1 const char miscutil_rcs[] = "$Id: miscutil.c,v 1.26 2001/12/30 14:07:32 steudten Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/miscutil.c,v $
6 * Purpose : zalloc, hash_string, safe_strerror, strcmpic,
7 * strncmpic, chomp, and MinGW32 strdup
9 * These are each too small to deserve their own file
10 * but don't really fit in any other file.
12 * Copyright : Written by and Copyright (C) 2001 the SourceForge
13 * IJBSWA team. http://ijbswa.sourceforge.net
15 * Based on the Internet Junkbuster originally written
16 * by and Copyright (C) 1997 Anonymous Coders and
17 * Junkbusters Corporation. http://www.junkbusters.com
19 * This program is free software; you can redistribute it
20 * and/or modify it under the terms of the GNU General
21 * Public License as published by the Free Software
22 * Foundation; either version 2 of the License, or (at
23 * your option) any later version.
25 * This program is distributed in the hope that it will
26 * be useful, but WITHOUT ANY WARRANTY; without even the
27 * implied warranty of MERCHANTABILITY or FITNESS FOR A
28 * PARTICULAR PURPOSE. See the GNU General Public
29 * License for more details.
31 * The GNU General Public License should be included with
32 * this file. If not, you can view it at
33 * http://www.gnu.org/copyleft/gpl.html
34 * or write to the Free Software Foundation, Inc., 59
35 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
38 * $Log: miscutil.c,v $
39 * Revision 1.26 2001/12/30 14:07:32 steudten
40 * - Add signal handling (unix)
41 * - Add SIGHUP handler (unix)
42 * - Add creation of pidfile (unix)
43 * - Add action 'top' in rc file (RH)
44 * - Add entry 'SIGNALS' to manpage
45 * - Add exit message to logfile (unix)
47 * Revision 1.25 2001/11/13 00:16:38 jongfoster
48 * Replacing references to malloc.h with the standard stdlib.h
49 * (See ANSI or K&R 2nd Ed)
51 * Revision 1.24 2001/11/05 21:41:43 steudten
52 * Add changes to be a real daemon just for unix os.
53 * (change cwd to /, detach from controlling tty, set
54 * process group and session leader to the own process.
56 * Add some fatal-error log message for failed malloc().
57 * Add '-d' if compiled with 'configure --with-debug' to
58 * enable debug output.
60 * Revision 1.23 2001/10/29 03:48:10 david__schmidt
61 * OS/2 native needed a snprintf() routine. Added one to miscutil, brackedted
62 * by and __OS2__ ifdef.
64 * Revision 1.22 2001/10/26 17:39:38 oes
65 * Moved ijb_isspace and ijb_tolower to project.h
67 * Revision 1.21 2001/10/23 21:27:50 jongfoster
68 * Standardising error codes in string_append
69 * make_path() no longer adds '\\' if the dir already ends in '\\' (this
70 * is just copying a UNIX-specific fix to the Windows-specific part)
72 * Revision 1.20 2001/10/22 15:33:56 david__schmidt
73 * Special-cased OS/2 out of the Netscape-abort-on-404-in-js problem in
74 * filters.c. Added a FIXME in front of the offending code. I'll gladly
75 * put in a better/more robust fix for all parties if one is presented...
76 * It seems that just returning 200 instead of 404 would pretty much fix
77 * it for everyone, but I don't know all the history of the problem.
79 * Revision 1.19 2001/10/14 22:02:57 jongfoster
80 * New function string_append() which is like strsav(), but running
81 * out of memory isn't automatically FATAL.
83 * Revision 1.18 2001/09/20 13:33:43 steudten
85 * change long to int as return value in hash_string(). Remember the wraparound
86 * for int = long = sizeof(4) - thats maybe not what we want.
88 * Revision 1.17 2001/09/13 20:51:29 jongfoster
89 * Fixing potential problems with characters >=128 in simplematch()
90 * This was also a compiler warning.
92 * Revision 1.16 2001/09/10 10:56:59 oes
93 * Silenced compiler warnings
95 * Revision 1.15 2001/07/13 14:02:24 oes
96 * Removed vim-settings
98 * Revision 1.14 2001/06/29 21:45:41 oes
99 * Indentation, CRLF->LF, Tab-> Space
101 * Revision 1.13 2001/06/29 13:32:14 oes
102 * Removed logentry from cancelled commit
104 * Revision 1.12 2001/06/09 10:55:28 jongfoster
105 * Changing BUFSIZ ==> BUFFER_SIZE
107 * Revision 1.11 2001/06/07 23:09:19 jongfoster
108 * Cosmetic indentation changes.
110 * Revision 1.10 2001/06/07 14:51:38 joergs
111 * make_path() no longer adds '/' if the dir already ends in '/'.
113 * Revision 1.9 2001/06/07 14:43:17 swa
114 * slight mistake in make_path, unix path style is /.
116 * Revision 1.8 2001/06/05 22:32:01 jongfoster
117 * New function make_path() to splice directory and file names together.
119 * Revision 1.7 2001/06/03 19:12:30 oes
120 * introduced bindup()
122 * Revision 1.6 2001/06/01 18:14:49 jongfoster
123 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
124 * in config.h if appropriate) rather than the NO_STRERR macro.
126 * Revision 1.5 2001/06/01 10:31:51 oes
127 * Added character class matching to trivimatch; renamed to simplematch
129 * Revision 1.4 2001/05/31 17:32:31 oes
131 * - Enhanced domain part globbing with infix and prefix asterisk
132 * matching and optional unanchored operation
134 * Revision 1.3 2001/05/29 23:10:09 oes
137 * - Introduced chomp()
138 * - Moved strsav() from showargs to miscutil
140 * Revision 1.2 2001/05/29 09:50:24 jongfoster
141 * Unified blocklist/imagelist/permissionslist.
142 * File format is still under discussion, but the internal changes
145 * Also modified interceptor behaviour:
146 * - We now intercept all URLs beginning with one of the following
147 * prefixes (and *only* these prefixes):
149 * * http://ijbswa.sf.net/config/
150 * * http://ijbswa.sourceforge.net/config/
151 * - New interceptors "home page" - go to http://i.j.b/ to see it.
152 * - Internal changes so that intercepted and fast redirect pages
153 * are not replaced with an image.
154 * - Interceptors now have the option to send a binary page direct
155 * to the client. (i.e. ijb-send-banner uses this)
156 * - Implemented show-url-info interceptor. (Which is why I needed
157 * the above interceptors changes - a typical URL is
158 * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
159 * The previous mechanism would not have intercepted that, and
160 * if it had been intercepted then it then it would have replaced
163 * Revision 1.1.1.1 2001/05/15 13:59:00 oes
164 * Initial import of version 2.9.3 source tree
167 *********************************************************************/
173 #include <sys/types.h>
175 #if !defined(_WIN32) && !defined(__OS2__)
177 #endif /* #if !defined(_WIN32) && !defined(__OS2__) */
183 #include "miscutil.h"
186 const char miscutil_h_rcs[] = MISCUTIL_H_VERSION;
188 /*********************************************************************
192 * Description : Malloc some memory and set it to '\0'.
193 * The way calloc() ought to be -acjc
196 * 1 : size = Size of memory chunk to return.
198 * Returns : Pointer to newly malloc'd memory chunk.
200 *********************************************************************/
201 void *zalloc(int size)
205 if ((ret = (void *)malloc(size)) != NULL)
207 memset(ret, 0, size);
213 /*********************************************************************
215 * Function : deletePidFile
217 * Description : deletes the pid file with the pid of the main process
223 *********************************************************************/
224 void deletePidFile( void )
228 snprintf( pidfile, sizeof(pidfile), "%s/%s", PID_FILE_PATH, PID_FILE_NAME);
231 /*********************************************************************
233 * Function : writePidFile
235 * Description : writes the pid file with the pid of the main process
241 *********************************************************************/
242 void writePidFile( void )
247 snprintf( pidfile, sizeof(pidfile), "%s/%s", PID_FILE_PATH, PID_FILE_NAME);
248 if ((fp = fopen( pidfile,"w")) == NULL )
250 log_error(LOG_LEVEL_INFO, "can't open pidfile '%s': %E", pidfile);
254 fprintf( fp,"%u\n", (unsigned int) getpid());
259 /*********************************************************************
261 * Function : hash_string
263 * Description : Take a string and compute a (hopefuly) unique numeric
264 * integer value. This has several uses, but being able
265 * to "switch" a string the one of my favorites.
268 * 1 : s : string to be hashed.
270 * Returns : an unsigned long variable with the hashed value.
272 *********************************************************************/
273 unsigned int hash_string( const char* s )
288 /*********************************************************************
292 * Description : For some reason (which is beyond me), gcc and WIN32
293 * don't like strdup. When a "free" is executed on a
294 * strdup'd ptr, it can at times freez up! So I just
295 * replaced it and problem was solved.
298 * 1 : s = string to duplicate
300 * Returns : Pointer to newly malloc'ed copy of the string.
302 *********************************************************************/
303 char *strdup( const char *s )
305 char * result = (char *)malloc( strlen(s)+1 );
315 #endif /* def __MINGW32__ */
319 /*********************************************************************
321 * Function : safe_strerror
323 * Description : Variant of the library routine strerror() which will
324 * work on systems without the library routine, and
325 * which should never return NULL.
328 * 1 : err = the `errno' of the last operation.
330 * Returns : An "English" string of the last `errno'. Allocated
331 * with strdup(), so caller frees. May be NULL if the
332 * system is out of memory.
334 *********************************************************************/
335 char *safe_strerror(int err)
338 char buf[BUFFER_SIZE];
343 #endif /* HAVE_STRERROR */
347 sprintf(buf, "(errno = %d)", err);
356 /*********************************************************************
358 * Function : strcmpic
360 * Description : Case insensitive string comparison
363 * 1 : s1 = string 1 to compare
364 * 2 : s2 = string 2 to compare
366 * Returns : 0 if s1==s2, Negative if s1<s2, Positive if s1>s2
368 *********************************************************************/
369 int strcmpic(const char *s1, const char *s2)
373 if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
379 return(ijb_tolower(*s1) - ijb_tolower(*s2));
384 /*********************************************************************
386 * Function : strncmpic
388 * Description : Case insensitive string comparison (upto n characters)
391 * 1 : s1 = string 1 to compare
392 * 2 : s2 = string 2 to compare
393 * 3 : n = maximum characters to compare
395 * Returns : 0 if s1==s2, Negative if s1<s2, Positive if s1>s2
397 *********************************************************************/
398 int strncmpic(const char *s1, const char *s2, size_t n)
400 if (n <= 0) return(0);
404 if ( ( *s1 != *s2 ) && ( ijb_tolower(*s1) != ijb_tolower(*s2) ) )
413 return(ijb_tolower(*s1) - ijb_tolower(*s2));
418 /*********************************************************************
422 * Description : In-situ-eliminate all leading and trailing whitespace
426 * 1 : s : string to be chomped.
428 * Returns : chomped string
430 *********************************************************************/
431 char *chomp(char *string)
436 * strip trailing whitespace
438 p = string + strlen(string);
439 while (p > string && ijb_isspace(*(p-1)))
446 * find end of leading whitespace
449 while (*q && ijb_isspace(*q))
455 * if there was any, move the rest forwards
470 /*********************************************************************
474 * Description : Reallocate "old" and append text to it. This makes
475 * it easier to append to malloc'd strings.
476 * Running out of memory is a FATAL error.
479 * 1 : old = Old text that is to be extended. Will be
480 * free()d by this routine. May be NULL.
481 * 2 : text_to_append = Text to be appended to old.
484 * Returns : Pointer to newly malloc'ed appended string.
485 * If there is no text to append, return old. Caller
488 *********************************************************************/
489 char *strsav(char *old, const char *text_to_append)
491 int old_len, new_len = 0;
494 if (( text_to_append == NULL) || (*text_to_append == '\0'))
501 if ((p = strdup(text_to_append)) == NULL)
503 log_error(LOG_LEVEL_FATAL, "strdup() failed!", new_len);
504 /* Never get here - LOG_LEVEL_FATAL causes program exit */
509 old_len = strlen(old);
510 new_len = old_len + strlen(text_to_append) + 1;
512 if ((p = realloc(old, new_len)) == NULL)
514 log_error(LOG_LEVEL_FATAL, "realloc(%d) bytes failed!", new_len);
515 /* Never get here - LOG_LEVEL_FATAL causes program exit */
518 strcpy(p + old_len, text_to_append);
523 /*********************************************************************
525 * Function : string_append
527 * Description : Reallocate target_string and append text to it.
528 * This makes it easier to append to malloc'd strings.
529 * This is similar to the (removed) strsav(), but
530 * running out of memory isn't catastrophic.
534 * The following style provides sufficient error
535 * checking for this routine, with minimal clutter
536 * in the source code. It is recommended if you
537 * have many calls to this function:
539 * char * s = strdup(...); // don't check for error
540 * string_append(&s, ...); // don't check for error
541 * string_append(&s, ...); // don't check for error
542 * string_append(&s, ...); // don't check for error
543 * if (NULL == s) { ... handle error ... }
547 * char * s = strdup(...); // don't check for error
548 * string_append(&s, ...); // don't check for error
549 * string_append(&s, ...); // don't check for error
550 * if (string_append(&s, ...)) {... handle error ...}
553 * 1 : target_string = Pointer to old text that is to be
554 * extended. *target_string will be free()d by this
555 * routine. target_string must be non-NULL.
556 * If *target_string is NULL, this routine will
557 * do nothing and return with an error - this allows
558 * you to make many calls to this routine and only
559 * check for errors after the last one.
560 * 2 : text_to_append = Text to be appended to old.
563 * Returns : JB_ERR_OK on success, and sets *target_string
564 * to newly malloc'ed appended string. Caller
565 * must free(*target_string).
566 * JB_ERR_MEMORY on out-of-memory. (And free()s
567 * *target_string and sets it to NULL).
568 * JB_ERR_MEMORY if *target_string is NULL.
570 *********************************************************************/
571 jb_err string_append(char **target_string, const char *text_to_append)
576 assert(target_string);
577 assert(text_to_append);
579 if (*target_string == NULL)
581 return JB_ERR_MEMORY;
584 if (*text_to_append == '\0')
589 old_len = strlen(*target_string);
591 if (NULL == (new_string = realloc(*target_string,
592 strlen(text_to_append) + old_len + 1)))
594 free(*target_string);
596 *target_string = NULL;
597 return JB_ERR_MEMORY;
600 strcpy(new_string + old_len, text_to_append);
602 *target_string = new_string;
607 /*********************************************************************
609 * Function : string_join
611 * Description : Join two strings together. Frees BOTH the original
612 * strings. If either or both input strings are NULL,
613 * fails as if it had run out of memory.
615 * For comparison, string_append requires that the
616 * second string is non-NULL, and doesn't free it.
618 * Rationale: Too often, we want to do
619 * string_append(s, html_encode(s2)). That assert()s
620 * if s2 is NULL or if html_encode() runs out of memory.
621 * It also leaks memory. Proper checking is cumbersome.
622 * The solution: string_join(s, html_encode(s2)) is safe,
623 * and will free the memory allocated by html_encode().
626 * 1 : target_string = Pointer to old text that is to be
627 * extended. *target_string will be free()d by this
628 * routine. target_string must be non-NULL.
629 * 2 : text_to_append = Text to be appended to old.
631 * Returns : JB_ERR_OK on success, and sets *target_string
632 * to newly malloc'ed appended string. Caller
633 * must free(*target_string).
634 * JB_ERR_MEMORY on out-of-memory, or if
635 * *target_string or text_to_append is NULL. (In
636 * this case, frees *target_string and text_to_append,
637 * sets *target_string to NULL).
639 *********************************************************************/
640 jb_err string_join(char **target_string, char *text_to_append)
644 assert(target_string);
646 if (text_to_append == NULL)
648 freez(*target_string);
649 return JB_ERR_MEMORY;
652 err = string_append(target_string, text_to_append);
654 free(text_to_append);
660 /*********************************************************************
662 * Function : simplematch
664 * Description : String matching, with a (greedy) '*' wildcard that
665 * stands for zero or more arbitrary characters and
666 * character classes in [], which take both enumerations
670 * 1 : pattern = pattern for matching
671 * 2 : text = text to be matched
673 * Returns : 0 if match, else nonzero
675 *********************************************************************/
676 int simplematch(char *pattern, char *text)
678 unsigned char *pat = (unsigned char *) pattern;
679 unsigned char *txt = (unsigned char *) text;
680 unsigned char *fallback = pat;
683 unsigned char lastchar = 'a';
685 unsigned char charmap[32];
691 /* EOF pattern but !EOF text? */
697 /* '*' in the pattern? */
701 /* The pattern ends afterwards? Speed up the return. */
707 /* Else, set wildcard mode and remember position after '*' */
712 /* Character range specification? */
715 memset(charmap, '\0', sizeof(charmap));
717 while (*++pat != ']')
723 else if (*pat == '-')
725 if ((*++pat == ']') || *pat == '\0')
729 for(i = lastchar; i <= *pat; i++)
731 charmap[i / 8] |= (1 << (i % 8));
736 charmap[*pat / 8] |= (1 << (*pat % 8));
740 } /* -END- if Character range specification */
743 /* Compare: Char match, or char range match*/
745 || ((*pat == ']') && (charmap[*txt / 8] & (1 << (*txt % 8)))) )
747 /* Sucess, go ahead */
752 /* In wildcard mode, just try again after failiure */
767 /* Cut off extra '*'s */
768 if(*pat == '*') pat++;
770 /* If this is the pattern's end, fine! */
776 /*********************************************************************
780 * Description : Duplicate the first n characters of a string that may
781 * contain '\0' characters.
784 * 1 : string = string to be duplicated
785 * 2 : n = number of bytes to duplicate
787 * Returns : pointer to copy, or NULL if failiure
789 *********************************************************************/
790 char *bindup(const char *string, int n)
794 if (NULL == (dup = (char *)malloc(n)))
800 memcpy(dup, string, n);
808 /*********************************************************************
810 * Function : make_path
812 * Description : Takes a directory name and a file name, returns
813 * the complete path. Handles windows/unix differences.
814 * If the file name is already an absolute path, or if
815 * the directory name is NULL or empty, it returns
819 * 1 : dir: Name of directory or NULL for none.
820 * 2 : file: Name of file. Should not be NULL or empty.
822 * Returns : "dir/file" (Or on windows, "dir\file").
823 * It allocates the string on the heap. Caller frees.
824 * Returns NULL in error (i.e. NULL file or out of
827 *********************************************************************/
828 char * make_path(const char * dir, const char * file)
835 strncpy(path,dir,512);
840 if(AddPart(path,file,512))
846 #else /* ndef AMIGA */
848 if ((file == NULL) || (*file == '\0'))
850 return NULL; /* Error */
853 if ((dir == NULL) || (*dir == '\0') /* No directory specified */
855 || (*file == '\\') || (file[1] == ':') /* Absolute path (DOS) */
856 #else /* ifndef _WIN32 */
857 || (*file == '/') /* Absolute path (U*ix) */
858 #endif /* ifndef _WIN32 */
868 if ( *dir != '/' && basedir && *basedir )
870 path = malloc( strlen( basedir ) + strlen(dir) + strlen(file) + 3);
871 if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
872 strcpy(path, basedir);
875 DBG(1, ("make_path: path: %s\n",path) );
879 path = malloc(strlen(dir) + strlen(file) + 2);
880 if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
885 path = malloc(strlen(dir) + strlen(file) + 2);
886 if (!path ) log_error(LOG_LEVEL_FATAL, "malloc failed!");
889 #endif /* defined unix */
892 if(path[strlen(path)-1] != '\\')
896 #else /* ifndef _WIN32 */
897 if(path[strlen(path)-1] != '/')
901 #endif /* ifndef _WIN32 */
906 #endif /* ndef AMIGA */
911 * What follows is a portable snprintf routine, written by Mark Martinec.
912 * See: http://www.ijs.si/software/snprintf/
913 * Anyone who needs it can add a define for themselves... so far, only
914 * OS/2 (native) lacks snprintf.
917 - a portable implementation of snprintf,
918 including vsnprintf.c, asnprintf, vasnprintf, asprintf, vasprintf
920 snprintf is a routine to convert numeric and string arguments to
921 formatted strings. It is similar to sprintf(3) provided in a system's
922 C library, yet it requires an additional argument - the buffer size -
923 and it guarantees never to store anything beyond the given buffer,
924 regardless of the format or arguments to be formatted. Some newer
925 operating systems do provide snprintf in their C library, but many do
926 not or do provide an inadequate (slow or idiosyncratic) version, which
927 calls for a portable implementation of this routine.
931 Mark Martinec <mark.martinec@ijs.si>, April 1999, June 2000
932 Copyright © 1999, Mark Martinec
938 #define PORTABLE_SNPRINTF_VERSION_MAJOR 2
939 #define PORTABLE_SNPRINTF_VERSION_MINOR 2
941 #if defined(NEED_ASPRINTF) || defined(NEED_ASNPRINTF) || defined(NEED_VASPRINTF) || defined(NEED_VASNPRINTF)
942 # if defined(NEED_SNPRINTF_ONLY)
943 # undef NEED_SNPRINTF_ONLY
945 # if !defined(PREFER_PORTABLE_SNPRINTF)
946 # define PREFER_PORTABLE_SNPRINTF
950 #if defined(SOLARIS_BUG_COMPATIBLE) && !defined(SOLARIS_COMPATIBLE)
951 #define SOLARIS_COMPATIBLE
954 #if defined(HPUX_BUG_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
955 #define HPUX_COMPATIBLE
958 #if defined(DIGITAL_UNIX_BUG_COMPATIBLE) && !defined(DIGITAL_UNIX_COMPATIBLE)
959 #define DIGITAL_UNIX_COMPATIBLE
962 #if defined(PERL_BUG_COMPATIBLE) && !defined(PERL_COMPATIBLE)
963 #define PERL_COMPATIBLE
966 #if defined(LINUX_BUG_COMPATIBLE) && !defined(LINUX_COMPATIBLE)
967 #define LINUX_COMPATIBLE
970 #include <sys/types.h>
981 #define isdigit(c) ((c) >= '0' && (c) <= '9')
983 /* For copying strings longer or equal to 'breakeven_point'
984 * it is more efficient to call memcpy() than to do it inline.
985 * The value depends mostly on the processor architecture,
986 * but also on the compiler and its optimization capabilities.
987 * The value is not critical, some small value greater than zero
988 * will be just fine if you don't care to squeeze every drop
989 * of performance out of the code.
991 * Small values favor memcpy, large values favor inline code.
993 #if defined(__alpha__) || defined(__alpha)
994 # define breakeven_point 2 /* AXP (DEC Alpha) - gcc or cc or egcs */
996 #if defined(__i386__) || defined(__i386)
997 # define breakeven_point 12 /* Intel Pentium/Linux - gcc 2.96 */
1000 # define breakeven_point 10 /* HP-PA - gcc */
1002 #if defined(__sparc__) || defined(__sparc)
1003 # define breakeven_point 33 /* Sun Sparc 5 - gcc 2.8.1 */
1006 /* some other values of possible interest: */
1007 /* #define breakeven_point 8 */ /* VAX 4000 - vaxc */
1008 /* #define breakeven_point 19 */ /* VAX 4000 - gcc 2.7.0 */
1010 #ifndef breakeven_point
1011 # define breakeven_point 6 /* some reasonable one-size-fits-all value */
1014 #define fast_memcpy(d,s,n) \
1015 { register size_t nn = (size_t)(n); \
1016 if (nn >= breakeven_point) memcpy((d), (s), nn); \
1017 else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
1018 register char *dd; register const char *ss; \
1019 for (ss=(s), dd=(d); nn>0; nn--) *dd++ = *ss++; } }
1021 #define fast_memset(d,c,n) \
1022 { register size_t nn = (size_t)(n); \
1023 if (nn >= breakeven_point) memset((d), (int)(c), nn); \
1024 else if (nn > 0) { /* proc call overhead is worth only for large strings*/\
1025 register char *dd; register const int cc=(int)(c); \
1026 for (dd=(d); nn>0; nn--) *dd++ = cc; } }
1030 #if defined(NEED_ASPRINTF)
1031 int asprintf (char **ptr, const char *fmt, /*args*/ ...);
1033 #if defined(NEED_VASPRINTF)
1034 int vasprintf (char **ptr, const char *fmt, va_list ap);
1036 #if defined(NEED_ASNPRINTF)
1037 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...);
1039 #if defined(NEED_VASNPRINTF)
1040 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap);
1043 #if defined(HAVE_SNPRINTF)
1044 /* declare our portable snprintf routine under name portable_snprintf */
1045 /* declare our portable vsnprintf routine under name portable_vsnprintf */
1047 /* declare our portable routines under names snprintf and vsnprintf */
1048 #define portable_snprintf snprintf
1049 #if !defined(NEED_SNPRINTF_ONLY)
1050 #define portable_vsnprintf vsnprintf
1054 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1055 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...);
1056 #if !defined(NEED_SNPRINTF_ONLY)
1057 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap);
1063 static char credits[] = "\n\
1064 @(#)snprintf.c, v2.2: Mark Martinec, <mark.martinec@ijs.si>\n\
1065 @(#)snprintf.c, v2.2: Copyright 1999, Mark Martinec. Frontier Artistic License applies.\n\
1066 @(#)snprintf.c, v2.2: http://www.ijs.si/software/snprintf/\n";
1068 #if defined(NEED_ASPRINTF)
1069 int asprintf(char **ptr, const char *fmt, /*args*/ ...) {
1075 va_start(ap, fmt); /* measure the required size */
1076 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1078 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1079 *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1080 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1084 str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1086 assert(str_l2 == str_l);
1092 #if defined(NEED_VASPRINTF)
1093 int vasprintf(char **ptr, const char *fmt, va_list ap) {
1099 va_copy(ap2, ap); /* don't consume the original ap, we'll need it again */
1100 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1103 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1104 *ptr = (char *) malloc(str_m = (size_t)str_l + 1);
1105 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1107 int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1108 assert(str_l2 == str_l);
1114 #if defined(NEED_ASNPRINTF)
1115 int asnprintf (char **ptr, size_t str_m, const char *fmt, /*args*/ ...) {
1120 va_start(ap, fmt); /* measure the required size */
1121 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap);
1123 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1124 if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1; /* truncate */
1125 /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1126 if (str_m == 0) { /* not interested in resulting string, just return size */
1128 *ptr = (char *) malloc(str_m);
1129 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1133 str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1135 assert(str_l2 == str_l);
1142 #if defined(NEED_VASNPRINTF)
1143 int vasnprintf (char **ptr, size_t str_m, const char *fmt, va_list ap) {
1148 va_copy(ap2, ap); /* don't consume the original ap, we'll need it again */
1149 str_l = portable_vsnprintf(NULL, (size_t)0, fmt, ap2);/*get required size*/
1152 assert(str_l >= 0); /* possible integer overflow if str_m > INT_MAX */
1153 if ((size_t)str_l + 1 < str_m) str_m = (size_t)str_l + 1; /* truncate */
1154 /* if str_m is 0, no buffer is allocated, just set *ptr to NULL */
1155 if (str_m == 0) { /* not interested in resulting string, just return size */
1157 *ptr = (char *) malloc(str_m);
1158 if (*ptr == NULL) { errno = ENOMEM; str_l = -1; }
1160 int str_l2 = portable_vsnprintf(*ptr, str_m, fmt, ap);
1161 assert(str_l2 == str_l);
1169 * If the system does have snprintf and the portable routine is not
1170 * specifically required, this module produces no code for snprintf/vsnprintf.
1172 #if !defined(HAVE_SNPRINTF) || defined(PREFER_PORTABLE_SNPRINTF)
1174 #if !defined(NEED_SNPRINTF_ONLY)
1175 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1180 str_l = portable_vsnprintf(str, str_m, fmt, ap);
1186 #if defined(NEED_SNPRINTF_ONLY)
1187 int portable_snprintf(char *str, size_t str_m, const char *fmt, /*args*/ ...) {
1189 int portable_vsnprintf(char *str, size_t str_m, const char *fmt, va_list ap) {
1192 #if defined(NEED_SNPRINTF_ONLY)
1196 const char *p = fmt;
1198 /* In contrast with POSIX, the ISO C99 now says
1199 * that str can be NULL and str_m can be 0.
1200 * This is more useful than the old: if (str_m < 1) return -1; */
1202 #if defined(NEED_SNPRINTF_ONLY)
1208 /* if (str_l < str_m) str[str_l++] = *p++; -- this would be sufficient */
1209 /* but the following code achieves better performance for cases
1210 * where format string is long and contains few conversions */
1211 const char *q = strchr(p+1,'%');
1212 size_t n = !q ? strlen(p) : (q-p);
1213 if (str_l < str_m) {
1214 size_t avail = str_m-str_l;
1215 fast_memcpy(str+str_l, p, (n>avail?avail:n));
1219 const char *starting_p;
1220 size_t min_field_width = 0, precision = 0;
1221 int zero_padding = 0, precision_specified = 0, justify_left = 0;
1222 int alternate_form = 0, force_sign = 0;
1223 int space_for_positive = 1; /* If both the ' ' and '+' flags appear,
1224 the ' ' flag should be ignored. */
1225 char length_modifier = '\0'; /* allowed values: \0, h, l, L */
1226 char tmp[32];/* temporary buffer for simple numeric->string conversion */
1228 const char *str_arg; /* string address in case of string argument */
1229 size_t str_arg_l; /* natural field width of arg without padding
1231 unsigned char uchar_arg;
1232 /* unsigned char argument value - only defined for c conversion.
1233 N.B. standard explicitly states the char argument for
1234 the c conversion is unsigned */
1236 size_t number_of_zeros_to_pad = 0;
1237 /* number of zeros to be inserted for numeric conversions
1238 as required by the precision or minimal field width */
1240 size_t zero_padding_insertion_ind = 0;
1241 /* index into tmp where zero padding is to be inserted */
1243 char fmt_spec = '\0';
1244 /* current conversion specifier character */
1246 str_arg = credits;/* just to make compiler happy (defined but not used)*/
1248 starting_p = p; p++; /* skip '%' */
1250 while (*p == '0' || *p == '-' || *p == '+' ||
1251 *p == ' ' || *p == '#' || *p == '\'') {
1253 case '0': zero_padding = 1; break;
1254 case '-': justify_left = 1; break;
1255 case '+': force_sign = 1; space_for_positive = 0; break;
1256 case ' ': force_sign = 1;
1257 /* If both the ' ' and '+' flags appear, the ' ' flag should be ignored */
1258 #ifdef PERL_COMPATIBLE
1259 /* ... but in Perl the last of ' ' and '+' applies */
1260 space_for_positive = 1;
1263 case '#': alternate_form = 1; break;
1268 /* If the '0' and '-' flags both appear, the '0' flag should be ignored. */
1270 /* parse field width */
1273 p++; j = va_arg(ap, int);
1274 if (j >= 0) min_field_width = j;
1275 else { min_field_width = -j; justify_left = 1; }
1276 } else if (isdigit((int)(*p))) {
1277 /* size_t could be wider than unsigned int;
1278 make sure we treat argument like common implementations do */
1279 unsigned int uj = *p++ - '0';
1280 while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1281 min_field_width = uj;
1283 /* parse precision */
1285 p++; precision_specified = 1;
1287 int j = va_arg(ap, int);
1289 if (j >= 0) precision = j;
1291 precision_specified = 0; precision = 0;
1293 * Solaris 2.6 man page claims that in this case the precision
1294 * should be set to 0. Digital Unix 4.0, HPUX 10 and BSD man page
1295 * claim that this case should be treated as unspecified precision,
1296 * which is what we do here.
1299 } else if (isdigit((int)(*p))) {
1300 /* size_t could be wider than unsigned int;
1301 make sure we treat argument like common implementations do */
1302 unsigned int uj = *p++ - '0';
1303 while (isdigit((int)(*p))) uj = 10*uj + (unsigned int)(*p++ - '0');
1307 /* parse 'h', 'l' and 'll' length modifiers */
1308 if (*p == 'h' || *p == 'l') {
1309 length_modifier = *p; p++;
1310 if (length_modifier == 'l' && *p == 'l') { /* double l = long long */
1311 #ifdef SNPRINTF_LONGLONG_SUPPORT
1312 length_modifier = '2'; /* double l encoded as '2' */
1314 length_modifier = 'l'; /* treat it as a single 'l' */
1320 /* common synonyms: */
1322 case 'i': fmt_spec = 'd'; break;
1323 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break;
1324 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break;
1325 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break;
1328 /* get parameter value, do initial processing */
1330 case '%': /* % behaves similar to 's' regarding flags and field widths */
1331 case 'c': /* c behaves similar to 's' regarding flags and field widths */
1333 length_modifier = '\0'; /* wint_t and wchar_t not supported */
1334 /* the result of zero padding flag with non-numeric conversion specifier*/
1335 /* is undefined. Solaris and HPUX 10 does zero padding in this case, */
1336 /* Digital Unix and Linux does not. */
1337 #if !defined(SOLARIS_COMPATIBLE) && !defined(HPUX_COMPATIBLE)
1338 zero_padding = 0; /* turn zero padding off for string conversions */
1345 int j = va_arg(ap, int);
1346 uchar_arg = (unsigned char) j; /* standard demands unsigned char */
1347 str_arg = (const char *) &uchar_arg;
1351 str_arg = va_arg(ap, const char *);
1352 if (!str_arg) str_arg_l = 0;
1353 /* make sure not to address string beyond the specified precision !!! */
1354 else if (!precision_specified) str_arg_l = strlen(str_arg);
1355 /* truncate string if necessary as requested by precision */
1356 else if (precision == 0) str_arg_l = 0;
1358 /* memchr on HP does not like n > 2^31 !!! */
1359 const char *q = memchr(str_arg, '\0',
1360 precision <= 0x7fffffff ? precision : 0x7fffffff);
1361 str_arg_l = !q ? precision : (q-str_arg);
1367 case 'd': case 'u': case 'o': case 'x': case 'X': case 'p': {
1368 /* NOTE: the u, o, x, X and p conversion specifiers imply
1369 the value is unsigned; d implies a signed value */
1372 /* 0 if numeric argument is zero (or if pointer is NULL for 'p'),
1373 +1 if greater than zero (or nonzero for unsigned arguments),
1374 -1 if negative (unsigned argument is never negative) */
1376 int int_arg = 0; unsigned int uint_arg = 0;
1377 /* only defined for length modifier h, or for no length modifiers */
1379 long int long_arg = 0; unsigned long int ulong_arg = 0;
1380 /* only defined for length modifier l */
1382 void *ptr_arg = NULL;
1383 /* pointer argument value -only defined for p conversion */
1385 #ifdef SNPRINTF_LONGLONG_SUPPORT
1386 long long int long_long_arg = 0;
1387 unsigned long long int ulong_long_arg = 0;
1388 /* only defined for length modifier ll */
1390 if (fmt_spec == 'p') {
1391 /* HPUX 10: An l, h, ll or L before any other conversion character
1392 * (other than d, i, u, o, x, or X) is ignored.
1394 * not specified, but seems to behave as HPUX does.
1395 * Solaris: If an h, l, or L appears before any other conversion
1396 * specifier (other than d, i, u, o, x, or X), the behavior
1397 * is undefined. (Actually %hp converts only 16-bits of address
1398 * and %llp treats address as 64-bit data which is incompatible
1399 * with (void *) argument on a 32-bit system).
1401 #ifdef SOLARIS_COMPATIBLE
1402 # ifdef SOLARIS_BUG_COMPATIBLE
1403 /* keep length modifiers even if it represents 'll' */
1405 if (length_modifier == '2') length_modifier = '\0';
1408 length_modifier = '\0';
1410 ptr_arg = va_arg(ap, void *);
1411 if (ptr_arg != NULL) arg_sign = 1;
1412 } else if (fmt_spec == 'd') { /* signed */
1413 switch (length_modifier) {
1416 /* It is non-portable to specify a second argument of char or short
1417 * to va_arg, because arguments seen by the called function
1418 * are not char or short. C converts char and short arguments
1419 * to int before passing them to a function.
1421 int_arg = va_arg(ap, int);
1422 if (int_arg > 0) arg_sign = 1;
1423 else if (int_arg < 0) arg_sign = -1;
1426 long_arg = va_arg(ap, long int);
1427 if (long_arg > 0) arg_sign = 1;
1428 else if (long_arg < 0) arg_sign = -1;
1430 #ifdef SNPRINTF_LONGLONG_SUPPORT
1432 long_long_arg = va_arg(ap, long long int);
1433 if (long_long_arg > 0) arg_sign = 1;
1434 else if (long_long_arg < 0) arg_sign = -1;
1438 } else { /* unsigned */
1439 switch (length_modifier) {
1442 uint_arg = va_arg(ap, unsigned int);
1443 if (uint_arg) arg_sign = 1;
1446 ulong_arg = va_arg(ap, unsigned long int);
1447 if (ulong_arg) arg_sign = 1;
1449 #ifdef SNPRINTF_LONGLONG_SUPPORT
1451 ulong_long_arg = va_arg(ap, unsigned long long int);
1452 if (ulong_long_arg) arg_sign = 1;
1457 str_arg = tmp; str_arg_l = 0;
1459 * For d, i, u, o, x, and X conversions, if precision is specified,
1460 * the '0' flag should be ignored. This is so with Solaris 2.6,
1461 * Digital UNIX 4.0, HPUX 10, Linux, FreeBSD, NetBSD; but not with Perl.
1463 #ifndef PERL_COMPATIBLE
1464 if (precision_specified) zero_padding = 0;
1466 if (fmt_spec == 'd') {
1467 if (force_sign && arg_sign >= 0)
1468 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1469 /* leave negative numbers for sprintf to handle,
1470 to avoid handling tricky cases like (short int)(-32768) */
1471 #ifdef LINUX_COMPATIBLE
1472 } else if (fmt_spec == 'p' && force_sign && arg_sign > 0) {
1473 tmp[str_arg_l++] = space_for_positive ? ' ' : '+';
1475 } else if (alternate_form) {
1476 if (arg_sign != 0 && (fmt_spec == 'x' || fmt_spec == 'X') )
1477 { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = fmt_spec; }
1478 /* alternate form should have no effect for p conversion, but ... */
1479 #ifdef HPUX_COMPATIBLE
1480 else if (fmt_spec == 'p'
1481 /* HPUX 10: for an alternate form of p conversion,
1482 * a nonzero result is prefixed by 0x. */
1483 #ifndef HPUX_BUG_COMPATIBLE
1484 /* Actually it uses 0x prefix even for a zero value. */
1487 ) { tmp[str_arg_l++] = '0'; tmp[str_arg_l++] = 'x'; }
1490 zero_padding_insertion_ind = str_arg_l;
1491 if (!precision_specified) precision = 1; /* default precision is 1 */
1492 if (precision == 0 && arg_sign == 0
1493 #if defined(HPUX_BUG_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1495 /* HPUX 10 man page claims: With conversion character p the result of
1496 * converting a zero value with a precision of zero is a null string.
1497 * Actually HP returns all zeroes, and Linux returns "(nil)". */
1500 /* converted to null string */
1501 /* When zero value is formatted with an explicit precision 0,
1502 the resulting formatted string is empty (d, i, u, o, x, X, p). */
1504 char f[5]; int f_l = 0;
1505 f[f_l++] = '%'; /* construct a simple format string for sprintf */
1506 if (!length_modifier) { }
1507 else if (length_modifier=='2') { f[f_l++] = 'l'; f[f_l++] = 'l'; }
1508 else f[f_l++] = length_modifier;
1509 f[f_l++] = fmt_spec; f[f_l++] = '\0';
1510 if (fmt_spec == 'p') str_arg_l += sprintf(tmp+str_arg_l, f, ptr_arg);
1511 else if (fmt_spec == 'd') { /* signed */
1512 switch (length_modifier) {
1514 case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, int_arg); break;
1515 case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, long_arg); break;
1516 #ifdef SNPRINTF_LONGLONG_SUPPORT
1517 case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,long_long_arg); break;
1520 } else { /* unsigned */
1521 switch (length_modifier) {
1523 case 'h': str_arg_l+=sprintf(tmp+str_arg_l, f, uint_arg); break;
1524 case 'l': str_arg_l+=sprintf(tmp+str_arg_l, f, ulong_arg); break;
1525 #ifdef SNPRINTF_LONGLONG_SUPPORT
1526 case '2': str_arg_l+=sprintf(tmp+str_arg_l,f,ulong_long_arg);break;
1530 /* include the optional minus sign and possible "0x"
1531 in the region before the zero padding insertion point */
1532 if (zero_padding_insertion_ind < str_arg_l &&
1533 tmp[zero_padding_insertion_ind] == '-') {
1534 zero_padding_insertion_ind++;
1536 if (zero_padding_insertion_ind+1 < str_arg_l &&
1537 tmp[zero_padding_insertion_ind] == '0' &&
1538 (tmp[zero_padding_insertion_ind+1] == 'x' ||
1539 tmp[zero_padding_insertion_ind+1] == 'X') ) {
1540 zero_padding_insertion_ind += 2;
1543 { size_t num_of_digits = str_arg_l - zero_padding_insertion_ind;
1544 if (alternate_form && fmt_spec == 'o'
1545 #ifdef HPUX_COMPATIBLE /* ("%#.o",0) -> "" */
1548 #ifdef DIGITAL_UNIX_BUG_COMPATIBLE /* ("%#o",0) -> "00" */
1550 /* unless zero is already the first character */
1551 && !(zero_padding_insertion_ind < str_arg_l
1552 && tmp[zero_padding_insertion_ind] == '0')
1554 ) { /* assure leading zero for alternate-form octal numbers */
1555 if (!precision_specified || precision < num_of_digits+1) {
1556 /* precision is increased to force the first character to be zero,
1557 except if a zero value is formatted with an explicit precision
1559 precision = num_of_digits+1; precision_specified = 1;
1562 /* zero padding to specified precision? */
1563 if (num_of_digits < precision)
1564 number_of_zeros_to_pad = precision - num_of_digits;
1566 /* zero padding to specified minimal field width? */
1567 if (!justify_left && zero_padding) {
1568 int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1569 if (n > 0) number_of_zeros_to_pad += n;
1573 default: /* unrecognized conversion specifier, keep format string as-is*/
1574 zero_padding = 0; /* turn zero padding off for non-numeric convers. */
1575 #ifndef DIGITAL_UNIX_COMPATIBLE
1576 justify_left = 1; min_field_width = 0; /* reset flags */
1578 #if defined(PERL_COMPATIBLE) || defined(LINUX_COMPATIBLE)
1579 /* keep the entire format string unchanged */
1580 str_arg = starting_p; str_arg_l = p - starting_p;
1581 /* well, not exactly so for Linux, which does something inbetween,
1582 * and I don't feel an urge to imitate it: "%+++++hy" -> "%+y" */
1584 /* discard the unrecognized conversion, just keep *
1585 * the unrecognized conversion character */
1586 str_arg = p; str_arg_l = 0;
1588 if (*p) str_arg_l++; /* include invalid conversion specifier unchanged
1589 if not at end-of-string */
1592 if (*p) p++; /* step over the just processed conversion specifier */
1593 /* insert padding to the left as requested by min_field_width;
1594 this does not include the zero padding in case of numerical conversions*/
1595 if (!justify_left) { /* left padding with blank or zero */
1596 int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1598 if (str_l < str_m) {
1599 size_t avail = str_m-str_l;
1600 fast_memset(str+str_l, (zero_padding?'0':' '), (n>avail?avail:n));
1605 /* zero padding as requested by the precision or by the minimal field width
1606 * for numeric conversions required? */
1607 if (number_of_zeros_to_pad <= 0) {
1608 /* will not copy first part of numeric right now, *
1609 * force it to be copied later in its entirety */
1610 zero_padding_insertion_ind = 0;
1612 /* insert first part of numerics (sign or '0x') before zero padding */
1613 int n = zero_padding_insertion_ind;
1615 if (str_l < str_m) {
1616 size_t avail = str_m-str_l;
1617 fast_memcpy(str+str_l, str_arg, (n>avail?avail:n));
1621 /* insert zero padding as requested by the precision or min field width */
1622 n = number_of_zeros_to_pad;
1624 if (str_l < str_m) {
1625 size_t avail = str_m-str_l;
1626 fast_memset(str+str_l, '0', (n>avail?avail:n));
1631 /* insert formatted string
1632 * (or as-is conversion specifier for unknown conversions) */
1633 { int n = str_arg_l - zero_padding_insertion_ind;
1635 if (str_l < str_m) {
1636 size_t avail = str_m-str_l;
1637 fast_memcpy(str+str_l, str_arg+zero_padding_insertion_ind,
1643 /* insert right padding */
1644 if (justify_left) { /* right blank padding to the field width */
1645 int n = min_field_width - (str_arg_l+number_of_zeros_to_pad);
1647 if (str_l < str_m) {
1648 size_t avail = str_m-str_l;
1649 fast_memset(str+str_l, ' ', (n>avail?avail:n));
1656 #if defined(NEED_SNPRINTF_ONLY)
1659 if (str_m > 0) { /* make sure the string is null-terminated
1660 even at the expense of overwriting the last character
1661 (shouldn't happen, but just in case) */
1662 str[str_l <= str_m-1 ? str_l : str_m-1] = '\0';
1664 /* Return the number of characters formatted (excluding trailing null
1665 * character), that is, the number of characters that would have been
1666 * written to the buffer if it were large enough.
1668 * The value of str_l should be returned, but str_l is of unsigned type
1669 * size_t, and snprintf is int, possibly leading to an undetected
1670 * integer overflow, resulting in a negative return value, which is illegal.
1671 * Both XSH5 and ISO C99 (at least the draft) are silent on this issue.
1672 * Should errno be set to EOVERFLOW and EOF returned in this case???
1677 #endif /* __OS2__ */