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