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