1 /* -*- c-file-style: "linux"; -*-
3 Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4 Copyright (C) 2000-2001 by Martin Pool <mbp@samba.org>
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.
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.
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.
22 Logging and utility functions.
25 Mapping to human-readable messages added by Martin Pool
26 <mbp@samba.org>, Oct 2000.
35 extern int local_server;
38 extern int msg_fd_out;
39 extern int protocol_version;
40 extern int preserve_times;
41 extern int log_format_has_i;
42 extern int log_format_has_o_or_i;
43 extern int daemon_log_format_has_o_or_i;
44 extern char *auth_user;
45 extern char *log_format;
47 static int log_initialised;
48 static int logfile_was_closed;
49 static char *logfname;
53 int log_got_error = 0;
58 } const rerr_names[] = {
59 { RERR_SYNTAX , "syntax or usage error" },
60 { RERR_PROTOCOL , "protocol incompatibility" },
61 { RERR_FILESELECT , "errors selecting input/output files, dirs" },
62 { RERR_UNSUPPORTED, "requested action not supported" },
63 { RERR_STARTCLIENT, "error starting client-server protocol" },
64 { RERR_SOCKETIO , "error in socket IO" },
65 { RERR_FILEIO , "error in file IO" },
66 { RERR_STREAMIO , "error in rsync protocol data stream" },
67 { RERR_MESSAGEIO , "errors with program diagnostics" },
68 { RERR_IPC , "error in IPC code" },
69 { RERR_CRASHED , "sibling process crashed" },
70 { RERR_TERMINATED , "sibling process terminated abnormally" },
71 { RERR_SIGNAL1 , "received SIGUSR1" },
72 { RERR_SIGNAL , "received SIGINT, SIGTERM, or SIGHUP" },
73 { RERR_WAITCHILD , "waitpid() failed" },
74 { RERR_MALLOC , "error allocating core memory buffers" },
75 { RERR_PARTIAL , "some files could not be transferred" },
76 { RERR_VANISHED , "some files vanished before they could be transferred" },
77 { RERR_TIMEOUT , "timeout in data send/receive" },
78 { RERR_CMD_FAILED , "remote shell failed" },
79 { RERR_CMD_KILLED , "remote shell killed" },
80 { RERR_CMD_RUN , "remote command could not be run" },
81 { RERR_CMD_NOTFOUND,"remote command not found" },
82 { RERR_DEL_LIMIT , "the --max-delete limit stopped deletions" },
88 * Map from rsync error code to name, or return NULL.
90 static char const *rerr_name(int code)
93 for (i = 0; rerr_names[i].name; i++) {
94 if (rerr_names[i].code == code)
95 return rerr_names[i].name;
100 static void logit(int priority, char *buf)
102 if (logfile_was_closed)
105 fprintf(logfile,"%s [%d] %s",
106 timestring(time(NULL)), (int)getpid(), buf);
109 syslog(priority, "%s", buf);
113 static void syslog_init()
115 static int been_here = 0;
116 int options = LOG_PID;
123 options |= LOG_NDELAY;
127 openlog("rsyncd", options, lp_syslog_facility());
129 openlog("rsyncd", options);
133 logit(LOG_INFO, "rsyncd started\n");
137 static void logfile_open(void)
139 extern int orig_umask;
140 int old_umask = umask(022 | orig_umask);
141 logfile = fopen(logfname, "a");
144 int fopen_errno = errno;
145 /* Rsync falls back to using syslog on failure. */
147 rsyserr(FERROR, fopen_errno,
148 "failed to open log-file %s", logfname);
149 rprintf(FINFO, "Ignoring \"log file\" setting.\n");
161 /* this looks pointless, but it is needed in order for the
162 * C library on some systems to fetch the timezone info
163 * before the chroot */
167 /* optionally use a log file instead of syslog */
168 logfname = lp_log_file();
169 if (logfname && *logfname)
175 void logfile_close(void)
178 logfile_was_closed = 1;
184 void logfile_reopen(void)
186 if (logfile_was_closed) {
187 logfile_was_closed = 0;
192 static void filtered_fwrite(const char *buf, int len, FILE *f)
194 const char *s, *end = buf + len;
195 for (s = buf; s < end; s++) {
197 && *s == '\\' && s[1] == '0'
198 && isdigit(*(uchar*)(s+2))
199 && isdigit(*(uchar*)(s+3))
200 && isdigit(*(uchar*)(s+4)))
201 || !isprint(*(uchar*)s)
202 || *(uchar*)s < ' ') {
203 if (s != buf && fwrite(buf, s - buf, 1, f) != 1)
204 exit_cleanup(RERR_MESSAGEIO);
205 fprintf(f, "\\%04o", *(uchar*)s);
209 if (buf != end && fwrite(buf, end - buf, 1, f) != 1)
210 exit_cleanup(RERR_MESSAGEIO);
213 /* this is the underlying (unformatted) rsync debugging function. Call
214 * it with FINFO, FERROR or FLOG. Note: recursion can happen with
215 * certain fatal conditions. */
216 void rwrite(enum logcode code, char *buf, int len)
218 int trailing_CR_or_NL;
222 exit_cleanup(RERR_MESSAGEIO);
224 if (quiet && code == FINFO)
227 if (am_server && msg_fd_out >= 0) {
228 /* Pass the message to our sibling. */
229 send_msg((enum msgcode)code, buf, len);
233 if (code == FSOCKERR) /* This gets simplified for a non-sibling. */
238 else if (am_daemon) {
241 int priority = code == FERROR ? LOG_WARNING : LOG_INFO;
246 if (!log_initialised)
248 strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
249 logit(priority, msg);
252 if (code == FLOG || !am_server)
254 } else if (code == FLOG)
258 /* Pass the message to the non-server side. */
259 if (io_multiplex_write((enum msgcode)code, buf, len))
262 /* TODO: can we send the error to the user somehow? */
273 f = am_server ? stderr : stdout;
275 while (len > 1 && (*buf == '\n' || *buf == '\t')) {
282 f = am_server ? stderr : stdout;
285 exit_cleanup(RERR_MESSAGEIO);
288 trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
291 filtered_fwrite(buf, len, f);
293 if (trailing_CR_or_NL) {
294 fputc(trailing_CR_or_NL, f);
299 /* This is the rsync debugging function. Call it with FINFO, FERROR or
301 void rprintf(enum logcode code, const char *format, ...)
304 char buf[BIGPATHBUFLEN];
307 va_start(ap, format);
308 len = vsnprintf(buf, sizeof buf, format, ap);
311 /* Deal with buffer overruns. Instead of panicking, just
312 * truncate the resulting string. (Note that configure ensures
313 * that we have a vsnprintf() that doesn't ever return -1.) */
314 if (len > sizeof buf - 1) {
315 static const char ellipsis[] = "[...]";
317 /* Reset length, and zero-terminate the end of our buffer */
318 len = sizeof buf - 1;
321 /* Copy the ellipsis to the end of the string, but give
322 * us one extra character:
324 * v--- null byte at buf[sizeof buf - 1]
326 * -> abcd[...]00 <-- now two null bytes at end
328 * If the input format string has a trailing newline,
329 * we copy it into that extra null; if it doesn't, well,
330 * all we lose is one byte. */
331 memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
332 if (format[strlen(format)-1] == '\n') {
337 rwrite(code, buf, len);
340 /* This is like rprintf, but it also tries to print some
341 * representation of the error code. Normally errcode = errno.
343 * Unlike rprintf, this always adds a newline and there should not be
344 * one in the format string.
346 * Note that since strerror might involve dynamically loading a
347 * message catalog we need to call it once before chroot-ing. */
348 void rsyserr(enum logcode code, int errcode, const char *format, ...)
351 char buf[BIGPATHBUFLEN];
354 strcpy(buf, RSYNC_NAME ": ");
355 len = (sizeof RSYNC_NAME ": ") - 1;
357 va_start(ap, format);
358 len += vsnprintf(buf + len, sizeof buf - len, format, ap);
361 if (len < sizeof buf) {
362 len += snprintf(buf + len, sizeof buf - len,
363 ": %s (%d)\n", strerror(errcode), errcode);
365 if (len >= sizeof buf)
366 exit_cleanup(RERR_MESSAGEIO);
368 rwrite(code, buf, len);
371 void rflush(enum logcode code)
383 if (code == FERROR) {
394 if (!f) exit_cleanup(RERR_MESSAGEIO);
398 /* a generic logging routine for send/recv, with parameter
400 static void log_formatted(enum logcode code, char *format, char *op,
401 struct file_struct *file, struct stats *initial_stats,
402 int iflags, char *hlink)
404 char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32];
411 /* We expand % codes one by one in place in buf. We don't
412 * copy in the terminating null of the inserted strings, but
413 * rather keep going until we reach the null of the format. */
414 total = strlcpy(buf, format, sizeof buf);
415 if (total > MAXPATHLEN) {
416 rprintf(FERROR, "log-format string is WAY too long!\n");
417 exit_cleanup(RERR_MESSAGEIO);
422 for (p = buf; (p = strchr(p, '%')) != NULL; ) {
427 while (isdigit(*(uchar*)p) && n - fmt < (int)(sizeof fmt) - 8)
444 strlcat(fmt, ".0f", sizeof fmt);
445 snprintf(buf2, sizeof buf2, fmt,
446 (double)file->length);
450 strlcat(fmt, "ld", sizeof fmt);
451 snprintf(buf2, sizeof buf2, fmt,
459 n = f_name(file, NULL);
460 if (am_sender && file->dir.root) {
461 pathjoin(buf2, sizeof buf2,
463 clean_fname(buf2, 0);
465 strlcpy(n, buf2, MAXPATHLEN);
474 n = f_name(file, NULL);
475 if (S_ISDIR(file->mode))
476 strlcat(n, "/", MAXPATHLEN);
479 if (hlink && *hlink) {
481 strcpy(buf2, " => ");
482 } else if (S_ISLNK(file->mode) && file->u.link) {
484 strcpy(buf2, " -> ");
491 strlcat(fmt, "s", sizeof fmt);
492 snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
496 n = lp_name(module_id);
499 n = timestring(time(NULL));
502 n = lp_path(module_id);
509 b = stats.total_written -
510 initial_stats->total_written;
512 b = stats.total_read -
513 initial_stats->total_read;
515 strlcat(fmt, ".0f", sizeof fmt);
516 snprintf(buf2, sizeof buf2, fmt, (double)b);
521 b = stats.total_written -
522 initial_stats->total_written;
524 b = stats.total_read -
525 initial_stats->total_read;
527 strlcat(fmt, ".0f", sizeof fmt);
528 snprintf(buf2, sizeof buf2, fmt, (double)b);
532 if (iflags & ITEM_DELETED) {
536 n = buf2 + MAXPATHLEN - 32;
537 n[0] = iflags & ITEM_LOCAL_CHANGE
538 ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
539 : !(iflags & ITEM_TRANSFER) ? '.'
540 : !local_server && *op == 's' ? '<' : '>';
541 n[1] = S_ISDIR(file->mode) ? 'd'
542 : IS_SPECIAL(file->mode) ? 'S'
543 : IS_DEVICE(file->mode) ? 'D'
544 : S_ISLNK(file->mode) ? 'L' : 'f';
545 n[2] = !(iflags & ITEM_REPORT_CHECKSUM) ? '.' : 'c';
546 n[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
547 n[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
548 : !preserve_times || S_ISLNK(file->mode) ? 'T' : 't';
549 n[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
550 n[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
551 n[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
554 if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
555 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
557 for (i = 2; n[i]; i++)
559 } else if (n[0] == '.' || n[0] == 'h'
560 || (n[0] == 'c' && n[1] == 'f')) {
562 for (i = 2; n[i]; i++) {
567 for (i = 2; n[i]; i++)
574 /* "n" is the string to be inserted in place of this % code. */
577 if (n != buf2 && fmt[1]) {
578 strlcat(fmt, "s", sizeof fmt);
579 snprintf(buf2, sizeof buf2, fmt, n);
584 /* Subtract the length of the escape from the string's size. */
587 if (len + total >= (size_t)sizeof buf) {
589 "buffer overflow expanding %%%c -- exiting\n",
591 exit_cleanup(RERR_MESSAGEIO);
594 /* Shuffle the rest of the string along to make space for n */
595 if (len != (size_t)(p - s + 1))
596 memmove(s + len, p + 1, total - (s - buf) + 1);
599 /* Insert the contents of string "n", but NOT its null. */
603 /* Skip over inserted string; continue looking */
607 rwrite(code, buf, total);
610 /* Return 1 if the format escape is in the log-format string (e.g. look for
611 * the 'b' in the "%9b" format escape). */
612 int log_format_has(const char *format, char esc)
619 for (p = format; (p = strchr(p, '%')) != NULL; ) {
622 while (isdigit(*(uchar*)p))
632 /* log the transfer of a file */
633 void log_item(struct file_struct *file, struct stats *initial_stats,
634 int iflags, char *hlink)
636 char *s_or_r = am_sender ? "send" : "recv";
638 if (lp_transfer_logging(module_id)) {
639 log_formatted(FLOG, lp_log_format(module_id), s_or_r,
640 file, initial_stats, iflags, hlink);
641 } else if (log_format && !am_server) {
642 log_formatted(FNAME, log_format, s_or_r,
643 file, initial_stats, iflags, hlink);
647 void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
650 int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
651 int see_item = itemizing && (significant_flags || *buf
652 || log_format_has_i > 1 || (verbose > 1 && log_format_has_i));
653 int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
655 if (am_daemon && !dry_run && see_item)
656 log_item(file, &stats, iflags, buf);
657 } else if (see_item || local_change || *buf
658 || (S_ISDIR(file->mode) && significant_flags))
659 log_item(file, &stats, iflags, buf);
662 void log_delete(char *fname, int mode)
664 static struct file_struct file;
665 int len = strlen(fname);
669 file.basename = fname;
671 if (!verbose && !log_format)
673 else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
675 len++; /* directories include trailing null */
676 send_msg(MSG_DELETED, fname, len);
678 fmt = log_format_has_o_or_i ? log_format : "deleting %n";
679 log_formatted(FCLIENT, fmt, "del.", &file, &stats,
683 if (!am_daemon || dry_run || !lp_transfer_logging(module_id))
686 fmt = daemon_log_format_has_o_or_i ? lp_log_format(module_id) : "deleting %n";
687 log_formatted(FLOG, fmt, "del.", &file, &stats, ITEM_DELETED, NULL);
691 * Called when the transfer is interrupted for some reason.
693 * Code is one of the RERR_* codes from errcode.h, or terminating
696 void log_exit(int code, const char *file, int line)
699 rprintf(FLOG,"sent %.0f bytes received %.0f bytes total size %.0f\n",
700 (double)stats.total_written,
701 (double)stats.total_read,
702 (double)stats.total_size);
706 name = rerr_name(code);
708 name = "unexplained error";
710 /* VANISHED is not an error, only a warning */
711 if (code == RERR_VANISHED) {
712 rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d)\n",
713 name, code, file, line);
715 rprintf(FERROR, "rsync error: %s (code %d) at %s(%d)\n",
716 name, code, file, line);