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