1 const char errlog_rcs[] = "$Id: errlog.c,v 1.77 2008/09/07 12:43:44 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.77 2008/09/07 12:43:44 fabiankeil
37 * Move the LogPutString() call in log_error() into the locked
38 * region so the Windows GUI log is consistent with the logfile.
40 * Revision 1.76 2008/09/07 12:35:05 fabiankeil
41 * Add mutex lock support for _WIN32.
43 * Revision 1.75 2008/09/04 08:13:58 fabiankeil
44 * Prepare for critical sections on Windows by adding a
45 * layer of indirection before the pthread mutex functions.
47 * Revision 1.74 2008/08/06 18:33:36 fabiankeil
48 * If the "close fd first" workaround doesn't work,
49 * the fatal error message will be lost, so we better
50 * explain the consequences while we still can.
52 * Revision 1.73 2008/08/04 19:06:55 fabiankeil
53 * Add a lame workaround for the "can't open an already open
54 * logfile on OS/2" problem reported by Maynard in #2028842
55 * and describe what a real solution would look like.
57 * Revision 1.72 2008/07/27 12:04:28 fabiankeil
60 * Revision 1.71 2008/06/28 17:17:15 fabiankeil
61 * Remove another stray semicolon.
63 * Revision 1.70 2008/06/28 17:10:29 fabiankeil
64 * Remove stray semicolon in get_log_timestamp().
65 * Reported by Jochen Voss in #2005221.
67 * Revision 1.69 2008/05/30 15:55:25 fabiankeil
68 * Declare variable "debug" static and complain about its name.
70 * Revision 1.68 2008/04/27 16:50:46 fabiankeil
71 * Remove an incorrect assertion. The value of debug may change if
72 * the configuration is reloaded in another thread. While we could
73 * cache the initial value, the assertion doesn't seem worth it.
75 * Revision 1.67 2008/03/27 18:27:23 fabiankeil
76 * Remove kill-popups action.
78 * Revision 1.66 2008/01/31 15:38:14 fabiankeil
79 * - Make the logfp assertion more strict. As of 1.63, the "||" could
80 * have been an "&&", which means we can use two separate assertions
81 * and skip on of them on Windows.
82 * - Break a long commit message line in two.
84 * Revision 1.65 2008/01/31 14:44:33 fabiankeil
85 * Use (a != b) instead of !(a == b) so the sanity check looks less insane.
87 * Revision 1.64 2008/01/21 18:56:46 david__schmidt
88 * Swap #def from negative to positive, re-joined it so it didn't
89 * span an assertion (compilation failure on OS/2)
91 * Revision 1.63 2007/12/15 19:49:32 fabiankeil
92 * Stop overloading logfile to control the mingw32 log window as well.
93 * It's no longer necessary now that we disable all debug lines by default
94 * and at least one user perceived it as a regression (added in 1.55).
96 * Revision 1.62 2007/11/30 15:33:46 fabiankeil
97 * Unbreak LOG_LEVEL_FATAL. It wasn't fatal with logging disabled
98 * and on mingw32 fatal log messages didn't end up in the log file.
100 * Revision 1.61 2007/11/04 19:03:01 fabiankeil
101 * Fix another deadlock Hal spotted and that mysteriously didn't affect FreeBSD.
103 * Revision 1.60 2007/11/03 19:03:31 fabiankeil
104 * - Prevent the Windows GUI from showing the version two times in a row.
105 * - Stop using the imperative in the "(Re-)Open logfile" message.
106 * - Ditch the "Switching to daemon mode" message as the detection
107 * whether or not we're already in daemon mode doesn't actually work.
109 * Revision 1.59 2007/11/01 12:50:56 fabiankeil
110 * Here's looking at you, deadlock.
112 * Revision 1.58 2007/10/28 19:04:21 fabiankeil
113 * Don't mention daemon mode in "Logging disabled" message. Some
114 * platforms call it differently and it's not really relevant anyway.
116 * Revision 1.57 2007/10/27 13:02:26 fabiankeil
117 * Relocate daemon-mode-related log messages to make sure
118 * they aren't shown again in case of configuration reloads.
120 * Revision 1.56 2007/10/14 14:26:56 fabiankeil
121 * Remove the old log_error() version.
123 * Revision 1.55 2007/10/14 14:12:41 fabiankeil
124 * When in daemon mode, close stderr after the configuration file has been
125 * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
127 * Revision 1.54 2007/09/22 16:15:34 fabiankeil
128 * - Let it compile with pcc.
129 * - Move our includes below system includes to prevent macro conflicts.
131 * Revision 1.53 2007/08/05 13:53:14 fabiankeil
132 * #1763173 from Stefan Huehner: declare some more functions
133 * static and use void instead of empty parameter lists.
135 * Revision 1.52 2007/07/14 07:28:47 fabiankeil
136 * Add translation function for JB_ERR_FOO codes.
138 * Revision 1.51 2007/05/11 11:51:34 fabiankeil
139 * Fix a type mismatch warning.
141 * Revision 1.50 2007/04/11 10:55:44 fabiankeil
142 * Enforce some assertions that could be triggered
143 * on mingw32 and other systems where we use threads
146 * Revision 1.49 2007/04/08 16:44:15 fabiankeil
147 * We need <sys/time.h> for gettimeofday(), not <time.h>.
149 * Revision 1.48 2007/03/31 13:33:28 fabiankeil
150 * Add alternative log_error() with timestamps
151 * that contain milliseconds and without using
152 * strcpy(), strcat() or sprintf().
154 * Revision 1.47 2006/11/28 15:25:15 fabiankeil
155 * Only unlink the pidfile if it's actually used.
157 * Revision 1.46 2006/11/13 19:05:51 fabiankeil
158 * Make pthread mutex locking more generic. Instead of
159 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
160 * and use mutex locking unless there is an _r function
161 * available. Better safe than sorry.
163 * Fixes "./configure --disable-pthread" and should result
164 * in less threading-related problems on pthread-using platforms,
165 * but it still doesn't fix BR#1122404.
167 * Revision 1.45 2006/08/21 11:15:54 david__schmidt
168 * MS Visual C++ build updates
170 * Revision 1.44 2006/08/18 16:03:16 david__schmidt
171 * Tweak for OS/2 build happiness.
173 * Revision 1.43 2006/08/03 02:46:41 david__schmidt
174 * Incorporate Fabian Keil's patch work:
175 * http://www.fabiankeil.de/sourcecode/privoxy/
177 * Revision 1.42 2006/07/18 14:48:46 david__schmidt
178 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
179 * with what was really the latest development (the v_3_0_branch branch)
181 * Revision 1.40.2.4 2005/04/03 20:10:50 david__schmidt
182 * Thanks to Jindrich Makovicka for a race condition fix for the log
183 * file. The race condition remains for non-pthread implementations.
184 * Reference patch #1175720.
186 * Revision 1.40.2.3 2003/03/07 03:41:04 david__schmidt
187 * Wrapping all *_r functions (the non-_r versions of them) with mutex
188 * semaphores for OSX. Hopefully this will take care of all of those pesky
191 * Revision 1.40.2.2 2002/09/28 00:30:57 david__schmidt
192 * Update error logging to give sane values for thread IDs on Mach kernels.
193 * It's still a hack, but at least it looks farily normal. We print the
194 * absolute value of the first 4 bytes of the pthread_t modded with 1000.
196 * Revision 1.40.2.1 2002/09/25 12:47:42 oes
197 * Make log_error safe against NULL string arguments
199 * Revision 1.40 2002/05/22 01:27:27 david__schmidt
201 * Add os2_socket_strerr mirroring w32_socket_strerr.
203 * Revision 1.39 2002/04/03 17:15:27 gliptak
204 * zero padding thread ids in log
206 * Revision 1.38 2002/03/31 17:18:59 jongfoster
207 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
209 * Revision 1.37 2002/03/27 14:32:43 david__schmidt
210 * More compiler warning message maintenance
212 * Revision 1.36 2002/03/26 22:29:54 swa
213 * we have a new homepage!
215 * Revision 1.35 2002/03/24 15:23:33 jongfoster
218 * Revision 1.34 2002/03/24 13:25:43 swa
219 * name change related issues
221 * Revision 1.33 2002/03/13 00:27:04 jongfoster
224 * Revision 1.32 2002/03/07 03:46:17 oes
225 * Fixed compiler warnings
227 * Revision 1.31 2002/03/06 23:02:57 jongfoster
230 * Revision 1.30 2002/03/05 22:43:45 david__schmidt
231 * - Better error reporting on OS/2
232 * - Fix double-slash comment (oops)
234 * Revision 1.29 2002/03/04 23:45:13 jongfoster
235 * Printing thread ID if using Win32 native threads
237 * Revision 1.28 2002/03/04 17:59:59 oes
238 * Deleted deletePidFile(), cosmetics
240 * Revision 1.27 2002/03/04 02:08:01 david__schmidt
241 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
243 * Revision 1.26 2002/01/09 19:05:45 steudten
244 * Fix big memory leak.
246 * Revision 1.25 2002/01/09 14:32:08 oes
247 * Added support for gmtime_r and localtime_r.
249 * Revision 1.24 2001/12/30 14:07:32 steudten
250 * - Add signal handling (unix)
251 * - Add SIGHUP handler (unix)
252 * - Add creation of pidfile (unix)
253 * - Add action 'top' in rc file (RH)
254 * - Add entry 'SIGNALS' to manpage
255 * - Add exit message to logfile (unix)
257 * Revision 1.23 2001/11/07 00:02:13 steudten
258 * Add line number in error output for lineparsing for
259 * actionsfile and configfile.
260 * Special handling for CLF added.
262 * Revision 1.22 2001/11/05 23:43:05 steudten
263 * Add time+date to log files.
265 * Revision 1.21 2001/10/25 03:40:47 david__schmidt
266 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
267 * threads to call select() simultaneously. So, it's time to do a real, live,
268 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
269 * (native). Both versions will work, but using __OS2__ offers multi-threading.
271 * Revision 1.20 2001/09/16 23:04:34 jongfoster
274 * Revision 1.19 2001/09/13 20:08:06 jongfoster
275 * Adding support for LOG_LEVEL_CGI
277 * Revision 1.18 2001/09/10 11:27:24 oes
278 * Declaration of w32_socket_strerr now conditional
280 * Revision 1.17 2001/09/10 10:17:13 oes
281 * Removed unused variable; Fixed sprintf format
283 * Revision 1.16 2001/07/30 22:08:36 jongfoster
284 * Tidying up #defines:
285 * - All feature #defines are now of the form FEATURE_xxx
286 * - Permanently turned off WIN_GUI_EDIT
287 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
289 * Revision 1.15 2001/07/29 17:41:10 jongfoster
290 * Now prints thread ID for each message (pthreads only)
292 * Revision 1.14 2001/07/19 19:03:48 haroon
293 * - Added case for LOG_LEVEL_POPUPS
295 * Revision 1.13 2001/07/13 13:58:58 oes
296 * - Added case for LOG_LEVEL_DEANIMATE
297 * - Removed all #ifdef PCRS
299 * Revision 1.12 2001/06/09 10:55:28 jongfoster
300 * Changing BUFSIZ ==> BUFFER_SIZE
302 * Revision 1.11 2001/06/01 18:14:49 jongfoster
303 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
304 * in config.h if appropriate) rather than the NO_STRERR macro.
306 * Revision 1.10 2001/05/29 11:52:21 oes
307 * Conditional compilation of w32_socket_error
309 * Revision 1.9 2001/05/28 16:15:17 jongfoster
310 * Improved reporting of errors under Win32.
312 * Revision 1.8 2001/05/26 17:25:14 jongfoster
313 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
315 * Revision 1.7 2001/05/26 15:21:28 jongfoster
316 * Activity animation in Win32 GUI now works even if debug==0
318 * Revision 1.6 2001/05/25 21:55:08 jongfoster
319 * Now cleans up properly on FATAL (removes taskbar icon etc)
321 * Revision 1.5 2001/05/22 18:46:04 oes
323 * - Enabled filtering banners by size rather than URL
324 * by adding patterns that replace all standard banner
325 * sizes with the "Junkbuster" gif to the re_filterfile
327 * - Enabled filtering WebBugs by providing a pattern
328 * which kills all 1x1 images
330 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
331 * which is selected by the (nonstandard and therefore
332 * capital) letter 'U' in the option string.
333 * It causes the quantifiers to be ungreedy by default.
334 * Appending a ? turns back to greedy (!).
336 * - Added a new interceptor ijb-send-banner, which
337 * sends back the "Junkbuster" gif. Without imagelist or
338 * MSIE detection support, or if tinygif = 1, or the
339 * URL isn't recognized as an imageurl, a lame HTML
340 * explanation is sent instead.
342 * - Added new feature, which permits blocking remote
343 * script redirects and firing back a local redirect
345 * The feature is conditionally compiled, i.e. it
346 * can be disabled with --disable-fast-redirects,
347 * plus it must be activated by a "fast-redirects"
348 * line in the config file, has its own log level
349 * and of course wants to be displayed by show-proxy-args
350 * Note: Boy, all the #ifdefs in 1001 locations and
351 * all the fumbling with configure.in and acconfig.h
352 * were *way* more work than the feature itself :-(
354 * - Because a generic redirect template was needed for
355 * this, tinygif = 3 now uses the same.
357 * - Moved GIFs, and other static HTTP response templates
362 * - Removed some >400 CRs again (Jon, you really worked
365 * Revision 1.4 2001/05/21 19:32:54 jongfoster
366 * Added another #ifdef _WIN_CONSOLE
368 * Revision 1.3 2001/05/20 01:11:40 jongfoster
369 * Added support for LOG_LEVEL_FATAL
370 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
371 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
373 * Revision 1.2 2001/05/17 22:42:01 oes
374 * - Cleaned CRLF's from the sources and related files
375 * - Repaired logging for REF and FRC
377 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
378 * Initial import of version 2.9.3 source tree
381 *********************************************************************/
390 #include "miscutil.h"
392 /* For gettimeofday() */
393 #include <sys/time.h>
395 #if !defined(_WIN32) && !defined(__OS2__)
397 #endif /* !defined(_WIN32) && !defined(__OS2__) */
409 #endif /* ndef _WIN_CONSOLE */
410 #endif /* def _WIN32 */
412 #define inline __inline
413 #endif /* def _MSC_VER */
416 #include <sys/socket.h> /* For sock_errno */
425 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
429 * LOG_LEVEL_FATAL cannot be turned off. (There are
430 * some exceptional situations where we need to get a
431 * message to the user).
433 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
435 /* where to log (default: stderr) */
436 static FILE *logfp = NULL;
438 /* logging detail level. XXX: stupid name. */
439 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
441 /* static functions */
442 static void fatal_error(const char * error_message);
444 static char *w32_socket_strerr(int errcode, char *tmp_buf);
447 static char *os2_socket_strerr(int errcode, char *tmp_buf);
450 #ifdef MUTEX_LOCKS_AVAILABLE
451 static inline void lock_logfile(void)
453 privoxy_mutex_lock(&log_mutex);
455 static inline void unlock_logfile(void)
457 privoxy_mutex_unlock(&log_mutex);
459 static inline void lock_loginit(void)
461 privoxy_mutex_lock(&log_init_mutex);
463 static inline void unlock_loginit(void)
465 privoxy_mutex_unlock(&log_init_mutex);
467 #else /* ! MUTEX_LOCKS_AVAILABLE */
469 * FIXME we need a cross-platform locking mechanism.
470 * The locking/unlocking functions below should be
471 * fleshed out for non-pthread implementations.
473 static inline void lock_logfile() {}
474 static inline void unlock_logfile() {}
475 static inline void lock_loginit() {}
476 static inline void unlock_loginit() {}
479 /*********************************************************************
481 * Function : fatal_error
483 * Description : Displays a fatal error to standard error (or, on
484 * a WIN32 GUI, to a dialog box), and exits
485 * JunkBuster with status code 1.
488 * 1 : error_message = The error message to display.
490 * Returns : Does not return.
492 *********************************************************************/
493 static void fatal_error(const char * error_message)
495 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
496 MessageBox(g_hwndLogFrame, error_message, "Privoxy Error",
497 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
499 /* Cleanup - remove taskbar icon etc. */
501 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
505 fputs(error_message, logfp);
519 /*********************************************************************
521 * Function : show_version
523 * Description : Logs the Privoxy version and the program name.
526 * 1 : prog_name = The program name.
530 *********************************************************************/
531 static void show_version(const char *prog_name)
533 log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
534 if (prog_name != NULL)
536 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
541 /*********************************************************************
543 * Function : init_log_module
545 * Description : Initializes the logging module to log to stderr.
546 * Can only be called while stderr hasn't been closed
547 * yet and is only supposed to be called once.
550 * 1 : prog_name = The program name.
554 *********************************************************************/
555 void init_log_module(const char *prog_name)
560 set_debug_level(debug);
561 show_version(prog_name);
565 /*********************************************************************
567 * Function : set_debug_level
569 * Description : Sets the debug level to the provided value
570 * plus LOG_LEVEL_MINIMUM.
572 * XXX: we should only use the LOG_LEVEL_MINIMUM
573 * until the first time the configuration file has
576 * Parameters : 1: debug_level = The debug level to set.
580 *********************************************************************/
581 void set_debug_level(int debug_level)
583 debug = debug_level | LOG_LEVEL_MINIMUM;
587 /*********************************************************************
589 * Function : disable_logging
591 * Description : Disables logging.
597 *********************************************************************/
598 void disable_logging(void)
602 log_error(LOG_LEVEL_INFO,
603 "No logfile configured. Please enable it before reporting any problems.");
612 /*********************************************************************
614 * Function : init_error_log
616 * Description : Initializes the logging module to log to a file.
618 * XXX: should be renamed.
621 * 1 : prog_name = The program name.
622 * 2 : logfname = The logfile name, or NULL for stderr.
623 * 3 : debuglevel = The debugging level.
627 *********************************************************************/
628 void init_error_log(const char *prog_name, const char *logfname)
632 assert(NULL != logfname);
638 log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
641 /* set the designated log file */
642 fp = fopen(logfname, "a");
643 if ((NULL == fp) && (logfp != NULL))
646 * Some platforms (like OS/2) don't allow us to open
647 * the same file twice, therefore we give it another
648 * shot after closing the old file descriptor first.
650 * We don't do it right away because it prevents us
651 * from logging the "can't open logfile" message to
654 * XXX: this is a lame workaround and once the next
655 * release is out we should stop bothering reopening
656 * the logfile unless we have to.
658 * Currently we reopen it every time the config file
659 * has been reloaded, but actually we only have to
660 * reopen it if the file name changed or if the
661 * configuration reloas was caused by a SIGHUP.
663 log_error(LOG_LEVEL_INFO, "Failed to reopen logfile: \'%s\'. "
664 "Retrying after closing the old file descriptor first. If that "
665 "doesn't work, Privoxy will exit without being able to log a message.",
671 fp = fopen(logfname, "a");
676 log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
679 /* set logging to be completely unbuffered */
692 * Prevent the Windows GUI from showing the version two
693 * times in a row on startup. It already displayed the show_version()
694 * call from init_log_module() that other systems write to stderr.
696 * This means mingw32 users will never see the version in their
697 * log file, but I assume they wouldn't look for it there anyway
698 * and simply use the "Help/About Privoxy" menu.
700 show_version(prog_name);
701 #endif /* def unix */
705 } /* init_error_log */
708 /*********************************************************************
710 * Function : get_thread_id
712 * Description : Returns a number that is different for each thread.
714 * XXX: Should be moved elsewhere (miscutil.c?)
718 * Returns : thread_id
720 *********************************************************************/
721 static long get_thread_id(void)
723 long this_thread = 1; /* was: pthread_t this_thread;*/
727 APIRET ulrc; /* XXX: I have no clue what this does */
730 /* FIXME get current thread id */
731 #ifdef FEATURE_PTHREAD
732 this_thread = (long)pthread_self();
735 * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
736 * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
737 * pthread_t is supposed to be opaque... but it's fairly random, though, so
738 * we make it mostly presentable.
740 this_thread = abs(this_thread % 1000);
741 #endif /* def __MACH__ */
742 #elif defined(_WIN32)
743 this_thread = GetCurrentThreadId();
744 #elif defined(__OS2__)
745 ulrc = DosGetInfoBlocks(&ptib, NULL);
747 this_thread = ptib -> tib_ptib2 -> tib2_ultid;
748 #endif /* def FEATURE_PTHREAD */
754 /*********************************************************************
756 * Function : get_log_timestamp
758 * Description : Generates the time stamp for the log message prefix.
761 * 1 : buffer = Storage buffer
762 * 2 : buffer_size = Size of storage buffer
764 * Returns : Number of written characters or 0 for error.
766 *********************************************************************/
767 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
772 struct timeval tv_now; /* XXX: stupid name */
774 int msecs_length = 0;
776 gettimeofday(&tv_now, NULL);
777 msecs = tv_now.tv_usec / 1000;
781 #ifdef HAVE_LOCALTIME_R
782 tm_now = *localtime_r(&now, &tm_now);
783 #elif FEATURE_PTHREAD
784 privoxy_mutex_lock(&localtime_mutex);
785 tm_now = *localtime(&now);
786 privoxy_mutex_unlock(&localtime_mutex);
788 tm_now = *localtime(&now);
791 length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
794 msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
796 if (msecs_length > 0)
798 length += (size_t)msecs_length;
809 /*********************************************************************
811 * Function : get_clf_timestamp
813 * Description : Generates a Common Log Format time string.
816 * 1 : buffer = Storage buffer
817 * 2 : buffer_size = Size of storage buffer
819 * Returns : Number of written characters or 0 for error.
821 *********************************************************************/
822 static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
825 * Complex because not all OSs have tm_gmtoff or
826 * the %z field in strftime()
831 #ifdef HAVE_LOCALTIME_R
840 gmt = *gmtime_r(&now, &gmt);
841 #elif FEATURE_PTHREAD
842 privoxy_mutex_lock(&gmtime_mutex);
844 privoxy_mutex_unlock(&gmtime_mutex);
848 #ifdef HAVE_LOCALTIME_R
849 tm_now = localtime_r(&now, &dummy);
850 #elif FEATURE_PTHREAD
851 privoxy_mutex_lock(&localtime_mutex);
852 tm_now = localtime(&now);
853 privoxy_mutex_unlock(&localtime_mutex);
855 tm_now = localtime(&now);
857 days = tm_now->tm_yday - gmt.tm_yday;
858 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
859 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
861 length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
865 tz_length = snprintf(buffer+length, buffer_size-length,
866 "%+03d%02d", mins / 60, abs(mins) % 60);
870 length += (size_t)tz_length;
881 /*********************************************************************
883 * Function : get_log_level_string
885 * Description : Translates a numerical loglevel into a string.
888 * 1 : loglevel = LOG_LEVEL_FOO
890 * Returns : Log level string.
892 *********************************************************************/
893 static inline const char *get_log_level_string(int loglevel)
895 char *log_level_string = NULL;
897 assert(0 < loglevel);
901 case LOG_LEVEL_ERROR:
902 log_level_string = "Error";
904 case LOG_LEVEL_FATAL:
905 log_level_string = "Fatal error";
908 log_level_string = "Request";
910 case LOG_LEVEL_CONNECT:
911 log_level_string = "Connect";
914 log_level_string = "Writing";
916 case LOG_LEVEL_HEADER:
917 log_level_string = "Header";
920 log_level_string = "Info";
922 case LOG_LEVEL_RE_FILTER:
923 log_level_string = "Re-Filter";
925 #ifdef FEATURE_FORCE_LOAD
926 case LOG_LEVEL_FORCE:
927 log_level_string = "Force";
929 #endif /* def FEATURE_FORCE_LOAD */
930 #ifdef FEATURE_FAST_REDIRECTS
931 case LOG_LEVEL_REDIRECTS:
932 log_level_string = "Redirect";
934 #endif /* def FEATURE_FAST_REDIRECTS */
935 case LOG_LEVEL_DEANIMATE:
936 log_level_string = "Gif-Deanimate";
939 log_level_string = "CGI";
942 log_level_string = "Unknown log level";
945 assert(NULL != log_level_string);
947 return log_level_string;
951 /*********************************************************************
953 * Function : log_error
955 * Description : This is the error-reporting and logging function.
958 * 1 : loglevel = the type of message to be logged
959 * 2 : fmt = the main string we want logged, printf-like
960 * 3 : ... = arguments to be inserted in fmt (printf-like).
964 *********************************************************************/
965 void log_error(int loglevel, const char *fmt, ...)
969 static char *outbuf_save = NULL;
970 char tempbuf[BUFFER_SIZE];
972 const char * src = fmt;
976 * XXX: Make this a config option,
977 * why else do we allocate instead of using
980 size_t log_buffer_size = BUFFER_SIZE;
982 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
984 * Irrespective of debug setting, a GET/POST/CONNECT makes
985 * the taskbar icon animate. (There is an option to disable
986 * this but checking that is handled inside LogShowActivity()).
988 if (loglevel == LOG_LEVEL_GPC)
992 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
995 * verify that the loglevel applies to current
996 * settings and that logging is enabled.
997 * Bail out otherwise.
999 if ((0 == (loglevel & debug))
1008 thread_id = get_thread_id();
1009 get_log_timestamp(timestamp, sizeof(timestamp));
1011 /* protect the whole function because of the static buffer (outbuf) */
1014 if (NULL == outbuf_save)
1016 outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
1017 if (NULL == outbuf_save)
1019 snprintf(tempbuf, sizeof(tempbuf),
1020 "%s Privoxy(%08lx) Fatal error: log_error() failed to allocate buffer memory.\n"
1021 "\nExiting.", timestamp, thread_id);
1022 fatal_error(tempbuf); /* Exit */
1025 outbuf = outbuf_save;
1028 * Memsetting the whole buffer to zero (in theory)
1029 * makes things easier later on.
1031 memset(outbuf, 0, log_buffer_size);
1033 /* Add prefix for everything but Common Log Format messages */
1034 if (loglevel != LOG_LEVEL_CLF)
1036 length = (size_t)snprintf(outbuf, log_buffer_size, "%s Privoxy(%08lx) %s: ",
1037 timestamp, thread_id, get_log_level_string(loglevel));
1040 /* get ready to scan var. args. */
1043 /* build formatted message from fmt and var-args */
1044 while ((*src) && (length < log_buffer_size-2))
1046 const char *sval = NULL; /* %N string */
1047 int ival; /* %N string length or an error code */
1048 unsigned uval; /* %u value */
1049 long lval; /* %l value */
1050 unsigned long ulval; /* %ul value */
1052 const char *format_string = tempbuf;
1057 outbuf[length++] = ch;
1059 * XXX: Only necessary on platforms where multiple threads
1060 * can write to the buffer at the same time because we
1061 * don't support mutexes (OS/2 for example).
1063 outbuf[length] = '\0';
1066 outbuf[length] = '\0';
1074 ival = va_arg( ap, int );
1075 snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
1078 uval = va_arg( ap, unsigned );
1079 snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
1082 /* this is a modifier that must be followed by u or d */
1086 lval = va_arg( ap, long );
1087 snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
1091 ulval = va_arg( ap, unsigned long );
1092 snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
1096 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1097 loglevel = LOG_LEVEL_FATAL;
1102 * Note that char paramaters are converted to int, so we need to
1103 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
1105 tempbuf[0] = (char) va_arg(ap, int);
1109 format_string = va_arg(ap, char *);
1110 if (format_string == NULL)
1112 format_string = "[null]";
1117 * Non-standard: Print a counted unterminated string.
1118 * Takes 2 parameters: int length, const char * string.
1120 ival = va_arg(ap, int);
1121 sval = va_arg(ap, char *);
1124 format_string = "[null]";
1130 /* That's ok (but stupid) */
1136 * That's not ok (and even more stupid)
1139 format_string = "[counted string lenght < 0]";
1142 else if (ival >= sizeof(tempbuf))
1145 * String is too long, copy as much as possible.
1146 * It will be further truncated later.
1148 memcpy(tempbuf, sval, sizeof(tempbuf)-1);
1149 tempbuf[sizeof(tempbuf)-1] = '\0';
1153 memcpy(tempbuf, sval, (size_t) ival);
1154 tempbuf[ival] = '\0';
1158 /* Non-standard: Print error code from errno */
1160 ival = WSAGetLastError();
1161 format_string = w32_socket_strerr(ival, tempbuf);
1163 ival = sock_errno();
1166 format_string = os2_socket_strerr(ival, tempbuf);
1171 format_string = strerror(ival);
1173 #else /* ifndef _WIN32 */
1175 #ifdef HAVE_STRERROR
1176 format_string = strerror(ival);
1177 #else /* ifndef HAVE_STRERROR */
1178 format_string = NULL;
1179 #endif /* ndef HAVE_STRERROR */
1182 snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
1184 #endif /* ndef _WIN32 */
1187 /* Non-standard: Print a Common Log File timestamp */
1188 get_clf_timestamp(tempbuf, sizeof(tempbuf));
1191 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1192 loglevel = LOG_LEVEL_FATAL;
1196 assert(length < log_buffer_size);
1197 length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
1199 if (length >= log_buffer_size-2)
1201 static char warning[] = "... [too long, truncated]";
1203 length = log_buffer_size - sizeof(warning) - 1;
1204 length += strlcpy(outbuf + length, warning, log_buffer_size - length);
1205 assert(length < log_buffer_size);
1209 } /* for( p ... ) */
1211 /* done with var. args */
1214 assert(length < log_buffer_size);
1215 length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
1217 /* Some sanity checks */
1218 if ((length >= log_buffer_size)
1219 || (outbuf[log_buffer_size-1] != '\0')
1220 || (outbuf[log_buffer_size] != '\0')
1223 /* Repeat as assertions */
1224 assert(length < log_buffer_size);
1225 assert(outbuf[log_buffer_size-1] == '\0');
1227 * outbuf's real size is log_buffer_size+1,
1228 * so while this looks like an off-by-one,
1229 * we're only checking our paranoia byte.
1231 assert(outbuf[log_buffer_size] == '\0');
1233 snprintf(outbuf, log_buffer_size,
1234 "%s Privoxy(%08lx) Fatal error: log_error()'s sanity checks failed. length: %d\n"
1235 "Exiting.", timestamp, thread_id, (int)length);
1236 loglevel = LOG_LEVEL_FATAL;
1241 * On Windows this is acceptable in case
1242 * we are logging to the GUI window only.
1244 assert(NULL != logfp);
1247 if (loglevel == LOG_LEVEL_FATAL)
1249 fatal_error(outbuf_save);
1250 /* Never get here */
1254 fputs(outbuf_save, logfp);
1257 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1258 /* Write to display */
1259 LogPutString(outbuf_save);
1260 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1267 /*********************************************************************
1269 * Function : jb_err_to_string
1271 * Description : Translates JB_ERR_FOO codes into strings.
1273 * XXX: the type of error codes is jb_err
1274 * but the typedef'inition is currently not
1275 * visible to all files that include errlog.h.
1278 * 1 : error = a valid jb_err code
1280 * Returns : A string with the jb_err translation
1282 *********************************************************************/
1283 const char *jb_err_to_string(int error)
1288 return "Success, no error";
1290 return "Out of memory";
1291 case JB_ERR_CGI_PARAMS:
1292 return "Missing or corrupt CGI parameters";
1294 return "Error opening, reading or writing a file";
1296 return "Parse error";
1297 case JB_ERR_MODIFIED:
1298 return "File has been modified outside of the CGI actions editor.";
1299 case JB_ERR_COMPRESS:
1300 return "(De)compression failure";
1303 return "Unknown error";
1306 return "Internal error";
1310 /*********************************************************************
1312 * Function : w32_socket_strerr
1314 * Description : Translate the return value from WSAGetLastError()
1318 * 1 : errcode = The return value from WSAGetLastError().
1319 * 2 : tmp_buf = A temporary buffer that might be used to
1322 * Returns : String representing the error code. This may be
1323 * a global string constant or a string stored in
1326 *********************************************************************/
1327 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1329 #define TEXT_FOR_ERROR(code,text) \
1330 if (errcode == code) \
1332 return #code " - " text; \
1335 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1336 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1337 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1338 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1339 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1340 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1341 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1342 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1343 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1344 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1345 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1346 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1347 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1348 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1349 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1350 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1351 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1352 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1353 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1354 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1355 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1356 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1357 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1358 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1359 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1360 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1361 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1362 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1363 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1364 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1365 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1366 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1367 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1368 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1369 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1370 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1371 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1372 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1373 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1374 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1375 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1376 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1378 * The following error codes are documented in the Microsoft WinSock
1379 * reference guide, but don't actually exist.
1381 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1382 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1383 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1384 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1385 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1386 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1387 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1388 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1389 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1390 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1393 sprintf(tmp_buf, "(error number %d)", errcode);
1396 #endif /* def _WIN32 */
1400 /*********************************************************************
1402 * Function : os2_socket_strerr
1404 * Description : Translate the return value from sock_errno()
1408 * 1 : errcode = The return value from sock_errno().
1409 * 2 : tmp_buf = A temporary buffer that might be used to
1412 * Returns : String representing the error code. This may be
1413 * a global string constant or a string stored in
1416 *********************************************************************/
1417 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1419 #define TEXT_FOR_ERROR(code,text) \
1420 if (errcode == code) \
1422 return #code " - " text; \
1425 TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
1426 TEXT_FOR_ERROR(SOCESRCH , "No such process.")
1427 TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
1428 TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
1429 TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
1430 TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
1431 TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
1432 TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
1433 TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
1434 TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
1435 TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
1436 TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
1437 TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
1438 TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
1439 TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
1440 TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
1441 TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
1442 TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
1443 TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1444 TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1445 TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
1446 TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
1447 TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
1448 TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
1449 TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
1450 TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
1451 TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
1452 TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
1453 TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
1454 TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
1455 TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
1456 TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
1457 TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
1458 TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
1459 TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
1460 TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
1461 TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
1462 TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
1463 TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
1464 TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
1465 TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
1466 TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
1467 TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
1469 sprintf(tmp_buf, "(error number %d)", errcode);
1472 #endif /* def __OS2__ */