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