log.c

   1 /*
   2  * Logging and utility functions.
   3  *
   4  * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
   5  * Copyright (C) 2000-2001 Martin Pool <mbp@samba.org>
   6  * Copyright (C) 2003-2020 Wayne Davison
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, visit the http://fsf.org website.
  20  */
  21
  22 #include "rsync.h"
  23 #include "itypes.h"
  24 #include "inums.h"
  25
  26 extern int dry_run;
  27 extern int am_daemon;
  28 extern int am_server;
  29 extern int am_sender;
  30 extern int am_generator;
  31 extern int local_server;
  32 extern int quiet;
  33 extern int module_id;
  34 extern int allow_8bit_chars;
  35 extern int protocol_version;
  36 extern int always_checksum;
  37 extern int preserve_times;
  38 extern int msgs2stderr;
  39 extern int xfersum_type;
  40 extern int checksum_type;
  41 extern int stdout_format_has_i;
  42 extern int stdout_format_has_o_or_i;
  43 extern int logfile_format_has_i;
  44 extern int logfile_format_has_o_or_i;
  45 extern int receiver_symlink_times;
  46 extern int64 total_data_written;
  47 extern int64 total_data_read;
  48 extern mode_t orig_umask;
  49 extern char *auth_user;
  50 extern char *stdout_format;
  51 extern char *logfile_format;
  52 extern char *logfile_name;
  53 #ifdef ICONV_CONST
  54 extern iconv_t ic_chck;
  55 #endif
  56 #ifdef ICONV_OPTION
  57 extern iconv_t ic_recv;
  58 #endif
  59 extern char curr_dir[MAXPATHLEN];
  60 extern char *full_module_path;
  61 extern unsigned int module_dirlen;
  62 extern char sender_file_sum[MAX_DIGEST_LEN];
  63 extern const char undetermined_hostname[];
  64
  65 static int log_initialised;
  66 static int logfile_was_closed;
  67 static FILE *logfile_fp;
  68 struct stats stats;
  69
  70 int got_xfer_error = 0;
  71 int output_needs_newline = 0;
  72 int send_msgs_to_gen = 0;
  73
  74 static int64 initial_data_written;
  75 static int64 initial_data_read;
  76
  77 struct {
  78         int code;
  79         char const *name;
  80 } const rerr_names[] = {
  81         { RERR_SYNTAX     , "syntax or usage error" },
  82         { RERR_PROTOCOL   , "protocol incompatibility" },
  83         { RERR_FILESELECT , "errors selecting input/output files, dirs" },
  84         { RERR_UNSUPPORTED, "requested action not supported" },
  85         { RERR_STARTCLIENT, "error starting client-server protocol" },
  86         { RERR_SOCKETIO   , "error in socket IO" },
  87         { RERR_FILEIO     , "error in file IO" },
  88         { RERR_STREAMIO   , "error in rsync protocol data stream" },
  89         { RERR_MESSAGEIO  , "errors with program diagnostics" },
  90         { RERR_IPC        , "error in IPC code" },
  91         { RERR_CRASHED    , "sibling process crashed" },
  92         { RERR_TERMINATED , "sibling process terminated abnormally" },
  93         { RERR_SIGNAL1    , "received SIGUSR1" },
  94         { RERR_SIGNAL     , "received SIGINT, SIGTERM, or SIGHUP" },
  95         { RERR_WAITCHILD  , "waitpid() failed" },
  96         { RERR_MALLOC     , "error allocating core memory buffers" },
  97         { RERR_PARTIAL    , "some files/attrs were not transferred (see previous errors)" },
  98         { RERR_VANISHED   , "some files vanished before they could be transferred" },
  99         { RERR_DEL_LIMIT  , "the --max-delete limit stopped deletions" },
 100         { RERR_TIMEOUT    , "timeout in data send/receive" },
 101         { RERR_CONTIMEOUT , "timeout waiting for daemon connection" },
 102         { RERR_CMD_FAILED , "remote shell failed" },
 103         { RERR_CMD_KILLED , "remote shell killed" },
 104         { RERR_CMD_RUN    , "remote command could not be run" },
 105         { RERR_CMD_NOTFOUND,"remote command not found" },
 106         { 0, NULL }
 107 };
 108
 109 /*
 110  * Map from rsync error code to name, or return NULL.
 111  */
 112 static char const *rerr_name(int code)
 113 {
 114         int i;
 115         for (i = 0; rerr_names[i].name; i++) {
 116                 if (rerr_names[i].code == code)
 117                         return rerr_names[i].name;
 118         }
 119         return NULL;
 120 }
 121
 122 static void logit(int priority, const char *buf)
 123 {
 124         if (logfile_was_closed)
 125                 logfile_reopen();
 126         if (logfile_fp) {
 127                 fprintf(logfile_fp, "%s [%d] %s", timestring(time(NULL)), (int)getpid(), buf);
 128                 fflush(logfile_fp);
 129         } else {
 130                 syslog(priority, "%s", buf);
 131         }
 132 }
 133
 134 static void syslog_init()
 135 {
 136         int options = LOG_PID;
 137
 138 #ifdef LOG_NDELAY
 139         options |= LOG_NDELAY;
 140 #endif
 141
 142 #ifdef LOG_DAEMON
 143         openlog(lp_syslog_tag(module_id), options, lp_syslog_facility(module_id));
 144 #else
 145         openlog(lp_syslog_tag(module_id), options);
 146 #endif
 147
 148 #ifndef LOG_NDELAY
 149         logit(LOG_INFO, "rsyncd started\n");
 150 #endif
 151 }
 152
 153 static void logfile_open(void)
 154 {
 155         mode_t old_umask = umask(022 | orig_umask);
 156         logfile_fp = fopen(logfile_name, "a");
 157         umask(old_umask);
 158         if (!logfile_fp) {
 159                 int fopen_errno = errno;
 160                 /* Rsync falls back to using syslog on failure. */
 161                 syslog_init();
 162                 rsyserr(FERROR, fopen_errno,
 163                         "failed to open log-file %s", logfile_name);
 164                 rprintf(FINFO, "Ignoring \"log file\" setting.\n");
 165                 logfile_name = "";
 166         }
 167 }
 168
 169 void log_init(int restart)
 170 {
 171         if (log_initialised) {
 172                 if (!restart) /* Note: a restart only happens with am_daemon */
 173                         return;
 174                 assert(logfile_name); /* all am_daemon procs got at least an empty string */
 175                 if (strcmp(logfile_name, lp_log_file(module_id)) != 0) {
 176                         if (logfile_fp) {
 177                                 fclose(logfile_fp);
 178                                 logfile_fp = NULL;
 179                         } else
 180                                 closelog();
 181                         logfile_name = NULL;
 182                 } else if (*logfile_name)
 183                         return; /* unchanged, non-empty "log file" names */
 184                 else if (lp_syslog_facility(-1) != lp_syslog_facility(module_id)
 185                       || strcmp(lp_syslog_tag(-1), lp_syslog_tag(module_id)) != 0)
 186                         closelog();
 187                 else
 188                         return; /* unchanged syslog settings */
 189         } else
 190                 log_initialised = 1;
 191
 192         /* This looks pointless, but it is needed in order for the
 193          * C library on some systems to fetch the timezone info
 194          * before the chroot. */
 195         timestring(time(NULL));
 196
 197         /* Optionally use a log file instead of syslog.  (Non-daemon
 198          * rsyncs will have already set logfile_name, as needed.) */
 199         if (am_daemon && !logfile_name)
 200                 logfile_name = lp_log_file(module_id);
 201         if (logfile_name && *logfile_name)
 202                 logfile_open();
 203         else
 204                 syslog_init();
 205 }
 206
 207 /* Note that this close & reopen idiom intentionally ignores syslog logging. */
 208 void logfile_close(void)
 209 {
 210         if (logfile_fp) {
 211                 logfile_was_closed = 1;
 212                 fclose(logfile_fp);
 213                 logfile_fp = NULL;
 214         }
 215 }
 216
 217 void logfile_reopen(void)
 218 {
 219         if (logfile_was_closed) {
 220                 logfile_was_closed = 0;
 221                 logfile_open();
 222         }
 223 }
 224
 225 static void filtered_fwrite(FILE *f, const char *in_buf, int in_len, int use_isprint, char end_char)
 226 {
 227         char outbuf[1024], *ob = outbuf;
 228         const char *end = in_buf + in_len;
 229         while (in_buf < end) {
 230                 if (ob - outbuf >= (int)sizeof outbuf - 10) {
 231                         if (fwrite(outbuf, ob - outbuf, 1, f) != 1)
 232                                 exit_cleanup(RERR_MESSAGEIO);
 233                         ob = outbuf;
 234                 }
 235                 if ((in_buf < end - 4 && *in_buf == '\\' && in_buf[1] == '#'
 236                   && isDigit(in_buf + 2) && isDigit(in_buf + 3) && isDigit(in_buf + 4))
 237                  || (*in_buf != '\t' && ((use_isprint && !isPrint(in_buf)) || *(uchar*)in_buf < ' ')))
 238                         ob += snprintf(ob, 6, "\\#%03o", *(uchar*)in_buf++);
 239                 else
 240                         *ob++ = *in_buf++;
 241         }
 242         if (end_char) /* The "- 10" above means that there is always room for one more char here. */
 243                 *ob++ = end_char;
 244         if (ob != outbuf && fwrite(outbuf, ob - outbuf, 1, f) != 1)
 245                 exit_cleanup(RERR_MESSAGEIO);
 246 }
 247
 248 /* this is the underlying (unformatted) rsync debugging function. Call
 249  * it with FINFO, FERROR_*, FWARNING, FLOG, or FCLIENT.  Note: recursion
 250  * can happen with certain fatal conditions. */
 251 void rwrite(enum logcode code, const char *buf, int len, int is_utf8)
 252 {
 253         char trailing_CR_or_NL;
 254         FILE *f = msgs2stderr ? stderr : stdout;
 255 #ifdef ICONV_OPTION
 256         iconv_t ic = is_utf8 && ic_recv != (iconv_t)-1 ? ic_recv : ic_chck;
 257 #else
 258 #ifdef ICONV_CONST
 259         iconv_t ic = ic_chck;
 260 #endif
 261 #endif
 262
 263         if (len < 0)
 264                 exit_cleanup(RERR_MESSAGEIO);
 265
 266         if (msgs2stderr) {
 267                 /* A normal daemon can get msgs2stderr set if the socket is busted, so we
 268                  * change the message destination into an FLOG message in order to try to
 269                  * get some info about an abnormal-exit into the log file. An rsh daemon
 270                  * can have this set via user request, so we'll leave the code alone so
 271                  * that the msg gets logged and then sent to stderr after that. */
 272                 if (am_daemon > 0 && code != FCLIENT)
 273                         code = FLOG;
 274         } else if (send_msgs_to_gen) {
 275                 assert(!is_utf8);
 276                 /* Pass the message to our sibling in native charset. */
 277                 send_msg((enum msgcode)code, buf, len, 0);
 278                 return;
 279         }
 280
 281         if (code == FERROR_SOCKET) /* This gets simplified for a non-sibling. */
 282                 code = FERROR;
 283         else if (code == FERROR_UTF8) {
 284                 is_utf8 = 1;
 285                 code = FERROR;
 286         }
 287
 288         if (code == FCLIENT)
 289                 code = FINFO;
 290         else if (am_daemon || logfile_name) {
 291                 static int in_block;
 292                 char msg[2048];
 293                 int priority = code == FINFO || code == FLOG ? LOG_INFO :  LOG_WARNING;
 294
 295                 if (in_block)
 296                         return;
 297                 in_block = 1;
 298                 if (!log_initialised)
 299                         log_init(0);
 300                 strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
 301                 logit(priority, msg);
 302                 in_block = 0;
 303
 304                 if (code == FLOG || (am_daemon && !am_server))
 305                         return;
 306         } else if (code == FLOG)
 307                 return;
 308
 309         switch (code) {
 310         case FERROR_XFER:
 311                 got_xfer_error = 1;
 312                 /* FALL THROUGH */
 313         case FERROR:
 314         case FWARNING:
 315                 f = stderr;
 316                 break;
 317         case FINFO:
 318                 if (quiet)
 319                         return;
 320                 break;
 321         /*case FLOG:*/
 322         /*case FCLIENT:*/
 323         /*case FERROR_UTF8:*/
 324         /*case FERROR_SOCKET:*/
 325         default:
 326                 fprintf(stderr, "Bad logcode in rwrite(): %d [%s]\n", (int)code, who_am_i());
 327                 exit_cleanup(RERR_MESSAGEIO);
 328         }
 329
 330         if (am_server && !msgs2stderr) {
 331                 enum msgcode msg = (enum msgcode)code;
 332                 if (protocol_version < 30) {
 333                         if (msg == MSG_ERROR)
 334                                 msg = MSG_ERROR_XFER;
 335                         else if (msg == MSG_WARNING)
 336                                 msg = MSG_INFO;
 337                 }
 338                 /* Pass the message to the non-server side. */
 339                 if (send_msg(msg, buf, len, !is_utf8))
 340                         return;
 341                 if (am_daemon > 0) {
 342                         /* TODO: can we send the error to the user somehow? */
 343                         return;
 344                 }
 345                 f = stderr;
 346         }
 347
 348         if (output_needs_newline) {
 349                 fputc('\n', f);
 350                 output_needs_newline = 0;
 351         }
 352
 353         trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
 354                           ? buf[--len] : 0;
 355
 356         if (len && buf[0] == '\r') {
 357                 fputc('\r', f);
 358                 buf++;
 359                 len--;
 360         }
 361
 362 #ifdef ICONV_CONST
 363         if (ic != (iconv_t)-1) {
 364                 xbuf outbuf, inbuf;
 365                 char convbuf[1024];
 366                 int ierrno;
 367
 368                 INIT_CONST_XBUF(outbuf, convbuf);
 369                 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
 370
 371                 while (inbuf.len) {
 372                         iconvbufs(ic, &inbuf, &outbuf, inbuf.pos ? 0 : ICB_INIT);
 373                         ierrno = errno;
 374                         if (outbuf.len) {
 375                                 filtered_fwrite(f, convbuf, outbuf.len, 0, 0);
 376                                 outbuf.len = 0;
 377                         }
 378                         /* Log one byte of illegal/incomplete sequence and continue with
 379                          * the next character. Check that the buffer is non-empty for the
 380                          * sake of robustness. */
 381                         if ((ierrno == EILSEQ || ierrno == EINVAL) && inbuf.len) {
 382                                 fprintf(f, "\\#%03o", CVAL(inbuf.buf, inbuf.pos++));
 383                                 inbuf.len--;
 384                         }
 385                 }
 386
 387                 if (trailing_CR_or_NL) {
 388                         fputc(trailing_CR_or_NL, f);
 389                         fflush(f);
 390                 }
 391         } else
 392 #endif
 393         {
 394                 filtered_fwrite(f, buf, len, !allow_8bit_chars, trailing_CR_or_NL);
 395                 if (trailing_CR_or_NL)
 396                         fflush(f);
 397         }
 398 }
 399
 400 /* This is the rsync debugging function. Call it with FINFO, FERROR_*,
 401  * FWARNING, FLOG, or FCLIENT. */
 402 void rprintf(enum logcode code, const char *format, ...)
 403 {
 404         va_list ap;
 405         char buf[BIGPATHBUFLEN];
 406         size_t len;
 407
 408         va_start(ap, format);
 409         len = vsnprintf(buf, sizeof buf, format, ap);
 410         va_end(ap);
 411
 412         /* Deal with buffer overruns.  Instead of panicking, just
 413          * truncate the resulting string.  (Note that configure ensures
 414          * that we have a vsnprintf() that doesn't ever return -1.) */
 415         if (len > sizeof buf - 1) {
 416                 static const char ellipsis[] = "[...]";
 417
 418                 /* Reset length, and zero-terminate the end of our buffer */
 419                 len = sizeof buf - 1;
 420                 buf[len] = '\0';
 421
 422                 /* Copy the ellipsis to the end of the string, but give
 423                  * us one extra character:
 424                  *
 425                  *                  v--- null byte at buf[sizeof buf - 1]
 426                  *        abcdefghij0
 427                  *     -> abcd[...]00  <-- now two null bytes at end
 428                  *
 429                  * If the input format string has a trailing newline,
 430                  * we copy it into that extra null; if it doesn't, well,
 431                  * all we lose is one byte.  */
 432                 memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
 433                 if (format[strlen(format)-1] == '\n') {
 434                         buf[len-1] = '\n';
 435                 }
 436         }
 437
 438         rwrite(code, buf, len, 0);
 439 }
 440
 441 /* This is like rprintf, but it also tries to print some
 442  * representation of the error code.  Normally errcode = errno.
 443  *
 444  * Unlike rprintf, this always adds a newline and there should not be
 445  * one in the format string.
 446  *
 447  * Note that since strerror might involve dynamically loading a
 448  * message catalog we need to call it once before chroot-ing. */
 449 void rsyserr(enum logcode code, int errcode, const char *format, ...)
 450 {
 451         va_list ap;
 452         char buf[BIGPATHBUFLEN];
 453         size_t len;
 454
 455         strlcpy(buf, RSYNC_NAME ": ", sizeof buf);
 456         len = (sizeof RSYNC_NAME ": ") - 1;
 457
 458         va_start(ap, format);
 459         len += vsnprintf(buf + len, sizeof buf - len, format, ap);
 460         va_end(ap);
 461
 462         if (len < sizeof buf) {
 463                 len += snprintf(buf + len, sizeof buf - len,
 464                                 ": %s (%d)\n", strerror(errcode), errcode);
 465         }
 466         if (len >= sizeof buf)
 467                 exit_cleanup(RERR_MESSAGEIO);
 468
 469         rwrite(code, buf, len, 0);
 470 }
 471
 472 void rflush(enum logcode code)
 473 {
 474         FILE *f;
 475
 476         if (am_daemon || code == FLOG)
 477                 return;
 478
 479         if (!am_server && (code == FINFO || code == FCLIENT))
 480                 f = stdout;
 481         else
 482                 f = stderr;
 483
 484         fflush(f);
 485 }
 486
 487 void remember_initial_stats(void)
 488 {
 489         initial_data_read = total_data_read;
 490         initial_data_written = total_data_written;
 491 }
 492
 493 /* A generic logging routine for send/recv, with parameter substitiution. */
 494 static void log_formatted(enum logcode code, const char *format, const char *op,
 495                           struct file_struct *file, const char *fname, int iflags,
 496                           const char *hlink)
 497 {
 498         char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32];
 499         char *p, *s, *c;
 500         const char *n;
 501         size_t len, total;
 502         int64 b;
 503
 504         *fmt = '%';
 505
 506         /* We expand % codes one by one in place in buf.  We don't
 507          * copy in the terminating null of the inserted strings, but
 508          * rather keep going until we reach the null of the format. */
 509         total = strlcpy(buf, format, sizeof buf);
 510         if (total > MAXPATHLEN) {
 511                 rprintf(FERROR, "log-format string is WAY too long!\n");
 512                 exit_cleanup(RERR_MESSAGEIO);
 513         }
 514         buf[total++] = '\n';
 515         buf[total] = '\0';
 516
 517         for (p = buf; (p = strchr(p, '%')) != NULL; ) {
 518                 int humanize = 0;
 519                 s = p++;
 520                 c = fmt + 1;
 521                 while (*p == '\'') {
 522                         humanize++;
 523                         p++;
 524                 }
 525                 if (*p == '-')
 526                         *c++ = *p++;
 527                 while (isDigit(p) && c - fmt < (int)(sizeof fmt) - 8)
 528                         *c++ = *p++;
 529                 while (*p == '\'') {
 530                         humanize++;
 531                         p++;
 532                 }
 533                 if (!*p)
 534                         break;
 535                 *c = '\0';
 536                 n = NULL;
 537
 538                 /* Note for %h and %a: it doesn't matter what fd we pass to
 539                  * client_{name,addr} because rsync_module will already have
 540                  * forced the answer to be cached (assuming, of course, for %h
 541                  * that lp_reverse_lookup(module_id) is true). */
 542                 switch (*p) {
 543                 case 'h':
 544                         if (am_daemon) {
 545                                 n = lp_reverse_lookup(module_id)
 546                                   ? client_name(0) : undetermined_hostname;
 547                         }
 548                         break;
 549                 case 'a':
 550                         if (am_daemon)
 551                                 n = client_addr(0);
 552                         break;
 553                 case 'l':
 554                         strlcat(fmt, "s", sizeof fmt);
 555                         snprintf(buf2, sizeof buf2, fmt,
 556                                  do_big_num(F_LENGTH(file), humanize, NULL));
 557                         n = buf2;
 558                         break;
 559                 case 'U':
 560                         strlcat(fmt, "u", sizeof fmt);
 561                         snprintf(buf2, sizeof buf2, fmt,
 562                                  uid_ndx ? F_OWNER(file) : 0);
 563                         n = buf2;
 564                         break;
 565                 case 'G':
 566                         if (!gid_ndx || file->flags & FLAG_SKIP_GROUP)
 567                                 n = "DEFAULT";
 568                         else {
 569                                 strlcat(fmt, "u", sizeof fmt);
 570                                 snprintf(buf2, sizeof buf2, fmt,
 571                                          F_GROUP(file));
 572                                 n = buf2;
 573                         }
 574                         break;
 575                 case 'p':
 576                         strlcat(fmt, "d", sizeof fmt);
 577                         snprintf(buf2, sizeof buf2, fmt, (int)getpid());
 578                         n = buf2;
 579                         break;
 580                 case 'M':
 581                         n = c = timestring(file->modtime);
 582                         while ((c = strchr(c, ' ')) != NULL)
 583                                 *c = '-';
 584                         break;
 585                 case 'B':
 586                         c = buf2 + MAXPATHLEN - PERMSTRING_SIZE - 1;
 587                         permstring(c, file->mode);
 588                         n = c + 1; /* skip the type char */
 589                         break;
 590                 case 'o':
 591                         n = op;
 592                         break;
 593                 case 'f':
 594                         if (fname) {
 595                                 c = f_name_buf();
 596                                 strlcpy(c, fname, MAXPATHLEN);
 597                         } else
 598                                 c = f_name(file, NULL);
 599                         if (am_sender && F_PATHNAME(file)) {
 600                                 pathjoin(buf2, sizeof buf2,
 601                                          F_PATHNAME(file), c);
 602                                 clean_fname(buf2, 0);
 603                                 if (fmt[1]) {
 604                                         strlcpy(c, buf2, MAXPATHLEN);
 605                                         n = c;
 606                                 } else
 607                                         n = buf2;
 608                         } else if (am_daemon && *c != '/') {
 609                                 pathjoin(buf2, sizeof buf2,
 610                                          curr_dir + module_dirlen, c);
 611                                 clean_fname(buf2, 0);
 612                                 if (fmt[1]) {
 613                                         strlcpy(c, buf2, MAXPATHLEN);
 614                                         n = c;
 615                                 } else
 616                                         n = buf2;
 617                         } else {
 618                                 clean_fname(c, 0);
 619                                 n = c;
 620                         }
 621                         if (*n == '/')
 622                                 n++;
 623                         break;
 624                 case 'n':
 625                         if (fname) {
 626                                 c = f_name_buf();
 627                                 strlcpy(c, fname, MAXPATHLEN);
 628                         } else
 629                                 c = f_name(file, NULL);
 630                         if (S_ISDIR(file->mode))
 631                                 strlcat(c, "/", MAXPATHLEN);
 632                         n = c;
 633                         break;
 634                 case 'L':
 635                         if (hlink && *hlink) {
 636                                 n = hlink;
 637                                 strlcpy(buf2, " => ", sizeof buf2);
 638                         } else if (S_ISLNK(file->mode) && !fname) {
 639                                 n = F_SYMLINK(file);
 640                                 strlcpy(buf2, " -> ", sizeof buf2);
 641                         } else {
 642                                 n = "";
 643                                 if (!fmt[1])
 644                                         break;
 645                                 strlcpy(buf2, "    ", sizeof buf2);
 646                         }
 647                         strlcat(fmt, "s", sizeof fmt);
 648                         snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
 649                         n = buf2;
 650                         break;
 651                 case 'm':
 652                         n = lp_name(module_id);
 653                         break;
 654                 case 't':
 655                         n = timestring(time(NULL));
 656                         break;
 657                 case 'P':
 658                         n = full_module_path;
 659                         break;
 660                 case 'u':
 661                         n = auth_user;
 662                         break;
 663                 case 'b':
 664                 case 'c':
 665                         if (!(iflags & ITEM_TRANSFER))
 666                                 b = 0;
 667                         else if ((!!am_sender) ^ (*p == 'c'))
 668                                 b = total_data_written - initial_data_written;
 669                         else
 670                                 b = total_data_read - initial_data_read;
 671                         strlcat(fmt, "s", sizeof fmt);
 672                         snprintf(buf2, sizeof buf2, fmt,
 673                                  do_big_num(b, humanize, NULL));
 674                         n = buf2;
 675                         break;
 676                 case 'C':
 677                         n = NULL;
 678                         if (S_ISREG(file->mode)) {
 679                                 if (always_checksum)
 680                                         n = sum_as_hex(checksum_type, F_SUM(file), 1);
 681                                 else if (iflags & ITEM_TRANSFER)
 682                                         n = sum_as_hex(xfersum_type, sender_file_sum, 0);
 683                         }
 684                         if (!n) {
 685                                 int sum_len = csum_len_for_type(always_checksum ? checksum_type : xfersum_type,
 686                                                                 always_checksum);
 687                                 memset(buf2, ' ', sum_len*2);
 688                                 buf2[sum_len*2] = '\0';
 689                                 n = buf2;
 690                         }
 691                         break;
 692                 case 'i':
 693                         if (iflags & ITEM_DELETED) {
 694                                 n = "*deleting  ";
 695                                 break;
 696                         }
 697                         n  = c = buf2 + MAXPATHLEN - 32;
 698                         c[0] = iflags & ITEM_LOCAL_CHANGE
 699                              ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
 700                              : !(iflags & ITEM_TRANSFER) ? '.'
 701                              : !local_server && *op == 's' ? '<' : '>';
 702                         if (S_ISLNK(file->mode)) {
 703                                 c[1] = 'L';
 704                                 c[3] = '.';
 705                                 c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
 706                                      : !preserve_times || !receiver_symlink_times
 707                                     || (iflags & ITEM_REPORT_TIMEFAIL) ? 'T' : 't';
 708                         } else {
 709                                 c[1] = S_ISDIR(file->mode) ? 'd'
 710                                      : IS_SPECIAL(file->mode) ? 'S'
 711                                      : IS_DEVICE(file->mode) ? 'D' : 'f';
 712                                 c[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
 713                                 c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
 714                                      : !preserve_times ? 'T' : 't';
 715                         }
 716                         c[2] = !(iflags & ITEM_REPORT_CHANGE) ? '.' : 'c';
 717                         c[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
 718                         c[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
 719                         c[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
 720                         c[8] = !(iflags & ITEM_REPORT_ATIME) ? '.'
 721                              : S_ISLNK(file->mode) ? 'U' : 'u';
 722                         c[9] = !(iflags & ITEM_REPORT_ACL) ? '.' : 'a';
 723                         c[10] = !(iflags & ITEM_REPORT_XATTR) ? '.' : 'x';
 724                         c[11] = '\0';
 725
 726                         if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
 727                                 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
 728                                 int i;
 729                                 for (i = 2; c[i]; i++)
 730                                         c[i] = ch;
 731                         } else if (c[0] == '.' || c[0] == 'h' || c[0] == 'c') {
 732                                 int i;
 733                                 for (i = 2; c[i]; i++) {
 734                                         if (c[i] != '.')
 735                                                 break;
 736                                 }
 737                                 if (!c[i]) {
 738                                         for (i = 2; c[i]; i++)
 739                                                 c[i] = ' ';
 740                                 }
 741                         }
 742                         break;
 743                 }
 744
 745                 /* "n" is the string to be inserted in place of this % code. */
 746                 if (!n)
 747                         continue;
 748                 if (n != buf2 && fmt[1]) {
 749                         strlcat(fmt, "s", sizeof fmt);
 750                         snprintf(buf2, sizeof buf2, fmt, n);
 751                         n = buf2;
 752                 }
 753                 len = strlen(n);
 754
 755                 /* Subtract the length of the escape from the string's size. */
 756                 total -= p - s + 1;
 757
 758                 if (len + total >= (size_t)sizeof buf) {
 759                         rprintf(FERROR,
 760                                 "buffer overflow expanding %%%c -- exiting\n",
 761                                 p[0]);
 762                         exit_cleanup(RERR_MESSAGEIO);
 763                 }
 764
 765                 /* Shuffle the rest of the string along to make space for n */
 766                 if (len != (size_t)(p - s + 1))
 767                         memmove(s + len, p + 1, total - (s - buf) + 1);
 768                 total += len;
 769
 770                 /* Insert the contents of string "n", but NOT its null. */
 771                 if (len)
 772                         memcpy(s, n, len);
 773
 774                 /* Skip over inserted string; continue looking */
 775                 p = s + len;
 776         }
 777
 778         rwrite(code, buf, total, 0);
 779 }
 780
 781 /* Return 1 if the format escape is in the log-format string (e.g. look for
 782  * the 'b' in the "%9b" format escape). */
 783 int log_format_has(const char *format, char esc)
 784 {
 785         const char *p;
 786
 787         if (!format)
 788                 return 0;
 789
 790         for (p = format; (p = strchr(p, '%')) != NULL; ) {
 791                 for (p++; *p == '\''; p++) {} /*SHARED ITERATOR*/
 792                 if (*p == '-')
 793                         p++;
 794                 while (isDigit(p))
 795                         p++;
 796                 while (*p == '\'') p++;
 797                 if (!*p)
 798                         break;
 799                 if (*p == esc)
 800                         return 1;
 801         }
 802         return 0;
 803 }
 804
 805 /* Log the transfer of a file.  If the code is FCLIENT, the output just goes
 806  * to stdout.  If it is FLOG, it just goes to the log file.  Otherwise we
 807  * output to both. */
 808 void log_item(enum logcode code, struct file_struct *file, int iflags, const char *hlink)
 809 {
 810         const char *s_or_r = am_sender ? "send" : "recv";
 811
 812         if (code != FLOG && stdout_format && !am_server)
 813                 log_formatted(FCLIENT, stdout_format, s_or_r, file, NULL, iflags, hlink);
 814         if (code != FCLIENT && logfile_format && *logfile_format)
 815                 log_formatted(FLOG, logfile_format, s_or_r, file, NULL, iflags, hlink);
 816 }
 817
 818 void maybe_log_item(struct file_struct *file, int iflags, int itemizing, const char *buf)
 819 {
 820         int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
 821         int see_item = itemizing && (significant_flags || *buf
 822                 || stdout_format_has_i > 1 || (INFO_GTE(NAME, 2) && stdout_format_has_i));
 823         int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
 824         if (am_server) {
 825                 if (logfile_name && !dry_run && see_item
 826                  && (significant_flags || logfile_format_has_i))
 827                         log_item(FLOG, file, iflags, buf);
 828         } else if (see_item || local_change || *buf
 829             || (S_ISDIR(file->mode) && significant_flags)) {
 830                 enum logcode code = significant_flags || logfile_format_has_i ? FINFO : FCLIENT;
 831                 log_item(code, file, iflags, buf);
 832         }
 833 }
 834
 835 void log_delete(const char *fname, int mode)
 836 {
 837         static struct {
 838                 union file_extras ex[4]; /* just in case... */
 839                 struct file_struct file;
 840         } x; /* Zero-initialized due to static declaration. */
 841         int len = strlen(fname);
 842         const char *fmt;
 843
 844         x.file.mode = mode;
 845
 846         if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
 847                 if (S_ISDIR(mode))
 848                         len++; /* directories include trailing null */
 849                 send_msg(MSG_DELETED, fname, len, am_generator);
 850         } else if (!INFO_GTE(DEL, 1) && !stdout_format)
 851                 ;
 852         else {
 853                 fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n";
 854                 log_formatted(FCLIENT, fmt, "del.", &x.file, fname, ITEM_DELETED, NULL);
 855         }
 856
 857         if (!logfile_name || dry_run || !logfile_format)
 858                 return;
 859
 860         fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n";
 861         log_formatted(FLOG, fmt, "del.", &x.file, fname, ITEM_DELETED, NULL);
 862 }
 863
 864 /*
 865  * Called when the transfer is interrupted for some reason.
 866  *
 867  * Code is one of the RERR_* codes from errcode.h, or terminating
 868  * successfully.
 869  */
 870 void log_exit(int code, const char *file, int line)
 871 {
 872         /* The receiving side's stats are split between 2 procs until the
 873          * end of the run, so only the sender can output non-final info. */
 874         if (code == 0 || am_sender) {
 875                 rprintf(FLOG,"sent %s bytes  received %s bytes  total size %s\n",
 876                         big_num(stats.total_written),
 877                         big_num(stats.total_read),
 878                         big_num(stats.total_size));
 879         }
 880         if (code != 0 && am_server != 2) {
 881                 const char *name;
 882
 883                 name = rerr_name(code);
 884                 if (!name)
 885                         name = "unexplained error";
 886
 887                 /* VANISHED is not an error, only a warning */
 888                 if (code == RERR_VANISHED) {
 889                         rprintf(FWARNING, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
 890                                 name, code, file, line, who_am_i(), RSYNC_VERSION);
 891                 } else {
 892                         rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
 893                                 name, code, file, line, who_am_i(), RSYNC_VERSION);
 894                 }
 895         }
 896 }