X-Git-Url: http://sjero.net/git/?a=blobdiff_plain;f=src%2Flog.c;h=55e98842cfe9fdd64528a8eb63e524c12d89bb17;hb=2447fb9a9b85083c1e6fa54d0a18bdf3962fab1f;hp=caa8a4e7cf38211c5a7aff4d9d6528bda7d492be;hpb=36a5d0b2fe3077c4c4842c3c777914efcc93ac94;p=wget diff --git a/src/log.c b/src/log.c index caa8a4e7..55e98842 100644 --- a/src/log.c +++ b/src/log.c @@ -1,5 +1,5 @@ /* Messages logging. - Copyright (C) 1998, 2000, 2001 Free Software Foundation, Inc. + Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Wget. @@ -29,31 +29,10 @@ so, delete this exception statement from your version. */ #include -/* This allows the architecture-specific .h files to specify the use - of stdargs regardless of __STDC__. */ -#ifndef WGET_USE_STDARG -/* Use stdarg only if the compiler supports ANSI C and stdarg.h is - present. We check for both because there are configurations where - stdarg.h exists, but doesn't work. */ -# ifdef __STDC__ -# ifdef HAVE_STDARG_H -# define WGET_USE_STDARG -# endif -# endif -#endif /* not WGET_USE_STDARG */ - #include -#ifdef HAVE_STRING_H -# include -#else -# include -#endif +#include #include -#ifdef WGET_USE_STDARG -# include -#else -# include -#endif +#include #ifdef HAVE_UNISTD_H # include #endif @@ -64,10 +43,6 @@ so, delete this exception statement from your version. */ #include "utils.h" #include "log.h" -#ifndef errno -extern int errno; -#endif - /* This file impplement support for "logging". Logging means printing output, plus several additional features: @@ -93,18 +68,18 @@ extern int errno; logging is inhibited, logfp is set back to NULL. */ static FILE *logfp; -/* If non-zero, it means logging is inhibited, i.e. nothing is printed - or stored. */ -static int inhibit_logging; +/* If true, it means logging is inhibited, i.e. nothing is printed or + stored. */ +static bool inhibit_logging; /* Whether the last output lines are stored for use as context. */ -static int save_context_p; +static bool save_context_p; /* Whether the log is flushed after each command. */ -static int flush_log_p = 1; +static bool flush_log_p = true; /* Whether any output has been received while flush_log_p was 0. */ -static int needs_flushing; +static bool needs_flushing; /* In the event of a hang-up, and if its output was on a TTY, Wget redirects its output to `wget-log'. @@ -148,9 +123,9 @@ static int log_line_current = -1; finish with \n. This is an important piece of information because the code is always careful to append data to trailing lines, rather than create new ones. */ -static int trailing_line; +static bool trailing_line; -static void check_redirect_output PARAMS ((void)); +static void check_redirect_output (void); #define ROT_ADVANCE(num) do { \ if (++num >= SAVED_LOG_LINES) \ @@ -233,7 +208,7 @@ saved_append_1 (const char *start, const char *end) { /* Allocate memory and concatenate the old and the new contents. */ - ln->malloced_line = (char *)xmalloc (old_len + len + 1); + ln->malloced_line = xmalloc (old_len + len + 1); memcpy (ln->malloced_line, ln->static_line, old_len); memcpy (ln->malloced_line + old_len, start, len); @@ -328,7 +303,7 @@ logputs (enum log_options o, const char *s) FILE *fp; check_redirect_output (); - if (!(fp = get_log_fp ())) + if ((fp = get_log_fp ()) == NULL) return; CHECK_VERBOSE (o); @@ -338,7 +313,7 @@ logputs (enum log_options o, const char *s) if (flush_log_p) logflush (); else - needs_flushing = 1; + needs_flushing = true; } struct logvprintf_state { @@ -361,7 +336,7 @@ struct logvprintf_state { (An alternative approach would be to use va_copy, but that's not portable.) */ -static int +static bool log_vprintf_internal (struct logvprintf_state *state, const char *fmt, va_list args) { @@ -408,7 +383,7 @@ log_vprintf_internal (struct logvprintf_state *state, const char *fmt, int newsize = available_size << 1; state->bigmsg = xrealloc (state->bigmsg, newsize); state->allocated = newsize; - return 0; + return false; } else if (numwritten >= available_size) { @@ -417,7 +392,7 @@ log_vprintf_internal (struct logvprintf_state *state, const char *fmt, int newsize = numwritten + 1; state->bigmsg = xrealloc (state->bigmsg, newsize); state->allocated = newsize; - return 0; + return false; } /* Writing succeeded. */ @@ -430,9 +405,9 @@ log_vprintf_internal (struct logvprintf_state *state, const char *fmt, if (flush_log_p) logflush (); else - needs_flushing = 1; + needs_flushing = true; - return 1; + return true; } /* Flush LOGFP. Useful while flushing is disabled. */ @@ -442,20 +417,20 @@ logflush (void) FILE *fp = get_log_fp (); if (fp) fflush (fp); - needs_flushing = 0; + needs_flushing = false; } /* Enable or disable log flushing. */ void -log_set_flush (int flush) +log_set_flush (bool flush) { if (flush == flush_log_p) return; - if (flush == 0) + if (flush == false) { /* Disable flushing by setting flush_log_p to 0. */ - flush_log_p = 0; + flush_log_p = false; } else { @@ -463,7 +438,7 @@ log_set_flush (int flush) flush the log now. */ if (needs_flushing) logflush (); - flush_log_p = 1; + flush_log_p = true; } } @@ -471,24 +446,14 @@ log_set_flush (int flush) status of storing, with which this function can be called again to reestablish storing. */ -int -log_set_save_context (int savep) +bool +log_set_save_context (bool savep) { - int old = save_context_p; + bool old = save_context_p; save_context_p = savep; return old; } -/* Handle difference in va_start between pre-ANSI and ANSI C. Note - that we always use `...' in function definitions and let ansi2knr - convert it for us. */ - -#ifdef WGET_USE_STDARG -# define VA_START(args, arg1) va_start (args, arg1) -#else -# define VA_START(args, ignored) va_start (args) -#endif - /* Print a message to the screen or to the log. The first argument defines the verbosity of the message, and the rest are as in printf(3). */ @@ -498,7 +463,7 @@ logprintf (enum log_options o, const char *fmt, ...) { va_list args; struct logvprintf_state lpstate; - int done; + bool done; check_redirect_output (); if (inhibit_logging) @@ -508,7 +473,7 @@ logprintf (enum log_options o, const char *fmt, ...) xzero (lpstate); do { - VA_START (args, fmt); + va_start (args, fmt); done = log_vprintf_internal (&lpstate, fmt, args); va_end (args); } @@ -517,7 +482,7 @@ logprintf (enum log_options o, const char *fmt, ...) #ifdef ENABLE_DEBUG /* The same as logprintf(), but does anything only if opt.debug is - non-zero. */ + true. */ void debug_logprintf (const char *fmt, ...) { @@ -525,7 +490,7 @@ debug_logprintf (const char *fmt, ...) { va_list args; struct logvprintf_state lpstate; - int done; + bool done; check_redirect_output (); if (inhibit_logging) @@ -534,7 +499,7 @@ debug_logprintf (const char *fmt, ...) xzero (lpstate); do { - VA_START (args, fmt); + va_start (args, fmt); done = log_vprintf_internal (&lpstate, fmt, args); va_end (args); } @@ -546,7 +511,7 @@ debug_logprintf (const char *fmt, ...) /* Open FILE and set up a logging stream. If FILE cannot be opened, exit with status of 1. */ void -log_init (const char *file, int appendp) +log_init (const char *file, bool appendp) { if (file) { @@ -577,7 +542,7 @@ log_init (const char *file, int appendp) the most recent several messages ("context") and dump them to a log file in case SIGHUP or SIGUSR1 is received (or Ctrl+Break is pressed under Windows). */ - save_context_p = 1; + save_context_p = true; } } } @@ -592,13 +557,13 @@ log_close (void) if (logfp) fclose (logfp); logfp = NULL; - inhibit_logging = 1; - save_context_p = 0; + inhibit_logging = true; + save_context_p = false; for (i = 0; i < SAVED_LOG_LINES; i++) free_log_line (i); log_line_current = -1; - trailing_line = 0; + trailing_line = false; } /* Dump saved lines to logfp. */ @@ -628,9 +593,183 @@ log_dump_context (void) fflush (fp); } +/* String escape functions. */ + +/* Return the number of non-printable characters in SOURCE. + Non-printable characters are determined as per safe-ctype.c. */ + +static int +count_nonprint (const char *source) +{ + const char *p; + int cnt; + for (p = source, cnt = 0; *p; p++) + if (!ISPRINT (*p)) + ++cnt; + return cnt; +} + +/* Copy SOURCE to DEST, escaping non-printable characters. + + Non-printable refers to anything outside the non-control ASCII + range (32-126) which means that, for example, CR, LF, and TAB are + considered non-printable along with ESC, BS, and other control + chars. This is by design: it makes sure that messages from remote + servers cannot be easily used to deceive the users by mimicking + Wget's output. Disallowing non-ASCII characters is another + necessary security measure, which makes sure that remote servers + cannot garble the screen or guess the local charset and perform + homographic attacks. + + Of course, the above mandates that escnonprint only be used in + contexts expected to be ASCII, such as when printing host names, + URL components, HTTP headers, FTP server messages, and the like. + + ESCAPE is the leading character of the escape sequence. BASE + should be the base of the escape sequence, and must be either 8 for + octal or 16 for hex. + + DEST must point to a location with sufficient room to store an + encoded version of SOURCE. */ + +static void +copy_and_escape (const char *source, char *dest, char escape, int base) +{ + const char *from = source; + char *to = dest; + unsigned char c; + + /* Copy chars from SOURCE to DEST, escaping non-printable ones. */ + switch (base) + { + case 8: + while ((c = *from++) != '\0') + if (ISPRINT (c)) + *to++ = c; + else + { + *to++ = escape; + *to++ = '0' + (c >> 6); + *to++ = '0' + ((c >> 3) & 7); + *to++ = '0' + (c & 7); + } + break; + case 16: + while ((c = *from++) != '\0') + if (ISPRINT (c)) + *to++ = c; + else + { + *to++ = escape; + *to++ = XNUM_TO_DIGIT (c >> 4); + *to++ = XNUM_TO_DIGIT (c & 0xf); + } + break; + default: + abort (); + } + *to = '\0'; +} + +#define RING_SIZE 3 +struct ringel { + char *buffer; + int size; +}; +static struct ringel ring[RING_SIZE]; /* ring data */ + +static const char * +escnonprint_internal (const char *str, char escape, int base) +{ + static int ringpos; /* current ring position */ + int nprcnt; + + assert (base == 8 || base == 16); + + nprcnt = count_nonprint (str); + if (nprcnt == 0) + /* If there are no non-printable chars in STR, don't bother + copying anything, just return STR. */ + return str; + + { + /* Set up a pointer to the current ring position, so we can write + simply r->X instead of ring[ringpos].X. */ + struct ringel *r = ring + ringpos; + + /* Every non-printable character is replaced with the escape char + and three (or two, depending on BASE) *additional* chars. Size + must also include the length of the original string and one + additional char for the terminating \0. */ + int needed_size = strlen (str) + 1 + (base == 8 ? 3 * nprcnt : 2 * nprcnt); + + /* If the current buffer is uninitialized or too small, + (re)allocate it. */ + if (r->buffer == NULL || r->size < needed_size) + { + r->buffer = xrealloc (r->buffer, needed_size); + r->size = needed_size; + } + + copy_and_escape (str, r->buffer, escape, base); + ringpos = (ringpos + 1) % RING_SIZE; + return r->buffer; + } +} + +/* Return a pointer to a static copy of STR with the non-printable + characters escaped as \ooo. If there are no non-printable + characters in STR, STR is returned. See copy_and_escape for more + information on which characters are considered non-printable. + + DON'T call this function on translated strings because escaping + will break them. Don't call it on literal strings from the source, + which are by definition trusted. If newlines are allowed in the + string, escape and print it line by line because escaping the whole + string will convert newlines to \012. (This is so that expectedly + single-line messages cannot use embedded newlines to mimic Wget's + output and deceive the user.) + + escnonprint doesn't quote its escape character because it is notf + meant as a general and reversible quoting mechanism, but as a quick + way to defang binary junk sent by malicious or buggy servers. + + NOTE: since this function can return a pointer to static data, be + careful to copy its result before calling it again. However, to be + more useful with printf, it maintains an internal ring of static + buffers to return. Currently the ring size is 3, which means you + can print up to three values in the same printf; if more is needed, + bump RING_SIZE. */ + +const char * +escnonprint (const char *str) +{ + return escnonprint_internal (str, '\\', 8); +} + +/* Return a pointer to a static copy of STR with the non-printable + characters escaped as %XX. If there are no non-printable + characters in STR, STR is returned. + + See escnonprint for usage details. */ + +const char * +escnonprint_uri (const char *str) +{ + return escnonprint_internal (str, '%', 16); +} + +void +log_cleanup (void) +{ + int i; + for (i = 0; i < countof (ring); i++) + xfree_null (ring[i].buffer); +} + /* When SIGHUP or SIGUSR1 are received, the output is redirected elsewhere. Such redirection is only allowed once. */ -enum { RR_NONE, RR_REQUESTED, RR_DONE } redirect_request = RR_NONE; +static enum { RR_NONE, RR_REQUESTED, RR_DONE } redirect_request = RR_NONE; static const char *redirect_request_signal_name; /* Redirect output to `wget-log'. */ @@ -638,25 +777,26 @@ static const char *redirect_request_signal_name; static void redirect_output (void) { - char *logfile = unique_name (DEFAULT_LOGFILE, 0); - fprintf (stderr, _("\n%s received, redirecting output to `%s'.\n"), - redirect_request_signal_name, logfile); - logfp = fopen (logfile, "w"); - if (!logfp) + char *logfile; + logfp = unique_create (DEFAULT_LOGFILE, false, &logfile); + if (logfp) + { + fprintf (stderr, _("\n%s received, redirecting output to `%s'.\n"), + redirect_request_signal_name, logfile); + xfree (logfile); + /* Dump the context output to the newly opened log. */ + log_dump_context (); + } + else { /* Eek! Opening the alternate log file has failed. Nothing we can do but disable printing completely. */ + fprintf (stderr, _("\n%s received.\n"), redirect_request_signal_name); fprintf (stderr, _("%s: %s; disabling logging.\n"), logfile, strerror (errno)); - inhibit_logging = 1; - } - else - { - /* Dump the context output to the newly opened log. */ - log_dump_context (); + inhibit_logging = true; } - xfree (logfile); - save_context_p = 0; + save_context_p = false; } /* Check whether a signal handler requested the output to be