1 const char errlog_rcs[] = "$Id: errlog.c,v 1.72 2008/07/27 12:04:28 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.72 2008/07/27 12:04:28 fabiankeil
39 * Revision 1.71 2008/06/28 17:17:15 fabiankeil
40 * Remove another stray semicolon.
42 * Revision 1.70 2008/06/28 17:10:29 fabiankeil
43 * Remove stray semicolon in get_log_timestamp().
44 * Reported by Jochen Voss in #2005221.
46 * Revision 1.69 2008/05/30 15:55:25 fabiankeil
47 * Declare variable "debug" static and complain about its name.
49 * Revision 1.68 2008/04/27 16:50:46 fabiankeil
50 * Remove an incorrect assertion. The value of debug may change if
51 * the configuration is reloaded in another thread. While we could
52 * cache the initial value, the assertion doesn't seem worth it.
54 * Revision 1.67 2008/03/27 18:27:23 fabiankeil
55 * Remove kill-popups action.
57 * Revision 1.66 2008/01/31 15:38:14 fabiankeil
58 * - Make the logfp assertion more strict. As of 1.63, the "||" could
59 * have been an "&&", which means we can use two separate assertions
60 * and skip on of them on Windows.
61 * - Break a long commit message line in two.
63 * Revision 1.65 2008/01/31 14:44:33 fabiankeil
64 * Use (a != b) instead of !(a == b) so the sanity check looks less insane.
66 * Revision 1.64 2008/01/21 18:56:46 david__schmidt
67 * Swap #def from negative to positive, re-joined it so it didn't
68 * span an assertion (compilation failure on OS/2)
70 * Revision 1.63 2007/12/15 19:49:32 fabiankeil
71 * Stop overloading logfile to control the mingw32 log window as well.
72 * It's no longer necessary now that we disable all debug lines by default
73 * and at least one user perceived it as a regression (added in 1.55).
75 * Revision 1.62 2007/11/30 15:33:46 fabiankeil
76 * Unbreak LOG_LEVEL_FATAL. It wasn't fatal with logging disabled
77 * and on mingw32 fatal log messages didn't end up in the log file.
79 * Revision 1.61 2007/11/04 19:03:01 fabiankeil
80 * Fix another deadlock Hal spotted and that mysteriously didn't affect FreeBSD.
82 * Revision 1.60 2007/11/03 19:03:31 fabiankeil
83 * - Prevent the Windows GUI from showing the version two times in a row.
84 * - Stop using the imperative in the "(Re-)Open logfile" message.
85 * - Ditch the "Switching to daemon mode" message as the detection
86 * whether or not we're already in daemon mode doesn't actually work.
88 * Revision 1.59 2007/11/01 12:50:56 fabiankeil
89 * Here's looking at you, deadlock.
91 * Revision 1.58 2007/10/28 19:04:21 fabiankeil
92 * Don't mention daemon mode in "Logging disabled" message. Some
93 * platforms call it differently and it's not really relevant anyway.
95 * Revision 1.57 2007/10/27 13:02:26 fabiankeil
96 * Relocate daemon-mode-related log messages to make sure
97 * they aren't shown again in case of configuration reloads.
99 * Revision 1.56 2007/10/14 14:26:56 fabiankeil
100 * Remove the old log_error() version.
102 * Revision 1.55 2007/10/14 14:12:41 fabiankeil
103 * When in daemon mode, close stderr after the configuration file has been
104 * parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
106 * Revision 1.54 2007/09/22 16:15:34 fabiankeil
107 * - Let it compile with pcc.
108 * - Move our includes below system includes to prevent macro conflicts.
110 * Revision 1.53 2007/08/05 13:53:14 fabiankeil
111 * #1763173 from Stefan Huehner: declare some more functions
112 * static and use void instead of empty parameter lists.
114 * Revision 1.52 2007/07/14 07:28:47 fabiankeil
115 * Add translation function for JB_ERR_FOO codes.
117 * Revision 1.51 2007/05/11 11:51:34 fabiankeil
118 * Fix a type mismatch warning.
120 * Revision 1.50 2007/04/11 10:55:44 fabiankeil
121 * Enforce some assertions that could be triggered
122 * on mingw32 and other systems where we use threads
125 * Revision 1.49 2007/04/08 16:44:15 fabiankeil
126 * We need <sys/time.h> for gettimeofday(), not <time.h>.
128 * Revision 1.48 2007/03/31 13:33:28 fabiankeil
129 * Add alternative log_error() with timestamps
130 * that contain milliseconds and without using
131 * strcpy(), strcat() or sprintf().
133 * Revision 1.47 2006/11/28 15:25:15 fabiankeil
134 * Only unlink the pidfile if it's actually used.
136 * Revision 1.46 2006/11/13 19:05:51 fabiankeil
137 * Make pthread mutex locking more generic. Instead of
138 * checking for OSX and OpenBSD, check for FEATURE_PTHREAD
139 * and use mutex locking unless there is an _r function
140 * available. Better safe than sorry.
142 * Fixes "./configure --disable-pthread" and should result
143 * in less threading-related problems on pthread-using platforms,
144 * but it still doesn't fix BR#1122404.
146 * Revision 1.45 2006/08/21 11:15:54 david__schmidt
147 * MS Visual C++ build updates
149 * Revision 1.44 2006/08/18 16:03:16 david__schmidt
150 * Tweak for OS/2 build happiness.
152 * Revision 1.43 2006/08/03 02:46:41 david__schmidt
153 * Incorporate Fabian Keil's patch work:
154 * http://www.fabiankeil.de/sourcecode/privoxy/
156 * Revision 1.42 2006/07/18 14:48:46 david__schmidt
157 * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
158 * with what was really the latest development (the v_3_0_branch branch)
160 * Revision 1.40.2.4 2005/04/03 20:10:50 david__schmidt
161 * Thanks to Jindrich Makovicka for a race condition fix for the log
162 * file. The race condition remains for non-pthread implementations.
163 * Reference patch #1175720.
165 * Revision 1.40.2.3 2003/03/07 03:41:04 david__schmidt
166 * Wrapping all *_r functions (the non-_r versions of them) with mutex
167 * semaphores for OSX. Hopefully this will take care of all of those pesky
170 * Revision 1.40.2.2 2002/09/28 00:30:57 david__schmidt
171 * Update error logging to give sane values for thread IDs on Mach kernels.
172 * It's still a hack, but at least it looks farily normal. We print the
173 * absolute value of the first 4 bytes of the pthread_t modded with 1000.
175 * Revision 1.40.2.1 2002/09/25 12:47:42 oes
176 * Make log_error safe against NULL string arguments
178 * Revision 1.40 2002/05/22 01:27:27 david__schmidt
180 * Add os2_socket_strerr mirroring w32_socket_strerr.
182 * Revision 1.39 2002/04/03 17:15:27 gliptak
183 * zero padding thread ids in log
185 * Revision 1.38 2002/03/31 17:18:59 jongfoster
186 * Win32 only: Enabling STRICT to fix a VC++ compile warning.
188 * Revision 1.37 2002/03/27 14:32:43 david__schmidt
189 * More compiler warning message maintenance
191 * Revision 1.36 2002/03/26 22:29:54 swa
192 * we have a new homepage!
194 * Revision 1.35 2002/03/24 15:23:33 jongfoster
197 * Revision 1.34 2002/03/24 13:25:43 swa
198 * name change related issues
200 * Revision 1.33 2002/03/13 00:27:04 jongfoster
203 * Revision 1.32 2002/03/07 03:46:17 oes
204 * Fixed compiler warnings
206 * Revision 1.31 2002/03/06 23:02:57 jongfoster
209 * Revision 1.30 2002/03/05 22:43:45 david__schmidt
210 * - Better error reporting on OS/2
211 * - Fix double-slash comment (oops)
213 * Revision 1.29 2002/03/04 23:45:13 jongfoster
214 * Printing thread ID if using Win32 native threads
216 * Revision 1.28 2002/03/04 17:59:59 oes
217 * Deleted deletePidFile(), cosmetics
219 * Revision 1.27 2002/03/04 02:08:01 david__schmidt
220 * Enable web editing of actions file on OS/2 (it had been broken all this time!)
222 * Revision 1.26 2002/01/09 19:05:45 steudten
223 * Fix big memory leak.
225 * Revision 1.25 2002/01/09 14:32:08 oes
226 * Added support for gmtime_r and localtime_r.
228 * Revision 1.24 2001/12/30 14:07:32 steudten
229 * - Add signal handling (unix)
230 * - Add SIGHUP handler (unix)
231 * - Add creation of pidfile (unix)
232 * - Add action 'top' in rc file (RH)
233 * - Add entry 'SIGNALS' to manpage
234 * - Add exit message to logfile (unix)
236 * Revision 1.23 2001/11/07 00:02:13 steudten
237 * Add line number in error output for lineparsing for
238 * actionsfile and configfile.
239 * Special handling for CLF added.
241 * Revision 1.22 2001/11/05 23:43:05 steudten
242 * Add time+date to log files.
244 * Revision 1.21 2001/10/25 03:40:47 david__schmidt
245 * Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
246 * threads to call select() simultaneously. So, it's time to do a real, live,
247 * native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
248 * (native). Both versions will work, but using __OS2__ offers multi-threading.
250 * Revision 1.20 2001/09/16 23:04:34 jongfoster
253 * Revision 1.19 2001/09/13 20:08:06 jongfoster
254 * Adding support for LOG_LEVEL_CGI
256 * Revision 1.18 2001/09/10 11:27:24 oes
257 * Declaration of w32_socket_strerr now conditional
259 * Revision 1.17 2001/09/10 10:17:13 oes
260 * Removed unused variable; Fixed sprintf format
262 * Revision 1.16 2001/07/30 22:08:36 jongfoster
263 * Tidying up #defines:
264 * - All feature #defines are now of the form FEATURE_xxx
265 * - Permanently turned off WIN_GUI_EDIT
266 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
268 * Revision 1.15 2001/07/29 17:41:10 jongfoster
269 * Now prints thread ID for each message (pthreads only)
271 * Revision 1.14 2001/07/19 19:03:48 haroon
272 * - Added case for LOG_LEVEL_POPUPS
274 * Revision 1.13 2001/07/13 13:58:58 oes
275 * - Added case for LOG_LEVEL_DEANIMATE
276 * - Removed all #ifdef PCRS
278 * Revision 1.12 2001/06/09 10:55:28 jongfoster
279 * Changing BUFSIZ ==> BUFFER_SIZE
281 * Revision 1.11 2001/06/01 18:14:49 jongfoster
282 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
283 * in config.h if appropriate) rather than the NO_STRERR macro.
285 * Revision 1.10 2001/05/29 11:52:21 oes
286 * Conditional compilation of w32_socket_error
288 * Revision 1.9 2001/05/28 16:15:17 jongfoster
289 * Improved reporting of errors under Win32.
291 * Revision 1.8 2001/05/26 17:25:14 jongfoster
292 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
294 * Revision 1.7 2001/05/26 15:21:28 jongfoster
295 * Activity animation in Win32 GUI now works even if debug==0
297 * Revision 1.6 2001/05/25 21:55:08 jongfoster
298 * Now cleans up properly on FATAL (removes taskbar icon etc)
300 * Revision 1.5 2001/05/22 18:46:04 oes
302 * - Enabled filtering banners by size rather than URL
303 * by adding patterns that replace all standard banner
304 * sizes with the "Junkbuster" gif to the re_filterfile
306 * - Enabled filtering WebBugs by providing a pattern
307 * which kills all 1x1 images
309 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
310 * which is selected by the (nonstandard and therefore
311 * capital) letter 'U' in the option string.
312 * It causes the quantifiers to be ungreedy by default.
313 * Appending a ? turns back to greedy (!).
315 * - Added a new interceptor ijb-send-banner, which
316 * sends back the "Junkbuster" gif. Without imagelist or
317 * MSIE detection support, or if tinygif = 1, or the
318 * URL isn't recognized as an imageurl, a lame HTML
319 * explanation is sent instead.
321 * - Added new feature, which permits blocking remote
322 * script redirects and firing back a local redirect
324 * The feature is conditionally compiled, i.e. it
325 * can be disabled with --disable-fast-redirects,
326 * plus it must be activated by a "fast-redirects"
327 * line in the config file, has its own log level
328 * and of course wants to be displayed by show-proxy-args
329 * Note: Boy, all the #ifdefs in 1001 locations and
330 * all the fumbling with configure.in and acconfig.h
331 * were *way* more work than the feature itself :-(
333 * - Because a generic redirect template was needed for
334 * this, tinygif = 3 now uses the same.
336 * - Moved GIFs, and other static HTTP response templates
341 * - Removed some >400 CRs again (Jon, you really worked
344 * Revision 1.4 2001/05/21 19:32:54 jongfoster
345 * Added another #ifdef _WIN_CONSOLE
347 * Revision 1.3 2001/05/20 01:11:40 jongfoster
348 * Added support for LOG_LEVEL_FATAL
349 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
350 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
352 * Revision 1.2 2001/05/17 22:42:01 oes
353 * - Cleaned CRLF's from the sources and related files
354 * - Repaired logging for REF and FRC
356 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
357 * Initial import of version 2.9.3 source tree
360 *********************************************************************/
369 #include "miscutil.h"
371 /* For gettimeofday() */
372 #include <sys/time.h>
374 #if !defined(_WIN32) && !defined(__OS2__)
376 #endif /* !defined(_WIN32) && !defined(__OS2__) */
388 #endif /* ndef _WIN_CONSOLE */
389 #endif /* def _WIN32 */
391 #define inline __inline
392 #endif /* def _MSC_VER */
395 #include <sys/socket.h> /* For sock_errno */
404 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
408 * LOG_LEVEL_FATAL cannot be turned off. (There are
409 * some exceptional situations where we need to get a
410 * message to the user).
412 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
414 /* where to log (default: stderr) */
415 static FILE *logfp = NULL;
417 /* logging detail level. XXX: stupid name. */
418 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
420 /* static functions */
421 static void fatal_error(const char * error_message);
423 static char *w32_socket_strerr(int errcode, char *tmp_buf);
426 static char *os2_socket_strerr(int errcode, char *tmp_buf);
429 #ifdef FEATURE_PTHREAD
430 static inline void lock_logfile(void)
432 pthread_mutex_lock(&log_mutex);
434 static inline void unlock_logfile(void)
436 pthread_mutex_unlock(&log_mutex);
438 static inline void lock_loginit(void)
440 pthread_mutex_lock(&log_init_mutex);
442 static inline void unlock_loginit(void)
444 pthread_mutex_unlock(&log_init_mutex);
446 #else /* ! FEATURE_PTHREAD */
448 * FIXME we need a cross-platform locking mechanism.
449 * The locking/unlocking functions below should be
450 * fleshed out for non-pthread implementations.
452 static inline void lock_logfile() {}
453 static inline void unlock_logfile() {}
454 static inline void lock_loginit() {}
455 static inline void unlock_loginit() {}
458 /*********************************************************************
460 * Function : fatal_error
462 * Description : Displays a fatal error to standard error (or, on
463 * a WIN32 GUI, to a dialog box), and exits
464 * JunkBuster with status code 1.
467 * 1 : error_message = The error message to display.
469 * Returns : Does not return.
471 *********************************************************************/
472 static void fatal_error(const char * error_message)
474 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
475 MessageBox(g_hwndLogFrame, error_message, "Privoxy Error",
476 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
478 /* Cleanup - remove taskbar icon etc. */
480 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
484 fputs(error_message, logfp);
498 /*********************************************************************
500 * Function : show_version
502 * Description : Logs the Privoxy version and the program name.
505 * 1 : prog_name = The program name.
509 *********************************************************************/
510 static void show_version(const char *prog_name)
512 log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
513 if (prog_name != NULL)
515 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
520 /*********************************************************************
522 * Function : init_log_module
524 * Description : Initializes the logging module to log to stderr.
525 * Can only be called while stderr hasn't been closed
526 * yet and is only supposed to be called once.
529 * 1 : prog_name = The program name.
533 *********************************************************************/
534 void init_log_module(const char *prog_name)
539 set_debug_level(debug);
540 show_version(prog_name);
544 /*********************************************************************
546 * Function : set_debug_level
548 * Description : Sets the debug level to the provided value
549 * plus LOG_LEVEL_MINIMUM.
551 * XXX: we should only use the LOG_LEVEL_MINIMUM
552 * until the first time the configuration file has
555 * Parameters : 1: debug_level = The debug level to set.
559 *********************************************************************/
560 void set_debug_level(int debug_level)
562 debug = debug_level | LOG_LEVEL_MINIMUM;
566 /*********************************************************************
568 * Function : disable_logging
570 * Description : Disables logging.
576 *********************************************************************/
577 void disable_logging(void)
581 log_error(LOG_LEVEL_INFO,
582 "No logfile configured. Please enable it before reporting any problems.");
591 /*********************************************************************
593 * Function : init_error_log
595 * Description : Initializes the logging module to log to a file.
597 * XXX: should be renamed.
600 * 1 : prog_name = The program name.
601 * 2 : logfname = The logfile name, or NULL for stderr.
602 * 3 : debuglevel = The debugging level.
606 *********************************************************************/
607 void init_error_log(const char *prog_name, const char *logfname)
611 assert(NULL != logfname);
617 log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
620 /* set the designated log file */
621 fp = fopen(logfname, "a");
622 if ((NULL == fp) && (logfp != NULL))
625 * Some platforms (like OS/2) don't allow us to open
626 * the same file twice, therefore we give it another
627 * shot after closing the old file descriptor first.
629 * We don't do it right away because it prevents us
630 * from logging the "can't open logfile" message to
633 * XXX: this is a lame workaround and once the next
634 * release is out we should stop bothering reopening
635 * the logfile unless we have to.
637 * Currently we reopen it every time the config file
638 * has been reloaded, but actually we only have to
639 * reopen it if the file name changed or if the
640 * configuration reloas was caused by a SIGHUP.
646 fp = fopen(logfname, "a");
651 log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
654 /* set logging to be completely unbuffered */
667 * Prevent the Windows GUI from showing the version two
668 * times in a row on startup. It already displayed the show_version()
669 * call from init_log_module() that other systems write to stderr.
671 * This means mingw32 users will never see the version in their
672 * log file, but I assume they wouldn't look for it there anyway
673 * and simply use the "Help/About Privoxy" menu.
675 show_version(prog_name);
676 #endif /* def unix */
680 } /* init_error_log */
683 /*********************************************************************
685 * Function : get_thread_id
687 * Description : Returns a number that is different for each thread.
689 * XXX: Should be moved elsewhere (miscutil.c?)
693 * Returns : thread_id
695 *********************************************************************/
696 static long get_thread_id(void)
698 long this_thread = 1; /* was: pthread_t this_thread;*/
702 APIRET ulrc; /* XXX: I have no clue what this does */
705 /* FIXME get current thread id */
706 #ifdef FEATURE_PTHREAD
707 this_thread = (long)pthread_self();
710 * Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
711 * value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
712 * pthread_t is supposed to be opaque... but it's fairly random, though, so
713 * we make it mostly presentable.
715 this_thread = abs(this_thread % 1000);
716 #endif /* def __MACH__ */
717 #elif defined(_WIN32)
718 this_thread = GetCurrentThreadId();
719 #elif defined(__OS2__)
720 ulrc = DosGetInfoBlocks(&ptib, NULL);
722 this_thread = ptib -> tib_ptib2 -> tib2_ultid;
723 #endif /* def FEATURE_PTHREAD */
729 /*********************************************************************
731 * Function : get_log_timestamp
733 * Description : Generates the time stamp for the log message prefix.
736 * 1 : buffer = Storage buffer
737 * 2 : buffer_size = Size of storage buffer
739 * Returns : Number of written characters or 0 for error.
741 *********************************************************************/
742 static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
747 struct timeval tv_now; /* XXX: stupid name */
749 int msecs_length = 0;
751 gettimeofday(&tv_now, NULL);
752 msecs = tv_now.tv_usec / 1000;
756 #ifdef HAVE_LOCALTIME_R
757 tm_now = *localtime_r(&now, &tm_now);
758 #elif FEATURE_PTHREAD
759 pthread_mutex_lock(&localtime_mutex);
760 tm_now = *localtime(&now);
761 pthread_mutex_unlock(&localtime_mutex);
763 tm_now = *localtime(&now);
766 length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
769 msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
771 if (msecs_length > 0)
773 length += (size_t)msecs_length;
784 /*********************************************************************
786 * Function : get_clf_timestamp
788 * Description : Generates a Common Log Format time string.
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_clf_timestamp(char *buffer, size_t buffer_size)
800 * Complex because not all OSs have tm_gmtoff or
801 * the %z field in strftime()
806 #ifdef HAVE_LOCALTIME_R
815 gmt = *gmtime_r(&now, &gmt);
816 #elif FEATURE_PTHREAD
817 pthread_mutex_lock(&gmtime_mutex);
819 pthread_mutex_unlock(&gmtime_mutex);
823 #ifdef HAVE_LOCALTIME_R
824 tm_now = localtime_r(&now, &dummy);
825 #elif FEATURE_PTHREAD
826 pthread_mutex_lock(&localtime_mutex);
827 tm_now = localtime(&now);
828 pthread_mutex_unlock(&localtime_mutex);
830 tm_now = localtime(&now);
832 days = tm_now->tm_yday - gmt.tm_yday;
833 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
834 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
836 length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
840 tz_length = snprintf(buffer+length, buffer_size-length,
841 "%+03d%02d", mins / 60, abs(mins) % 60);
845 length += (size_t)tz_length;
856 /*********************************************************************
858 * Function : get_log_level_string
860 * Description : Translates a numerical loglevel into a string.
863 * 1 : loglevel = LOG_LEVEL_FOO
865 * Returns : Log level string.
867 *********************************************************************/
868 static inline const char *get_log_level_string(int loglevel)
870 char *log_level_string = NULL;
872 assert(0 < loglevel);
876 case LOG_LEVEL_ERROR:
877 log_level_string = "Error";
879 case LOG_LEVEL_FATAL:
880 log_level_string = "Fatal error";
883 log_level_string = "Request";
885 case LOG_LEVEL_CONNECT:
886 log_level_string = "Connect";
889 log_level_string = "Writing";
891 case LOG_LEVEL_HEADER:
892 log_level_string = "Header";
895 log_level_string = "Info";
897 case LOG_LEVEL_RE_FILTER:
898 log_level_string = "Re-Filter";
900 #ifdef FEATURE_FORCE_LOAD
901 case LOG_LEVEL_FORCE:
902 log_level_string = "Force";
904 #endif /* def FEATURE_FORCE_LOAD */
905 #ifdef FEATURE_FAST_REDIRECTS
906 case LOG_LEVEL_REDIRECTS:
907 log_level_string = "Redirect";
909 #endif /* def FEATURE_FAST_REDIRECTS */
910 case LOG_LEVEL_DEANIMATE:
911 log_level_string = "Gif-Deanimate";
914 log_level_string = "CGI";
917 log_level_string = "Unknown log level";
920 assert(NULL != log_level_string);
922 return log_level_string;
926 /*********************************************************************
928 * Function : log_error
930 * Description : This is the error-reporting and logging function.
933 * 1 : loglevel = the type of message to be logged
934 * 2 : fmt = the main string we want logged, printf-like
935 * 3 : ... = arguments to be inserted in fmt (printf-like).
939 *********************************************************************/
940 void log_error(int loglevel, const char *fmt, ...)
944 static char *outbuf_save = NULL;
945 char tempbuf[BUFFER_SIZE];
947 const char * src = fmt;
951 * XXX: Make this a config option,
952 * why else do we allocate instead of using
955 size_t log_buffer_size = BUFFER_SIZE;
957 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
959 * Irrespective of debug setting, a GET/POST/CONNECT makes
960 * the taskbar icon animate. (There is an option to disable
961 * this but checking that is handled inside LogShowActivity()).
963 if (loglevel == LOG_LEVEL_GPC)
967 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
970 * verify that the loglevel applies to current
971 * settings and that logging is enabled.
972 * Bail out otherwise.
974 if ((0 == (loglevel & debug))
983 thread_id = get_thread_id();
984 get_log_timestamp(timestamp, sizeof(timestamp));
986 /* protect the whole function because of the static buffer (outbuf) */
989 if (NULL == outbuf_save)
991 outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
992 if (NULL == outbuf_save)
994 snprintf(tempbuf, sizeof(tempbuf),
995 "%s Privoxy(%08lx) Fatal error: log_error() failed to allocate buffer memory.\n"
996 "\nExiting.", timestamp, thread_id);
997 fatal_error(tempbuf); /* Exit */
1000 outbuf = outbuf_save;
1003 * Memsetting the whole buffer to zero (in theory)
1004 * makes things easier later on.
1006 memset(outbuf, 0, log_buffer_size);
1008 /* Add prefix for everything but Common Log Format messages */
1009 if (loglevel != LOG_LEVEL_CLF)
1011 length = (size_t)snprintf(outbuf, log_buffer_size, "%s Privoxy(%08lx) %s: ",
1012 timestamp, thread_id, get_log_level_string(loglevel));
1015 /* get ready to scan var. args. */
1018 /* build formatted message from fmt and var-args */
1019 while ((*src) && (length < log_buffer_size-2))
1021 const char *sval = NULL; /* %N string */
1022 int ival; /* %N string length or an error code */
1023 unsigned uval; /* %u value */
1024 long lval; /* %l value */
1025 unsigned long ulval; /* %ul value */
1027 const char *format_string = tempbuf;
1032 outbuf[length++] = ch;
1034 * XXX: Only necessary on platforms which don't use pthread
1035 * mutexes (mingw32 for example), where multiple threads can
1036 * write to the buffer at the same time.
1038 outbuf[length] = '\0';
1041 outbuf[length] = '\0';
1049 ival = va_arg( ap, int );
1050 snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
1053 uval = va_arg( ap, unsigned );
1054 snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
1057 /* this is a modifier that must be followed by u or d */
1061 lval = va_arg( ap, long );
1062 snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
1066 ulval = va_arg( ap, unsigned long );
1067 snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
1071 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1072 loglevel = LOG_LEVEL_FATAL;
1077 * Note that char paramaters are converted to int, so we need to
1078 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
1080 tempbuf[0] = (char) va_arg(ap, int);
1084 format_string = va_arg(ap, char *);
1085 if (format_string == NULL)
1087 format_string = "[null]";
1092 * Non-standard: Print a counted unterminated string.
1093 * Takes 2 parameters: int length, const char * string.
1095 ival = va_arg(ap, int);
1096 sval = va_arg(ap, char *);
1099 format_string = "[null]";
1105 /* That's ok (but stupid) */
1111 * That's not ok (and even more stupid)
1114 format_string = "[counted string lenght < 0]";
1117 else if (ival >= sizeof(tempbuf))
1120 * String is too long, copy as much as possible.
1121 * It will be further truncated later.
1123 memcpy(tempbuf, sval, sizeof(tempbuf)-1);
1124 tempbuf[sizeof(tempbuf)-1] = '\0';
1128 memcpy(tempbuf, sval, (size_t) ival);
1129 tempbuf[ival] = '\0';
1133 /* Non-standard: Print error code from errno */
1135 ival = WSAGetLastError();
1136 format_string = w32_socket_strerr(ival, tempbuf);
1138 ival = sock_errno();
1141 format_string = os2_socket_strerr(ival, tempbuf);
1146 format_string = strerror(ival);
1148 #else /* ifndef _WIN32 */
1150 #ifdef HAVE_STRERROR
1151 format_string = strerror(ival);
1152 #else /* ifndef HAVE_STRERROR */
1153 format_string = NULL;
1154 #endif /* ndef HAVE_STRERROR */
1157 snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
1159 #endif /* ndef _WIN32 */
1162 /* Non-standard: Print a Common Log File timestamp */
1163 get_clf_timestamp(tempbuf, sizeof(tempbuf));
1166 snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
1167 loglevel = LOG_LEVEL_FATAL;
1171 assert(length < log_buffer_size);
1172 length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
1174 if (length >= log_buffer_size-2)
1176 static char warning[] = "... [too long, truncated]";
1178 length = log_buffer_size - sizeof(warning) - 1;
1179 length += strlcpy(outbuf + length, warning, log_buffer_size - length);
1180 assert(length < log_buffer_size);
1184 } /* for( p ... ) */
1186 /* done with var. args */
1189 assert(length < log_buffer_size);
1190 length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
1192 /* Some sanity checks */
1193 if ((length >= log_buffer_size)
1194 || (outbuf[log_buffer_size-1] != '\0')
1195 || (outbuf[log_buffer_size] != '\0')
1198 /* Repeat as assertions */
1199 assert(length < log_buffer_size);
1200 assert(outbuf[log_buffer_size-1] == '\0');
1202 * outbuf's real size is log_buffer_size+1,
1203 * so while this looks like an off-by-one,
1204 * we're only checking our paranoia byte.
1206 assert(outbuf[log_buffer_size] == '\0');
1208 snprintf(outbuf, log_buffer_size,
1209 "%s Privoxy(%08lx) Fatal error: log_error()'s sanity checks failed. length: %d\n"
1210 "Exiting.", timestamp, thread_id, (int)length);
1211 loglevel = LOG_LEVEL_FATAL;
1216 * On Windows this is acceptable in case
1217 * we are logging to the GUI window only.
1219 assert(NULL != logfp);
1222 if (loglevel == LOG_LEVEL_FATAL)
1224 fatal_error(outbuf_save);
1225 /* Never get here */
1229 fputs(outbuf_save, logfp);
1233 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
1234 /* Write to display */
1235 LogPutString(outbuf_save);
1236 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
1241 /*********************************************************************
1243 * Function : jb_err_to_string
1245 * Description : Translates JB_ERR_FOO codes into strings.
1247 * XXX: the type of error codes is jb_err
1248 * but the typedef'inition is currently not
1249 * visible to all files that include errlog.h.
1252 * 1 : error = a valid jb_err code
1254 * Returns : A string with the jb_err translation
1256 *********************************************************************/
1257 const char *jb_err_to_string(int error)
1262 return "Success, no error";
1264 return "Out of memory";
1265 case JB_ERR_CGI_PARAMS:
1266 return "Missing or corrupt CGI parameters";
1268 return "Error opening, reading or writing a file";
1270 return "Parse error";
1271 case JB_ERR_MODIFIED:
1272 return "File has been modified outside of the CGI actions editor.";
1273 case JB_ERR_COMPRESS:
1274 return "(De)compression failure";
1277 return "Unknown error";
1280 return "Internal error";
1284 /*********************************************************************
1286 * Function : w32_socket_strerr
1288 * Description : Translate the return value from WSAGetLastError()
1292 * 1 : errcode = The return value from WSAGetLastError().
1293 * 2 : tmp_buf = A temporary buffer that might be used to
1296 * Returns : String representing the error code. This may be
1297 * a global string constant or a string stored in
1300 *********************************************************************/
1301 static char *w32_socket_strerr(int errcode, char *tmp_buf)
1303 #define TEXT_FOR_ERROR(code,text) \
1304 if (errcode == code) \
1306 return #code " - " text; \
1309 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
1310 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
1311 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
1312 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
1313 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
1314 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
1315 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
1316 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
1317 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
1318 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
1319 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
1320 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
1321 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
1322 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
1323 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
1324 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
1325 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
1326 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
1327 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
1328 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
1329 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
1330 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
1331 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
1332 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
1333 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
1334 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
1335 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
1336 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
1337 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
1338 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
1339 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
1340 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
1341 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
1342 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
1343 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
1344 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
1345 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
1346 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
1347 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
1348 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
1349 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
1350 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
1352 * The following error codes are documented in the Microsoft WinSock
1353 * reference guide, but don't actually exist.
1355 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
1356 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
1357 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
1358 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
1359 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
1360 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
1361 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
1362 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
1363 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
1364 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
1367 sprintf(tmp_buf, "(error number %d)", errcode);
1370 #endif /* def _WIN32 */
1374 /*********************************************************************
1376 * Function : os2_socket_strerr
1378 * Description : Translate the return value from sock_errno()
1382 * 1 : errcode = The return value from sock_errno().
1383 * 2 : tmp_buf = A temporary buffer that might be used to
1386 * Returns : String representing the error code. This may be
1387 * a global string constant or a string stored in
1390 *********************************************************************/
1391 static char *os2_socket_strerr(int errcode, char *tmp_buf)
1393 #define TEXT_FOR_ERROR(code,text) \
1394 if (errcode == code) \
1396 return #code " - " text; \
1399 TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
1400 TEXT_FOR_ERROR(SOCESRCH , "No such process.")
1401 TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
1402 TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
1403 TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
1404 TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
1405 TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
1406 TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
1407 TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
1408 TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
1409 TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
1410 TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
1411 TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
1412 TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
1413 TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
1414 TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
1415 TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
1416 TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
1417 TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
1418 TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
1419 TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
1420 TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
1421 TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
1422 TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
1423 TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
1424 TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
1425 TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
1426 TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
1427 TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
1428 TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
1429 TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
1430 TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
1431 TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
1432 TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
1433 TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
1434 TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
1435 TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
1436 TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
1437 TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
1438 TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
1439 TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
1440 TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
1441 TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
1443 sprintf(tmp_buf, "(error number %d)", errcode);
1446 #endif /* def __OS2__ */