Tweak for OS/2 build happiness.
[privoxy.git] / miscutil.c
1 const char miscutil_rcs[] = "$Id: miscutil.c,v 1.40 2006/08/17 17:15:10 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/miscutil.c,v $
5  *
6  * Purpose     :  zalloc, hash_string, safe_strerror, strcmpic,
7  *                strncmpic, chomp, and MinGW32 strdup
8  *                functions. 
9  *                These are each too small to deserve their own file
10  *                but don't really fit in any other file.
11  *
12  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
13  *                Privoxy team. http://www.privoxy.org/
14  *
15  *                Based on the Internet Junkbuster originally written
16  *                by and Copyright (C) 1997 Anonymous Coders and 
17  *                Junkbusters Corporation.  http://www.junkbusters.com
18  *
19  *                This program is free software; you can redistribute it 
20  *                and/or modify it under the terms of the GNU General
21  *                Public License as published by the Free Software
22  *                Foundation; either version 2 of the License, or (at
23  *                your option) any later version.
24  *
25  *                This program is distributed in the hope that it will
26  *                be useful, but WITHOUT ANY WARRANTY; without even the
27  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
28  *                PARTICULAR PURPOSE.  See the GNU General Public
29  *                License for more details.
30  *
31  *                The GNU General Public License should be included with
32  *                this file.  If not, you can view it at
33  *                http://www.gnu.org/copyleft/gpl.html
34  *                or write to the Free Software Foundation, Inc., 59
35  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
36  *
37  * Revisions   :
38  *    $Log: miscutil.c,v $
39  *    Revision 1.40  2006/08/17 17:15:10  fabiankeil
40  *    - Back to timegm() using GnuPG's replacement if necessary.
41  *      Using mktime() and localtime() could add a on hour offset if
42  *      the randomize factor was big enough to lead to a summer/wintertime
43  *      switch.
44  *
45  *    - Removed now-useless Privoxy 3.0.3 compatibility glue.
46  *
47  *    - Moved randomization code into pick_from_range().
48  *
49  *    - Changed parse_header_time definition.
50  *      time_t isn't guaranteed to be signed and
51  *      if it isn't, -1 isn't available as error code.
52  *      Changed some variable types in client_if_modified_since()
53  *      because of the same reason.
54  *
55  *    Revision 1.39  2006/07/18 14:48:46  david__schmidt
56  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
57  *    with what was really the latest development (the v_3_0_branch branch)
58  *
59  *    Revision 1.37.2.4  2003/12/01 14:45:14  oes
60  *    Fixed two more problems with wildcarding in simplematch()
61  *
62  *    Revision 1.37.2.3  2003/11/20 11:39:24  oes
63  *    Bugfix: The "?" wildcard for domain names had never been implemented. Ooops\!
64  *
65  *    Revision 1.37.2.2  2002/11/12 14:28:18  oes
66  *    Proper backtracking in simplematch; fixes bug #632888
67  *
68  *    Revision 1.37.2.1  2002/09/25 12:58:51  oes
69  *    Made strcmpic and strncmpic safe against NULL arguments
70  *    (which are now treated as empty strings).
71  *
72  *    Revision 1.37  2002/04/26 18:29:43  jongfoster
73  *    Fixing this Visual C++ warning:
74  *    miscutil.c(710) : warning C4090: '=' : different 'const' qualifiers
75  *
76  *    Revision 1.36  2002/04/26 12:55:38  oes
77  *    New function string_toupper
78  *
79  *    Revision 1.35  2002/03/26 22:29:55  swa
80  *    we have a new homepage!
81  *
82  *    Revision 1.34  2002/03/24 13:25:43  swa
83  *    name change related issues
84  *
85  *    Revision 1.33  2002/03/07 03:46:53  oes
86  *    Fixed compiler warnings etc
87  *
88  *    Revision 1.32  2002/03/06 23:02:57  jongfoster
89  *    Removing tabs
90  *
91  *    Revision 1.31  2002/03/05 04:52:42  oes
92  *    Deleted non-errlog debugging code
93  *
94  *    Revision 1.30  2002/03/04 18:27:42  oes
95  *    - Deleted deletePidFile
96  *    - Made write_pid_file use the --pidfile option value
97  *      (or no PID file, if the option was absent)
98  *    - Played styleguide police
99  *
100  *    Revision 1.29  2002/03/04 02:08:02  david__schmidt
101  *    Enable web editing of actions file on OS/2 (it had been broken all this time!)
102  *
103  *    Revision 1.28  2002/03/03 09:18:03  joergs
104  *    Made jumbjuster work on AmigaOS again.
105  *
106  *    Revision 1.27  2002/01/21 00:52:32  jongfoster
107  *    Adding string_join()
108  *
109  *    Revision 1.26  2001/12/30 14:07:32  steudten
110  *    - Add signal handling (unix)
111  *    - Add SIGHUP handler (unix)
112  *    - Add creation of pidfile (unix)
113  *    - Add action 'top' in rc file (RH)
114  *    - Add entry 'SIGNALS' to manpage
115  *    - Add exit message to logfile (unix)
116  *
117  *    Revision 1.25  2001/11/13 00:16:38  jongfoster
118  *    Replacing references to malloc.h with the standard stdlib.h
119  *    (See ANSI or K&R 2nd Ed)
120  *
121  *    Revision 1.24  2001/11/05 21:41:43  steudten
122  *    Add changes to be a real daemon just for unix os.
123  *    (change cwd to /, detach from controlling tty, set
124  *    process group and session leader to the own process.
125  *    Add DBG() Macro.
126  *    Add some fatal-error log message for failed malloc().
127  *    Add '-d' if compiled with 'configure --with-debug' to
128  *    enable debug output.
129  *
130  *    Revision 1.23  2001/10/29 03:48:10  david__schmidt
131  *    OS/2 native needed a snprintf() routine.  Added one to miscutil, brackedted
132  *    by and __OS2__ ifdef.
133  *
134  *    Revision 1.22  2001/10/26 17:39:38  oes
135  *    Moved ijb_isspace and ijb_tolower to project.h
136  *
137  *    Revision 1.21  2001/10/23 21:27:50  jongfoster
138  *    Standardising error codes in string_append
139  *    make_path() no longer adds '\\' if the dir already ends in '\\' (this
140  *    is just copying a UNIX-specific fix to the Windows-specific part)
141  *
142  *    Revision 1.20  2001/10/22 15:33:56  david__schmidt
143  *    Special-cased OS/2 out of the Netscape-abort-on-404-in-js problem in
144  *    filters.c.  Added a FIXME in front of the offending code.  I'll gladly
145  *    put in a better/more robust fix for all parties if one is presented...
146  *    It seems that just returning 200 instead of 404 would pretty much fix
147  *    it for everyone, but I don't know all the history of the problem.
148  *
149  *    Revision 1.19  2001/10/14 22:02:57  jongfoster
150  *    New function string_append() which is like strsav(), but running
151  *    out of memory isn't automatically FATAL.
152  *
153  *    Revision 1.18  2001/09/20 13:33:43  steudten
154  *
155  *    change long to int as return value in hash_string(). Remember the wraparound
156  *    for int = long = sizeof(4) - thats maybe not what we want.
157  *
158  *    Revision 1.17  2001/09/13 20:51:29  jongfoster
159  *    Fixing potential problems with characters >=128 in simplematch()
160  *    This was also a compiler warning.
161  *
162  *    Revision 1.16  2001/09/10 10:56:59  oes
163  *    Silenced compiler warnings
164  *
165  *    Revision 1.15  2001/07/13 14:02:24  oes
166  *    Removed vim-settings
167  *
168  *    Revision 1.14  2001/06/29 21:45:41  oes
169  *    Indentation, CRLF->LF, Tab-> Space
170  *
171  *    Revision 1.13  2001/06/29 13:32:14  oes
172  *    Removed logentry from cancelled commit
173  *
174  *    Revision 1.12  2001/06/09 10:55:28  jongfoster
175  *    Changing BUFSIZ ==> BUFFER_SIZE
176  *
177  *    Revision 1.11  2001/06/07 23:09:19  jongfoster
178  *    Cosmetic indentation changes.
179  *
180  *    Revision 1.10  2001/06/07 14:51:38  joergs
181  *    make_path() no longer adds '/' if the dir already ends in '/'.
182  *
183  *    Revision 1.9  2001/06/07 14:43:17  swa
184  *    slight mistake in make_path, unix path style is /.
185  *
186  *    Revision 1.8  2001/06/05 22:32:01  jongfoster
187  *    New function make_path() to splice directory and file names together.
188  *
189  *    Revision 1.7  2001/06/03 19:12:30  oes
190  *    introduced bindup()
191  *
192  *    Revision 1.6  2001/06/01 18:14:49  jongfoster
193  *    Changing the calls to strerr() to check HAVE_STRERR (which is defined
194  *    in config.h if appropriate) rather than the NO_STRERR macro.
195  *
196  *    Revision 1.5  2001/06/01 10:31:51  oes
197  *    Added character class matching to trivimatch; renamed to simplematch
198  *
199  *    Revision 1.4  2001/05/31 17:32:31  oes
200  *
201  *     - Enhanced domain part globbing with infix and prefix asterisk
202  *       matching and optional unanchored operation
203  *
204  *    Revision 1.3  2001/05/29 23:10:09  oes
205  *
206  *
207  *     - Introduced chomp()
208  *     - Moved strsav() from showargs to miscutil
209  *
210  *    Revision 1.2  2001/05/29 09:50:24  jongfoster
211  *    Unified blocklist/imagelist/permissionslist.
212  *    File format is still under discussion, but the internal changes
213  *    are (mostly) done.
214  *
215  *    Also modified interceptor behaviour:
216  *    - We now intercept all URLs beginning with one of the following
217  *      prefixes (and *only* these prefixes):
218  *        * http://i.j.b/
219  *        * http://ijbswa.sf.net/config/
220  *        * http://ijbswa.sourceforge.net/config/
221  *    - New interceptors "home page" - go to http://i.j.b/ to see it.
222  *    - Internal changes so that intercepted and fast redirect pages
223  *      are not replaced with an image.
224  *    - Interceptors now have the option to send a binary page direct
225  *      to the client. (i.e. ijb-send-banner uses this)
226  *    - Implemented show-url-info interceptor.  (Which is why I needed
227  *      the above interceptors changes - a typical URL is
228  *      "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
229  *      The previous mechanism would not have intercepted that, and
230  *      if it had been intercepted then it then it would have replaced
231  *      it with an image.)
232  *
233  *    Revision 1.1.1.1  2001/05/15 13:59:00  oes
234  *    Initial import of version 2.9.3 source tree
235  *
236  *
237  *********************************************************************/
238 \f
239
240 #include "config.h"
241
242 #include <stdio.h>
243 #include <sys/types.h>
244 #include <stdlib.h>
245 #if !defined(_WIN32) && !defined(__OS2__)
246 #include <unistd.h>
247 #endif /* #if !defined(_WIN32) && !defined(__OS2__) */
248 #include <string.h>
249 #include <ctype.h>
250 #include <assert.h>
251
252 #ifndef HAVE_TIMEGM
253 #include <time.h>
254 #endif /* #ifndef HAVE_TIMEGM */
255
256 #include "project.h"
257 #include "miscutil.h"
258 #include "errlog.h"
259 #include "jcc.h"
260
261 const char miscutil_h_rcs[] = MISCUTIL_H_VERSION;
262
263 /*********************************************************************
264  *
265  * Function    :  zalloc
266  *
267  * Description :  Malloc some memory and set it to '\0'.
268  *                The way calloc() ought to be -acjc
269  *
270  * Parameters  :
271  *          1  :  size = Size of memory chunk to return.
272  *
273  * Returns     :  Pointer to newly malloc'd memory chunk.
274  *
275  *********************************************************************/
276 void *zalloc(size_t size)
277 {
278    void * ret;
279
280    if ((ret = (void *)malloc(size)) != NULL)
281    {
282       memset(ret, 0, size);
283    }
284
285    return(ret);
286
287 }
288
289
290 #if defined(unix)
291 /*********************************************************************
292  *
293  * Function    :  write_pid_file 
294  *
295  * Description :  Writes a pid file with the pid of the main process 
296  *
297  * Parameters  :  None
298  *
299  * Returns     :  N/A 
300  *
301  *********************************************************************/
302 void write_pid_file(void)
303 {
304    FILE   *fp;
305    
306    /*
307     * If no --pidfile option was given,
308     * we can live without one.
309     */
310    if (pidfile == NULL) return;
311
312    if ((fp = fopen(pidfile, "w")) == NULL)
313    {
314       log_error(LOG_LEVEL_INFO, "can't open pidfile '%s': %E", pidfile);
315    }
316    else
317    {
318       fprintf(fp, "%u\n", (unsigned int) getpid());
319       fclose (fp);
320    }
321    return;
322
323 }
324 #endif /* def unix */
325
326
327 /*********************************************************************
328  *
329  * Function    :  hash_string
330  *
331  * Description :  Take a string and compute a (hopefuly) unique numeric
332  *                integer value.  This has several uses, but being able
333  *                to "switch" a string the one of my favorites.
334  *
335  * Parameters  :
336  *          1  :  s : string to be hashed.
337  *
338  * Returns     :  an unsigned long variable with the hashed value.
339  *
340  *********************************************************************/
341 unsigned int hash_string( const char* s )
342 {
343    unsigned int h = 0; 
344
345    for ( ; *s; ++s )
346    {
347       h = 5 * h + *s;
348    }
349
350    return (h);
351
352 }
353
354
355 #ifdef __MINGW32__
356 /*********************************************************************
357  *
358  * Function    :  strdup
359  *
360  * Description :  For some reason (which is beyond me), gcc and WIN32
361  *                don't like strdup.  When a "free" is executed on a
362  *                strdup'd ptr, it can at times freez up!  So I just
363  *                replaced it and problem was solved.
364  *
365  * Parameters  :
366  *          1  :  s = string to duplicate
367  *
368  * Returns     :  Pointer to newly malloc'ed copy of the string.
369  *
370  *********************************************************************/
371 char *strdup( const char *s )
372 {
373    char * result = (char *)malloc( strlen(s)+1 );
374
375    if (result != NULL)
376    {
377       strcpy( result, s );
378    }
379
380    return( result );
381 }
382
383 #endif /* def __MINGW32__ */
384
385
386
387 /*********************************************************************
388  *
389  * Function    :  safe_strerror
390  *
391  * Description :  Variant of the library routine strerror() which will
392  *                work on systems without the library routine, and
393  *                which should never return NULL.
394  *
395  * Parameters  :
396  *          1  :  err = the `errno' of the last operation.
397  *
398  * Returns     :  An "English" string of the last `errno'.  Allocated
399  *                with strdup(), so caller frees.  May be NULL if the
400  *                system is out of memory.
401  *
402  *********************************************************************/
403 char *safe_strerror(int err)
404 {
405    char *s = NULL;
406    char buf[BUFFER_SIZE];
407
408
409 #ifdef HAVE_STRERROR
410    s = strerror(err);
411 #endif /* HAVE_STRERROR */
412
413    if (s == NULL)
414    {
415       sprintf(buf, "(errno = %d)", err);
416       s = buf;
417    }
418
419    return(strdup(s));
420
421 }
422
423
424 /*********************************************************************
425  *
426  * Function    :  strcmpic
427  *
428  * Description :  Case insensitive string comparison
429  *
430  * Parameters  :
431  *          1  :  s1 = string 1 to compare
432  *          2  :  s2 = string 2 to compare
433  *
434  * Returns     :  0 if s1==s2, Negative if s1<s2, Positive if s1>s2
435  *
436  *********************************************************************/
437 int strcmpic(const char *s1, const char *s2)
438 {
439    if (!s1) s1 = "";
440    if (!s2) s2 = "";
441
442    while (*s1 && *s2)
443    {
444       if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
445       {
446          break;
447       }
448       s1++, s2++;
449    }
450    return(ijb_tolower(*s1) - ijb_tolower(*s2));
451
452 }
453
454
455 /*********************************************************************
456  *
457  * Function    :  strncmpic
458  *
459  * Description :  Case insensitive string comparison (upto n characters)
460  *
461  * Parameters  :
462  *          1  :  s1 = string 1 to compare
463  *          2  :  s2 = string 2 to compare
464  *          3  :  n = maximum characters to compare
465  *
466  * Returns     :  0 if s1==s2, Negative if s1<s2, Positive if s1>s2
467  *
468  *********************************************************************/
469 int strncmpic(const char *s1, const char *s2, size_t n)
470 {
471    if (n <= 0) return(0);
472    if (!s1) s1 = "";
473    if (!s2) s2 = "";
474    
475    while (*s1 && *s2)
476    {
477       if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
478       {
479          break;
480       }
481
482       if (--n <= 0) break;
483
484       s1++, s2++;
485    }
486    return(ijb_tolower(*s1) - ijb_tolower(*s2));
487
488 }
489
490
491 /*********************************************************************
492  *
493  * Function    :  chomp
494  *
495  * Description :  In-situ-eliminate all leading and trailing whitespace
496  *                from a string.
497  *
498  * Parameters  :
499  *          1  :  s : string to be chomped.
500  *
501  * Returns     :  chomped string
502  *
503  *********************************************************************/
504 char *chomp(char *string)
505 {
506    char *p, *q, *r;
507
508    /* 
509     * strip trailing whitespace
510     */
511    p = string + strlen(string);
512    while (p > string && ijb_isspace(*(p-1)))
513    {
514       p--;
515    }
516    *p = '\0';
517
518    /* 
519     * find end of leading whitespace 
520     */
521    q = r = string;
522    while (*q && ijb_isspace(*q))
523    {
524       q++;
525    }
526
527    /*
528     * if there was any, move the rest forwards
529     */
530    if (q != string)
531    {
532       while (q <= p)
533       {
534          *r++ = *q++;
535       }
536    }
537
538    return(string);
539
540 }
541
542
543 /*********************************************************************
544  *
545  * Function    :  strsav
546  *
547  * Description :  Reallocate "old" and append text to it.  This makes
548  *                it easier to append to malloc'd strings.
549  *                Running out of memory is a FATAL error.
550  *
551  * Parameters  :
552  *          1  :  old = Old text that is to be extended.  Will be
553  *                free()d by this routine.  May be NULL.
554  *          2  :  text_to_append = Text to be appended to old.
555  *                May be NULL.
556  *
557  * Returns     :  Pointer to newly malloc'ed appended string.
558  *                If there is no text to append, return old.  Caller
559  *                must free().
560  *
561  *********************************************************************/
562 char *strsav(char *old, const char *text_to_append)
563 {
564    size_t old_len, new_len = 0;
565    char *p;
566
567    if ((text_to_append == NULL) || (*text_to_append == '\0'))
568    {
569       return(old);
570    }
571
572    if (NULL == old)
573    {
574       if ((p = strdup(text_to_append)) == NULL)
575       {
576          log_error(LOG_LEVEL_FATAL, "strdup() failed!");
577          /* Never get here - LOG_LEVEL_FATAL causes program exit */
578       }
579       return p;
580    }
581
582    old_len = strlen(old);
583    new_len = old_len + strlen(text_to_append) + 1;
584
585    if ((p = realloc(old, new_len)) == NULL)
586    {
587       log_error(LOG_LEVEL_FATAL, "realloc(%d) bytes failed!", new_len);
588       /* Never get here - LOG_LEVEL_FATAL causes program exit */
589    }
590
591    strcpy(p + old_len, text_to_append);
592    return(p);
593 }
594
595
596 /*********************************************************************
597  *
598  * Function    :  string_append
599  *
600  * Description :  Reallocate target_string and append text to it.  
601  *                This makes it easier to append to malloc'd strings.
602  *                This is similar to the (removed) strsav(), but
603  *                running out of memory isn't catastrophic.
604  *
605  *                Programming style:
606  *
607  *                The following style provides sufficient error
608  *                checking for this routine, with minimal clutter
609  *                in the source code.  It is recommended if you
610  *                have many calls to this function:
611  *
612  *                char * s = strdup(...); // don't check for error
613  *                string_append(&s, ...);  // don't check for error
614  *                string_append(&s, ...);  // don't check for error
615  *                string_append(&s, ...);  // don't check for error
616  *                if (NULL == s) { ... handle error ... }
617  *
618  *                OR, equivalently:
619  *
620  *                char * s = strdup(...); // don't check for error
621  *                string_append(&s, ...);  // don't check for error
622  *                string_append(&s, ...);  // don't check for error
623  *                if (string_append(&s, ...)) {... handle error ...}
624  *
625  * Parameters  :
626  *          1  :  target_string = Pointer to old text that is to be
627  *                extended.  *target_string will be free()d by this
628  *                routine.  target_string must be non-NULL.
629  *                If *target_string is NULL, this routine will
630  *                do nothing and return with an error - this allows
631  *                you to make many calls to this routine and only
632  *                check for errors after the last one.
633  *          2  :  text_to_append = Text to be appended to old.
634  *                Must not be NULL.
635  *
636  * Returns     :  JB_ERR_OK on success, and sets *target_string
637  *                   to newly malloc'ed appended string.  Caller
638  *                   must free(*target_string).
639  *                JB_ERR_MEMORY on out-of-memory.  (And free()s
640  *                   *target_string and sets it to NULL).
641  *                JB_ERR_MEMORY if *target_string is NULL.
642  *
643  *********************************************************************/
644 jb_err string_append(char **target_string, const char *text_to_append)
645 {
646    size_t old_len;
647    char *new_string;
648
649    assert(target_string);
650    assert(text_to_append);
651
652    if (*target_string == NULL)
653    {
654       return JB_ERR_MEMORY;
655    }
656
657    if (*text_to_append == '\0')
658    {
659       return JB_ERR_OK;
660    }
661
662    old_len = strlen(*target_string);
663
664    if (NULL == (new_string = realloc(*target_string,
665           strlen(text_to_append) + old_len + 1)))
666    {
667       free(*target_string);
668
669       *target_string = NULL;
670       return JB_ERR_MEMORY;
671    }
672
673    strcpy(new_string + old_len, text_to_append);
674
675    *target_string = new_string;
676    return JB_ERR_OK;
677 }
678
679
680 /*********************************************************************
681  *
682  * Function    :  string_join
683  *
684  * Description :  Join two strings together.  Frees BOTH the original
685  *                strings.  If either or both input strings are NULL,
686  *                fails as if it had run out of memory.
687  *
688  *                For comparison, string_append requires that the
689  *                second string is non-NULL, and doesn't free it.
690  *
691  *                Rationale: Too often, we want to do
692  *                string_append(s, html_encode(s2)).  That assert()s
693  *                if s2 is NULL or if html_encode() runs out of memory.
694  *                It also leaks memory.  Proper checking is cumbersome.
695  *                The solution: string_join(s, html_encode(s2)) is safe,
696  *                and will free the memory allocated by html_encode().
697  *
698  * Parameters  :
699  *          1  :  target_string = Pointer to old text that is to be
700  *                extended.  *target_string will be free()d by this
701  *                routine.  target_string must be non-NULL.
702  *          2  :  text_to_append = Text to be appended to old.
703  *
704  * Returns     :  JB_ERR_OK on success, and sets *target_string
705  *                   to newly malloc'ed appended string.  Caller
706  *                   must free(*target_string).
707  *                JB_ERR_MEMORY on out-of-memory, or if
708  *                   *target_string or text_to_append is NULL.  (In
709  *                   this case, frees *target_string and text_to_append,
710  *                   sets *target_string to NULL).
711  *
712  *********************************************************************/
713 jb_err string_join(char **target_string, char *text_to_append)
714 {
715    jb_err err;
716
717    assert(target_string);
718
719    if (text_to_append == NULL)
720    {
721       freez(*target_string);
722       return JB_ERR_MEMORY;
723    }
724
725    err = string_append(target_string, text_to_append);
726
727    free(text_to_append);
728
729    return err;
730 }
731
732
733 /*********************************************************************
734  *
735  * Function    :  string_toupper
736  *
737  * Description :  Produce a copy of string with all convertible
738  *                characters converted to uppercase.
739  *
740  * Parameters  :
741  *          1  :  string = string to convert
742  *
743  * Returns     :  Uppercase copy of string if possible, 
744  *                NULL on out-of-memory or if string was NULL.
745  *
746  *********************************************************************/
747 char *string_toupper(const char *string)
748 {
749    char *result, *p;
750    const char *q;
751
752    if (!string || ((result = (char *) zalloc(strlen(string) + 1)) == NULL))
753    {
754       return NULL;
755    }
756    
757    q = string;
758    p = result;
759
760    while (*q != '\0')
761    {
762       *p++ = toupper(*q++);
763    }
764
765    return result;
766
767 }
768
769
770 /*********************************************************************
771  *
772  * Function    :  simplematch
773  *
774  * Description :  String matching, with a (greedy) '*' wildcard that
775  *                stands for zero or more arbitrary characters and
776  *                character classes in [], which take both enumerations
777  *                and ranges.
778  *
779  * Parameters  :
780  *          1  :  pattern = pattern for matching
781  *          2  :  text    = text to be matched
782  *
783  * Returns     :  0 if match, else nonzero
784  *
785  *********************************************************************/
786 int simplematch(char *pattern, char *text)
787 {
788    unsigned char *pat = (unsigned char *) pattern;
789    unsigned char *txt = (unsigned char *) text;
790    unsigned char *fallback = pat; 
791    int wildcard = 0;
792   
793    unsigned char lastchar = 'a';
794    unsigned i;
795    unsigned char charmap[32];
796   
797    while (*txt)
798    {
799
800       /* EOF pattern but !EOF text? */
801       if (*pat == '\0')
802       {
803          if (wildcard)
804          {
805             pat = fallback;
806          }
807          else
808          {
809             return 1;
810          }
811       }
812
813       /* '*' in the pattern?  */
814       if (*pat == '*') 
815       {
816      
817          /* The pattern ends afterwards? Speed up the return. */
818          if (*++pat == '\0')
819          {
820             return 0;
821          }
822      
823          /* Else, set wildcard mode and remember position after '*' */
824          wildcard = 1;
825          fallback = pat;
826       }
827
828       /* Character range specification? */
829       if (*pat == '[')
830       {
831          memset(charmap, '\0', sizeof(charmap));
832
833          while (*++pat != ']')
834          {
835             if (!*pat)
836             { 
837                return 1;
838             }
839             else if (*pat == '-')
840             {
841                if ((*++pat == ']') || *pat == '\0')
842                {
843                   return(1);
844                }
845                for(i = lastchar; i <= *pat; i++)
846                {
847                   charmap[i / 8] |= (1 << (i % 8));
848                } 
849             }
850             else
851             {
852                charmap[*pat / 8] |= (1 << (*pat % 8));
853                lastchar = *pat;
854             }
855          }
856       } /* -END- if Character range specification */
857
858
859       /* 
860        * Char match, or char range match? 
861        */
862       if ( (*pat == *txt)
863       ||   (*pat == '?')
864       ||   ((*pat == ']') && (charmap[*txt / 8] & (1 << (*txt % 8)))) )
865       {
866          /* 
867           * Sucess: Go ahead
868           */
869          pat++;
870       }
871       else if (!wildcard)
872       {
873          /* 
874           * No match && no wildcard: No luck
875           */
876          return 1;
877       }
878       else if (pat != fallback)
879       {
880          /*
881           * Wildcard mode && nonmatch beyond fallback: Rewind pattern
882           */
883          pat = fallback;
884       }
885       txt++;
886    }
887
888    /* Cut off extra '*'s */
889    if(*pat == '*')  pat++;
890
891    /* If this is the pattern's end, fine! */
892    return(*pat);
893
894 }
895
896
897 /*********************************************************************
898  *
899  * Function    :  bindup
900  *
901  * Description :  Duplicate the first n characters of a string that may
902  *                contain '\0' characters.
903  *
904  * Parameters  :
905  *          1  :  string = string to be duplicated
906  *          2  :  len = number of bytes to duplicate
907  *
908  * Returns     :  pointer to copy, or NULL if failiure
909  *
910  *********************************************************************/
911 char *bindup(const char *string, size_t len)
912 {
913    char *duplicate;
914
915    if (NULL == (duplicate = (char *)malloc(len)))
916    {
917       return NULL;
918    }
919    else
920    {
921      memcpy(duplicate, string, len);
922    }
923
924    return duplicate;
925
926 }
927
928
929 /*********************************************************************
930  *
931  * Function    :  make_path
932  *
933  * Description :  Takes a directory name and a file name, returns 
934  *                the complete path.  Handles windows/unix differences.
935  *                If the file name is already an absolute path, or if
936  *                the directory name is NULL or empty, it returns 
937  *                the filename. 
938  *
939  * Parameters  :
940  *          1  :  dir: Name of directory or NULL for none.
941  *          2  :  file: Name of file.  Should not be NULL or empty.
942  *
943  * Returns     :  "dir/file" (Or on windows, "dir\file").
944  *                It allocates the string on the heap.  Caller frees.
945  *                Returns NULL in error (i.e. NULL file or out of
946  *                memory) 
947  *
948  *********************************************************************/
949 char * make_path(const char * dir, const char * file)
950 {
951 #ifdef AMIGA
952    char path[512];
953
954    if(dir)
955    {
956       if(dir[0] == '.')
957       {
958          if(dir[1] == '/')
959          {
960             strncpy(path,dir+2,512);
961          }
962          else
963          {
964             strncpy(path,dir+1,512);
965          }
966       }
967       else
968       {
969          strncpy(path,dir,512);
970       }
971       path[511]=0;
972    } else {
973       path[0]=0;
974    }
975    if(AddPart(path,file,512))
976    {
977       return strdup(path);
978    } else {
979       return NULL;
980    }
981 #else /* ndef AMIGA */
982
983    if ((file == NULL) || (*file == '\0'))
984    {
985       return NULL; /* Error */
986    }
987
988    if ((dir == NULL) || (*dir == '\0') /* No directory specified */
989 #if defined(_WIN32) || defined(__OS2__)
990       || (*file == '\\') || (file[1] == ':') /* Absolute path (DOS) */
991 #else /* ifndef _WIN32 || __OS2__ */
992       || (*file == '/') /* Absolute path (U*ix) */
993 #endif /* ifndef _WIN32 || __OS2__  */
994       )
995    {
996       return strdup(file);
997    }
998    else
999    {
1000       char * path;
1001
1002 #if defined(unix)
1003       if ( *dir != '/' && basedir && *basedir )
1004       {
1005          path = malloc( strlen( basedir ) + strlen(dir) + strlen(file) + 3);
1006          if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
1007          strcpy(path, basedir);
1008          strcat(path, "/");
1009          strcat(path, dir);
1010       }
1011       else
1012       {
1013          path = malloc(strlen(dir) + strlen(file) + 2);
1014          if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
1015          strcpy(path, dir);
1016       }
1017 #else
1018
1019       path = malloc(strlen(dir) + strlen(file) + 2);
1020       if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
1021       strcpy(path, dir);
1022
1023 #endif /* defined unix */
1024
1025 #if defined(_WIN32) || defined(__OS2__)
1026       if(path[strlen(path)-1] != '\\')
1027       {
1028          strcat(path, "\\");
1029       }
1030 #else /* ifndef _WIN32 || __OS2__ */
1031       if(path[strlen(path)-1] != '/')
1032       {
1033          strcat(path, "/");
1034       }
1035 #endif /* ifndef _WIN32 || __OS2__ */
1036       strcat(path, file);
1037
1038       return path;
1039    }
1040 #endif /* ndef AMIGA */
1041 }
1042
1043
1044 /*********************************************************************
1045  *
1046  * Function    :  pick_from_range
1047  *
1048  * Description :  Pick a positive number out of a given range.
1049  *                Should only be used if randomness would be nice,
1050  *                but isn't really necessary.
1051  *
1052  * Parameters  :
1053  *          1  :  range: Highest possible number to pick.
1054  *
1055  * Returns     :  Picked number. 
1056  *
1057  *********************************************************************/
1058
1059 long int pick_from_range(long int range)
1060 {
1061    long int number;
1062 #ifndef HAVE_RANDOM
1063    unsigned int weak_seed;
1064
1065    weak_seed = (unsigned int)((unsigned int)time(NULL) | (unsigned int)range);
1066    srand(weak_seed);
1067    /*
1068     * Some rand implementations aren't that random and return mostly
1069     * lower numbers. Low entropy doesn't matter for the header times, 
1070     * but higher "random" factors are prefered.
1071     */
1072    number = (rand() * 12345) % (long int)(range + 1);
1073    /* Overflows don't matter either, positive numbers do. */
1074    if(number<0)
1075    {
1076       number*= -1;
1077    }
1078 #else
1079    number = random() % range + 1; 
1080 #endif /* (ifndef HAVE_RANDOM) */
1081    return (number);
1082 }
1083
1084
1085 #ifndef HAVE_TIMEGM
1086 /*********************************************************************
1087  *
1088  * Function    :  timegm
1089  *
1090  * Description :  libc replacement function for the inverse of gmtime()
1091  *                Copyright (C) 2004 Free Software Foundation, Inc.
1092  *                Code copied from GnuPG with minor style changes.
1093  *
1094  * Parameters  :
1095  *          1  :  tm: Broken-down time struct.
1096  *
1097  * Returns     :  tm converted into time_t seconds. 
1098  *
1099  *********************************************************************/
1100
1101 time_t timegm(struct tm *tm)
1102 {
1103    time_t answer;
1104    char *zone;
1105
1106    zone=getenv("TZ");
1107    putenv("TZ=UTC");
1108    tzset();
1109    answer=mktime(tm);
1110    if(zone)
1111    {
1112       char *old_zone;
1113
1114       old_zone=malloc(3+strlen(zone)+1);
1115       if(old_zone)
1116       {
1117          strcpy(old_zone,"TZ=");
1118          strcat(old_zone,zone);
1119          putenv(old_zone);      
1120       }
1121    }
1122    else
1123    {
1124 #ifdef HAVE_UNSETENV
1125       unsetenv("TZ");
1126 #else
1127       putenv("TZ");
1128 #endif
1129    }
1130    tzset();
1131    return answer;
1132 }
1133 #endif /* (ifndef HAVE_TIMEGM) */
1134
1135
1136 /*
1137  * What follows is a portable snprintf routine, written by Mark Martinec.
1138  * See: http://www.ijs.si/software/snprintf/
1139  * Anyone who needs it can add a define for themselves... so far, only 
1140  * OS/2 (native) lacks snprintf.
1141
1142                                   snprintf.c
1143                    - a portable implementation of snprintf,
1144        including vsnprintf.c, asnprintf, vasnprintf, asprintf, vasprintf
1145                                        
1146    snprintf is a routine to convert numeric and string arguments to
1147    formatted strings. It is similar to sprintf(3) provided in a system's
1148    C library, yet it requires an additional argument - the buffer size -
1149    and it guarantees never to store anything beyond the given buffer,
1150    regardless of the format or arguments to be formatted. Some newer
1151    operating systems do provide snprintf in their C library, but many do
1152    not or do provide an inadequate (slow or idiosyncratic) version, which
1153    calls for a portable implementation of this routine.
1154
1155 Author
1156
1157    Mark Martinec <mark.martinec@ijs.si>, April 1999, June 2000
1158    Copyright Â© 1999, Mark Martinec
1159
1160  */
1161
1162 #ifdef __OS2__
1163
1164 #define PORTABLE_SNPRINTF_VERSION_MAJOR 2
1165 #define PORTABLE_SNPRINTF_VERSION_MINOR 2
1166
1167 #if defined(NEED_ASPRINTF) || defined(NEED_ASNPRINTF) || defined(NEED_VASPRINTF) || defined(NEED_VASNPRINTF)
1168 # if defined(NEED_SNPRINTF_ONLY)
1169 # undef NEED_SNPRINTF_ONLY
1170 # endif
1171 # if !defined(PREFER_PORTABLE_SNPRINTF)
1172 # define PREFER_PORTABLE_SNPRINTF
1173 # endif
1174 #endif
1175
1176 #if defined(SOLARIS_BUG_COMPATIBLE) && !defined(SOLARIS_COMPATIBLE)
1177 #define SOLARIS_COMPATIBLE
1178 #endif
1179
1180 #if defined(HPUX_BUG_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
1181 #define HPUX_COMPATIBLE
1182 #endif
1183
1184 #if defined(DIGITAL_UNIX_BUG_COMPATIBLE) && !defined(DIGITAL_UNIX_COMPATIBLE)
1185 #define DIGITAL_UNIX_COMPATIBLE
1186 #endif
1187
1188 #if defined(PERL_BUG_COMPATIBLE) && !defined(PERL_COMPATIBLE)
1189 #define PERL_COMPATIBLE
1190 #endif
1191
1192 #if defined(LINUX_BUG_COMPATIBLE) && !defined(LINUX_COMPATIBLE)
1193 #define LINUX_COMPATIBLE
1194 #endif
1195
1196 #include <sys/types.h>
1197 #include <string.h>
1198 #include <stdlib.h>
1199 #include <stdio.h>
1200 #include <stdarg.h>
1201 #include <assert.h>
1202 #include <errno.h>
1203
1204 #ifdef isdigit
1205 #undef isdigit
1206 #endif
1207 #define isdigit(c) ((c) >= '0' && (c) <= '9')
1208
1209 /* For copying strings longer or equal to 'breakeven_point'
1210  * it is more efficient to call memcpy() than to do it inline.
1211  * The value depends mostly on the processor architecture,
1212  * but also on the compiler and its optimization capabilities.
1213  * The value is not critical, some small value greater than zero
1214  * will be just fine if you don't care to squeeze every drop
1215  * of performance out of the code.
1216  *
1217  * Small values favor memcpy, large values favor inline code.
1218  */
1219 #if defined(__alpha__) || defined(__alpha)
1220 #  define breakeven_point   2    /* AXP (DEC Alpha)     - gcc or cc or egcs */
1221 #endif
1222 #if defined(__i386__)  || defined(__i386)
1223 #  define breakeven_point  12    /* Intel Pentium/Linux - gcc 2.96 */
1224 #endif
1225 #if defined(__hppa)
1226 #  define breakeven_point  10    /* HP-PA               - gcc */
1227 #endif
1228 #if defined(__sparc__) || defined(__sparc)
1229 #  define breakeven_point  33    /* Sun Sparc 5         - gcc 2.8.1 */
1230 #endif
1231
1232 /* some other values of possible interest: */
1233 /* #define breakeven_point  8 */ /* VAX 4000          - vaxc */
1234 /* #define breakeven_point 19 */ /* VAX 4000          - gcc 2.7.0 */
1235
1236 #ifndef breakeven_point
1237 #  define breakeven_point   6    /* some reasonable one-size-fits-all value */
1238 #endif
1239
1240 #define fast_memcpy(d,s,n) \
1241   { register size_t nn = (size_t)(n); \
1242     if (nn >= breakeven_point) memcpy((d), (s), nn); \
1243     else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
1244       register char *dd; register const char *ss; \
1245       for (ss=(s), dd=(d); nn>0; nn--) *dd++ = *ss++; } }
1246
1247 #define fast_memset(d,c,n) \
1248   { register size_t nn = (size_t)(n); \
1249     if (nn >= breakeven_point) memset((d), (int)(c), nn); \
1250     else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
1251       register char *dd; register const int cc=(int)(c); \
1252       for (dd=(d); nn>0; nn--) *dd++ = cc; } }
1253
1254 /* prototypes */
1255
1256 #if defined(NEED_ASPRINTF)
1257 int asprintf   (char **ptr, const char *fmt, /*args*/ ...);
1258 #endif
1259 #if defined(NEED_VASPRINTF)
1260 int vasprintf  (char **ptr, const char *fmt, va_list ap);
1261 #endif
1262 #if defined(NEED_ASNPRINTF)
1263 int asnprintf  (char **ptr, size_t str_m, const char *fmt, /*args*/ ...);
1264 #endif
1265 #if defined(NEED_VASNPRINTF)
1266 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap);
1267 #endif
1268
1269 #if defined(HAVE_SNPRINTF)
1270 /* declare our portable snprintf  routine under name portable_snprintf  */
1271 /* declare our portable vsnprintf routine under name portable_vsnprintf */
1272 #else
1273 /* declare our portable routines under names snprintf and vsnprintf */
1274 #define portable_snprintf snprintf
1275 #if !defined(NEED_SNPRINTF_ONLY)
1276 #define portable_vsnprintf vsnprintf
1277 #endif
1278 #endif
1279
1280 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1281 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...);
1282 #if !defined(NEED_SNPRINTF_ONLY)
1283 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap);
1284 #endif
1285 #endif
1286
1287 /* declarations */
1288
1289 static char credits[] = "\n\
1290 @(#)snprintf.c, v2.2: Mark Martinec, <mark.martinec@ijs.si>\n\
1291 @(#)snprintf.c, v2.2: Copyright 1999, Mark Martinec. Frontier Artistic License applies.\n\
1292 @(#)snprintf.c, v2.2: http://www.ijs.si/software/snprintf/\n";
1293
1294 #if defined(NEED_ASPRINTF)
1295 int asprintf(char **ptr, const char *fmt, /*args*/ ...) {
1296   va_list ap;
1297   size_t str_m;
1298   int str_l;
1299
1300   *ptr = NULL;
1301   va_start(ap, fmt);                            /* measure the required size */
1302   str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1303   va_end(ap);
1304   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
1305   *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1306   if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1307   else {
1308     int str_l2;
1309     va_start(ap, fmt);
1310     str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1311     va_end(ap);
1312     assert(str_l2 == str_l);
1313   }
1314   return str_l;
1315 }
1316 #endif
1317
1318 #if defined(NEED_VASPRINTF)
1319 int vasprintf(char **ptr, const char *fmt, va_list ap) {
1320   size_t str_m;
1321   int str_l;
1322
1323   *ptr = NULL;
1324   { va_list ap2;
1325     va_copy(ap2, ap);  /* don't consume the original ap, we'll need it again */
1326     str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1327     va_end(ap2);
1328   }
1329   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
1330   *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1331   if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1332   else {
1333     int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1334     assert(str_l2 == str_l);
1335   }
1336   return str_l;
1337 }
1338 #endif
1339
1340 #if defined(NEED_ASNPRINTF)
1341 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...) {
1342   va_list ap;
1343   int str_l;
1344
1345   *ptr = NULL;
1346   va_start(ap, fmt);                            /* measure the required size */
1347   str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1348   va_end(ap);
1349   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
1350   if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1;      /* truncate */
1351   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1352   if (str_m == 0) {  /* not interested in resulting string, just return size */
1353   } else {
1354     *ptr = (char *) malloc(str_m);
1355     if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1356     else {
1357       int str_l2;
1358       va_start(ap, fmt);
1359       str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1360       va_end(ap);
1361       assert(str_l2 == str_l);
1362     }
1363   }
1364   return str_l;
1365 }
1366 #endif
1367
1368 #if defined(NEED_VASNPRINTF)
1369 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap) {
1370   int str_l;
1371
1372   *ptr = NULL;
1373   { va_list ap2;
1374     va_copy(ap2, ap);  /* don't consume the original ap, we'll need it again */
1375     str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1376     va_end(ap2);
1377   }
1378   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
1379   if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1;      /* truncate */
1380   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1381   if (str_m == 0) {  /* not interested in resulting string, just return size */
1382   } else {
1383     *ptr = (char *) malloc(str_m);
1384     if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1385     else {
1386       int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1387       assert(str_l2 == str_l);
1388     }
1389   }
1390   return str_l;
1391 }
1392 #endif
1393
1394 /*
1395  * If the system does have snprintf and the portable routine is not
1396  * specifically required, this module produces no code for snprintf/vsnprintf.
1397  */
1398 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1399
1400 #if !defined(NEED_SNPRINTF_ONLY)
1401 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1402   va_list ap;
1403   int str_l;
1404
1405   va_start(ap, fmt);
1406   str_l = portable_vsnprintf(str, str_m, fmt, ap);
1407   va_end(ap);
1408   return str_l;
1409 }
1410 #endif
1411
1412 #if defined(NEED_SNPRINTF_ONLY)
1413 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1414 #else
1415 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap) {
1416 #endif
1417
1418 #if defined(NEED_SNPRINTF_ONLY)
1419   va_list ap;
1420 #endif
1421   size_t str_l = 0;
1422   const char *p = fmt;
1423
1424 /* In contrast with POSIX, the ISO C99 now says
1425  * that str can be NULL and str_m can be 0.
1426  * This is more useful than the old:  if (str_m < 1) return -1; */
1427
1428 #if defined(NEED_SNPRINTF_ONLY)
1429   va_start(ap, fmt);
1430 #endif
1431   if (!p) p = "";
1432   while (*p) {
1433     if (*p != '%') {
1434    /* if (str_l < str_m) str[str_l++] = *p++;    -- this would be sufficient */
1435    /* but the following code achieves better performance for cases
1436     * where format string is long and contains few conversions */
1437       const char *q = strchr(p+1,'%');
1438       size_t n = !q ? strlen(p) : (q-p);
1439       if (str_l < str_m) {
1440         size_t avail = str_m-str_l;
1441         fast_memcpy(str+str_l, p, (n>avail?avail:n));
1442       }
1443       p += n; str_l += n;
1444     } else {
1445       const char *starting_p;
1446       size_t min_field_width = 0, precision = 0;
1447       int zero_padding = 0, precision_specified = 0, justify_left = 0;
1448       int alternate_form = 0, force_sign = 0;
1449       int space_for_positive = 1; /* If both the ' ' and '+' flags appear,
1450                                      the ' ' flag should be ignored. */
1451       char length_modifier = '\0';            /* allowed values: \0, h, l, L */
1452       char tmp[32];/* temporary buffer for simple numeric->string conversion */
1453
1454       const char *str_arg;      /* string address in case of string argument */
1455       size_t str_arg_l;         /* natural field width of arg without padding
1456                                    and sign */
1457       unsigned char uchar_arg;
1458         /* unsigned char argument value - only defined for c conversion.
1459            N.B. standard explicitly states the char argument for
1460            the c conversion is unsigned */
1461
1462       size_t number_of_zeros_to_pad = 0;
1463         /* number of zeros to be inserted for numeric conversions
1464            as required by the precision or minimal field width */
1465
1466       size_t zero_padding_insertion_ind = 0;
1467         /* index into tmp where zero padding is to be inserted */
1468
1469       char fmt_spec = '\0';
1470         /* current conversion specifier character */
1471
1472       str_arg = credits;/* just to make compiler happy (defined but not used)*/
1473       str_arg = NULL;
1474       starting_p = p; p++;  /* skip '%' */
1475    /* parse flags */
1476       while (*p == '0' || *p == '-' || *p == '+' ||
1477              *p == ' ' || *p == '#' || *p == '\'') {
1478         switch (*p) {
1479         case '0': zero_padding = 1; break;
1480         case '-': justify_left = 1; break;
1481         case '+': force_sign = 1; space_for_positive = 0; break;
1482         case ' ': force_sign = 1;
1483      /* If both the ' ' and '+' flags appear, the ' ' flag should be ignored */
1484 #ifdef PERL_COMPATIBLE
1485      /* ... but in Perl the last of ' ' and '+' applies */
1486                   space_for_positive = 1;
1487 #endif
1488                   break;
1489         case '#': alternate_form = 1; break;
1490         case '\'': break;
1491         }
1492         p++;
1493       }
1494    /* If the '0' and '-' flags both appear, the '0' flag should be ignored. */
1495
1496    /* parse field width */
1497       if (*p == '*') {
1498         int j;
1499         p++; j = va_arg(ap, int);
1500         if (j >= 0) min_field_width = j;
1501         else { min_field_width = -j; justify_left = 1; }
1502       } else if (isdigit((int)(*p))) {
1503         /* size_t could be wider than unsigned int;
1504            make sure we treat argument like common implementations do */
1505         unsigned int uj = *p++ - '0';
1506         while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1507         min_field_width = uj;
1508       }
1509    /* parse precision */
1510       if (*p == '.') {
1511         p++; precision_specified = 1;
1512         if (*p == '*') {
1513           int j = va_arg(ap, int);
1514           p++;
1515           if (j >= 0) precision = j;
1516           else {
1517             precision_specified = 0; precision = 0;
1518          /* NOTE:
1519           *   Solaris 2.6 man page claims that in this case the precision
1520           *   should be set to 0.  Digital Unix 4.0, HPUX 10 and BSD man page
1521           *   claim that this case should be treated as unspecified precision,
1522           *   which is what we do here.
1523           */
1524           }
1525         } else if (isdigit((int)(*p))) {
1526           /* size_t could be wider than unsigned int;
1527              make sure we treat argument like common implementations do */
1528           unsigned int uj = *p++ - '0';
1529           while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1530           precision = uj;
1531         }
1532       }
1533    /* parse 'h', 'l' and 'll' length modifiers */
1534       if (*p == 'h' || *p == 'l') {
1535         length_modifier = *p; p++;
1536         if (length_modifier == 'l' && *p == 'l') {   /* double l = long long */
1537 #ifdef SNPRINTF_LONGLONG_SUPPORT
1538           length_modifier = '2';                  /* double l encoded as '2' */
1539 #else
1540           length_modifier = 'l';                 /* treat it as a single 'l' */
1541 #endif
1542           p++;
1543         }
1544       }
1545       fmt_spec = *p;
1546    /* common synonyms: */
1547       switch (fmt_spec) {
1548       case 'i': fmt_spec = 'd'; break;
1549       case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
1550       case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
1551       case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
1552       default: break;
1553       }
1554    /* get parameter value, do initial processing */
1555       switch (fmt_spec) {
1556       case '%': /* % behaves similar to 's' regarding flags and field widths */
1557       case 'c': /* c behaves similar to 's' regarding flags and field widths */
1558       case 's':
1559         length_modifier = '\0';          /* wint_t and wchar_t not supported */
1560      /* the result of zero padding flag with non-numeric conversion specifier*/
1561      /* is undefined. Solaris and HPUX 10 does zero padding in this case,    */
1562      /* Digital Unix and Linux does not. */
1563 #if !defined(SOLARIS_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
1564         zero_padding = 0;    /* turn zero padding off for string conversions */
1565 #endif
1566         str_arg_l = 1;
1567         switch (fmt_spec) {
1568         case '%':
1569           str_arg = p; break;
1570         case 'c': {
1571           int j = va_arg(ap, int);
1572           uchar_arg = (unsigned char) j;   /* standard demands unsigned char */
1573           str_arg = (const char *) &uchar_arg;
1574           break;
1575         }
1576         case 's':
1577           str_arg = va_arg(ap, const char *);
1578           if (!str_arg) str_arg_l = 0;
1579        /* make sure not to address string beyond the specified precision !!! */
1580           else if (!precision_specified) str_arg_l = strlen(str_arg);
1581        /* truncate string if necessary as requested by precision */
1582           else if (precision == 0) str_arg_l = 0;
1583           else {
1584        /* memchr on HP does not like n > 2^31  !!! */
1585             const char *q = memchr(str_arg, '\0',
1586                              precision <= 0x7fffffff ? precision : 0x7fffffff);
1587             str_arg_l = !q ? precision : (q-str_arg);
1588           }
1589           break;
1590         default: break;
1591         }
1592         break;
1593       case 'd': case 'u': case 'o': case 'x': case 'X': case 'p': {
1594         /* NOTE: the u, o, x, X and p conversion specifiers imply
1595                  the value is unsigned;  d implies a signed value */
1596
1597         int arg_sign = 0;
1598           /* 0 if numeric argument is zero (or if pointer is NULL for 'p'),
1599             +1 if greater than zero (or nonzero for unsigned arguments),
1600             -1 if negative (unsigned argument is never negative) */
1601
1602         int int_arg = 0;  unsigned int uint_arg = 0;
1603           /* only defined for length modifier h, or for no length modifiers */
1604
1605         long int long_arg = 0;  unsigned long int ulong_arg = 0;
1606           /* only defined for length modifier l */
1607
1608         void *ptr_arg = NULL;
1609           /* pointer argument value -only defined for p conversion */
1610
1611 #ifdef SNPRINTF_LONGLONG_SUPPORT
1612         long long int long_long_arg = 0;
1613         unsigned long long int ulong_long_arg = 0;
1614           /* only defined for length modifier ll */
1615 #endif
1616         if (fmt_spec == 'p') {
1617         /* HPUX 10: An l, h, ll or L before any other conversion character
1618          *   (other than d, i, u, o, x, or X) is ignored.
1619          * Digital Unix:
1620          *   not specified, but seems to behave as HPUX does.
1621          * Solaris: If an h, l, or L appears before any other conversion
1622          *   specifier (other than d, i, u, o, x, or X), the behavior
1623          *   is undefined. (Actually %hp converts only 16-bits of address
1624          *   and %llp treats address as 64-bit data which is incompatible
1625          *   with (void *) argument on a 32-bit system).
1626          */
1627 #ifdef SOLARIS_COMPATIBLE
1628 #  ifdef SOLARIS_BUG_COMPATIBLE
1629           /* keep length modifiers even if it represents 'll' */
1630 #  else
1631           if (length_modifier == '2') length_modifier = '\0';
1632 #  endif
1633 #else
1634           length_modifier = '\0';
1635 #endif
1636           ptr_arg = va_arg(ap, void *);
1637           if (ptr_arg != NULL) arg_sign = 1;
1638         } else if (fmt_spec == 'd') {  /* signed */
1639           switch (length_modifier) {
1640           case '\0':
1641           case 'h':
1642          /* It is non-portable to specify a second argument of char or short
1643           * to va_arg, because arguments seen by the called function
1644           * are not char or short.  C converts char and short arguments
1645           * to int before passing them to a function.
1646           */
1647             int_arg = va_arg(ap, int);
1648             if      (int_arg > 0) arg_sign =  1;
1649             else if (int_arg < 0) arg_sign = -1;
1650             break;
1651           case 'l':
1652             long_arg = va_arg(ap, long int);
1653             if      (long_arg > 0) arg_sign =  1;
1654             else if (long_arg < 0) arg_sign = -1;
1655             break;
1656 #ifdef SNPRINTF_LONGLONG_SUPPORT
1657           case '2':
1658             long_long_arg = va_arg(ap, long long int);
1659             if      (long_long_arg > 0) arg_sign =  1;
1660             else if (long_long_arg < 0) arg_sign = -1;
1661             break;
1662 #endif
1663           }
1664         } else {  /* unsigned */
1665           switch (length_modifier) {
1666           case '\0':
1667           case 'h':
1668             uint_arg = va_arg(ap, unsigned int);
1669             if (uint_arg) arg_sign = 1;
1670             break;
1671           case 'l':
1672             ulong_arg = va_arg(ap, unsigned long int);
1673             if (ulong_arg) arg_sign = 1;
1674             break;
1675 #ifdef SNPRINTF_LONGLONG_SUPPORT
1676           case '2':
1677             ulong_long_arg = va_arg(ap, unsigned long long int);
1678             if (ulong_long_arg) arg_sign = 1;
1679             break;
1680 #endif
1681           }
1682         }
1683         str_arg = tmp; str_arg_l = 0;
1684      /* NOTE:
1685       *   For d, i, u, o, x, and X conversions, if precision is specified,
1686       *   the '0' flag should be ignored. This is so with Solaris 2.6,
1687       *   Digital UNIX 4.0, HPUX 10, Linux, FreeBSD, NetBSD; but not with Perl.
1688       */
1689 #ifndef PERL_COMPATIBLE
1690         if (precision_specified) zero_padding = 0;
1691 #endif
1692         if (fmt_spec == 'd') {
1693           if (force_sign && arg_sign >= 0)
1694             tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1695          /* leave negative numbers for sprintf to handle,
1696             to avoid handling tricky cases like (short int)(-32768) */
1697 #ifdef LINUX_COMPATIBLE
1698         } else if (fmt_spec == 'p' && force_sign && arg_sign > 0) {
1699           tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1700 #endif
1701         } else if (alternate_form) {
1702           if (arg_sign != 0 && (fmt_spec == 'x' || fmt_spec == 'X') )
1703             { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = fmt_spec; }
1704          /* alternate form should have no effect for p conversion, but ... */
1705 #ifdef HPUX_COMPATIBLE
1706           else if (fmt_spec == 'p'
1707          /* HPUX 10: for an alternate form of p conversion,
1708           *          a nonzero result is prefixed by 0x. */
1709 #ifndef HPUX_BUG_COMPATIBLE
1710          /* Actually it uses 0x prefix even for a zero value. */
1711                    && arg_sign != 0
1712 #endif
1713                   ) { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = 'x'; }
1714 #endif
1715         }
1716         zero_padding_insertion_ind = str_arg_l;
1717         if (!precision_specified) precision = 1;   /* default precision is 1 */
1718         if (precision == 0 && arg_sign == 0
1719 #if defined(HPUX_BUG_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1720             && fmt_spec != 'p'
1721          /* HPUX 10 man page claims: With conversion character p the result of
1722           * converting a zero value with a precision of zero is a null string.
1723           * Actually HP returns all zeroes, and Linux returns "(nil)". */
1724 #endif
1725         ) {
1726          /* converted to null string */
1727          /* When zero value is formatted with an explicit precision 0,
1728             the resulting formatted string is empty (d, i, u, o, x, X, p).   */
1729         } else {
1730           char f[5]; int f_l = 0;
1731           f[f_l++] = '%';    /* construct a simple format string for sprintf */
1732           if (!length_modifier) { }
1733           else if (length_modifier=='2') { f[f_l++] = 'l'; f[f_l++] = 'l'; }
1734           else f[f_l++] = length_modifier;
1735           f[f_l++] = fmt_spec; f[f_l++] = '\0';
1736           if (fmt_spec == 'p') str_arg_l += sprintf(tmp+str_arg_l, f, ptr_arg);
1737           else if (fmt_spec == 'd') {  /* signed */
1738             switch (length_modifier) {
1739             case '\0':
1740             case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, int_arg);  break;
1741             case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, long_arg); break;
1742 #ifdef SNPRINTF_LONGLONG_SUPPORT
1743             case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,long_long_arg); break;
1744 #endif
1745             }
1746           } else {  /* unsigned */
1747             switch (length_modifier) {
1748             case '\0':
1749             case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, uint_arg);  break;
1750             case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, ulong_arg); break;
1751 #ifdef SNPRINTF_LONGLONG_SUPPORT
1752             case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,ulong_long_arg);break;
1753 #endif
1754             }
1755           }
1756          /* include the optional minus sign and possible "0x"
1757             in the region before the zero padding insertion point */
1758           if (zero_padding_insertion_ind < str_arg_l &&
1759               tmp[zero_padding_insertion_ind] == '-') {
1760             zero_padding_insertion_ind++;
1761           }
1762           if (zero_padding_insertion_ind+1 < str_arg_l &&
1763               tmp[zero_padding_insertion_ind]   == '0' &&
1764              (tmp[zero_padding_insertion_ind+1] == 'x' ||
1765               tmp[zero_padding_insertion_ind+1] == 'X') ) {
1766             zero_padding_insertion_ind += 2;
1767           }
1768         }
1769         { size_t num_of_digits = str_arg_l - zero_padding_insertion_ind;
1770           if (alternate_form && fmt_spec == 'o'
1771 #ifdef HPUX_COMPATIBLE                                  /* ("%#.o",0) -> ""  */
1772               && (str_arg_l > 0)
1773 #endif
1774 #ifdef DIGITAL_UNIX_BUG_COMPATIBLE                      /* ("%#o",0) -> "00" */
1775 #else
1776               /* unless zero is already the first character */
1777               && !(zero_padding_insertion_ind < str_arg_l
1778                    && tmp[zero_padding_insertion_ind] == '0')
1779 #endif
1780           ) {        /* assure leading zero for alternate-form octal numbers */
1781             if (!precision_specified || precision < num_of_digits+1) {
1782              /* precision is increased to force the first character to be zero,
1783                 except if a zero value is formatted with an explicit precision
1784                 of zero */
1785               precision = num_of_digits+1; precision_specified = 1;
1786             }
1787           }
1788        /* zero padding to specified precision? */
1789           if (num_of_digits < precision) 
1790             number_of_zeros_to_pad = precision - num_of_digits;
1791         }
1792      /* zero padding to specified minimal field width? */
1793         if (!justify_left && zero_padding) {
1794           int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1795           if (n > 0) number_of_zeros_to_pad += n;
1796         }
1797         break;
1798       }
1799       default: /* unrecognized conversion specifier, keep format string as-is*/
1800         zero_padding = 0;  /* turn zero padding off for non-numeric convers. */
1801 #ifndef DIGITAL_UNIX_COMPATIBLE
1802         justify_left = 1; min_field_width = 0;                /* reset flags */
1803 #endif
1804 #if defined(PERL_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1805      /* keep the entire format string unchanged */
1806         str_arg = starting_p; str_arg_l = p - starting_p;
1807      /* well, not exactly so for Linux, which does something inbetween,
1808       * and I don't feel an urge to imitate it: "%+++++hy" -> "%+y"  */
1809 #else
1810      /* discard the unrecognized conversion, just keep *
1811       * the unrecognized conversion character          */
1812         str_arg = p; str_arg_l = 0;
1813 #endif
1814         if (*p) str_arg_l++;  /* include invalid conversion specifier unchanged
1815                                  if not at end-of-string */
1816         break;
1817       }
1818       if (*p) p++;      /* step over the just processed conversion specifier */
1819    /* insert padding to the left as requested by min_field_width;
1820       this does not include the zero padding in case of numerical conversions*/
1821       if (!justify_left) {                /* left padding with blank or zero */
1822         int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1823         if (n > 0) {
1824           if (str_l < str_m) {
1825             size_t avail = str_m-str_l;
1826             fast_memset(str+str_l, (zero_padding?'0':' '), (n>avail?avail:n));
1827           }
1828           str_l += n;
1829         }
1830       }
1831    /* zero padding as requested by the precision or by the minimal field width
1832     * for numeric conversions required? */
1833       if (number_of_zeros_to_pad <= 0) {
1834      /* will not copy first part of numeric right now, *
1835       * force it to be copied later in its entirety    */
1836         zero_padding_insertion_ind = 0;
1837       } else {
1838      /* insert first part of numerics (sign or '0x') before zero padding */
1839         int n = zero_padding_insertion_ind;
1840         if (n > 0) {
1841           if (str_l < str_m) {
1842             size_t avail = str_m-str_l;
1843             fast_memcpy(str+str_l, str_arg, (n>avail?avail:n));
1844           }
1845           str_l += n;
1846         }
1847      /* insert zero padding as requested by the precision or min field width */
1848         n = number_of_zeros_to_pad;
1849         if (n > 0) {
1850           if (str_l < str_m) {
1851             size_t avail = str_m-str_l;
1852             fast_memset(str+str_l, '0', (n>avail?avail:n));
1853           }
1854           str_l += n;
1855         }
1856       }
1857    /* insert formatted string
1858     * (or as-is conversion specifier for unknown conversions) */
1859       { int n = str_arg_l - zero_padding_insertion_ind;
1860         if (n > 0) {
1861           if (str_l < str_m) {
1862             size_t avail = str_m-str_l;
1863             fast_memcpy(str+str_l, str_arg+zero_padding_insertion_ind,
1864                         (n>avail?avail:n));
1865           }
1866           str_l += n;
1867         }
1868       }
1869    /* insert right padding */
1870       if (justify_left) {          /* right blank padding to the field width */
1871         int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1872         if (n > 0) {
1873           if (str_l < str_m) {
1874             size_t avail = str_m-str_l;
1875             fast_memset(str+str_l, ' ', (n>avail?avail:n));
1876           }
1877           str_l += n;
1878         }
1879       }
1880     }
1881   }
1882 #if defined(NEED_SNPRINTF_ONLY)
1883   va_end(ap);
1884 #endif
1885   if (str_m > 0) { /* make sure the string is null-terminated
1886                       even at the expense of overwriting the last character
1887                       (shouldn't happen, but just in case) */
1888     str[str_l <= str_m-1 ? str_l : str_m-1] = '\0';
1889   }
1890   /* Return the number of characters formatted (excluding trailing null
1891    * character), that is, the number of characters that would have been
1892    * written to the buffer if it were large enough.
1893    *
1894    * The value of str_l should be returned, but str_l is of unsigned type
1895    * size_t, and snprintf is int, possibly leading to an undetected
1896    * integer overflow, resulting in a negative return value, which is illegal.
1897    * Both XSH5 and ISO C99 (at least the draft) are silent on this issue.
1898    * Should errno be set to EOVERFLOW and EOF returned in this case???
1899    */
1900   return (int) str_l;
1901 }
1902 #endif
1903 #endif /* __OS2__ */
1904 /*
1905   Local Variables:
1906   tab-width: 3
1907   end:
1908 */