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