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