1 const char errlog_rcs[] = "$Id: errlog.c,v 1.86 2009/02/09 21:21:15 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-2009 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.86 2009/02/09 21:21:15 fabiankeil
37 * Now that init_log_module() is called earlier, call show_version()
38 * later on from main() directly so it doesn't get called for --help
41 * Revision 1.85 2009/02/06 17:51:38 fabiankeil
42 * Be prepared if I break the log module initialization again.
44 * Revision 1.84 2008/12/14 15:46:22 fabiankeil
45 * Give crunched requests their own log level.
47 * Revision 1.83 2008/12/04 18:14:32 fabiankeil
48 * Fix some cparser warnings.
50 * Revision 1.82 2008/11/23 16:06:58 fabiankeil
51 * Update a log message I missed in 1.80.
53 * Revision 1.81 2008/11/23 15:59:27 fabiankeil
54 * - Update copyright range.
55 * - Remove stray line breaks in a log message
56 * nobody is supposed to see anyway.
58 * Revision 1.80 2008/11/23 15:49:49 fabiankeil
59 * In log_error(), don't surround the thread id with "Privoxy(" and ")".
61 * Revision 1.79 2008/10/20 17:09:25 fabiankeil
62 * Update init_error_log() description to match reality.
64 * Revision 1.78 2008/09/07 16:59:31 fabiankeil
65 * Update a comment to reflect that we
66 * have mutex support on mingw32 now.
68 * Revision 1.77 2008/09/07 12:43:44 fabiankeil
69 * Move the LogPutString() call in log_error() into the locked
70 * region so the Windows GUI log is consistent with the logfile.
72 * Revision 1.76 2008/09/07 12:35:05 fabiankeil
73 * Add mutex lock support for _WIN32.
75 * Revision 1.75 2008/09/04 08:13:58 fabiankeil
76 * Prepare for critical sections on Windows by adding a
77 * layer of indirection before the pthread mutex functions.
79 * Revision 1.74 2008/08/06 18:33:36 fabiankeil
80 * If the "close fd first" workaround doesn't work,
81 * the fatal error message will be lost, so we better
82 * explain the consequences while we still can.
84 * Revision 1.73 2008/08/04 19:06:55 fabiankeil
85 * Add a lame workaround for the "can't open an already open
86 * logfile on OS/2" problem reported by Maynard in #2028842
87 * and describe what a real solution would look like.
89 * Revision 1.72 2008/07/27 12:04:28 fabiankeil
92 * Revision 1.71 2008/06/28 17:17:15 fabiankeil
93 * Remove another stray semicolon.
95 * Revision 1.70 2008/06/28 17:10:29 fabiankeil
96 * Remove stray semicolon in get_log_timestamp().
97 * Reported by Jochen Voss in #2005221.
99 * Revision 1.69 2008/05/30 15:55:25 fabiankeil
100 * Declare variable "debug" static and complain about its name.
102 * Revision 1.68 2008/04/27 16:50:46 fabiankeil
103 * Remove an incorrect assertion. The value of debug may change if
104 * the configuration is reloaded in another thread. While we could
105 * cache the initial value, the assertion doesn't seem worth it.
107 * Revision 1.67 2008/03/27 18:27:23 fabiankeil
108 * Remove kill-popups action.
110 * Revision 1.66 2008/01/31 15:38:14 fabiankeil
111 * - Make the logfp assertion more strict. As of 1.63, the "||" could
112 * have been an "&&", which means we can use two separate assertions
113 * and skip on of them on Windows.
114 * - Break a long commit message line in two.
116 * Revision 1.65 2008/01/31 14:44:33 fabiankeil
117 * Use (a != b) instead of !(a == b) so the sanity check looks less insane.
119 * Revision 1.64 2008/01/21 18:56:46 david__schmidt
120 * Swap #def from negative to positive, re-joined it so it didn't
121 * span an assertion (compilation failure on OS/2)
123 * Revision 1.63 2007/12/15 19:49:32 fabiankeil
124 * Stop overloading logfile to control the mingw32 log window as well.
125 * It's no longer necessary now that we disable all debug lines by default
126 * and at least one user perceived it as a regression (added in 1.55).
128 * Revision 1.62 2007/11/30 15:33:46 fabiankeil
129 * Unbreak LOG_LEVEL_FATAL. It wasn't fatal with logging disabled
130 * and on mingw32 fatal log messages didn't end up in the log file.
132 * Revision 1.61 2007/11/04 19:03:01 fabiankeil
133 * Fix another deadlock Hal spotted and that mysteriously didn't affect FreeBSD.
135 * Revision 1.60 2007/11/03 19:03:31 fabiankeil
136 * - Prevent the Windows GUI from showing the version two times in a row.
137 * - Stop using the imperative in the "(Re-)Open logfile" message.
138 * - Ditch the "Switching to daemon mode" message as the detection
139 * whether or not we're already in daemon mode doesn't actually work.
141 * Revision 1.59 2007/11/01 12:50:56 fabiankeil
142 * Here's looking at you, deadlock.
144 * Revision 1.58 2007/10/28 19:04:21 fabiankeil
145 * Don't mention daemon mode in "Logging disabled" message. Some
146 * platforms call it differently and it's not really relevant anyway.
148 * Revision 1.57 2007/10/27 13:02:26 fabiankeil
149 * Relocate daemon-mode-related log messages to make sure
150 * they aren't shown again in case of configuration reloads.
152 * Revision 1.56 2007/10/14 14:26:56 fabiankeil
153 * Remove the old log_error() version.
155 * Revision 1.55 2007/10/14 14:12:41 fabiankeil
156 * When in daemon mode, close stderr after the configuration file has been
157 * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
159 * Revision 1.54 2007/09/22 16:15:34 fabiankeil
160 * - Let it compile with pcc.
161 * - Move our includes below system includes to prevent macro conflicts.
163 * Revision 1.53 2007/08/05 13:53:14 fabiankeil
164 * #1763173 from Stefan Huehner: declare some more functions
165 * static and use void instead of empty parameter lists.
167 * Revision 1.52 2007/07/14 07:28:47 fabiankeil
168 * Add translation function for JB_ERR_FOO codes.
170 * Revision 1.51 2007/05/11 11:51:34 fabiankeil
171 * Fix a type mismatch warning.
173 * Revision 1.50 2007/04/11 10:55:44 fabiankeil
174 * Enforce some assertions that could be triggered
175 * on mingw32 and other systems where we use threads
178 * Revision 1.49 2007/04/08 16:44:15 fabiankeil
179 * We need <sys/time.h> for gettimeofday(), not <time.h>.
181 * Revision 1.48 2007/03/31 13:33:28 fabiankeil
182 * Add alternative log_error() with timestamps
183 * that contain milliseconds and without using
184 * strcpy(), strcat() or sprintf().
186 * Revision 1.47 2006/11/28 15:25:15 fabiankeil
187 * Only unlink the pidfile if it's actually used.
189 * Revision 1.46 2006/11/13 19:05:51 fabiankeil
190 * Make pthread mutex locking more generic. Instead of
191 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
192 * and use mutex locking unless there is an _r function
193 * available. Better safe than sorry.
195 * Fixes "./configure --disable-pthread" and should result
196 * in less threading-related problems on pthread-using platforms,
197 * but it still doesn't fix BR#1122404.
199 * Revision 1.45 2006/08/21 11:15:54 david__schmidt
200 * MS Visual C++ build updates
202 * Revision 1.44 2006/08/18 16:03:16 david__schmidt
203 * Tweak for OS/2 build happiness.
205 * Revision 1.43 2006/08/03 02:46:41 david__schmidt
206 * Incorporate Fabian Keil's patch work:
207 * http://www.fabiankeil.de/sourcecode/privoxy/
209 * Revision 1.42 2006/07/18 14:48:46 david__schmidt
210 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
211 * with what was really the latest development (the v_3_0_branch branch)
213 * Revision 1.40.2.4 2005/04/03 20:10:50 david__schmidt
214 * Thanks to Jindrich Makovicka for a race condition fix for the log
215 * file. The race condition remains for non-pthread implementations.
216 * Reference patch #1175720.
218 * Revision 1.40.2.3 2003/03/07 03:41:04 david__schmidt
219 * Wrapping all *_r functions (the non-_r versions of them) with mutex
220 * semaphores for OSX. Hopefully this will take care of all of those pesky
223 * Revision 1.40.2.2 2002/09/28 00:30:57 david__schmidt
224 * Update error logging to give sane values for thread IDs on Mach kernels.
225 * It's still a hack, but at least it looks farily normal. We print the
226 * absolute value of the first 4 bytes of the pthread_t modded with 1000.
228 * Revision 1.40.2.1 2002/09/25 12:47:42 oes
229 * Make log_error safe against NULL string arguments
231 * Revision 1.40 2002/05/22 01:27:27 david__schmidt
233 * Add os2_socket_strerr mirroring w32_socket_strerr.
235 * Revision 1.39 2002/04/03 17:15:27 gliptak
236 * zero padding thread ids in log
238 * Revision 1.38 2002/03/31 17:18:59 jongfoster
239 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
241 * Revision 1.37 2002/03/27 14:32:43 david__schmidt
242 * More compiler warning message maintenance
244 * Revision 1.36 2002/03/26 22:29:54 swa
245 * we have a new homepage!
247 * Revision 1.35 2002/03/24 15:23:33 jongfoster
250 * Revision 1.34 2002/03/24 13:25:43 swa
251 * name change related issues
253 * Revision 1.33 2002/03/13 00:27:04 jongfoster
256 * Revision 1.32 2002/03/07 03:46:17 oes
257 * Fixed compiler warnings
259 * Revision 1.31 2002/03/06 23:02:57 jongfoster
262 * Revision 1.30 2002/03/05 22:43:45 david__schmidt
263 * - Better error reporting on OS/2
264 * - Fix double-slash comment (oops)
266 * Revision 1.29 2002/03/04 23:45:13 jongfoster
267 * Printing thread ID if using Win32 native threads
269 * Revision 1.28 2002/03/04 17:59:59 oes
270 * Deleted deletePidFile(), cosmetics
272 * Revision 1.27 2002/03/04 02:08:01 david__schmidt
273 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
275 * Revision 1.26 2002/01/09 19:05:45 steudten
276 * Fix big memory leak.
278 * Revision 1.25 2002/01/09 14:32:08 oes
279 * Added support for gmtime_r and localtime_r.
281 * Revision 1.24 2001/12/30 14:07:32 steudten
282 * - Add signal handling (unix)
283 * - Add SIGHUP handler (unix)
284 * - Add creation of pidfile (unix)
285 * - Add action 'top' in rc file (RH)
286 * - Add entry 'SIGNALS' to manpage
287 * - Add exit message to logfile (unix)
289 * Revision 1.23 2001/11/07 00:02:13 steudten
290 * Add line number in error output for lineparsing for
291 * actionsfile and configfile.
292 * Special handling for CLF added.
294 * Revision 1.22 2001/11/05 23:43:05 steudten
295 * Add time+date to log files.
297 * Revision 1.21 2001/10/25 03:40:47 david__schmidt
298 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
299 * threads to call select() simultaneously. So, it's time to do a real, live,
300 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
301 * (native). Both versions will work, but using __OS2__ offers multi-threading.
303 * Revision 1.20 2001/09/16 23:04:34 jongfoster
306 * Revision 1.19 2001/09/13 20:08:06 jongfoster
307 * Adding support for LOG_LEVEL_CGI
309 * Revision 1.18 2001/09/10 11:27:24 oes
310 * Declaration of w32_socket_strerr now conditional
312 * Revision 1.17 2001/09/10 10:17:13 oes
313 * Removed unused variable; Fixed sprintf format
315 * Revision 1.16 2001/07/30 22:08:36 jongfoster
316 * Tidying up #defines:
317 * - All feature #defines are now of the form FEATURE_xxx
318 * - Permanently turned off WIN_GUI_EDIT
319 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
321 * Revision 1.15 2001/07/29 17:41:10 jongfoster
322 * Now prints thread ID for each message (pthreads only)
324 * Revision 1.14 2001/07/19 19:03:48 haroon
325 * - Added case for LOG_LEVEL_POPUPS
327 * Revision 1.13 2001/07/13 13:58:58 oes
328 * - Added case for LOG_LEVEL_DEANIMATE
329 * - Removed all #ifdef PCRS
331 * Revision 1.12 2001/06/09 10:55:28 jongfoster
332 * Changing BUFSIZ ==> BUFFER_SIZE
334 * Revision 1.11 2001/06/01 18:14:49 jongfoster
335 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
336 * in config.h if appropriate) rather than the NO_STRERR macro.
338 * Revision 1.10 2001/05/29 11:52:21 oes
339 * Conditional compilation of w32_socket_error
341 * Revision 1.9 2001/05/28 16:15:17 jongfoster
342 * Improved reporting of errors under Win32.
344 * Revision 1.8 2001/05/26 17:25:14 jongfoster
345 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
347 * Revision 1.7 2001/05/26 15:21:28 jongfoster
348 * Activity animation in Win32 GUI now works even if debug==0
350 * Revision 1.6 2001/05/25 21:55:08 jongfoster
351 * Now cleans up properly on FATAL (removes taskbar icon etc)
353 * Revision 1.5 2001/05/22 18:46:04 oes
355 * - Enabled filtering banners by size rather than URL
356 * by adding patterns that replace all standard banner
357 * sizes with the "Junkbuster" gif to the re_filterfile
359 * - Enabled filtering WebBugs by providing a pattern
360 * which kills all 1x1 images
362 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
363 * which is selected by the (nonstandard and therefore
364 * capital) letter 'U' in the option string.
365 * It causes the quantifiers to be ungreedy by default.
366 * Appending a ? turns back to greedy (!).
368 * - Added a new interceptor ijb-send-banner, which
369 * sends back the "Junkbuster" gif. Without imagelist or
370 * MSIE detection support, or if tinygif = 1, or the
371 * URL isn't recognized as an imageurl, a lame HTML
372 * explanation is sent instead.
374 * - Added new feature, which permits blocking remote
375 * script redirects and firing back a local redirect
377 * The feature is conditionally compiled, i.e. it
378 * can be disabled with --disable-fast-redirects,
379 * plus it must be activated by a "fast-redirects"
380 * line in the config file, has its own log level
381 * and of course wants to be displayed by show-proxy-args
382 * Note: Boy, all the #ifdefs in 1001 locations and
383 * all the fumbling with configure.in and acconfig.h
384 * were *way* more work than the feature itself :-(
386 * - Because a generic redirect template was needed for
387 * this, tinygif = 3 now uses the same.
389 * - Moved GIFs, and other static HTTP response templates
394 * - Removed some >400 CRs again (Jon, you really worked
397 * Revision 1.4 2001/05/21 19:32:54 jongfoster
398 * Added another #ifdef _WIN_CONSOLE
400 * Revision 1.3 2001/05/20 01:11:40 jongfoster
401 * Added support for LOG_LEVEL_FATAL
402 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
403 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
405 * Revision 1.2 2001/05/17 22:42:01 oes
406 * - Cleaned CRLF's from the sources and related files
407 * - Repaired logging for REF and FRC
409 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
410 * Initial import of version 2.9.3 source tree
413 *********************************************************************/
422 #include "miscutil.h"
424 /* For gettimeofday() */
425 #include <sys/time.h>
427 #if !defined(_WIN32) && !defined(__OS2__)
429 #endif /* !defined(_WIN32) && !defined(__OS2__) */
441 #endif /* ndef _WIN_CONSOLE */
442 #endif /* def _WIN32 */
444 #define inline __inline
445 #endif /* def _MSC_VER */
448 #include <sys/socket.h> /* For sock_errno */
457 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
461 * LOG_LEVEL_FATAL cannot be turned off. (There are
462 * some exceptional situations where we need to get a
463 * message to the user).
465 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
467 /* where to log (default: stderr) */
468 static FILE *logfp = NULL;
470 /* logging detail level. XXX: stupid name. */
471 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
473 /* static functions */
474 static void fatal_error(const char * error_message);
476 static char *w32_socket_strerr(int errcode, char *tmp_buf);
479 static char *os2_socket_strerr(int errcode, char *tmp_buf);
482 #ifdef MUTEX_LOCKS_AVAILABLE
483 static inline void lock_logfile(void)
485 privoxy_mutex_lock(&log_mutex);
487 static inline void unlock_logfile(void)
489 privoxy_mutex_unlock(&log_mutex);
491 static inline void lock_loginit(void)
493 privoxy_mutex_lock(&log_init_mutex);
495 static inline void unlock_loginit(void)
497 privoxy_mutex_unlock(&log_init_mutex);
499 #else /* ! MUTEX_LOCKS_AVAILABLE */
501 * FIXME we need a cross-platform locking mechanism.
502 * The locking/unlocking functions below should be
503 * fleshed out for non-pthread implementations.
505 static inline void lock_logfile() {}
506 static inline void unlock_logfile() {}
507 static inline void lock_loginit() {}
508 static inline void unlock_loginit() {}
511 /*********************************************************************
513 * Function : fatal_error
515 * Description : Displays a fatal error to standard error (or, on
516 * a WIN32 GUI, to a dialog box), and exits
517 * JunkBuster with status code 1.
520 * 1 : error_message = The error message to display.
522 * Returns : Does not return.
524 *********************************************************************/
525 static void fatal_error(const char * error_message)
527 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
528 MessageBox(g_hwndLogFrame, error_message, "Privoxy Error",
529 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
531 /* Cleanup - remove taskbar icon etc. */
533 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
537 fputs(error_message, logfp);
551 /*********************************************************************
553 * Function : show_version
555 * Description : Logs the Privoxy version and the program name.
558 * 1 : prog_name = The program name.
562 *********************************************************************/
563 void show_version(const char *prog_name)
565 log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
566 if (prog_name != NULL)
568 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
573 /*********************************************************************
575 * Function : init_log_module
577 * Description : Initializes the logging module to log to stderr.
578 * Can only be called while stderr hasn't been closed
579 * yet and is only supposed to be called once.
582 * 1 : prog_name = The program name.
586 *********************************************************************/
587 void init_log_module(void)
592 set_debug_level(debug);
596 /*********************************************************************
598 * Function : set_debug_level
600 * Description : Sets the debug level to the provided value
601 * plus LOG_LEVEL_MINIMUM.
603 * XXX: we should only use the LOG_LEVEL_MINIMUM
604 * until the first time the configuration file has
607 * Parameters : 1: debug_level = The debug level to set.
611 *********************************************************************/
612 void set_debug_level(int debug_level)
614 debug = debug_level | LOG_LEVEL_MINIMUM;
618 /*********************************************************************
620 * Function : disable_logging
622 * Description : Disables logging.
628 *********************************************************************/
629 void disable_logging(void)
633 log_error(LOG_LEVEL_INFO,
634 "No logfile configured. Please enable it before reporting any problems.");
643 /*********************************************************************
645 * Function : init_error_log
647 * Description : Initializes the logging module to log to a file.
649 * XXX: should be renamed.
652 * 1 : prog_name = The program name.
653 * 2 : logfname = The logfile to (re)open.
657 *********************************************************************/
658 void init_error_log(const char *prog_name, const char *logfname)
662 assert(NULL != logfname);
668 log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
671 /* set the designated log file */
672 fp = fopen(logfname, "a");
673 if ((NULL == fp) && (logfp != NULL))
676 * Some platforms (like OS/2) don't allow us to open
677 * the same file twice, therefore we give it another
678 * shot after closing the old file descriptor first.
680 * We don't do it right away because it prevents us
681 * from logging the "can't open logfile" message to
684 * XXX: this is a lame workaround and once the next
685 * release is out we should stop bothering reopening
686 * the logfile unless we have to.
688 * Currently we reopen it every time the config file
689 * has been reloaded, but actually we only have to
690 * reopen it if the file name changed or if the
691 * configuration reloas was caused by a SIGHUP.
693 log_error(LOG_LEVEL_INFO, "Failed to reopen logfile: \'%s\'. "
694 "Retrying after closing the old file descriptor first. If that "
695 "doesn't work, Privoxy will exit without being able to log a message.",
701 fp = fopen(logfname, "a");
706 log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
709 /* set logging to be completely unbuffered */
722 * Prevent the Windows GUI from showing the version two
723 * times in a row on startup. It already displayed the show_version()
724 * call from main() that other systems write to stderr.
726 * This means mingw32 users will never see the version in their
727 * log file, but I assume they wouldn't look for it there anyway
728 * and simply use the "Help/About Privoxy" menu.
730 show_version(prog_name);
731 #endif /* def unix */
735 } /* init_error_log */
738 /*********************************************************************
740 * Function : get_thread_id
742 * Description : Returns a number that is different for each thread.
744 * XXX: Should be moved elsewhere (miscutil.c?)
748 * Returns : thread_id
750 *********************************************************************/
751 static long get_thread_id(void)
753 long this_thread = 1; /* was: pthread_t this_thread;*/
757 APIRET ulrc; /* XXX: I have no clue what this does */
760 /* FIXME get current thread id */
761 #ifdef FEATURE_PTHREAD
762 this_thread = (long)pthread_self();
765 * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
766 * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
767 * pthread_t is supposed to be opaque... but it's fairly random, though, so
768 * we make it mostly presentable.
770 this_thread = abs(this_thread % 1000);
771 #endif /* def __MACH__ */
772 #elif defined(_WIN32)
773 this_thread = GetCurrentThreadId();
774 #elif defined(__OS2__)
775 ulrc = DosGetInfoBlocks(&ptib, NULL);
777 this_thread = ptib -> tib_ptib2 -> tib2_ultid;
778 #endif /* def FEATURE_PTHREAD */
784 /*********************************************************************
786 * Function : get_log_timestamp
788 * Description : Generates the time stamp for the log message prefix.
791 * 1 : buffer = Storage buffer
792 * 2 : buffer_size = Size of storage buffer
794 * Returns : Number of written characters or 0 for error.
796 *********************************************************************/
797 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
802 struct timeval tv_now; /* XXX: stupid name */
804 int msecs_length = 0;
806 gettimeofday(&tv_now, NULL);
807 msecs = tv_now.tv_usec / 1000;
811 #ifdef HAVE_LOCALTIME_R
812 tm_now = *localtime_r(&now, &tm_now);
813 #elif FEATURE_PTHREAD
814 privoxy_mutex_lock(&localtime_mutex);
815 tm_now = *localtime(&now);
816 privoxy_mutex_unlock(&localtime_mutex);
818 tm_now = *localtime(&now);
821 length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
822 if (length > (size_t)0)
824 msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
826 if (msecs_length > 0)
828 length += (size_t)msecs_length;
839 /*********************************************************************
841 * Function : get_clf_timestamp
843 * Description : Generates a Common Log Format time string.
846 * 1 : buffer = Storage buffer
847 * 2 : buffer_size = Size of storage buffer
849 * Returns : Number of written characters or 0 for error.
851 *********************************************************************/
852 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
855 * Complex because not all OSs have tm_gmtoff or
856 * the %z field in strftime()
861 #ifdef HAVE_LOCALTIME_R
870 gmt = *gmtime_r(&now, &gmt);
871 #elif FEATURE_PTHREAD
872 privoxy_mutex_lock(&gmtime_mutex);
874 privoxy_mutex_unlock(&gmtime_mutex);
878 #ifdef HAVE_LOCALTIME_R
879 tm_now = localtime_r(&now, &dummy);
880 #elif FEATURE_PTHREAD
881 privoxy_mutex_lock(&localtime_mutex);
882 tm_now = localtime(&now);
883 privoxy_mutex_unlock(&localtime_mutex);
885 tm_now = localtime(&now);
887 days = tm_now->tm_yday - gmt.tm_yday;
888 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
889 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
891 length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
893 if (length > (size_t)0)
895 tz_length = snprintf(buffer+length, buffer_size-length,
896 "%+03d%02d", mins / 60, abs(mins) % 60);
900 length += (size_t)tz_length;
911 /*********************************************************************
913 * Function : get_log_level_string
915 * Description : Translates a numerical loglevel into a string.
918 * 1 : loglevel = LOG_LEVEL_FOO
920 * Returns : Log level string.
922 *********************************************************************/
923 static inline const char *get_log_level_string(int loglevel)
925 char *log_level_string = NULL;
927 assert(0 < loglevel);
931 case LOG_LEVEL_ERROR:
932 log_level_string = "Error";
934 case LOG_LEVEL_FATAL:
935 log_level_string = "Fatal error";
938 log_level_string = "Request";
940 case LOG_LEVEL_CONNECT:
941 log_level_string = "Connect";
944 log_level_string = "Writing";
946 case LOG_LEVEL_HEADER:
947 log_level_string = "Header";
950 log_level_string = "Info";
952 case LOG_LEVEL_RE_FILTER:
953 log_level_string = "Re-Filter";
955 #ifdef FEATURE_FORCE_LOAD
956 case LOG_LEVEL_FORCE:
957 log_level_string = "Force";
959 #endif /* def FEATURE_FORCE_LOAD */
960 #ifdef FEATURE_FAST_REDIRECTS
961 case LOG_LEVEL_REDIRECTS:
962 log_level_string = "Redirect";
964 #endif /* def FEATURE_FAST_REDIRECTS */
965 case LOG_LEVEL_DEANIMATE:
966 log_level_string = "Gif-Deanimate";
968 case LOG_LEVEL_CRUNCH:
969 log_level_string = "Crunch";
972 log_level_string = "CGI";
975 log_level_string = "Unknown log level";
978 assert(NULL != log_level_string);
980 return log_level_string;
984 /*********************************************************************
986 * Function : log_error
988 * Description : This is the error-reporting and logging function.
991 * 1 : loglevel = the type of message to be logged
992 * 2 : fmt = the main string we want logged, printf-like
993 * 3 : ... = arguments to be inserted in fmt (printf-like).
997 *********************************************************************/
998 void log_error(int loglevel, const char *fmt, ...)
1001 char *outbuf = NULL;
1002 static char *outbuf_save = NULL;
1003 char tempbuf[BUFFER_SIZE];
1005 const char * src = fmt;
1009 * XXX: Make this a config option,
1010 * why else do we allocate instead of using
1013 size_t log_buffer_size = BUFFER_SIZE;
1015 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1017 * Irrespective of debug setting, a GET/POST/CONNECT makes
1018 * the taskbar icon animate. (There is an option to disable
1019 * this but checking that is handled inside LogShowActivity()).
1021 if ((loglevel == LOG_LEVEL_GPC) || (loglevel == LOG_LEVEL_CRUNCH))
1025 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1028 * verify that the loglevel applies to current
1029 * settings and that logging is enabled.
1030 * Bail out otherwise.
1032 if ((0 == (loglevel & debug))
1038 if (loglevel == LOG_LEVEL_FATAL)
1040 fatal_error("Fatal error. You're not supposed to"
1041 "see this message. Please file a bug report.");
1046 thread_id = get_thread_id();
1047 get_log_timestamp(timestamp, sizeof(timestamp));
1049 /* protect the whole function because of the static buffer (outbuf) */
1052 if (NULL == outbuf_save)
1054 outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
1055 if (NULL == outbuf_save)
1057 snprintf(tempbuf, sizeof(tempbuf),
1058 "%s %08lx Fatal error: Out of memory in log_error().",
1059 timestamp, thread_id);
1060 fatal_error(tempbuf); /* Exit */
1064 outbuf = outbuf_save;
1067 * Memsetting the whole buffer to zero (in theory)
1068 * makes things easier later on.
1070 memset(outbuf, 0, log_buffer_size);
1072 /* Add prefix for everything but Common Log Format messages */
1073 if (loglevel != LOG_LEVEL_CLF)
1075 length = (size_t)snprintf(outbuf, log_buffer_size, "%s %08lx %s: ",
1076 timestamp, thread_id, get_log_level_string(loglevel));
1079 /* get ready to scan var. args. */
1082 /* build formatted message from fmt and var-args */
1083 while ((*src) && (length < log_buffer_size-2))
1085 const char *sval = NULL; /* %N string */
1086 int ival; /* %N string length or an error code */
1087 unsigned uval; /* %u value */
1088 long lval; /* %l value */
1089 unsigned long ulval; /* %ul value */
1091 const char *format_string = tempbuf;
1096 outbuf[length++] = ch;
1098 * XXX: Only necessary on platforms where multiple threads
1099 * can write to the buffer at the same time because we
1100 * don't support mutexes (OS/2 for example).
1102 outbuf[length] = '\0';
1105 outbuf[length] = '\0';
1113 ival = va_arg( ap, int );
1114 snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
1117 uval = va_arg( ap, unsigned );
1118 snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
1121 /* this is a modifier that must be followed by u or d */
1125 lval = va_arg( ap, long );
1126 snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
1130 ulval = va_arg( ap, unsigned long );
1131 snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
1135 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1136 loglevel = LOG_LEVEL_FATAL;
1141 * Note that char paramaters are converted to int, so we need to
1142 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
1144 tempbuf[0] = (char) va_arg(ap, int);
1148 format_string = va_arg(ap, char *);
1149 if (format_string == NULL)
1151 format_string = "[null]";
1156 * Non-standard: Print a counted unterminated string.
1157 * Takes 2 parameters: int length, const char * string.
1159 ival = va_arg(ap, int);
1160 sval = va_arg(ap, char *);
1163 format_string = "[null]";
1169 /* That's ok (but stupid) */
1175 * That's not ok (and even more stupid)
1178 format_string = "[counted string lenght < 0]";
1181 else if ((size_t)ival >= sizeof(tempbuf))
1184 * String is too long, copy as much as possible.
1185 * It will be further truncated later.
1187 memcpy(tempbuf, sval, sizeof(tempbuf)-1);
1188 tempbuf[sizeof(tempbuf)-1] = '\0';
1192 memcpy(tempbuf, sval, (size_t) ival);
1193 tempbuf[ival] = '\0';
1197 /* Non-standard: Print error code from errno */
1199 ival = WSAGetLastError();
1200 format_string = w32_socket_strerr(ival, tempbuf);
1202 ival = sock_errno();
1205 format_string = os2_socket_strerr(ival, tempbuf);
1210 format_string = strerror(ival);
1212 #else /* ifndef _WIN32 */
1214 #ifdef HAVE_STRERROR
1215 format_string = strerror(ival);
1216 #else /* ifndef HAVE_STRERROR */
1217 format_string = NULL;
1218 #endif /* ndef HAVE_STRERROR */
1221 snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
1223 #endif /* ndef _WIN32 */
1226 /* Non-standard: Print a Common Log File timestamp */
1227 get_clf_timestamp(tempbuf, sizeof(tempbuf));
1230 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1231 loglevel = LOG_LEVEL_FATAL;
1235 assert(length < log_buffer_size);
1236 length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
1238 if (length >= log_buffer_size-2)
1240 static char warning[] = "... [too long, truncated]";
1242 length = log_buffer_size - sizeof(warning) - 1;
1243 length += strlcpy(outbuf + length, warning, log_buffer_size - length);
1244 assert(length < log_buffer_size);
1248 } /* for( p ... ) */
1250 /* done with var. args */
1253 assert(length < log_buffer_size);
1254 length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
1256 /* Some sanity checks */
1257 if ((length >= log_buffer_size)
1258 || (outbuf[log_buffer_size-1] != '\0')
1259 || (outbuf[log_buffer_size] != '\0')
1262 /* Repeat as assertions */
1263 assert(length < log_buffer_size);
1264 assert(outbuf[log_buffer_size-1] == '\0');
1266 * outbuf's real size is log_buffer_size+1,
1267 * so while this looks like an off-by-one,
1268 * we're only checking our paranoia byte.
1270 assert(outbuf[log_buffer_size] == '\0');
1272 snprintf(outbuf, log_buffer_size,
1273 "%s %08lx Fatal error: log_error()'s sanity checks failed."
1274 "length: %d. Exiting.",
1275 timestamp, thread_id, (int)length);
1276 loglevel = LOG_LEVEL_FATAL;
1281 * On Windows this is acceptable in case
1282 * we are logging to the GUI window only.
1284 assert(NULL != logfp);
1287 if (loglevel == LOG_LEVEL_FATAL)
1289 fatal_error(outbuf_save);
1290 /* Never get here */
1294 fputs(outbuf_save, logfp);
1297 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1298 /* Write to display */
1299 LogPutString(outbuf_save);
1300 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1307 /*********************************************************************
1309 * Function : jb_err_to_string
1311 * Description : Translates JB_ERR_FOO codes into strings.
1313 * XXX: the type of error codes is jb_err
1314 * but the typedef'inition is currently not
1315 * visible to all files that include errlog.h.
1318 * 1 : error = a valid jb_err code
1320 * Returns : A string with the jb_err translation
1322 *********************************************************************/
1323 const char *jb_err_to_string(int error)
1328 return "Success, no error";
1330 return "Out of memory";
1331 case JB_ERR_CGI_PARAMS:
1332 return "Missing or corrupt CGI parameters";
1334 return "Error opening, reading or writing a file";
1336 return "Parse error";
1337 case JB_ERR_MODIFIED:
1338 return "File has been modified outside of the CGI actions editor.";
1339 case JB_ERR_COMPRESS:
1340 return "(De)compression failure";
1343 return "Unknown error";
1346 return "Internal error";
1350 /*********************************************************************
1352 * Function : w32_socket_strerr
1354 * Description : Translate the return value from WSAGetLastError()
1358 * 1 : errcode = The return value from WSAGetLastError().
1359 * 2 : tmp_buf = A temporary buffer that might be used to
1362 * Returns : String representing the error code. This may be
1363 * a global string constant or a string stored in
1366 *********************************************************************/
1367 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1369 #define TEXT_FOR_ERROR(code,text) \
1370 if (errcode == code) \
1372 return #code " - " text; \
1375 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1376 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1377 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1378 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1379 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1380 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1381 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1382 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1383 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1384 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1385 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1386 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1387 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1388 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1389 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1390 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1391 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1392 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1393 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1394 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1395 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1396 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1397 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1398 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1399 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1400 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1401 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1402 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1403 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1404 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1405 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1406 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1407 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1408 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1409 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1410 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1411 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1412 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1413 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1414 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1415 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1416 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1418 * The following error codes are documented in the Microsoft WinSock
1419 * reference guide, but don't actually exist.
1421 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1422 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1423 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1424 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1425 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1426 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1427 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1428 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1429 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1430 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1433 sprintf(tmp_buf, "(error number %d)", errcode);
1436 #endif /* def _WIN32 */
1440 /*********************************************************************
1442 * Function : os2_socket_strerr
1444 * Description : Translate the return value from sock_errno()
1448 * 1 : errcode = The return value from sock_errno().
1449 * 2 : tmp_buf = A temporary buffer that might be used to
1452 * Returns : String representing the error code. This may be
1453 * a global string constant or a string stored in
1456 *********************************************************************/
1457 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1459 #define TEXT_FOR_ERROR(code,text) \
1460 if (errcode == code) \
1462 return #code " - " text; \
1465 TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
1466 TEXT_FOR_ERROR(SOCESRCH , "No such process.")
1467 TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
1468 TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
1469 TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
1470 TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
1471 TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
1472 TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
1473 TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
1474 TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
1475 TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
1476 TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
1477 TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
1478 TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
1479 TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
1480 TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
1481 TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
1482 TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
1483 TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1484 TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1485 TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
1486 TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
1487 TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
1488 TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
1489 TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
1490 TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
1491 TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
1492 TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
1493 TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
1494 TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
1495 TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
1496 TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
1497 TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
1498 TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
1499 TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
1500 TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
1501 TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
1502 TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
1503 TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
1504 TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
1505 TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
1506 TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
1507 TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
1509 sprintf(tmp_buf, "(error number %d)", errcode);
1512 #endif /* def __OS2__ */