1 const char errlog_rcs[] = "$Id: errlog.c,v 1.10 2001/05/29 11:52:21 oes 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.10 2001/05/29 11:52:21 oes
37 * Conditional compilation of w32_socket_error
39 * Revision 1.9 2001/05/28 16:15:17 jongfoster
40 * Improved reporting of errors under Win32.
42 * Revision 1.8 2001/05/26 17:25:14 jongfoster
43 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
45 * Revision 1.7 2001/05/26 15:21:28 jongfoster
46 * Activity animation in Win32 GUI now works even if debug==0
48 * Revision 1.6 2001/05/25 21:55:08 jongfoster
49 * Now cleans up properly on FATAL (removes taskbar icon etc)
51 * Revision 1.5 2001/05/22 18:46:04 oes
53 * - Enabled filtering banners by size rather than URL
54 * by adding patterns that replace all standard banner
55 * sizes with the "Junkbuster" gif to the re_filterfile
57 * - Enabled filtering WebBugs by providing a pattern
58 * which kills all 1x1 images
60 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
61 * which is selected by the (nonstandard and therefore
62 * capital) letter 'U' in the option string.
63 * It causes the quantifiers to be ungreedy by default.
64 * Appending a ? turns back to greedy (!).
66 * - Added a new interceptor ijb-send-banner, which
67 * sends back the "Junkbuster" gif. Without imagelist or
68 * MSIE detection support, or if tinygif = 1, or the
69 * URL isn't recognized as an imageurl, a lame HTML
70 * explanation is sent instead.
72 * - Added new feature, which permits blocking remote
73 * script redirects and firing back a local redirect
75 * The feature is conditionally compiled, i.e. it
76 * can be disabled with --disable-fast-redirects,
77 * plus it must be activated by a "fast-redirects"
78 * line in the config file, has its own log level
79 * and of course wants to be displayed by show-proxy-args
80 * Note: Boy, all the #ifdefs in 1001 locations and
81 * all the fumbling with configure.in and acconfig.h
82 * were *way* more work than the feature itself :-(
84 * - Because a generic redirect template was needed for
85 * this, tinygif = 3 now uses the same.
87 * - Moved GIFs, and other static HTTP response templates
92 * - Removed some >400 CRs again (Jon, you really worked
95 * Revision 1.4 2001/05/21 19:32:54 jongfoster
96 * Added another #ifdef _WIN_CONSOLE
98 * Revision 1.3 2001/05/20 01:11:40 jongfoster
99 * Added support for LOG_LEVEL_FATAL
100 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
101 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
103 * Revision 1.2 2001/05/17 22:42:01 oes
104 * - Cleaned CRLF's from the sources and related files
105 * - Repaired logging for REF and FRC
107 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
108 * Initial import of version 2.9.3 source tree
111 *********************************************************************/
123 #endif /* ndef _WIN32 */
126 /* #include <pthread.h> */
132 #endif /* ndef _WIN_CONSOLE */
133 #endif /* def _WIN32 */
138 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
142 * LOG_LEVEL_FATAL cannot be turned off. (There are
143 * some exceptional situations where we need to get a
144 * message to the user).
146 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
148 /* where to log (default: stderr) */
149 static FILE *logfp = NULL;
151 /* where to log (NULL == stderr) */
152 static char * logfilename = NULL;
154 /* logging detail level. */
155 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
157 /* static functions */
158 static void fatal_error(const char * error_message);
159 static char * w32_socket_strerr(int errcode, char * tmp_buf);
162 /*********************************************************************
164 * Function : fatal_error
166 * Description : Displays a fatal error to standard error (or, on
167 * a WIN32 GUI, to a dialog box), and exits
168 * JunkBuster with status code 1.
171 * 1 : error_message = The error message to display.
173 * Returns : Does not return.
175 *********************************************************************/
176 static void fatal_error(const char * error_message)
178 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
179 MessageBox(g_hwndLogFrame, error_message, "Internet JunkBuster Error",
180 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
182 /* Cleanup - remove taskbar icon etc. */
185 #else /* if !defined(_WIN32) || defined(_WIN_CONSOLE) */
186 fputs(error_message, stderr);
187 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
193 /*********************************************************************
195 * Function : init_errlog
197 * Description : Initializes the logging module. Must call before
201 * 1 : prog_name = The program name.
202 * 2 : logfname = The logfile name, or NULL for stderr.
203 * 3 : debuglevel = The debugging level.
207 *********************************************************************/
208 void init_error_log(const char *prog_name, const char *logfname, int debuglevel)
212 /* FIXME RACE HAZARD: should start critical section error_log_use here */
214 /* set the logging detail level */
215 debug = debuglevel | LOG_LEVEL_MINIMUM;
217 if ((logfp != NULL) && (logfp != stderr))
223 /* set the designated log file */
226 if( !(fp = fopen(logfname, "a")) )
228 log_error(LOG_LEVEL_FATAL, "init_errlog(): can't open logfile: %s", logfname);
231 /* set logging to be completely unbuffered */
237 log_error(LOG_LEVEL_INFO, "Internet JunkBuster version " VERSION);
238 if (prog_name != NULL)
240 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
243 /* FIXME RACE HAZARD: should end critical section error_log_use here */
245 } /* init_error_log */
248 /*********************************************************************
250 * Function : log_error
252 * Description : This is the error-reporting and logging function.
255 * 1 : loglevel = the type of message to be logged
256 * 2 : fmt = the main string we want logged, printf-like
257 * 3 : ... = arguments to be inserted in fmt (printf-like).
261 *********************************************************************/
262 void log_error(int loglevel, char *fmt, ...)
268 long this_thread = 1; /* was: pthread_t this_thread;*/
270 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
272 * Irrespective of debug setting, a GET/POST/CONNECT makes
273 * the taskbar icon animate. (There is an option to disable
274 * this but checking that is handled inside LogShowActivity()).
276 if (loglevel == LOG_LEVEL_GPC)
280 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
282 /* verify if loglevel applies to current settings and bail out if negative */
283 if ((loglevel & debug) == 0)
288 /* FIXME get current thread id */
289 /* this_thread = (long)pthread_self(); */
293 case LOG_LEVEL_ERROR:
294 outc = sprintf(outbuf, "IJB(%d) Error: ", this_thread);
296 case LOG_LEVEL_FATAL:
297 outc = sprintf(outbuf, "IJB(%d) Fatal error: ", this_thread);
300 outc = sprintf(outbuf, "IJB(%d) Request: ", this_thread);
302 case LOG_LEVEL_CONNECT:
303 outc = sprintf(outbuf, "IJB(%d) Connect: ", this_thread);
306 outc = sprintf(outbuf, "IJB(%d) Writing: ", this_thread);
308 case LOG_LEVEL_HEADER:
309 outc = sprintf(outbuf, "IJB(%d) Header: ", this_thread);
312 outc = sprintf(outbuf, "IJB(%d) Info: ", this_thread);
315 case LOG_LEVEL_RE_FILTER:
316 outc = sprintf(outbuf, "IJB(%d) Re-Filter: ", this_thread);
318 #endif /* def PCRS */
320 case LOG_LEVEL_FORCE:
321 outc = sprintf(outbuf, "IJB(%d) Force: ", this_thread);
323 #endif /* def FORCE_LOAD */
324 #ifdef FAST_REDIRECTS
325 case LOG_LEVEL_REDIRECTS:
326 outc = sprintf(outbuf, "IJB(%d) Redirect: ", this_thread);
328 #endif /* def FAST_REDIRECTS */
334 outc = sprintf(outbuf, "IJB(%d) UNKNOWN LOG TYPE(%d): ", this_thread, loglevel);
338 /* get ready to scan var. args. */
341 /* build formatted message from fmt and var-args */
342 while ((*src) && (outc < BUFSIZ-2))
344 char tempbuf[BUFSIZ];
363 outbuf[outc++] = '%';
366 ival = va_arg( ap, int );
368 outc += sprintf(tempbuf, "%d", ival);
371 strcpy(outbuf + oldoutc, tempbuf);
375 outbuf[oldoutc] = '\0';
379 uval = va_arg( ap, unsigned );
381 outc += sprintf(tempbuf, "%u", uval);
384 strcpy(outbuf + oldoutc, tempbuf);
388 outbuf[oldoutc] = '\0';
392 /* this is a modifier that must be followed by u or d */
396 lval = va_arg( ap, long );
398 outc += sprintf(tempbuf, "%ld", lval);
402 ulval = va_arg( ap, unsigned long );
404 outc += sprintf(tempbuf, "%lu", ulval);
409 sprintf(outbuf, "IJB(%d) Error: log_error(): Bad format string:\n"
411 "Exiting.", this_thread, fmt);
412 /* FIXME RACE HAZARD: should start critical section error_log_use here */
417 fputs(outbuf, logfp);
418 /* FIXME RACE HAZARD: should end critical section error_log_use here */
425 strcpy(outbuf + oldoutc, tempbuf);
429 outbuf[oldoutc] = '\0';
434 * Note that char paramaters are converted to int, so we need to
435 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
437 outbuf[outc++] = (char) va_arg( ap, int );
440 sval = va_arg( ap, char * );
442 outc += strlen(sval);
445 strcpy(outbuf + oldoutc, sval);
449 outbuf[oldoutc] = '\0';
453 /* Non-standard: Print a counted string. Takes 2 parameters:
454 * int length, const char * string
456 ival = va_arg( ap, int );
457 sval = va_arg( ap, char * );
466 memcpy(outbuf + oldoutc, sval, ival);
470 outbuf[oldoutc] = '\0';
474 /* Non-standard: Print error code from errno */
476 ival = WSAGetLastError();
477 sval = w32_socket_strerr(ival, tempbuf);
478 #else /* ifndef _WIN32 */
481 sval = strerror(ival);
482 #else /* ifndef HAVE_STRERROR */
484 #endif /* ndef HAVE_STRERROR */
487 sprintf(tempbuf, "(errno = %d)", ival);
490 #endif /* ndef _WIN32 */
492 outc += strlen(sval);
495 strcpy(outbuf + oldoutc, sval);
499 outbuf[oldoutc] = '\0';
503 /* Non-standard: Print a Common Log File timestamp */
506 * Write timestamp into tempbuf.
508 * Complex because not all OSs have tm_gmtoff or
509 * the %z field in strftime()
516 gmt = *gmtime (&now);
517 tm_now = localtime (&now);
518 days = tm_now->tm_yday - gmt.tm_yday;
519 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
520 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
521 strftime (tempbuf, BUFSIZ-6, "%d/%b/%Y:%H:%M:%S ", tm_now);
522 sprintf (tempbuf + strlen(tempbuf), "%+03d%02d", mins / 60, abs(mins) % 60);
525 outc += strlen(tempbuf);
528 strcpy(outbuf + oldoutc, tempbuf);
532 outbuf[oldoutc] = '\0';
536 sprintf(outbuf, "IJB(%d) Error: log_error(): Bad format string:\n"
538 "Exiting.", this_thread, fmt);
539 /* FIXME RACE HAZARD: should start critical section error_log_use here */
544 fputs(outbuf, logfp);
545 /* FIXME RACE HAZARD: should end critical section error_log_use here */
554 /* done with var. args */
557 if (outc >= BUFSIZ-2)
559 /* insufficient room for newline and trailing null. */
561 static const char warning[] = "... [too long, truncated]\n";
565 /* Need to add terminating null in this case. */
569 /* Truncate output */
570 outbuf[BUFSIZ - sizeof(warning)] = '\0';
573 strcat(outbuf, warning);
577 /* Add terminating newline and null */
578 outbuf[outc++] = '\n';
582 /* FIXME RACE HAZARD: should start critical section error_log_use here */
584 /* deal with glibc stupidity - it won't let you initialize logfp */
590 fputs(outbuf, logfp);
592 if (loglevel == LOG_LEVEL_FATAL)
598 /* FIXME RACE HAZARD: should end critical section error_log_use here */
600 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
601 /* Write to display */
602 LogPutString(outbuf);
603 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
609 /*********************************************************************
611 * Function : w32_socket_strerr
613 * Description : Translate the return value from WSAGetLastError()
617 * 1 : errcode = The return value from WSAGetLastError().
618 * 2 : tmp_buf = A temporary buffer that might be used to
621 * Returns : String representing the error code. This may be
622 * a global string constant or a string stored in
625 *********************************************************************/
626 static char * w32_socket_strerr(int errcode, char * tmp_buf)
628 #define TEXT_FOR_ERROR(code,text) \
629 if (errcode == code) \
631 return #code " - " text; \
634 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
635 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
636 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
637 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
638 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
639 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
640 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
641 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
642 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
643 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
644 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
645 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
646 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
647 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
648 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
649 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
650 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
651 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
652 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
653 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
654 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
655 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
656 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
657 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
658 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
659 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
660 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
661 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
662 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
663 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
664 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
665 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
666 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
667 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
668 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
669 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
670 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
671 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
672 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
673 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
674 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
675 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
677 * The following error codes are documented in the Microsoft WinSock
678 * reference guide, but don't actually exist.
680 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
681 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
682 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
683 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
684 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
685 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
686 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
687 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
688 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
689 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
692 sprintf(tmp_buf, "(error number %d)", errcode);
695 #endif /* def _WIN32 */