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