1 const char errlog_rcs[] = "$Id: errlog.c,v 1.16 2001/07/30 22:08:36 jongfoster 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 the SourceForge
10 * IJBSWA team. http://ijbswa.sourceforge.net
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.16 2001/07/30 22:08:36 jongfoster
37 * Tidying up #defines:
38 * - All feature #defines are now of the form FEATURE_xxx
39 * - Permanently turned off WIN_GUI_EDIT
40 * - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
42 * Revision 1.15 2001/07/29 17:41:10 jongfoster
43 * Now prints thread ID for each message (pthreads only)
45 * Revision 1.14 2001/07/19 19:03:48 haroon
46 * - Added case for LOG_LEVEL_POPUPS
48 * Revision 1.13 2001/07/13 13:58:58 oes
49 * - Added case for LOG_LEVEL_DEANIMATE
50 * - Removed all #ifdef PCRS
52 * Revision 1.12 2001/06/09 10:55:28 jongfoster
53 * Changing BUFSIZ ==> BUFFER_SIZE
55 * Revision 1.11 2001/06/01 18:14:49 jongfoster
56 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
57 * in config.h if appropriate) rather than the NO_STRERR macro.
59 * Revision 1.10 2001/05/29 11:52:21 oes
60 * Conditional compilation of w32_socket_error
62 * Revision 1.9 2001/05/28 16:15:17 jongfoster
63 * Improved reporting of errors under Win32.
65 * Revision 1.8 2001/05/26 17:25:14 jongfoster
66 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
68 * Revision 1.7 2001/05/26 15:21:28 jongfoster
69 * Activity animation in Win32 GUI now works even if debug==0
71 * Revision 1.6 2001/05/25 21:55:08 jongfoster
72 * Now cleans up properly on FATAL (removes taskbar icon etc)
74 * Revision 1.5 2001/05/22 18:46:04 oes
76 * - Enabled filtering banners by size rather than URL
77 * by adding patterns that replace all standard banner
78 * sizes with the "Junkbuster" gif to the re_filterfile
80 * - Enabled filtering WebBugs by providing a pattern
81 * which kills all 1x1 images
83 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
84 * which is selected by the (nonstandard and therefore
85 * capital) letter 'U' in the option string.
86 * It causes the quantifiers to be ungreedy by default.
87 * Appending a ? turns back to greedy (!).
89 * - Added a new interceptor ijb-send-banner, which
90 * sends back the "Junkbuster" gif. Without imagelist or
91 * MSIE detection support, or if tinygif = 1, or the
92 * URL isn't recognized as an imageurl, a lame HTML
93 * explanation is sent instead.
95 * - Added new feature, which permits blocking remote
96 * script redirects and firing back a local redirect
98 * The feature is conditionally compiled, i.e. it
99 * can be disabled with --disable-fast-redirects,
100 * plus it must be activated by a "fast-redirects"
101 * line in the config file, has its own log level
102 * and of course wants to be displayed by show-proxy-args
103 * Note: Boy, all the #ifdefs in 1001 locations and
104 * all the fumbling with configure.in and acconfig.h
105 * were *way* more work than the feature itself :-(
107 * - Because a generic redirect template was needed for
108 * this, tinygif = 3 now uses the same.
110 * - Moved GIFs, and other static HTTP response templates
115 * - Removed some >400 CRs again (Jon, you really worked
118 * Revision 1.4 2001/05/21 19:32:54 jongfoster
119 * Added another #ifdef _WIN_CONSOLE
121 * Revision 1.3 2001/05/20 01:11:40 jongfoster
122 * Added support for LOG_LEVEL_FATAL
123 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
124 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
126 * Revision 1.2 2001/05/17 22:42:01 oes
127 * - Cleaned CRLF's from the sources and related files
128 * - Repaired logging for REF and FRC
130 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
131 * Initial import of version 2.9.3 source tree
134 *********************************************************************/
146 #endif /* ndef _WIN32 */
149 #ifdef FEATURE_PTHREAD
151 #endif /* def FEATURE_PTHREAD */
157 #endif /* ndef _WIN_CONSOLE */
158 #endif /* def _WIN32 */
163 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
167 * LOG_LEVEL_FATAL cannot be turned off. (There are
168 * some exceptional situations where we need to get a
169 * message to the user).
171 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
173 /* where to log (default: stderr) */
174 static FILE *logfp = NULL;
176 /* logging detail level. */
177 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
179 /* static functions */
180 static void fatal_error(const char * error_message);
181 static char * w32_socket_strerr(int errcode, char * tmp_buf);
184 /*********************************************************************
186 * Function : fatal_error
188 * Description : Displays a fatal error to standard error (or, on
189 * a WIN32 GUI, to a dialog box), and exits
190 * JunkBuster with status code 1.
193 * 1 : error_message = The error message to display.
195 * Returns : Does not return.
197 *********************************************************************/
198 static void fatal_error(const char * error_message)
200 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
201 MessageBox(g_hwndLogFrame, error_message, "Internet JunkBuster Error",
202 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
204 /* Cleanup - remove taskbar icon etc. */
207 #else /* if !defined(_WIN32) || defined(_WIN_CONSOLE) */
208 fputs(error_message, stderr);
209 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
215 /*********************************************************************
217 * Function : init_errlog
219 * Description : Initializes the logging module. Must call before
223 * 1 : prog_name = The program name.
224 * 2 : logfname = The logfile name, or NULL for stderr.
225 * 3 : debuglevel = The debugging level.
229 *********************************************************************/
230 void init_error_log(const char *prog_name, const char *logfname, int debuglevel)
234 /* FIXME RACE HAZARD: should start critical section error_log_use here */
236 /* set the logging detail level */
237 debug = debuglevel | LOG_LEVEL_MINIMUM;
239 if ((logfp != NULL) && (logfp != stderr))
245 /* set the designated log file */
248 if( !(fp = fopen(logfname, "a")) )
250 log_error(LOG_LEVEL_FATAL, "init_errlog(): can't open logfile: %s", logfname);
253 /* set logging to be completely unbuffered */
259 log_error(LOG_LEVEL_INFO, "Internet JunkBuster version " VERSION);
260 if (prog_name != NULL)
262 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
265 /* FIXME RACE HAZARD: should end critical section error_log_use here */
267 } /* init_error_log */
270 /*********************************************************************
272 * Function : log_error
274 * Description : This is the error-reporting and logging function.
277 * 1 : loglevel = the type of message to be logged
278 * 2 : fmt = the main string we want logged, printf-like
279 * 3 : ... = arguments to be inserted in fmt (printf-like).
283 *********************************************************************/
284 void log_error(int loglevel, char *fmt, ...)
287 char outbuf[BUFFER_SIZE];
290 long this_thread = 1; /* was: pthread_t this_thread;*/
292 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
294 * Irrespective of debug setting, a GET/POST/CONNECT makes
295 * the taskbar icon animate. (There is an option to disable
296 * this but checking that is handled inside LogShowActivity()).
298 if (loglevel == LOG_LEVEL_GPC)
302 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
304 /* verify if loglevel applies to current settings and bail out if negative */
305 if ((loglevel & debug) == 0)
310 /* FIXME get current thread id */
311 #ifdef FEATURE_PTHREAD
312 this_thread = (long)pthread_self();
313 #endif /* def FEATURE_PTHREAD */
317 case LOG_LEVEL_ERROR:
318 outc = sprintf(outbuf, "IJB(%ld) Error: ", this_thread);
320 case LOG_LEVEL_FATAL:
321 outc = sprintf(outbuf, "IJB(%ld) Fatal error: ", this_thread);
324 outc = sprintf(outbuf, "IJB(%ld) Request: ", this_thread);
326 case LOG_LEVEL_CONNECT:
327 outc = sprintf(outbuf, "IJB(%ld) Connect: ", this_thread);
330 outc = sprintf(outbuf, "IJB(%ld) Writing: ", this_thread);
332 case LOG_LEVEL_HEADER:
333 outc = sprintf(outbuf, "IJB(%ld) Header: ", this_thread);
336 outc = sprintf(outbuf, "IJB(%ld) Info: ", this_thread);
338 case LOG_LEVEL_RE_FILTER:
339 outc = sprintf(outbuf, "IJB(%ld) Re-Filter: ", this_thread);
341 #ifdef FEATURE_FORCE_LOAD
342 case LOG_LEVEL_FORCE:
343 outc = sprintf(outbuf, "IJB(%ld) Force: ", this_thread);
345 #endif /* def FEATURE_FORCE_LOAD */
346 #ifdef FEATURE_FAST_REDIRECTS
347 case LOG_LEVEL_REDIRECTS:
348 outc = sprintf(outbuf, "IJB(%ld) Redirect: ", this_thread);
350 #endif /* def FEATURE_FAST_REDIRECTS */
351 case LOG_LEVEL_DEANIMATE:
352 outc = sprintf(outbuf, "IJB(%ld) Gif-Deanimate: ", this_thread);
358 #ifdef FEATURE_KILL_POPUPS
359 case LOG_LEVEL_POPUPS:
360 outc = sprintf(outbuf, "IJB(%ld) Kill-Popups: ", this_thread);
362 #endif /* def FEATURE_KILL_POPUPS */
364 outc = sprintf(outbuf, "IJB(%ld) UNKNOWN LOG TYPE(%d): ", this_thread, loglevel);
368 /* get ready to scan var. args. */
371 /* build formatted message from fmt and var-args */
372 while ((*src) && (outc < BUFFER_SIZE-2))
374 char tempbuf[BUFFER_SIZE];
393 outbuf[outc++] = '%';
396 ival = va_arg( ap, int );
398 outc += sprintf(tempbuf, "%d", ival);
399 if (outc < BUFFER_SIZE-1)
401 strcpy(outbuf + oldoutc, tempbuf);
405 outbuf[oldoutc] = '\0';
409 uval = va_arg( ap, unsigned );
411 outc += sprintf(tempbuf, "%u", uval);
412 if (outc < BUFFER_SIZE-1)
414 strcpy(outbuf + oldoutc, tempbuf);
418 outbuf[oldoutc] = '\0';
422 /* this is a modifier that must be followed by u or d */
426 lval = va_arg( ap, long );
428 outc += sprintf(tempbuf, "%ld", lval);
432 ulval = va_arg( ap, unsigned long );
434 outc += sprintf(tempbuf, "%lu", ulval);
439 sprintf(outbuf, "IJB(%ld) Error: log_error(): Bad format string:\n"
441 "Exiting.", this_thread, fmt);
442 /* FIXME RACE HAZARD: should start critical section error_log_use here */
447 fputs(outbuf, logfp);
448 /* FIXME RACE HAZARD: should end critical section error_log_use here */
453 if (outc < BUFFER_SIZE-1)
455 strcpy(outbuf + oldoutc, tempbuf);
459 outbuf[oldoutc] = '\0';
464 * Note that char paramaters are converted to int, so we need to
465 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
467 outbuf[outc++] = (char) va_arg( ap, int );
470 sval = va_arg( ap, char * );
472 outc += strlen(sval);
473 if (outc < BUFFER_SIZE-1)
475 strcpy(outbuf + oldoutc, sval);
479 outbuf[oldoutc] = '\0';
483 /* Non-standard: Print a counted string. Takes 2 parameters:
484 * int length, const char * string
486 ival = va_arg( ap, int );
487 sval = va_arg( ap, char * );
494 if (outc < BUFFER_SIZE-1)
496 memcpy(outbuf + oldoutc, sval, ival);
500 outbuf[oldoutc] = '\0';
504 /* Non-standard: Print error code from errno */
506 ival = WSAGetLastError();
507 sval = w32_socket_strerr(ival, tempbuf);
508 #else /* ifndef _WIN32 */
511 sval = strerror(ival);
512 #else /* ifndef HAVE_STRERROR */
514 #endif /* ndef HAVE_STRERROR */
517 sprintf(tempbuf, "(errno = %d)", ival);
520 #endif /* ndef _WIN32 */
522 outc += strlen(sval);
523 if (outc < BUFFER_SIZE-1)
525 strcpy(outbuf + oldoutc, sval);
529 outbuf[oldoutc] = '\0';
533 /* Non-standard: Print a Common Log File timestamp */
536 * Write timestamp into tempbuf.
538 * Complex because not all OSs have tm_gmtoff or
539 * the %z field in strftime()
546 gmt = *gmtime (&now);
547 tm_now = localtime (&now);
548 days = tm_now->tm_yday - gmt.tm_yday;
549 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
550 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
551 strftime (tempbuf, BUFFER_SIZE-6, "%d/%b/%Y:%H:%M:%S ", tm_now);
552 sprintf (tempbuf + strlen(tempbuf), "%+03d%02d", mins / 60, abs(mins) % 60);
555 outc += strlen(tempbuf);
556 if (outc < BUFFER_SIZE-1)
558 strcpy(outbuf + oldoutc, tempbuf);
562 outbuf[oldoutc] = '\0';
566 sprintf(outbuf, "IJB(%ld) Error: log_error(): Bad format string:\n"
568 "Exiting.", this_thread, fmt);
569 /* FIXME RACE HAZARD: should start critical section error_log_use here */
574 fputs(outbuf, logfp);
575 /* FIXME RACE HAZARD: should end critical section error_log_use here */
584 /* done with var. args */
587 if (outc >= BUFFER_SIZE-2)
589 /* insufficient room for newline and trailing null. */
591 static const char warning[] = "... [too long, truncated]\n";
593 if (outc < BUFFER_SIZE)
595 /* Need to add terminating null in this case. */
599 /* Truncate output */
600 outbuf[BUFFER_SIZE - sizeof(warning)] = '\0';
603 strcat(outbuf, warning);
607 /* Add terminating newline and null */
608 outbuf[outc++] = '\n';
612 /* FIXME RACE HAZARD: should start critical section error_log_use here */
614 /* deal with glibc stupidity - it won't let you initialize logfp */
620 fputs(outbuf, logfp);
622 if (loglevel == LOG_LEVEL_FATAL)
628 /* FIXME RACE HAZARD: should end critical section error_log_use here */
630 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
631 /* Write to display */
632 LogPutString(outbuf);
633 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
639 /*********************************************************************
641 * Function : w32_socket_strerr
643 * Description : Translate the return value from WSAGetLastError()
647 * 1 : errcode = The return value from WSAGetLastError().
648 * 2 : tmp_buf = A temporary buffer that might be used to
651 * Returns : String representing the error code. This may be
652 * a global string constant or a string stored in
655 *********************************************************************/
656 static char * w32_socket_strerr(int errcode, char * tmp_buf)
658 #define TEXT_FOR_ERROR(code,text) \
659 if (errcode == code) \
661 return #code " - " text; \
664 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
665 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
666 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
667 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
668 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
669 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
670 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
671 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
672 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
673 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
674 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
675 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
676 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
677 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
678 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
679 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
680 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
681 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
682 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
683 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
684 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
685 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
686 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
687 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
688 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
689 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
690 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
691 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
692 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
693 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
694 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
695 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
696 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
697 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
698 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
699 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
700 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
701 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
702 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
703 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
704 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
705 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
707 * The following error codes are documented in the Microsoft WinSock
708 * reference guide, but don't actually exist.
710 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
711 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
712 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
713 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
714 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
715 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
716 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
717 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
718 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
719 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
722 sprintf(tmp_buf, "(error number %d)", errcode);
725 #endif /* def _WIN32 */