1 const char errlog_rcs[] = "$Id: errlog.c,v 1.55 2007/10/14 14:12:41 fabiankeil Exp $";
2 /*********************************************************************
4 * File : $Source: /cvsroot/ijbswa/current/errlog.c,v $
6 * Purpose : Log errors to a designated destination in an elegant,
9 * Copyright : Written by and Copyright (C) 2001-2007 the SourceForge
10 * Privoxy team. http://www.privoxy.org/
12 * Based on the Internet Junkbuster originally written
13 * by and Copyright (C) 1997 Anonymous Coders and
14 * Junkbusters Corporation. http://www.junkbusters.com
16 * This program is free software; you can redistribute it
17 * and/or modify it under the terms of the GNU General
18 * Public License as published by the Free Software
19 * Foundation; either version 2 of the License, or (at
20 * your option) any later version.
22 * This program is distributed in the hope that it will
23 * be useful, but WITHOUT ANY WARRANTY; without even the
24 * implied warranty of MERCHANTABILITY or FITNESS FOR A
25 * PARTICULAR PURPOSE. See the GNU General Public
26 * License for more details.
28 * The GNU General Public License should be included with
29 * this file. If not, you can view it at
30 * http://www.gnu.org/copyleft/gpl.html
31 * or write to the Free Software Foundation, Inc., 59
32 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
36 * Revision 1.55 2007/10/14 14:12:41 fabiankeil
37 * When in daemon mode, close stderr after the configuration file has been
38 * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
40 * Revision 1.54 2007/09/22 16:15:34 fabiankeil
41 * - Let it compile with pcc.
42 * - Move our includes below system includes to prevent macro conflicts.
44 * Revision 1.53 2007/08/05 13:53:14 fabiankeil
45 * #1763173 from Stefan Huehner: declare some more functions
46 * static and use void instead of empty parameter lists.
48 * Revision 1.52 2007/07/14 07:28:47 fabiankeil
49 * Add translation function for JB_ERR_FOO codes.
51 * Revision 1.51 2007/05/11 11:51:34 fabiankeil
52 * Fix a type mismatch warning.
54 * Revision 1.50 2007/04/11 10:55:44 fabiankeil
55 * Enforce some assertions that could be triggered
56 * on mingw32 and other systems where we use threads
59 * Revision 1.49 2007/04/08 16:44:15 fabiankeil
60 * We need <sys/time.h> for gettimeofday(), not <time.h>.
62 * Revision 1.48 2007/03/31 13:33:28 fabiankeil
63 * Add alternative log_error() with timestamps
64 * that contain milliseconds and without using
65 * strcpy(), strcat() or sprintf().
67 * Revision 1.47 2006/11/28 15:25:15 fabiankeil
68 * Only unlink the pidfile if it's actually used.
70 * Revision 1.46 2006/11/13 19:05:51 fabiankeil
71 * Make pthread mutex locking more generic. Instead of
72 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
73 * and use mutex locking unless there is an _r function
74 * available. Better safe than sorry.
76 * Fixes "./configure --disable-pthread" and should result
77 * in less threading-related problems on pthread-using platforms,
78 * but it still doesn't fix BR#1122404.
80 * Revision 1.45 2006/08/21 11:15:54 david__schmidt
81 * MS Visual C++ build updates
83 * Revision 1.44 2006/08/18 16:03:16 david__schmidt
84 * Tweak for OS/2 build happiness.
86 * Revision 1.43 2006/08/03 02:46:41 david__schmidt
87 * Incorporate Fabian Keil's patch work:
88 * http://www.fabiankeil.de/sourcecode/privoxy/
90 * Revision 1.42 2006/07/18 14:48:46 david__schmidt
91 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
92 * with what was really the latest development (the v_3_0_branch branch)
94 * Revision 1.40.2.4 2005/04/03 20:10:50 david__schmidt
95 * Thanks to Jindrich Makovicka for a race condition fix for the log
96 * file. The race condition remains for non-pthread implementations.
97 * Reference patch #1175720.
99 * Revision 1.40.2.3 2003/03/07 03:41:04 david__schmidt
100 * Wrapping all *_r functions (the non-_r versions of them) with mutex
101 * semaphores for OSX. Hopefully this will take care of all of those pesky
104 * Revision 1.40.2.2 2002/09/28 00:30:57 david__schmidt
105 * Update error logging to give sane values for thread IDs on Mach kernels.
106 * It's still a hack, but at least it looks farily normal. We print the
107 * absolute value of the first 4 bytes of the pthread_t modded with 1000.
109 * Revision 1.40.2.1 2002/09/25 12:47:42 oes
110 * Make log_error safe against NULL string arguments
112 * Revision 1.40 2002/05/22 01:27:27 david__schmidt
114 * Add os2_socket_strerr mirroring w32_socket_strerr.
116 * Revision 1.39 2002/04/03 17:15:27 gliptak
117 * zero padding thread ids in log
119 * Revision 1.38 2002/03/31 17:18:59 jongfoster
120 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
122 * Revision 1.37 2002/03/27 14:32:43 david__schmidt
123 * More compiler warning message maintenance
125 * Revision 1.36 2002/03/26 22:29:54 swa
126 * we have a new homepage!
128 * Revision 1.35 2002/03/24 15:23:33 jongfoster
131 * Revision 1.34 2002/03/24 13:25:43 swa
132 * name change related issues
134 * Revision 1.33 2002/03/13 00:27:04 jongfoster
137 * Revision 1.32 2002/03/07 03:46:17 oes
138 * Fixed compiler warnings
140 * Revision 1.31 2002/03/06 23:02:57 jongfoster
143 * Revision 1.30 2002/03/05 22:43:45 david__schmidt
144 * - Better error reporting on OS/2
145 * - Fix double-slash comment (oops)
147 * Revision 1.29 2002/03/04 23:45:13 jongfoster
148 * Printing thread ID if using Win32 native threads
150 * Revision 1.28 2002/03/04 17:59:59 oes
151 * Deleted deletePidFile(), cosmetics
153 * Revision 1.27 2002/03/04 02:08:01 david__schmidt
154 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
156 * Revision 1.26 2002/01/09 19:05:45 steudten
157 * Fix big memory leak.
159 * Revision 1.25 2002/01/09 14:32:08 oes
160 * Added support for gmtime_r and localtime_r.
162 * Revision 1.24 2001/12/30 14:07:32 steudten
163 * - Add signal handling (unix)
164 * - Add SIGHUP handler (unix)
165 * - Add creation of pidfile (unix)
166 * - Add action 'top' in rc file (RH)
167 * - Add entry 'SIGNALS' to manpage
168 * - Add exit message to logfile (unix)
170 * Revision 1.23 2001/11/07 00:02:13 steudten
171 * Add line number in error output for lineparsing for
172 * actionsfile and configfile.
173 * Special handling for CLF added.
175 * Revision 1.22 2001/11/05 23:43:05 steudten
176 * Add time+date to log files.
178 * Revision 1.21 2001/10/25 03:40:47 david__schmidt
179 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
180 * threads to call select() simultaneously. So, it's time to do a real, live,
181 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
182 * (native). Both versions will work, but using __OS2__ offers multi-threading.
184 * Revision 1.20 2001/09/16 23:04:34 jongfoster
187 * Revision 1.19 2001/09/13 20:08:06 jongfoster
188 * Adding support for LOG_LEVEL_CGI
190 * Revision 1.18 2001/09/10 11:27:24 oes
191 * Declaration of w32_socket_strerr now conditional
193 * Revision 1.17 2001/09/10 10:17:13 oes
194 * Removed unused variable; Fixed sprintf format
196 * Revision 1.16 2001/07/30 22:08:36 jongfoster
197 * Tidying up #defines:
198 * - All feature #defines are now of the form FEATURE_xxx
199 * - Permanently turned off WIN_GUI_EDIT
200 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
202 * Revision 1.15 2001/07/29 17:41:10 jongfoster
203 * Now prints thread ID for each message (pthreads only)
205 * Revision 1.14 2001/07/19 19:03:48 haroon
206 * - Added case for LOG_LEVEL_POPUPS
208 * Revision 1.13 2001/07/13 13:58:58 oes
209 * - Added case for LOG_LEVEL_DEANIMATE
210 * - Removed all #ifdef PCRS
212 * Revision 1.12 2001/06/09 10:55:28 jongfoster
213 * Changing BUFSIZ ==> BUFFER_SIZE
215 * Revision 1.11 2001/06/01 18:14:49 jongfoster
216 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
217 * in config.h if appropriate) rather than the NO_STRERR macro.
219 * Revision 1.10 2001/05/29 11:52:21 oes
220 * Conditional compilation of w32_socket_error
222 * Revision 1.9 2001/05/28 16:15:17 jongfoster
223 * Improved reporting of errors under Win32.
225 * Revision 1.8 2001/05/26 17:25:14 jongfoster
226 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
228 * Revision 1.7 2001/05/26 15:21:28 jongfoster
229 * Activity animation in Win32 GUI now works even if debug==0
231 * Revision 1.6 2001/05/25 21:55:08 jongfoster
232 * Now cleans up properly on FATAL (removes taskbar icon etc)
234 * Revision 1.5 2001/05/22 18:46:04 oes
236 * - Enabled filtering banners by size rather than URL
237 * by adding patterns that replace all standard banner
238 * sizes with the "Junkbuster" gif to the re_filterfile
240 * - Enabled filtering WebBugs by providing a pattern
241 * which kills all 1x1 images
243 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
244 * which is selected by the (nonstandard and therefore
245 * capital) letter 'U' in the option string.
246 * It causes the quantifiers to be ungreedy by default.
247 * Appending a ? turns back to greedy (!).
249 * - Added a new interceptor ijb-send-banner, which
250 * sends back the "Junkbuster" gif. Without imagelist or
251 * MSIE detection support, or if tinygif = 1, or the
252 * URL isn't recognized as an imageurl, a lame HTML
253 * explanation is sent instead.
255 * - Added new feature, which permits blocking remote
256 * script redirects and firing back a local redirect
258 * The feature is conditionally compiled, i.e. it
259 * can be disabled with --disable-fast-redirects,
260 * plus it must be activated by a "fast-redirects"
261 * line in the config file, has its own log level
262 * and of course wants to be displayed by show-proxy-args
263 * Note: Boy, all the #ifdefs in 1001 locations and
264 * all the fumbling with configure.in and acconfig.h
265 * were *way* more work than the feature itself :-(
267 * - Because a generic redirect template was needed for
268 * this, tinygif = 3 now uses the same.
270 * - Moved GIFs, and other static HTTP response templates
275 * - Removed some >400 CRs again (Jon, you really worked
278 * Revision 1.4 2001/05/21 19:32:54 jongfoster
279 * Added another #ifdef _WIN_CONSOLE
281 * Revision 1.3 2001/05/20 01:11:40 jongfoster
282 * Added support for LOG_LEVEL_FATAL
283 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
284 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
286 * Revision 1.2 2001/05/17 22:42:01 oes
287 * - Cleaned CRLF's from the sources and related files
288 * - Repaired logging for REF and FRC
290 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
291 * Initial import of version 2.9.3 source tree
294 *********************************************************************/
303 #include "miscutil.h"
305 /* For gettimeofday() */
306 #include <sys/time.h>
308 #if !defined(_WIN32) && !defined(__OS2__)
310 #endif /* !defined(_WIN32) && !defined(__OS2__) */
322 #endif /* ndef _WIN_CONSOLE */
323 #endif /* def _WIN32 */
325 #define inline __inline
326 #endif /* def _MSC_VER */
329 #include <sys/socket.h> /* For sock_errno */
338 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
342 * LOG_LEVEL_FATAL cannot be turned off. (There are
343 * some exceptional situations where we need to get a
344 * message to the user).
346 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
348 /* where to log (default: stderr) */
349 static FILE *logfp = NULL;
351 /* logging detail level. */
352 int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
354 /* static functions */
355 static void fatal_error(const char * error_message);
357 static char *w32_socket_strerr(int errcode, char *tmp_buf);
360 static char *os2_socket_strerr(int errcode, char *tmp_buf);
363 #ifdef FEATURE_PTHREAD
364 static inline void lock_logfile(void)
366 pthread_mutex_lock(&log_mutex);
368 static inline void unlock_logfile(void)
370 pthread_mutex_unlock(&log_mutex);
372 static inline void lock_loginit(void)
374 pthread_mutex_lock(&log_init_mutex);
376 static inline void unlock_loginit(void)
378 pthread_mutex_unlock(&log_init_mutex);
380 #else /* ! FEATURE_PTHREAD */
382 * FIXME we need a cross-platform locking mechanism.
383 * The locking/unlocking functions below should be
384 * fleshed out for non-pthread implementations.
386 static inline void lock_logfile() {}
387 static inline void unlock_logfile() {}
388 static inline void lock_loginit() {}
389 static inline void unlock_loginit() {}
392 /*********************************************************************
394 * Function : fatal_error
396 * Description : Displays a fatal error to standard error (or, on
397 * a WIN32 GUI, to a dialog box), and exits
398 * JunkBuster with status code 1.
401 * 1 : error_message = The error message to display.
403 * Returns : Does not return.
405 *********************************************************************/
406 static void fatal_error(const char * error_message)
408 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
409 MessageBox(g_hwndLogFrame, error_message, "Privoxy Error",
410 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
412 /* Cleanup - remove taskbar icon etc. */
415 #else /* if !defined(_WIN32) || defined(_WIN_CONSOLE) */
416 fputs(error_message, logfp);
417 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
430 /*********************************************************************
432 * Function : show_version
434 * Description : Logs the Privoxy version and the program name.
437 * 1 : prog_name = The program name.
441 *********************************************************************/
442 static void show_version(const char *prog_name)
444 log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
445 if (prog_name != NULL)
447 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
452 /*********************************************************************
454 * Function : init_log_module
456 * Description : Initializes the logging module to log to stderr.
457 * Can only be called while stderr hasn't been closed
458 * yet and is only supposed to be called once.
461 * 1 : prog_name = The program name.
465 *********************************************************************/
466 void init_log_module(const char *prog_name)
471 set_debug_level(debug);
472 show_version(prog_name);
476 /*********************************************************************
478 * Function : set_debug_level
480 * Description : Sets the debug level to the provided value
481 * plus LOG_LEVEL_MINIMUM.
483 * XXX: we should only use the LOG_LEVEL_MINIMUM
484 * until the frist time the configuration file has
487 * Parameters : 1: debug_level = The debug level to set.
491 *********************************************************************/
492 void set_debug_level(int debug_level)
494 debug = debug_level | LOG_LEVEL_MINIMUM;
498 /*********************************************************************
500 * Function : disable_logging
502 * Description : Disables logging.
508 *********************************************************************/
509 void disable_logging(void)
521 /*********************************************************************
523 * Function : init_error_log
525 * Description : Initializes the logging module to log to a file.
527 * XXX: should be renamed.
530 * 1 : prog_name = The program name.
531 * 2 : logfname = The logfile name, or NULL for stderr.
532 * 3 : debuglevel = The debugging level.
536 *********************************************************************/
537 void init_error_log(const char *prog_name, const char *logfname)
541 assert(NULL != logfname);
546 if ((logfp != NULL) && (logfp != stderr))
548 log_error(LOG_LEVEL_INFO, "(Re-)Open logfile \'%s\'", logfname ? logfname : "none");
551 /* set the designated log file */
552 fp = fopen(logfname, "a");
555 log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
558 /* set logging to be completely unbuffered */
568 show_version(prog_name);
572 } /* init_error_log */
575 /*********************************************************************
577 * Function : get_thread_id
579 * Description : Returns a number that is different for each thread.
581 * XXX: Should be moved elsewhere (miscutil.c?)
585 * Returns : thread_id
587 *********************************************************************/
588 static long get_thread_id(void)
590 long this_thread = 1; /* was: pthread_t this_thread;*/
594 APIRET ulrc; /* XXX: I have no clue what this does */
597 /* FIXME get current thread id */
598 #ifdef FEATURE_PTHREAD
599 this_thread = (long)pthread_self();
602 * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
603 * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
604 * pthread_t is supposed to be opaque... but it's fairly random, though, so
605 * we make it mostly presentable.
607 this_thread = abs(this_thread % 1000);
608 #endif /* def __MACH__ */
609 #elif defined(_WIN32)
610 this_thread = GetCurrentThreadId();
611 #elif defined(__OS2__)
612 ulrc = DosGetInfoBlocks(&ptib, NULL);
614 this_thread = ptib -> tib_ptib2 -> tib2_ultid;
615 #endif /* def FEATURE_PTHREAD */
621 /*********************************************************************
623 * Function : get_log_timestamp
625 * Description : Generates the time stamp for the log message prefix.
628 * 1 : buffer = Storage buffer
629 * 2 : buffer_size = Size of storage buffer
631 * Returns : Number of written characters or 0 for error.
633 *********************************************************************/
634 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
639 struct timeval tv_now; /* XXX: stupid name */
641 int msecs_length = 0;
643 gettimeofday(&tv_now, NULL);
644 msecs = tv_now.tv_usec / 1000;
648 #ifdef HAVE_LOCALTIME_R
649 tm_now = *localtime_r(&now, &tm_now);
650 #elif FEATURE_PTHREAD
651 pthread_mutex_lock(&localtime_mutex);
652 tm_now = *localtime(&now);
653 pthread_mutex_unlock(&localtime_mutex);
655 tm_now = *localtime(&now);
658 length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
661 msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
663 if (msecs_length > 0)
665 length += (size_t)msecs_length;
676 /*********************************************************************
678 * Function : get_clf_timestamp
680 * Description : Generates a Common Log Format time string.
683 * 1 : buffer = Storage buffer
684 * 2 : buffer_size = Size of storage buffer
686 * Returns : Number of written characters or 0 for error.
688 *********************************************************************/
689 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
692 * Complex because not all OSs have tm_gmtoff or
693 * the %z field in strftime()
698 #ifdef HAVE_LOCALTIME_R
707 gmt = *gmtime_r(&now, &gmt);
708 #elif FEATURE_PTHREAD
709 pthread_mutex_lock(&gmtime_mutex);
711 pthread_mutex_unlock(&gmtime_mutex);
715 #ifdef HAVE_LOCALTIME_R
716 tm_now = localtime_r(&now, &dummy);
717 #elif FEATURE_PTHREAD
718 pthread_mutex_lock(&localtime_mutex);
719 tm_now = localtime(&now);
720 pthread_mutex_unlock(&localtime_mutex);
722 tm_now = localtime(&now);
724 days = tm_now->tm_yday - gmt.tm_yday;
725 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
726 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
728 length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
732 tz_length = snprintf(buffer+length, buffer_size-length,
733 "%+03d%02d", mins / 60, abs(mins) % 60);
737 length += (size_t)tz_length;
748 /*********************************************************************
750 * Function : get_log_level_string
752 * Description : Translates a numerical loglevel into a string.
755 * 1 : loglevel = LOG_LEVEL_FOO
757 * Returns : Log level string.
759 *********************************************************************/
760 static inline const char *get_log_level_string(int loglevel)
762 char *log_level_string = NULL;
764 assert(0 < loglevel);
768 case LOG_LEVEL_ERROR:
769 log_level_string = "Error";
771 case LOG_LEVEL_FATAL:
772 log_level_string = "Fatal error";
775 log_level_string = "Request";
777 case LOG_LEVEL_CONNECT:
778 log_level_string = "Connect";
781 log_level_string = "Writing";
783 case LOG_LEVEL_HEADER:
784 log_level_string = "Header";
787 log_level_string = "Info";
789 case LOG_LEVEL_RE_FILTER:
790 log_level_string = "Re-Filter";
792 #ifdef FEATURE_FORCE_LOAD
793 case LOG_LEVEL_FORCE:
794 log_level_string = "Force";
796 #endif /* def FEATURE_FORCE_LOAD */
797 #ifdef FEATURE_FAST_REDIRECTS
798 case LOG_LEVEL_REDIRECTS:
799 log_level_string = "Redirect";
801 #endif /* def FEATURE_FAST_REDIRECTS */
802 case LOG_LEVEL_DEANIMATE:
803 log_level_string = "Gif-Deanimate";
805 #ifdef FEATURE_KILL_POPUPS
806 case LOG_LEVEL_POPUPS:
807 log_level_string = "Kill-Popups";
809 #endif /* def FEATURE_KILL_POPUPS */
811 log_level_string = "CGI";
814 log_level_string = "Unknown log level";
817 assert(NULL != log_level_string);
819 return log_level_string;
823 /*********************************************************************
825 * Function : log_error
827 * Description : This is the error-reporting and logging function.
830 * 1 : loglevel = the type of message to be logged
831 * 2 : fmt = the main string we want logged, printf-like
832 * 3 : ... = arguments to be inserted in fmt (printf-like).
836 *********************************************************************/
837 void log_error(int loglevel, const char *fmt, ...)
841 static char *outbuf_save = NULL;
842 char tempbuf[BUFFER_SIZE];
844 const char * src = fmt;
848 * XXX: Make this a config option,
849 * why else do we allocate instead of using
852 size_t log_buffer_size = BUFFER_SIZE;
854 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
856 * Irrespective of debug setting, a GET/POST/CONNECT makes
857 * the taskbar icon animate. (There is an option to disable
858 * this but checking that is handled inside LogShowActivity()).
860 if (loglevel == LOG_LEVEL_GPC)
864 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
867 * verify that the loglevel applies to current
868 * settings and that logging is enabled.
869 * Bail out otherwise.
871 if ((0 == (loglevel & debug)) || (logfp == NULL))
876 thread_id = get_thread_id();
877 get_log_timestamp(timestamp, sizeof(timestamp));
879 /* protect the whole function because of the static buffer (outbuf) */
882 if (NULL == outbuf_save)
884 outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
885 if (NULL == outbuf_save)
887 snprintf(tempbuf, sizeof(tempbuf),
888 "%s Privoxy(%08lx) Fatal error: log_error() failed to allocate buffer memory.\n"
889 "\nExiting.", timestamp, thread_id);
890 assert(NULL != logfp);
891 fputs(tempbuf, logfp);
893 fatal_error(tempbuf); /* Exit */
896 outbuf = outbuf_save;
899 * Memsetting the whole buffer to zero (in theory)
900 * makes things easier later on.
902 memset(outbuf, 0, log_buffer_size);
904 /* Add prefix for everything but Common Log Format messages */
905 if (loglevel != LOG_LEVEL_CLF)
907 length = (size_t)snprintf(outbuf, log_buffer_size, "%s Privoxy(%08lx) %s: ",
908 timestamp, thread_id, get_log_level_string(loglevel));
911 /* get ready to scan var. args. */
914 /* build formatted message from fmt and var-args */
915 while ((*src) && (length < log_buffer_size-2))
917 const char *sval = NULL; /* %N string */
918 int ival; /* %N string length or an error code */
919 unsigned uval; /* %u value */
920 long lval; /* %l value */
921 unsigned long ulval; /* %ul value */
923 const char *format_string = tempbuf;
928 outbuf[length++] = ch;
930 * XXX: Only necessary on platforms which don't use pthread
931 * mutexes (mingw32 for example), where multiple threads can
932 * write to the buffer at the same time.
934 outbuf[length] = '\0';
937 outbuf[length] = '\0';
945 ival = va_arg( ap, int );
946 snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
949 uval = va_arg( ap, unsigned );
950 snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
953 /* this is a modifier that must be followed by u or d */
957 lval = va_arg( ap, long );
958 snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
962 ulval = va_arg( ap, unsigned long );
963 snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
967 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
968 loglevel = LOG_LEVEL_FATAL;
973 * Note that char paramaters are converted to int, so we need to
974 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
976 tempbuf[0] = (char) va_arg(ap, int);
980 format_string = va_arg(ap, char *);
981 if (format_string == NULL)
983 format_string = "[null]";
988 * Non-standard: Print a counted unterminated string.
989 * Takes 2 parameters: int length, const char * string.
991 ival = va_arg(ap, int);
992 sval = va_arg(ap, char *);
995 format_string = "[null]";
1001 /* That's ok (but stupid) */
1007 * That's not ok (and even more stupid)
1010 format_string = "[counted string lenght < 0]";
1013 else if (ival >= sizeof(tempbuf))
1016 * String is too long, copy as much as possible.
1017 * It will be further truncated later.
1019 memcpy(tempbuf, sval, sizeof(tempbuf)-1);
1020 tempbuf[sizeof(tempbuf)-1] = '\0';
1024 memcpy(tempbuf, sval, (size_t) ival);
1025 tempbuf[ival] = '\0';
1029 /* Non-standard: Print error code from errno */
1031 ival = WSAGetLastError();
1032 format_string = w32_socket_strerr(ival, tempbuf);
1034 ival = sock_errno();
1037 format_string = os2_socket_strerr(ival, tempbuf);
1042 format_string = strerror(ival);
1044 #else /* ifndef _WIN32 */
1046 #ifdef HAVE_STRERROR
1047 format_string = strerror(ival);
1048 #else /* ifndef HAVE_STRERROR */
1049 format_string = NULL;
1050 #endif /* ndef HAVE_STRERROR */
1053 snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
1055 #endif /* ndef _WIN32 */
1058 /* Non-standard: Print a Common Log File timestamp */
1059 get_clf_timestamp(tempbuf, sizeof(tempbuf));
1062 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1063 loglevel = LOG_LEVEL_FATAL;
1067 assert(length < log_buffer_size);
1068 length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
1070 if (length >= log_buffer_size-2)
1072 static char warning[] = "... [too long, truncated]";
1074 length = log_buffer_size - sizeof(warning) - 1;
1075 length += strlcpy(outbuf + length, warning, log_buffer_size - length);
1076 assert(length < log_buffer_size);
1080 } /* for( p ... ) */
1082 /* done with var. args */
1085 assert(length < log_buffer_size);
1086 length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
1088 /* Some sanity checks */
1089 if (!(length < log_buffer_size)
1090 || !(outbuf[log_buffer_size-1] == '\0')
1091 || !(outbuf[log_buffer_size] == '\0')
1094 /* Repeat as assertions */
1095 assert(length < log_buffer_size);
1096 assert(outbuf[log_buffer_size-1] == '\0');
1098 * outbuf's real size is log_buffer_size+1,
1099 * so while this looks like an off-by-one,
1100 * we're only checking our paranoia byte.
1102 assert(outbuf[log_buffer_size] == '\0');
1104 snprintf(outbuf, log_buffer_size,
1105 "%s Privoxy(%08lx) Fatal error: log_error()'s sanity checks failed. length: %d\n"
1106 "Exiting.", timestamp, thread_id, (int)length);
1107 loglevel = LOG_LEVEL_FATAL;
1110 assert(NULL != logfp);
1112 if (loglevel == LOG_LEVEL_FATAL)
1114 fatal_error(outbuf_save);
1115 /* Never get here */
1117 fputs(outbuf_save, logfp);
1121 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1122 /* Write to display */
1123 LogPutString(outbuf_save);
1124 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1129 /*********************************************************************
1131 * Function : jb_err_to_string
1133 * Description : Translates JB_ERR_FOO codes into strings.
1135 * XXX: the type of error codes is jb_err
1136 * but the typedef'inition is currently not
1137 * visible to all files that include errlog.h.
1140 * 1 : error = a valid jb_err code
1142 * Returns : A string with the jb_err translation
1144 *********************************************************************/
1145 const char *jb_err_to_string(int error)
1150 return "Success, no error";
1152 return "Out of memory";
1153 case JB_ERR_CGI_PARAMS:
1154 return "Missing or corrupt CGI parameters";
1156 return "Error opening, reading or writing a file";
1158 return "Parse error";
1159 case JB_ERR_MODIFIED:
1160 return "File has been modified outside of the CGI actions editor.";
1161 case JB_ERR_COMPRESS:
1162 return "(De)compression failure";
1165 return "Unknown error";
1168 return "Internal error";
1172 /*********************************************************************
1174 * Function : w32_socket_strerr
1176 * Description : Translate the return value from WSAGetLastError()
1180 * 1 : errcode = The return value from WSAGetLastError().
1181 * 2 : tmp_buf = A temporary buffer that might be used to
1184 * Returns : String representing the error code. This may be
1185 * a global string constant or a string stored in
1188 *********************************************************************/
1189 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1191 #define TEXT_FOR_ERROR(code,text) \
1192 if (errcode == code) \
1194 return #code " - " text; \
1197 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1198 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1199 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1200 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1201 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1202 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1203 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1204 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1205 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1206 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1207 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1208 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1209 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1210 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1211 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1212 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1213 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1214 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1215 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1216 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1217 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1218 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1219 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1220 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1221 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1222 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1223 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1224 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1225 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1226 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1227 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1228 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1229 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1230 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1231 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1232 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1233 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1234 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1235 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1236 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1237 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1238 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1240 * The following error codes are documented in the Microsoft WinSock
1241 * reference guide, but don't actually exist.
1243 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1244 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1245 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1246 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1247 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1248 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1249 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1250 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1251 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1252 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1255 sprintf(tmp_buf, "(error number %d)", errcode);
1258 #endif /* def _WIN32 */
1262 /*********************************************************************
1264 * Function : os2_socket_strerr
1266 * Description : Translate the return value from sock_errno()
1270 * 1 : errcode = The return value from sock_errno().
1271 * 2 : tmp_buf = A temporary buffer that might be used to
1274 * Returns : String representing the error code. This may be
1275 * a global string constant or a string stored in
1278 *********************************************************************/
1279 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1281 #define TEXT_FOR_ERROR(code,text) \
1282 if (errcode == code) \
1284 return #code " - " text; \
1287 TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
1288 TEXT_FOR_ERROR(SOCESRCH , "No such process.")
1289 TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
1290 TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
1291 TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
1292 TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
1293 TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
1294 TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
1295 TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
1296 TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
1297 TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
1298 TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
1299 TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
1300 TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
1301 TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
1302 TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
1303 TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
1304 TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
1305 TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1306 TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1307 TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
1308 TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
1309 TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
1310 TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
1311 TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
1312 TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
1313 TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
1314 TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
1315 TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
1316 TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
1317 TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
1318 TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
1319 TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
1320 TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
1321 TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
1322 TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
1323 TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
1324 TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
1325 TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
1326 TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
1327 TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
1328 TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
1329 TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
1331 sprintf(tmp_buf, "(error number %d)", errcode);
1334 #endif /* def __OS2__ */