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