]> git.ipfire.org Git - thirdparty/rsync.git/blobdiff - log.c
More tweaks for Actions.
[thirdparty/rsync.git] / log.c
diff --git a/log.c b/log.c
index b1ed320d94d83ddb6e598692a653a617ca26e242..e4ba1cce24122c62ee21cdb9ed5b550993131cea 100644 (file)
--- a/log.c
+++ b/log.c
@@ -3,7 +3,7 @@
  *
  * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
  * Copyright (C) 2000-2001 Martin Pool <mbp@samba.org>
- * Copyright (C) 2003-2013 Wayne Davison
+ * Copyright (C) 2003-2022 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
@@ -31,11 +31,10 @@ extern int am_generator;
 extern int local_server;
 extern int quiet;
 extern int module_id;
-extern int checksum_len;
 extern int allow_8bit_chars;
 extern int protocol_version;
 extern int always_checksum;
-extern int preserve_times;
+extern int preserve_mtimes;
 extern int msgs2stderr;
 extern int stdout_format_has_i;
 extern int stdout_format_has_o_or_i;
@@ -61,6 +60,8 @@ extern unsigned int module_dirlen;
 extern char sender_file_sum[MAX_DIGEST_LEN];
 extern const char undetermined_hostname[];
 
+extern struct name_num_item *xfer_sum_nni, *file_sum_nni;
+
 static int log_initialised;
 static int logfile_was_closed;
 static FILE *logfile_fp;
@@ -74,8 +75,8 @@ static int64 initial_data_written;
 static int64 initial_data_read;
 
 struct {
-        int code;
-        char const *name;
+       int code;
+       char const *name;
 } const rerr_names[] = {
        { RERR_SYNTAX     , "syntax or usage error" },
        { RERR_PROTOCOL   , "protocol incompatibility" },
@@ -132,21 +133,16 @@ static void logit(int priority, const char *buf)
 
 static void syslog_init()
 {
-       static int been_here = 0;
        int options = LOG_PID;
 
-       if (been_here)
-               return;
-       been_here = 1;
-
 #ifdef LOG_NDELAY
        options |= LOG_NDELAY;
 #endif
 
 #ifdef LOG_DAEMON
-       openlog("rsyncd", options, lp_syslog_facility(module_id));
+       openlog(lp_syslog_tag(module_id), options, lp_syslog_facility(module_id));
 #else
-       openlog("rsyncd", options);
+       openlog(lp_syslog_tag(module_id), options);
 #endif
 
 #ifndef LOG_NDELAY
@@ -166,14 +162,16 @@ static void logfile_open(void)
                rsyserr(FERROR, fopen_errno,
                        "failed to open log-file %s", logfile_name);
                rprintf(FINFO, "Ignoring \"log file\" setting.\n");
+               logfile_name = "";
        }
 }
 
 void log_init(int restart)
 {
        if (log_initialised) {
-               if (!restart)
+               if (!restart) /* Note: a restart only happens with am_daemon */
                        return;
+               assert(logfile_name); /* all am_daemon procs got at least an empty string */
                if (strcmp(logfile_name, lp_log_file(module_id)) != 0) {
                        if (logfile_fp) {
                                fclose(logfile_fp);
@@ -183,7 +181,8 @@ void log_init(int restart)
                        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))
+               else if (lp_syslog_facility(-1) != lp_syslog_facility(module_id)
+                     || strcmp(lp_syslog_tag(-1), lp_syslog_tag(module_id)) != 0)
                        closelog();
                else
                        return; /* unchanged syslog settings */
@@ -205,6 +204,7 @@ void log_init(int restart)
                syslog_init();
 }
 
+/* Note that this close & reopen idiom intentionally ignores syslog logging. */
 void logfile_close(void)
 {
        if (logfile_fp) {
@@ -222,25 +222,26 @@ void logfile_reopen(void)
        }
 }
 
-static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint)
+static void filtered_fwrite(FILE *f, const char *in_buf, int in_len, int use_isprint, char end_char)
 {
-       const char *s, *end = buf + len;
-       for (s = buf; s < end; s++) {
-               if ((s < end - 4
-                 && *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)
+       char outbuf[1024], *ob = outbuf;
+       const char *end = in_buf + in_len;
+       while (in_buf < end) {
+               if (ob - outbuf >= (int)sizeof outbuf - 10) {
+                       if (fwrite(outbuf, ob - outbuf, 1, f) != 1)
                                exit_cleanup(RERR_MESSAGEIO);
-                       fprintf(f, "\\#%03o", *(uchar*)s);
-                       buf = s + 1;
+                       ob = outbuf;
                }
+               if ((in_buf < end - 4 && *in_buf == '\\' && in_buf[1] == '#'
+                 && isDigit(in_buf + 2) && isDigit(in_buf + 3) && isDigit(in_buf + 4))
+                || (*in_buf != '\t' && ((use_isprint && !isPrint(in_buf)) || *(uchar*)in_buf < ' ')))
+                       ob += snprintf(ob, 6, "\\#%03o", *(uchar*)in_buf++);
+               else
+                       *ob++ = *in_buf++;
        }
-       if (buf != end && fwrite(buf, end - buf, 1, f) != 1)
+       if (end_char) /* The "- 10" above means that there is always room for one more char here. */
+               *ob++ = end_char;
+       if (ob != outbuf && fwrite(outbuf, ob - outbuf, 1, f) != 1)
                exit_cleanup(RERR_MESSAGEIO);
 }
 
@@ -249,8 +250,8 @@ static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint)
  * can happen with certain fatal conditions. */
 void rwrite(enum logcode code, const char *buf, int len, int is_utf8)
 {
-       int trailing_CR_or_NL;
-       FILE *f = msgs2stderr ? stderr : stdout;
+       char trailing_CR_or_NL;
+       FILE *f = msgs2stderr == 1 ? stderr : stdout;
 #ifdef ICONV_OPTION
        iconv_t ic = is_utf8 && ic_recv != (iconv_t)-1 ? ic_recv : ic_chck;
 #else
@@ -262,15 +263,14 @@ void rwrite(enum logcode code, const char *buf, int len, int is_utf8)
        if (len < 0)
                exit_cleanup(RERR_MESSAGEIO);
 
-       if (msgs2stderr) {
-               if (!am_daemon) {
-                       if (code == FLOG)
-                               return;
-                       goto output_msg;
-               }
-               if (code == FCLIENT)
-                       return;
-               code = FLOG;
+       if (msgs2stderr == 1) {
+               /* A normal daemon can get msgs2stderr set if the socket is busted, so we
+                * change the message destination into an FLOG message in order to try to
+                * get some info about an abnormal-exit into the log file. An rsh daemon
+                * can have this set via user request, so we'll leave the code alone so
+                * that the msg gets logged and then sent to stderr after that. */
+               if (am_daemon > 0 && code != FCLIENT)
+                       code = FLOG;
        } else if (send_msgs_to_gen) {
                assert(!is_utf8);
                /* Pass the message to our sibling in native charset. */
@@ -306,10 +306,28 @@ void rwrite(enum logcode code, const char *buf, int len, int is_utf8)
        } else if (code == FLOG)
                return;
 
-       if (quiet && code == FINFO)
-               return;
+       switch (code) {
+       case FERROR_XFER:
+               got_xfer_error = 1;
+               /* FALL THROUGH */
+       case FERROR:
+       case FWARNING:
+               f = stderr;
+               break;
+       case FINFO:
+               if (quiet)
+                       return;
+               break;
+       /*case FLOG:*/
+       /*case FCLIENT:*/
+       /*case FERROR_UTF8:*/
+       /*case FERROR_SOCKET:*/
+       default:
+               fprintf(stderr, "Bad logcode in rwrite(): %d [%s]\n", (int)code, who_am_i());
+               exit_cleanup(RERR_MESSAGEIO);
+       }
 
-       if (am_server) {
+       if (am_server && msgs2stderr != 1 && (msgs2stderr != 2 || f != stderr)) {
                enum msgcode msg = (enum msgcode)code;
                if (protocol_version < 30) {
                        if (msg == MSG_ERROR)
@@ -320,40 +338,19 @@ void rwrite(enum logcode code, const char *buf, int len, int is_utf8)
                /* Pass the message to the non-server side. */
                if (send_msg(msg, buf, len, !is_utf8))
                        return;
-               if (am_daemon) {
+               if (am_daemon > 0) {
                        /* TODO: can we send the error to the user somehow? */
                        return;
                }
                f = stderr;
        }
 
-output_msg:
-       switch (code) {
-       case FERROR_XFER:
-               got_xfer_error = 1;
-               /* FALL THROUGH */
-       case FERROR:
-       case FERROR_UTF8:
-       case FERROR_SOCKET:
-       case FWARNING:
-               f = stderr;
-               break;
-       case FLOG:
-       case FINFO:
-       case FCLIENT:
-               break;
-       default:
-               fprintf(stderr, "Unknown logcode in rwrite(): %d [%s]\n", (int)code, who_am_i());
-               exit_cleanup(RERR_MESSAGEIO);
-       }
-
        if (output_needs_newline) {
                fputc('\n', f);
                output_needs_newline = 0;
        }
 
-       trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
-                         ? buf[--len] : 0;
+       trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r') ? buf[--len] : '\0';
 
        if (len && buf[0] == '\r') {
                fputc('\r', f);
@@ -374,21 +371,33 @@ output_msg:
                        iconvbufs(ic, &inbuf, &outbuf, inbuf.pos ? 0 : ICB_INIT);
                        ierrno = errno;
                        if (outbuf.len) {
-                               filtered_fwrite(f, convbuf, outbuf.len, 0);
+                               char trailing = inbuf.len ? '\0' : trailing_CR_or_NL;
+                               filtered_fwrite(f, convbuf, outbuf.len, 0, trailing);
+                               if (trailing) {
+                                       trailing_CR_or_NL = '\0';
+                                       fflush(f);
+                               }
                                outbuf.len = 0;
                        }
-                       if (!ierrno || ierrno == E2BIG)
-                               continue;
-                       fprintf(f, "\\#%03o", CVAL(inbuf.buf, inbuf.pos++));
-                       inbuf.len--;
+                       /* Log one byte of illegal/incomplete sequence and continue with
+                        * the next character. Check that the buffer is non-empty for the
+                        * sake of robustness. */
+                       if ((ierrno == EILSEQ || ierrno == EINVAL) && inbuf.len) {
+                               fprintf(f, "\\#%03o", CVAL(inbuf.buf, inbuf.pos++));
+                               inbuf.len--;
+                       }
+               }
+
+               if (trailing_CR_or_NL) {
+                       fputc(trailing_CR_or_NL, f);
+                       fflush(f);
                }
        } else
 #endif
-               filtered_fwrite(f, buf, len, !allow_8bit_chars);
-
-       if (trailing_CR_or_NL) {
-               fputc(trailing_CR_or_NL, f);
-               fflush(f);
+       {
+               filtered_fwrite(f, buf, len, !allow_8bit_chars, trailing_CR_or_NL);
+               if (trailing_CR_or_NL)
+                       fflush(f);
        }
 }
 
@@ -447,8 +456,7 @@ void rsyserr(enum logcode code, int errcode, const char *format, ...)
        char buf[BIGPATHBUFLEN];
        size_t len;
 
-       strlcpy(buf, RSYNC_NAME ": ", sizeof buf);
-       len = (sizeof RSYNC_NAME ": ") - 1;
+       len = snprintf(buf, sizeof buf, RSYNC_NAME ": [%s] ", who_am_i());
 
        va_start(ap, format);
        len += vsnprintf(buf + len, sizeof buf - len, format, ap);
@@ -656,21 +664,10 @@ static void log_formatted(enum logcode code, const char *format, const char *op,
                        n = auth_user;
                        break;
                case 'b':
-                       if (!(iflags & ITEM_TRANSFER))
-                               b = 0;
-                       else if (am_sender)
-                               b = total_data_written - initial_data_written;
-                       else
-                               b = total_data_read - initial_data_read;
-                       strlcat(fmt, "s", sizeof fmt);
-                       snprintf(buf2, sizeof buf2, fmt,
-                                do_big_num(b, humanize, NULL));
-                       n = buf2;
-                       break;
                case 'c':
                        if (!(iflags & ITEM_TRANSFER))
                                b = 0;
-                       else if (!am_sender)
+                       else if ((!!am_sender) ^ (*p == 'c'))
                                b = total_data_written - initial_data_written;
                        else
                                b = total_data_read - initial_data_read;
@@ -680,15 +677,18 @@ static void log_formatted(enum logcode code, const char *format, const char *op,
                        n = buf2;
                        break;
                case 'C':
-                       if (protocol_version >= 30
-                        && (iflags & ITEM_TRANSFER
-                         || (always_checksum && S_ISREG(file->mode)))) {
-                               const char *sum = iflags & ITEM_TRANSFER
-                                               ? sender_file_sum : F_SUM(file);
-                               n = sum_as_hex(sum);
-                       } else {
-                               memset(buf2, ' ', checksum_len*2);
-                               buf2[checksum_len*2] = '\0';
+                       n = NULL;
+                       if (S_ISREG(file->mode)) {
+                               if (always_checksum)
+                                       n = sum_as_hex(file_sum_nni->num, F_SUM(file), 1);
+                               else if (iflags & ITEM_TRANSFER)
+                                       n = sum_as_hex(xfer_sum_nni->num, sender_file_sum, 0);
+                       }
+                       if (!n) {
+                               int sum_len = csum_len_for_type(always_checksum ? file_sum_nni->num : xfer_sum_nni->num,
+                                                               always_checksum);
+                               memset(buf2, ' ', sum_len*2);
+                               buf2[sum_len*2] = '\0';
                                n = buf2;
                        }
                        break;
@@ -699,14 +699,14 @@ static void log_formatted(enum logcode code, const char *format, const char *op,
                        }
                        n  = c = buf2 + MAXPATHLEN - 32;
                        c[0] = iflags & ITEM_LOCAL_CHANGE
-                             ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
+                            ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
                             : !(iflags & ITEM_TRANSFER) ? '.'
                             : !local_server && *op == 's' ? '<' : '>';
                        if (S_ISLNK(file->mode)) {
                                c[1] = 'L';
                                c[3] = '.';
                                c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
-                                    : !preserve_times || !receiver_symlink_times
+                                    : !preserve_mtimes || !receiver_symlink_times
                                    || (iflags & ITEM_REPORT_TIMEFAIL) ? 'T' : 't';
                        } else {
                                c[1] = S_ISDIR(file->mode) ? 'd'
@@ -714,13 +714,15 @@ static void log_formatted(enum logcode code, const char *format, const char *op,
                                     : IS_DEVICE(file->mode) ? 'D' : 'f';
                                c[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
                                c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
-                                    : !preserve_times ? 'T' : 't';
+                                    : !preserve_mtimes ? 'T' : 't';
                        }
                        c[2] = !(iflags & ITEM_REPORT_CHANGE) ? '.' : 'c';
                        c[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
                        c[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
                        c[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
-                       c[8] = !(iflags & ITEM_REPORT_ATIME) ? '.' : 'u';
+                       c[8] = !(iflags & (ITEM_REPORT_ATIME|ITEM_REPORT_CRTIME)) ? '.'
+                            : BITS_SET(iflags, ITEM_REPORT_ATIME|ITEM_REPORT_CRTIME) ? 'b'
+                            : iflags & ITEM_REPORT_ATIME ? 'u' : 'n';
                        c[9] = !(iflags & ITEM_REPORT_ACL) ? '.' : 'a';
                        c[10] = !(iflags & ITEM_REPORT_XATTR) ? '.' : 'x';
                        c[11] = '\0';
@@ -817,8 +819,7 @@ void log_item(enum logcode code, struct file_struct *file, int iflags, const cha
                log_formatted(FLOG, logfile_format, s_or_r, file, NULL, iflags, hlink);
 }
 
-void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
-                   const char *buf)
+void maybe_log_item(struct file_struct *file, int iflags, int itemizing, const char *buf)
 {
        int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
        int see_item = itemizing && (significant_flags || *buf
@@ -837,31 +838,41 @@ void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
 
 void log_delete(const char *fname, int mode)
 {
-       static struct {
-               union file_extras ex[4]; /* just in case... */
-               struct file_struct file;
-       } x; /* Zero-initialized due to static declaration. */
+       static struct file_struct *file = NULL;
        int len = strlen(fname);
        const char *fmt;
 
-       x.file.mode = mode;
+       if (!file) {
+               int extra_len = (file_extra_cnt + 2) * EXTRA_LEN;
+               char *bp;
+#if EXTRA_ROUNDING > 0
+               if (extra_len & (EXTRA_ROUNDING * EXTRA_LEN))
+                       extra_len = (extra_len | (EXTRA_ROUNDING * EXTRA_LEN)) + EXTRA_LEN;
+#endif
 
-       if (!INFO_GTE(DEL, 1) && !stdout_format)
-               ;
-       else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
+               bp = new_array0(char, FILE_STRUCT_LEN + extra_len + 1);
+               bp += extra_len;
+               file = (struct file_struct *)bp;
+       }
+
+       file->mode = mode;
+
+       if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
                if (S_ISDIR(mode))
                        len++; /* directories include trailing null */
                send_msg(MSG_DELETED, fname, len, am_generator);
-       } else {
+       } else if (!INFO_GTE(DEL, 1) && !stdout_format)
+               ;
+       else {
                fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n";
-               log_formatted(FCLIENT, fmt, "del.", &x.file, fname, ITEM_DELETED, NULL);
+               log_formatted(FCLIENT, fmt, "del.", file, fname, ITEM_DELETED, NULL);
        }
 
        if (!logfile_name || dry_run || !logfile_format)
                return;
 
        fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n";
-       log_formatted(FLOG, fmt, "del.", &x.file, fname, ITEM_DELETED, NULL);
+       log_formatted(FLOG, fmt, "del.", file, fname, ITEM_DELETED, NULL);
 }
 
 /*
@@ -872,12 +883,15 @@ void log_delete(const char *fname, int mode)
  */
 void log_exit(int code, const char *file, int line)
 {
-       if (code == 0) {
+       /* The receiving side's stats are split between 2 procs until the
+        * end of the run, so only the sender can output non-final info. */
+       if (code == 0 || am_sender) {
                rprintf(FLOG,"sent %s bytes  received %s bytes  total size %s\n",
                        big_num(stats.total_written),
                        big_num(stats.total_read),
                        big_num(stats.total_size));
-       } else if (am_server != 2) {
+       }
+       if (code != 0 && am_server != 2) {
                const char *name;
 
                name = rerr_name(code);
@@ -887,10 +901,10 @@ void log_exit(int code, const char *file, int line)
                /* VANISHED is not an error, only a warning */
                if (code == RERR_VANISHED) {
                        rprintf(FWARNING, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
-                               name, code, file, line, who_am_i(), RSYNC_VERSION);
+                               name, code, src_file(file), line, who_am_i(), rsync_version());
                } else {
                        rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
-                               name, code, file, line, who_am_i(), RSYNC_VERSION);
+                               name, code, src_file(file), line, who_am_i(), rsync_version());
                }
        }
 }