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 stdout_format_has_i;
  41 extern int stdout_format_has_o_or_i;
  42 extern int logfile_format_has_i;
  43 extern int logfile_format_has_o_or_i;
  44 extern mode_t orig_umask;
  45 extern char *auth_user;
  46 extern char *stdout_format;
  47 extern char *logfile_format;
  48 extern char *logfile_name;
  49 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
  50 extern iconv_t ic_chck;
  51 #endif
  52 extern char curr_dir[];
  53 extern unsigned int module_dirlen;
  54
  55 static int log_initialised;
  56 static int logfile_was_closed;
  57 static FILE *logfile_fp;
  58 struct stats stats;
  59
  60 int log_got_error = 0;
  61
  62 struct {
  63         int code;
  64         char const *name;
  65 } const rerr_names[] = {
  66         { RERR_SYNTAX     , "syntax or usage error" },
  67         { RERR_PROTOCOL   , "protocol incompatibility" },
  68         { RERR_FILESELECT , "errors selecting input/output files, dirs" },
  69         { RERR_UNSUPPORTED, "requested action not supported" },
  70         { RERR_STARTCLIENT, "error starting client-server protocol" },
  71         { RERR_SOCKETIO   , "error in socket IO" },
  72         { RERR_FILEIO     , "error in file IO" },
  73         { RERR_STREAMIO   , "error in rsync protocol data stream" },
  74         { RERR_MESSAGEIO  , "errors with program diagnostics" },
  75         { RERR_IPC        , "error in IPC code" },
  76         { RERR_CRASHED    , "sibling process crashed" },
  77         { RERR_TERMINATED , "sibling process terminated abnormally" },
  78         { RERR_SIGNAL1    , "received SIGUSR1" },
  79         { RERR_SIGNAL     , "received SIGINT, SIGTERM, or SIGHUP" },
  80         { RERR_WAITCHILD  , "waitpid() failed" },
  81         { RERR_MALLOC     , "error allocating core memory buffers" },
  82         { RERR_PARTIAL    , "some files could not be transferred" },
  83         { RERR_VANISHED   , "some files vanished before they could be transferred" },
  84         { RERR_TIMEOUT    , "timeout in data send/receive" },
  85         { RERR_CMD_FAILED , "remote shell failed" },
  86         { RERR_CMD_KILLED , "remote shell killed" },
  87         { RERR_CMD_RUN    , "remote command could not be run" },
  88         { RERR_CMD_NOTFOUND,"remote command not found" },
  89         { RERR_DEL_LIMIT  , "the --max-delete limit stopped deletions" },
  90         { 0, NULL }
  91 };
  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, 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(*(uchar*)(s+2))
 219                   && isdigit(*(uchar*)(s+3))
 220                   && isdigit(*(uchar*)(s+4)))
 221                  || (*s != '\t'
 222                   && ((use_isprint && !isprint(*(uchar*)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, 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         if (ic_chck != (iconv_t)-1) {
 305                 char convbuf[1024];
 306                 char *in_buf = buf, *out_buf = convbuf;
 307                 size_t in_cnt = len, out_cnt = sizeof convbuf - 1;
 308
 309                 iconv(ic_chck, NULL, 0, NULL, 0);
 310                 while (iconv(ic_chck, &in_buf,&in_cnt,
 311                                  &out_buf,&out_cnt) == (size_t)-1) {
 312                         if (out_buf != convbuf) {
 313                                 filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
 314                                 out_buf = convbuf;
 315                                 out_cnt = sizeof convbuf - 1;
 316                         }
 317                         if (errno == E2BIG)
 318                                 continue;
 319                         fprintf(f, "\\#%03o", *(uchar*)in_buf++);
 320                         in_cnt--;
 321                 }
 322                 if (out_buf != convbuf)
 323                         filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
 324         } else
 325 #endif
 326                 filtered_fwrite(f, buf, len, !allow_8bit_chars);
 327
 328         if (trailing_CR_or_NL) {
 329                 fputc(trailing_CR_or_NL, f);
 330                 fflush(f);
 331         }
 332 }
 333
 334 /* This is the rsync debugging function. Call it with FINFO, FERROR or
 335  * FLOG. */
 336 void rprintf(enum logcode code, const char *format, ...)
 337 {
 338         va_list ap;
 339         char buf[BIGPATHBUFLEN];
 340         size_t len;
 341
 342         va_start(ap, format);
 343         len = vsnprintf(buf, sizeof buf, format, ap);
 344         va_end(ap);
 345
 346         /* Deal with buffer overruns.  Instead of panicking, just
 347          * truncate the resulting string.  (Note that configure ensures
 348          * that we have a vsnprintf() that doesn't ever return -1.) */
 349         if (len > sizeof buf - 1) {
 350                 static const char ellipsis[] = "[...]";
 351
 352                 /* Reset length, and zero-terminate the end of our buffer */
 353                 len = sizeof buf - 1;
 354                 buf[len] = '\0';
 355
 356                 /* Copy the ellipsis to the end of the string, but give
 357                  * us one extra character:
 358                  *
 359                  *                  v--- null byte at buf[sizeof buf - 1]
 360                  *        abcdefghij0
 361                  *     -> abcd[...]00  <-- now two null bytes at end
 362                  *
 363                  * If the input format string has a trailing newline,
 364                  * we copy it into that extra null; if it doesn't, well,
 365                  * all we lose is one byte.  */
 366                 memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
 367                 if (format[strlen(format)-1] == '\n') {
 368                         buf[len-1] = '\n';
 369                 }
 370         }
 371
 372         rwrite(code, buf, len);
 373 }
 374
 375 /* This is like rprintf, but it also tries to print some
 376  * representation of the error code.  Normally errcode = errno.
 377  *
 378  * Unlike rprintf, this always adds a newline and there should not be
 379  * one in the format string.
 380  *
 381  * Note that since strerror might involve dynamically loading a
 382  * message catalog we need to call it once before chroot-ing. */
 383 void rsyserr(enum logcode code, int errcode, const char *format, ...)
 384 {
 385         va_list ap;
 386         char buf[BIGPATHBUFLEN];
 387         size_t len;
 388
 389         strcpy(buf, RSYNC_NAME ": ");
 390         len = (sizeof RSYNC_NAME ": ") - 1;
 391
 392         va_start(ap, format);
 393         len += vsnprintf(buf + len, sizeof buf - len, format, ap);
 394         va_end(ap);
 395
 396         if (len < sizeof buf) {
 397                 len += snprintf(buf + len, sizeof buf - len,
 398                                 ": %s (%d)\n", strerror(errcode), errcode);
 399         }
 400         if (len >= sizeof buf)
 401                 exit_cleanup(RERR_MESSAGEIO);
 402
 403         rwrite(code, buf, len);
 404 }
 405
 406 void rflush(enum logcode code)
 407 {
 408         FILE *f = NULL;
 409
 410         if (am_daemon || code == FLOG)
 411                 return;
 412
 413         if (code == FERROR || am_server)
 414                 f = stderr;
 415         else
 416                 f = stdout;
 417
 418         fflush(f);
 419 }
 420
 421 /* A generic logging routine for send/recv, with parameter substitiution. */
 422 static void log_formatted(enum logcode code, char *format, char *op,
 423                           struct file_struct *file, struct stats *initial_stats,
 424                           int iflags, char *hlink)
 425 {
 426         char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32];
 427         char *p, *s, *n;
 428         size_t len, total;
 429         int64 b;
 430
 431         *fmt = '%';
 432
 433         /* We expand % codes one by one in place in buf.  We don't
 434          * copy in the terminating null of the inserted strings, but
 435          * rather keep going until we reach the null of the format. */
 436         total = strlcpy(buf, format, sizeof buf);
 437         if (total > MAXPATHLEN) {
 438                 rprintf(FERROR, "log-format string is WAY too long!\n");
 439                 exit_cleanup(RERR_MESSAGEIO);
 440         }
 441         buf[total++] = '\n';
 442         buf[total] = '\0';
 443
 444         for (p = buf; (p = strchr(p, '%')) != NULL; ) {
 445                 s = p++;
 446                 n = fmt + 1;
 447                 if (*p == '-')
 448                         *n++ = *p++;
 449                 while (isdigit(*(uchar*)p) && n - fmt < (int)(sizeof fmt) - 8)
 450                         *n++ = *p++;
 451                 if (!*p)
 452                         break;
 453                 *n = '\0';
 454                 n = NULL;
 455
 456                 switch (*p) {
 457                 case 'h':
 458                         if (am_daemon)
 459                                 n = client_name(0);
 460                         break;
 461                 case 'a':
 462                         if (am_daemon)
 463                                 n = client_addr(0);
 464                         break;
 465                 case 'l':
 466                         strlcat(fmt, ".0f", sizeof fmt);
 467                         snprintf(buf2, sizeof buf2, fmt,
 468                                  (double)file->length);
 469                         n = buf2;
 470                         break;
 471                 case 'U':
 472                         strlcat(fmt, "ld", sizeof fmt);
 473                         snprintf(buf2, sizeof buf2, fmt,
 474                                  (long)file->uid);
 475                         n = buf2;
 476                         break;
 477                 case 'G':
 478                         if (file->gid == GID_NONE)
 479                                 n = "DEFAULT";
 480                         else {
 481                                 strlcat(fmt, "ld", sizeof fmt);
 482                                 snprintf(buf2, sizeof buf2, fmt,
 483                                          (long)file->gid);
 484                                 n = buf2;
 485                         }
 486                         break;
 487                 case 'p':
 488                         strlcat(fmt, "ld", sizeof fmt);
 489                         snprintf(buf2, sizeof buf2, fmt,
 490                                  (long)getpid());
 491                         n = buf2;
 492                         break;
 493                 case 'M':
 494                         n = timestring(file->modtime);
 495                         {
 496                                 char *cp = n;
 497                                 while ((cp = strchr(cp, ' ')) != NULL)
 498                                         *cp = '-';
 499                         }
 500                         break;
 501                 case 'B':
 502                         n = buf2 + MAXPATHLEN - PERMSTRING_SIZE;
 503                         permstring(n - 1, file->mode); /* skip the type char */
 504                         break;
 505                 case 'o':
 506                         n = op;
 507                         break;
 508                 case 'f':
 509                         n = f_name(file, NULL);
 510                         if (am_sender && file->dir.root) {
 511                                 pathjoin(buf2, sizeof buf2,
 512                                          file->dir.root, n);
 513                                 clean_fname(buf2, 0);
 514                                 if (fmt[1])
 515                                         strlcpy(n, buf2, MAXPATHLEN);
 516                                 else
 517                                         n = buf2;
 518                         } else if (*n != '/') {
 519                                 pathjoin(buf2, sizeof buf2,
 520                                          curr_dir + module_dirlen, n);
 521                                 clean_fname(buf2, 0);
 522                                 if (fmt[1])
 523                                         strlcpy(n, buf2, MAXPATHLEN);
 524                                 else
 525                                         n = buf2;
 526                         } else
 527                                 clean_fname(n, 0);
 528                         if (*n == '/')
 529                                 n++;
 530                         break;
 531                 case 'n':
 532                         n = f_name(file, NULL);
 533                         if (S_ISDIR(file->mode))
 534                                 strlcat(n, "/", MAXPATHLEN);
 535                         break;
 536                 case 'L':
 537                         if (hlink && *hlink) {
 538                                 n = hlink;
 539                                 strcpy(buf2, " => ");
 540                         } else if (S_ISLNK(file->mode) && file->u.link) {
 541                                 n = file->u.link;
 542                                 strcpy(buf2, " -> ");
 543                         } else {
 544                                 n = "";
 545                                 if (!fmt[1])
 546                                         break;
 547                                 strcpy(buf2, "    ");
 548                         }
 549                         strlcat(fmt, "s", sizeof fmt);
 550                         snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
 551                         n = buf2;
 552                         break;
 553                 case 'm':
 554                         n = lp_name(module_id);
 555                         break;
 556                 case 't':
 557                         n = timestring(time(NULL));
 558                         break;
 559                 case 'P':
 560                         n = lp_path(module_id);
 561                         break;
 562                 case 'u':
 563                         n = auth_user;
 564                         break;
 565                 case 'b':
 566                         if (am_sender) {
 567                                 b = stats.total_written -
 568                                         initial_stats->total_written;
 569                         } else {
 570                                 b = stats.total_read -
 571                                         initial_stats->total_read;
 572                         }
 573                         strlcat(fmt, ".0f", sizeof fmt);
 574                         snprintf(buf2, sizeof buf2, fmt, (double)b);
 575                         n = buf2;
 576                         break;
 577                 case 'c':
 578                         if (!am_sender) {
 579                                 b = stats.total_written -
 580                                         initial_stats->total_written;
 581                         } else {
 582                                 b = stats.total_read -
 583                                         initial_stats->total_read;
 584                         }
 585                         strlcat(fmt, ".0f", sizeof fmt);
 586                         snprintf(buf2, sizeof buf2, fmt, (double)b);
 587                         n = buf2;
 588                         break;
 589                 case 'i':
 590                         if (iflags & ITEM_DELETED) {
 591                                 n = "*deleting";
 592                                 break;
 593                         }
 594                         n = buf2 + MAXPATHLEN - 32;
 595                         n[0] = iflags & ITEM_LOCAL_CHANGE
 596                               ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
 597                              : !(iflags & ITEM_TRANSFER) ? '.'
 598                              : !local_server && *op == 's' ? '<' : '>';
 599                         n[1] = S_ISDIR(file->mode) ? 'd'
 600                              : IS_SPECIAL(file->mode) ? 'S'
 601                              : IS_DEVICE(file->mode) ? 'D'
 602                              : S_ISLNK(file->mode) ? 'L' : 'f';
 603                         n[2] = !(iflags & ITEM_REPORT_CHECKSUM) ? '.' : 'c';
 604                         n[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
 605                         n[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
 606                              : !preserve_times || S_ISLNK(file->mode) ? 'T' : 't';
 607                         n[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
 608                         n[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
 609                         n[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
 610                         n[8] = '.';
 611                         n[9] = '\0';
 612
 613                         if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
 614                                 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
 615                                 int i;
 616                                 for (i = 2; n[i]; i++)
 617                                         n[i] = ch;
 618                         } else if (n[0] == '.' || n[0] == 'h'
 619                                 || (n[0] == 'c' && n[1] == 'f')) {
 620                                 int i;
 621                                 for (i = 2; n[i]; i++) {
 622                                         if (n[i] != '.')
 623                                                 break;
 624                                 }
 625                                 if (!n[i]) {
 626                                         for (i = 2; n[i]; i++)
 627                                                 n[i] = ' ';
 628                                 }
 629                         }
 630                         break;
 631                 }
 632
 633                 /* "n" is the string to be inserted in place of this % code. */
 634                 if (!n)
 635                         continue;
 636                 if (n != buf2 && fmt[1]) {
 637                         strlcat(fmt, "s", sizeof fmt);
 638                         snprintf(buf2, sizeof buf2, fmt, n);
 639                         n = buf2;
 640                 }
 641                 len = strlen(n);
 642
 643                 /* Subtract the length of the escape from the string's size. */
 644                 total -= p - s + 1;
 645
 646                 if (len + total >= (size_t)sizeof buf) {
 647                         rprintf(FERROR,
 648                                 "buffer overflow expanding %%%c -- exiting\n",
 649                                 p[0]);
 650                         exit_cleanup(RERR_MESSAGEIO);
 651                 }
 652
 653                 /* Shuffle the rest of the string along to make space for n */
 654                 if (len != (size_t)(p - s + 1))
 655                         memmove(s + len, p + 1, total - (s - buf) + 1);
 656                 total += len;
 657
 658                 /* Insert the contents of string "n", but NOT its null. */
 659                 if (len)
 660                         memcpy(s, n, len);
 661
 662                 /* Skip over inserted string; continue looking */
 663                 p = s + len;
 664         }
 665
 666         rwrite(code, buf, total);
 667 }
 668
 669 /* Return 1 if the format escape is in the log-format string (e.g. look for
 670  * the 'b' in the "%9b" format escape). */
 671 int log_format_has(const char *format, char esc)
 672 {
 673         const char *p;
 674
 675         if (!format)
 676                 return 0;
 677
 678         for (p = format; (p = strchr(p, '%')) != NULL; ) {
 679                 if (*++p == '-')
 680                         p++;
 681                 while (isdigit(*(uchar*)p))
 682                         p++;
 683                 if (!*p)
 684                         break;
 685                 if (*p == esc)
 686                         return 1;
 687         }
 688         return 0;
 689 }
 690
 691 /* Log the transfer of a file.  If the code is FCLIENT, the output just goes
 692  * to stdout.  If it is FLOG, it just goes to the log file.  Otherwise we
 693  * output to both. */
 694 void log_item(enum logcode code, struct file_struct *file,
 695               struct stats *initial_stats, int iflags, char *hlink)
 696 {
 697         char *s_or_r = am_sender ? "send" : "recv";
 698
 699         if (code != FLOG && stdout_format && !am_server) {
 700                 log_formatted(FCLIENT, stdout_format, s_or_r,
 701                               file, initial_stats, iflags, hlink);
 702         }
 703         if (code != FCLIENT && logfile_format && *logfile_format) {
 704                 log_formatted(FLOG, logfile_format, s_or_r,
 705                               file, initial_stats, iflags, hlink);
 706         }
 707 }
 708
 709 void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
 710                     char *buf)
 711 {
 712         int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
 713         int see_item = itemizing && (significant_flags || *buf
 714                 || stdout_format_has_i > 1 || (verbose > 1 && stdout_format_has_i));
 715         int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
 716         if (am_server) {
 717                 if (logfile_name && !dry_run && see_item
 718                  && (significant_flags || logfile_format_has_i))
 719                         log_item(FLOG, file, &stats, iflags, buf);
 720         } else if (see_item || local_change || *buf
 721             || (S_ISDIR(file->mode) && significant_flags)) {
 722                 enum logcode code = significant_flags || logfile_format_has_i ? FINFO : FCLIENT;
 723                 log_item(code, file, &stats, iflags, buf);
 724         }
 725 }
 726
 727 void log_delete(char *fname, int mode)
 728 {
 729         static struct file_struct file;
 730         int len = strlen(fname);
 731         char *fmt;
 732
 733         file.mode = mode;
 734         file.basename = fname;
 735
 736         if (!verbose && !stdout_format)
 737                 ;
 738         else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
 739                 if (S_ISDIR(mode))
 740                         len++; /* directories include trailing null */
 741                 send_msg(MSG_DELETED, fname, len);
 742         } else {
 743                 fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n";
 744                 log_formatted(FCLIENT, fmt, "del.", &file, &stats,
 745                               ITEM_DELETED, NULL);
 746         }
 747
 748         if (!logfile_name || dry_run || !logfile_format)
 749                 return;
 750
 751         fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n";
 752         log_formatted(FLOG, fmt, "del.", &file, &stats, ITEM_DELETED, NULL);
 753 }
 754
 755 /*
 756  * Called when the transfer is interrupted for some reason.
 757  *
 758  * Code is one of the RERR_* codes from errcode.h, or terminating
 759  * successfully.
 760  */
 761 void log_exit(int code, const char *file, int line)
 762 {
 763         if (code == 0) {
 764                 rprintf(FLOG,"sent %.0f bytes  received %.0f bytes  total size %.0f\n",
 765                         (double)stats.total_written,
 766                         (double)stats.total_read,
 767                         (double)stats.total_size);
 768         } else {
 769                 const char *name;
 770
 771                 name = rerr_name(code);
 772                 if (!name)
 773                         name = "unexplained error";
 774
 775                 /* VANISHED is not an error, only a warning */
 776                 if (code == RERR_VANISHED) {
 777                         rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
 778                                 name, code, file, line, who_am_i(), RSYNC_VERSION);
 779                 } else {
 780                         rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
 781                                 name, code, file, line, who_am_i(), RSYNC_VERSION);
 782                 }
 783         }
 784 }