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-2008 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 3 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, visit the http://fsf.org website.
30 extern int am_generator;
31 extern int local_server;
34 extern int msg_fd_out;
35 extern int checksum_len;
36 extern int allow_8bit_chars;
37 extern int protocol_version;
38 extern int always_checksum;
39 extern int preserve_times;
40 extern int msgs2stderr;
43 extern int stdout_format_has_i;
44 extern int stdout_format_has_o_or_i;
45 extern int logfile_format_has_i;
46 extern int logfile_format_has_o_or_i;
47 extern int receiver_symlink_times;
48 extern mode_t orig_umask;
49 extern char *auth_user;
50 extern char *stdout_format;
51 extern char *logfile_format;
52 extern char *logfile_name;
54 extern iconv_t ic_chck;
57 extern iconv_t ic_recv;
59 extern char curr_dir[MAXPATHLEN];
60 extern char *full_module_path;
61 extern unsigned int module_dirlen;
62 extern char sender_file_sum[MAX_DIGEST_LEN];
64 static int log_initialised;
65 static int logfile_was_closed;
66 static FILE *logfile_fp;
69 int got_xfer_error = 0;
70 int output_needs_newline = 0;
75 } const rerr_names[] = {
76 { RERR_SYNTAX , "syntax or usage error" },
77 { RERR_PROTOCOL , "protocol incompatibility" },
78 { RERR_FILESELECT , "errors selecting input/output files, dirs" },
79 { RERR_UNSUPPORTED, "requested action not supported" },
80 { RERR_STARTCLIENT, "error starting client-server protocol" },
81 { RERR_SOCKETIO , "error in socket IO" },
82 { RERR_FILEIO , "error in file IO" },
83 { RERR_STREAMIO , "error in rsync protocol data stream" },
84 { RERR_MESSAGEIO , "errors with program diagnostics" },
85 { RERR_IPC , "error in IPC code" },
86 { RERR_CRASHED , "sibling process crashed" },
87 { RERR_TERMINATED , "sibling process terminated abnormally" },
88 { RERR_SIGNAL1 , "received SIGUSR1" },
89 { RERR_SIGNAL , "received SIGINT, SIGTERM, or SIGHUP" },
90 { RERR_WAITCHILD , "waitpid() failed" },
91 { RERR_MALLOC , "error allocating core memory buffers" },
92 { RERR_PARTIAL , "some files/attrs were not transferred (see previous errors)" },
93 { RERR_VANISHED , "some files vanished before they could be transferred" },
94 { RERR_TIMEOUT , "timeout in data send/receive" },
95 { RERR_CONTIMEOUT , "timeout waiting for daemon connection" },
96 { RERR_CMD_FAILED , "remote shell failed" },
97 { RERR_CMD_KILLED , "remote shell killed" },
98 { RERR_CMD_RUN , "remote command could not be run" },
99 { RERR_CMD_NOTFOUND,"remote command not found" },
100 { RERR_DEL_LIMIT , "the --max-delete limit stopped deletions" },
105 * Map from rsync error code to name, or return NULL.
107 static char const *rerr_name(int code)
110 for (i = 0; rerr_names[i].name; i++) {
111 if (rerr_names[i].code == code)
112 return rerr_names[i].name;
117 static void logit(int priority, const char *buf)
119 if (logfile_was_closed)
122 fprintf(logfile_fp, "%s [%d] %s",
123 timestring(time(NULL)), (int)getpid(), buf);
126 syslog(priority, "%s", buf);
130 static void syslog_init()
132 static int been_here = 0;
133 int options = LOG_PID;
140 options |= LOG_NDELAY;
144 openlog("rsyncd", options, lp_syslog_facility(module_id));
146 openlog("rsyncd", options);
150 logit(LOG_INFO, "rsyncd started\n");
154 static void logfile_open(void)
156 mode_t old_umask = umask(022 | orig_umask);
157 logfile_fp = fopen(logfile_name, "a");
160 int fopen_errno = errno;
161 /* Rsync falls back to using syslog on failure. */
163 rsyserr(FERROR, fopen_errno,
164 "failed to open log-file %s", logfile_name);
165 rprintf(FINFO, "Ignoring \"log file\" setting.\n");
169 void log_init(int restart)
171 if (log_initialised) {
174 if (strcmp(logfile_name, lp_log_file(module_id)) != 0) {
181 } else if (*logfile_name)
182 return; /* unchanged, non-empty "log file" names */
183 else if (lp_syslog_facility(-1) != lp_syslog_facility(module_id))
186 return; /* unchanged syslog settings */
190 /* This looks pointless, but it is needed in order for the
191 * C library on some systems to fetch the timezone info
192 * before the chroot. */
193 timestring(time(NULL));
195 /* Optionally use a log file instead of syslog. (Non-daemon
196 * rsyncs will have already set logfile_name, as needed.) */
197 if (am_daemon && !logfile_name)
198 logfile_name = lp_log_file(module_id);
199 if (logfile_name && *logfile_name)
205 void logfile_close(void)
208 logfile_was_closed = 1;
214 void logfile_reopen(void)
216 if (logfile_was_closed) {
217 logfile_was_closed = 0;
222 static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint)
224 const char *s, *end = buf + len;
225 for (s = buf; s < end; s++) {
227 && *s == '\\' && s[1] == '#'
232 && ((use_isprint && !isPrint(s))
233 || *(uchar*)s < ' '))) {
234 if (s != buf && fwrite(buf, s - buf, 1, f) != 1)
235 exit_cleanup(RERR_MESSAGEIO);
236 fprintf(f, "\\#%03o", *(uchar*)s);
240 if (buf != end && fwrite(buf, end - buf, 1, f) != 1)
241 exit_cleanup(RERR_MESSAGEIO);
244 /* this is the underlying (unformatted) rsync debugging function. Call
245 * it with FINFO, FERROR_*, FWARNING, FLOG, or FCLIENT. Note: recursion
246 * can happen with certain fatal conditions. */
247 void rwrite(enum logcode code, const char *buf, int len, int is_utf8)
249 int trailing_CR_or_NL;
250 FILE *f = msgs2stderr ? stderr : stdout;
252 iconv_t ic = is_utf8 && ic_recv != (iconv_t)-1 ? ic_recv : ic_chck;
255 iconv_t ic = ic_chck;
260 exit_cleanup(RERR_MESSAGEIO);
262 if (msgs2stderr && code != FLOG)
265 if (am_server && msg_fd_out >= 0) {
267 /* Pass the message to our sibling in native charset. */
268 send_msg((enum msgcode)code, buf, len, 0);
272 if (code == FERROR_SOCKET) /* This gets simplified for a non-sibling. */
274 else if (code == FERROR_UTF8) {
281 else if (am_daemon || logfile_name) {
284 int priority = code == FINFO || code == FLOG ? LOG_INFO : LOG_WARNING;
289 if (!log_initialised)
291 strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
292 logit(priority, msg);
295 if (code == FLOG || (am_daemon && !am_server))
297 } else if (code == FLOG)
300 if (quiet && code == FINFO)
304 enum msgcode msg = (enum msgcode)code;
305 if (protocol_version < 30) {
306 if (msg == MSG_ERROR)
307 msg = MSG_ERROR_XFER;
308 else if (msg == MSG_WARNING)
311 /* Pass the message to the non-server side. */
312 if (send_msg(msg, buf, len, !is_utf8))
315 /* TODO: can we send the error to the user somehow? */
334 exit_cleanup(RERR_MESSAGEIO);
337 if (output_needs_newline) {
339 output_needs_newline = 0;
342 trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
345 if (len && buf[0] == '\r') {
352 if (ic != (iconv_t)-1) {
357 INIT_CONST_XBUF(outbuf, convbuf);
358 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
361 iconvbufs(ic, &inbuf, &outbuf, 0);
364 filtered_fwrite(f, convbuf, outbuf.len, 0);
367 if (!ierrno || ierrno == E2BIG)
369 fprintf(f, "\\#%03o", CVAL(inbuf.buf, inbuf.pos++));
374 filtered_fwrite(f, buf, len, !allow_8bit_chars);
376 if (trailing_CR_or_NL) {
377 fputc(trailing_CR_or_NL, f);
382 /* This is the rsync debugging function. Call it with FINFO, FERROR_*,
383 * FWARNING, FLOG, or FCLIENT. */
384 void rprintf(enum logcode code, const char *format, ...)
387 char buf[BIGPATHBUFLEN];
390 va_start(ap, format);
391 len = vsnprintf(buf, sizeof buf, format, ap);
394 /* Deal with buffer overruns. Instead of panicking, just
395 * truncate the resulting string. (Note that configure ensures
396 * that we have a vsnprintf() that doesn't ever return -1.) */
397 if (len > sizeof buf - 1) {
398 static const char ellipsis[] = "[...]";
400 /* Reset length, and zero-terminate the end of our buffer */
401 len = sizeof buf - 1;
404 /* Copy the ellipsis to the end of the string, but give
405 * us one extra character:
407 * v--- null byte at buf[sizeof buf - 1]
409 * -> abcd[...]00 <-- now two null bytes at end
411 * If the input format string has a trailing newline,
412 * we copy it into that extra null; if it doesn't, well,
413 * all we lose is one byte. */
414 memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
415 if (format[strlen(format)-1] == '\n') {
420 rwrite(code, buf, len, 0);
423 /* This is like rprintf, but it also tries to print some
424 * representation of the error code. Normally errcode = errno.
426 * Unlike rprintf, this always adds a newline and there should not be
427 * one in the format string.
429 * Note that since strerror might involve dynamically loading a
430 * message catalog we need to call it once before chroot-ing. */
431 void rsyserr(enum logcode code, int errcode, const char *format, ...)
434 char buf[BIGPATHBUFLEN];
437 strlcpy(buf, RSYNC_NAME ": ", sizeof buf);
438 len = (sizeof RSYNC_NAME ": ") - 1;
440 va_start(ap, format);
441 len += vsnprintf(buf + len, sizeof buf - len, format, ap);
444 if (len < sizeof buf) {
445 len += snprintf(buf + len, sizeof buf - len,
446 ": %s (%d)\n", strerror(errcode), errcode);
448 if (len >= sizeof buf)
449 exit_cleanup(RERR_MESSAGEIO);
451 rwrite(code, buf, len, 0);
454 void rflush(enum logcode code)
458 if (am_daemon || code == FLOG)
461 if (!am_server && (code == FINFO || code == FCLIENT))
469 /* A generic logging routine for send/recv, with parameter substitiution. */
470 static void log_formatted(enum logcode code, const char *format, const char *op,
471 struct file_struct *file, const char *fname,
472 struct stats *initial_stats, int iflags,
475 char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32];
483 /* We expand % codes one by one in place in buf. We don't
484 * copy in the terminating null of the inserted strings, but
485 * rather keep going until we reach the null of the format. */
486 total = strlcpy(buf, format, sizeof buf);
487 if (total > MAXPATHLEN) {
488 rprintf(FERROR, "log-format string is WAY too long!\n");
489 exit_cleanup(RERR_MESSAGEIO);
494 for (p = buf; (p = strchr(p, '%')) != NULL; ) {
499 while (isDigit(p) && c - fmt < (int)(sizeof fmt) - 8)
516 strlcat(fmt, "s", sizeof fmt);
517 snprintf(buf2, sizeof buf2, fmt,
518 comma_num(F_LENGTH(file)));
522 strlcat(fmt, "u", sizeof fmt);
523 snprintf(buf2, sizeof buf2, fmt,
524 uid_ndx ? F_OWNER(file) : 0);
528 if (!gid_ndx || file->flags & FLAG_SKIP_GROUP)
531 strlcat(fmt, "u", sizeof fmt);
532 snprintf(buf2, sizeof buf2, fmt,
538 strlcat(fmt, "ld", sizeof fmt);
539 snprintf(buf2, sizeof buf2, fmt,
544 n = c = timestring(file->modtime);
545 while ((c = strchr(c, ' ')) != NULL)
549 c = buf2 + MAXPATHLEN - PERMSTRING_SIZE - 1;
550 permstring(c, file->mode);
551 n = c + 1; /* skip the type char */
559 strlcpy(c, fname, MAXPATHLEN);
561 c = f_name(file, NULL);
562 if (am_sender && F_PATHNAME(file)) {
563 pathjoin(buf2, sizeof buf2,
564 F_PATHNAME(file), c);
565 clean_fname(buf2, 0);
567 strlcpy(c, buf2, MAXPATHLEN);
571 } else if (am_daemon && *c != '/') {
572 pathjoin(buf2, sizeof buf2,
573 curr_dir + module_dirlen, c);
574 clean_fname(buf2, 0);
576 strlcpy(c, buf2, MAXPATHLEN);
590 strlcpy(c, fname, MAXPATHLEN);
592 c = f_name(file, NULL);
593 if (S_ISDIR(file->mode))
594 strlcat(c, "/", MAXPATHLEN);
598 if (hlink && *hlink) {
600 strlcpy(buf2, " => ", sizeof buf2);
601 } else if (S_ISLNK(file->mode) && !fname) {
603 strlcpy(buf2, " -> ", sizeof buf2);
608 strlcpy(buf2, " ", sizeof buf2);
610 strlcat(fmt, "s", sizeof fmt);
611 snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
615 n = lp_name(module_id);
618 n = timestring(time(NULL));
621 n = full_module_path;
628 b = stats.total_written -
629 initial_stats->total_written;
631 b = stats.total_read -
632 initial_stats->total_read;
634 strlcat(fmt, "s", sizeof fmt);
635 snprintf(buf2, sizeof buf2, fmt, comma_num(b));
640 b = stats.total_written -
641 initial_stats->total_written;
643 b = stats.total_read -
644 initial_stats->total_read;
646 strlcat(fmt, "s", sizeof fmt);
647 snprintf(buf2, sizeof buf2, fmt, comma_num(b));
651 if (protocol_version >= 30
652 && (iflags & ITEM_TRANSFER
653 || (always_checksum && S_ISREG(file->mode)))) {
655 const char *sum = iflags & ITEM_TRANSFER
656 ? sender_file_sum : F_SUM(file);
657 c = buf2 + checksum_len*2;
659 for (i = checksum_len; --i >= 0; ) {
663 *--c = x1 <= 9 ? x1 + '0' : x1 + 'a' - 10;
664 *--c = x2 <= 9 ? x2 + '0' : x2 + 'a' - 10;
667 memset(buf2, ' ', checksum_len*2);
668 buf2[checksum_len*2] = '\0';
673 if (iflags & ITEM_DELETED) {
677 n = c = buf2 + MAXPATHLEN - 32;
678 c[0] = iflags & ITEM_LOCAL_CHANGE
679 ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
680 : !(iflags & ITEM_TRANSFER) ? '.'
681 : !local_server && *op == 's' ? '<' : '>';
682 if (S_ISLNK(file->mode)) {
685 c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
686 : !preserve_times || !receiver_symlink_times
687 || (iflags & ITEM_REPORT_TIMEFAIL) ? 'T' : 't';
689 c[1] = S_ISDIR(file->mode) ? 'd'
690 : IS_SPECIAL(file->mode) ? 'S'
691 : IS_DEVICE(file->mode) ? 'D' : 'f';
692 c[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
693 c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
694 : !preserve_times ? 'T' : 't';
696 c[2] = !(iflags & ITEM_REPORT_CHANGE) ? '.' : 'c';
697 c[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
698 c[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
699 c[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
700 c[8] = !(iflags & ITEM_REPORT_ATIME) ? '.' : 'u';
701 c[9] = !(iflags & ITEM_REPORT_ACL) ? '.' : 'a';
702 c[10] = !(iflags & ITEM_REPORT_XATTR) ? '.' : 'x';
705 if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
706 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
708 for (i = 2; c[i]; i++)
710 } else if (c[0] == '.' || c[0] == 'h' || c[0] == 'c') {
712 for (i = 2; c[i]; i++) {
717 for (i = 2; c[i]; i++)
724 /* "n" is the string to be inserted in place of this % code. */
727 if (n != buf2 && fmt[1]) {
728 strlcat(fmt, "s", sizeof fmt);
729 snprintf(buf2, sizeof buf2, fmt, n);
734 /* Subtract the length of the escape from the string's size. */
737 if (len + total >= (size_t)sizeof buf) {
739 "buffer overflow expanding %%%c -- exiting\n",
741 exit_cleanup(RERR_MESSAGEIO);
744 /* Shuffle the rest of the string along to make space for n */
745 if (len != (size_t)(p - s + 1))
746 memmove(s + len, p + 1, total - (s - buf) + 1);
749 /* Insert the contents of string "n", but NOT its null. */
753 /* Skip over inserted string; continue looking */
757 rwrite(code, buf, total, 0);
760 /* Return 1 if the format escape is in the log-format string (e.g. look for
761 * the 'b' in the "%9b" format escape). */
762 int log_format_has(const char *format, char esc)
769 for (p = format; (p = strchr(p, '%')) != NULL; ) {
782 /* Log the transfer of a file. If the code is FCLIENT, the output just goes
783 * to stdout. If it is FLOG, it just goes to the log file. Otherwise we
785 void log_item(enum logcode code, struct file_struct *file,
786 struct stats *initial_stats, int iflags, const char *hlink)
788 const char *s_or_r = am_sender ? "send" : "recv";
790 if (code != FLOG && stdout_format && !am_server) {
791 log_formatted(FCLIENT, stdout_format, s_or_r,
792 file, NULL, initial_stats, iflags, hlink);
794 if (code != FCLIENT && logfile_format && *logfile_format) {
795 log_formatted(FLOG, logfile_format, s_or_r,
796 file, NULL, initial_stats, iflags, hlink);
800 void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
803 int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
804 int see_item = itemizing && (significant_flags || *buf
805 || stdout_format_has_i > 1 || (INFO_GTE(NAME, 2) && stdout_format_has_i));
806 int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
808 if (logfile_name && !dry_run && see_item
809 && (significant_flags || logfile_format_has_i))
810 log_item(FLOG, file, &stats, iflags, buf);
811 } else if (see_item || local_change || *buf
812 || (S_ISDIR(file->mode) && significant_flags)) {
813 enum logcode code = significant_flags || logfile_format_has_i ? FINFO : FCLIENT;
814 log_item(code, file, &stats, iflags, buf);
818 void log_delete(const char *fname, int mode)
821 union file_extras ex[4]; /* just in case... */
822 struct file_struct file;
824 int len = strlen(fname);
829 if (!INFO_GTE(DEL, 1) && !stdout_format)
831 else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
833 len++; /* directories include trailing null */
834 send_msg(MSG_DELETED, fname, len, am_generator);
836 fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n";
837 log_formatted(FCLIENT, fmt, "del.", &x.file, fname, &stats,
841 if (!logfile_name || dry_run || !logfile_format)
844 fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n";
845 log_formatted(FLOG, fmt, "del.", &x.file, fname, &stats, ITEM_DELETED, NULL);
849 * Called when the transfer is interrupted for some reason.
851 * Code is one of the RERR_* codes from errcode.h, or terminating
854 void log_exit(int code, const char *file, int line)
857 rprintf(FLOG,"sent %s bytes received %s bytes total size %s\n",
858 comma_num(stats.total_written),
859 comma_num(stats.total_read),
860 comma_num(stats.total_size));
861 } else if (am_server != 2) {
864 name = rerr_name(code);
866 name = "unexplained error";
868 /* VANISHED is not an error, only a warning */
869 if (code == RERR_VANISHED) {
870 rprintf(FWARNING, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
871 name, code, file, line, who_am_i(), RSYNC_VERSION);
873 rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
874 name, code, file, line, who_am_i(), RSYNC_VERSION);