Call f_name() with revised args (which also replaces f_name_to()).
[rsync/rsync.git] / log.c
diff --git a/log.c b/log.c
index f81c8af..41d847f 100644 (file)
--- a/log.c
+++ b/log.c
@@ -32,17 +32,20 @@ extern int dry_run;
 extern int am_daemon;
 extern int am_server;
 extern int am_sender;
+extern int local_server;
 extern int quiet;
 extern int module_id;
 extern int msg_fd_out;
 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 char *auth_user;
 extern char *log_format;
 
 static int log_initialised;
+static int logfile_was_closed;
 static char *logfname;
 static FILE *logfile;
 struct stats stats;
@@ -58,14 +61,16 @@ struct {
        { RERR_FILESELECT , "errors selecting input/output files, dirs" },
        { RERR_UNSUPPORTED, "requested action not supported" },
        { RERR_STARTCLIENT, "error starting client-server protocol" },
-       { RERR_LOG_FAILURE, "daemon unable to append to log-file" },
        { RERR_SOCKETIO   , "error in socket IO" },
        { RERR_FILEIO     , "error in file IO" },
        { RERR_STREAMIO   , "error in rsync protocol data stream" },
        { RERR_MESSAGEIO  , "errors with program diagnostics" },
        { RERR_IPC        , "error in IPC code" },
-       { RERR_SIGNAL     , "received SIGUSR1 or SIGINT" },
-       { RERR_WAITCHILD  , "some error returned by waitpid()" },
+       { RERR_CRASHED    , "sibling process crashed" },
+       { RERR_TERMINATED , "sibling process terminated abnormally" },
+       { RERR_SIGNAL1    , "received SIGUSR1" },
+       { RERR_SIGNAL     , "received SIGINT, SIGTERM, or SIGHUP" },
+       { RERR_WAITCHILD  , "waitpid() failed" },
        { RERR_MALLOC     , "error allocating core memory buffers" },
        { RERR_PARTIAL    , "some files could not be transferred" },
        { RERR_VANISHED   , "some files vanished before they could be transferred" },
@@ -96,9 +101,9 @@ static char const *rerr_name(int code)
 
 static void logit(int priority, char *buf)
 {
-       if (logfname) {
-               if (!logfile)
-                       log_open();
+       if (logfile_was_closed)
+               logfile_reopen();
+       if (logfile) {
                fprintf(logfile,"%s [%d] %s",
                        timestring(time(NULL)), (int)getpid(), buf);
                fflush(logfile);
@@ -107,30 +112,14 @@ static void logit(int priority, char *buf)
        }
 }
 
-void log_init(void)
+static void syslog_init()
 {
+       static int been_here = 0;
        int options = LOG_PID;
-       time_t t;
 
-       if (log_initialised)
+       if (been_here)
                return;
-       log_initialised = 1;
-
-       /* 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) {
-               if (*logfname) {
-                       log_open();
-                       return;
-               }
-               logfname = NULL;
-       }
+       been_here = 1;
 
 #ifdef LOG_NDELAY
        options |= LOG_NDELAY;
@@ -143,33 +132,65 @@ void log_init(void)
 #endif
 
 #ifndef LOG_NDELAY
-       logit(LOG_INFO,"rsyncd started\n");
+       logit(LOG_INFO, "rsyncd started\n");
 #endif
 }
 
-void log_open(void)
+static void logfile_open(void)
 {
-       if (logfname && !logfile) {
-               extern int orig_umask;
-               int old_umask = umask(022 | orig_umask);
-               logfile = fopen(logfname, "a");
-               umask(old_umask);
-               if (!logfile) {
-                       am_daemon = 0; /* avoid trying to log again */
-                       rsyserr(FERROR, errno, "fopen() of log-file failed");
-                       exit_cleanup(RERR_LOG_FAILURE);
-               }
+       extern int orig_umask;
+       int old_umask = umask(022 | orig_umask);
+       logfile = fopen(logfname, "a");
+       umask(old_umask);
+       if (!logfile) {
+               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);
+               rprintf(FINFO, "Ignoring \"log file\" setting.\n");
        }
 }
 
-void log_close(void)
+void log_init(void)
+{
+       time_t t;
+
+       if (log_initialised)
+               return;
+       log_initialised = 1;
+
+       /* 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)
+               logfile_open();
+       else
+               syslog_init();
+}
+
+void logfile_close(void)
 {
        if (logfile) {
+               logfile_was_closed = 1;
                fclose(logfile);
                logfile = NULL;
        }
 }
 
+void logfile_reopen(void)
+{
+       if (logfile_was_closed) {
+               logfile_was_closed = 0;
+               logfile_open();
+       }
+}
+
 /* this is the underlying (unformatted) rsync debugging function. Call
  * it with FINFO, FERROR or FLOG */
 void rwrite(enum logcode code, char *buf, int len)
@@ -239,14 +260,14 @@ void rwrite(enum logcode code, char *buf, int len)
        if (buf[len-1] == '\r' || buf[len-1] == '\n')
                fflush(f);
 }
-               
+
 
 /* This is the rsync debugging function. Call it with FINFO, FERROR or
  * FLOG. */
 void rprintf(enum logcode code, const char *format, ...)
 {
        va_list ap;
-       char buf[MAXPATHLEN+512];
+       char buf[BIGPATHBUFLEN];
        size_t len;
 
        va_start(ap, format);
@@ -257,7 +278,7 @@ void rprintf(enum logcode code, const char *format, ...)
         * truncate the resulting string.  (Note that configure ensures
         * that we have a vsnprintf() that doesn't ever return -1.) */
        if (len > sizeof buf - 1) {
-               const char ellipsis[] = "[...]";
+               static const char ellipsis[] = "[...]";
 
                /* Reset length, and zero-terminate the end of our buffer */
                len = sizeof buf - 1;
@@ -273,7 +294,7 @@ void rprintf(enum logcode code, const char *format, ...)
                 * If the input format string has a trailing newline,
                 * we copy it into that extra null; if it doesn't, well,
                 * all we lose is one byte.  */
-               strncpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
+               memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
                if (format[strlen(format)-1] == '\n') {
                        buf[len-1] = '\n';
                }
@@ -294,7 +315,7 @@ void rprintf(enum logcode code, const char *format, ...)
 void rsyserr(enum logcode code, int errcode, const char *format, ...)
 {
        va_list ap;
-       char buf[MAXPATHLEN+512];
+       char buf[BIGPATHBUFLEN];
        size_t len;
 
        strcpy(buf, RSYNC_NAME ": ");
@@ -319,7 +340,7 @@ void rsyserr(enum logcode code, int errcode, const char *format, ...)
 void rflush(enum logcode code)
 {
        FILE *f = NULL;
-       
+
        if (am_daemon) {
                return;
        }
@@ -351,66 +372,109 @@ static void log_formatted(enum logcode code, char *format, char *op,
                          struct file_struct *file, struct stats *initial_stats,
                          int iflags, char *hlink)
 {
-       char buf[MAXPATHLEN+1024];
-       char buf2[MAXPATHLEN];
-       char *p, *n;
+       char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32];
+       char *p, *s, *n;
        size_t len, total;
        int64 b;
 
+       *fmt = '%';
+
        /* We expand % codes one by one in place in buf.  We don't
-        * copy in the terminating nul of the inserted strings, but
-        * rather keep going until we reach the nul of the format. */
+        * copy in the terminating null of the inserted strings, but
+        * rather keep going until we reach the null of the format. */
        total = strlcpy(buf, format, sizeof buf);
-       
-       for (p = buf; (p = strchr(p, '%')) != NULL && p[1]; ) {
+       if (total > MAXPATHLEN) {
+               rprintf(FERROR, "log-format string is WAY too long!\n");
+               exit_cleanup(RERR_MESSAGEIO);
+       }
+       buf[total++] = '\n';
+       buf[total] = '\0';
+
+       for (p = buf; (p = strchr(p, '%')) != NULL; ) {
+               s = p++;
+               n = fmt + 1;
+               if (*p == '-')
+                       *n++ = *p++;
+               while (isdigit(*(uchar*)p) && n - fmt < (int)(sizeof fmt) - 8)
+                       *n++ = *p++;
+               if (!*p)
+                       break;
+               *n = '\0';
                n = NULL;
 
-               switch (p[1]) {
-               case 'h': if (am_daemon) n = client_name(0); break;
-               case 'a': if (am_daemon) n = client_addr(0); break;
+               switch (*p) {
+               case 'h':
+                       if (am_daemon)
+                               n = client_name(0);
+                       break;
+               case 'a':
+                       if (am_daemon)
+                               n = client_addr(0);
+                       break;
                case 'l':
-                       snprintf(buf2, sizeof buf2, "%.0f",
+                       strlcat(fmt, ".0f", sizeof fmt);
+                       snprintf(buf2, sizeof buf2, fmt,
                                 (double)file->length);
                        n = buf2;
                        break;
                case 'p':
-                       snprintf(buf2, sizeof buf2, "%d",
-                                (int)getpid());
+                       strlcat(fmt, "ld", sizeof fmt);
+                       snprintf(buf2, sizeof buf2, fmt,
+                                (long)getpid());
                        n = buf2;
                        break;
-               case 'o': n = op; break;
+               case 'o':
+                       n = op;
+                       break;
                case 'f':
-                       pathjoin(buf2, sizeof buf2,
-                           am_sender && file->dir.root ? file->dir.root : "",
-                           safe_fname(f_name(file)));
-                       clean_fname(buf2, 0);
-                       n = buf2;
-                       if (*n == '/') n++;
+                       n = f_name(file);
+                       if (am_sender && file->dir.root) {
+                               pathjoin(buf2, sizeof buf2,
+                                        file->dir.root, n);
+                               clean_fname(buf2, 0);
+                               if (fmt[1])
+                                       strlcpy(n, buf2, MAXPATHLEN);
+                               else
+                                       n = buf2;
+                       } else
+                               clean_fname(n, 0);
+                       if (*n == '/')
+                               n++;
                        break;
                case 'n':
-                       n = (char*)safe_fname(f_name(file));
-                       if (S_ISDIR(file->mode)) {
-                               /* The buffer from safe_fname() has more
-                                * room than MAXPATHLEN, so this is safe. */
-                               strcat(n, "/");
-                       }
+                       n = f_name(file);
+                       if (S_ISDIR(file->mode))
+                               strlcat(n, "/", MAXPATHLEN);
                        break;
                case 'L':
                        if (hlink && *hlink) {
-                               snprintf(buf2, sizeof buf2, " => %s",
-                                        safe_fname(hlink));
-                               n = buf2;
+                               n = hlink;
+                               strcpy(buf2, " => ");
                        } else if (S_ISLNK(file->mode) && file->u.link) {
-                               snprintf(buf2, sizeof buf2, " -> %s",
-                                        safe_fname(file->u.link));
-                               n = buf2;
-                       } else
+                               n = file->u.link;
+                               strcpy(buf2, " -> ");
+                       } else {
                                n = "";
+                               if (!fmt[1])
+                                       break;
+                               strcpy(buf2, "    ");
+                       }
+                       strlcat(fmt, "s", sizeof fmt);
+                       snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
+                       n = buf2;
+                       break;
+               case 'm':
+                       n = lp_name(module_id);
+                       break;
+               case 't':
+                       n = timestring(time(NULL));
+                       break;
+               case 'P':
+                       n = lp_path(module_id);
+                       break;
+               case 'u':
+                       n = auth_user;
                        break;
-               case 'm': n = lp_name(module_id); break;
-               case 't': n = timestring(time(NULL)); break;
-               case 'P': n = lp_path(module_id); break;
-               case 'u': n = auth_user; break;
                case 'b':
                        if (am_sender) {
                                b = stats.total_written -
@@ -419,7 +483,8 @@ static void log_formatted(enum logcode code, char *format, char *op,
                                b = stats.total_read -
                                        initial_stats->total_read;
                        }
-                       snprintf(buf2, sizeof buf2, "%.0f", (double)b);
+                       strlcat(fmt, ".0f", sizeof fmt);
+                       snprintf(buf2, sizeof buf2, fmt, (double)b);
                        n = buf2;
                        break;
                case 'c':
@@ -430,7 +495,8 @@ static void log_formatted(enum logcode code, char *format, char *op,
                                b = stats.total_read -
                                        initial_stats->total_read;
                        }
-                       snprintf(buf2, sizeof buf2, "%.0f", (double)b);
+                       strlcat(fmt, ".0f", sizeof fmt);
+                       snprintf(buf2, sizeof buf2, fmt, (double)b);
                        n = buf2;
                        break;
                case 'i':
@@ -438,11 +504,11 @@ static void log_formatted(enum logcode code, char *format, char *op,
                                n = "*deleting";
                                break;
                        }
-                       n = buf2;
+                       n = buf2 + MAXPATHLEN - 32;
                        n[0] = iflags & ITEM_LOCAL_CHANGE
                              ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
                             : !(iflags & ITEM_TRANSFER) ? '.'
-                            : *op == 's' ? '>' : '<';
+                            : !local_server && *op == 's' ? '<' : '>';
                        n[1] = S_ISDIR(file->mode) ? 'd'
                             : IS_DEVICE(file->mode) ? 'D'
                             : S_ISLNK(file->mode) ? 'L' : 'f';
@@ -462,7 +528,8 @@ static void log_formatted(enum logcode code, char *format, char *op,
                                int i;
                                for (i = 2; n[i]; i++)
                                        n[i] = ch;
-                       } else if (!(iflags & (ITEM_TRANSFER|ITEM_LOCAL_CHANGE))) {
+                       } else if (n[0] == '.' || n[0] == 'h'
+                               || (n[0] == 'c' && n[1] == 'f')) {
                                int i;
                                for (i = 2; n[i]; i++) {
                                        if (n[i] != '.')
@@ -476,17 +543,20 @@ static void log_formatted(enum logcode code, char *format, char *op,
                        break;
                }
 
-               /* n is the string to be inserted in place of this %
-                * code; len is its length not including the trailing
-                * NUL */
-               if (!n) {
-                       p += 2;
+               /* "n" is the string to be inserted in place of this % code. */
+               if (!n)
                        continue;
+               if (n != buf2 && fmt[1]) {
+                       strlcat(fmt, "s", sizeof fmt);
+                       snprintf(buf2, sizeof buf2, fmt, n);
+                       n = buf2;
                }
-
                len = strlen(n);
 
-               if (len + total - 2 >= sizeof buf) {
+               /* Subtract the length of the escape from the string's size. */
+               total -= p - s + 1;
+
+               if (len + total >= (size_t)sizeof buf) {
                        rprintf(FERROR,
                                "buffer overflow expanding %%%c -- exiting\n",
                                p[0]);
@@ -494,19 +564,41 @@ static void log_formatted(enum logcode code, char *format, char *op,
                }
 
                /* Shuffle the rest of the string along to make space for n */
-               if (len != 2)
-                       memmove(p + len, p + 2, total - (p + 2 - buf) + 1);
-               total += len - 2;
+               if (len != (size_t)(p - s + 1))
+                       memmove(s + len, p + 1, total - (s - buf) + 1);
+               total += len;
 
-               /* Insert the contents of string "n", but NOT its nul. */
+               /* Insert the contents of string "n", but NOT its null. */
                if (len)
-                       memcpy(p, n, len);
+                       memcpy(s, n, len);
 
                /* Skip over inserted string; continue looking */
-               p += len;
+               p = s + len;
        }
 
-       rprintf(code, "%s\n", buf);
+       rwrite(code, buf, total);
+}
+
+/* Return 1 if the format escape is in the log-format string (e.g. look for
+ * the 'b' in the "%9b" format escape). */
+int log_format_has(const char *format, char esc)
+{
+       const char *p;
+
+       if (!format)
+               return 0;
+
+       for (p = format; (p = strchr(p, '%')) != NULL; ) {
+               if (*++p == '-')
+                       p++;
+               while (isdigit(*(uchar*)p))
+                       p++;
+               if (!*p)
+                       break;
+               if (*p == esc)
+                       return 1;
+       }
+       return 0;
 }
 
 /* log the transfer of a file */
@@ -527,12 +619,15 @@ void log_item(struct file_struct *file, struct stats *initial_stats,
 void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
                    char *buf)
 {
-       int see_item = itemizing && (iflags || verbose > 1);
+       int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
+       int see_item = itemizing && (significant_flags || *buf
+                                 || (verbose > 1 && log_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);
-       } else if (see_item || iflags & ITEM_LOCAL_CHANGE || *buf
-           || (S_ISDIR(file->mode) && iflags & SIGNIFICANT_ITEM_FLAGS))
+       } else if (see_item || local_change || *buf
+           || (S_ISDIR(file->mode) && significant_flags))
                log_item(file, &stats, iflags, buf);
 }