1 const char errlog_rcs[] = "$Id: errlog.c,v 1.63 2007/12/15 19:49:32 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.63 2007/12/15 19:49:32 fabiankeil
37 * Stop overloading logfile to control the mingw32 log window as well.
38 * It's no longer necessary now that we disable all debug lines by default
39 * and at least one user perceived it as a regression (added in 1.55).
41 * Revision 1.62 2007/11/30 15:33:46 fabiankeil
42 * Unbreak LOG_LEVEL_FATAL. It wasn't fatal with logging disabled
43 * and on mingw32 fatal log messages didn't end up in the log file.
45 * Revision 1.61 2007/11/04 19:03:01 fabiankeil
46 * Fix another deadlock Hal spotted and that mysteriously didn't affect FreeBSD.
48 * Revision 1.60 2007/11/03 19:03:31 fabiankeil
49 * - Prevent the Windows GUI from showing the version two times in a row.
50 * - Stop using the imperative in the "(Re-)Open logfile" message.
51 * - Ditch the "Switching to daemon mode" message as the detection
52 * whether or not we're already in daemon mode doesn't actually work.
54 * Revision 1.59 2007/11/01 12:50:56 fabiankeil
55 * Here's looking at you, deadlock.
57 * Revision 1.58 2007/10/28 19:04:21 fabiankeil
58 * Don't mention daemon mode in "Logging disabled" message. Some
59 * platforms call it differently and it's not really relevant anyway.
61 * Revision 1.57 2007/10/27 13:02:26 fabiankeil
62 * Relocate daemon-mode-related log messages to make sure
63 * they aren't shown again in case of configuration reloads.
65 * Revision 1.56 2007/10/14 14:26:56 fabiankeil
66 * Remove the old log_error() version.
68 * Revision 1.55 2007/10/14 14:12:41 fabiankeil
69 * When in daemon mode, close stderr after the configuration file has been
70 * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
72 * Revision 1.54 2007/09/22 16:15:34 fabiankeil
73 * - Let it compile with pcc.
74 * - Move our includes below system includes to prevent macro conflicts.
76 * Revision 1.53 2007/08/05 13:53:14 fabiankeil
77 * #1763173 from Stefan Huehner: declare some more functions
78 * static and use void instead of empty parameter lists.
80 * Revision 1.52 2007/07/14 07:28:47 fabiankeil
81 * Add translation function for JB_ERR_FOO codes.
83 * Revision 1.51 2007/05/11 11:51:34 fabiankeil
84 * Fix a type mismatch warning.
86 * Revision 1.50 2007/04/11 10:55:44 fabiankeil
87 * Enforce some assertions that could be triggered
88 * on mingw32 and other systems where we use threads
91 * Revision 1.49 2007/04/08 16:44:15 fabiankeil
92 * We need <sys/time.h> for gettimeofday(), not <time.h>.
94 * Revision 1.48 2007/03/31 13:33:28 fabiankeil
95 * Add alternative log_error() with timestamps
96 * that contain milliseconds and without using
97 * strcpy(), strcat() or sprintf().
99 * Revision 1.47 2006/11/28 15:25:15 fabiankeil
100 * Only unlink the pidfile if it's actually used.
102 * Revision 1.46 2006/11/13 19:05:51 fabiankeil
103 * Make pthread mutex locking more generic. Instead of
104 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
105 * and use mutex locking unless there is an _r function
106 * available. Better safe than sorry.
108 * Fixes "./configure --disable-pthread" and should result
109 * in less threading-related problems on pthread-using platforms,
110 * but it still doesn't fix BR#1122404.
112 * Revision 1.45 2006/08/21 11:15:54 david__schmidt
113 * MS Visual C++ build updates
115 * Revision 1.44 2006/08/18 16:03:16 david__schmidt
116 * Tweak for OS/2 build happiness.
118 * Revision 1.43 2006/08/03 02:46:41 david__schmidt
119 * Incorporate Fabian Keil's patch work:
120 * http://www.fabiankeil.de/sourcecode/privoxy/
122 * Revision 1.42 2006/07/18 14:48:46 david__schmidt
123 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
124 * with what was really the latest development (the v_3_0_branch branch)
126 * Revision 1.40.2.4 2005/04/03 20:10:50 david__schmidt
127 * Thanks to Jindrich Makovicka for a race condition fix for the log
128 * file. The race condition remains for non-pthread implementations.
129 * Reference patch #1175720.
131 * Revision 1.40.2.3 2003/03/07 03:41:04 david__schmidt
132 * Wrapping all *_r functions (the non-_r versions of them) with mutex
133 * semaphores for OSX. Hopefully this will take care of all of those pesky
136 * Revision 1.40.2.2 2002/09/28 00:30:57 david__schmidt
137 * Update error logging to give sane values for thread IDs on Mach kernels.
138 * It's still a hack, but at least it looks farily normal. We print the
139 * absolute value of the first 4 bytes of the pthread_t modded with 1000.
141 * Revision 1.40.2.1 2002/09/25 12:47:42 oes
142 * Make log_error safe against NULL string arguments
144 * Revision 1.40 2002/05/22 01:27:27 david__schmidt
146 * Add os2_socket_strerr mirroring w32_socket_strerr.
148 * Revision 1.39 2002/04/03 17:15:27 gliptak
149 * zero padding thread ids in log
151 * Revision 1.38 2002/03/31 17:18:59 jongfoster
152 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
154 * Revision 1.37 2002/03/27 14:32:43 david__schmidt
155 * More compiler warning message maintenance
157 * Revision 1.36 2002/03/26 22:29:54 swa
158 * we have a new homepage!
160 * Revision 1.35 2002/03/24 15:23:33 jongfoster
163 * Revision 1.34 2002/03/24 13:25:43 swa
164 * name change related issues
166 * Revision 1.33 2002/03/13 00:27:04 jongfoster
169 * Revision 1.32 2002/03/07 03:46:17 oes
170 * Fixed compiler warnings
172 * Revision 1.31 2002/03/06 23:02:57 jongfoster
175 * Revision 1.30 2002/03/05 22:43:45 david__schmidt
176 * - Better error reporting on OS/2
177 * - Fix double-slash comment (oops)
179 * Revision 1.29 2002/03/04 23:45:13 jongfoster
180 * Printing thread ID if using Win32 native threads
182 * Revision 1.28 2002/03/04 17:59:59 oes
183 * Deleted deletePidFile(), cosmetics
185 * Revision 1.27 2002/03/04 02:08:01 david__schmidt
186 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
188 * Revision 1.26 2002/01/09 19:05:45 steudten
189 * Fix big memory leak.
191 * Revision 1.25 2002/01/09 14:32:08 oes
192 * Added support for gmtime_r and localtime_r.
194 * Revision 1.24 2001/12/30 14:07:32 steudten
195 * - Add signal handling (unix)
196 * - Add SIGHUP handler (unix)
197 * - Add creation of pidfile (unix)
198 * - Add action 'top' in rc file (RH)
199 * - Add entry 'SIGNALS' to manpage
200 * - Add exit message to logfile (unix)
202 * Revision 1.23 2001/11/07 00:02:13 steudten
203 * Add line number in error output for lineparsing for
204 * actionsfile and configfile.
205 * Special handling for CLF added.
207 * Revision 1.22 2001/11/05 23:43:05 steudten
208 * Add time+date to log files.
210 * Revision 1.21 2001/10/25 03:40:47 david__schmidt
211 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
212 * threads to call select() simultaneously. So, it's time to do a real, live,
213 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
214 * (native). Both versions will work, but using __OS2__ offers multi-threading.
216 * Revision 1.20 2001/09/16 23:04:34 jongfoster
219 * Revision 1.19 2001/09/13 20:08:06 jongfoster
220 * Adding support for LOG_LEVEL_CGI
222 * Revision 1.18 2001/09/10 11:27:24 oes
223 * Declaration of w32_socket_strerr now conditional
225 * Revision 1.17 2001/09/10 10:17:13 oes
226 * Removed unused variable; Fixed sprintf format
228 * Revision 1.16 2001/07/30 22:08:36 jongfoster
229 * Tidying up #defines:
230 * - All feature #defines are now of the form FEATURE_xxx
231 * - Permanently turned off WIN_GUI_EDIT
232 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
234 * Revision 1.15 2001/07/29 17:41:10 jongfoster
235 * Now prints thread ID for each message (pthreads only)
237 * Revision 1.14 2001/07/19 19:03:48 haroon
238 * - Added case for LOG_LEVEL_POPUPS
240 * Revision 1.13 2001/07/13 13:58:58 oes
241 * - Added case for LOG_LEVEL_DEANIMATE
242 * - Removed all #ifdef PCRS
244 * Revision 1.12 2001/06/09 10:55:28 jongfoster
245 * Changing BUFSIZ ==> BUFFER_SIZE
247 * Revision 1.11 2001/06/01 18:14:49 jongfoster
248 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
249 * in config.h if appropriate) rather than the NO_STRERR macro.
251 * Revision 1.10 2001/05/29 11:52:21 oes
252 * Conditional compilation of w32_socket_error
254 * Revision 1.9 2001/05/28 16:15:17 jongfoster
255 * Improved reporting of errors under Win32.
257 * Revision 1.8 2001/05/26 17:25:14 jongfoster
258 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
260 * Revision 1.7 2001/05/26 15:21:28 jongfoster
261 * Activity animation in Win32 GUI now works even if debug==0
263 * Revision 1.6 2001/05/25 21:55:08 jongfoster
264 * Now cleans up properly on FATAL (removes taskbar icon etc)
266 * Revision 1.5 2001/05/22 18:46:04 oes
268 * - Enabled filtering banners by size rather than URL
269 * by adding patterns that replace all standard banner
270 * sizes with the "Junkbuster" gif to the re_filterfile
272 * - Enabled filtering WebBugs by providing a pattern
273 * which kills all 1x1 images
275 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
276 * which is selected by the (nonstandard and therefore
277 * capital) letter 'U' in the option string.
278 * It causes the quantifiers to be ungreedy by default.
279 * Appending a ? turns back to greedy (!).
281 * - Added a new interceptor ijb-send-banner, which
282 * sends back the "Junkbuster" gif. Without imagelist or
283 * MSIE detection support, or if tinygif = 1, or the
284 * URL isn't recognized as an imageurl, a lame HTML
285 * explanation is sent instead.
287 * - Added new feature, which permits blocking remote
288 * script redirects and firing back a local redirect
290 * The feature is conditionally compiled, i.e. it
291 * can be disabled with --disable-fast-redirects,
292 * plus it must be activated by a "fast-redirects"
293 * line in the config file, has its own log level
294 * and of course wants to be displayed by show-proxy-args
295 * Note: Boy, all the #ifdefs in 1001 locations and
296 * all the fumbling with configure.in and acconfig.h
297 * were *way* more work than the feature itself :-(
299 * - Because a generic redirect template was needed for
300 * this, tinygif = 3 now uses the same.
302 * - Moved GIFs, and other static HTTP response templates
307 * - Removed some >400 CRs again (Jon, you really worked
310 * Revision 1.4 2001/05/21 19:32:54 jongfoster
311 * Added another #ifdef _WIN_CONSOLE
313 * Revision 1.3 2001/05/20 01:11:40 jongfoster
314 * Added support for LOG_LEVEL_FATAL
315 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
316 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
318 * Revision 1.2 2001/05/17 22:42:01 oes
319 * - Cleaned CRLF's from the sources and related files
320 * - Repaired logging for REF and FRC
322 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
323 * Initial import of version 2.9.3 source tree
326 *********************************************************************/
335 #include "miscutil.h"
337 /* For gettimeofday() */
338 #include <sys/time.h>
340 #if !defined(_WIN32) && !defined(__OS2__)
342 #endif /* !defined(_WIN32) && !defined(__OS2__) */
354 #endif /* ndef _WIN_CONSOLE */
355 #endif /* def _WIN32 */
357 #define inline __inline
358 #endif /* def _MSC_VER */
361 #include <sys/socket.h> /* For sock_errno */
370 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
374 * LOG_LEVEL_FATAL cannot be turned off. (There are
375 * some exceptional situations where we need to get a
376 * message to the user).
378 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
380 /* where to log (default: stderr) */
381 static FILE *logfp = NULL;
383 /* logging detail level. */
384 int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
386 /* static functions */
387 static void fatal_error(const char * error_message);
389 static char *w32_socket_strerr(int errcode, char *tmp_buf);
392 static char *os2_socket_strerr(int errcode, char *tmp_buf);
395 #ifdef FEATURE_PTHREAD
396 static inline void lock_logfile(void)
398 pthread_mutex_lock(&log_mutex);
400 static inline void unlock_logfile(void)
402 pthread_mutex_unlock(&log_mutex);
404 static inline void lock_loginit(void)
406 pthread_mutex_lock(&log_init_mutex);
408 static inline void unlock_loginit(void)
410 pthread_mutex_unlock(&log_init_mutex);
412 #else /* ! FEATURE_PTHREAD */
414 * FIXME we need a cross-platform locking mechanism.
415 * The locking/unlocking functions below should be
416 * fleshed out for non-pthread implementations.
418 static inline void lock_logfile() {}
419 static inline void unlock_logfile() {}
420 static inline void lock_loginit() {}
421 static inline void unlock_loginit() {}
424 /*********************************************************************
426 * Function : fatal_error
428 * Description : Displays a fatal error to standard error (or, on
429 * a WIN32 GUI, to a dialog box), and exits
430 * JunkBuster with status code 1.
433 * 1 : error_message = The error message to display.
435 * Returns : Does not return.
437 *********************************************************************/
438 static void fatal_error(const char * error_message)
440 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
441 MessageBox(g_hwndLogFrame, error_message, "Privoxy Error",
442 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
444 /* Cleanup - remove taskbar icon etc. */
446 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
450 fputs(error_message, logfp);
464 /*********************************************************************
466 * Function : show_version
468 * Description : Logs the Privoxy version and the program name.
471 * 1 : prog_name = The program name.
475 *********************************************************************/
476 static void show_version(const char *prog_name)
478 log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
479 if (prog_name != NULL)
481 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
486 /*********************************************************************
488 * Function : init_log_module
490 * Description : Initializes the logging module to log to stderr.
491 * Can only be called while stderr hasn't been closed
492 * yet and is only supposed to be called once.
495 * 1 : prog_name = The program name.
499 *********************************************************************/
500 void init_log_module(const char *prog_name)
505 set_debug_level(debug);
506 show_version(prog_name);
510 /*********************************************************************
512 * Function : set_debug_level
514 * Description : Sets the debug level to the provided value
515 * plus LOG_LEVEL_MINIMUM.
517 * XXX: we should only use the LOG_LEVEL_MINIMUM
518 * until the frist time the configuration file has
521 * Parameters : 1: debug_level = The debug level to set.
525 *********************************************************************/
526 void set_debug_level(int debug_level)
528 debug = debug_level | LOG_LEVEL_MINIMUM;
532 /*********************************************************************
534 * Function : disable_logging
536 * Description : Disables logging.
542 *********************************************************************/
543 void disable_logging(void)
547 log_error(LOG_LEVEL_INFO,
548 "No logfile configured. Please enable it before reporting any problems.");
557 /*********************************************************************
559 * Function : init_error_log
561 * Description : Initializes the logging module to log to a file.
563 * XXX: should be renamed.
566 * 1 : prog_name = The program name.
567 * 2 : logfname = The logfile name, or NULL for stderr.
568 * 3 : debuglevel = The debugging level.
572 *********************************************************************/
573 void init_error_log(const char *prog_name, const char *logfname)
577 assert(NULL != logfname);
583 log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
586 /* set the designated log file */
587 fp = fopen(logfname, "a");
590 log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
593 /* set logging to be completely unbuffered */
606 * Prevent the Windows GUI from showing the version two
607 * times in a row on startup. It already displayed the show_version()
608 * call from init_log_module() that other systems write to stderr.
610 * This means mingw32 users will never see the version in their
611 * log file, but I assume they wouldn't look for it there anyway
612 * and simply use the "Help/About Privoxy" menu.
614 show_version(prog_name);
615 #endif /* def unix */
619 } /* init_error_log */
622 /*********************************************************************
624 * Function : get_thread_id
626 * Description : Returns a number that is different for each thread.
628 * XXX: Should be moved elsewhere (miscutil.c?)
632 * Returns : thread_id
634 *********************************************************************/
635 static long get_thread_id(void)
637 long this_thread = 1; /* was: pthread_t this_thread;*/
641 APIRET ulrc; /* XXX: I have no clue what this does */
644 /* FIXME get current thread id */
645 #ifdef FEATURE_PTHREAD
646 this_thread = (long)pthread_self();
649 * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
650 * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
651 * pthread_t is supposed to be opaque... but it's fairly random, though, so
652 * we make it mostly presentable.
654 this_thread = abs(this_thread % 1000);
655 #endif /* def __MACH__ */
656 #elif defined(_WIN32)
657 this_thread = GetCurrentThreadId();
658 #elif defined(__OS2__)
659 ulrc = DosGetInfoBlocks(&ptib, NULL);
661 this_thread = ptib -> tib_ptib2 -> tib2_ultid;
662 #endif /* def FEATURE_PTHREAD */
668 /*********************************************************************
670 * Function : get_log_timestamp
672 * Description : Generates the time stamp for the log message prefix.
675 * 1 : buffer = Storage buffer
676 * 2 : buffer_size = Size of storage buffer
678 * Returns : Number of written characters or 0 for error.
680 *********************************************************************/
681 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
686 struct timeval tv_now; /* XXX: stupid name */
688 int msecs_length = 0;
690 gettimeofday(&tv_now, NULL);
691 msecs = tv_now.tv_usec / 1000;
695 #ifdef HAVE_LOCALTIME_R
696 tm_now = *localtime_r(&now, &tm_now);
697 #elif FEATURE_PTHREAD
698 pthread_mutex_lock(&localtime_mutex);
699 tm_now = *localtime(&now);
700 pthread_mutex_unlock(&localtime_mutex);
702 tm_now = *localtime(&now);
705 length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
708 msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
710 if (msecs_length > 0)
712 length += (size_t)msecs_length;
723 /*********************************************************************
725 * Function : get_clf_timestamp
727 * Description : Generates a Common Log Format time string.
730 * 1 : buffer = Storage buffer
731 * 2 : buffer_size = Size of storage buffer
733 * Returns : Number of written characters or 0 for error.
735 *********************************************************************/
736 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
739 * Complex because not all OSs have tm_gmtoff or
740 * the %z field in strftime()
745 #ifdef HAVE_LOCALTIME_R
754 gmt = *gmtime_r(&now, &gmt);
755 #elif FEATURE_PTHREAD
756 pthread_mutex_lock(&gmtime_mutex);
758 pthread_mutex_unlock(&gmtime_mutex);
762 #ifdef HAVE_LOCALTIME_R
763 tm_now = localtime_r(&now, &dummy);
764 #elif FEATURE_PTHREAD
765 pthread_mutex_lock(&localtime_mutex);
766 tm_now = localtime(&now);
767 pthread_mutex_unlock(&localtime_mutex);
769 tm_now = localtime(&now);
771 days = tm_now->tm_yday - gmt.tm_yday;
772 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
773 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
775 length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
779 tz_length = snprintf(buffer+length, buffer_size-length,
780 "%+03d%02d", mins / 60, abs(mins) % 60);
784 length += (size_t)tz_length;
795 /*********************************************************************
797 * Function : get_log_level_string
799 * Description : Translates a numerical loglevel into a string.
802 * 1 : loglevel = LOG_LEVEL_FOO
804 * Returns : Log level string.
806 *********************************************************************/
807 static inline const char *get_log_level_string(int loglevel)
809 char *log_level_string = NULL;
811 assert(0 < loglevel);
815 case LOG_LEVEL_ERROR:
816 log_level_string = "Error";
818 case LOG_LEVEL_FATAL:
819 log_level_string = "Fatal error";
822 log_level_string = "Request";
824 case LOG_LEVEL_CONNECT:
825 log_level_string = "Connect";
828 log_level_string = "Writing";
830 case LOG_LEVEL_HEADER:
831 log_level_string = "Header";
834 log_level_string = "Info";
836 case LOG_LEVEL_RE_FILTER:
837 log_level_string = "Re-Filter";
839 #ifdef FEATURE_FORCE_LOAD
840 case LOG_LEVEL_FORCE:
841 log_level_string = "Force";
843 #endif /* def FEATURE_FORCE_LOAD */
844 #ifdef FEATURE_FAST_REDIRECTS
845 case LOG_LEVEL_REDIRECTS:
846 log_level_string = "Redirect";
848 #endif /* def FEATURE_FAST_REDIRECTS */
849 case LOG_LEVEL_DEANIMATE:
850 log_level_string = "Gif-Deanimate";
852 #ifdef FEATURE_KILL_POPUPS
853 case LOG_LEVEL_POPUPS:
854 log_level_string = "Kill-Popups";
856 #endif /* def FEATURE_KILL_POPUPS */
858 log_level_string = "CGI";
861 log_level_string = "Unknown log level";
864 assert(NULL != log_level_string);
866 return log_level_string;
870 /*********************************************************************
872 * Function : log_error
874 * Description : This is the error-reporting and logging function.
877 * 1 : loglevel = the type of message to be logged
878 * 2 : fmt = the main string we want logged, printf-like
879 * 3 : ... = arguments to be inserted in fmt (printf-like).
883 *********************************************************************/
884 void log_error(int loglevel, const char *fmt, ...)
888 static char *outbuf_save = NULL;
889 char tempbuf[BUFFER_SIZE];
891 const char * src = fmt;
895 * XXX: Make this a config option,
896 * why else do we allocate instead of using
899 size_t log_buffer_size = BUFFER_SIZE;
901 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
903 * Irrespective of debug setting, a GET/POST/CONNECT makes
904 * the taskbar icon animate. (There is an option to disable
905 * this but checking that is handled inside LogShowActivity()).
907 if (loglevel == LOG_LEVEL_GPC)
911 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
914 * verify that the loglevel applies to current
915 * settings and that logging is enabled.
916 * Bail out otherwise.
918 if ((0 == (loglevel & debug))
927 thread_id = get_thread_id();
928 get_log_timestamp(timestamp, sizeof(timestamp));
930 /* protect the whole function because of the static buffer (outbuf) */
933 if (NULL == outbuf_save)
935 outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
936 if (NULL == outbuf_save)
938 snprintf(tempbuf, sizeof(tempbuf),
939 "%s Privoxy(%08lx) Fatal error: log_error() failed to allocate buffer memory.\n"
940 "\nExiting.", timestamp, thread_id);
941 fatal_error(tempbuf); /* Exit */
944 outbuf = outbuf_save;
947 * Memsetting the whole buffer to zero (in theory)
948 * makes things easier later on.
950 memset(outbuf, 0, log_buffer_size);
952 /* Add prefix for everything but Common Log Format messages */
953 if (loglevel != LOG_LEVEL_CLF)
955 length = (size_t)snprintf(outbuf, log_buffer_size, "%s Privoxy(%08lx) %s: ",
956 timestamp, thread_id, get_log_level_string(loglevel));
959 /* get ready to scan var. args. */
962 /* build formatted message from fmt and var-args */
963 while ((*src) && (length < log_buffer_size-2))
965 const char *sval = NULL; /* %N string */
966 int ival; /* %N string length or an error code */
967 unsigned uval; /* %u value */
968 long lval; /* %l value */
969 unsigned long ulval; /* %ul value */
971 const char *format_string = tempbuf;
976 outbuf[length++] = ch;
978 * XXX: Only necessary on platforms which don't use pthread
979 * mutexes (mingw32 for example), where multiple threads can
980 * write to the buffer at the same time.
982 outbuf[length] = '\0';
985 outbuf[length] = '\0';
993 ival = va_arg( ap, int );
994 snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
997 uval = va_arg( ap, unsigned );
998 snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
1001 /* this is a modifier that must be followed by u or d */
1005 lval = va_arg( ap, long );
1006 snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
1010 ulval = va_arg( ap, unsigned long );
1011 snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
1015 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1016 loglevel = LOG_LEVEL_FATAL;
1021 * Note that char paramaters are converted to int, so we need to
1022 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
1024 tempbuf[0] = (char) va_arg(ap, int);
1028 format_string = va_arg(ap, char *);
1029 if (format_string == NULL)
1031 format_string = "[null]";
1036 * Non-standard: Print a counted unterminated string.
1037 * Takes 2 parameters: int length, const char * string.
1039 ival = va_arg(ap, int);
1040 sval = va_arg(ap, char *);
1043 format_string = "[null]";
1049 /* That's ok (but stupid) */
1055 * That's not ok (and even more stupid)
1058 format_string = "[counted string lenght < 0]";
1061 else if (ival >= sizeof(tempbuf))
1064 * String is too long, copy as much as possible.
1065 * It will be further truncated later.
1067 memcpy(tempbuf, sval, sizeof(tempbuf)-1);
1068 tempbuf[sizeof(tempbuf)-1] = '\0';
1072 memcpy(tempbuf, sval, (size_t) ival);
1073 tempbuf[ival] = '\0';
1077 /* Non-standard: Print error code from errno */
1079 ival = WSAGetLastError();
1080 format_string = w32_socket_strerr(ival, tempbuf);
1082 ival = sock_errno();
1085 format_string = os2_socket_strerr(ival, tempbuf);
1090 format_string = strerror(ival);
1092 #else /* ifndef _WIN32 */
1094 #ifdef HAVE_STRERROR
1095 format_string = strerror(ival);
1096 #else /* ifndef HAVE_STRERROR */
1097 format_string = NULL;
1098 #endif /* ndef HAVE_STRERROR */
1101 snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
1103 #endif /* ndef _WIN32 */
1106 /* Non-standard: Print a Common Log File timestamp */
1107 get_clf_timestamp(tempbuf, sizeof(tempbuf));
1110 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1111 loglevel = LOG_LEVEL_FATAL;
1115 assert(length < log_buffer_size);
1116 length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
1118 if (length >= log_buffer_size-2)
1120 static char warning[] = "... [too long, truncated]";
1122 length = log_buffer_size - sizeof(warning) - 1;
1123 length += strlcpy(outbuf + length, warning, log_buffer_size - length);
1124 assert(length < log_buffer_size);
1128 } /* for( p ... ) */
1130 /* done with var. args */
1133 assert(length < log_buffer_size);
1134 length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
1136 /* Some sanity checks */
1137 if (!(length < log_buffer_size)
1138 || !(outbuf[log_buffer_size-1] == '\0')
1139 || !(outbuf[log_buffer_size] == '\0')
1142 /* Repeat as assertions */
1143 assert(length < log_buffer_size);
1144 assert(outbuf[log_buffer_size-1] == '\0');
1146 * outbuf's real size is log_buffer_size+1,
1147 * so while this looks like an off-by-one,
1148 * we're only checking our paranoia byte.
1150 assert(outbuf[log_buffer_size] == '\0');
1152 snprintf(outbuf, log_buffer_size,
1153 "%s Privoxy(%08lx) Fatal error: log_error()'s sanity checks failed. length: %d\n"
1154 "Exiting.", timestamp, thread_id, (int)length);
1155 loglevel = LOG_LEVEL_FATAL;
1159 assert(loglevel & debug);
1163 (loglevel & debug));
1166 if (loglevel == LOG_LEVEL_FATAL)
1168 fatal_error(outbuf_save);
1169 /* Never get here */
1173 fputs(outbuf_save, logfp);
1177 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1178 /* Write to display */
1179 LogPutString(outbuf_save);
1180 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1185 /*********************************************************************
1187 * Function : jb_err_to_string
1189 * Description : Translates JB_ERR_FOO codes into strings.
1191 * XXX: the type of error codes is jb_err
1192 * but the typedef'inition is currently not
1193 * visible to all files that include errlog.h.
1196 * 1 : error = a valid jb_err code
1198 * Returns : A string with the jb_err translation
1200 *********************************************************************/
1201 const char *jb_err_to_string(int error)
1206 return "Success, no error";
1208 return "Out of memory";
1209 case JB_ERR_CGI_PARAMS:
1210 return "Missing or corrupt CGI parameters";
1212 return "Error opening, reading or writing a file";
1214 return "Parse error";
1215 case JB_ERR_MODIFIED:
1216 return "File has been modified outside of the CGI actions editor.";
1217 case JB_ERR_COMPRESS:
1218 return "(De)compression failure";
1221 return "Unknown error";
1224 return "Internal error";
1228 /*********************************************************************
1230 * Function : w32_socket_strerr
1232 * Description : Translate the return value from WSAGetLastError()
1236 * 1 : errcode = The return value from WSAGetLastError().
1237 * 2 : tmp_buf = A temporary buffer that might be used to
1240 * Returns : String representing the error code. This may be
1241 * a global string constant or a string stored in
1244 *********************************************************************/
1245 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1247 #define TEXT_FOR_ERROR(code,text) \
1248 if (errcode == code) \
1250 return #code " - " text; \
1253 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1254 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1255 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1256 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1257 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1258 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1259 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1260 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1261 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1262 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1263 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1264 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1265 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1266 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1267 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1268 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1269 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1270 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1271 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1272 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1273 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1274 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1275 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1276 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1277 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1278 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1279 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1280 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1281 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1282 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1283 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1284 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1285 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1286 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1287 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1288 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1289 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1290 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1291 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1292 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1293 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1294 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1296 * The following error codes are documented in the Microsoft WinSock
1297 * reference guide, but don't actually exist.
1299 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1300 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1301 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1302 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1303 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1304 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1305 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1306 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1307 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1308 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1311 sprintf(tmp_buf, "(error number %d)", errcode);
1314 #endif /* def _WIN32 */
1318 /*********************************************************************
1320 * Function : os2_socket_strerr
1322 * Description : Translate the return value from sock_errno()
1326 * 1 : errcode = The return value from sock_errno().
1327 * 2 : tmp_buf = A temporary buffer that might be used to
1330 * Returns : String representing the error code. This may be
1331 * a global string constant or a string stored in
1334 *********************************************************************/
1335 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1337 #define TEXT_FOR_ERROR(code,text) \
1338 if (errcode == code) \
1340 return #code " - " text; \
1343 TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
1344 TEXT_FOR_ERROR(SOCESRCH , "No such process.")
1345 TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
1346 TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
1347 TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
1348 TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
1349 TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
1350 TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
1351 TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
1352 TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
1353 TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
1354 TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
1355 TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
1356 TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
1357 TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
1358 TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
1359 TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
1360 TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
1361 TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1362 TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1363 TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
1364 TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
1365 TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
1366 TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
1367 TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
1368 TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
1369 TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
1370 TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
1371 TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
1372 TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
1373 TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
1374 TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
1375 TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
1376 TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
1377 TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
1378 TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
1379 TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
1380 TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
1381 TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
1382 TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
1383 TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
1384 TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
1385 TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
1387 sprintf(tmp_buf, "(error number %d)", errcode);
1390 #endif /* def __OS2__ */