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