1 const char errlog_rcs[] = "$Id: errlog.c,v 1.12 2001/06/09 10:55:28 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.12 2001/06/09 10:55:28 jongfoster
37 * Changing BUFSIZ ==> BUFFER_SIZE
39 * Revision 1.11 2001/06/01 18:14:49 jongfoster
40 * Changing the calls to strerr() to check HAVE_STRERR (which is defined
41 * in config.h if appropriate) rather than the NO_STRERR macro.
43 * Revision 1.10 2001/05/29 11:52:21 oes
44 * Conditional compilation of w32_socket_error
46 * Revision 1.9 2001/05/28 16:15:17 jongfoster
47 * Improved reporting of errors under Win32.
49 * Revision 1.8 2001/05/26 17:25:14 jongfoster
50 * Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
52 * Revision 1.7 2001/05/26 15:21:28 jongfoster
53 * Activity animation in Win32 GUI now works even if debug==0
55 * Revision 1.6 2001/05/25 21:55:08 jongfoster
56 * Now cleans up properly on FATAL (removes taskbar icon etc)
58 * Revision 1.5 2001/05/22 18:46:04 oes
60 * - Enabled filtering banners by size rather than URL
61 * by adding patterns that replace all standard banner
62 * sizes with the "Junkbuster" gif to the re_filterfile
64 * - Enabled filtering WebBugs by providing a pattern
65 * which kills all 1x1 images
67 * - Added support for PCRE_UNGREEDY behaviour to pcrs,
68 * which is selected by the (nonstandard and therefore
69 * capital) letter 'U' in the option string.
70 * It causes the quantifiers to be ungreedy by default.
71 * Appending a ? turns back to greedy (!).
73 * - Added a new interceptor ijb-send-banner, which
74 * sends back the "Junkbuster" gif. Without imagelist or
75 * MSIE detection support, or if tinygif = 1, or the
76 * URL isn't recognized as an imageurl, a lame HTML
77 * explanation is sent instead.
79 * - Added new feature, which permits blocking remote
80 * script redirects and firing back a local redirect
82 * The feature is conditionally compiled, i.e. it
83 * can be disabled with --disable-fast-redirects,
84 * plus it must be activated by a "fast-redirects"
85 * line in the config file, has its own log level
86 * and of course wants to be displayed by show-proxy-args
87 * Note: Boy, all the #ifdefs in 1001 locations and
88 * all the fumbling with configure.in and acconfig.h
89 * were *way* more work than the feature itself :-(
91 * - Because a generic redirect template was needed for
92 * this, tinygif = 3 now uses the same.
94 * - Moved GIFs, and other static HTTP response templates
99 * - Removed some >400 CRs again (Jon, you really worked
102 * Revision 1.4 2001/05/21 19:32:54 jongfoster
103 * Added another #ifdef _WIN_CONSOLE
105 * Revision 1.3 2001/05/20 01:11:40 jongfoster
106 * Added support for LOG_LEVEL_FATAL
107 * Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
108 * and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
110 * Revision 1.2 2001/05/17 22:42:01 oes
111 * - Cleaned CRLF's from the sources and related files
112 * - Repaired logging for REF and FRC
114 * Revision 1.1.1.1 2001/05/15 13:58:51 oes
115 * Initial import of version 2.9.3 source tree
118 *********************************************************************/
130 #endif /* ndef _WIN32 */
133 /* #include <pthread.h> */
139 #endif /* ndef _WIN_CONSOLE */
140 #endif /* def _WIN32 */
145 const char errlog_h_rcs[] = ERRLOG_H_VERSION;
149 * LOG_LEVEL_FATAL cannot be turned off. (There are
150 * some exceptional situations where we need to get a
151 * message to the user).
153 #define LOG_LEVEL_MINIMUM LOG_LEVEL_FATAL
155 /* where to log (default: stderr) */
156 static FILE *logfp = NULL;
158 /* where to log (NULL == stderr) */
159 static char * logfilename = NULL;
161 /* logging detail level. */
162 static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
164 /* static functions */
165 static void fatal_error(const char * error_message);
166 static char * w32_socket_strerr(int errcode, char * tmp_buf);
169 /*********************************************************************
171 * Function : fatal_error
173 * Description : Displays a fatal error to standard error (or, on
174 * a WIN32 GUI, to a dialog box), and exits
175 * JunkBuster with status code 1.
178 * 1 : error_message = The error message to display.
180 * Returns : Does not return.
182 *********************************************************************/
183 static void fatal_error(const char * error_message)
185 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
186 MessageBox(g_hwndLogFrame, error_message, "Internet JunkBuster Error",
187 MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
189 /* Cleanup - remove taskbar icon etc. */
192 #else /* if !defined(_WIN32) || defined(_WIN_CONSOLE) */
193 fputs(error_message, stderr);
194 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
200 /*********************************************************************
202 * Function : init_errlog
204 * Description : Initializes the logging module. Must call before
208 * 1 : prog_name = The program name.
209 * 2 : logfname = The logfile name, or NULL for stderr.
210 * 3 : debuglevel = The debugging level.
214 *********************************************************************/
215 void init_error_log(const char *prog_name, const char *logfname, int debuglevel)
219 /* FIXME RACE HAZARD: should start critical section error_log_use here */
221 /* set the logging detail level */
222 debug = debuglevel | LOG_LEVEL_MINIMUM;
224 if ((logfp != NULL) && (logfp != stderr))
230 /* set the designated log file */
233 if( !(fp = fopen(logfname, "a")) )
235 log_error(LOG_LEVEL_FATAL, "init_errlog(): can't open logfile: %s", logfname);
238 /* set logging to be completely unbuffered */
244 log_error(LOG_LEVEL_INFO, "Internet JunkBuster version " VERSION);
245 if (prog_name != NULL)
247 log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
250 /* FIXME RACE HAZARD: should end critical section error_log_use here */
252 } /* init_error_log */
255 /*********************************************************************
257 * Function : log_error
259 * Description : This is the error-reporting and logging function.
262 * 1 : loglevel = the type of message to be logged
263 * 2 : fmt = the main string we want logged, printf-like
264 * 3 : ... = arguments to be inserted in fmt (printf-like).
268 *********************************************************************/
269 void log_error(int loglevel, char *fmt, ...)
272 char outbuf[BUFFER_SIZE];
275 long this_thread = 1; /* was: pthread_t this_thread;*/
277 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
279 * Irrespective of debug setting, a GET/POST/CONNECT makes
280 * the taskbar icon animate. (There is an option to disable
281 * this but checking that is handled inside LogShowActivity()).
283 if (loglevel == LOG_LEVEL_GPC)
287 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
289 /* verify if loglevel applies to current settings and bail out if negative */
290 if ((loglevel & debug) == 0)
295 /* FIXME get current thread id */
296 /* this_thread = (long)pthread_self(); */
300 case LOG_LEVEL_ERROR:
301 outc = sprintf(outbuf, "IJB(%d) Error: ", this_thread);
303 case LOG_LEVEL_FATAL:
304 outc = sprintf(outbuf, "IJB(%d) Fatal error: ", this_thread);
307 outc = sprintf(outbuf, "IJB(%d) Request: ", this_thread);
309 case LOG_LEVEL_CONNECT:
310 outc = sprintf(outbuf, "IJB(%d) Connect: ", this_thread);
313 outc = sprintf(outbuf, "IJB(%d) Writing: ", this_thread);
315 case LOG_LEVEL_HEADER:
316 outc = sprintf(outbuf, "IJB(%d) Header: ", this_thread);
319 outc = sprintf(outbuf, "IJB(%d) Info: ", this_thread);
321 case LOG_LEVEL_RE_FILTER:
322 outc = sprintf(outbuf, "IJB(%d) Re-Filter: ", this_thread);
325 case LOG_LEVEL_FORCE:
326 outc = sprintf(outbuf, "IJB(%d) Force: ", this_thread);
328 #endif /* def FORCE_LOAD */
329 #ifdef FAST_REDIRECTS
330 case LOG_LEVEL_REDIRECTS:
331 outc = sprintf(outbuf, "IJB(%d) Redirect: ", this_thread);
333 #endif /* def FAST_REDIRECTS */
334 case LOG_LEVEL_DEANIMATE:
335 outc = sprintf(outbuf, "IJB(%d) Gif-Deanimate: ", this_thread);
342 outc = sprintf(outbuf, "IJB(%d) UNKNOWN LOG TYPE(%d): ", this_thread, loglevel);
346 /* get ready to scan var. args. */
349 /* build formatted message from fmt and var-args */
350 while ((*src) && (outc < BUFFER_SIZE-2))
352 char tempbuf[BUFFER_SIZE];
371 outbuf[outc++] = '%';
374 ival = va_arg( ap, int );
376 outc += sprintf(tempbuf, "%d", ival);
377 if (outc < BUFFER_SIZE-1)
379 strcpy(outbuf + oldoutc, tempbuf);
383 outbuf[oldoutc] = '\0';
387 uval = va_arg( ap, unsigned );
389 outc += sprintf(tempbuf, "%u", uval);
390 if (outc < BUFFER_SIZE-1)
392 strcpy(outbuf + oldoutc, tempbuf);
396 outbuf[oldoutc] = '\0';
400 /* this is a modifier that must be followed by u or d */
404 lval = va_arg( ap, long );
406 outc += sprintf(tempbuf, "%ld", lval);
410 ulval = va_arg( ap, unsigned long );
412 outc += sprintf(tempbuf, "%lu", ulval);
417 sprintf(outbuf, "IJB(%d) Error: log_error(): Bad format string:\n"
419 "Exiting.", this_thread, fmt);
420 /* FIXME RACE HAZARD: should start critical section error_log_use here */
425 fputs(outbuf, logfp);
426 /* FIXME RACE HAZARD: should end critical section error_log_use here */
431 if (outc < BUFFER_SIZE-1)
433 strcpy(outbuf + oldoutc, tempbuf);
437 outbuf[oldoutc] = '\0';
442 * Note that char paramaters are converted to int, so we need to
443 * pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
445 outbuf[outc++] = (char) va_arg( ap, int );
448 sval = va_arg( ap, char * );
450 outc += strlen(sval);
451 if (outc < BUFFER_SIZE-1)
453 strcpy(outbuf + oldoutc, sval);
457 outbuf[oldoutc] = '\0';
461 /* Non-standard: Print a counted string. Takes 2 parameters:
462 * int length, const char * string
464 ival = va_arg( ap, int );
465 sval = va_arg( ap, char * );
472 if (outc < BUFFER_SIZE-1)
474 memcpy(outbuf + oldoutc, sval, ival);
478 outbuf[oldoutc] = '\0';
482 /* Non-standard: Print error code from errno */
484 ival = WSAGetLastError();
485 sval = w32_socket_strerr(ival, tempbuf);
486 #else /* ifndef _WIN32 */
489 sval = strerror(ival);
490 #else /* ifndef HAVE_STRERROR */
492 #endif /* ndef HAVE_STRERROR */
495 sprintf(tempbuf, "(errno = %d)", ival);
498 #endif /* ndef _WIN32 */
500 outc += strlen(sval);
501 if (outc < BUFFER_SIZE-1)
503 strcpy(outbuf + oldoutc, sval);
507 outbuf[oldoutc] = '\0';
511 /* Non-standard: Print a Common Log File timestamp */
514 * Write timestamp into tempbuf.
516 * Complex because not all OSs have tm_gmtoff or
517 * the %z field in strftime()
524 gmt = *gmtime (&now);
525 tm_now = localtime (&now);
526 days = tm_now->tm_yday - gmt.tm_yday;
527 hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour);
528 mins = hrs * 60 + tm_now->tm_min - gmt.tm_min;
529 strftime (tempbuf, BUFFER_SIZE-6, "%d/%b/%Y:%H:%M:%S ", tm_now);
530 sprintf (tempbuf + strlen(tempbuf), "%+03d%02d", mins / 60, abs(mins) % 60);
533 outc += strlen(tempbuf);
534 if (outc < BUFFER_SIZE-1)
536 strcpy(outbuf + oldoutc, tempbuf);
540 outbuf[oldoutc] = '\0';
544 sprintf(outbuf, "IJB(%d) Error: log_error(): Bad format string:\n"
546 "Exiting.", this_thread, fmt);
547 /* FIXME RACE HAZARD: should start critical section error_log_use here */
552 fputs(outbuf, logfp);
553 /* FIXME RACE HAZARD: should end critical section error_log_use here */
562 /* done with var. args */
565 if (outc >= BUFFER_SIZE-2)
567 /* insufficient room for newline and trailing null. */
569 static const char warning[] = "... [too long, truncated]\n";
571 if (outc < BUFFER_SIZE)
573 /* Need to add terminating null in this case. */
577 /* Truncate output */
578 outbuf[BUFFER_SIZE - sizeof(warning)] = '\0';
581 strcat(outbuf, warning);
585 /* Add terminating newline and null */
586 outbuf[outc++] = '\n';
590 /* FIXME RACE HAZARD: should start critical section error_log_use here */
592 /* deal with glibc stupidity - it won't let you initialize logfp */
598 fputs(outbuf, logfp);
600 if (loglevel == LOG_LEVEL_FATAL)
606 /* FIXME RACE HAZARD: should end critical section error_log_use here */
608 #if defined(_WIN32) && !defined(_WIN_CONSOLE)
609 /* Write to display */
610 LogPutString(outbuf);
611 #endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
617 /*********************************************************************
619 * Function : w32_socket_strerr
621 * Description : Translate the return value from WSAGetLastError()
625 * 1 : errcode = The return value from WSAGetLastError().
626 * 2 : tmp_buf = A temporary buffer that might be used to
629 * Returns : String representing the error code. This may be
630 * a global string constant or a string stored in
633 *********************************************************************/
634 static char * w32_socket_strerr(int errcode, char * tmp_buf)
636 #define TEXT_FOR_ERROR(code,text) \
637 if (errcode == code) \
639 return #code " - " text; \
642 TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
643 TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
644 TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
645 TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
646 TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
647 TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
648 TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
649 TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
650 TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
651 TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
652 TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
653 TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
654 TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
655 TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
656 TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
657 TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
658 TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
659 TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
660 TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
661 TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
662 TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
663 TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
664 TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
665 TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
666 TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
667 TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
668 TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
669 TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
670 TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
671 TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
672 TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
673 TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
674 TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
675 TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
676 TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
677 TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
678 TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
679 TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
680 TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
681 TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
682 TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
683 TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
685 * The following error codes are documented in the Microsoft WinSock
686 * reference guide, but don't actually exist.
688 * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
689 * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
690 * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
691 * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
692 * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
693 * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
694 * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
695 * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
696 * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
697 * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
700 sprintf(tmp_buf, "(error number %d)", errcode);
703 #endif /* def _WIN32 */