Support for both static and dynamically generated CGI pages.
[privoxy.git] / errlog.c
index 7861253..fad5d6e 100644 (file)
--- a/errlog.c
+++ b/errlog.c
@@ -1,4 +1,4 @@
-const char errlog_rcs[] = "$Id: errlog.c,v 1.6 2001/05/25 21:55:08 jongfoster Exp $";
+const char errlog_rcs[] = "$Id: errlog.c,v 1.18 2001/09/10 11:27:24 oes Exp $";
 /*********************************************************************
  *
  * File        :  $Source: /cvsroot/ijbswa/current/errlog.c,v $
@@ -33,6 +33,47 @@ const char errlog_rcs[] = "$Id: errlog.c,v 1.6 2001/05/25 21:55:08 jongfoster Ex
  *
  * Revisions   :
  *    $Log: errlog.c,v $
+ *    Revision 1.18  2001/09/10 11:27:24  oes
+ *    Declaration of w32_socket_strerr now conditional
+ *
+ *    Revision 1.17  2001/09/10 10:17:13  oes
+ *    Removed unused variable; Fixed sprintf format
+ *
+ *    Revision 1.16  2001/07/30 22:08:36  jongfoster
+ *    Tidying up #defines:
+ *    - All feature #defines are now of the form FEATURE_xxx
+ *    - Permanently turned off WIN_GUI_EDIT
+ *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
+ *
+ *    Revision 1.15  2001/07/29 17:41:10  jongfoster
+ *    Now prints thread ID for each message (pthreads only)
+ *
+ *    Revision 1.14  2001/07/19 19:03:48  haroon
+ *    - Added case for LOG_LEVEL_POPUPS
+ *
+ *    Revision 1.13  2001/07/13 13:58:58  oes
+ *     - Added case for LOG_LEVEL_DEANIMATE
+ *     - Removed all #ifdef PCRS
+ *
+ *    Revision 1.12  2001/06/09 10:55:28  jongfoster
+ *    Changing BUFSIZ ==> BUFFER_SIZE
+ *
+ *    Revision 1.11  2001/06/01 18:14:49  jongfoster
+ *    Changing the calls to strerr() to check HAVE_STRERR (which is defined
+ *    in config.h if appropriate) rather than the NO_STRERR macro.
+ *
+ *    Revision 1.10  2001/05/29 11:52:21  oes
+ *    Conditional compilation of w32_socket_error
+ *
+ *    Revision 1.9  2001/05/28 16:15:17  jongfoster
+ *    Improved reporting of errors under Win32.
+ *
+ *    Revision 1.8  2001/05/26 17:25:14  jongfoster
+ *    Added support for CLF (Common Log Format) and fixed LOG_LEVEL_LOG
+ *
+ *    Revision 1.7  2001/05/26 15:21:28  jongfoster
+ *    Activity animation in Win32 GUI now works even if debug==0
+ *
  *    Revision 1.6  2001/05/25 21:55:08  jongfoster
  *    Now cleans up properly on FATAL (removes taskbar icon etc)
  *
@@ -111,7 +152,9 @@ const char errlog_rcs[] = "$Id: errlog.c,v 1.6 2001/05/25 21:55:08 jongfoster Ex
 #endif /* ndef _WIN32 */
 
 #include <errno.h>
-/* #include <pthread.h> */
+#ifdef FEATURE_PTHREAD
+#include <pthread.h>
+#endif /* def FEATURE_PTHREAD */
 
 #ifdef _WIN32
 #include <windows.h>
@@ -127,25 +170,23 @@ const char errlog_h_rcs[] = ERRLOG_H_VERSION;
 
 
 /*
- * LOG_LEVEL_FATAL, LOG_LEVEL_ERROR and LOG_LEVEL_INFO
- * cannot be turned off.  (There are some exceptional situations
- * where we need to get a message to the user).
- *
- * FIXME: Do we need LOG_LEVEL_INFO here?
+ * LOG_LEVEL_FATAL cannot be turned off.  (There are
+ * some exceptional situations where we need to get a
+ * message to the user).
  */
-#define LOG_LEVEL_MINIMUM  (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO)
+#define LOG_LEVEL_MINIMUM  LOG_LEVEL_FATAL
 
 /* where to log (default: stderr) */
 static FILE *logfp = NULL;
 
-/* where to log (NULL == stderr) */
-static char * logfilename = NULL;
-
 /* logging detail level.  */
-static int debug = LOG_LEVEL_MINIMUM;  
+static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);  
 
+/* static functions */
 static void fatal_error(const char * error_message);
-
+#ifdef _WIN32
+static char *w32_socket_strerr(int errcode, char *tmp_buf);
+#endif
 
 /*********************************************************************
  *
@@ -250,70 +291,87 @@ void init_error_log(const char *prog_name, const char *logfname, int debuglevel)
 void log_error(int loglevel, char *fmt, ...)
 {
    va_list ap;
-   char outbuf[BUFSIZ];
+   char outbuf[BUFFER_SIZE];
    char * src = fmt;
    int outc = 0;
    long this_thread = 1;  /* was: pthread_t this_thread;*/
-\r
-#if defined(_WIN32) && !defined(_WIN_CONSOLE)\r
-   /*\r
-    * Irrespective of debug setting, a GET/POST/CONNECT makes\r
-    * the taskbar icon animate.  (There is an option to disable\r
-    * this but checking that is handled inside LogShowActivity()).\r
-    */\r
-   if (loglevel == LOG_LEVEL_GPC)\r
-   {\r
-      LogShowActivity();\r
+
+#if defined(_WIN32) && !defined(_WIN_CONSOLE)
+   /*
+    * Irrespective of debug setting, a GET/POST/CONNECT makes
+    * the taskbar icon animate.  (There is an option to disable
+    * this but checking that is handled inside LogShowActivity()).
+    */
+   if (loglevel == LOG_LEVEL_GPC)
+   {
+      LogShowActivity();
    }
-#endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */\r
-\r
+#endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
+
    /* verify if loglevel applies to current settings and bail out if negative */
-   if(!(loglevel & debug))
+   if ((loglevel & debug) == 0)
    {
       return;
    }
 
    /* FIXME get current thread id */
-   /* this_thread = (long)pthread_self(); */
+#ifdef FEATURE_PTHREAD
+   this_thread = (long)pthread_self();
+#endif /* def FEATURE_PTHREAD */
 
    switch (loglevel)
    {
-      /* FIXME: What about LOG_LEVEL_LOG ??? */
       case LOG_LEVEL_ERROR:
-         outc = sprintf(outbuf, "IJB(%d) Error: ", this_thread);
+         outc = sprintf(outbuf, "IJB(%ld) Error: ", this_thread);
          break;
       case LOG_LEVEL_FATAL:
-         outc = sprintf(outbuf, "IJB(%d) Fatal error: ", this_thread);
+         outc = sprintf(outbuf, "IJB(%ld) Fatal error: ", this_thread);
          break;
       case LOG_LEVEL_GPC:
-         outc = sprintf(outbuf, "IJB(%d) Request: ", this_thread);
+         outc = sprintf(outbuf, "IJB(%ld) Request: ", this_thread);
          break;
       case LOG_LEVEL_CONNECT:
-         outc = sprintf(outbuf, "IJB(%d) Connect: ", this_thread);
+         outc = sprintf(outbuf, "IJB(%ld) Connect: ", this_thread);
+         break;
+      case LOG_LEVEL_LOG:
+         outc = sprintf(outbuf, "IJB(%ld) Writing: ", this_thread);
          break;
       case LOG_LEVEL_HEADER:
-         outc = sprintf(outbuf, "IJB(%d) Header: ", this_thread);
+         outc = sprintf(outbuf, "IJB(%ld) Header: ", this_thread);
          break;
       case LOG_LEVEL_INFO:
-         outc = sprintf(outbuf, "IJB(%d) Info: ", this_thread);
+         outc = sprintf(outbuf, "IJB(%ld) Info: ", this_thread);
          break;
-#ifdef PCRS
       case LOG_LEVEL_RE_FILTER:
-         outc = sprintf(outbuf, "IJB(%d) Re-Filter: ", this_thread);
+         outc = sprintf(outbuf, "IJB(%ld) Re-Filter: ", this_thread);
          break;
-#endif /* def PCRS */
-#ifdef FORCE_LOAD
+#ifdef FEATURE_FORCE_LOAD
       case LOG_LEVEL_FORCE:
-         outc = sprintf(outbuf, "IJB(%d) Force: ", this_thread);
+         outc = sprintf(outbuf, "IJB(%ld) Force: ", this_thread);
          break;
-#endif /* def FORCE_LOAD */
-#ifdef FAST_REDIRECTS
+#endif /* def FEATURE_FORCE_LOAD */
+#ifdef FEATURE_FAST_REDIRECTS
       case LOG_LEVEL_REDIRECTS:
-         outc = sprintf(outbuf, "IJB(%d) Redirect: ", this_thread);
+         outc = sprintf(outbuf, "IJB(%ld) Redirect: ", this_thread);
+         break;
+#endif /* def FEATURE_FAST_REDIRECTS */
+      case LOG_LEVEL_DEANIMATE:
+         outc = sprintf(outbuf, "IJB(%ld) Gif-Deanimate: ", this_thread);
+         break;
+      case LOG_LEVEL_CLF:
+         outc = 0;
+         outbuf[0] = '\0';
+         break;
+#ifdef FEATURE_KILL_POPUPS
+      case LOG_LEVEL_POPUPS:
+         outc = sprintf(outbuf, "IJB(%ld) Kill-Popups: ", this_thread);
+         break;
+#endif /* def FEATURE_KILL_POPUPS */
+      case LOG_LEVEL_CGI:
+         outc = sprintf(outbuf, "IJB(%d) CGI: ", this_thread);
          break;
-#endif /* def FAST_REDIRECTS */
       default:
-         outc = sprintf(outbuf, "IJB(%d) UNKNOWN LOG TYPE(%d): ", this_thread, loglevel);
+         outc = sprintf(outbuf, "IJB(%ld) UNKNOWN LOG TYPE(%d): ", this_thread, loglevel);
          break;
    }
    
@@ -321,9 +379,9 @@ void log_error(int loglevel, char *fmt, ...)
    va_start( ap, fmt );
 
    /* build formatted message from fmt and var-args */
-   while ((*src) && (outc < BUFSIZ-2))
+   while ((*src) && (outc < BUFFER_SIZE-2))
    {
-      char tempbuf[BUFSIZ];
+      char tempbuf[BUFFER_SIZE];
       char *sval;
       int ival;
       unsigned uval;
@@ -348,7 +406,7 @@ void log_error(int loglevel, char *fmt, ...)
             ival = va_arg( ap, int );
             oldoutc = outc;
             outc += sprintf(tempbuf, "%d", ival);
-            if (outc < BUFSIZ-1) 
+            if (outc < BUFFER_SIZE-1) 
             {
                strcpy(outbuf + oldoutc, tempbuf);
             }
@@ -361,7 +419,7 @@ void log_error(int loglevel, char *fmt, ...)
             uval = va_arg( ap, unsigned );
             oldoutc = outc;
             outc += sprintf(tempbuf, "%u", uval);
-            if (outc < BUFSIZ-1) 
+            if (outc < BUFFER_SIZE-1) 
             {
                strcpy(outbuf + oldoutc, tempbuf);
             }
@@ -388,7 +446,7 @@ void log_error(int loglevel, char *fmt, ...)
             else
             {
                /* Error */
-               sprintf(outbuf, "IJB(%d) Error: log_error(): Bad format string:\n"
+               sprintf(outbuf, "IJB(%ld) Error: log_error(): Bad format string:\n"
                                "Format = \"%s\"\n"
                                "Exiting.", this_thread, fmt);
                /* FIXME RACE HAZARD: should start critical section error_log_use here */
@@ -402,7 +460,7 @@ void log_error(int loglevel, char *fmt, ...)
                /* Never get here */
                break;
             }
-            if (outc < BUFSIZ-1) 
+            if (outc < BUFFER_SIZE-1) 
             {
                strcpy(outbuf + oldoutc, tempbuf);
             }
@@ -422,7 +480,7 @@ void log_error(int loglevel, char *fmt, ...)
             sval = va_arg( ap, char * );
             oldoutc = outc;
             outc += strlen(sval);
-            if (outc < BUFSIZ-1) 
+            if (outc < BUFFER_SIZE-1) 
             {
                strcpy(outbuf + oldoutc, sval);
             }
@@ -431,22 +489,48 @@ void log_error(int loglevel, char *fmt, ...)
                outbuf[oldoutc] = '\0';
             }
             break;
+         case 'N':
+            /* Non-standard: Print a counted string.  Takes 2 parameters:
+             * int length, const char * string
+             */
+            ival = va_arg( ap, int );
+            sval = va_arg( ap, char * );
+            if (ival < 0)
+            {
+               ival = 0;
+            }
+            oldoutc = outc;
+            outc += ival;
+            if (outc < BUFFER_SIZE-1)
+            {
+               memcpy(outbuf + oldoutc, sval, ival);
+            }
+            else
+            {
+               outbuf[oldoutc] = '\0';
+            }
+            break;
          case 'E':
             /* Non-standard: Print error code from errno */
-            ival = errno;
-#ifndef NOSTRERROR
+#ifdef _WIN32
+            ival = WSAGetLastError();
+            sval = w32_socket_strerr(ival, tempbuf);
+#else /* ifndef _WIN32 */
+            ival = errno; 
+#ifdef HAVE_STRERROR
             sval = strerror(ival);
-#else /* def NOSTRERROR */
-            sval = NULL
-#endif /* def NOSTRERROR */
+#else /* ifndef HAVE_STRERROR */
+            sval = NULL;
+#endif /* ndef HAVE_STRERROR */
             if (sval == NULL)
             {
                sprintf(tempbuf, "(errno = %d)", ival);
                sval = tempbuf;
             }
+#endif /* ndef _WIN32 */
             oldoutc = outc;
             outc += strlen(sval);
-            if (outc < BUFSIZ-1) 
+            if (outc < BUFFER_SIZE-1) 
             {
                strcpy(outbuf + oldoutc, sval);
             }
@@ -455,8 +539,41 @@ void log_error(int loglevel, char *fmt, ...)
                outbuf[oldoutc] = '\0';
             }
             break;
+         case 'T':
+            /* Non-standard: Print a Common Log File timestamp */
+            {
+               /*
+                * Write timestamp into tempbuf.
+                *
+                * Complex because not all OSs have tm_gmtoff or
+                * the %z field in strftime()
+                */
+               time_t now; 
+               struct tm *tm_now; 
+               struct tm gmt; 
+               int days, hrs, mins; 
+               time (&now); 
+               gmt = *gmtime (&now); 
+               tm_now = localtime (&now); 
+               days = tm_now->tm_yday - gmt.tm_yday; 
+               hrs = ((days < -1 ? 24 : 1 < days ? -24 : days * 24) + tm_now->tm_hour - gmt.tm_hour); 
+               mins = hrs * 60 + tm_now->tm_min - gmt.tm_min; 
+               strftime (tempbuf, BUFFER_SIZE-6, "%d/%b/%Y:%H:%M:%S ", tm_now); 
+               sprintf (tempbuf + strlen(tempbuf), "%+03d%02d", mins / 60, abs(mins) % 60); 
+            }
+            oldoutc = outc;
+            outc += strlen(tempbuf);
+            if (outc < BUFFER_SIZE-1) 
+            {
+               strcpy(outbuf + oldoutc, tempbuf);
+            }
+            else
+            {
+               outbuf[oldoutc] = '\0';
+            }
+            break;
          default:
-            sprintf(outbuf, "IJB(%d) Error: log_error(): Bad format string:\n"
+            sprintf(outbuf, "IJB(%ld) Error: log_error(): Bad format string:\n"
                             "Format = \"%s\"\n"
                             "Exiting.", this_thread, fmt);
             /* FIXME RACE HAZARD: should start critical section error_log_use here */
@@ -477,20 +594,20 @@ void log_error(int loglevel, char *fmt, ...)
    /* done with var. args */
    va_end( ap );
    
-   if (outc >= BUFSIZ-2)
+   if (outc >= BUFFER_SIZE-2)
    {
       /* insufficient room for newline and trailing null. */
 
       static const char warning[] = "... [too long, truncated]\n";
 
-      if (outc < BUFSIZ)
+      if (outc < BUFFER_SIZE)
       {
          /* Need to add terminating null in this case. */
          outbuf[outc] = '\0';
       }
 
       /* Truncate output */
-      outbuf[BUFSIZ - sizeof(warning)] = '\0';
+      outbuf[BUFFER_SIZE - sizeof(warning)] = '\0';
 
       /* Append warning */
       strcat(outbuf, warning);
@@ -528,6 +645,96 @@ void log_error(int loglevel, char *fmt, ...)
 }
 
 
+#ifdef _WIN32
+/*********************************************************************
+ *
+ * Function    :  w32_socket_strerr
+ *
+ * Description :  Translate the return value from WSAGetLastError()
+ *                into a string.
+ *
+ * Parameters  :
+ *          1  :  errcode = The return value from WSAGetLastError().
+ *          2  :  tmp_buf = A temporary buffer that might be used to
+ *                          store the string.
+ *
+ * Returns     :  String representing the error code.  This may be
+ *                a global string constant or a string stored in
+ *                tmp_buf.
+ *
+ *********************************************************************/
+static char *w32_socket_strerr(int errcode, char *tmp_buf)
+{
+#define TEXT_FOR_ERROR(code,text) \
+   if (errcode == code)           \
+   {                              \
+      return #code " - " text;    \
+   }
+
+   TEXT_FOR_ERROR(WSAEACCES, "Permission denied")
+   TEXT_FOR_ERROR(WSAEADDRINUSE, "Address already in use.")
+   TEXT_FOR_ERROR(WSAEADDRNOTAVAIL, "Cannot assign requested address.");
+   TEXT_FOR_ERROR(WSAEAFNOSUPPORT, "Address family not supported by protocol family.");
+   TEXT_FOR_ERROR(WSAEALREADY, "Operation already in progress.");
+   TEXT_FOR_ERROR(WSAECONNABORTED, "Software caused connection abort.");
+   TEXT_FOR_ERROR(WSAECONNREFUSED, "Connection refused.");
+   TEXT_FOR_ERROR(WSAECONNRESET, "Connection reset by peer.");
+   TEXT_FOR_ERROR(WSAEDESTADDRREQ, "Destination address required.");
+   TEXT_FOR_ERROR(WSAEFAULT, "Bad address.");
+   TEXT_FOR_ERROR(WSAEHOSTDOWN, "Host is down.");
+   TEXT_FOR_ERROR(WSAEHOSTUNREACH, "No route to host.");
+   TEXT_FOR_ERROR(WSAEINPROGRESS, "Operation now in progress.");
+   TEXT_FOR_ERROR(WSAEINTR, "Interrupted function call.");
+   TEXT_FOR_ERROR(WSAEINVAL, "Invalid argument.");
+   TEXT_FOR_ERROR(WSAEISCONN, "Socket is already connected.");
+   TEXT_FOR_ERROR(WSAEMFILE, "Too many open sockets.");
+   TEXT_FOR_ERROR(WSAEMSGSIZE, "Message too long.");
+   TEXT_FOR_ERROR(WSAENETDOWN, "Network is down.");
+   TEXT_FOR_ERROR(WSAENETRESET, "Network dropped connection on reset.");
+   TEXT_FOR_ERROR(WSAENETUNREACH, "Network is unreachable.");
+   TEXT_FOR_ERROR(WSAENOBUFS, "No buffer space available.");
+   TEXT_FOR_ERROR(WSAENOPROTOOPT, "Bad protocol option.");
+   TEXT_FOR_ERROR(WSAENOTCONN, "Socket is not connected.");
+   TEXT_FOR_ERROR(WSAENOTSOCK, "Socket operation on non-socket.");
+   TEXT_FOR_ERROR(WSAEOPNOTSUPP, "Operation not supported.");
+   TEXT_FOR_ERROR(WSAEPFNOSUPPORT, "Protocol family not supported.");
+   TEXT_FOR_ERROR(WSAEPROCLIM, "Too many processes.");
+   TEXT_FOR_ERROR(WSAEPROTONOSUPPORT, "Protocol not supported.");
+   TEXT_FOR_ERROR(WSAEPROTOTYPE, "Protocol wrong type for socket.");
+   TEXT_FOR_ERROR(WSAESHUTDOWN, "Cannot send after socket shutdown.");
+   TEXT_FOR_ERROR(WSAESOCKTNOSUPPORT, "Socket type not supported.");
+   TEXT_FOR_ERROR(WSAETIMEDOUT, "Connection timed out.");
+   TEXT_FOR_ERROR(WSAEWOULDBLOCK, "Resource temporarily unavailable.");
+   TEXT_FOR_ERROR(WSAHOST_NOT_FOUND, "Host not found.");
+   TEXT_FOR_ERROR(WSANOTINITIALISED, "Successful WSAStartup not yet performed.");
+   TEXT_FOR_ERROR(WSANO_DATA, "Valid name, no data record of requested type.");
+   TEXT_FOR_ERROR(WSANO_RECOVERY, "This is a non-recoverable error.");
+   TEXT_FOR_ERROR(WSASYSNOTREADY, "Network subsystem is unavailable.");
+   TEXT_FOR_ERROR(WSATRY_AGAIN, "Non-authoritative host not found.");
+   TEXT_FOR_ERROR(WSAVERNOTSUPPORTED, "WINSOCK.DLL version out of range.");
+   TEXT_FOR_ERROR(WSAEDISCON, "Graceful shutdown in progress.");
+   /*
+    * The following error codes are documented in the Microsoft WinSock
+    * reference guide, but don't actually exist.
+    *
+    * TEXT_FOR_ERROR(WSA_INVALID_HANDLE, "Specified event object handle is invalid.");
+    * TEXT_FOR_ERROR(WSA_INVALID_PARAMETER, "One or more parameters are invalid.");
+    * TEXT_FOR_ERROR(WSAINVALIDPROCTABLE, "Invalid procedure table from service provider.");
+    * TEXT_FOR_ERROR(WSAINVALIDPROVIDER, "Invalid service provider version number.");
+    * TEXT_FOR_ERROR(WSA_IO_PENDING, "Overlapped operations will complete later.");
+    * TEXT_FOR_ERROR(WSA_IO_INCOMPLETE, "Overlapped I/O event object not in signaled state.");
+    * TEXT_FOR_ERROR(WSA_NOT_ENOUGH_MEMORY, "Insufficient memory available.");
+    * TEXT_FOR_ERROR(WSAPROVIDERFAILEDINIT, "Unable to initialize a service provider.");
+    * TEXT_FOR_ERROR(WSASYSCALLFAILURE, "System call failure.");
+    * TEXT_FOR_ERROR(WSA_OPERATION_ABORTED, "Overlapped operation aborted.");
+    */
+
+   sprintf(tmp_buf, "(error number %d)", errcode);
+   return tmp_buf;
+}
+#endif /* def _WIN32 */
+
+
 /*
   Local Variables:
   tab-width: 3