2 * Logging and utility functions.
4 * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 2000-2001 Martin Pool <mbp@samba.org>
6 * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
24 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
33 extern int local_server;
36 extern int msg_fd_out;
37 extern int allow_8bit_chars;
38 extern int protocol_version;
39 extern int preserve_times;
40 extern int stdout_format_has_i;
41 extern int stdout_format_has_o_or_i;
42 extern int logfile_format_has_i;
43 extern int logfile_format_has_o_or_i;
44 extern mode_t orig_umask;
45 extern char *auth_user;
46 extern char *stdout_format;
47 extern char *logfile_format;
48 extern char *logfile_name;
49 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
50 extern iconv_t ic_chck;
52 extern char curr_dir[];
53 extern unsigned int module_dirlen;
55 static int log_initialised;
56 static int logfile_was_closed;
57 static FILE *logfile_fp;
60 int log_got_error = 0;
65 } const rerr_names[] = {
66 { RERR_SYNTAX , "syntax or usage error" },
67 { RERR_PROTOCOL , "protocol incompatibility" },
68 { RERR_FILESELECT , "errors selecting input/output files, dirs" },
69 { RERR_UNSUPPORTED, "requested action not supported" },
70 { RERR_STARTCLIENT, "error starting client-server protocol" },
71 { RERR_SOCKETIO , "error in socket IO" },
72 { RERR_FILEIO , "error in file IO" },
73 { RERR_STREAMIO , "error in rsync protocol data stream" },
74 { RERR_MESSAGEIO , "errors with program diagnostics" },
75 { RERR_IPC , "error in IPC code" },
76 { RERR_CRASHED , "sibling process crashed" },
77 { RERR_TERMINATED , "sibling process terminated abnormally" },
78 { RERR_SIGNAL1 , "received SIGUSR1" },
79 { RERR_SIGNAL , "received SIGINT, SIGTERM, or SIGHUP" },
80 { RERR_WAITCHILD , "waitpid() failed" },
81 { RERR_MALLOC , "error allocating core memory buffers" },
82 { RERR_PARTIAL , "some files could not be transferred" },
83 { RERR_VANISHED , "some files vanished before they could be transferred" },
84 { RERR_TIMEOUT , "timeout in data send/receive" },
85 { RERR_CMD_FAILED , "remote shell failed" },
86 { RERR_CMD_KILLED , "remote shell killed" },
87 { RERR_CMD_RUN , "remote command could not be run" },
88 { RERR_CMD_NOTFOUND,"remote command not found" },
89 { RERR_DEL_LIMIT , "the --max-delete limit stopped deletions" },
95 * Map from rsync error code to name, or return NULL.
97 static char const *rerr_name(int code)
100 for (i = 0; rerr_names[i].name; i++) {
101 if (rerr_names[i].code == code)
102 return rerr_names[i].name;
107 static void logit(int priority, char *buf)
109 if (logfile_was_closed)
112 fprintf(logfile_fp, "%s [%d] %s",
113 timestring(time(NULL)), (int)getpid(), buf);
116 syslog(priority, "%s", buf);
120 static void syslog_init()
122 static int been_here = 0;
123 int options = LOG_PID;
130 options |= LOG_NDELAY;
134 openlog("rsyncd", options, lp_syslog_facility(module_id));
136 openlog("rsyncd", options);
140 logit(LOG_INFO, "rsyncd started\n");
144 static void logfile_open(void)
146 mode_t old_umask = umask(022 | orig_umask);
147 logfile_fp = fopen(logfile_name, "a");
150 int fopen_errno = errno;
151 /* Rsync falls back to using syslog on failure. */
153 rsyserr(FERROR, fopen_errno,
154 "failed to open log-file %s", logfile_name);
155 rprintf(FINFO, "Ignoring \"log file\" setting.\n");
159 void log_init(int restart)
161 if (log_initialised) {
164 if (strcmp(logfile_name, lp_log_file(module_id)) != 0) {
171 } else if (*logfile_name)
172 return; /* unchanged, non-empty "log file" names */
173 else if (lp_syslog_facility(-1) != lp_syslog_facility(module_id))
176 return; /* unchanged syslog settings */
180 /* This looks pointless, but it is needed in order for the
181 * C library on some systems to fetch the timezone info
182 * before the chroot. */
183 timestring(time(NULL));
185 /* Optionally use a log file instead of syslog. (Non-daemon
186 * rsyncs will have already set logfile_name, as needed.) */
187 if (am_daemon && !logfile_name)
188 logfile_name = lp_log_file(module_id);
189 if (logfile_name && *logfile_name)
195 void logfile_close(void)
198 logfile_was_closed = 1;
204 void logfile_reopen(void)
206 if (logfile_was_closed) {
207 logfile_was_closed = 0;
212 static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint)
214 const char *s, *end = buf + len;
215 for (s = buf; s < end; s++) {
217 && *s == '\\' && s[1] == '#'
218 && isdigit(*(uchar*)(s+2))
219 && isdigit(*(uchar*)(s+3))
220 && isdigit(*(uchar*)(s+4)))
222 && ((use_isprint && !isprint(*(uchar*)s))
223 || *(uchar*)s < ' '))) {
224 if (s != buf && fwrite(buf, s - buf, 1, f) != 1)
225 exit_cleanup(RERR_MESSAGEIO);
226 fprintf(f, "\\#%03o", *(uchar*)s);
230 if (buf != end && fwrite(buf, end - buf, 1, f) != 1)
231 exit_cleanup(RERR_MESSAGEIO);
234 /* this is the underlying (unformatted) rsync debugging function. Call
235 * it with FINFO, FERROR or FLOG. Note: recursion can happen with
236 * certain fatal conditions. */
237 void rwrite(enum logcode code, char *buf, int len)
239 int trailing_CR_or_NL;
243 exit_cleanup(RERR_MESSAGEIO);
245 if (am_server && msg_fd_out >= 0) {
246 /* Pass the message to our sibling. */
247 send_msg((enum msgcode)code, buf, len);
251 if (code == FSOCKERR) /* This gets simplified for a non-sibling. */
256 else if (am_daemon || logfile_name) {
259 int priority = code == FERROR ? LOG_WARNING : LOG_INFO;
264 if (!log_initialised)
266 strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
267 logit(priority, msg);
270 if (code == FLOG || (am_daemon && !am_server))
272 } else if (code == FLOG)
275 if (quiet && code != FERROR)
279 /* Pass the message to the non-server side. */
280 if (send_msg((enum msgcode)code, buf, len))
283 /* TODO: can we send the error to the user somehow? */
294 f = am_server ? stderr : stdout;
297 exit_cleanup(RERR_MESSAGEIO);
300 trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
303 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
304 if (ic_chck != (iconv_t)-1) {
306 char *in_buf = buf, *out_buf = convbuf;
307 size_t in_cnt = len, out_cnt = sizeof convbuf - 1;
309 iconv(ic_chck, NULL, 0, NULL, 0);
310 while (iconv(ic_chck, &in_buf,&in_cnt,
311 &out_buf,&out_cnt) == (size_t)-1) {
312 if (out_buf != convbuf) {
313 filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
315 out_cnt = sizeof convbuf - 1;
319 fprintf(f, "\\#%03o", *(uchar*)in_buf++);
322 if (out_buf != convbuf)
323 filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
326 filtered_fwrite(f, buf, len, !allow_8bit_chars);
328 if (trailing_CR_or_NL) {
329 fputc(trailing_CR_or_NL, f);
334 /* This is the rsync debugging function. Call it with FINFO, FERROR or
336 void rprintf(enum logcode code, const char *format, ...)
339 char buf[BIGPATHBUFLEN];
342 va_start(ap, format);
343 len = vsnprintf(buf, sizeof buf, format, ap);
346 /* Deal with buffer overruns. Instead of panicking, just
347 * truncate the resulting string. (Note that configure ensures
348 * that we have a vsnprintf() that doesn't ever return -1.) */
349 if (len > sizeof buf - 1) {
350 static const char ellipsis[] = "[...]";
352 /* Reset length, and zero-terminate the end of our buffer */
353 len = sizeof buf - 1;
356 /* Copy the ellipsis to the end of the string, but give
357 * us one extra character:
359 * v--- null byte at buf[sizeof buf - 1]
361 * -> abcd[...]00 <-- now two null bytes at end
363 * If the input format string has a trailing newline,
364 * we copy it into that extra null; if it doesn't, well,
365 * all we lose is one byte. */
366 memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
367 if (format[strlen(format)-1] == '\n') {
372 rwrite(code, buf, len);
375 /* This is like rprintf, but it also tries to print some
376 * representation of the error code. Normally errcode = errno.
378 * Unlike rprintf, this always adds a newline and there should not be
379 * one in the format string.
381 * Note that since strerror might involve dynamically loading a
382 * message catalog we need to call it once before chroot-ing. */
383 void rsyserr(enum logcode code, int errcode, const char *format, ...)
386 char buf[BIGPATHBUFLEN];
389 strcpy(buf, RSYNC_NAME ": ");
390 len = (sizeof RSYNC_NAME ": ") - 1;
392 va_start(ap, format);
393 len += vsnprintf(buf + len, sizeof buf - len, format, ap);
396 if (len < sizeof buf) {
397 len += snprintf(buf + len, sizeof buf - len,
398 ": %s (%d)\n", strerror(errcode), errcode);
400 if (len >= sizeof buf)
401 exit_cleanup(RERR_MESSAGEIO);
403 rwrite(code, buf, len);
406 void rflush(enum logcode code)
410 if (am_daemon || code == FLOG)
413 if (code == FERROR || am_server)
421 /* A generic logging routine for send/recv, with parameter substitiution. */
422 static void log_formatted(enum logcode code, char *format, char *op,
423 struct file_struct *file, struct stats *initial_stats,
424 int iflags, char *hlink)
426 char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32];
433 /* We expand % codes one by one in place in buf. We don't
434 * copy in the terminating null of the inserted strings, but
435 * rather keep going until we reach the null of the format. */
436 total = strlcpy(buf, format, sizeof buf);
437 if (total > MAXPATHLEN) {
438 rprintf(FERROR, "log-format string is WAY too long!\n");
439 exit_cleanup(RERR_MESSAGEIO);
444 for (p = buf; (p = strchr(p, '%')) != NULL; ) {
449 while (isdigit(*(uchar*)p) && n - fmt < (int)(sizeof fmt) - 8)
466 strlcat(fmt, ".0f", sizeof fmt);
467 snprintf(buf2, sizeof buf2, fmt,
468 (double)file->length);
472 strlcat(fmt, "ld", sizeof fmt);
473 snprintf(buf2, sizeof buf2, fmt,
478 if (file->gid == GID_NONE)
481 strlcat(fmt, "ld", sizeof fmt);
482 snprintf(buf2, sizeof buf2, fmt,
488 strlcat(fmt, "ld", sizeof fmt);
489 snprintf(buf2, sizeof buf2, fmt,
494 n = timestring(file->modtime);
497 while ((cp = strchr(cp, ' ')) != NULL)
502 n = buf2 + MAXPATHLEN - PERMSTRING_SIZE;
503 permstring(n - 1, file->mode); /* skip the type char */
509 n = f_name(file, NULL);
510 if (am_sender && file->dir.root) {
511 pathjoin(buf2, sizeof buf2,
513 clean_fname(buf2, 0);
515 strlcpy(n, buf2, MAXPATHLEN);
520 pathjoin(buf2, sizeof buf2,
521 curr_dir + module_dirlen, n);
522 clean_fname(buf2, 0);
524 strlcpy(n, buf2, MAXPATHLEN);
534 n = f_name(file, NULL);
535 if (S_ISDIR(file->mode))
536 strlcat(n, "/", MAXPATHLEN);
539 if (hlink && *hlink) {
541 strcpy(buf2, " => ");
542 } else if (S_ISLNK(file->mode) && file->u.link) {
544 strcpy(buf2, " -> ");
551 strlcat(fmt, "s", sizeof fmt);
552 snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
556 n = lp_name(module_id);
559 n = timestring(time(NULL));
562 n = lp_path(module_id);
569 b = stats.total_written -
570 initial_stats->total_written;
572 b = stats.total_read -
573 initial_stats->total_read;
575 strlcat(fmt, ".0f", sizeof fmt);
576 snprintf(buf2, sizeof buf2, fmt, (double)b);
581 b = stats.total_written -
582 initial_stats->total_written;
584 b = stats.total_read -
585 initial_stats->total_read;
587 strlcat(fmt, ".0f", sizeof fmt);
588 snprintf(buf2, sizeof buf2, fmt, (double)b);
592 if (iflags & ITEM_DELETED) {
596 n = buf2 + MAXPATHLEN - 32;
597 n[0] = iflags & ITEM_LOCAL_CHANGE
598 ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
599 : !(iflags & ITEM_TRANSFER) ? '.'
600 : !local_server && *op == 's' ? '<' : '>';
601 n[1] = S_ISDIR(file->mode) ? 'd'
602 : IS_SPECIAL(file->mode) ? 'S'
603 : IS_DEVICE(file->mode) ? 'D'
604 : S_ISLNK(file->mode) ? 'L' : 'f';
605 n[2] = !(iflags & ITEM_REPORT_CHECKSUM) ? '.' : 'c';
606 n[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
607 n[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
608 : !preserve_times || S_ISLNK(file->mode) ? 'T' : 't';
609 n[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
610 n[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
611 n[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
615 if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
616 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
618 for (i = 2; n[i]; i++)
620 } else if (n[0] == '.' || n[0] == 'h'
621 || (n[0] == 'c' && n[1] == 'f')) {
623 for (i = 2; n[i]; i++) {
628 for (i = 2; n[i]; i++)
635 /* "n" is the string to be inserted in place of this % code. */
638 if (n != buf2 && fmt[1]) {
639 strlcat(fmt, "s", sizeof fmt);
640 snprintf(buf2, sizeof buf2, fmt, n);
645 /* Subtract the length of the escape from the string's size. */
648 if (len + total >= (size_t)sizeof buf) {
650 "buffer overflow expanding %%%c -- exiting\n",
652 exit_cleanup(RERR_MESSAGEIO);
655 /* Shuffle the rest of the string along to make space for n */
656 if (len != (size_t)(p - s + 1))
657 memmove(s + len, p + 1, total - (s - buf) + 1);
660 /* Insert the contents of string "n", but NOT its null. */
664 /* Skip over inserted string; continue looking */
668 rwrite(code, buf, total);
671 /* Return 1 if the format escape is in the log-format string (e.g. look for
672 * the 'b' in the "%9b" format escape). */
673 int log_format_has(const char *format, char esc)
680 for (p = format; (p = strchr(p, '%')) != NULL; ) {
683 while (isdigit(*(uchar*)p))
693 /* Log the transfer of a file. If the code is FCLIENT, the output just goes
694 * to stdout. If it is FLOG, it just goes to the log file. Otherwise we
696 void log_item(enum logcode code, struct file_struct *file,
697 struct stats *initial_stats, int iflags, char *hlink)
699 char *s_or_r = am_sender ? "send" : "recv";
701 if (code != FLOG && stdout_format && !am_server) {
702 log_formatted(FCLIENT, stdout_format, s_or_r,
703 file, initial_stats, iflags, hlink);
705 if (code != FCLIENT && logfile_format && *logfile_format) {
706 log_formatted(FLOG, logfile_format, s_or_r,
707 file, initial_stats, iflags, hlink);
711 void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
714 int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
715 int see_item = itemizing && (significant_flags || *buf
716 || stdout_format_has_i > 1 || (verbose > 1 && stdout_format_has_i));
717 int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
719 if (logfile_name && !dry_run && see_item
720 && (significant_flags || logfile_format_has_i))
721 log_item(FLOG, file, &stats, iflags, buf);
722 } else if (see_item || local_change || *buf
723 || (S_ISDIR(file->mode) && significant_flags)) {
724 enum logcode code = significant_flags || logfile_format_has_i ? FINFO : FCLIENT;
725 log_item(code, file, &stats, iflags, buf);
729 void log_delete(char *fname, int mode)
731 static struct file_struct file;
732 int len = strlen(fname);
736 file.basename = fname;
738 if (!verbose && !stdout_format)
740 else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
742 len++; /* directories include trailing null */
743 send_msg(MSG_DELETED, fname, len);
745 fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n";
746 log_formatted(FCLIENT, fmt, "del.", &file, &stats,
750 if (!logfile_name || dry_run || !logfile_format)
753 fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n";
754 log_formatted(FLOG, fmt, "del.", &file, &stats, ITEM_DELETED, NULL);
758 * Called when the transfer is interrupted for some reason.
760 * Code is one of the RERR_* codes from errcode.h, or terminating
763 void log_exit(int code, const char *file, int line)
766 rprintf(FLOG,"sent %.0f bytes received %.0f bytes total size %.0f\n",
767 (double)stats.total_written,
768 (double)stats.total_read,
769 (double)stats.total_size);
773 name = rerr_name(code);
775 name = "unexplained error";
777 /* VANISHED is not an error, only a warning */
778 if (code == RERR_VANISHED) {
779 rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
780 name, code, file, line, who_am_i(), RSYNC_VERSION);
782 rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
783 name, code, file, line, who_am_i(), RSYNC_VERSION);