1 const char errlog_rcs[] = "$Id: errlog.c,v 1.61 2007/11/04 19:03:01 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.61 2007/11/04 19:03:01 fabiankeil
37 * Fix another deadlock Hal spotted and that mysteriously didn't affect FreeBSD.
39 * Revision 1.60 2007/11/03 19:03:31 fabiankeil
40 * - Prevent the Windows GUI from showing the version two times in a row.
41 * - Stop using the imperative in the "(Re-)Open logfile" message.
42 * - Ditch the "Switching to daemon mode" message as the detection
43 * whether or not we're already in daemon mode doesn't actually work.
45 * Revision 1.59 2007/11/01 12:50:56 fabiankeil
46 * Here's looking at you, deadlock.
48 * Revision 1.58 2007/10/28 19:04:21 fabiankeil
49 * Don't mention daemon mode in "Logging disabled" message. Some
50 * platforms call it differently and it's not really relevant anyway.
52 * Revision 1.57 2007/10/27 13:02:26 fabiankeil
53 * Relocate daemon-mode-related log messages to make sure
54 * they aren't shown again in case of configuration reloads.
56 * Revision 1.56 2007/10/14 14:26:56 fabiankeil
57 * Remove the old log_error() version.
59 * Revision 1.55 2007/10/14 14:12:41 fabiankeil
60 * When in daemon mode, close stderr after the configuration file has been
61 * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
63 * Revision 1.54 2007/09/22 16:15:34 fabiankeil
64 * - Let it compile with pcc.
65 * - Move our includes below system includes to prevent macro conflicts.
67 * Revision 1.53 2007/08/05 13:53:14 fabiankeil
68 * #1763173 from Stefan Huehner: declare some more functions
69 * static and use void instead of empty parameter lists.
71 * Revision 1.52 2007/07/14 07:28:47 fabiankeil
72 * Add translation function for JB_ERR_FOO codes.
74 * Revision 1.51 2007/05/11 11:51:34 fabiankeil
75 * Fix a type mismatch warning.
77 * Revision 1.50 2007/04/11 10:55:44 fabiankeil
78 * Enforce some assertions that could be triggered
79 * on mingw32 and other systems where we use threads
82 * Revision 1.49 2007/04/08 16:44:15 fabiankeil
83 * We need <sys/time.h> for gettimeofday(), not <time.h>.
85 * Revision 1.48 2007/03/31 13:33:28 fabiankeil
86 * Add alternative log_error() with timestamps
87 * that contain milliseconds and without using
88 * strcpy(), strcat() or sprintf().
90 * Revision 1.47 2006/11/28 15:25:15 fabiankeil
91 * Only unlink the pidfile if it's actually used.
93 * Revision 1.46 2006/11/13 19:05:51 fabiankeil
94 * Make pthread mutex locking more generic. Instead of
95 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
96 * and use mutex locking unless there is an _r function
97 * available. Better safe than sorry.
99 * Fixes "./configure --disable-pthread" and should result
100 * in less threading-related problems on pthread-using platforms,
101 * but it still doesn't fix BR#1122404.
103 * Revision 1.45 2006/08/21 11:15:54 david__schmidt
104 * MS Visual C++ build updates
106 * Revision 1.44 2006/08/18 16:03:16 david__schmidt
107 * Tweak for OS/2 build happiness.
109 * Revision 1.43 2006/08/03 02:46:41 david__schmidt
110 * Incorporate Fabian Keil's patch work:
111 * http://www.fabiankeil.de/sourcecode/privoxy/
113 * Revision 1.42 2006/07/18 14:48:46 david__schmidt
114 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
115 * with what was really the latest development (the v_3_0_branch branch)
117 * Revision 1.40.2.4 2005/04/03 20:10:50 david__schmidt
118 * Thanks to Jindrich Makovicka for a race condition fix for the log
119 * file. The race condition remains for non-pthread implementations.
120 * Reference patch #1175720.
122 * Revision 1.40.2.3 2003/03/07 03:41:04 david__schmidt
123 * Wrapping all *_r functions (the non-_r versions of them) with mutex
124 * semaphores for OSX. Hopefully this will take care of all of those pesky
127 * Revision 1.40.2.2 2002/09/28 00:30:57 david__schmidt
128 * Update error logging to give sane values for thread IDs on Mach kernels.
129 * It's still a hack, but at least it looks farily normal. We print the
130 * absolute value of the first 4 bytes of the pthread_t modded with 1000.
132 * Revision 1.40.2.1 2002/09/25 12:47:42 oes
133 * Make log_error safe against NULL string arguments
135 * Revision 1.40 2002/05/22 01:27:27 david__schmidt
137 * Add os2_socket_strerr mirroring w32_socket_strerr.
139 * Revision 1.39 2002/04/03 17:15:27 gliptak
140 * zero padding thread ids in log
142 * Revision 1.38 2002/03/31 17:18:59 jongfoster
143 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
145 * Revision 1.37 2002/03/27 14:32:43 david__schmidt
146 * More compiler warning message maintenance
148 * Revision 1.36 2002/03/26 22:29:54 swa
149 * we have a new homepage!
151 * Revision 1.35 2002/03/24 15:23:33 jongfoster
154 * Revision 1.34 2002/03/24 13:25:43 swa
155 * name change related issues
157 * Revision 1.33 2002/03/13 00:27:04 jongfoster
160 * Revision 1.32 2002/03/07 03:46:17 oes
161 * Fixed compiler warnings
163 * Revision 1.31 2002/03/06 23:02:57 jongfoster
166 * Revision 1.30 2002/03/05 22:43:45 david__schmidt
167 * - Better error reporting on OS/2
168 * - Fix double-slash comment (oops)
170 * Revision 1.29 2002/03/04 23:45:13 jongfoster
171 * Printing thread ID if using Win32 native threads
173 * Revision 1.28 2002/03/04 17:59:59 oes
174 * Deleted deletePidFile(), cosmetics
176 * Revision 1.27 2002/03/04 02:08:01 david__schmidt
177 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
179 * Revision 1.26 2002/01/09 19:05:45 steudten
180 * Fix big memory leak.
182 * Revision 1.25 2002/01/09 14:32:08 oes
183 * Added support for gmtime_r and localtime_r.
185 * Revision 1.24 2001/12/30 14:07:32 steudten
186 * - Add signal handling (unix)
187 * - Add SIGHUP handler (unix)
188 * - Add creation of pidfile (unix)
189 * - Add action 'top' in rc file (RH)
190 * - Add entry 'SIGNALS' to manpage
191 * - Add exit message to logfile (unix)
193 * Revision 1.23 2001/11/07 00:02:13 steudten
194 * Add line number in error output for lineparsing for
195 * actionsfile and configfile.
196 * Special handling for CLF added.
198 * Revision 1.22 2001/11/05 23:43:05 steudten
199 * Add time+date to log files.
201 * Revision 1.21 2001/10/25 03:40:47 david__schmidt
202 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
203 * threads to call select() simultaneously. So, it's time to do a real, live,
204 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
205 * (native). Both versions will work, but using __OS2__ offers multi-threading.
207 * Revision 1.20 2001/09/16 23:04:34 jongfoster
210 * Revision 1.19 2001/09/13 20:08:06 jongfoster
211 * Adding support for LOG_LEVEL_CGI
213 * Revision 1.18 2001/09/10 11:27:24 oes
214 * Declaration of w32_socket_strerr now conditional
216 * Revision 1.17 2001/09/10 10:17:13 oes
217 * Removed unused variable; Fixed sprintf format
219 * Revision 1.16 2001/07/30 22:08:36 jongfoster
220 * Tidying up #defines:
221 * - All feature #defines are now of the form FEATURE_xxx
222 * - Permanently turned off WIN_GUI_EDIT
223 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
225 * Revision 1.15 2001/07/29 17:41:10 jongfoster
226 * Now prints thread ID for each message (pthreads only)
228 * Revision 1.14 2001/07/19 19:03:48 haroon
229 * - Added case for LOG_LEVEL_POPUPS
231 * Revision 1.13 2001/07/13 13:58:58 oes
232 * - Added case for LOG_LEVEL_DEANIMATE
233 * - Removed all #ifdef PCRS
235 * Revision 1.12 2001/06/09 10:55:28 jongfoster
236 * Changing BUFSIZ ==> BUFFER_SIZE
238 * Revision 1.11 2001/06/01 18:14:49 jongfoster
239 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
240 * in config.h if appropriate) rather than the NO_STRERR macro.
242 * Revision 1.10 2001/05/29 11:52:21 oes
243 * Conditional compilation of w32_socket_error
245 * Revision 1.9 2001/05/28 16:15:17 jongfoster
246 * Improved reporting of errors under Win32.
248 * Revision 1.8 2001/05/26 17:25:14 jongfoster
249 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
251 * Revision 1.7 2001/05/26 15:21:28 jongfoster
252 * Activity animation in Win32 GUI now works even if debug==0
254 * Revision 1.6 2001/05/25 21:55:08 jongfoster
255 * Now cleans up properly on FATAL (removes taskbar icon etc)
257 * Revision 1.5 2001/05/22 18:46:04 oes
259 * - Enabled filtering banners by size rather than URL
260 * by adding patterns that replace all standard banner
261 * sizes with the "Junkbuster" gif to the re_filterfile
263 * - Enabled filtering WebBugs by providing a pattern
264 * which kills all 1x1 images
266 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
267 * which is selected by the (nonstandard and therefore
268 * capital) letter 'U' in the option string.
269 * It causes the quantifiers to be ungreedy by default.
270 * Appending a ? turns back to greedy (!).
272 * - Added a new interceptor ijb-send-banner, which
273 * sends back the "Junkbuster" gif. Without imagelist or
274 * MSIE detection support, or if tinygif = 1, or the
275 * URL isn't recognized as an imageurl, a lame HTML
276 * explanation is sent instead.
278 * - Added new feature, which permits blocking remote
279 * script redirects and firing back a local redirect
281 * The feature is conditionally compiled, i.e. it
282 * can be disabled with --disable-fast-redirects,
283 * plus it must be activated by a "fast-redirects"
284 * line in the config file, has its own log level
285 * and of course wants to be displayed by show-proxy-args
286 * Note: Boy, all the #ifdefs in 1001 locations and
287 * all the fumbling with configure.in and acconfig.h
288 * were *way* more work than the feature itself :-(
290 * - Because a generic redirect template was needed for
291 * this, tinygif = 3 now uses the same.
293 * - Moved GIFs, and other static HTTP response templates
298 * - Removed some >400 CRs again (Jon, you really worked
301 * Revision 1.4 2001/05/21 19:32:54 jongfoster
302 * Added another #ifdef _WIN_CONSOLE
304 * Revision 1.3 2001/05/20 01:11:40 jongfoster
305 * Added support for LOG_LEVEL_FATAL
306 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
307 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
309 * Revision 1.2 2001/05/17 22:42:01 oes
310 * - Cleaned CRLF's from the sources and related files
311 * - Repaired logging for REF and FRC
313 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
314 * Initial import of version 2.9.3 source tree
317 *********************************************************************/
326 #include "miscutil.h"
328 /* For gettimeofday() */
329 #include <sys/time.h>
331 #if !defined(_WIN32) && !defined(__OS2__)
333 #endif /* !defined(_WIN32) && !defined(__OS2__) */
345 #endif /* ndef _WIN_CONSOLE */
346 #endif /* def _WIN32 */
348 #define inline __inline
349 #endif /* def _MSC_VER */
352 #include <sys/socket.h> /* For sock_errno */
361 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
365 * LOG_LEVEL_FATAL cannot be turned off. (There are
366 * some exceptional situations where we need to get a
367 * message to the user).
369 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
371 /* where to log (default: stderr) */
372 static FILE *logfp = NULL;
374 /* logging detail level. */
375 int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
377 /* static functions */
378 static void fatal_error(const char * error_message);
380 static char *w32_socket_strerr(int errcode, char *tmp_buf);
383 static char *os2_socket_strerr(int errcode, char *tmp_buf);
386 #ifdef FEATURE_PTHREAD
387 static inline void lock_logfile(void)
389 pthread_mutex_lock(&log_mutex);
391 static inline void unlock_logfile(void)
393 pthread_mutex_unlock(&log_mutex);
395 static inline void lock_loginit(void)
397 pthread_mutex_lock(&log_init_mutex);
399 static inline void unlock_loginit(void)
401 pthread_mutex_unlock(&log_init_mutex);
403 #else /* ! FEATURE_PTHREAD */
405 * FIXME we need a cross-platform locking mechanism.
406 * The locking/unlocking functions below should be
407 * fleshed out for non-pthread implementations.
409 static inline void lock_logfile() {}
410 static inline void unlock_logfile() {}
411 static inline void lock_loginit() {}
412 static inline void unlock_loginit() {}
415 /*********************************************************************
417 * Function : fatal_error
419 * Description : Displays a fatal error to standard error (or, on
420 * a WIN32 GUI, to a dialog box), and exits
421 * JunkBuster with status code 1.
424 * 1 : error_message = The error message to display.
426 * Returns : Does not return.
428 *********************************************************************/
429 static void fatal_error(const char * error_message)
431 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
432 MessageBox(g_hwndLogFrame, error_message, "Privoxy Error",
433 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
435 /* Cleanup - remove taskbar icon etc. */
437 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
441 fputs(error_message, logfp);
455 /*********************************************************************
457 * Function : show_version
459 * Description : Logs the Privoxy version and the program name.
462 * 1 : prog_name = The program name.
466 *********************************************************************/
467 static void show_version(const char *prog_name)
469 log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
470 if (prog_name != NULL)
472 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
477 /*********************************************************************
479 * Function : init_log_module
481 * Description : Initializes the logging module to log to stderr.
482 * Can only be called while stderr hasn't been closed
483 * yet and is only supposed to be called once.
486 * 1 : prog_name = The program name.
490 *********************************************************************/
491 void init_log_module(const char *prog_name)
496 set_debug_level(debug);
497 show_version(prog_name);
501 /*********************************************************************
503 * Function : set_debug_level
505 * Description : Sets the debug level to the provided value
506 * plus LOG_LEVEL_MINIMUM.
508 * XXX: we should only use the LOG_LEVEL_MINIMUM
509 * until the frist time the configuration file has
512 * Parameters : 1: debug_level = The debug level to set.
516 *********************************************************************/
517 void set_debug_level(int debug_level)
519 debug = debug_level | LOG_LEVEL_MINIMUM;
523 /*********************************************************************
525 * Function : disable_logging
527 * Description : Disables logging.
533 *********************************************************************/
534 void disable_logging(void)
538 log_error(LOG_LEVEL_INFO, "No logfile configured. Logging disabled.");
547 /*********************************************************************
549 * Function : init_error_log
551 * Description : Initializes the logging module to log to a file.
553 * XXX: should be renamed.
556 * 1 : prog_name = The program name.
557 * 2 : logfname = The logfile name, or NULL for stderr.
558 * 3 : debuglevel = The debugging level.
562 *********************************************************************/
563 void init_error_log(const char *prog_name, const char *logfname)
567 assert(NULL != logfname);
573 log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
576 /* set the designated log file */
577 fp = fopen(logfname, "a");
580 log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
583 /* set logging to be completely unbuffered */
596 * Prevent the Windows GUI from showing the version two
597 * times in a row on startup. It already displayed the show_version()
598 * call from init_log_module() that other systems write to stderr.
600 * This means mingw32 users will never see the version in their
601 * log file, but I assume they wouldn't look for it there anyway
602 * and simply use the "Help/About Privoxy" menu.
604 show_version(prog_name);
605 #endif /* def unix */
609 } /* init_error_log */
612 /*********************************************************************
614 * Function : get_thread_id
616 * Description : Returns a number that is different for each thread.
618 * XXX: Should be moved elsewhere (miscutil.c?)
622 * Returns : thread_id
624 *********************************************************************/
625 static long get_thread_id(void)
627 long this_thread = 1; /* was: pthread_t this_thread;*/
631 APIRET ulrc; /* XXX: I have no clue what this does */
634 /* FIXME get current thread id */
635 #ifdef FEATURE_PTHREAD
636 this_thread = (long)pthread_self();
639 * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
640 * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
641 * pthread_t is supposed to be opaque... but it's fairly random, though, so
642 * we make it mostly presentable.
644 this_thread = abs(this_thread % 1000);
645 #endif /* def __MACH__ */
646 #elif defined(_WIN32)
647 this_thread = GetCurrentThreadId();
648 #elif defined(__OS2__)
649 ulrc = DosGetInfoBlocks(&ptib, NULL);
651 this_thread = ptib -> tib_ptib2 -> tib2_ultid;
652 #endif /* def FEATURE_PTHREAD */
658 /*********************************************************************
660 * Function : get_log_timestamp
662 * Description : Generates the time stamp for the log message prefix.
665 * 1 : buffer = Storage buffer
666 * 2 : buffer_size = Size of storage buffer
668 * Returns : Number of written characters or 0 for error.
670 *********************************************************************/
671 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
676 struct timeval tv_now; /* XXX: stupid name */
678 int msecs_length = 0;
680 gettimeofday(&tv_now, NULL);
681 msecs = tv_now.tv_usec / 1000;
685 #ifdef HAVE_LOCALTIME_R
686 tm_now = *localtime_r(&now, &tm_now);
687 #elif FEATURE_PTHREAD
688 pthread_mutex_lock(&localtime_mutex);
689 tm_now = *localtime(&now);
690 pthread_mutex_unlock(&localtime_mutex);
692 tm_now = *localtime(&now);
695 length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
698 msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
700 if (msecs_length > 0)
702 length += (size_t)msecs_length;
713 /*********************************************************************
715 * Function : get_clf_timestamp
717 * Description : Generates a Common Log Format time string.
720 * 1 : buffer = Storage buffer
721 * 2 : buffer_size = Size of storage buffer
723 * Returns : Number of written characters or 0 for error.
725 *********************************************************************/
726 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
729 * Complex because not all OSs have tm_gmtoff or
730 * the %z field in strftime()
735 #ifdef HAVE_LOCALTIME_R
744 gmt = *gmtime_r(&now, &gmt);
745 #elif FEATURE_PTHREAD
746 pthread_mutex_lock(&gmtime_mutex);
748 pthread_mutex_unlock(&gmtime_mutex);
752 #ifdef HAVE_LOCALTIME_R
753 tm_now = localtime_r(&now, &dummy);
754 #elif FEATURE_PTHREAD
755 pthread_mutex_lock(&localtime_mutex);
756 tm_now = localtime(&now);
757 pthread_mutex_unlock(&localtime_mutex);
759 tm_now = localtime(&now);
761 days = tm_now->tm_yday - gmt.tm_yday;
762 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
763 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
765 length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
769 tz_length = snprintf(buffer+length, buffer_size-length,
770 "%+03d%02d", mins / 60, abs(mins) % 60);
774 length += (size_t)tz_length;
785 /*********************************************************************
787 * Function : get_log_level_string
789 * Description : Translates a numerical loglevel into a string.
792 * 1 : loglevel = LOG_LEVEL_FOO
794 * Returns : Log level string.
796 *********************************************************************/
797 static inline const char *get_log_level_string(int loglevel)
799 char *log_level_string = NULL;
801 assert(0 < loglevel);
805 case LOG_LEVEL_ERROR:
806 log_level_string = "Error";
808 case LOG_LEVEL_FATAL:
809 log_level_string = "Fatal error";
812 log_level_string = "Request";
814 case LOG_LEVEL_CONNECT:
815 log_level_string = "Connect";
818 log_level_string = "Writing";
820 case LOG_LEVEL_HEADER:
821 log_level_string = "Header";
824 log_level_string = "Info";
826 case LOG_LEVEL_RE_FILTER:
827 log_level_string = "Re-Filter";
829 #ifdef FEATURE_FORCE_LOAD
830 case LOG_LEVEL_FORCE:
831 log_level_string = "Force";
833 #endif /* def FEATURE_FORCE_LOAD */
834 #ifdef FEATURE_FAST_REDIRECTS
835 case LOG_LEVEL_REDIRECTS:
836 log_level_string = "Redirect";
838 #endif /* def FEATURE_FAST_REDIRECTS */
839 case LOG_LEVEL_DEANIMATE:
840 log_level_string = "Gif-Deanimate";
842 #ifdef FEATURE_KILL_POPUPS
843 case LOG_LEVEL_POPUPS:
844 log_level_string = "Kill-Popups";
846 #endif /* def FEATURE_KILL_POPUPS */
848 log_level_string = "CGI";
851 log_level_string = "Unknown log level";
854 assert(NULL != log_level_string);
856 return log_level_string;
860 /*********************************************************************
862 * Function : log_error
864 * Description : This is the error-reporting and logging function.
867 * 1 : loglevel = the type of message to be logged
868 * 2 : fmt = the main string we want logged, printf-like
869 * 3 : ... = arguments to be inserted in fmt (printf-like).
873 *********************************************************************/
874 void log_error(int loglevel, const char *fmt, ...)
878 static char *outbuf_save = NULL;
879 char tempbuf[BUFFER_SIZE];
881 const char * src = fmt;
885 * XXX: Make this a config option,
886 * why else do we allocate instead of using
889 size_t log_buffer_size = BUFFER_SIZE;
891 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
893 * Irrespective of debug setting, a GET/POST/CONNECT makes
894 * the taskbar icon animate. (There is an option to disable
895 * this but checking that is handled inside LogShowActivity()).
897 if (loglevel == LOG_LEVEL_GPC)
901 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
904 * verify that the loglevel applies to current
905 * settings and that logging is enabled.
906 * Bail out otherwise.
908 if ((loglevel != LOG_LEVEL_FATAL) &&
909 ((0 == (loglevel & debug)) || (logfp == NULL)))
914 thread_id = get_thread_id();
915 get_log_timestamp(timestamp, sizeof(timestamp));
917 /* protect the whole function because of the static buffer (outbuf) */
920 if (NULL == outbuf_save)
922 outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
923 if (NULL == outbuf_save)
925 snprintf(tempbuf, sizeof(tempbuf),
926 "%s Privoxy(%08lx) Fatal error: log_error() failed to allocate buffer memory.\n"
927 "\nExiting.", timestamp, thread_id);
928 fatal_error(tempbuf); /* Exit */
931 outbuf = outbuf_save;
934 * Memsetting the whole buffer to zero (in theory)
935 * makes things easier later on.
937 memset(outbuf, 0, log_buffer_size);
939 /* Add prefix for everything but Common Log Format messages */
940 if (loglevel != LOG_LEVEL_CLF)
942 length = (size_t)snprintf(outbuf, log_buffer_size, "%s Privoxy(%08lx) %s: ",
943 timestamp, thread_id, get_log_level_string(loglevel));
946 /* get ready to scan var. args. */
949 /* build formatted message from fmt and var-args */
950 while ((*src) && (length < log_buffer_size-2))
952 const char *sval = NULL; /* %N string */
953 int ival; /* %N string length or an error code */
954 unsigned uval; /* %u value */
955 long lval; /* %l value */
956 unsigned long ulval; /* %ul value */
958 const char *format_string = tempbuf;
963 outbuf[length++] = ch;
965 * XXX: Only necessary on platforms which don't use pthread
966 * mutexes (mingw32 for example), where multiple threads can
967 * write to the buffer at the same time.
969 outbuf[length] = '\0';
972 outbuf[length] = '\0';
980 ival = va_arg( ap, int );
981 snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
984 uval = va_arg( ap, unsigned );
985 snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
988 /* this is a modifier that must be followed by u or d */
992 lval = va_arg( ap, long );
993 snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
997 ulval = va_arg( ap, unsigned long );
998 snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
1002 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1003 loglevel = LOG_LEVEL_FATAL;
1008 * Note that char paramaters are converted to int, so we need to
1009 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
1011 tempbuf[0] = (char) va_arg(ap, int);
1015 format_string = va_arg(ap, char *);
1016 if (format_string == NULL)
1018 format_string = "[null]";
1023 * Non-standard: Print a counted unterminated string.
1024 * Takes 2 parameters: int length, const char * string.
1026 ival = va_arg(ap, int);
1027 sval = va_arg(ap, char *);
1030 format_string = "[null]";
1036 /* That's ok (but stupid) */
1042 * That's not ok (and even more stupid)
1045 format_string = "[counted string lenght < 0]";
1048 else if (ival >= sizeof(tempbuf))
1051 * String is too long, copy as much as possible.
1052 * It will be further truncated later.
1054 memcpy(tempbuf, sval, sizeof(tempbuf)-1);
1055 tempbuf[sizeof(tempbuf)-1] = '\0';
1059 memcpy(tempbuf, sval, (size_t) ival);
1060 tempbuf[ival] = '\0';
1064 /* Non-standard: Print error code from errno */
1066 ival = WSAGetLastError();
1067 format_string = w32_socket_strerr(ival, tempbuf);
1069 ival = sock_errno();
1072 format_string = os2_socket_strerr(ival, tempbuf);
1077 format_string = strerror(ival);
1079 #else /* ifndef _WIN32 */
1081 #ifdef HAVE_STRERROR
1082 format_string = strerror(ival);
1083 #else /* ifndef HAVE_STRERROR */
1084 format_string = NULL;
1085 #endif /* ndef HAVE_STRERROR */
1088 snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
1090 #endif /* ndef _WIN32 */
1093 /* Non-standard: Print a Common Log File timestamp */
1094 get_clf_timestamp(tempbuf, sizeof(tempbuf));
1097 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1098 loglevel = LOG_LEVEL_FATAL;
1102 assert(length < log_buffer_size);
1103 length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
1105 if (length >= log_buffer_size-2)
1107 static char warning[] = "... [too long, truncated]";
1109 length = log_buffer_size - sizeof(warning) - 1;
1110 length += strlcpy(outbuf + length, warning, log_buffer_size - length);
1111 assert(length < log_buffer_size);
1115 } /* for( p ... ) */
1117 /* done with var. args */
1120 assert(length < log_buffer_size);
1121 length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
1123 /* Some sanity checks */
1124 if (!(length < log_buffer_size)
1125 || !(outbuf[log_buffer_size-1] == '\0')
1126 || !(outbuf[log_buffer_size] == '\0')
1129 /* Repeat as assertions */
1130 assert(length < log_buffer_size);
1131 assert(outbuf[log_buffer_size-1] == '\0');
1133 * outbuf's real size is log_buffer_size+1,
1134 * so while this looks like an off-by-one,
1135 * we're only checking our paranoia byte.
1137 assert(outbuf[log_buffer_size] == '\0');
1139 snprintf(outbuf, log_buffer_size,
1140 "%s Privoxy(%08lx) Fatal error: log_error()'s sanity checks failed. length: %d\n"
1141 "Exiting.", timestamp, thread_id, (int)length);
1142 loglevel = LOG_LEVEL_FATAL;
1145 assert(NULL != logfp || loglevel == LOG_LEVEL_FATAL);
1147 if (loglevel == LOG_LEVEL_FATAL)
1149 fatal_error(outbuf_save);
1150 /* Never get here */
1152 fputs(outbuf_save, logfp);
1156 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1157 /* Write to display */
1158 LogPutString(outbuf_save);
1159 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1164 /*********************************************************************
1166 * Function : jb_err_to_string
1168 * Description : Translates JB_ERR_FOO codes into strings.
1170 * XXX: the type of error codes is jb_err
1171 * but the typedef'inition is currently not
1172 * visible to all files that include errlog.h.
1175 * 1 : error = a valid jb_err code
1177 * Returns : A string with the jb_err translation
1179 *********************************************************************/
1180 const char *jb_err_to_string(int error)
1185 return "Success, no error";
1187 return "Out of memory";
1188 case JB_ERR_CGI_PARAMS:
1189 return "Missing or corrupt CGI parameters";
1191 return "Error opening, reading or writing a file";
1193 return "Parse error";
1194 case JB_ERR_MODIFIED:
1195 return "File has been modified outside of the CGI actions editor.";
1196 case JB_ERR_COMPRESS:
1197 return "(De)compression failure";
1200 return "Unknown error";
1203 return "Internal error";
1207 /*********************************************************************
1209 * Function : w32_socket_strerr
1211 * Description : Translate the return value from WSAGetLastError()
1215 * 1 : errcode = The return value from WSAGetLastError().
1216 * 2 : tmp_buf = A temporary buffer that might be used to
1219 * Returns : String representing the error code. This may be
1220 * a global string constant or a string stored in
1223 *********************************************************************/
1224 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1226 #define TEXT_FOR_ERROR(code,text) \
1227 if (errcode == code) \
1229 return #code " - " text; \
1232 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1233 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1234 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1235 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1236 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1237 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1238 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1239 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1240 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1241 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1242 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1243 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1244 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1245 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1246 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1247 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1248 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1249 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1250 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1251 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1252 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1253 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1254 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1255 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1256 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1257 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1258 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1259 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1260 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1261 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1262 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1263 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1264 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1265 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1266 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1267 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1268 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1269 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1270 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1271 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1272 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1273 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1275 * The following error codes are documented in the Microsoft WinSock
1276 * reference guide, but don't actually exist.
1278 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1279 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1280 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1281 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1282 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1283 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1284 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1285 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1286 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1287 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1290 sprintf(tmp_buf, "(error number %d)", errcode);
1293 #endif /* def _WIN32 */
1297 /*********************************************************************
1299 * Function : os2_socket_strerr
1301 * Description : Translate the return value from sock_errno()
1305 * 1 : errcode = The return value from sock_errno().
1306 * 2 : tmp_buf = A temporary buffer that might be used to
1309 * Returns : String representing the error code. This may be
1310 * a global string constant or a string stored in
1313 *********************************************************************/
1314 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1316 #define TEXT_FOR_ERROR(code,text) \
1317 if (errcode == code) \
1319 return #code " - " text; \
1322 TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
1323 TEXT_FOR_ERROR(SOCESRCH , "No such process.")
1324 TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
1325 TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
1326 TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
1327 TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
1328 TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
1329 TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
1330 TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
1331 TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
1332 TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
1333 TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
1334 TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
1335 TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
1336 TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
1337 TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
1338 TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
1339 TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
1340 TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1341 TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1342 TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
1343 TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
1344 TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
1345 TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
1346 TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
1347 TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
1348 TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
1349 TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
1350 TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
1351 TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
1352 TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
1353 TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
1354 TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
1355 TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
1356 TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
1357 TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
1358 TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
1359 TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
1360 TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
1361 TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
1362 TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
1363 TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
1364 TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
1366 sprintf(tmp_buf, "(error number %d)", errcode);
1369 #endif /* def __OS2__ */