dan
/
tor-android
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
tor-android/external/privoxy/errlog.c

1548 lines
51 KiB
C
Raw Normal View History

privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
const char errlog_rcs[] = "$Id: errlog.c,v 1.92 2009/03/20 03:39:31 ler762 Exp $";
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/errlog.c,v $
*
* Purpose : Log errors to a designated destination in an elegant,
* printf-like fashion.
*
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* Copyright : Written by and Copyright (C) 2001-2009 the SourceForge
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* by and Copyright (C) 1997 Anonymous Coders and
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* Junkbusters Corporation. http://www.junkbusters.com
*
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* This program is free software; you can redistribute it
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* and/or modify it under the terms of the GNU General
* Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will
* be useful, but WITHOUT ANY WARRANTY; without even the
* implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU General Public
* License for more details.
*
* The GNU General Public License should be included with
* this file. If not, you can view it at
* http://www.gnu.org/copyleft/gpl.html
* or write to the Free Software Foundation, Inc., 59
* Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* Revisions :
* $Log: errlog.c,v $
* Revision 1.92 2009/03/20 03:39:31 ler762
* I like having the version logged at startup and the Windows GUI stopped logging
* it after LOG_LEVEL_INFO was removed from
* static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR | LOG_LEVEL_INFO);
*
* Revision 1.91 2009/03/18 21:56:30 fabiankeil
* In init_error_log(), suppress the "(Re-)Opening logfile" message if
* we're still logging to stderr. This restores the "silent mode", but
* with LOG_LEVEL_INFO enabled, the show_version() info is written to
* the logfile as intended.
*
* Revision 1.90 2009/03/18 20:43:19 fabiankeil
* Don't enable LOG_LEVEL_INFO by default and don't apply the user's
* debug settings until the logfile has been opened (if there is one).
* Patch submitted by Roland in #2624120.
*
* Revision 1.89 2009/03/07 12:56:12 fabiankeil
* Add log_error() support for unsigned long long (%lld).
*
* Revision 1.88 2009/03/07 11:34:36 fabiankeil
* Omit timestamp and thread id in the mingw32 message box.
*
* Revision 1.87 2009/03/01 18:28:24 fabiankeil
* Help clang understand that we aren't dereferencing
* NULL pointers here.
*
* Revision 1.86 2009/02/09 21:21:15 fabiankeil
* Now that init_log_module() is called earlier, call show_version()
* later on from main() directly so it doesn't get called for --help
* or --version.
*
* Revision 1.85 2009/02/06 17:51:38 fabiankeil
* Be prepared if I break the log module initialization again.
*
* Revision 1.84 2008/12/14 15:46:22 fabiankeil
* Give crunched requests their own log level.
*
* Revision 1.83 2008/12/04 18:14:32 fabiankeil
* Fix some cparser warnings.
*
* Revision 1.82 2008/11/23 16:06:58 fabiankeil
* Update a log message I missed in 1.80.
*
* Revision 1.81 2008/11/23 15:59:27 fabiankeil
* - Update copyright range.
* - Remove stray line breaks in a log message
* nobody is supposed to see anyway.
*
* Revision 1.80 2008/11/23 15:49:49 fabiankeil
* In log_error(), don't surround the thread id with "Privoxy(" and ")".
*
* Revision 1.79 2008/10/20 17:09:25 fabiankeil
* Update init_error_log() description to match reality.
*
* Revision 1.78 2008/09/07 16:59:31 fabiankeil
* Update a comment to reflect that we
* have mutex support on mingw32 now.
*
* Revision 1.77 2008/09/07 12:43:44 fabiankeil
* Move the LogPutString() call in log_error() into the locked
* region so the Windows GUI log is consistent with the logfile.
*
* Revision 1.76 2008/09/07 12:35:05 fabiankeil
* Add mutex lock support for _WIN32.
*
* Revision 1.75 2008/09/04 08:13:58 fabiankeil
* Prepare for critical sections on Windows by adding a
* layer of indirection before the pthread mutex functions.
*
* Revision 1.74 2008/08/06 18:33:36 fabiankeil
* If the "close fd first" workaround doesn't work,
* the fatal error message will be lost, so we better
* explain the consequences while we still can.
*
* Revision 1.73 2008/08/04 19:06:55 fabiankeil
* Add a lame workaround for the "can't open an already open
* logfile on OS/2" problem reported by Maynard in #2028842
* and describe what a real solution would look like.
*
* Revision 1.72 2008/07/27 12:04:28 fabiankeil
* Fix a comment typo.
*
* Revision 1.71 2008/06/28 17:17:15 fabiankeil
* Remove another stray semicolon.
*
* Revision 1.70 2008/06/28 17:10:29 fabiankeil
* Remove stray semicolon in get_log_timestamp().
* Reported by Jochen Voss in #2005221.
*
* Revision 1.69 2008/05/30 15:55:25 fabiankeil
* Declare variable "debug" static and complain about its name.
*
* Revision 1.68 2008/04/27 16:50:46 fabiankeil
* Remove an incorrect assertion. The value of debug may change if
* the configuration is reloaded in another thread. While we could
* cache the initial value, the assertion doesn't seem worth it.
*
* Revision 1.67 2008/03/27 18:27:23 fabiankeil
* Remove kill-popups action.
*
* Revision 1.66 2008/01/31 15:38:14 fabiankeil
* - Make the logfp assertion more strict. As of 1.63, the "||" could
* have been an "&&", which means we can use two separate assertions
* and skip on of them on Windows.
* - Break a long commit message line in two.
*
* Revision 1.65 2008/01/31 14:44:33 fabiankeil
* Use (a != b) instead of !(a == b) so the sanity check looks less insane.
*
* Revision 1.64 2008/01/21 18:56:46 david__schmidt
* Swap #def from negative to positive, re-joined it so it didn't
* span an assertion (compilation failure on OS/2)
*
* Revision 1.63 2007/12/15 19:49:32 fabiankeil
* Stop overloading logfile to control the mingw32 log window as well.
* It's no longer necessary now that we disable all debug lines by default
* and at least one user perceived it as a regression (added in 1.55).
*
* Revision 1.62 2007/11/30 15:33:46 fabiankeil
* Unbreak LOG_LEVEL_FATAL. It wasn't fatal with logging disabled
* and on mingw32 fatal log messages didn't end up in the log file.
*
* Revision 1.61 2007/11/04 19:03:01 fabiankeil
* Fix another deadlock Hal spotted and that mysteriously didn't affect FreeBSD.
*
* Revision 1.60 2007/11/03 19:03:31 fabiankeil
* - Prevent the Windows GUI from showing the version two times in a row.
* - Stop using the imperative in the "(Re-)Open logfile" message.
* - Ditch the "Switching to daemon mode" message as the detection
* whether or not we're already in daemon mode doesn't actually work.
*
* Revision 1.59 2007/11/01 12:50:56 fabiankeil
* Here's looking at you, deadlock.
*
* Revision 1.58 2007/10/28 19:04:21 fabiankeil
* Don't mention daemon mode in "Logging disabled" message. Some
* platforms call it differently and it's not really relevant anyway.
*
* Revision 1.57 2007/10/27 13:02:26 fabiankeil
* Relocate daemon-mode-related log messages to make sure
* they aren't shown again in case of configuration reloads.
*
* Revision 1.56 2007/10/14 14:26:56 fabiankeil
* Remove the old log_error() version.
*
* Revision 1.55 2007/10/14 14:12:41 fabiankeil
* When in daemon mode, close stderr after the configuration file has been
* parsed the first time. If logfile isn't set, stop logging. Fixes BR#897436.
*
* Revision 1.54 2007/09/22 16:15:34 fabiankeil
* - Let it compile with pcc.
* - Move our includes below system includes to prevent macro conflicts.
*
* Revision 1.53 2007/08/05 13:53:14 fabiankeil
* #1763173 from Stefan Huehner: declare some more functions
* static and use void instead of empty parameter lists.
*
* Revision 1.52 2007/07/14 07:28:47 fabiankeil
* Add translation function for JB_ERR_FOO codes.
*
* Revision 1.51 2007/05/11 11:51:34 fabiankeil
* Fix a type mismatch warning.
*
* Revision 1.50 2007/04/11 10:55:44 fabiankeil
* Enforce some assertions that could be triggered
* on mingw32 and other systems where we use threads
* but no locks.
*
* Revision 1.49 2007/04/08 16:44:15 fabiankeil
* We need <sys/time.h> for gettimeofday(), not <time.h>.
*
* Revision 1.48 2007/03/31 13:33:28 fabiankeil
* Add alternative log_error() with timestamps
* that contain milliseconds and without using
* strcpy(), strcat() or sprintf().
*
* Revision 1.47 2006/11/28 15:25:15 fabiankeil
* Only unlink the pidfile if it's actually used.
*
* Revision 1.46 2006/11/13 19:05:51 fabiankeil
* Make pthread mutex locking more generic. Instead of
* checking for OSX and OpenBSD, check for FEATURE_PTHREAD
* and use mutex locking unless there is an _r function
* available. Better safe than sorry.
*
* Fixes "./configure --disable-pthread" and should result
* in less threading-related problems on pthread-using platforms,
* but it still doesn't fix BR#1122404.
*
* Revision 1.45 2006/08/21 11:15:54 david__schmidt
* MS Visual C++ build updates
*
* Revision 1.44 2006/08/18 16:03:16 david__schmidt
* Tweak for OS/2 build happiness.
*
* Revision 1.43 2006/08/03 02:46:41 david__schmidt
* Incorporate Fabian Keil's patch work:
* http://www.fabiankeil.de/sourcecode/privoxy/
*
* Revision 1.42 2006/07/18 14:48:46 david__schmidt
* Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
* with what was really the latest development (the v_3_0_branch branch)
*
* Revision 1.40.2.4 2005/04/03 20:10:50 david__schmidt
* Thanks to Jindrich Makovicka for a race condition fix for the log
* file. The race condition remains for non-pthread implementations.
* Reference patch #1175720.
*
* Revision 1.40.2.3 2003/03/07 03:41:04 david__schmidt
* Wrapping all *_r functions (the non-_r versions of them) with mutex
* semaphores for OSX. Hopefully this will take care of all of those pesky
* crash reports.
*
* Revision 1.40.2.2 2002/09/28 00:30:57 david__schmidt
* Update error logging to give sane values for thread IDs on Mach kernels.
* It's still a hack, but at least it looks farily normal. We print the
* absolute value of the first 4 bytes of the pthread_t modded with 1000.
*
* Revision 1.40.2.1 2002/09/25 12:47:42 oes
* Make log_error safe against NULL string arguments
*
* Revision 1.40 2002/05/22 01:27:27 david__schmidt
*
* Add os2_socket_strerr mirroring w32_socket_strerr.
*
* Revision 1.39 2002/04/03 17:15:27 gliptak
* zero padding thread ids in log
*
* Revision 1.38 2002/03/31 17:18:59 jongfoster
* Win32 only: Enabling STRICT to fix a VC++ compile warning.
*
* Revision 1.37 2002/03/27 14:32:43 david__schmidt
* More compiler warning message maintenance
*
* Revision 1.36 2002/03/26 22:29:54 swa
* we have a new homepage!
*
* Revision 1.35 2002/03/24 15:23:33 jongfoster
* Name changes
*
* Revision 1.34 2002/03/24 13:25:43 swa
* name change related issues
*
* Revision 1.33 2002/03/13 00:27:04 jongfoster
* Killing warnings
*
* Revision 1.32 2002/03/07 03:46:17 oes
* Fixed compiler warnings
*
* Revision 1.31 2002/03/06 23:02:57 jongfoster
* Removing tabs
*
* Revision 1.30 2002/03/05 22:43:45 david__schmidt
* - Better error reporting on OS/2
* - Fix double-slash comment (oops)
*
* Revision 1.29 2002/03/04 23:45:13 jongfoster
* Printing thread ID if using Win32 native threads
*
* Revision 1.28 2002/03/04 17:59:59 oes
* Deleted deletePidFile(), cosmetics
*
* Revision 1.27 2002/03/04 02:08:01 david__schmidt
* Enable web editing of actions file on OS/2 (it had been broken all this time!)
*
* Revision 1.26 2002/01/09 19:05:45 steudten
* Fix big memory leak.
*
* Revision 1.25 2002/01/09 14:32:08 oes
* Added support for gmtime_r and localtime_r.
*
* Revision 1.24 2001/12/30 14:07:32 steudten
* - Add signal handling (unix)
* - Add SIGHUP handler (unix)
* - Add creation of pidfile (unix)
* - Add action 'top' in rc file (RH)
* - Add entry 'SIGNALS' to manpage
* - Add exit message to logfile (unix)
*
* Revision 1.23 2001/11/07 00:02:13 steudten
* Add line number in error output for lineparsing for
* actionsfile and configfile.
* Special handling for CLF added.
*
* Revision 1.22 2001/11/05 23:43:05 steudten
* Add time+date to log files.
*
* Revision 1.21 2001/10/25 03:40:47 david__schmidt
* Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
* threads to call select() simultaneously. So, it's time to do a real, live,
* native OS/2 port. See defines for __EMX__ (the porting layer) vs. __OS2__
* (native). Both versions will work, but using __OS2__ offers multi-threading.
*
* Revision 1.20 2001/09/16 23:04:34 jongfoster
* Fixing a warning
*
* Revision 1.19 2001/09/13 20:08:06 jongfoster
* Adding support for LOG_LEVEL_CGI
*
* 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)
*
* Revision 1.5 2001/05/22 18:46:04 oes
*
* - Enabled filtering banners by size rather than URL
* by adding patterns that replace all standard banner
* sizes with the "Junkbuster" gif to the re_filterfile
*
* - Enabled filtering WebBugs by providing a pattern
* which kills all 1x1 images
*
* - Added support for PCRE_UNGREEDY behaviour to pcrs,
* which is selected by the (nonstandard and therefore
* capital) letter 'U' in the option string.
* It causes the quantifiers to be ungreedy by default.
* Appending a ? turns back to greedy (!).
*
* - Added a new interceptor ijb-send-banner, which
* sends back the "Junkbuster" gif. Without imagelist or
* MSIE detection support, or if tinygif = 1, or the
* URL isn't recognized as an imageurl, a lame HTML
* explanation is sent instead.
*
* - Added new feature, which permits blocking remote
* script redirects and firing back a local redirect
* to the browser.
* The feature is conditionally compiled, i.e. it
* can be disabled with --disable-fast-redirects,
* plus it must be activated by a "fast-redirects"
* line in the config file, has its own log level
* and of course wants to be displayed by show-proxy-args
* Note: Boy, all the #ifdefs in 1001 locations and
* all the fumbling with configure.in and acconfig.h
* were *way* more work than the feature itself :-(
*
* - Because a generic redirect template was needed for
* this, tinygif = 3 now uses the same.
*
* - Moved GIFs, and other static HTTP response templates
* to project.h
*
* - Some minor fixes
*
* - Removed some >400 CRs again (Jon, you really worked
* a lot! ;-)
*
* Revision 1.4 2001/05/21 19:32:54 jongfoster
* Added another #ifdef _WIN_CONSOLE
*
* Revision 1.3 2001/05/20 01:11:40 jongfoster
* Added support for LOG_LEVEL_FATAL
* Renamed LOG_LEVEL_FRC to LOG_LEVEL_FORCE,
* and LOG_LEVEL_REF to LOG_LEVEL_RE_FILTER
*
* Revision 1.2 2001/05/17 22:42:01 oes
* - Cleaned CRLF's from the sources and related files
* - Repaired logging for REF and FRC
*
* Revision 1.1.1.1 2001/05/15 13:58:51 oes
* Initial import of version 2.9.3 source tree
*
*
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
*********************************************************************/
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include "config.h"
#include "miscutil.h"
/* For gettimeofday() */
#include <sys/time.h>
#if !defined(_WIN32) && !defined(__OS2__)
#include <unistd.h>
#endif /* !defined(_WIN32) && !defined(__OS2__) */
#include <errno.h>
#include <assert.h>
#ifdef _WIN32
#ifndef STRICT
#define STRICT
#endif
#include <windows.h>
#ifndef _WIN_CONSOLE
#include "w32log.h"
#endif /* ndef _WIN_CONSOLE */
#endif /* def _WIN32 */
#ifdef _MSC_VER
#define inline __inline
#endif /* def _MSC_VER */
#ifdef __OS2__
#include <sys/socket.h> /* For sock_errno */
#define INCL_DOS
#include <os2.h>
#endif
#include "errlog.h"
#include "project.h"
#include "jcc.h"
const char errlog_h_rcs[] = ERRLOG_H_VERSION;
/*
* 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
/* where to log (default: stderr) */
static FILE *logfp = NULL;
/* logging detail level. XXX: stupid name. */
static int debug = (LOG_LEVEL_FATAL | LOG_LEVEL_ERROR);
/* static functions */
static void fatal_error(const char * error_message);
#ifdef _WIN32
static char *w32_socket_strerr(int errcode, char *tmp_buf);
#endif
#ifdef __OS2__
static char *os2_socket_strerr(int errcode, char *tmp_buf);
#endif
#ifdef MUTEX_LOCKS_AVAILABLE
static inline void lock_logfile(void)
{
privoxy_mutex_lock(&log_mutex);
}
static inline void unlock_logfile(void)
{
privoxy_mutex_unlock(&log_mutex);
}
static inline void lock_loginit(void)
{
privoxy_mutex_lock(&log_init_mutex);
}
static inline void unlock_loginit(void)
{
privoxy_mutex_unlock(&log_init_mutex);
}
#else /* ! MUTEX_LOCKS_AVAILABLE */
/*
* FIXME we need a cross-platform locking mechanism.
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* The locking/unlocking functions below should be
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* fleshed out for non-pthread implementations.
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
*/
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
static inline void lock_logfile() {}
static inline void unlock_logfile() {}
static inline void lock_loginit() {}
static inline void unlock_loginit() {}
#endif
/*********************************************************************
*
* Function : fatal_error
*
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* Description : Displays a fatal error to standard error (or, on
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* a WIN32 GUI, to a dialog box), and exits Privoxy
* with status code 1.
*
* Parameters :
* 1 : error_message = The error message to display.
*
* Returns : Does not return.
*
*********************************************************************/
static void fatal_error(const char *error_message)
{
#if defined(_WIN32) && !defined(_WIN_CONSOLE)
/* Skip timestamp and thread id for the message box. */
const char *box_message = strstr(error_message, "Fatal error");
if (NULL == box_message)
{
/* Shouldn't happen but ... */
box_message = error_message;
}
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
MessageBox(g_hwndLogFrame, box_message, "Privoxy Error",
MB_OK | MB_ICONERROR | MB_TASKMODAL | MB_SETFOREGROUND | MB_TOPMOST);
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
/* Cleanup - remove taskbar icon etc. */
TermLogWindow();
#endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
if (logfp != NULL)
{
fputs(error_message, logfp);
}
#if defined(unix)
if (pidfile)
{
unlink(pidfile);
}
#endif /* unix */
exit(1);
}
/*********************************************************************
*
* Function : show_version
*
* Description : Logs the Privoxy version and the program name.
*
* Parameters :
* 1 : prog_name = The program name.
*
* Returns : Nothing.
*
*********************************************************************/
void show_version(const char *prog_name)
{
log_error(LOG_LEVEL_INFO, "Privoxy version " VERSION);
if (prog_name != NULL)
{
log_error(LOG_LEVEL_INFO, "Program name: %s", prog_name);
}
}
/*********************************************************************
*
* Function : init_log_module
*
* Description : Initializes the logging module to log to stderr.
* Can only be called while stderr hasn't been closed
* yet and is only supposed to be called once.
*
* Parameters :
* 1 : prog_name = The program name.
*
* Returns : Nothing.
*
*********************************************************************/
void init_log_module(void)
{
lock_logfile();
logfp = stderr;
unlock_logfile();
set_debug_level(debug);
}
/*********************************************************************
*
* Function : set_debug_level
*
* Description : Sets the debug level to the provided value
* plus LOG_LEVEL_MINIMUM.
*
* XXX: we should only use the LOG_LEVEL_MINIMUM
* until the first time the configuration file has
* been parsed.
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
*
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* Parameters : 1: debug_level = The debug level to set.
*
* Returns : Nothing.
*
*********************************************************************/
void set_debug_level(int debug_level)
{
debug = debug_level | LOG_LEVEL_MINIMUM;
}
/*********************************************************************
*
* Function : disable_logging
*
* Description : Disables logging.
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
*
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* Parameters : None.
*
* Returns : Nothing.
*
*********************************************************************/
void disable_logging(void)
{
if (logfp != NULL)
{
log_error(LOG_LEVEL_INFO,
"No logfile configured. Please enable it before reporting any problems.");
lock_logfile();
fclose(logfp);
logfp = NULL;
unlock_logfile();
}
}
/*********************************************************************
*
* Function : init_error_log
*
* Description : Initializes the logging module to log to a file.
*
* XXX: should be renamed.
*
* Parameters :
* 1 : prog_name = The program name.
* 2 : logfname = The logfile to (re)open.
*
* Returns : N/A
*
*********************************************************************/
void init_error_log(const char *prog_name, const char *logfname)
{
FILE *fp;
assert(NULL != logfname);
lock_loginit();
if ((logfp != NULL) && (logfp != stderr))
{
log_error(LOG_LEVEL_INFO, "(Re-)Opening logfile \'%s\'", logfname);
}
/* set the designated log file */
fp = fopen(logfname, "a");
if ((NULL == fp) && (logfp != NULL))
{
/*
* Some platforms (like OS/2) don't allow us to open
* the same file twice, therefore we give it another
* shot after closing the old file descriptor first.
*
* We don't do it right away because it prevents us
* from logging the "can't open logfile" message to
* the old logfile.
*
* XXX: this is a lame workaround and once the next
* release is out we should stop bothering reopening
* the logfile unless we have to.
*
* Currently we reopen it every time the config file
* has been reloaded, but actually we only have to
* reopen it if the file name changed or if the
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* configuration reloas was caused by a SIGHUP.
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
*/
log_error(LOG_LEVEL_INFO, "Failed to reopen logfile: \'%s\'. "
"Retrying after closing the old file descriptor first. If that "
"doesn't work, Privoxy will exit without being able to log a message.",
logfname);
lock_logfile();
fclose(logfp);
logfp = NULL;
unlock_logfile();
fp = fopen(logfname, "a");
}
if (NULL == fp)
{
log_error(LOG_LEVEL_FATAL, "init_error_log(): can't open logfile: \'%s\'", logfname);
}
/* set logging to be completely unbuffered */
setbuf(fp, NULL);
lock_logfile();
if (logfp != NULL)
{
fclose(logfp);
}
logfp = fp;
unlock_logfile();
show_version(prog_name);
unlock_loginit();
} /* init_error_log */
/*********************************************************************
*
* Function : get_thread_id
*
* Description : Returns a number that is different for each thread.
*
* XXX: Should be moved elsewhere (miscutil.c?)
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
*
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* Parameters : None
*
* Returns : thread_id
*
*********************************************************************/
static long get_thread_id(void)
{
long this_thread = 1; /* was: pthread_t this_thread;*/
#ifdef __OS2__
PTIB ptib;
APIRET ulrc; /* XXX: I have no clue what this does */
#endif /* __OS2__ */
/* FIXME get current thread id */
#ifdef FEATURE_PTHREAD
this_thread = (long)pthread_self();
#ifdef __MACH__
/*
* Mac OSX (and perhaps other Mach instances) doesn't have a debuggable
* value at the first 4 bytes of pthread_self()'s return value, a pthread_t.
* pthread_t is supposed to be opaque... but it's fairly random, though, so
* we make it mostly presentable.
*/
this_thread = abs(this_thread % 1000);
#endif /* def __MACH__ */
#elif defined(_WIN32)
this_thread = GetCurrentThreadId();
#elif defined(__OS2__)
ulrc = DosGetInfoBlocks(&ptib, NULL);
if (ulrc == 0)
this_thread = ptib -> tib_ptib2 -> tib2_ultid;
#endif /* def FEATURE_PTHREAD */
return this_thread;
}
/*********************************************************************
*
* Function : get_log_timestamp
*
* Description : Generates the time stamp for the log message prefix.
*
* Parameters :
* 1 : buffer = Storage buffer
* 2 : buffer_size = Size of storage buffer
*
* Returns : Number of written characters or 0 for error.
*
*********************************************************************/
static inline size_t get_log_timestamp(char *buffer, size_t buffer_size)
{
size_t length;
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
time_t now;
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
struct tm tm_now;
struct timeval tv_now; /* XXX: stupid name */
long msecs;
int msecs_length = 0;
gettimeofday(&tv_now, NULL);
msecs = tv_now.tv_usec / 1000;
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
time(&now);
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
#ifdef HAVE_LOCALTIME_R
tm_now = *localtime_r(&now, &tm_now);
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
#elif FEATURE_PTHREAD
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
privoxy_mutex_lock(&localtime_mutex);
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
tm_now = *localtime(&now);
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
privoxy_mutex_unlock(&localtime_mutex);
#else
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
tm_now = *localtime(&now);
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
#endif
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
length = strftime(buffer, buffer_size, "%b %d %H:%M:%S", &tm_now);
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
if (length > (size_t)0)
{
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
msecs_length = snprintf(buffer+length, buffer_size - length, ".%.3ld", msecs);
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
}
if (msecs_length > 0)
{
length += (size_t)msecs_length;
}
else
{
length = 0;
}
return length;
}
/*********************************************************************
*
* Function : get_clf_timestamp
*
* Description : Generates a Common Log Format time string.
*
* Parameters :
* 1 : buffer = Storage buffer
* 2 : buffer_size = Size of storage buffer
*
* Returns : Number of written characters or 0 for error.
*
*********************************************************************/
static inline size_t get_clf_timestamp(char *buffer, size_t buffer_size)
{
/*
* Complex because not all OSs have tm_gmtoff or
* the %z field in strftime()
*/
time_t now;
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
struct tm *tm_now;
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
struct tm gmt;
#ifdef HAVE_LOCALTIME_R
struct tm dummy;
#endif
int days, hrs, mins;
size_t length;
int tz_length = 0;
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
time (&now);
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
#ifdef HAVE_GMTIME_R
gmt = *gmtime_r(&now, &gmt);
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
#elif FEATURE_PTHREAD
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
privoxy_mutex_lock(&gmtime_mutex);
gmt = *gmtime(&now);
privoxy_mutex_unlock(&gmtime_mutex);
#else
gmt = *gmtime(&now);
#endif
#ifdef HAVE_LOCALTIME_R
tm_now = localtime_r(&now, &dummy);
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
#elif FEATURE_PTHREAD
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
privoxy_mutex_lock(&localtime_mutex);
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
tm_now = localtime(&now);
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
privoxy_mutex_unlock(&localtime_mutex);
#else
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
tm_now = localtime(&now);
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
#endif
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
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;
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
length = strftime(buffer, buffer_size, "%d/%b/%Y:%H:%M:%S ", tm_now);
if (length > (size_t)0)
{
tz_length = snprintf(buffer+length, buffer_size-length,
"%+03d%02d", mins / 60, abs(mins) % 60);
}
if (tz_length > 0)
{
length += (size_t)tz_length;
}
else
{
length = 0;
}
return length;
}
/*********************************************************************
*
* Function : get_log_level_string
*
* Description : Translates a numerical loglevel into a string.
*
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* Parameters :
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* 1 : loglevel = LOG_LEVEL_FOO
*
* Returns : Log level string.
*
*********************************************************************/
static inline const char *get_log_level_string(int loglevel)
{
char *log_level_string = NULL;
assert(0 < loglevel);
switch (loglevel)
{
case LOG_LEVEL_ERROR:
log_level_string = "Error";
break;
case LOG_LEVEL_FATAL:
log_level_string = "Fatal error";
break;
case LOG_LEVEL_GPC:
log_level_string = "Request";
break;
case LOG_LEVEL_CONNECT:
log_level_string = "Connect";
break;
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
case LOG_LEVEL_LOG:
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
log_level_string = "Writing";
break;
case LOG_LEVEL_HEADER:
log_level_string = "Header";
break;
case LOG_LEVEL_INFO:
log_level_string = "Info";
break;
case LOG_LEVEL_RE_FILTER:
log_level_string = "Re-Filter";
break;
#ifdef FEATURE_FORCE_LOAD
case LOG_LEVEL_FORCE:
log_level_string = "Force";
break;
#endif /* def FEATURE_FORCE_LOAD */
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
#ifdef FEATURE_FAST_REDIRECTS
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
case LOG_LEVEL_REDIRECTS:
log_level_string = "Redirect";
break;
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
#endif /* def FEATURE_FAST_REDIRECTS */
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
case LOG_LEVEL_DEANIMATE:
log_level_string = "Gif-Deanimate";
break;
case LOG_LEVEL_CRUNCH:
log_level_string = "Crunch";
break;
case LOG_LEVEL_CGI:
log_level_string = "CGI";
break;
default:
log_level_string = "Unknown log level";
break;
}
assert(NULL != log_level_string);
return log_level_string;
}
/*********************************************************************
*
* Function : log_error
*
* Description : This is the error-reporting and logging function.
*
* Parameters :
* 1 : loglevel = the type of message to be logged
* 2 : fmt = the main string we want logged, printf-like
* 3 : ... = arguments to be inserted in fmt (printf-like).
*
* Returns : N/A
*
*********************************************************************/
void log_error(int loglevel, const char *fmt, ...)
{
va_list ap;
char *outbuf = NULL;
static char *outbuf_save = NULL;
char tempbuf[BUFFER_SIZE];
size_t length = 0;
const char * src = fmt;
long thread_id;
char timestamp[30];
/*
* XXX: Make this a config option,
* why else do we allocate instead of using
* an array?
*/
size_t log_buffer_size = BUFFER_SIZE;
#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) || (loglevel == LOG_LEVEL_CRUNCH))
{
LogShowActivity();
}
#endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
/*
* verify that the loglevel applies to current
* settings and that logging is enabled.
* Bail out otherwise.
*/
if ((0 == (loglevel & debug))
#ifndef _WIN32
|| (logfp == NULL)
#endif
)
{
if (loglevel == LOG_LEVEL_FATAL)
{
fatal_error("Fatal error. You're not supposed to"
"see this message. Please file a bug report.");
}
return;
}
thread_id = get_thread_id();
get_log_timestamp(timestamp, sizeof(timestamp));
/* protect the whole function because of the static buffer (outbuf) */
lock_logfile();
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
if (NULL == outbuf_save)
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
{
outbuf_save = (char*)zalloc(log_buffer_size + 1); /* +1 for paranoia */
if (NULL == outbuf_save)
{
snprintf(tempbuf, sizeof(tempbuf),
"%s %08lx Fatal error: Out of memory in log_error().",
timestamp, thread_id);
fatal_error(tempbuf); /* Exit */
return;
}
}
outbuf = outbuf_save;
/*
* Memsetting the whole buffer to zero (in theory)
* makes things easier later on.
*/
memset(outbuf, 0, log_buffer_size);
/* Add prefix for everything but Common Log Format messages */
if (loglevel != LOG_LEVEL_CLF)
{
length = (size_t)snprintf(outbuf, log_buffer_size, "%s %08lx %s: ",
timestamp, thread_id, get_log_level_string(loglevel));
}
/* get ready to scan var. args. */
va_start(ap, fmt);
/* build formatted message from fmt and var-args */
while ((*src) && (length < log_buffer_size-2))
{
const char *sval = NULL; /* %N string */
int ival; /* %N string length or an error code */
unsigned uval; /* %u value */
long lval; /* %l value */
unsigned long ulval; /* %ul value */
char ch;
const char *format_string = tempbuf;
ch = *src++;
if (ch != '%')
{
outbuf[length++] = ch;
/*
* XXX: Only necessary on platforms where multiple threads
* can write to the buffer at the same time because we
* don't support mutexes (OS/2 for example).
*/
outbuf[length] = '\0';
continue;
}
outbuf[length] = '\0';
ch = *src++;
switch (ch) {
case '%':
tempbuf[0] = '%';
tempbuf[1] = '\0';
break;
case 'd':
ival = va_arg( ap, int );
snprintf(tempbuf, sizeof(tempbuf), "%d", ival);
break;
case 'u':
uval = va_arg( ap, unsigned );
snprintf(tempbuf, sizeof(tempbuf), "%u", uval);
break;
case 'l':
/* this is a modifier that must be followed by u, lu, or d */
ch = *src++;
if (ch == 'd')
{
lval = va_arg( ap, long );
snprintf(tempbuf, sizeof(tempbuf), "%ld", lval);
}
else if (ch == 'u')
{
ulval = va_arg( ap, unsigned long );
snprintf(tempbuf, sizeof(tempbuf), "%lu", ulval);
}
else if ((ch == 'l') && (*src == 'u'))
{
unsigned long long lluval = va_arg(ap, unsigned long long);
snprintf(tempbuf, sizeof(tempbuf), "%llu", lluval);
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
ch = *src++;
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
}
else
{
snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
loglevel = LOG_LEVEL_FATAL;
}
break;
case 'c':
/*
* Note that char paramaters are converted to int, so we need to
* pass "int" to va_arg. (See K&R, 2nd ed, section A7.3.2, page 202)
*/
tempbuf[0] = (char) va_arg(ap, int);
tempbuf[1] = '\0';
break;
case 's':
format_string = va_arg(ap, char *);
if (format_string == NULL)
{
format_string = "[null]";
}
break;
case 'N':
/*
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* Non-standard: Print a counted unterminated string.
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
* Takes 2 parameters: int length, const char * string.
*/
ival = va_arg(ap, int);
sval = va_arg(ap, char *);
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
if (sval == NULL)
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
{
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
format_string = "[null]";
}
else if (ival <= 0)
{
if (0 == ival)
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
{
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
/* That's ok (but stupid) */
tempbuf[0] = '\0';
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
}
else
{
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
/*
* That's not ok (and even more stupid)
*/
assert(ival >= 0);
format_string = "[counted string lenght < 0]";
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
}
}
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
else if ((size_t)ival >= sizeof(tempbuf))
{
/*
* String is too long, copy as much as possible.
* It will be further truncated later.
*/
memcpy(tempbuf, sval, sizeof(tempbuf)-1);
tempbuf[sizeof(tempbuf)-1] = '\0';
}
else
{
memcpy(tempbuf, sval, (size_t) ival);
tempbuf[ival] = '\0';
}
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
break;
case 'E':
/* Non-standard: Print error code from errno */
#ifdef _WIN32
ival = WSAGetLastError();
format_string = w32_socket_strerr(ival, tempbuf);
#elif __OS2__
ival = sock_errno();
if (ival != 0)
{
format_string = os2_socket_strerr(ival, tempbuf);
}
else
{
ival = errno;
format_string = strerror(ival);
}
#else /* ifndef _WIN32 */
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
ival = errno;
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
#ifdef HAVE_STRERROR
format_string = strerror(ival);
#else /* ifndef HAVE_STRERROR */
format_string = NULL;
#endif /* ndef HAVE_STRERROR */
if (sval == NULL)
{
snprintf(tempbuf, sizeof(tempbuf), "(errno = %d)", ival);
}
#endif /* ndef _WIN32 */
break;
case 'T':
/* Non-standard: Print a Common Log File timestamp */
get_clf_timestamp(tempbuf, sizeof(tempbuf));
break;
default:
snprintf(tempbuf, sizeof(tempbuf), "Bad format string: \"%s\"", fmt);
loglevel = LOG_LEVEL_FATAL;
break;
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
} /* switch( p ) */
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
assert(length < log_buffer_size);
length += strlcpy(outbuf + length, format_string, log_buffer_size - length);
if (length >= log_buffer_size-2)
{
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
static char warning[] = "... [too long, truncated]";
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
length = log_buffer_size - sizeof(warning) - 1;
length += strlcpy(outbuf + length, warning, log_buffer_size - length);
assert(length < log_buffer_size);
break;
}
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
} /* for( p ... ) */
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
/* done with var. args */
va_end(ap);
assert(length < log_buffer_size);
length += strlcpy(outbuf + length, "\n", log_buffer_size - length);
/* Some sanity checks */
if ((length >= log_buffer_size)
|| (outbuf[log_buffer_size-1] != '\0')
|| (outbuf[log_buffer_size] != '\0')
)
{
/* Repeat as assertions */
assert(length < log_buffer_size);
assert(outbuf[log_buffer_size-1] == '\0');
/*
* outbuf's real size is log_buffer_size+1,
* so while this looks like an off-by-one,
* we're only checking our paranoia byte.
*/
assert(outbuf[log_buffer_size] == '\0');
snprintf(outbuf, log_buffer_size,
"%s %08lx Fatal error: log_error()'s sanity checks failed."
"length: %d. Exiting.",
timestamp, thread_id, (int)length);
loglevel = LOG_LEVEL_FATAL;
}
#ifndef _WIN32
/*
* On Windows this is acceptable in case
* we are logging to the GUI window only.
*/
assert(NULL != logfp);
#endif
if (loglevel == LOG_LEVEL_FATAL)
{
fatal_error(outbuf_save);
/* Never get here */
}
if (logfp != NULL)
{
fputs(outbuf_save, logfp);
}
#if defined(_WIN32) && !defined(_WIN_CONSOLE)
/* Write to display */
LogPutString(outbuf_save);
#endif /* defined(_WIN32) && !defined(_WIN_CONSOLE) */
unlock_logfile();
}
/*********************************************************************
*
* Function : jb_err_to_string
*
* Description : Translates JB_ERR_FOO codes into strings.
*
* XXX: the type of error codes is jb_err
* but the typedef'inition is currently not
* visible to all files that include errlog.h.
*
* Parameters :
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
* 1 : error = a valid jb_err code
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
*
* Returns : A string with the jb_err translation
*
*********************************************************************/
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
const char *jb_err_to_string(int error)
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
{
privoxy 3.0.12 clean checkin
2012-06-28 03:42:39 +00:00
switch (error)
adding in privoxy directly to Orbot repo
2012-05-03 18:32:18 +00:00
{
case JB_ERR_OK:
return "Success, no error";
case JB_ERR_MEMORY:
return "Out of memory";
case JB_ERR_CGI_PARAMS:
return "Missing or corrupt CGI parameters";
case JB_ERR_FILE:
return "Error opening, reading or writing a file";
case JB_ERR_PARSE:
return "Parse error";
case JB_ERR_MODIFIED:
return "File has been modified outside of the CGI actions editor.";
case JB_ERR_COMPRESS:
return "(De)compression failure";
default:
assert(0);
return "Unknown error";
}
assert(0);
return "Internal error";
}
#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 */
#ifdef __OS2__
/*********************************************************************
*
* Function : os2_socket_strerr
*
* Description : Translate the return value from sock_errno()
* into a string.
*
* Parameters :
* 1 : errcode = The return value from sock_errno().
* 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 *os2_socket_strerr(int errcode, char *tmp_buf)
{
#define TEXT_FOR_ERROR(code,text) \
if (errcode == code) \
{ \
return #code " - " text; \
}
TEXT_FOR_ERROR(SOCEPERM , "Not owner.")
TEXT_FOR_ERROR(SOCESRCH , "No such process.")
TEXT_FOR_ERROR(SOCEINTR , "Interrupted system call.")
TEXT_FOR_ERROR(SOCENXIO , "No such device or address.")
TEXT_FOR_ERROR(SOCEBADF , "Bad file number.")
TEXT_FOR_ERROR(SOCEACCES , "Permission denied.")
TEXT_FOR_ERROR(SOCEFAULT , "Bad address.")
TEXT_FOR_ERROR(SOCEINVAL , "Invalid argument.")
TEXT_FOR_ERROR(SOCEMFILE , "Too many open files.")
TEXT_FOR_ERROR(SOCEPIPE , "Broken pipe.")
TEXT_FOR_ERROR(SOCEWOULDBLOCK , "Operation would block.")
TEXT_FOR_ERROR(SOCEINPROGRESS , "Operation now in progress.")
TEXT_FOR_ERROR(SOCEALREADY , "Operation already in progress.")
TEXT_FOR_ERROR(SOCENOTSOCK , "Socket operation on non-socket.")
TEXT_FOR_ERROR(SOCEDESTADDRREQ , "Destination address required.")
TEXT_FOR_ERROR(SOCEMSGSIZE , "Message too long.")
TEXT_FOR_ERROR(SOCEPROTOTYPE , "Protocol wrong type for socket.")
TEXT_FOR_ERROR(SOCENOPROTOOPT , "Protocol not available.")
TEXT_FOR_ERROR(SOCEPROTONOSUPPORT, "Protocol not supported.")
TEXT_FOR_ERROR(SOCESOCKTNOSUPPORT, "Socket type not supported.")
TEXT_FOR_ERROR(SOCEOPNOTSUPP , "Operation not supported.")
TEXT_FOR_ERROR(SOCEPFNOSUPPORT , "Protocol family not supported.")
TEXT_FOR_ERROR(SOCEAFNOSUPPORT , "Address family not supported by protocol family.")
TEXT_FOR_ERROR(SOCEADDRINUSE , "Address already in use.")
TEXT_FOR_ERROR(SOCEADDRNOTAVAIL , "Can't assign requested address.")
TEXT_FOR_ERROR(SOCENETDOWN , "Network is down.")
TEXT_FOR_ERROR(SOCENETUNREACH , "Network is unreachable.")
TEXT_FOR_ERROR(SOCENETRESET , "Network dropped connection on reset.")
TEXT_FOR_ERROR(SOCECONNABORTED , "Software caused connection abort.")
TEXT_FOR_ERROR(SOCECONNRESET , "Connection reset by peer.")
TEXT_FOR_ERROR(SOCENOBUFS , "No buffer space available.")
TEXT_FOR_ERROR(SOCEISCONN , "Socket is already connected.")
TEXT_FOR_ERROR(SOCENOTCONN , "Socket is not connected.")
TEXT_FOR_ERROR(SOCESHUTDOWN , "Can't send after socket shutdown.")
TEXT_FOR_ERROR(SOCETOOMANYREFS , "Too many references: can't splice.")
TEXT_FOR_ERROR(SOCETIMEDOUT , "Operation timed out.")
TEXT_FOR_ERROR(SOCECONNREFUSED , "Connection refused.")
TEXT_FOR_ERROR(SOCELOOP , "Too many levels of symbolic links.")
TEXT_FOR_ERROR(SOCENAMETOOLONG , "File name too long.")
TEXT_FOR_ERROR(SOCEHOSTDOWN , "Host is down.")
TEXT_FOR_ERROR(SOCEHOSTUNREACH , "No route to host.")
TEXT_FOR_ERROR(SOCENOTEMPTY , "Directory not empty.")
TEXT_FOR_ERROR(SOCEOS2ERR , "OS/2 Error.")
sprintf(tmp_buf, "(error number %d)", errcode);
return tmp_buf;
}
#endif /* def __OS2__ */
/*
Local Variables:
tab-width: 3
end:
*/