Got rid of type-casting into isFOO() and toFOO() functions by
[rsync/rsync.git] / log.c
diff --git a/log.c b/log.c
index 9a9f083..f7ccc00 100644 (file)
--- a/log.c
+++ b/log.c
@@ -1,32 +1,27 @@
-/* -*- c-file-style: "linux"; -*-
-
-   Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
-   Copyright (C) 2000-2001 by Martin Pool <mbp@samba.org>
-
-   This program is free software; you can redistribute it 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.
-
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-*/
-
 /*
-  Logging and utility functions.
-  tridge, May 1998
+ * Logging and utility functions.
+ *
+ * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
+ * Copyright (C) 2000-2001 Martin Pool <mbp@samba.org>
+ * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
+ *
+ * This program is free software; you can redistribute it 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.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
+ */
 
-  Mapping to human-readable messages added by Martin Pool
-  <mbp@samba.org>, Oct 2000.
-  */
 #include "rsync.h"
-#if defined HAVE_ICONV && defined HAVE_ICONV_H
+#if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
 #include <iconv.h>
 #endif
 
@@ -39,21 +34,27 @@ extern int local_server;
 extern int quiet;
 extern int module_id;
 extern int msg_fd_out;
+extern int allow_8bit_chars;
 extern int protocol_version;
 extern int preserve_times;
-extern int log_format_has_i;
-extern int log_format_has_o_or_i;
-extern int daemon_log_format_has_o_or_i;
+extern int stdout_format_has_i;
+extern int stdout_format_has_o_or_i;
+extern int logfile_format_has_i;
+extern int logfile_format_has_o_or_i;
+extern mode_t orig_umask;
 extern char *auth_user;
-extern char *log_format;
-#ifdef HAVE_ICONV
+extern char *stdout_format;
+extern char *logfile_format;
+extern char *logfile_name;
+#if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
 extern iconv_t ic_chck;
 #endif
+extern char curr_dir[];
+extern unsigned int module_dirlen;
 
 static int log_initialised;
 static int logfile_was_closed;
-static char *logfname;
-static FILE *logfile;
+static FILE *logfile_fp;
 struct stats stats;
 
 int log_got_error = 0;
@@ -89,7 +90,6 @@ struct {
        { 0, NULL }
 };
 
-
 /*
  * Map from rsync error code to name, or return NULL.
  */
@@ -107,10 +107,10 @@ static void logit(int priority, char *buf)
 {
        if (logfile_was_closed)
                logfile_reopen();
-       if (logfile) {
-               fprintf(logfile,"%s [%d] %s",
+       if (logfile_fp) {
+               fprintf(logfile_fp, "%s [%d] %s",
                        timestring(time(NULL)), (int)getpid(), buf);
-               fflush(logfile);
+               fflush(logfile_fp);
        } else {
                syslog(priority, "%s", buf);
        }
@@ -130,7 +130,7 @@ static void syslog_init()
 #endif
 
 #ifdef LOG_DAEMON
-       openlog("rsyncd", options, lp_syslog_facility());
+       openlog("rsyncd", options, lp_syslog_facility(module_id));
 #else
        openlog("rsyncd", options);
 #endif
@@ -142,37 +142,50 @@ static void syslog_init()
 
 static void logfile_open(void)
 {
-       extern int orig_umask;
-       int old_umask = umask(022 | orig_umask);
-       logfile = fopen(logfname, "a");
+       mode_t old_umask = umask(022 | orig_umask);
+       logfile_fp = fopen(logfile_name, "a");
        umask(old_umask);
-       if (!logfile) {
+       if (!logfile_fp) {
                int fopen_errno = errno;
                /* Rsync falls back to using syslog on failure. */
                syslog_init();
                rsyserr(FERROR, fopen_errno,
-                       "failed to open log-file %s", logfname);
+                       "failed to open log-file %s", logfile_name);
                rprintf(FINFO, "Ignoring \"log file\" setting.\n");
        }
 }
 
-void log_init(void)
+void log_init(int restart)
 {
-       time_t t;
-
-       if (log_initialised)
-               return;
-       log_initialised = 1;
+       if (log_initialised) {
+               if (!restart)
+                       return;
+               if (strcmp(logfile_name, lp_log_file(module_id)) != 0) {
+                       if (logfile_fp) {
+                               fclose(logfile_fp);
+                               logfile_fp = NULL;
+                       } else
+                               closelog();
+                       logfile_name = NULL;
+               } else if (*logfile_name)
+                       return; /* unchanged, non-empty "log file" names */
+               else if (lp_syslog_facility(-1) != lp_syslog_facility(module_id))
+                       closelog();
+               else
+                       return; /* unchanged syslog settings */
+       } else
+               log_initialised = 1;
 
-       /* this looks pointless, but it is needed in order for the
+       /* This looks pointless, but it is needed in order for the
         * C library on some systems to fetch the timezone info
-        * before the chroot */
-       t = time(NULL);
-       localtime(&t);
-
-       /* optionally use a log file instead of syslog */
-       logfname = lp_log_file();
-       if (logfname && *logfname)
+        * before the chroot. */
+       timestring(time(NULL));
+
+       /* Optionally use a log file instead of syslog.  (Non-daemon
+        * rsyncs will have already set logfile_name, as needed.) */
+       if (am_daemon && !logfile_name)
+               logfile_name = lp_log_file(module_id);
+       if (logfile_name && *logfile_name)
                logfile_open();
        else
                syslog_init();
@@ -180,10 +193,10 @@ void log_init(void)
 
 void logfile_close(void)
 {
-       if (logfile) {
+       if (logfile_fp) {
                logfile_was_closed = 1;
-               fclose(logfile);
-               logfile = NULL;
+               fclose(logfile_fp);
+               logfile_fp = NULL;
        }
 }
 
@@ -195,24 +208,21 @@ void logfile_reopen(void)
        }
 }
 
-static void filtered_fwrite(const char *buf, int len, FILE *f)
+static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint)
 {
        const char *s, *end = buf + len;
        for (s = buf; s < end; s++) {
                if ((s < end - 4
-                 && *s == '\\' && s[1] == '0'
-                 && isdigit(*(uchar*)(s+2))
-                 && isdigit(*(uchar*)(s+3))
-                 && isdigit(*(uchar*)(s+4)))
-#ifdef HAVE_ICONV
-                || (*(uchar*)s < ' ' && *s != '\t')
-#else
-                || ((!isprint(*(uchar*)s) || *(uchar*)s < ' ') && *s != '\t')
-#endif
-               ) {
+                 && *s == '\\' && s[1] == '#'
+                 && isDigit(s + 2)
+                 && isDigit(s + 3)
+                 && isDigit(s + 4))
+                || (*s != '\t'
+                 && ((use_isprint && !isPrint(s))
+                  || *(uchar*)s < ' '))) {
                        if (s != buf && fwrite(buf, s - buf, 1, f) != 1)
                                exit_cleanup(RERR_MESSAGEIO);
-                       fprintf(f, "\\%04o", *(uchar*)s);
+                       fprintf(f, "\\#%03o", *(uchar*)s);
                        buf = s + 1;
                }
        }
@@ -231,9 +241,6 @@ void rwrite(enum logcode code, char *buf, int len)
        if (len < 0)
                exit_cleanup(RERR_MESSAGEIO);
 
-       if (quiet && code == FINFO)
-               return;
-
        if (am_server && msg_fd_out >= 0) {
                /* Pass the message to our sibling. */
                send_msg((enum msgcode)code, buf, len);
@@ -245,7 +252,7 @@ void rwrite(enum logcode code, char *buf, int len)
 
        if (code == FCLIENT)
                code = FINFO;
-       else if (am_daemon) {
+       else if (am_daemon || logfile_name) {
                static int in_block;
                char msg[2048];
                int priority = code == FERROR ? LOG_WARNING : LOG_INFO;
@@ -254,19 +261,22 @@ void rwrite(enum logcode code, char *buf, int len)
                        return;
                in_block = 1;
                if (!log_initialised)
-                       log_init();
+                       log_init(0);
                strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
                logit(priority, msg);
                in_block = 0;
 
-               if (code == FLOG || !am_server)
+               if (code == FLOG || (am_daemon && !am_server))
                        return;
        } else if (code == FLOG)
                return;
 
+       if (quiet && code != FERROR)
+               return;
+
        if (am_server) {
                /* Pass the message to the non-server side. */
-               if (io_multiplex_write((enum msgcode)code, buf, len))
+               if (send_msg((enum msgcode)code, buf, len))
                        return;
                if (am_daemon) {
                        /* TODO: can we send the error to the user somehow? */
@@ -278,17 +288,8 @@ void rwrite(enum logcode code, char *buf, int len)
        case FERROR:
                log_got_error = 1;
                f = stderr;
-               goto pre_scan;
-       case FINFO:
-               f = am_server ? stderr : stdout;
-       pre_scan:
-               while (len > 1 && *buf == '\n') {
-                       fputc(*buf, f);
-                       buf++;
-                       len--;
-               }
                break;
-       case FNAME:
+       case FINFO:
                f = am_server ? stderr : stdout;
                break;
        default:
@@ -298,7 +299,7 @@ void rwrite(enum logcode code, char *buf, int len)
        trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
                          ? buf[--len] : 0;
 
-#ifdef HAVE_ICONV
+#if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
        if (ic_chck != (iconv_t)-1) {
                char convbuf[1024];
                char *in_buf = buf, *out_buf = convbuf;
@@ -308,20 +309,20 @@ void rwrite(enum logcode code, char *buf, int len)
                while (iconv(ic_chck, &in_buf,&in_cnt,
                                 &out_buf,&out_cnt) == (size_t)-1) {
                        if (out_buf != convbuf) {
-                               filtered_fwrite(convbuf, out_buf - convbuf, f);
+                               filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
                                out_buf = convbuf;
                                out_cnt = sizeof convbuf - 1;
                        }
                        if (errno == E2BIG)
                                continue;
-                       fprintf(f, "\\%04o", *(uchar*)in_buf++);
+                       fprintf(f, "\\#%03o", *(uchar*)in_buf++);
                        in_cnt--;
                }
                if (out_buf != convbuf)
-                       filtered_fwrite(convbuf, out_buf - convbuf, f);
+                       filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
        } else
 #endif
-               filtered_fwrite(buf, len, f);
+               filtered_fwrite(f, buf, len, !allow_8bit_chars);
 
        if (trailing_CR_or_NL) {
                fputc(trailing_CR_or_NL, f);
@@ -384,7 +385,7 @@ void rsyserr(enum logcode code, int errcode, const char *format, ...)
        char buf[BIGPATHBUFLEN];
        size_t len;
 
-       strcpy(buf, RSYNC_NAME ": ");
+       strlcpy(buf, RSYNC_NAME ": ", sizeof buf);
        len = (sizeof RSYNC_NAME ": ") - 1;
 
        va_start(ap, format);
@@ -405,31 +406,18 @@ void rflush(enum logcode code)
 {
        FILE *f = NULL;
 
-       if (am_daemon) {
+       if (am_daemon || code == FLOG)
                return;
-       }
 
-       if (code == FLOG) {
-               return;
-       }
-
-       if (code == FERROR) {
+       if (code == FERROR || am_server)
                f = stderr;
-       }
-
-       if (code == FINFO) {
-               if (am_server)
-                       f = stderr;
-               else
-                       f = stdout;
-       }
+       else
+               f = stdout;
 
-       if (!f) exit_cleanup(RERR_MESSAGEIO);
        fflush(f);
 }
 
-/* a generic logging routine for send/recv, with parameter
- * substitiution */
+/* A generic logging routine for send/recv, with parameter substitiution. */
 static void log_formatted(enum logcode code, char *format, char *op,
                          struct file_struct *file, struct stats *initial_stats,
                          int iflags, char *hlink)
@@ -457,7 +445,7 @@ static void log_formatted(enum logcode code, char *format, char *op,
                n = fmt + 1;
                if (*p == '-')
                        *n++ = *p++;
-               while (isdigit(*(uchar*)p) && n - fmt < (int)(sizeof fmt) - 8)
+               while (isDigit(p) && n - fmt < (int)(sizeof fmt) - 8)
                        *n++ = *p++;
                if (!*p)
                        break;
@@ -526,6 +514,14 @@ static void log_formatted(enum logcode code, char *format, char *op,
                                        strlcpy(n, buf2, MAXPATHLEN);
                                else
                                        n = buf2;
+                       } else if (*n != '/') {
+                               pathjoin(buf2, sizeof buf2,
+                                        curr_dir + module_dirlen, n);
+                               clean_fname(buf2, 0);
+                               if (fmt[1])
+                                       strlcpy(n, buf2, MAXPATHLEN);
+                               else
+                                       n = buf2;
                        } else
                                clean_fname(n, 0);
                        if (*n == '/')
@@ -539,15 +535,15 @@ static void log_formatted(enum logcode code, char *format, char *op,
                case 'L':
                        if (hlink && *hlink) {
                                n = hlink;
-                               strcpy(buf2, " => ");
+                               strlcpy(buf2, " => ", sizeof buf2);
                        } else if (S_ISLNK(file->mode) && file->u.link) {
                                n = file->u.link;
-                               strcpy(buf2, " -> ");
+                               strlcpy(buf2, " -> ", sizeof buf2);
                        } else {
                                n = "";
                                if (!fmt[1])
                                        break;
-                               strcpy(buf2, "    ");
+                               strlcpy(buf2, "    ", sizeof buf2);
                        }
                        strlcat(fmt, "s", sizeof fmt);
                        snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
@@ -610,7 +606,8 @@ static void log_formatted(enum logcode code, char *format, char *op,
                        n[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
                        n[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
                        n[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
-                       n[8] = '\0';
+                       n[8] = '.';
+                       n[9] = '\0';
 
                        if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
                                char ch = iflags & ITEM_IS_NEW ? '+' : '?';
@@ -680,7 +677,7 @@ int log_format_has(const char *format, char esc)
        for (p = format; (p = strchr(p, '%')) != NULL; ) {
                if (*++p == '-')
                        p++;
-               while (isdigit(*(uchar*)p))
+               while (isDigit(p))
                        p++;
                if (!*p)
                        break;
@@ -690,17 +687,20 @@ int log_format_has(const char *format, char esc)
        return 0;
 }
 
-/* log the transfer of a file */
-void log_item(struct file_struct *file, struct stats *initial_stats,
-             int iflags, char *hlink)
+/* Log the transfer of a file.  If the code is FCLIENT, the output just goes
+ * to stdout.  If it is FLOG, it just goes to the log file.  Otherwise we
+ * output to both. */
+void log_item(enum logcode code, struct file_struct *file,
+             struct stats *initial_stats, int iflags, char *hlink)
 {
        char *s_or_r = am_sender ? "send" : "recv";
 
-       if (lp_transfer_logging(module_id)) {
-               log_formatted(FLOG, lp_log_format(module_id), s_or_r,
+       if (code != FLOG && stdout_format && !am_server) {
+               log_formatted(FCLIENT, stdout_format, s_or_r,
                              file, initial_stats, iflags, hlink);
-       } else if (log_format && !am_server) {
-               log_formatted(FNAME, log_format, s_or_r,
+       }
+       if (code != FCLIENT && logfile_format && *logfile_format) {
+               log_formatted(FLOG, logfile_format, s_or_r,
                              file, initial_stats, iflags, hlink);
        }
 }
@@ -710,14 +710,17 @@ void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
 {
        int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
        int see_item = itemizing && (significant_flags || *buf
-               || log_format_has_i > 1 || (verbose > 1 && log_format_has_i));
+               || stdout_format_has_i > 1 || (verbose > 1 && stdout_format_has_i));
        int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
        if (am_server) {
-               if (am_daemon && !dry_run && see_item)
-                       log_item(file, &stats, iflags, buf);
+               if (logfile_name && !dry_run && see_item
+                && (significant_flags || logfile_format_has_i))
+                       log_item(FLOG, file, &stats, iflags, buf);
        } else if (see_item || local_change || *buf
-           || (S_ISDIR(file->mode) && significant_flags))
-               log_item(file, &stats, iflags, buf);
+           || (S_ISDIR(file->mode) && significant_flags)) {
+               enum logcode code = significant_flags || logfile_format_has_i ? FINFO : FCLIENT;
+               log_item(code, file, &stats, iflags, buf);
+       }
 }
 
 void log_delete(char *fname, int mode)
@@ -729,22 +732,22 @@ void log_delete(char *fname, int mode)
        file.mode = mode;
        file.basename = fname;
 
-       if (!verbose && !log_format)
+       if (!verbose && !stdout_format)
                ;
        else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
                if (S_ISDIR(mode))
                        len++; /* directories include trailing null */
                send_msg(MSG_DELETED, fname, len);
        } else {
-               fmt = log_format_has_o_or_i ? log_format : "deleting %n";
+               fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n";
                log_formatted(FCLIENT, fmt, "del.", &file, &stats,
                              ITEM_DELETED, NULL);
        }
 
-       if (!am_daemon || dry_run || !lp_transfer_logging(module_id))
+       if (!logfile_name || dry_run || !logfile_format)
                return;
 
-       fmt = daemon_log_format_has_o_or_i ? lp_log_format(module_id) : "deleting %n";
+       fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n";
        log_formatted(FLOG, fmt, "del.", &file, &stats, ITEM_DELETED, NULL);
 }
 
@@ -770,11 +773,11 @@ void log_exit(int code, const char *file, int line)
 
                /* VANISHED is not an error, only a warning */
                if (code == RERR_VANISHED) {
-                       rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d) [%s]\n", 
-                               name, code, file, line, who_am_i());
+                       rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
+                               name, code, file, line, who_am_i(), RSYNC_VERSION);
                } else {
-                       rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s]\n",
-                               name, code, file, line, who_am_i());
+                       rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
+                               name, code, file, line, who_am_i(), RSYNC_VERSION);
                }
        }
 }