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 quiet;
  36 extern int module_id;
  37 extern int msg_fd_out;
  38 extern int protocol_version;
  39 extern int preserve_times;
  40 extern int log_format_has_o_or_i;
  41 extern int daemon_log_format_has_o_or_i;
  42 extern char *auth_user;
  43 extern char *log_format;
  44
  45 static int log_initialised;
  46 static char *logfname;
  47 static FILE *logfile;
  48 struct stats stats;
  49
  50 int log_got_error = 0;
  51
  52 struct {
  53         int code;
  54         char const *name;
  55 } const rerr_names[] = {
  56         { RERR_SYNTAX     , "syntax or usage error" },
  57         { RERR_PROTOCOL   , "protocol incompatibility" },
  58         { RERR_FILESELECT , "errors selecting input/output files, dirs" },
  59         { RERR_UNSUPPORTED, "requested action not supported" },
  60         { RERR_STARTCLIENT, "error starting client-server protocol" },
  61         { RERR_LOG_FAILURE, "daemon unable to append to log-file" },
  62         { RERR_SOCKETIO   , "error in socket IO" },
  63         { RERR_FILEIO     , "error in file IO" },
  64         { RERR_STREAMIO   , "error in rsync protocol data stream" },
  65         { RERR_MESSAGEIO  , "errors with program diagnostics" },
  66         { RERR_IPC        , "error in IPC code" },
  67         { RERR_SIGNAL     , "received SIGUSR1 or SIGINT" },
  68         { RERR_WAITCHILD  , "some error returned by waitpid()" },
  69         { RERR_MALLOC     , "error allocating core memory buffers" },
  70         { RERR_PARTIAL    , "some files could not be transferred" },
  71         { RERR_VANISHED   , "some files vanished before they could be transferred" },
  72         { RERR_TIMEOUT    , "timeout in data send/receive" },
  73         { RERR_CMD_FAILED , "remote shell failed" },
  74         { RERR_CMD_KILLED , "remote shell killed" },
  75         { RERR_CMD_RUN    , "remote command could not be run" },
  76         { RERR_CMD_NOTFOUND,"remote command not found" },
  77         { RERR_DEL_LIMIT  , "the --max-delete limit stopped deletions" },
  78         { 0, NULL }
  79 };
  80
  81
  82
  83 /*
  84  * Map from rsync error code to name, or return NULL.
  85  */
  86 static char const *rerr_name(int code)
  87 {
  88         int i;
  89         for (i = 0; rerr_names[i].name; i++) {
  90                 if (rerr_names[i].code == code)
  91                         return rerr_names[i].name;
  92         }
  93         return NULL;
  94 }
  95
  96
  97 static void logit(int priority, char *buf)
  98 {
  99         if (logfname) {
 100                 if (!logfile)
 101                         log_open();
 102                 fprintf(logfile,"%s [%d] %s",
 103                         timestring(time(NULL)), (int)getpid(), buf);
 104                 fflush(logfile);
 105         } else {
 106                 syslog(priority, "%s", buf);
 107         }
 108 }
 109
 110 void log_init(void)
 111 {
 112         int options = LOG_PID;
 113         time_t t;
 114
 115         if (log_initialised)
 116                 return;
 117         log_initialised = 1;
 118
 119         /* this looks pointless, but it is needed in order for the
 120          * C library on some systems to fetch the timezone info
 121          * before the chroot */
 122         t = time(NULL);
 123         localtime(&t);
 124
 125         /* optionally use a log file instead of syslog */
 126         logfname = lp_log_file();
 127         if (logfname) {
 128                 if (*logfname) {
 129                         log_open();
 130                         return;
 131                 }
 132                 logfname = NULL;
 133         }
 134
 135 #ifdef LOG_NDELAY
 136         options |= LOG_NDELAY;
 137 #endif
 138
 139 #ifdef LOG_DAEMON
 140         openlog("rsyncd", options, lp_syslog_facility());
 141 #else
 142         openlog("rsyncd", options);
 143 #endif
 144
 145 #ifndef LOG_NDELAY
 146         logit(LOG_INFO,"rsyncd started\n");
 147 #endif
 148 }
 149
 150 void log_open(void)
 151 {
 152         if (logfname && !logfile) {
 153                 extern int orig_umask;
 154                 int old_umask = umask(022 | orig_umask);
 155                 logfile = fopen(logfname, "a");
 156                 umask(old_umask);
 157                 if (!logfile) {
 158                         am_daemon = 0; /* avoid trying to log again */
 159                         rsyserr(FERROR, errno, "fopen() of log-file failed");
 160                         exit_cleanup(RERR_LOG_FAILURE);
 161                 }
 162         }
 163 }
 164
 165 void log_close(void)
 166 {
 167         if (logfile) {
 168                 fclose(logfile);
 169                 logfile = NULL;
 170         }
 171 }
 172
 173 /* this is the underlying (unformatted) rsync debugging function. Call
 174  * it with FINFO, FERROR or FLOG */
 175 void rwrite(enum logcode code, char *buf, int len)
 176 {
 177         FILE *f = NULL;
 178         /* recursion can happen with certain fatal conditions */
 179
 180         if (quiet && code == FINFO)
 181                 return;
 182
 183         if (len < 0)
 184                 exit_cleanup(RERR_MESSAGEIO);
 185
 186         buf[len] = 0;
 187
 188         if (am_server && msg_fd_out >= 0) {
 189                 /* Pass the message to our sibling. */
 190                 send_msg((enum msgcode)code, buf, len);
 191                 return;
 192         }
 193
 194         if (code == FCLIENT)
 195                 code = FINFO;
 196         else if (am_daemon) {
 197                 static int in_block;
 198                 char msg[2048];
 199                 int priority = code == FERROR ? LOG_WARNING : LOG_INFO;
 200
 201                 if (in_block)
 202                         return;
 203                 in_block = 1;
 204                 if (!log_initialised)
 205                         log_init();
 206                 strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
 207                 logit(priority, msg);
 208                 in_block = 0;
 209
 210                 if (code == FLOG || !am_server)
 211                         return;
 212         } else if (code == FLOG)
 213                 return;
 214
 215         if (am_server) {
 216                 /* Pass the message to the non-server side. */
 217                 if (io_multiplex_write((enum msgcode)code, buf, len))
 218                         return;
 219                 if (am_daemon) {
 220                         /* TODO: can we send the error to the user somehow? */
 221                         return;
 222                 }
 223         }
 224
 225         if (code == FERROR) {
 226                 log_got_error = 1;
 227                 f = stderr;
 228         }
 229
 230         if (code == FINFO)
 231                 f = am_server ? stderr : stdout;
 232
 233         if (!f)
 234                 exit_cleanup(RERR_MESSAGEIO);
 235
 236         if (fwrite(buf, len, 1, f) != 1)
 237                 exit_cleanup(RERR_MESSAGEIO);
 238
 239         if (buf[len-1] == '\r' || buf[len-1] == '\n')
 240                 fflush(f);
 241 }
 242
 243
 244 /* This is the rsync debugging function. Call it with FINFO, FERROR or
 245  * FLOG. */
 246 void rprintf(enum logcode code, const char *format, ...)
 247 {
 248         va_list ap;
 249         char buf[MAXPATHLEN+512];
 250         size_t len;
 251
 252         va_start(ap, format);
 253         len = vsnprintf(buf, sizeof buf, format, ap);
 254         va_end(ap);
 255
 256         /* Deal with buffer overruns.  Instead of panicking, just
 257          * truncate the resulting string.  (Note that configure ensures
 258          * that we have a vsnprintf() that doesn't ever return -1.) */
 259         if (len > sizeof buf - 1) {
 260                 const char ellipsis[] = "[...]";
 261
 262                 /* Reset length, and zero-terminate the end of our buffer */
 263                 len = sizeof buf - 1;
 264                 buf[len] = '\0';
 265
 266                 /* Copy the ellipsis to the end of the string, but give
 267                  * us one extra character:
 268                  *
 269                  *                  v--- null byte at buf[sizeof buf - 1]
 270                  *        abcdefghij0
 271                  *     -> abcd[...]00  <-- now two null bytes at end
 272                  *
 273                  * If the input format string has a trailing newline,
 274                  * we copy it into that extra null; if it doesn't, well,
 275                  * all we lose is one byte.  */
 276                 strncpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
 277                 if (format[strlen(format)-1] == '\n') {
 278                         buf[len-1] = '\n';
 279                 }
 280         }
 281
 282         rwrite(code, buf, len);
 283 }
 284
 285
 286 /* This is like rprintf, but it also tries to print some
 287  * representation of the error code.  Normally errcode = errno.
 288  *
 289  * Unlike rprintf, this always adds a newline and there should not be
 290  * one in the format string.
 291  *
 292  * Note that since strerror might involve dynamically loading a
 293  * message catalog we need to call it once before chroot-ing. */
 294 void rsyserr(enum logcode code, int errcode, const char *format, ...)
 295 {
 296         va_list ap;
 297         char buf[MAXPATHLEN+512];
 298         size_t len;
 299
 300         strcpy(buf, RSYNC_NAME ": ");
 301         len = (sizeof RSYNC_NAME ": ") - 1;
 302
 303         va_start(ap, format);
 304         len += vsnprintf(buf + len, sizeof buf - len, format, ap);
 305         va_end(ap);
 306
 307         if (len < sizeof buf) {
 308                 len += snprintf(buf + len, sizeof buf - len,
 309                                 ": %s (%d)\n", strerror(errcode), errcode);
 310         }
 311         if (len >= sizeof buf)
 312                 exit_cleanup(RERR_MESSAGEIO);
 313
 314         rwrite(code, buf, len);
 315 }
 316
 317
 318
 319 void rflush(enum logcode code)
 320 {
 321         FILE *f = NULL;
 322
 323         if (am_daemon) {
 324                 return;
 325         }
 326
 327         if (code == FLOG) {
 328                 return;
 329         }
 330
 331         if (code == FERROR) {
 332                 f = stderr;
 333         }
 334
 335         if (code == FINFO) {
 336                 if (am_server)
 337                         f = stderr;
 338                 else
 339                         f = stdout;
 340         }
 341
 342         if (!f) exit_cleanup(RERR_MESSAGEIO);
 343         fflush(f);
 344 }
 345
 346
 347
 348 /* a generic logging routine for send/recv, with parameter
 349  * substitiution */
 350 static void log_formatted(enum logcode code, char *format, char *op,
 351                           struct file_struct *file, struct stats *initial_stats,
 352                           int iflags, char *hlink)
 353 {
 354         char buf[MAXPATHLEN+1024];
 355         char buf2[MAXPATHLEN];
 356         char *p, *n;
 357         size_t len, total;
 358         int64 b;
 359
 360         /* We expand % codes one by one in place in buf.  We don't
 361          * copy in the terminating nul of the inserted strings, but
 362          * rather keep going until we reach the nul of the format. */
 363         total = strlcpy(buf, format, sizeof buf);
 364
 365         for (p = buf; (p = strchr(p, '%')) != NULL && p[1]; ) {
 366                 n = NULL;
 367
 368                 switch (p[1]) {
 369                 case 'h': if (am_daemon) n = client_name(0); break;
 370                 case 'a': if (am_daemon) n = client_addr(0); break;
 371                 case 'l':
 372                         snprintf(buf2, sizeof buf2, "%.0f",
 373                                  (double)file->length);
 374                         n = buf2;
 375                         break;
 376                 case 'p':
 377                         snprintf(buf2, sizeof buf2, "%d",
 378                                  (int)getpid());
 379                         n = buf2;
 380                         break;
 381                 case 'o': n = op; break;
 382                 case 'f':
 383                         pathjoin(buf2, sizeof buf2,
 384                             am_sender && file->dir.root ? file->dir.root : "",
 385                             safe_fname(f_name(file)));
 386                         clean_fname(buf2, 0);
 387                         n = buf2;
 388                         if (*n == '/') n++;
 389                         break;
 390                 case 'n':
 391                         n = (char*)safe_fname(f_name(file));
 392                         if (S_ISDIR(file->mode)) {
 393                                 /* The buffer from safe_fname() has more
 394                                  * room than MAXPATHLEN, so this is safe. */
 395                                 strcat(n, "/");
 396                         }
 397                         break;
 398                 case 'L':
 399                         if (hlink && *hlink) {
 400                                 snprintf(buf2, sizeof buf2, " => %s",
 401                                          safe_fname(hlink));
 402                                 n = buf2;
 403                         } else if (S_ISLNK(file->mode) && file->u.link) {
 404                                 snprintf(buf2, sizeof buf2, " -> %s",
 405                                          safe_fname(file->u.link));
 406                                 n = buf2;
 407                         } else
 408                                 n = "";
 409                         break;
 410                 case 'm': n = lp_name(module_id); break;
 411                 case 't': n = timestring(time(NULL)); break;
 412                 case 'P': n = lp_path(module_id); break;
 413                 case 'u': n = auth_user; break;
 414                 case 'b':
 415                         if (am_sender) {
 416                                 b = stats.total_written -
 417                                         initial_stats->total_written;
 418                         } else {
 419                                 b = stats.total_read -
 420                                         initial_stats->total_read;
 421                         }
 422                         snprintf(buf2, sizeof buf2, "%.0f", (double)b);
 423                         n = buf2;
 424                         break;
 425                 case 'c':
 426                         if (!am_sender) {
 427                                 b = stats.total_written -
 428                                         initial_stats->total_written;
 429                         } else {
 430                                 b = stats.total_read -
 431                                         initial_stats->total_read;
 432                         }
 433                         snprintf(buf2, sizeof buf2, "%.0f", (double)b);
 434                         n = buf2;
 435                         break;
 436                 case 'i':
 437                         if (iflags & ITEM_DELETED) {
 438                                 n = "*deleting";
 439                                 break;
 440                         }
 441                         n = buf2;
 442                         n[0] = iflags & ITEM_LOCAL_CHANGE
 443                               ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
 444                              : !(iflags & ITEM_TRANSFER) ? '.'
 445                              : *op == 's' ? '>' : '<';
 446                         n[1] = S_ISDIR(file->mode) ? 'd'
 447                              : IS_DEVICE(file->mode) ? 'D'
 448                              : S_ISLNK(file->mode) ? 'L' : 'f';
 449                         n[2] = !(iflags & ITEM_REPORT_CHECKSUM) ? '.' : 'c';
 450                         n[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
 451                         n[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
 452                              : !preserve_times || IS_DEVICE(file->mode)
 453                                                || S_ISLNK(file->mode) ? 'T' : 't';
 454                         n[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
 455                         n[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
 456                         n[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
 457                         n[8] = !(iflags & ITEM_REPORT_XATTRS) ? '.' : 'a';
 458                         n[9] = '\0';
 459
 460                         if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
 461                                 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
 462                                 int i;
 463                                 for (i = 2; n[i]; i++)
 464                                         n[i] = ch;
 465                         } else if (!(iflags & (ITEM_TRANSFER|ITEM_LOCAL_CHANGE))) {
 466                                 int i;
 467                                 for (i = 2; n[i]; i++) {
 468                                         if (n[i] != '.')
 469                                                 break;
 470                                 }
 471                                 if (!n[i]) {
 472                                         for (i = 2; n[i]; i++)
 473                                                 n[i] = ' ';
 474                                 }
 475                         }
 476                         break;
 477                 }
 478
 479                 /* n is the string to be inserted in place of this %
 480                  * code; len is its length not including the trailing
 481                  * NUL */
 482                 if (!n) {
 483                         p += 2;
 484                         continue;
 485                 }
 486
 487                 len = strlen(n);
 488
 489                 if (len + total - 2 >= sizeof buf) {
 490                         rprintf(FERROR,
 491                                 "buffer overflow expanding %%%c -- exiting\n",
 492                                 p[0]);
 493                         exit_cleanup(RERR_MESSAGEIO);
 494                 }
 495
 496                 /* Shuffle the rest of the string along to make space for n */
 497                 if (len != 2)
 498                         memmove(p + len, p + 2, total - (p + 2 - buf) + 1);
 499                 total += len - 2;
 500
 501                 /* Insert the contents of string "n", but NOT its nul. */
 502                 if (len)
 503                         memcpy(p, n, len);
 504
 505                 /* Skip over inserted string; continue looking */
 506                 p += len;
 507         }
 508
 509         rprintf(code, "%s\n", buf);
 510 }
 511
 512 /* log the transfer of a file */
 513 void log_item(struct file_struct *file, struct stats *initial_stats,
 514               int iflags, char *hlink)
 515 {
 516         char *s_or_r = am_sender ? "send" : "recv";
 517
 518         if (lp_transfer_logging(module_id)) {
 519                 log_formatted(FLOG, lp_log_format(module_id), s_or_r,
 520                               file, initial_stats, iflags, hlink);
 521         } else if (log_format && !am_server) {
 522                 log_formatted(FINFO, log_format, s_or_r,
 523                               file, initial_stats, iflags, hlink);
 524         }
 525 }
 526
 527 void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
 528                     char *buf)
 529 {
 530         int see_item = itemizing && (iflags || verbose > 1);
 531         if (am_server) {
 532                 if (am_daemon && !dry_run && see_item)
 533                         log_item(file, &stats, iflags, buf);
 534         } else if (see_item || iflags & ITEM_LOCAL_CHANGE || *buf
 535             || (S_ISDIR(file->mode) && iflags & SIGNIFICANT_ITEM_FLAGS))
 536                 log_item(file, &stats, iflags, buf);
 537 }
 538
 539 void log_delete(char *fname, int mode)
 540 {
 541         static struct file_struct file;
 542         int len = strlen(fname);
 543         char *fmt;
 544
 545         file.mode = mode;
 546         file.basename = fname;
 547
 548         if (!verbose && !log_format)
 549                 ;
 550         else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
 551                 if (S_ISDIR(mode))
 552                         len++; /* directories include trailing null */
 553                 send_msg(MSG_DELETED, fname, len);
 554         } else {
 555                 fmt = log_format_has_o_or_i ? log_format : "deleting %n";
 556                 log_formatted(FCLIENT, fmt, "del.", &file, &stats,
 557                               ITEM_DELETED, NULL);
 558         }
 559
 560         if (!am_daemon || dry_run || !lp_transfer_logging(module_id))
 561                 return;
 562
 563         fmt = daemon_log_format_has_o_or_i ? lp_log_format(module_id) : "deleting %n";
 564         log_formatted(FLOG, fmt, "del.", &file, &stats, ITEM_DELETED, NULL);
 565 }
 566
 567
 568 /*
 569  * Called when the transfer is interrupted for some reason.
 570  *
 571  * Code is one of the RERR_* codes from errcode.h, or terminating
 572  * successfully.
 573  */
 574 void log_exit(int code, const char *file, int line)
 575 {
 576         if (code == 0) {
 577                 rprintf(FLOG,"sent %.0f bytes  received %.0f bytes  total size %.0f\n",
 578                         (double)stats.total_written,
 579                         (double)stats.total_read,
 580                         (double)stats.total_size);
 581         } else {
 582                 const char *name;
 583
 584                 name = rerr_name(code);
 585                 if (!name)
 586                         name = "unexplained error";
 587
 588                 /* VANISHED is not an error, only a warning */
 589                 if (code == RERR_VANISHED) {
 590                         rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d)\n",
 591                                 name, code, file, line);
 592                 } else {
 593                         rprintf(FERROR, "rsync error: %s (code %d) at %s(%d)\n",
 594                                 name, code, file, line);
 595                 }
 596         }
 597 }