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