1 const char errlog_rcs[] = "$Id: errlog.c,v 1.88 2009/03/07 11:34:36 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.88 2009/03/07 11:34:36 fabiankeil
37 * Omit timestamp and thread id in the mingw32 message box.
39 * Revision 1.87 2009/03/01 18:28:24 fabiankeil
40 * Help clang understand that we aren't dereferencing
43 * Revision 1.86 2009/02/09 21:21:15 fabiankeil
44 * Now that init_log_module() is called earlier, call show_version()
45 * later on from main() directly so it doesn't get called for --help
48 * Revision 1.85 2009/02/06 17:51:38 fabiankeil
49 * Be prepared if I break the log module initialization again.
51 * Revision 1.84 2008/12/14 15:46:22 fabiankeil
52 * Give crunched requests their own log level.
54 * Revision 1.83 2008/12/04 18:14:32 fabiankeil
55 * Fix some cparser warnings.
57 * Revision 1.82 2008/11/23 16:06:58 fabiankeil
58 * Update a log message I missed in 1.80.
60 * Revision 1.81 2008/11/23 15:59:27 fabiankeil
61 * - Update copyright range.
62 * - Remove stray line breaks in a log message
63 * nobody is supposed to see anyway.
65 * Revision 1.80 2008/11/23 15:49:49 fabiankeil
66 * In log_error(), don't surround the thread id with "Privoxy(" and ")".
68 * Revision 1.79 2008/10/20 17:09:25 fabiankeil
69 * Update init_error_log() description to match reality.
71 * Revision 1.78 2008/09/07 16:59:31 fabiankeil
72 * Update a comment to reflect that we
73 * have mutex support on mingw32 now.
75 * Revision 1.77 2008/09/07 12:43:44 fabiankeil
76 * Move the LogPutString() call in log_error() into the locked
77 * region so the Windows GUI log is consistent with the logfile.
79 * Revision 1.76 2008/09/07 12:35:05 fabiankeil
80 * Add mutex lock support for _WIN32.
82 * Revision 1.75 2008/09/04 08:13:58 fabiankeil
83 * Prepare for critical sections on Windows by adding a
84 * layer of indirection before the pthread mutex functions.
86 * Revision 1.74 2008/08/06 18:33:36 fabiankeil
87 * If the "close fd first" workaround doesn't work,
88 * the fatal error message will be lost, so we better
89 * explain the consequences while we still can.
91 * Revision 1.73 2008/08/04 19:06:55 fabiankeil
92 * Add a lame workaround for the "can't open an already open
93 * logfile on OS/2" problem reported by Maynard in #2028842
94 * and describe what a real solution would look like.
96 * Revision 1.72 2008/07/27 12:04:28 fabiankeil
99 * Revision 1.71 2008/06/28 17:17:15 fabiankeil
100 * Remove another stray semicolon.
102 * Revision 1.70 2008/06/28 17:10:29 fabiankeil
103 * Remove stray semicolon in get_log_timestamp().
104 * Reported by Jochen Voss in #2005221.
106 * Revision 1.69 2008/05/30 15:55:25 fabiankeil
107 * Declare variable "debug" static and complain about its name.
109 * Revision 1.68 2008/04/27 16:50:46 fabiankeil
110 * Remove an incorrect assertion. The value of debug may change if
111 * the configuration is reloaded in another thread. While we could
112 * cache the initial value, the assertion doesn't seem worth it.
114 * Revision 1.67 2008/03/27 18:27:23 fabiankeil
115 * Remove kill-popups action.
117 * Revision 1.66 2008/01/31 15:38:14 fabiankeil
118 * - Make the logfp assertion more strict. As of 1.63, the "||" could
119 * have been an "&&", which means we can use two separate assertions
120 * and skip on of them on Windows.
121 * - Break a long commit message line in two.
123 * Revision 1.65 2008/01/31 14:44:33 fabiankeil
124 * Use (a != b) instead of !(a == b) so the sanity check looks less insane.
126 * Revision 1.64 2008/01/21 18:56:46 david__schmidt
127 * Swap #def from negative to positive, re-joined it so it didn't
128 * span an assertion (compilation failure on OS/2)
130 * Revision 1.63 2007/12/15 19:49:32 fabiankeil
131 * Stop overloading logfile to control the mingw32 log window as well.
132 * It's no longer necessary now that we disable all debug lines by default
133 * and at least one user perceived it as a regression (added in 1.55).
135 * Revision 1.62 2007/11/30 15:33:46 fabiankeil
136 * Unbreak LOG_LEVEL_FATAL. It wasn't fatal with logging disabled
137 * and on mingw32 fatal log messages didn't end up in the log file.
139 * Revision 1.61 2007/11/04 19:03:01 fabiankeil
140 * Fix another deadlock Hal spotted and that mysteriously didn't affect FreeBSD.
142 * Revision 1.60 2007/11/03 19:03:31 fabiankeil
143 * - Prevent the Windows GUI from showing the version two times in a row.
144 * - Stop using the imperative in the "(Re-)Open logfile" message.
145 * - Ditch the "Switching to daemon mode" message as the detection
146 * whether or not we're already in daemon mode doesn't actually work.
148 * Revision 1.59 2007/11/01 12:50:56 fabiankeil
149 * Here's looking at you, deadlock.
151 * Revision 1.58 2007/10/28 19:04:21 fabiankeil
152 * Don't mention daemon mode in "Logging disabled" message. Some
153 * platforms call it differently and it's not really relevant anyway.
155 * Revision 1.57 2007/10/27 13:02:26 fabiankeil
156 * Relocate daemon-mode-related log messages to make sure
157 * they aren't shown again in case of configuration reloads.
159 * Revision 1.56 2007/10/14 14:26:56 fabiankeil
160 * Remove the old log_error() version.
162 * Revision 1.55 2007/10/14 14:12:41 fabiankeil
163 * When in daemon mode, close stderr after the configuration file has been
164 * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
166 * Revision 1.54 2007/09/22 16:15:34 fabiankeil
167 * - Let it compile with pcc.
168 * - Move our includes below system includes to prevent macro conflicts.
170 * Revision 1.53 2007/08/05 13:53:14 fabiankeil
171 * #1763173 from Stefan Huehner: declare some more functions
172 * static and use void instead of empty parameter lists.
174 * Revision 1.52 2007/07/14 07:28:47 fabiankeil
175 * Add translation function for JB_ERR_FOO codes.
177 * Revision 1.51 2007/05/11 11:51:34 fabiankeil
178 * Fix a type mismatch warning.
180 * Revision 1.50 2007/04/11 10:55:44 fabiankeil
181 * Enforce some assertions that could be triggered
182 * on mingw32 and other systems where we use threads
185 * Revision 1.49 2007/04/08 16:44:15 fabiankeil
186 * We need <sys/time.h> for gettimeofday(), not <time.h>.
188 * Revision 1.48 2007/03/31 13:33:28 fabiankeil
189 * Add alternative log_error() with timestamps
190 * that contain milliseconds and without using
191 * strcpy(), strcat() or sprintf().
193 * Revision 1.47 2006/11/28 15:25:15 fabiankeil
194 * Only unlink the pidfile if it's actually used.
196 * Revision 1.46 2006/11/13 19:05:51 fabiankeil
197 * Make pthread mutex locking more generic. Instead of
198 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
199 * and use mutex locking unless there is an _r function
200 * available. Better safe than sorry.
202 * Fixes "./configure --disable-pthread" and should result
203 * in less threading-related problems on pthread-using platforms,
204 * but it still doesn't fix BR#1122404.
206 * Revision 1.45 2006/08/21 11:15:54 david__schmidt
207 * MS Visual C++ build updates
209 * Revision 1.44 2006/08/18 16:03:16 david__schmidt
210 * Tweak for OS/2 build happiness.
212 * Revision 1.43 2006/08/03 02:46:41 david__schmidt
213 * Incorporate Fabian Keil's patch work:
214 * http://www.fabiankeil.de/sourcecode/privoxy/
216 * Revision 1.42 2006/07/18 14:48:46 david__schmidt
217 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
218 * with what was really the latest development (the v_3_0_branch branch)
220 * Revision 1.40.2.4 2005/04/03 20:10:50 david__schmidt
221 * Thanks to Jindrich Makovicka for a race condition fix for the log
222 * file. The race condition remains for non-pthread implementations.
223 * Reference patch #1175720.
225 * Revision 1.40.2.3 2003/03/07 03:41:04 david__schmidt
226 * Wrapping all *_r functions (the non-_r versions of them) with mutex
227 * semaphores for OSX. Hopefully this will take care of all of those pesky
230 * Revision 1.40.2.2 2002/09/28 00:30:57 david__schmidt
231 * Update error logging to give sane values for thread IDs on Mach kernels.
232 * It's still a hack, but at least it looks farily normal. We print the
233 * absolute value of the first 4 bytes of the pthread_t modded with 1000.
235 * Revision 1.40.2.1 2002/09/25 12:47:42 oes
236 * Make log_error safe against NULL string arguments
238 * Revision 1.40 2002/05/22 01:27:27 david__schmidt
240 * Add os2_socket_strerr mirroring w32_socket_strerr.
242 * Revision 1.39 2002/04/03 17:15:27 gliptak
243 * zero padding thread ids in log
245 * Revision 1.38 2002/03/31 17:18:59 jongfoster
246 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
248 * Revision 1.37 2002/03/27 14:32:43 david__schmidt
249 * More compiler warning message maintenance
251 * Revision 1.36 2002/03/26 22:29:54 swa
252 * we have a new homepage!
254 * Revision 1.35 2002/03/24 15:23:33 jongfoster
257 * Revision 1.34 2002/03/24 13:25:43 swa
258 * name change related issues
260 * Revision 1.33 2002/03/13 00:27:04 jongfoster
263 * Revision 1.32 2002/03/07 03:46:17 oes
264 * Fixed compiler warnings
266 * Revision 1.31 2002/03/06 23:02:57 jongfoster
269 * Revision 1.30 2002/03/05 22:43:45 david__schmidt
270 * - Better error reporting on OS/2
271 * - Fix double-slash comment (oops)
273 * Revision 1.29 2002/03/04 23:45:13 jongfoster
274 * Printing thread ID if using Win32 native threads
276 * Revision 1.28 2002/03/04 17:59:59 oes
277 * Deleted deletePidFile(), cosmetics
279 * Revision 1.27 2002/03/04 02:08:01 david__schmidt
280 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
282 * Revision 1.26 2002/01/09 19:05:45 steudten
283 * Fix big memory leak.
285 * Revision 1.25 2002/01/09 14:32:08 oes
286 * Added support for gmtime_r and localtime_r.
288 * Revision 1.24 2001/12/30 14:07:32 steudten
289 * - Add signal handling (unix)
290 * - Add SIGHUP handler (unix)
291 * - Add creation of pidfile (unix)
292 * - Add action 'top' in rc file (RH)
293 * - Add entry 'SIGNALS' to manpage
294 * - Add exit message to logfile (unix)
296 * Revision 1.23 2001/11/07 00:02:13 steudten
297 * Add line number in error output for lineparsing for
298 * actionsfile and configfile.
299 * Special handling for CLF added.
301 * Revision 1.22 2001/11/05 23:43:05 steudten
302 * Add time+date to log files.
304 * Revision 1.21 2001/10/25 03:40:47 david__schmidt
305 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
306 * threads to call select() simultaneously. So, it's time to do a real, live,
307 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
308 * (native). Both versions will work, but using __OS2__ offers multi-threading.
310 * Revision 1.20 2001/09/16 23:04:34 jongfoster
313 * Revision 1.19 2001/09/13 20:08:06 jongfoster
314 * Adding support for LOG_LEVEL_CGI
316 * Revision 1.18 2001/09/10 11:27:24 oes
317 * Declaration of w32_socket_strerr now conditional
319 * Revision 1.17 2001/09/10 10:17:13 oes
320 * Removed unused variable; Fixed sprintf format
322 * Revision 1.16 2001/07/30 22:08:36 jongfoster
323 * Tidying up #defines:
324 * - All feature #defines are now of the form FEATURE_xxx
325 * - Permanently turned off WIN_GUI_EDIT
326 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
328 * Revision 1.15 2001/07/29 17:41:10 jongfoster
329 * Now prints thread ID for each message (pthreads only)
331 * Revision 1.14 2001/07/19 19:03:48 haroon
332 * - Added case for LOG_LEVEL_POPUPS
334 * Revision 1.13 2001/07/13 13:58:58 oes
335 * - Added case for LOG_LEVEL_DEANIMATE
336 * - Removed all #ifdef PCRS
338 * Revision 1.12 2001/06/09 10:55:28 jongfoster
339 * Changing BUFSIZ ==> BUFFER_SIZE
341 * Revision 1.11 2001/06/01 18:14:49 jongfoster
342 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
343 * in config.h if appropriate) rather than the NO_STRERR macro.
345 * Revision 1.10 2001/05/29 11:52:21 oes
346 * Conditional compilation of w32_socket_error
348 * Revision 1.9 2001/05/28 16:15:17 jongfoster
349 * Improved reporting of errors under Win32.
351 * Revision 1.8 2001/05/26 17:25:14 jongfoster
352 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
354 * Revision 1.7 2001/05/26 15:21:28 jongfoster
355 * Activity animation in Win32 GUI now works even if debug==0
357 * Revision 1.6 2001/05/25 21:55:08 jongfoster
358 * Now cleans up properly on FATAL (removes taskbar icon etc)
360 * Revision 1.5 2001/05/22 18:46:04 oes
362 * - Enabled filtering banners by size rather than URL
363 * by adding patterns that replace all standard banner
364 * sizes with the "Junkbuster" gif to the re_filterfile
366 * - Enabled filtering WebBugs by providing a pattern
367 * which kills all 1x1 images
369 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
370 * which is selected by the (nonstandard and therefore
371 * capital) letter 'U' in the option string.
372 * It causes the quantifiers to be ungreedy by default.
373 * Appending a ? turns back to greedy (!).
375 * - Added a new interceptor ijb-send-banner, which
376 * sends back the "Junkbuster" gif. Without imagelist or
377 * MSIE detection support, or if tinygif = 1, or the
378 * URL isn't recognized as an imageurl, a lame HTML
379 * explanation is sent instead.
381 * - Added new feature, which permits blocking remote
382 * script redirects and firing back a local redirect
384 * The feature is conditionally compiled, i.e. it
385 * can be disabled with --disable-fast-redirects,
386 * plus it must be activated by a "fast-redirects"
387 * line in the config file, has its own log level
388 * and of course wants to be displayed by show-proxy-args
389 * Note: Boy, all the #ifdefs in 1001 locations and
390 * all the fumbling with configure.in and acconfig.h
391 * were *way* more work than the feature itself :-(
393 * - Because a generic redirect template was needed for
394 * this, tinygif = 3 now uses the same.
396 * - Moved GIFs, and other static HTTP response templates
401 * - Removed some >400 CRs again (Jon, you really worked
404 * Revision 1.4 2001/05/21 19:32:54 jongfoster
405 * Added another #ifdef _WIN_CONSOLE
407 * Revision 1.3 2001/05/20 01:11:40 jongfoster
408 * Added support for LOG_LEVEL_FATAL
409 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
410 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
412 * Revision 1.2 2001/05/17 22:42:01 oes
413 * - Cleaned CRLF's from the sources and related files
414 * - Repaired logging for REF and FRC
416 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
417 * Initial import of version 2.9.3 source tree
420 *********************************************************************/
429 #include "miscutil.h"
431 /* For gettimeofday() */
432 #include <sys/time.h>
434 #if !defined(_WIN32) && !defined(__OS2__)
436 #endif /* !defined(_WIN32) && !defined(__OS2__) */
448 #endif /* ndef _WIN_CONSOLE */
449 #endif /* def _WIN32 */
451 #define inline __inline
452 #endif /* def _MSC_VER */
455 #include <sys/socket.h> /* For sock_errno */
464 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
468 * LOG_LEVEL_FATAL cannot be turned off. (There are
469 * some exceptional situations where we need to get a
470 * message to the user).
472 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
474 /* where to log (default: stderr) */
475 static FILE *logfp = NULL;
477 /* logging detail level. XXX: stupid name. */
478 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
480 /* static functions */
481 static void fatal_error(const char * error_message);
483 static char *w32_socket_strerr(int errcode, char *tmp_buf);
486 static char *os2_socket_strerr(int errcode, char *tmp_buf);
489 #ifdef MUTEX_LOCKS_AVAILABLE
490 static inline void lock_logfile(void)
492 privoxy_mutex_lock(&log_mutex);
494 static inline void unlock_logfile(void)
496 privoxy_mutex_unlock(&log_mutex);
498 static inline void lock_loginit(void)
500 privoxy_mutex_lock(&log_init_mutex);
502 static inline void unlock_loginit(void)
504 privoxy_mutex_unlock(&log_init_mutex);
506 #else /* ! MUTEX_LOCKS_AVAILABLE */
508 * FIXME we need a cross-platform locking mechanism.
509 * The locking/unlocking functions below should be
510 * fleshed out for non-pthread implementations.
512 static inline void lock_logfile() {}
513 static inline void unlock_logfile() {}
514 static inline void lock_loginit() {}
515 static inline void unlock_loginit() {}
518 /*********************************************************************
520 * Function : fatal_error
522 * Description : Displays a fatal error to standard error (or, on
523 * a WIN32 GUI, to a dialog box), and exits Privoxy
524 * with status code 1.
527 * 1 : error_message = The error message to display.
529 * Returns : Does not return.
531 *********************************************************************/
532 static void fatal_error(const char *error_message)
534 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
535 /* Skip timestamp and thread id for the message box. */
536 const char *box_message = strstr(error_message, "Fatal error");
537 if (NULL == box_message)
539 /* Shouldn't happen but ... */
540 box_message = error_message;
542 MessageBox(g_hwndLogFrame, box_message, "Privoxy Error",
543 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
545 /* Cleanup - remove taskbar icon etc. */
547 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
551 fputs(error_message, logfp);
565 /*********************************************************************
567 * Function : show_version
569 * Description : Logs the Privoxy version and the program name.
572 * 1 : prog_name = The program name.
576 *********************************************************************/
577 void show_version(const char *prog_name)
579 log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
580 if (prog_name != NULL)
582 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
587 /*********************************************************************
589 * Function : init_log_module
591 * Description : Initializes the logging module to log to stderr.
592 * Can only be called while stderr hasn't been closed
593 * yet and is only supposed to be called once.
596 * 1 : prog_name = The program name.
600 *********************************************************************/
601 void init_log_module(void)
606 set_debug_level(debug);
610 /*********************************************************************
612 * Function : set_debug_level
614 * Description : Sets the debug level to the provided value
615 * plus LOG_LEVEL_MINIMUM.
617 * XXX: we should only use the LOG_LEVEL_MINIMUM
618 * until the first time the configuration file has
621 * Parameters : 1: debug_level = The debug level to set.
625 *********************************************************************/
626 void set_debug_level(int debug_level)
628 debug = debug_level | LOG_LEVEL_MINIMUM;
632 /*********************************************************************
634 * Function : disable_logging
636 * Description : Disables logging.
642 *********************************************************************/
643 void disable_logging(void)
647 log_error(LOG_LEVEL_INFO,
648 "No logfile configured. Please enable it before reporting any problems.");
657 /*********************************************************************
659 * Function : init_error_log
661 * Description : Initializes the logging module to log to a file.
663 * XXX: should be renamed.
666 * 1 : prog_name = The program name.
667 * 2 : logfname = The logfile to (re)open.
671 *********************************************************************/
672 void init_error_log(const char *prog_name, const char *logfname)
676 assert(NULL != logfname);
682 log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
685 /* set the designated log file */
686 fp = fopen(logfname, "a");
687 if ((NULL == fp) && (logfp != NULL))
690 * Some platforms (like OS/2) don't allow us to open
691 * the same file twice, therefore we give it another
692 * shot after closing the old file descriptor first.
694 * We don't do it right away because it prevents us
695 * from logging the "can't open logfile" message to
698 * XXX: this is a lame workaround and once the next
699 * release is out we should stop bothering reopening
700 * the logfile unless we have to.
702 * Currently we reopen it every time the config file
703 * has been reloaded, but actually we only have to
704 * reopen it if the file name changed or if the
705 * configuration reloas was caused by a SIGHUP.
707 log_error(LOG_LEVEL_INFO, "Failed to reopen logfile: \'%s\'. "
708 "Retrying after closing the old file descriptor first. If that "
709 "doesn't work, Privoxy will exit without being able to log a message.",
715 fp = fopen(logfname, "a");
720 log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
723 /* set logging to be completely unbuffered */
736 * Prevent the Windows GUI from showing the version two
737 * times in a row on startup. It already displayed the show_version()
738 * call from main() that other systems write to stderr.
740 * This means mingw32 users will never see the version in their
741 * log file, but I assume they wouldn't look for it there anyway
742 * and simply use the "Help/About Privoxy" menu.
744 show_version(prog_name);
745 #endif /* def unix */
749 } /* init_error_log */
752 /*********************************************************************
754 * Function : get_thread_id
756 * Description : Returns a number that is different for each thread.
758 * XXX: Should be moved elsewhere (miscutil.c?)
762 * Returns : thread_id
764 *********************************************************************/
765 static long get_thread_id(void)
767 long this_thread = 1; /* was: pthread_t this_thread;*/
771 APIRET ulrc; /* XXX: I have no clue what this does */
774 /* FIXME get current thread id */
775 #ifdef FEATURE_PTHREAD
776 this_thread = (long)pthread_self();
779 * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
780 * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
781 * pthread_t is supposed to be opaque... but it's fairly random, though, so
782 * we make it mostly presentable.
784 this_thread = abs(this_thread % 1000);
785 #endif /* def __MACH__ */
786 #elif defined(_WIN32)
787 this_thread = GetCurrentThreadId();
788 #elif defined(__OS2__)
789 ulrc = DosGetInfoBlocks(&ptib, NULL);
791 this_thread = ptib -> tib_ptib2 -> tib2_ultid;
792 #endif /* def FEATURE_PTHREAD */
798 /*********************************************************************
800 * Function : get_log_timestamp
802 * Description : Generates the time stamp for the log message prefix.
805 * 1 : buffer = Storage buffer
806 * 2 : buffer_size = Size of storage buffer
808 * Returns : Number of written characters or 0 for error.
810 *********************************************************************/
811 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
816 struct timeval tv_now; /* XXX: stupid name */
818 int msecs_length = 0;
820 gettimeofday(&tv_now, NULL);
821 msecs = tv_now.tv_usec / 1000;
825 #ifdef HAVE_LOCALTIME_R
826 tm_now = *localtime_r(&now, &tm_now);
827 #elif FEATURE_PTHREAD
828 privoxy_mutex_lock(&localtime_mutex);
829 tm_now = *localtime(&now);
830 privoxy_mutex_unlock(&localtime_mutex);
832 tm_now = *localtime(&now);
835 length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
836 if (length > (size_t)0)
838 msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
840 if (msecs_length > 0)
842 length += (size_t)msecs_length;
853 /*********************************************************************
855 * Function : get_clf_timestamp
857 * Description : Generates a Common Log Format time string.
860 * 1 : buffer = Storage buffer
861 * 2 : buffer_size = Size of storage buffer
863 * Returns : Number of written characters or 0 for error.
865 *********************************************************************/
866 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
869 * Complex because not all OSs have tm_gmtoff or
870 * the %z field in strftime()
875 #ifdef HAVE_LOCALTIME_R
884 gmt = *gmtime_r(&now, &gmt);
885 #elif FEATURE_PTHREAD
886 privoxy_mutex_lock(&gmtime_mutex);
888 privoxy_mutex_unlock(&gmtime_mutex);
892 #ifdef HAVE_LOCALTIME_R
893 tm_now = localtime_r(&now, &dummy);
894 #elif FEATURE_PTHREAD
895 privoxy_mutex_lock(&localtime_mutex);
896 tm_now = localtime(&now);
897 privoxy_mutex_unlock(&localtime_mutex);
899 tm_now = localtime(&now);
901 days = tm_now->tm_yday - gmt.tm_yday;
902 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
903 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
905 length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
907 if (length > (size_t)0)
909 tz_length = snprintf(buffer+length, buffer_size-length,
910 "%+03d%02d", mins / 60, abs(mins) % 60);
914 length += (size_t)tz_length;
925 /*********************************************************************
927 * Function : get_log_level_string
929 * Description : Translates a numerical loglevel into a string.
932 * 1 : loglevel = LOG_LEVEL_FOO
934 * Returns : Log level string.
936 *********************************************************************/
937 static inline const char *get_log_level_string(int loglevel)
939 char *log_level_string = NULL;
941 assert(0 < loglevel);
945 case LOG_LEVEL_ERROR:
946 log_level_string = "Error";
948 case LOG_LEVEL_FATAL:
949 log_level_string = "Fatal error";
952 log_level_string = "Request";
954 case LOG_LEVEL_CONNECT:
955 log_level_string = "Connect";
958 log_level_string = "Writing";
960 case LOG_LEVEL_HEADER:
961 log_level_string = "Header";
964 log_level_string = "Info";
966 case LOG_LEVEL_RE_FILTER:
967 log_level_string = "Re-Filter";
969 #ifdef FEATURE_FORCE_LOAD
970 case LOG_LEVEL_FORCE:
971 log_level_string = "Force";
973 #endif /* def FEATURE_FORCE_LOAD */
974 #ifdef FEATURE_FAST_REDIRECTS
975 case LOG_LEVEL_REDIRECTS:
976 log_level_string = "Redirect";
978 #endif /* def FEATURE_FAST_REDIRECTS */
979 case LOG_LEVEL_DEANIMATE:
980 log_level_string = "Gif-Deanimate";
982 case LOG_LEVEL_CRUNCH:
983 log_level_string = "Crunch";
986 log_level_string = "CGI";
989 log_level_string = "Unknown log level";
992 assert(NULL != log_level_string);
994 return log_level_string;
998 /*********************************************************************
1000 * Function : log_error
1002 * Description : This is the error-reporting and logging function.
1005 * 1 : loglevel = the type of message to be logged
1006 * 2 : fmt = the main string we want logged, printf-like
1007 * 3 : ... = arguments to be inserted in fmt (printf-like).
1011 *********************************************************************/
1012 void log_error(int loglevel, const char *fmt, ...)
1015 char *outbuf = NULL;
1016 static char *outbuf_save = NULL;
1017 char tempbuf[BUFFER_SIZE];
1019 const char * src = fmt;
1023 * XXX: Make this a config option,
1024 * why else do we allocate instead of using
1027 size_t log_buffer_size = BUFFER_SIZE;
1029 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1031 * Irrespective of debug setting, a GET/POST/CONNECT makes
1032 * the taskbar icon animate. (There is an option to disable
1033 * this but checking that is handled inside LogShowActivity()).
1035 if ((loglevel == LOG_LEVEL_GPC) || (loglevel == LOG_LEVEL_CRUNCH))
1039 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1042 * verify that the loglevel applies to current
1043 * settings and that logging is enabled.
1044 * Bail out otherwise.
1046 if ((0 == (loglevel & debug))
1052 if (loglevel == LOG_LEVEL_FATAL)
1054 fatal_error("Fatal error. You're not supposed to"
1055 "see this message. Please file a bug report.");
1060 thread_id = get_thread_id();
1061 get_log_timestamp(timestamp, sizeof(timestamp));
1063 /* protect the whole function because of the static buffer (outbuf) */
1066 if (NULL == outbuf_save)
1068 outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
1069 if (NULL == outbuf_save)
1071 snprintf(tempbuf, sizeof(tempbuf),
1072 "%s %08lx Fatal error: Out of memory in log_error().",
1073 timestamp, thread_id);
1074 fatal_error(tempbuf); /* Exit */
1078 outbuf = outbuf_save;
1081 * Memsetting the whole buffer to zero (in theory)
1082 * makes things easier later on.
1084 memset(outbuf, 0, log_buffer_size);
1086 /* Add prefix for everything but Common Log Format messages */
1087 if (loglevel != LOG_LEVEL_CLF)
1089 length = (size_t)snprintf(outbuf, log_buffer_size, "%s %08lx %s: ",
1090 timestamp, thread_id, get_log_level_string(loglevel));
1093 /* get ready to scan var. args. */
1096 /* build formatted message from fmt and var-args */
1097 while ((*src) && (length < log_buffer_size-2))
1099 const char *sval = NULL; /* %N string */
1100 int ival; /* %N string length or an error code */
1101 unsigned uval; /* %u value */
1102 long lval; /* %l value */
1103 unsigned long ulval; /* %ul value */
1105 const char *format_string = tempbuf;
1110 outbuf[length++] = ch;
1112 * XXX: Only necessary on platforms where multiple threads
1113 * can write to the buffer at the same time because we
1114 * don't support mutexes (OS/2 for example).
1116 outbuf[length] = '\0';
1119 outbuf[length] = '\0';
1127 ival = va_arg( ap, int );
1128 snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
1131 uval = va_arg( ap, unsigned );
1132 snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
1135 /* this is a modifier that must be followed by u, lu, or d */
1139 lval = va_arg( ap, long );
1140 snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
1144 ulval = va_arg( ap, unsigned long );
1145 snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
1147 else if ((ch == 'l') && (*src == 'u'))
1149 unsigned long long lluval = va_arg(ap, unsigned long long);
1150 snprintf(tempbuf, sizeof(tempbuf), "%llu", lluval);
1155 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1156 loglevel = LOG_LEVEL_FATAL;
1161 * Note that char paramaters are converted to int, so we need to
1162 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
1164 tempbuf[0] = (char) va_arg(ap, int);
1168 format_string = va_arg(ap, char *);
1169 if (format_string == NULL)
1171 format_string = "[null]";
1176 * Non-standard: Print a counted unterminated string.
1177 * Takes 2 parameters: int length, const char * string.
1179 ival = va_arg(ap, int);
1180 sval = va_arg(ap, char *);
1183 format_string = "[null]";
1189 /* That's ok (but stupid) */
1195 * That's not ok (and even more stupid)
1198 format_string = "[counted string lenght < 0]";
1201 else if ((size_t)ival >= sizeof(tempbuf))
1204 * String is too long, copy as much as possible.
1205 * It will be further truncated later.
1207 memcpy(tempbuf, sval, sizeof(tempbuf)-1);
1208 tempbuf[sizeof(tempbuf)-1] = '\0';
1212 memcpy(tempbuf, sval, (size_t) ival);
1213 tempbuf[ival] = '\0';
1217 /* Non-standard: Print error code from errno */
1219 ival = WSAGetLastError();
1220 format_string = w32_socket_strerr(ival, tempbuf);
1222 ival = sock_errno();
1225 format_string = os2_socket_strerr(ival, tempbuf);
1230 format_string = strerror(ival);
1232 #else /* ifndef _WIN32 */
1234 #ifdef HAVE_STRERROR
1235 format_string = strerror(ival);
1236 #else /* ifndef HAVE_STRERROR */
1237 format_string = NULL;
1238 #endif /* ndef HAVE_STRERROR */
1241 snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
1243 #endif /* ndef _WIN32 */
1246 /* Non-standard: Print a Common Log File timestamp */
1247 get_clf_timestamp(tempbuf, sizeof(tempbuf));
1250 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1251 loglevel = LOG_LEVEL_FATAL;
1255 assert(length < log_buffer_size);
1256 length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
1258 if (length >= log_buffer_size-2)
1260 static char warning[] = "... [too long, truncated]";
1262 length = log_buffer_size - sizeof(warning) - 1;
1263 length += strlcpy(outbuf + length, warning, log_buffer_size - length);
1264 assert(length < log_buffer_size);
1268 } /* for( p ... ) */
1270 /* done with var. args */
1273 assert(length < log_buffer_size);
1274 length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
1276 /* Some sanity checks */
1277 if ((length >= log_buffer_size)
1278 || (outbuf[log_buffer_size-1] != '\0')
1279 || (outbuf[log_buffer_size] != '\0')
1282 /* Repeat as assertions */
1283 assert(length < log_buffer_size);
1284 assert(outbuf[log_buffer_size-1] == '\0');
1286 * outbuf's real size is log_buffer_size+1,
1287 * so while this looks like an off-by-one,
1288 * we're only checking our paranoia byte.
1290 assert(outbuf[log_buffer_size] == '\0');
1292 snprintf(outbuf, log_buffer_size,
1293 "%s %08lx Fatal error: log_error()'s sanity checks failed."
1294 "length: %d. Exiting.",
1295 timestamp, thread_id, (int)length);
1296 loglevel = LOG_LEVEL_FATAL;
1301 * On Windows this is acceptable in case
1302 * we are logging to the GUI window only.
1304 assert(NULL != logfp);
1307 if (loglevel == LOG_LEVEL_FATAL)
1309 fatal_error(outbuf_save);
1310 /* Never get here */
1314 fputs(outbuf_save, logfp);
1317 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1318 /* Write to display */
1319 LogPutString(outbuf_save);
1320 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1327 /*********************************************************************
1329 * Function : jb_err_to_string
1331 * Description : Translates JB_ERR_FOO codes into strings.
1333 * XXX: the type of error codes is jb_err
1334 * but the typedef'inition is currently not
1335 * visible to all files that include errlog.h.
1338 * 1 : error = a valid jb_err code
1340 * Returns : A string with the jb_err translation
1342 *********************************************************************/
1343 const char *jb_err_to_string(int error)
1348 return "Success, no error";
1350 return "Out of memory";
1351 case JB_ERR_CGI_PARAMS:
1352 return "Missing or corrupt CGI parameters";
1354 return "Error opening, reading or writing a file";
1356 return "Parse error";
1357 case JB_ERR_MODIFIED:
1358 return "File has been modified outside of the CGI actions editor.";
1359 case JB_ERR_COMPRESS:
1360 return "(De)compression failure";
1363 return "Unknown error";
1366 return "Internal error";
1370 /*********************************************************************
1372 * Function : w32_socket_strerr
1374 * Description : Translate the return value from WSAGetLastError()
1378 * 1 : errcode = The return value from WSAGetLastError().
1379 * 2 : tmp_buf = A temporary buffer that might be used to
1382 * Returns : String representing the error code. This may be
1383 * a global string constant or a string stored in
1386 *********************************************************************/
1387 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1389 #define TEXT_FOR_ERROR(code,text) \
1390 if (errcode == code) \
1392 return #code " - " text; \
1395 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1396 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1397 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1398 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1399 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1400 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1401 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1402 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1403 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1404 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1405 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1406 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1407 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1408 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1409 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1410 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1411 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1412 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1413 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1414 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1415 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1416 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1417 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1418 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1419 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1420 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1421 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1422 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1423 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1424 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1425 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1426 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1427 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1428 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1429 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1430 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1431 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1432 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1433 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1434 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1435 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1436 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1438 * The following error codes are documented in the Microsoft WinSock
1439 * reference guide, but don't actually exist.
1441 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1442 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1443 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1444 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1445 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1446 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1447 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1448 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1449 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1450 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1453 sprintf(tmp_buf, "(error number %d)", errcode);
1456 #endif /* def _WIN32 */
1460 /*********************************************************************
1462 * Function : os2_socket_strerr
1464 * Description : Translate the return value from sock_errno()
1468 * 1 : errcode = The return value from sock_errno().
1469 * 2 : tmp_buf = A temporary buffer that might be used to
1472 * Returns : String representing the error code. This may be
1473 * a global string constant or a string stored in
1476 *********************************************************************/
1477 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1479 #define TEXT_FOR_ERROR(code,text) \
1480 if (errcode == code) \
1482 return #code " - " text; \
1485 TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
1486 TEXT_FOR_ERROR(SOCESRCH , "No such process.")
1487 TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
1488 TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
1489 TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
1490 TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
1491 TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
1492 TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
1493 TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
1494 TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
1495 TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
1496 TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
1497 TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
1498 TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
1499 TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
1500 TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
1501 TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
1502 TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
1503 TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1504 TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1505 TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
1506 TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
1507 TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
1508 TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
1509 TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
1510 TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
1511 TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
1512 TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
1513 TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
1514 TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
1515 TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
1516 TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
1517 TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
1518 TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
1519 TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
1520 TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
1521 TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
1522 TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
1523 TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
1524 TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
1525 TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
1526 TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
1527 TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
1529 sprintf(tmp_buf, "(error number %d)", errcode);
1532 #endif /* def __OS2__ */