log.c

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