Finished the bulk of changes for gnupg 1.9. This included switching
[gnupg.git] / jnlib / stringhelp.c
1 /* stringhelp.c -  standard string helper functions
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <stdarg.h>
25 #include <ctype.h>
26
27 #include "libjnlib-config.h"
28 #include "utf8conv.h"
29 #include "stringhelp.h"
30
31
32 /****************
33  * look for the substring SUB in buffer and return a pointer to that
34  * substring in BUF or NULL if not found.
35  * Comparison is case-insensitive.
36  */
37 const char *
38 memistr( const char *buf, size_t buflen, const char *sub )
39 {
40     const byte *t, *s ;
41     size_t n;
42
43     for( t=buf, n=buflen, s=sub ; n ; t++, n-- )
44         if( toupper(*t) == toupper(*s) ) {
45             for( buf=t++, buflen = n--, s++;
46                  n && toupper(*t) == toupper(*s); t++, s++, n-- )
47                 ;
48             if( !*s )
49                 return buf;
50             t = buf; n = buflen; s = sub ;
51         }
52
53     return NULL ;
54 }
55
56 const char *
57 ascii_memistr( const char *buf, size_t buflen, const char *sub )
58 {
59     const byte *t, *s ;
60     size_t n;
61
62     for( t=buf, n=buflen, s=sub ; n ; t++, n-- )
63         if( ascii_toupper(*t) == ascii_toupper(*s) ) {
64             for( buf=t++, buflen = n--, s++;
65                  n && ascii_toupper(*t) == ascii_toupper(*s); t++, s++, n-- )
66                 ;
67             if( !*s )
68                 return buf;
69             t = buf; n = buflen; s = sub ;
70         }
71
72     return NULL ;
73 }
74
75 /****************
76  * Wie strncpy(), aber es werden maximal n-1 zeichen kopiert und ein
77  * '\0' angehängt. Ist n = 0, so geschieht nichts, ist Destination
78  * gleich NULL, so wird via jnlib_xmalloc Speicher besorgt, ist dann nicht
79  * genügend Speicher vorhanden, so bricht die funktion ab.
80  */
81 char *
82 mem2str( char *dest , const void *src , size_t n )
83 {
84     char *d;
85     const char *s;
86
87     if( n ) {
88         if( !dest )
89             dest = jnlib_xmalloc( n ) ;
90         d = dest;
91         s = src ;
92         for(n--; n && *s; n-- )
93             *d++ = *s++;
94         *d = '\0' ;
95     }
96
97     return dest ;
98 }
99
100
101 /****************
102  * remove leading and trailing white spaces
103  */
104 char *
105 trim_spaces( char *str )
106 {
107     char *string, *p, *mark;
108
109     string = str;
110     /* find first non space character */
111     for( p=string; *p && isspace( *(byte*)p ) ; p++ )
112         ;
113     /* move characters */
114     for( (mark = NULL); (*string = *p); string++, p++ )
115         if( isspace( *(byte*)p ) ) {
116             if( !mark )
117                 mark = string ;
118         }
119         else
120             mark = NULL ;
121     if( mark )
122         *mark = '\0' ;  /* remove trailing spaces */
123
124     return str ;
125 }
126
127 /****************
128  * remove trailing white spaces
129  */
130 char *
131 trim_trailing_spaces( char *string )
132 {
133     char *p, *mark;
134
135     for( mark = NULL, p = string; *p; p++ ) {
136         if( isspace( *(byte*)p ) ) {
137             if( !mark )
138                 mark = p;
139         }
140         else
141             mark = NULL;
142     }
143     if( mark )
144         *mark = '\0' ;
145
146     return string ;
147 }
148
149
150 unsigned
151 trim_trailing_chars( byte *line, unsigned len, const char *trimchars )
152 {
153     byte *p, *mark;
154     unsigned n;
155
156     for(mark=NULL, p=line, n=0; n < len; n++, p++ ) {
157         if( strchr(trimchars, *p ) ) {
158             if( !mark )
159                 mark = p;
160         }
161         else
162             mark = NULL;
163     }
164
165     if( mark ) {
166         *mark = 0;
167         return mark - line;
168     }
169     return len;
170 }
171
172 /****************
173  * remove trailing white spaces and return the length of the buffer
174  */
175 unsigned
176 trim_trailing_ws( byte *line, unsigned len )
177 {
178     return trim_trailing_chars( line, len, " \t\r\n" );
179 }
180
181 size_t
182 length_sans_trailing_chars (const unsigned char *line, size_t len,
183                             const char *trimchars )
184 {
185   const unsigned char *p, *mark;
186   size_t n;
187   
188   for( mark=NULL, p=line, n=0; n < len; n++, p++ )
189     {
190       if (strchr (trimchars, *p ))
191         {
192           if( !mark )
193             mark = p;
194         }
195       else
196         mark = NULL;
197     }
198   
199   if (mark) 
200     return mark - line;
201   return len;
202 }
203
204 /****************
205  * remove trailing white spaces and return the length of the buffer
206  */
207 size_t
208 length_sans_trailing_ws (const unsigned char *line, size_t len)
209 {
210   return length_sans_trailing_chars (line, len, " \t\r\n");
211 }
212
213
214
215 /***************
216  * Extract from a given path the filename component.
217  *
218  */
219 char *
220 make_basename(const char *filepath)
221 {
222     char *p;
223
224     if ( !(p=strrchr(filepath, '/')) )
225       #ifdef HAVE_DRIVE_LETTERS
226         if ( !(p=strrchr(filepath, '\\')) )
227             if ( !(p=strrchr(filepath, ':')) )
228       #endif
229               {
230                 return jnlib_xstrdup(filepath);
231               }
232
233     return jnlib_xstrdup(p+1);
234 }
235
236
237
238 /***************
239  * Extract from a given filename the path prepended to it.
240  * If their isn't a path prepended to the filename, a dot
241  * is returned ('.').
242  *
243  */
244 char *
245 make_dirname(const char *filepath)
246 {
247     char *dirname;
248     int  dirname_length;
249     char *p;
250
251     if ( !(p=strrchr(filepath, '/')) )
252       #ifdef HAVE_DRIVE_LETTERS
253         if ( !(p=strrchr(filepath, '\\')) )
254             if ( !(p=strrchr(filepath, ':')) )
255       #endif
256               {
257                 return jnlib_xstrdup(".");
258               }
259
260     dirname_length = p-filepath;
261     dirname = jnlib_xmalloc(dirname_length+1);
262     strncpy(dirname, filepath, dirname_length);
263     dirname[dirname_length] = 0;
264
265     return dirname;
266 }
267
268
269
270 /****************
271  * Construct a filename from the NULL terminated list of parts.
272  * Tilde expansion is done here.
273  */
274 char *
275 make_filename( const char *first_part, ... )
276 {
277     va_list arg_ptr ;
278     size_t n;
279     const char *s;
280     char *name, *home, *p;
281
282     va_start( arg_ptr, first_part ) ;
283     n = strlen(first_part)+1;
284     while( (s=va_arg(arg_ptr, const char *)) )
285         n += strlen(s) + 1;
286     va_end(arg_ptr);
287
288     home = NULL;
289     if( *first_part == '~' && first_part[1] == '/'
290                            && (home = getenv("HOME")) && *home )
291         n += strlen(home);
292
293     name = jnlib_xmalloc(n);
294     p = home ? stpcpy(stpcpy(name,home), first_part+1)
295              : stpcpy(name, first_part);
296     va_start( arg_ptr, first_part ) ;
297     while( (s=va_arg(arg_ptr, const char *)) )
298         p = stpcpy(stpcpy(p,"/"), s);
299     va_end(arg_ptr);
300
301     return name;
302 }
303
304
305 int
306 compare_filenames( const char *a, const char *b )
307 {
308     /* ? check whether this is an absolute filename and
309      * resolve symlinks?
310      */
311 #ifdef HAVE_DRIVE_LETTERS
312     return stricmp(a,b);
313 #else
314     return strcmp(a,b);
315 #endif
316 }
317
318 /* Print a BUFFER to stream FP while replacing all control characters
319    and the character DELIM with standard C escape sequences.  Returns
320    the number of characters printed. */
321 size_t 
322 print_sanitized_buffer (FILE *fp, const void *buffer, size_t length,
323                         int delim)
324 {
325   const unsigned char *p = buffer;
326   size_t count = 0;
327
328   for (; length; length--, p++, count++)
329     {
330       if (*p < 0x20 || (*p >= 0x7f && *p < 0xa0) || *p == delim)
331         {
332           putc ('\\', fp);
333           count++;
334           if (*p == '\n')
335             putc ('n', fp);
336           else if (*p == '\r')
337             putc ('r', fp);
338           else if (*p == '\f')
339             putc ('f', fp);
340           else if (*p == '\v')
341             putc ('v', fp);
342           else if (*p == '\b')
343             putc ('b', fp);
344           else if (!*p)
345             putc('0', fp);
346           else
347             {
348               fprintf (fp, "x%02x", *p);
349               count += 2;
350             }
351         }
352       else
353         putc (*p, fp);
354     }
355
356   return count;
357 }
358
359 size_t 
360 print_sanitized_utf8_buffer (FILE *fp, const void *buffer,
361                              size_t length, int delim)
362 {
363   const char *p = buffer;
364   size_t i;
365
366   /* We can handle plain ascii simpler, so check for it first. */
367   for (i=0; i < length; i++ ) 
368     {
369       if ( (p[i] & 0x80) )
370         break;
371     }
372   if (i < length)
373     {
374         char *buf = utf8_to_native (p, length, delim);
375         /*(utf8 conversion already does the control character quoting)*/
376         i = strlen (buf);
377         fputs (buf, fp);
378         jnlib_free (buf);
379         return i;
380     }
381   else
382     return print_sanitized_buffer (fp, p, length, delim);
383 }
384
385
386 size_t 
387 print_sanitized_string (FILE *fp, const char *string, int delim)
388 {
389   return string? print_sanitized_buffer (fp, string, strlen (string), delim):0;
390 }
391
392 size_t 
393 print_sanitized_utf8_string (FILE *fp, const char *string, int delim)
394 {
395   /* FIXME: convert to local characterset */
396   return print_sanitized_string (fp, string, delim);
397 }
398
399 /* Create a string from the buffer P of length N which is suitable for
400    printing.  Caller must release the created string using xfree. */
401 char *
402 sanitize_buffer (const unsigned char *p, size_t n, int delim)
403 {
404   size_t save_n, buflen;
405   const byte *save_p;
406   char *buffer, *d;
407
408   /* first count length */
409   for (save_n = n, save_p = p, buflen=1 ; n; n--, p++ ) 
410     {
411       if ( *p < 0x20 || (*p >= 0x7f && *p < 0xa0) || *p == delim 
412            || (delim && *p=='\\'))
413         {
414           if ( *p=='\n' || *p=='\r' || *p=='\f'
415                || *p=='\v' || *p=='\b' || !*p )
416             buflen += 2;
417           else
418             buflen += 4;
419         }
420       else
421         buflen++;
422     }
423   p = save_p;
424   n = save_n;
425   /* and now make the string */
426   d = buffer = jnlib_xmalloc( buflen );
427   for ( ; n; n--, p++ )
428     {
429       if (*p < 0x20 || (*p >= 0x7f && *p < 0xa0) || *p == delim 
430           ||(delim && *p=='\\')) {
431         *d++ = '\\';
432         if( *p == '\n' )
433           *d++ = 'n';
434         else if( *p == '\r' )
435           *d++ = 'r';
436         else if( *p == '\f' )
437           *d++ = 'f';
438         else if( *p == '\v' )
439           *d++ = 'v';
440         else if( *p == '\b' )
441           *d++ = 'b';
442         else if( !*p )
443           *d++ = '0';
444         else {
445           sprintf(d, "x%02x", *p );
446           d += 2;
447         }
448       }
449       else
450         *d++ = *p;
451     }
452   *d = 0;
453   return buffer;
454 }
455
456 /****************************************************
457  ******** locale insensitive ctype functions ********
458  ****************************************************/
459 /* FIXME: replace them by a table lookup and macros */
460 int
461 ascii_isupper (int c)
462 {
463     return c >= 'A' && c <= 'Z';
464 }
465
466 int
467 ascii_islower (int c)
468 {
469     return c >= 'a' && c <= 'z';
470 }
471
472 int 
473 ascii_toupper (int c)
474 {
475     if (c >= 'a' && c <= 'z')
476         c &= ~0x20;
477     return c;
478 }
479
480 int 
481 ascii_tolower (int c)
482 {
483     if (c >= 'A' && c <= 'Z')
484         c |= 0x20;
485     return c;
486 }
487
488
489 int
490 ascii_strcasecmp( const char *a, const char *b )
491 {
492     if (a == b)
493         return 0;
494
495     for (; *a && *b; a++, b++) {
496         if (*a != *b && ascii_toupper(*a) != ascii_toupper(*b))
497             break;
498     }
499     return *a == *b? 0 : (ascii_toupper (*a) - ascii_toupper (*b));
500 }
501
502 int 
503 ascii_strncasecmp (const char *a, const char *b, size_t n)
504 {
505   const unsigned char *p1 = (const unsigned char *)a;
506   const unsigned char *p2 = (const unsigned char *)b;
507   unsigned char c1, c2;
508
509   if (p1 == p2 || !n )
510     return 0;
511
512   do
513     {
514       c1 = ascii_tolower (*p1);
515       c2 = ascii_tolower (*p2);
516
517       if ( !--n || c1 == '\0')
518         break;
519
520       ++p1;
521       ++p2;
522     }
523   while (c1 == c2);
524   
525   return c1 - c2;
526 }
527
528
529 int
530 ascii_memcasecmp( const char *a, const char *b, size_t n )
531 {
532     if (a == b)
533         return 0;
534     for ( ; n; n--, a++, b++ ) {
535         if( *a != *b  && ascii_toupper (*a) != ascii_toupper (*b) )
536             return *a == *b? 0 : (ascii_toupper (*a) - ascii_toupper (*b));
537     }
538     return 0;
539 }
540
541 int
542 ascii_strcmp( const char *a, const char *b )
543 {
544     if (a == b)
545         return 0;
546
547     for (; *a && *b; a++, b++) {
548         if (*a != *b )
549             break;
550     }
551     return *a == *b? 0 : (*(signed char *)a - *(signed char *)b);
552 }
553
554
555 void *
556 ascii_memcasemem (const void *haystack, size_t nhaystack,
557                   const void *needle, size_t nneedle)
558 {
559
560   if (!nneedle)
561     return (void*)haystack; /* finding an empty needle is really easy */
562   if (nneedle <= nhaystack)
563     {
564       const unsigned char *a = haystack;
565       const unsigned char *b = a + nhaystack - nneedle;
566       
567       for (; a <= b; a++)
568         {
569           if ( !ascii_memcasecmp (a, needle, nneedle) )
570             return (void *)a;
571         }
572     }
573   return NULL;
574 }
575
576 /*********************************************
577  ********** missing string functions *********
578  *********************************************/
579
580 #ifndef HAVE_STPCPY
581 char *
582 stpcpy(char *a,const char *b)
583 {
584     while( *b )
585         *a++ = *b++;
586     *a = 0;
587
588     return (char*)a;
589 }
590 #endif
591
592 #ifndef HAVE_STRLWR
593 char *
594 strlwr(char *s)
595 {
596     char *p;
597     for(p=s; *p; p++ )
598         *p = tolower(*p);
599     return s;
600 }
601 #endif
602
603
604 #ifndef HAVE_STRCASECMP
605 int
606 strcasecmp( const char *a, const char *b )
607 {
608     for( ; *a && *b; a++, b++ ) {
609         if( *a != *b && toupper(*a) != toupper(*b) )
610             break;
611     }
612     return *(const byte*)a - *(const byte*)b;
613 }
614 #endif
615
616
617 /****************
618  * mingw32/cpd has a memicmp()
619  */
620 #ifndef HAVE_MEMICMP
621 int
622 memicmp( const char *a, const char *b, size_t n )
623 {
624     for( ; n; n--, a++, b++ )
625         if( *a != *b  && toupper(*(const byte*)a) != toupper(*(const byte*)b) )
626             return *(const byte *)a - *(const byte*)b;
627     return 0;
628 }
629 #endif