miscutil.c

   1 const char miscutil_rcs[] = "$Id: miscutil.c,v 1.82 2016/07/23 23:05:15 ler762 Exp $";
   2 /*********************************************************************
   3  *
   4  * File        :  $Source: /cvsroot/ijbswa/current/miscutil.c,v $
   5  *
   6  * Purpose     :  zalloc, hash_string, strcmpic, strncmpic, and
   7  *                MinGW32 strdup functions.  These are each too small
   8  *                to deserve their own file but don't really fit in
   9  *                any other file.
  10  *
  11  * Copyright   :  Written by and Copyright (C) 2001-2016 the
  12  *                Privoxy team. http://www.privoxy.org/
  13  *
  14  *                Based on the Internet Junkbuster originally written
  15  *                by and Copyright (C) 1997 Anonymous Coders and
  16  *                Junkbusters Corporation.  http://www.junkbusters.com
  17  *
  18  *                The timegm replacement function was taken from GnuPG,
  19  *                Copyright (C) 2004 Free Software Foundation, Inc.
  20  *
  21  *                The snprintf replacement function is written by
  22  *                Mark Martinec who also holds the copyright. It can be
  23  *                used under the terms of the GPL or the terms of the
  24  *                "Frontier Artistic License".
  25  *
  26  *                This program is free software; you can redistribute it
  27  *                and/or modify it under the terms of the GNU General
  28  *                Public License as published by the Free Software
  29  *                Foundation; either version 2 of the License, or (at
  30  *                your option) any later version.
  31  *
  32  *                This program is distributed in the hope that it will
  33  *                be useful, but WITHOUT ANY WARRANTY; without even the
  34  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  35  *                PARTICULAR PURPOSE.  See the GNU General Public
  36  *                License for more details.
  37  *
  38  *                The GNU General Public License should be included with
  39  *                this file.  If not, you can view it at
  40  *                http://www.gnu.org/copyleft/gpl.html
  41  *                or write to the Free Software Foundation, Inc., 59
  42  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  43  *
  44  *********************************************************************/
  45
  46
  47 #include "config.h"
  48
  49 #include <stdio.h>
  50 #include <sys/types.h>
  51 #include <stdlib.h>
  52 #if !defined(_WIN32) && !defined(__OS2__)
  53 #include <unistd.h>
  54 #endif /* #if !defined(_WIN32) && !defined(__OS2__) */
  55 #include <string.h>
  56 #include <ctype.h>
  57 #include <assert.h>
  58
  59 #if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
  60 #include <time.h>
  61 #endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
  62
  63 #include "project.h"
  64 #include "miscutil.h"
  65 #include "errlog.h"
  66 #include "jcc.h"
  67
  68 const char miscutil_h_rcs[] = MISCUTIL_H_VERSION;
  69
  70 /*********************************************************************
  71  *
  72  * Function    :  zalloc
  73  *
  74  * Description :  Malloc some memory and set it to '\0'.
  75  *
  76  * Parameters  :
  77  *          1  :  size = Size of memory chunk to return.
  78  *
  79  * Returns     :  Pointer to newly malloc'd memory chunk.
  80  *
  81  *********************************************************************/
  82 void *zalloc(size_t size)
  83 {
  84    void * ret;
  85
  86    if ((ret = (void *)malloc(size)) != NULL)
  87    {
  88       memset(ret, 0, size);
  89    }
  90
  91    return(ret);
  92
  93 }
  94
  95
  96 /*********************************************************************
  97  *
  98  * Function    :  zalloc_or_die
  99  *
 100  * Description :  zalloc wrapper that either succeeds or causes
 101  *                program termination.
 102  *
 103  *                Useful in situations were the string length is
 104  *                "small" and zalloc() failures couldn't be handled
 105  *                better anyway. In case of debug builds, failures
 106  *                trigger an assert().
 107  *
 108  * Parameters  :
 109  *          1  :  size = Size of memory chunk to return.
 110  *
 111  * Returns     :  Pointer to newly malloc'd memory chunk.
 112  *
 113  *********************************************************************/
 114 void *zalloc_or_die(size_t size)
 115 {
 116    void *buffer;
 117
 118    buffer = zalloc(size);
 119    if (buffer == NULL)
 120    {
 121       assert(buffer != NULL);
 122       log_error(LOG_LEVEL_FATAL, "Out of memory in zalloc_or_die().");
 123       exit(1);
 124    }
 125
 126    return(buffer);
 127
 128 }
 129
 130 /*********************************************************************
 131  *
 132  * Function    :  strdup_or_die
 133  *
 134  * Description :  strdup wrapper that either succeeds or causes
 135  *                program termination.
 136  *
 137  *                Useful in situations were the string length is
 138  *                "small" and strdup() failures couldn't be handled
 139  *                better anyway. In case of debug builds, failures
 140  *                trigger an assert().
 141  *
 142  * Parameters  :
 143  *          1  :  str = String to duplicate
 144  *
 145  * Returns     :  Pointer to newly strdup'd copy of the string.
 146  *
 147  *********************************************************************/
 148 char *strdup_or_die(const char *str)
 149 {
 150    char *new_str;
 151
 152    new_str = strdup(str);
 153
 154    if (new_str == NULL)
 155    {
 156       assert(new_str != NULL);
 157       log_error(LOG_LEVEL_FATAL, "Out of memory in strdup_or_die().");
 158       exit(1);
 159    }
 160
 161    return(new_str);
 162
 163 }
 164
 165
 166 /*********************************************************************
 167  *
 168  * Function    :  malloc_or_die
 169  *
 170  * Description :  malloc wrapper that either succeeds or causes
 171  *                program termination.
 172  *
 173  *                Useful in situations were the buffer size is "small"
 174  *                and malloc() failures couldn't be handled better
 175  *                anyway. In case of debug builds, failures trigger
 176  *                an assert().
 177  *
 178  * Parameters  :
 179  *          1  :  buffer_size = Size of the space to allocate
 180  *
 181  * Returns     :  Pointer to newly malloc'd memory
 182  *
 183  *********************************************************************/
 184 void *malloc_or_die(size_t buffer_size)
 185 {
 186    char *new_buf;
 187
 188    if (buffer_size == 0)
 189    {
 190       log_error(LOG_LEVEL_ERROR,
 191          "malloc_or_die() called with buffer size 0");
 192       assert(buffer_size != 0);
 193       buffer_size = 4096;
 194    }
 195
 196    new_buf = malloc(buffer_size);
 197
 198    if (new_buf == NULL)
 199    {
 200       assert(new_buf != NULL);
 201       log_error(LOG_LEVEL_FATAL, "Out of memory in malloc_or_die().");
 202       exit(1);
 203    }
 204
 205    return(new_buf);
 206
 207 }
 208
 209
 210 #if defined(unix)
 211 /*********************************************************************
 212  *
 213  * Function    :  write_pid_file
 214  *
 215  * Description :  Writes a pid file with the pid of the main process
 216  *
 217  * Parameters  :  None
 218  *
 219  * Returns     :  N/A
 220  *
 221  *********************************************************************/
 222 void write_pid_file(void)
 223 {
 224    FILE   *fp;
 225
 226    /*
 227     * If no --pidfile option was given,
 228     * we can live without one.
 229     */
 230    if (pidfile == NULL) return;
 231
 232    if ((fp = fopen(pidfile, "w")) == NULL)
 233    {
 234       log_error(LOG_LEVEL_INFO, "can't open pidfile '%s': %E", pidfile);
 235    }
 236    else
 237    {
 238       fprintf(fp, "%u\n", (unsigned int) getpid());
 239       fclose (fp);
 240    }
 241    return;
 242
 243 }
 244 #endif /* def unix */
 245
 246
 247 /*********************************************************************
 248  *
 249  * Function    :  hash_string
 250  *
 251  * Description :  Take a string and compute a (hopefuly) unique numeric
 252  *                integer value. This is useful to "switch" a string.
 253  *
 254  * Parameters  :
 255  *          1  :  s : string to be hashed.
 256  *
 257  * Returns     :  The string's hash
 258  *
 259  *********************************************************************/
 260 unsigned int hash_string(const char* s)
 261 {
 262    unsigned int h = 0;
 263
 264    for (; *s; ++s)
 265    {
 266       h = 5 * h + (unsigned int)*s;
 267    }
 268
 269    return (h);
 270
 271 }
 272
 273
 274 /*********************************************************************
 275  *
 276  * Function    :  strcmpic
 277  *
 278  * Description :  Case insensitive string comparison
 279  *
 280  * Parameters  :
 281  *          1  :  s1 = string 1 to compare
 282  *          2  :  s2 = string 2 to compare
 283  *
 284  * Returns     :  0 if s1==s2, Negative if s1<s2, Positive if s1>s2
 285  *
 286  *********************************************************************/
 287 int strcmpic(const char *s1, const char *s2)
 288 {
 289    if (!s1) s1 = "";
 290    if (!s2) s2 = "";
 291
 292    while (*s1 && *s2)
 293    {
 294       if ((*s1 != *s2) && (privoxy_tolower(*s1) != privoxy_tolower(*s2)))
 295       {
 296          break;
 297       }
 298       s1++, s2++;
 299    }
 300    return(privoxy_tolower(*s1) - privoxy_tolower(*s2));
 301
 302 }
 303
 304
 305 /*********************************************************************
 306  *
 307  * Function    :  strncmpic
 308  *
 309  * Description :  Case insensitive string comparison (up to n characters)
 310  *
 311  * Parameters  :
 312  *          1  :  s1 = string 1 to compare
 313  *          2  :  s2 = string 2 to compare
 314  *          3  :  n = maximum characters to compare
 315  *
 316  * Returns     :  0 if s1==s2, Negative if s1<s2, Positive if s1>s2
 317  *
 318  *********************************************************************/
 319 int strncmpic(const char *s1, const char *s2, size_t n)
 320 {
 321    if (n <= (size_t)0) return(0);
 322    if (!s1) s1 = "";
 323    if (!s2) s2 = "";
 324
 325    while (*s1 && *s2)
 326    {
 327       if ((*s1 != *s2) && (privoxy_tolower(*s1) != privoxy_tolower(*s2)))
 328       {
 329          break;
 330       }
 331
 332       if (--n <= (size_t)0) break;
 333
 334       s1++, s2++;
 335    }
 336    return(privoxy_tolower(*s1) - privoxy_tolower(*s2));
 337
 338 }
 339
 340
 341 /*********************************************************************
 342  *
 343  * Function    :  chomp
 344  *
 345  * Description :  In-situ-eliminate all leading and trailing whitespace
 346  *                from a string.
 347  *
 348  * Parameters  :
 349  *          1  :  s : string to be chomped.
 350  *
 351  * Returns     :  chomped string
 352  *
 353  *********************************************************************/
 354 char *chomp(char *string)
 355 {
 356    char *p, *q, *r;
 357
 358    /*
 359     * strip trailing whitespace
 360     */
 361    p = string + strlen(string);
 362    while (p > string && privoxy_isspace(*(p-1)))
 363    {
 364       p--;
 365    }
 366    *p = '\0';
 367
 368    /*
 369     * find end of leading whitespace
 370     */
 371    q = r = string;
 372    while (*q && privoxy_isspace(*q))
 373    {
 374       q++;
 375    }
 376
 377    /*
 378     * if there was any, move the rest forwards
 379     */
 380    if (q != string)
 381    {
 382       while (q <= p)
 383       {
 384          *r++ = *q++;
 385       }
 386    }
 387
 388    return(string);
 389
 390 }
 391
 392
 393 /*********************************************************************
 394  *
 395  * Function    :  string_append
 396  *
 397  * Description :  Reallocate target_string and append text to it.
 398  *                This makes it easier to append to malloc'd strings.
 399  *                This is similar to the (removed) strsav(), but
 400  *                running out of memory isn't catastrophic.
 401  *
 402  *                Programming style:
 403  *
 404  *                The following style provides sufficient error
 405  *                checking for this routine, with minimal clutter
 406  *                in the source code.  It is recommended if you
 407  *                have many calls to this function:
 408  *
 409  *                char * s = strdup(...); // don't check for error
 410  *                string_append(&s, ...);  // don't check for error
 411  *                string_append(&s, ...);  // don't check for error
 412  *                string_append(&s, ...);  // don't check for error
 413  *                if (NULL == s) { ... handle error ... }
 414  *
 415  *                OR, equivalently:
 416  *
 417  *                char * s = strdup(...); // don't check for error
 418  *                string_append(&s, ...);  // don't check for error
 419  *                string_append(&s, ...);  // don't check for error
 420  *                if (string_append(&s, ...)) {... handle error ...}
 421  *
 422  * Parameters  :
 423  *          1  :  target_string = Pointer to old text that is to be
 424  *                extended.  *target_string will be free()d by this
 425  *                routine.  target_string must be non-NULL.
 426  *                If *target_string is NULL, this routine will
 427  *                do nothing and return with an error - this allows
 428  *                you to make many calls to this routine and only
 429  *                check for errors after the last one.
 430  *          2  :  text_to_append = Text to be appended to old.
 431  *                Must not be NULL.
 432  *
 433  * Returns     :  JB_ERR_OK on success, and sets *target_string
 434  *                   to newly malloc'ed appended string.  Caller
 435  *                   must free(*target_string).
 436  *                JB_ERR_MEMORY on out-of-memory.  (And free()s
 437  *                   *target_string and sets it to NULL).
 438  *                JB_ERR_MEMORY if *target_string is NULL.
 439  *
 440  *********************************************************************/
 441 jb_err string_append(char **target_string, const char *text_to_append)
 442 {
 443    size_t old_len;
 444    char *new_string;
 445    size_t new_size;
 446
 447    assert(target_string);
 448    assert(text_to_append);
 449
 450    if (*target_string == NULL)
 451    {
 452       return JB_ERR_MEMORY;
 453    }
 454
 455    if (*text_to_append == '\0')
 456    {
 457       return JB_ERR_OK;
 458    }
 459
 460    old_len = strlen(*target_string);
 461
 462    new_size = strlen(text_to_append) + old_len + 1;
 463
 464    if (NULL == (new_string = realloc(*target_string, new_size)))
 465    {
 466       free(*target_string);
 467
 468       *target_string = NULL;
 469       return JB_ERR_MEMORY;
 470    }
 471
 472    strlcpy(new_string + old_len, text_to_append, new_size - old_len);
 473
 474    *target_string = new_string;
 475    return JB_ERR_OK;
 476 }
 477
 478
 479 /*********************************************************************
 480  *
 481  * Function    :  string_join
 482  *
 483  * Description :  Join two strings together.  Frees BOTH the original
 484  *                strings.  If either or both input strings are NULL,
 485  *                fails as if it had run out of memory.
 486  *
 487  *                For comparison, string_append requires that the
 488  *                second string is non-NULL, and doesn't free it.
 489  *
 490  *                Rationale: Too often, we want to do
 491  *                string_append(s, html_encode(s2)).  That assert()s
 492  *                if s2 is NULL or if html_encode() runs out of memory.
 493  *                It also leaks memory.  Proper checking is cumbersome.
 494  *                The solution: string_join(s, html_encode(s2)) is safe,
 495  *                and will free the memory allocated by html_encode().
 496  *
 497  * Parameters  :
 498  *          1  :  target_string = Pointer to old text that is to be
 499  *                extended.  *target_string will be free()d by this
 500  *                routine.  target_string must be non-NULL.
 501  *          2  :  text_to_append = Text to be appended to old.
 502  *
 503  * Returns     :  JB_ERR_OK on success, and sets *target_string
 504  *                   to newly malloc'ed appended string.  Caller
 505  *                   must free(*target_string).
 506  *                JB_ERR_MEMORY on out-of-memory, or if
 507  *                   *target_string or text_to_append is NULL.  (In
 508  *                   this case, frees *target_string and text_to_append,
 509  *                   sets *target_string to NULL).
 510  *
 511  *********************************************************************/
 512 jb_err string_join(char **target_string, char *text_to_append)
 513 {
 514    jb_err err;
 515
 516    assert(target_string);
 517
 518    if (text_to_append == NULL)
 519    {
 520       freez(*target_string);
 521       return JB_ERR_MEMORY;
 522    }
 523
 524    err = string_append(target_string, text_to_append);
 525
 526    freez(text_to_append);
 527
 528    return err;
 529 }
 530
 531
 532 /*********************************************************************
 533  *
 534  * Function    :  string_toupper
 535  *
 536  * Description :  Produce a copy of string with all convertible
 537  *                characters converted to uppercase.
 538  *
 539  * Parameters  :
 540  *          1  :  string = string to convert
 541  *
 542  * Returns     :  Uppercase copy of string if possible,
 543  *                NULL on out-of-memory or if string was NULL.
 544  *
 545  *********************************************************************/
 546 char *string_toupper(const char *string)
 547 {
 548    char *result, *p;
 549    const char *q;
 550
 551    if (!string || ((result = (char *) zalloc(strlen(string) + 1)) == NULL))
 552    {
 553       return NULL;
 554    }
 555
 556    q = string;
 557    p = result;
 558
 559    while (*q != '\0')
 560    {
 561       *p++ = (char)toupper((int) *q++);
 562    }
 563
 564    return result;
 565
 566 }
 567
 568
 569 /*********************************************************************
 570  *
 571  * Function    :  string_move
 572  *
 573  * Description :  memmove wrapper to move the last part of a string
 574  *                towards the beginning, overwriting the part in
 575  *                the middle. strlcpy() can't be used here as the
 576  *                strings overlap.
 577  *
 578  * Parameters  :
 579  *          1  :  dst = Destination to overwrite
 580  *          2  :  src = Source to move.
 581  *
 582  * Returns     :  N/A
 583  *
 584  *********************************************************************/
 585 void string_move(char *dst, char *src)
 586 {
 587    assert(dst < src);
 588
 589    /* +1 to copy the terminating nul as well. */
 590    memmove(dst, src, strlen(src)+1);
 591 }
 592
 593
 594 /*********************************************************************
 595  *
 596  * Function    :  bindup
 597  *
 598  * Description :  Duplicate the first n characters of a string that may
 599  *                contain '\0' characters.
 600  *
 601  * Parameters  :
 602  *          1  :  string = string to be duplicated
 603  *          2  :  len = number of bytes to duplicate
 604  *
 605  * Returns     :  pointer to copy, or NULL if failiure
 606  *
 607  *********************************************************************/
 608 char *bindup(const char *string, size_t len)
 609 {
 610    char *duplicate;
 611
 612    duplicate = (char *)malloc(len);
 613    if (NULL != duplicate)
 614    {
 615       memcpy(duplicate, string, len);
 616    }
 617
 618    return duplicate;
 619
 620 }
 621
 622
 623 /*********************************************************************
 624  *
 625  * Function    :  make_path
 626  *
 627  * Description :  Takes a directory name and a file name, returns
 628  *                the complete path.  Handles windows/unix differences.
 629  *                If the file name is already an absolute path, or if
 630  *                the directory name is NULL or empty, it returns
 631  *                the filename.
 632  *
 633  * Parameters  :
 634  *          1  :  dir: Name of directory or NULL for none.
 635  *          2  :  file: Name of file.  Should not be NULL or empty.
 636  *
 637  * Returns     :  "dir/file" (Or on windows, "dir\file").
 638  *                It allocates the string on the heap.  Caller frees.
 639  *                Returns NULL in error (i.e. NULL file or out of
 640  *                memory)
 641  *
 642  *********************************************************************/
 643 char * make_path(const char * dir, const char * file)
 644 {
 645 #ifdef AMIGA
 646    char path[512];
 647
 648    if (dir)
 649    {
 650       if (dir[0] == '.')
 651       {
 652          if (dir[1] == '/')
 653          {
 654             strncpy(path,dir+2,512);
 655          }
 656          else
 657          {
 658             strncpy(path,dir+1,512);
 659          }
 660       }
 661       else
 662       {
 663          strncpy(path,dir,512);
 664       }
 665       path[511]=0;
 666    }
 667    else
 668    {
 669       path[0]=0;
 670    }
 671    if (AddPart(path,file,512))
 672    {
 673       return strdup(path);
 674    }
 675    else
 676    {
 677       return NULL;
 678    }
 679 #else /* ndef AMIGA */
 680
 681    if ((file == NULL) || (*file == '\0'))
 682    {
 683       return NULL; /* Error */
 684    }
 685
 686    if ((dir == NULL) || (*dir == '\0') /* No directory specified */
 687 #if defined(_WIN32) || defined(__OS2__)
 688       || (*file == '\\') || (file[1] == ':') /* Absolute path (DOS) */
 689 #else /* ifndef _WIN32 || __OS2__ */
 690       || (*file == '/') /* Absolute path (U*ix) */
 691 #endif /* ifndef _WIN32 || __OS2__  */
 692       )
 693    {
 694       return strdup(file);
 695    }
 696    else
 697    {
 698       char * path;
 699       size_t path_size = strlen(dir) + strlen(file) + 2; /* +2 for trailing (back)slash and \0 */
 700
 701 #if defined(unix)
 702       if (*dir != '/' && basedir && *basedir)
 703       {
 704          /*
 705           * Relative path, so start with the base directory.
 706           */
 707          path_size += strlen(basedir) + 1; /* +1 for the slash */
 708          path = malloc(path_size);
 709          if (!path) log_error(LOG_LEVEL_FATAL, "malloc failed!");
 710          strlcpy(path, basedir, path_size);
 711          strlcat(path, "/", path_size);
 712          strlcat(path, dir, path_size);
 713       }
 714       else
 715 #endif /* defined unix */
 716       {
 717          path = malloc(path_size);
 718          if (!path) log_error(LOG_LEVEL_FATAL, "malloc failed!");
 719          strlcpy(path, dir, path_size);
 720       }
 721
 722       assert(NULL != path);
 723 #if defined(_WIN32) || defined(__OS2__)
 724       if (path[strlen(path)-1] != '\\')
 725       {
 726          strlcat(path, "\\", path_size);
 727       }
 728 #else /* ifndef _WIN32 || __OS2__ */
 729       if (path[strlen(path)-1] != '/')
 730       {
 731          strlcat(path, "/", path_size);
 732       }
 733 #endif /* ifndef _WIN32 || __OS2__ */
 734       strlcat(path, file, path_size);
 735
 736       return path;
 737    }
 738 #endif /* ndef AMIGA */
 739 }
 740
 741
 742 /*********************************************************************
 743  *
 744  * Function    :  pick_from_range
 745  *
 746  * Description :  Pick a positive number out of a given range.
 747  *                Should only be used if randomness would be nice,
 748  *                but isn't really necessary.
 749  *
 750  * Parameters  :
 751  *          1  :  range: Highest possible number to pick.
 752  *
 753  * Returns     :  Picked number.
 754  *
 755  *********************************************************************/
 756 long int pick_from_range(long int range)
 757 {
 758    long int number;
 759 #ifdef _WIN32
 760    static unsigned long seed = 0;
 761 #endif /* def _WIN32 */
 762
 763    assert(range != 0);
 764    assert(range > 0);
 765
 766    if (range <= 0) return 0;
 767
 768 #ifdef HAVE_ARC4RANDOM
 769    number = arc4random() % range + 1;
 770 #elif defined(HAVE_RANDOM)
 771    number = random() % range + 1;
 772 #elif defined(MUTEX_LOCKS_AVAILABLE)
 773    privoxy_mutex_lock(&rand_mutex);
 774 #ifdef _WIN32
 775    if (!seed)
 776    {
 777       seed = (unsigned long)(GetCurrentThreadId()+GetTickCount());
 778    }
 779    srand(seed);
 780    seed = (unsigned long)((rand() << 16) + rand());
 781 #endif /* def _WIN32 */
 782    number = (unsigned long)((rand() << 16) + (rand())) % (unsigned long)(range + 1);
 783    privoxy_mutex_unlock(&rand_mutex);
 784 #else
 785    /*
 786     * XXX: Which platforms reach this and are there
 787     * better options than just using rand() and hoping
 788     * that it's safe?
 789     */
 790    log_error(LOG_LEVEL_INFO, "No thread-safe PRNG available? Header time randomization "
 791       "might cause crashes, predictable results or even combine these fine options.");
 792    number = rand() % (long int)(range + 1);
 793
 794 #endif /* (def HAVE_ARC4RANDOM) */
 795
 796    return number;
 797 }
 798
 799
 800 #ifdef USE_PRIVOXY_STRLCPY
 801 /*********************************************************************
 802  *
 803  * Function    :  privoxy_strlcpy
 804  *
 805  * Description :  strlcpy(3) look-alike for those without decent libc.
 806  *
 807  * Parameters  :
 808  *          1  :  destination: buffer to copy into.
 809  *          2  :  source: String to copy.
 810  *          3  :  size: Size of destination buffer.
 811  *
 812  * Returns     :  The length of the string that privoxy_strlcpy() tried to create.
 813  *
 814  *********************************************************************/
 815 size_t privoxy_strlcpy(char *destination, const char *source, const size_t size)
 816 {
 817    if (0 < size)
 818    {
 819       snprintf(destination, size, "%s", source);
 820       /*
 821        * Platforms that lack strlcpy() also tend to have
 822        * a broken snprintf implementation that doesn't
 823        * guarantee nul termination.
 824        *
 825        * XXX: the configure script should detect and reject those.
 826        */
 827       destination[size-1] = '\0';
 828    }
 829    return strlen(source);
 830 }
 831 #endif /* def USE_PRIVOXY_STRLCPY */
 832
 833
 834 #ifndef HAVE_STRLCAT
 835 /*********************************************************************
 836  *
 837  * Function    :  privoxy_strlcat
 838  *
 839  * Description :  strlcat(3) look-alike for those without decent libc.
 840  *
 841  * Parameters  :
 842  *          1  :  destination: C string.
 843  *          2  :  source: String to copy.
 844  *          3  :  size: Size of destination buffer.
 845  *
 846  * Returns     :  The length of the string that privoxy_strlcat() tried to create.
 847  *
 848  *********************************************************************/
 849 size_t privoxy_strlcat(char *destination, const char *source, const size_t size)
 850 {
 851    const size_t old_length = strlen(destination);
 852    return old_length + strlcpy(destination + old_length, source, size - old_length);
 853 }
 854 #endif /* ndef HAVE_STRLCAT */
 855
 856
 857 #if !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV)
 858 /*********************************************************************
 859  *
 860  * Function    :  timegm
 861  *
 862  * Description :  libc replacement function for the inverse of gmtime().
 863  *                Copyright (C) 2004 Free Software Foundation, Inc.
 864  *
 865  *                Code originally copied from GnuPG, modifications done
 866  *                for Privoxy: style changed, #ifdefs for _WIN32 added
 867  *                to have it work on mingw32.
 868  *
 869  *                XXX: It's very unlikely to happen, but if the malloc()
 870  *                call fails the time zone will be permanently set to UTC.
 871  *
 872  * Parameters  :
 873  *          1  :  tm: Broken-down time struct.
 874  *
 875  * Returns     :  tm converted into time_t seconds.
 876  *
 877  *********************************************************************/
 878 time_t timegm(struct tm *tm)
 879 {
 880    time_t answer;
 881    char *zone;
 882
 883    zone = getenv("TZ");
 884    putenv("TZ=UTC");
 885    tzset();
 886    answer = mktime(tm);
 887    if (zone)
 888    {
 889       char *old_zone;
 890
 891       old_zone = malloc(3 + strlen(zone) + 1);
 892       if (old_zone)
 893       {
 894          strcpy(old_zone, "TZ=");
 895          strcat(old_zone, zone);
 896          putenv(old_zone);
 897 #ifdef _WIN32
 898          /* http://man7.org/linux/man-pages/man3/putenv.3.html
 899           *   int putenv(char *string);
 900           *     The string pointed to by string becomes part of the environment, so altering the
 901           *     string changes the environment.
 902           * In other words, the memory pointed to by *string is used until
 903           *   a) another call to putenv() with the same e-var name
 904           *   b) the program exits
 905           *
 906           * Windows e-vars don't work that way, so let's not leak memory.
 907           */
 908          free(old_zone);
 909 #endif /* def _WIN32 */
 910       }
 911    }
 912    else
 913    {
 914 #ifdef HAVE_UNSETENV
 915       unsetenv("TZ");
 916 #elif defined(_WIN32)
 917       putenv("TZ=");
 918 #else
 919       putenv("TZ");
 920 #endif
 921    }
 922    tzset();
 923
 924    return answer;
 925 }
 926 #endif /* !defined(HAVE_TIMEGM) && defined(HAVE_TZSET) && defined(HAVE_PUTENV) */
 927
 928
 929 #ifndef HAVE_SNPRINTF
 930 /*
 931  * What follows is a portable snprintf routine, written by Mark Martinec.
 932  * See: http://www.ijs.si/software/snprintf/
 933
 934                                   snprintf.c
 935                    - a portable implementation of snprintf,
 936        including vsnprintf.c, asnprintf, vasnprintf, asprintf, vasprintf
 937
 938    snprintf is a routine to convert numeric and string arguments to
 939    formatted strings. It is similar to sprintf(3) provided in a system's
 940    C library, yet it requires an additional argument - the buffer size -
 941    and it guarantees never to store anything beyond the given buffer,
 942    regardless of the format or arguments to be formatted. Some newer
 943    operating systems do provide snprintf in their C library, but many do
 944    not or do provide an inadequate (slow or idiosyncratic) version, which
 945    calls for a portable implementation of this routine.
 946
 947 Author
 948
 949    Mark Martinec <mark.martinec@ijs.si>, April 1999, June 2000
 950    Copyright © 1999, Mark Martinec
 951
 952  */
 953
 954 #define PORTABLE_SNPRINTF_VERSION_MAJOR 2
 955 #define PORTABLE_SNPRINTF_VERSION_MINOR 2
 956
 957 #if defined(NEED_ASPRINTF) || defined(NEED_ASNPRINTF) || defined(NEED_VASPRINTF) || defined(NEED_VASNPRINTF)
 958 # if defined(NEED_SNPRINTF_ONLY)
 959 # undef NEED_SNPRINTF_ONLY
 960 # endif
 961 # if !defined(PREFER_PORTABLE_SNPRINTF)
 962 # define PREFER_PORTABLE_SNPRINTF
 963 # endif
 964 #endif
 965
 966 #if defined(SOLARIS_BUG_COMPATIBLE) && !defined(SOLARIS_COMPATIBLE)
 967 #define SOLARIS_COMPATIBLE
 968 #endif
 969
 970 #if defined(HPUX_BUG_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
 971 #define HPUX_COMPATIBLE
 972 #endif
 973
 974 #if defined(DIGITAL_UNIX_BUG_COMPATIBLE) && !defined(DIGITAL_UNIX_COMPATIBLE)
 975 #define DIGITAL_UNIX_COMPATIBLE
 976 #endif
 977
 978 #if defined(PERL_BUG_COMPATIBLE) && !defined(PERL_COMPATIBLE)
 979 #define PERL_COMPATIBLE
 980 #endif
 981
 982 #if defined(LINUX_BUG_COMPATIBLE) && !defined(LINUX_COMPATIBLE)
 983 #define LINUX_COMPATIBLE
 984 #endif
 985
 986 #include <sys/types.h>
 987 #include <string.h>
 988 #include <stdlib.h>
 989 #include <stdio.h>
 990 #include <stdarg.h>
 991 #include <assert.h>
 992 #include <errno.h>
 993
 994 #ifdef isdigit
 995 #undef isdigit
 996 #endif
 997 #define isdigit(c) ((c) >= '0' && (c) <= '9')
 998
 999 /* For copying strings longer or equal to 'breakeven_point'
1000  * it is more efficient to call memcpy() than to do it inline.
1001  * The value depends mostly on the processor architecture,
1002  * but also on the compiler and its optimization capabilities.
1003  * The value is not critical, some small value greater than zero
1004  * will be just fine if you don't care to squeeze every drop
1005  * of performance out of the code.
1006  *
1007  * Small values favor memcpy, large values favor inline code.
1008  */
1009 #if defined(__alpha__) || defined(__alpha)
1010 #  define breakeven_point   2    /* AXP (DEC Alpha)     - gcc or cc or egcs */
1011 #endif
1012 #if defined(__i386__)  || defined(__i386)
1013 #  define breakeven_point  12    /* Intel Pentium/Linux - gcc 2.96 */
1014 #endif
1015 #if defined(__hppa)
1016 #  define breakeven_point  10    /* HP-PA               - gcc */
1017 #endif
1018 #if defined(__sparc__) || defined(__sparc)
1019 #  define breakeven_point  33    /* Sun Sparc 5         - gcc 2.8.1 */
1020 #endif
1021
1022 /* some other values of possible interest: */
1023 /* #define breakeven_point  8 */ /* VAX 4000          - vaxc */
1024 /* #define breakeven_point 19 */ /* VAX 4000          - gcc 2.7.0 */
1025
1026 #ifndef breakeven_point
1027 #  define breakeven_point   6    /* some reasonable one-size-fits-all value */
1028 #endif
1029
1030 #define fast_memcpy(d,s,n) \
1031   { register size_t nn = (size_t)(n); \
1032     if (nn >= breakeven_point) memcpy((d), (s), nn); \
1033     else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
1034       register char *dd; register const char *ss; \
1035       for (ss=(s), dd=(d); nn>0; nn--) *dd++ = *ss++; } }
1036
1037 #define fast_memset(d,c,n) \
1038   { register size_t nn = (size_t)(n); \
1039     if (nn >= breakeven_point) memset((d), (int)(c), nn); \
1040     else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
1041       register char *dd; register const int cc=(int)(c); \
1042       for (dd=(d); nn>0; nn--) *dd++ = cc; } }
1043
1044 /* prototypes */
1045
1046 #if defined(NEED_ASPRINTF)
1047 int asprintf   (char **ptr, const char *fmt, /*args*/ ...);
1048 #endif
1049 #if defined(NEED_VASPRINTF)
1050 int vasprintf  (char **ptr, const char *fmt, va_list ap);
1051 #endif
1052 #if defined(NEED_ASNPRINTF)
1053 int asnprintf  (char **ptr, size_t str_m, const char *fmt, /*args*/ ...);
1054 #endif
1055 #if defined(NEED_VASNPRINTF)
1056 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap);
1057 #endif
1058
1059 #if defined(HAVE_SNPRINTF)
1060 /* declare our portable snprintf  routine under name portable_snprintf  */
1061 /* declare our portable vsnprintf routine under name portable_vsnprintf */
1062 #else
1063 /* declare our portable routines under names snprintf and vsnprintf */
1064 #define portable_snprintf snprintf
1065 #if !defined(NEED_SNPRINTF_ONLY)
1066 #define portable_vsnprintf vsnprintf
1067 #endif
1068 #endif
1069
1070 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1071 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...);
1072 #if !defined(NEED_SNPRINTF_ONLY)
1073 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap);
1074 #endif
1075 #endif
1076
1077 /* declarations */
1078
1079 static char credits[] = "\n\
1080 @(#)snprintf.c, v2.2: Mark Martinec, <mark.martinec@ijs.si>\n\
1081 @(#)snprintf.c, v2.2: Copyright 1999, Mark Martinec. Frontier Artistic License applies.\n\
1082 @(#)snprintf.c, v2.2: http://www.ijs.si/software/snprintf/\n";
1083
1084 #if defined(NEED_ASPRINTF)
1085 int asprintf(char **ptr, const char *fmt, /*args*/ ...) {
1086   va_list ap;
1087   size_t str_m;
1088   int str_l;
1089
1090   *ptr = NULL;
1091   va_start(ap, fmt);                            /* measure the required size */
1092   str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1093   va_end(ap);
1094   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
1095   *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1096   if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1097   else {
1098     int str_l2;
1099     va_start(ap, fmt);
1100     str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1101     va_end(ap);
1102     assert(str_l2 == str_l);
1103   }
1104   return str_l;
1105 }
1106 #endif
1107
1108 #if defined(NEED_VASPRINTF)
1109 int vasprintf(char **ptr, const char *fmt, va_list ap) {
1110   size_t str_m;
1111   int str_l;
1112
1113   *ptr = NULL;
1114   { va_list ap2;
1115     va_copy(ap2, ap);  /* don't consume the original ap, we'll need it again */
1116     str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1117     va_end(ap2);
1118   }
1119   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
1120   *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1121   if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1122   else {
1123     int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1124     assert(str_l2 == str_l);
1125   }
1126   return str_l;
1127 }
1128 #endif
1129
1130 #if defined(NEED_ASNPRINTF)
1131 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...) {
1132   va_list ap;
1133   int str_l;
1134
1135   *ptr = NULL;
1136   va_start(ap, fmt);                            /* measure the required size */
1137   str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1138   va_end(ap);
1139   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
1140   if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1;      /* truncate */
1141   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1142   if (str_m == 0) {  /* not interested in resulting string, just return size */
1143   } else {
1144     *ptr = (char *) malloc(str_m);
1145     if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1146     else {
1147       int str_l2;
1148       va_start(ap, fmt);
1149       str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1150       va_end(ap);
1151       assert(str_l2 == str_l);
1152     }
1153   }
1154   return str_l;
1155 }
1156 #endif
1157
1158 #if defined(NEED_VASNPRINTF)
1159 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap) {
1160   int str_l;
1161
1162   *ptr = NULL;
1163   { va_list ap2;
1164     va_copy(ap2, ap);  /* don't consume the original ap, we'll need it again */
1165     str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1166     va_end(ap2);
1167   }
1168   assert(str_l >= 0);        /* possible integer overflow if str_m > INT_MAX */
1169   if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1;      /* truncate */
1170   /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1171   if (str_m == 0) {  /* not interested in resulting string, just return size */
1172   } else {
1173     *ptr = (char *) malloc(str_m);
1174     if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1175     else {
1176       int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1177       assert(str_l2 == str_l);
1178     }
1179   }
1180   return str_l;
1181 }
1182 #endif
1183
1184 /*
1185  * If the system does have snprintf and the portable routine is not
1186  * specifically required, this module produces no code for snprintf/vsnprintf.
1187  */
1188 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1189
1190 #if !defined(NEED_SNPRINTF_ONLY)
1191 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1192   va_list ap;
1193   int str_l;
1194
1195   va_start(ap, fmt);
1196   str_l = portable_vsnprintf(str, str_m, fmt, ap);
1197   va_end(ap);
1198   return str_l;
1199 }
1200 #endif
1201
1202 #if defined(NEED_SNPRINTF_ONLY)
1203 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1204 #else
1205 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap) {
1206 #endif
1207
1208 #if defined(NEED_SNPRINTF_ONLY)
1209   va_list ap;
1210 #endif
1211   size_t str_l = 0;
1212   const char *p = fmt;
1213
1214 /* In contrast with POSIX, the ISO C99 now says
1215  * that str can be NULL and str_m can be 0.
1216  * This is more useful than the old:  if (str_m < 1) return -1; */
1217
1218 #if defined(NEED_SNPRINTF_ONLY)
1219   va_start(ap, fmt);
1220 #endif
1221   if (!p) p = "";
1222   while (*p) {
1223     if (*p != '%') {
1224    /* if (str_l < str_m) str[str_l++] = *p++;    -- this would be sufficient */
1225    /* but the following code achieves better performance for cases
1226     * where format string is long and contains few conversions */
1227       const char *q = strchr(p+1,'%');
1228       size_t n = !q ? strlen(p) : (q-p);
1229       if (str_l < str_m) {
1230         size_t avail = str_m-str_l;
1231         fast_memcpy(str+str_l, p, (n>avail?avail:n));
1232       }
1233       p += n; str_l += n;
1234     } else {
1235       const char *starting_p;
1236       size_t min_field_width = 0, precision = 0;
1237       int zero_padding = 0, precision_specified = 0, justify_left = 0;
1238       int alternate_form = 0, force_sign = 0;
1239       int space_for_positive = 1; /* If both the ' ' and '+' flags appear,
1240                                      the ' ' flag should be ignored. */
1241       char length_modifier = '\0';            /* allowed values: \0, h, l, L */
1242       char tmp[32];/* temporary buffer for simple numeric->string conversion */
1243
1244       const char *str_arg;      /* string address in case of string argument */
1245       size_t str_arg_l;         /* natural field width of arg without padding
1246                                    and sign */
1247       unsigned char uchar_arg;
1248         /* unsigned char argument value - only defined for c conversion.
1249            N.B. standard explicitly states the char argument for
1250            the c conversion is unsigned */
1251
1252       size_t number_of_zeros_to_pad = 0;
1253         /* number of zeros to be inserted for numeric conversions
1254            as required by the precision or minimal field width */
1255
1256       size_t zero_padding_insertion_ind = 0;
1257         /* index into tmp where zero padding is to be inserted */
1258
1259       char fmt_spec = '\0';
1260         /* current conversion specifier character */
1261
1262       str_arg = credits;/* just to make compiler happy (defined but not used)*/
1263       str_arg = NULL;
1264       starting_p = p; p++;  /* skip '%' */
1265    /* parse flags */
1266       while (*p == '0' || *p == '-' || *p == '+' ||
1267              *p == ' ' || *p == '#' || *p == '\'') {
1268         switch (*p) {
1269         case '0': zero_padding = 1; break;
1270         case '-': justify_left = 1; break;
1271         case '+': force_sign = 1; space_for_positive = 0; break;
1272         case ' ': force_sign = 1;
1273      /* If both the ' ' and '+' flags appear, the ' ' flag should be ignored */
1274 #ifdef PERL_COMPATIBLE
1275      /* ... but in Perl the last of ' ' and '+' applies */
1276                   space_for_positive = 1;
1277 #endif
1278                   break;
1279         case '#': alternate_form = 1; break;
1280         case '\'': break;
1281         }
1282         p++;
1283       }
1284    /* If the '0' and '-' flags both appear, the '0' flag should be ignored. */
1285
1286    /* parse field width */
1287       if (*p == '*') {
1288         int j;
1289         p++; j = va_arg(ap, int);
1290         if (j >= 0) min_field_width = j;
1291         else { min_field_width = -j; justify_left = 1; }
1292       } else if (isdigit((int)(*p))) {
1293         /* size_t could be wider than unsigned int;
1294            make sure we treat argument like common implementations do */
1295         unsigned int uj = *p++ - '0';
1296         while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1297         min_field_width = uj;
1298       }
1299    /* parse precision */
1300       if (*p == '.') {
1301         p++; precision_specified = 1;
1302         if (*p == '*') {
1303           int j = va_arg(ap, int);
1304           p++;
1305           if (j >= 0) precision = j;
1306           else {
1307             precision_specified = 0; precision = 0;
1308          /* NOTE:
1309           *   Solaris 2.6 man page claims that in this case the precision
1310           *   should be set to 0.  Digital Unix 4.0, HPUX 10 and BSD man page
1311           *   claim that this case should be treated as unspecified precision,
1312           *   which is what we do here.
1313           */
1314           }
1315         } else if (isdigit((int)(*p))) {
1316           /* size_t could be wider than unsigned int;
1317              make sure we treat argument like common implementations do */
1318           unsigned int uj = *p++ - '0';
1319           while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1320           precision = uj;
1321         }
1322       }
1323    /* parse 'h', 'l' and 'll' length modifiers */
1324       if (*p == 'h' || *p == 'l') {
1325         length_modifier = *p; p++;
1326         if (length_modifier == 'l' && *p == 'l') {   /* double l = long long */
1327 #ifdef SNPRINTF_LONGLONG_SUPPORT
1328           length_modifier = '2';                  /* double l encoded as '2' */
1329 #else
1330           length_modifier = 'l';                 /* treat it as a single 'l' */
1331 #endif
1332           p++;
1333         }
1334       }
1335       fmt_spec = *p;
1336    /* common synonyms: */
1337       switch (fmt_spec) {
1338       case 'i': fmt_spec = 'd'; break;
1339       case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
1340       case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
1341       case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
1342       default: break;
1343       }
1344    /* get parameter value, do initial processing */
1345       switch (fmt_spec) {
1346       case '%': /* % behaves similar to 's' regarding flags and field widths */
1347       case 'c': /* c behaves similar to 's' regarding flags and field widths */
1348       case 's':
1349         length_modifier = '\0';          /* wint_t and wchar_t not supported */
1350      /* the result of zero padding flag with non-numeric conversion specifier*/
1351      /* is undefined. Solaris and HPUX 10 does zero padding in this case,    */
1352      /* Digital Unix and Linux does not. */
1353 #if !defined(SOLARIS_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
1354         zero_padding = 0;    /* turn zero padding off for string conversions */
1355 #endif
1356         str_arg_l = 1;
1357         switch (fmt_spec) {
1358         case '%':
1359           str_arg = p; break;
1360         case 'c': {
1361           int j = va_arg(ap, int);
1362           uchar_arg = (unsigned char) j;   /* standard demands unsigned char */
1363           str_arg = (const char *) &uchar_arg;
1364           break;
1365         }
1366         case 's':
1367           str_arg = va_arg(ap, const char *);
1368           if (!str_arg) str_arg_l = 0;
1369        /* make sure not to address string beyond the specified precision !!! */
1370           else if (!precision_specified) str_arg_l = strlen(str_arg);
1371        /* truncate string if necessary as requested by precision */
1372           else if (precision == 0) str_arg_l = 0;
1373           else {
1374        /* memchr on HP does not like n > 2^31  !!! */
1375             const char *q = memchr(str_arg, '\0',
1376                              precision <= 0x7fffffff ? precision : 0x7fffffff);
1377             str_arg_l = !q ? precision : (q-str_arg);
1378           }
1379           break;
1380         default: break;
1381         }
1382         break;
1383       case 'd': case 'u': case 'o': case 'x': case 'X': case 'p': {
1384         /* NOTE: the u, o, x, X and p conversion specifiers imply
1385                  the value is unsigned;  d implies a signed value */
1386
1387         int arg_sign = 0;
1388           /* 0 if numeric argument is zero (or if pointer is NULL for 'p'),
1389             +1 if greater than zero (or nonzero for unsigned arguments),
1390             -1 if negative (unsigned argument is never negative) */
1391
1392         int int_arg = 0;  unsigned int uint_arg = 0;
1393           /* only defined for length modifier h, or for no length modifiers */
1394
1395         long int long_arg = 0;  unsigned long int ulong_arg = 0;
1396           /* only defined for length modifier l */
1397
1398         void *ptr_arg = NULL;
1399           /* pointer argument value -only defined for p conversion */
1400
1401 #ifdef SNPRINTF_LONGLONG_SUPPORT
1402         long long int long_long_arg = 0;
1403         unsigned long long int ulong_long_arg = 0;
1404           /* only defined for length modifier ll */
1405 #endif
1406         if (fmt_spec == 'p') {
1407         /* HPUX 10: An l, h, ll or L before any other conversion character
1408          *   (other than d, i, u, o, x, or X) is ignored.
1409          * Digital Unix:
1410          *   not specified, but seems to behave as HPUX does.
1411          * Solaris: If an h, l, or L appears before any other conversion
1412          *   specifier (other than d, i, u, o, x, or X), the behavior
1413          *   is undefined. (Actually %hp converts only 16-bits of address
1414          *   and %llp treats address as 64-bit data which is incompatible
1415          *   with (void *) argument on a 32-bit system).
1416          */
1417 #ifdef SOLARIS_COMPATIBLE
1418 #  ifdef SOLARIS_BUG_COMPATIBLE
1419           /* keep length modifiers even if it represents 'll' */
1420 #  else
1421           if (length_modifier == '2') length_modifier = '\0';
1422 #  endif
1423 #else
1424           length_modifier = '\0';
1425 #endif
1426           ptr_arg = va_arg(ap, void *);
1427           if (ptr_arg != NULL) arg_sign = 1;
1428         } else if (fmt_spec == 'd') {  /* signed */
1429           switch (length_modifier) {
1430           case '\0':
1431           case 'h':
1432          /* It is non-portable to specify a second argument of char or short
1433           * to va_arg, because arguments seen by the called function
1434           * are not char or short.  C converts char and short arguments
1435           * to int before passing them to a function.
1436           */
1437             int_arg = va_arg(ap, int);
1438             if      (int_arg > 0) arg_sign =  1;
1439             else if (int_arg < 0) arg_sign = -1;
1440             break;
1441           case 'l':
1442             long_arg = va_arg(ap, long int);
1443             if      (long_arg > 0) arg_sign =  1;
1444             else if (long_arg < 0) arg_sign = -1;
1445             break;
1446 #ifdef SNPRINTF_LONGLONG_SUPPORT
1447           case '2':
1448             long_long_arg = va_arg(ap, long long int);
1449             if      (long_long_arg > 0) arg_sign =  1;
1450             else if (long_long_arg < 0) arg_sign = -1;
1451             break;
1452 #endif
1453           }
1454         } else {  /* unsigned */
1455           switch (length_modifier) {
1456           case '\0':
1457           case 'h':
1458             uint_arg = va_arg(ap, unsigned int);
1459             if (uint_arg) arg_sign = 1;
1460             break;
1461           case 'l':
1462             ulong_arg = va_arg(ap, unsigned long int);
1463             if (ulong_arg) arg_sign = 1;
1464             break;
1465 #ifdef SNPRINTF_LONGLONG_SUPPORT
1466           case '2':
1467             ulong_long_arg = va_arg(ap, unsigned long long int);
1468             if (ulong_long_arg) arg_sign = 1;
1469             break;
1470 #endif
1471           }
1472         }
1473         str_arg = tmp; str_arg_l = 0;
1474      /* NOTE:
1475       *   For d, i, u, o, x, and X conversions, if precision is specified,
1476       *   the '0' flag should be ignored. This is so with Solaris 2.6,
1477       *   Digital UNIX 4.0, HPUX 10, Linux, FreeBSD, NetBSD; but not with Perl.
1478       */
1479 #ifndef PERL_COMPATIBLE
1480         if (precision_specified) zero_padding = 0;
1481 #endif
1482         if (fmt_spec == 'd') {
1483           if (force_sign && arg_sign >= 0)
1484             tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1485          /* leave negative numbers for sprintf to handle,
1486             to avoid handling tricky cases like (short int)(-32768) */
1487 #ifdef LINUX_COMPATIBLE
1488         } else if (fmt_spec == 'p' && force_sign && arg_sign > 0) {
1489           tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1490 #endif
1491         } else if (alternate_form) {
1492           if (arg_sign != 0 && (fmt_spec == 'x' || fmt_spec == 'X') )
1493             { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = fmt_spec; }
1494          /* alternate form should have no effect for p conversion, but ... */
1495 #ifdef HPUX_COMPATIBLE
1496           else if (fmt_spec == 'p'
1497          /* HPUX 10: for an alternate form of p conversion,
1498           *          a nonzero result is prefixed by 0x. */
1499 #ifndef HPUX_BUG_COMPATIBLE
1500          /* Actually it uses 0x prefix even for a zero value. */
1501                    && arg_sign != 0
1502 #endif
1503                   ) { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = 'x'; }
1504 #endif
1505         }
1506         zero_padding_insertion_ind = str_arg_l;
1507         if (!precision_specified) precision = 1;   /* default precision is 1 */
1508         if (precision == 0 && arg_sign == 0
1509 #if defined(HPUX_BUG_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1510             && fmt_spec != 'p'
1511          /* HPUX 10 man page claims: With conversion character p the result of
1512           * converting a zero value with a precision of zero is a null string.
1513           * Actually HP returns all zeroes, and Linux returns "(nil)". */
1514 #endif
1515         ) {
1516          /* converted to null string */
1517          /* When zero value is formatted with an explicit precision 0,
1518             the resulting formatted string is empty (d, i, u, o, x, X, p).   */
1519         } else {
1520           char f[5]; int f_l = 0;
1521           f[f_l++] = '%';    /* construct a simple format string for sprintf */
1522           if (!length_modifier) { }
1523           else if (length_modifier=='2') { f[f_l++] = 'l'; f[f_l++] = 'l'; }
1524           else f[f_l++] = length_modifier;
1525           f[f_l++] = fmt_spec; f[f_l++] = '\0';
1526           if (fmt_spec == 'p') str_arg_l += sprintf(tmp+str_arg_l, f, ptr_arg);
1527           else if (fmt_spec == 'd') {  /* signed */
1528             switch (length_modifier) {
1529             case '\0':
1530             case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, int_arg);  break;
1531             case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, long_arg); break;
1532 #ifdef SNPRINTF_LONGLONG_SUPPORT
1533             case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,long_long_arg); break;
1534 #endif
1535             }
1536           } else {  /* unsigned */
1537             switch (length_modifier) {
1538             case '\0':
1539             case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, uint_arg);  break;
1540             case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, ulong_arg); break;
1541 #ifdef SNPRINTF_LONGLONG_SUPPORT
1542             case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,ulong_long_arg);break;
1543 #endif
1544             }
1545           }
1546          /* include the optional minus sign and possible "0x"
1547             in the region before the zero padding insertion point */
1548           if (zero_padding_insertion_ind < str_arg_l &&
1549               tmp[zero_padding_insertion_ind] == '-') {
1550             zero_padding_insertion_ind++;
1551           }
1552           if (zero_padding_insertion_ind+1 < str_arg_l &&
1553               tmp[zero_padding_insertion_ind]   == '0' &&
1554              (tmp[zero_padding_insertion_ind+1] == 'x' ||
1555               tmp[zero_padding_insertion_ind+1] == 'X') ) {
1556             zero_padding_insertion_ind += 2;
1557           }
1558         }
1559         { size_t num_of_digits = str_arg_l - zero_padding_insertion_ind;
1560           if (alternate_form && fmt_spec == 'o'
1561 #ifdef HPUX_COMPATIBLE                                  /* ("%#.o",0) -> ""  */
1562               && (str_arg_l > 0)
1563 #endif
1564 #ifdef DIGITAL_UNIX_BUG_COMPATIBLE                      /* ("%#o",0) -> "00" */
1565 #else
1566               /* unless zero is already the first character */
1567               && !(zero_padding_insertion_ind < str_arg_l
1568                    && tmp[zero_padding_insertion_ind] == '0')
1569 #endif
1570           ) {        /* assure leading zero for alternate-form octal numbers */
1571             if (!precision_specified || precision < num_of_digits+1) {
1572              /* precision is increased to force the first character to be zero,
1573                 except if a zero value is formatted with an explicit precision
1574                 of zero */
1575               precision = num_of_digits+1; precision_specified = 1;
1576             }
1577           }
1578        /* zero padding to specified precision? */
1579           if (num_of_digits < precision)
1580             number_of_zeros_to_pad = precision - num_of_digits;
1581         }
1582      /* zero padding to specified minimal field width? */
1583         if (!justify_left && zero_padding) {
1584           int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1585           if (n > 0) number_of_zeros_to_pad += n;
1586         }
1587         break;
1588       }
1589       default: /* unrecognized conversion specifier, keep format string as-is*/
1590         zero_padding = 0;  /* turn zero padding off for non-numeric convers. */
1591 #ifndef DIGITAL_UNIX_COMPATIBLE
1592         justify_left = 1; min_field_width = 0;                /* reset flags */
1593 #endif
1594 #if defined(PERL_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1595      /* keep the entire format string unchanged */
1596         str_arg = starting_p; str_arg_l = p - starting_p;
1597      /* well, not exactly so for Linux, which does something between,
1598       * and I don't feel an urge to imitate it: "%+++++hy" -> "%+y"  */
1599 #else
1600      /* discard the unrecognized conversion, just keep *
1601       * the unrecognized conversion character          */
1602         str_arg = p; str_arg_l = 0;
1603 #endif
1604         if (*p) str_arg_l++;  /* include invalid conversion specifier unchanged
1605                                  if not at end-of-string */
1606         break;
1607       }
1608       if (*p) p++;      /* step over the just processed conversion specifier */
1609    /* insert padding to the left as requested by min_field_width;
1610       this does not include the zero padding in case of numerical conversions*/
1611       if (!justify_left) {                /* left padding with blank or zero */
1612         int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1613         if (n > 0) {
1614           if (str_l < str_m) {
1615             size_t avail = str_m-str_l;
1616             fast_memset(str+str_l, (zero_padding?'0':' '), (n>avail?avail:n));
1617           }
1618           str_l += n;
1619         }
1620       }
1621    /* zero padding as requested by the precision or by the minimal field width
1622     * for numeric conversions required? */
1623       if (number_of_zeros_to_pad <= 0) {
1624      /* will not copy first part of numeric right now, *
1625       * force it to be copied later in its entirety    */
1626         zero_padding_insertion_ind = 0;
1627       } else {
1628      /* insert first part of numerics (sign or '0x') before zero padding */
1629         int n = zero_padding_insertion_ind;
1630         if (n > 0) {
1631           if (str_l < str_m) {
1632             size_t avail = str_m-str_l;
1633             fast_memcpy(str+str_l, str_arg, (n>avail?avail:n));
1634           }
1635           str_l += n;
1636         }
1637      /* insert zero padding as requested by the precision or min field width */
1638         n = number_of_zeros_to_pad;
1639         if (n > 0) {
1640           if (str_l < str_m) {
1641             size_t avail = str_m-str_l;
1642             fast_memset(str+str_l, '0', (n>avail?avail:n));
1643           }
1644           str_l += n;
1645         }
1646       }
1647    /* insert formatted string
1648     * (or as-is conversion specifier for unknown conversions) */
1649       { int n = str_arg_l - zero_padding_insertion_ind;
1650         if (n > 0) {
1651           if (str_l < str_m) {
1652             size_t avail = str_m-str_l;
1653             fast_memcpy(str+str_l, str_arg+zero_padding_insertion_ind,
1654                         (n>avail?avail:n));
1655           }
1656           str_l += n;
1657         }
1658       }
1659    /* insert right padding */
1660       if (justify_left) {          /* right blank padding to the field width */
1661         int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1662         if (n > 0) {
1663           if (str_l < str_m) {
1664             size_t avail = str_m-str_l;
1665             fast_memset(str+str_l, ' ', (n>avail?avail:n));
1666           }
1667           str_l += n;
1668         }
1669       }
1670     }
1671   }
1672 #if defined(NEED_SNPRINTF_ONLY)
1673   va_end(ap);
1674 #endif
1675   if (str_m > 0) { /* make sure the string is null-terminated
1676                       even at the expense of overwriting the last character
1677                       (shouldn't happen, but just in case) */
1678     str[str_l <= str_m-1 ? str_l : str_m-1] = '\0';
1679   }
1680   /* Return the number of characters formatted (excluding trailing null
1681    * character), that is, the number of characters that would have been
1682    * written to the buffer if it were large enough.
1683    *
1684    * The value of str_l should be returned, but str_l is of unsigned type
1685    * size_t, and snprintf is int, possibly leading to an undetected
1686    * integer overflow, resulting in a negative return value, which is illegal.
1687    * Both XSH5 and ISO C99 (at least the draft) are silent on this issue.
1688    * Should errno be set to EOVERFLOW and EOF returned in this case???
1689    */
1690   return (int) str_l;
1691 }
1692 #endif
1693 #endif /* ndef HAVE_SNPRINTF */
1694 /*
1695   Local Variables:
1696   tab-width: 3
1697   end:
1698 */