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_o_or_i;
43 extern mode_t orig_umask;
44 extern char *auth_user;
45 extern char *stdout_format;
46 extern char *logfile_format;
47 extern char *logfile_name;
48 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
49 extern iconv_t ic_chck;
52 static int log_initialised;
53 static int logfile_was_closed;
54 static FILE *logfile_fp;
57 int log_got_error = 0;
62 } const rerr_names[] = {
63 { RERR_SYNTAX , "syntax or usage error" },
64 { RERR_PROTOCOL , "protocol incompatibility" },
65 { RERR_FILESELECT , "errors selecting input/output files, dirs" },
66 { RERR_UNSUPPORTED, "requested action not supported" },
67 { RERR_STARTCLIENT, "error starting client-server protocol" },
68 { RERR_SOCKETIO , "error in socket IO" },
69 { RERR_FILEIO , "error in file IO" },
70 { RERR_STREAMIO , "error in rsync protocol data stream" },
71 { RERR_MESSAGEIO , "errors with program diagnostics" },
72 { RERR_IPC , "error in IPC code" },
73 { RERR_CRASHED , "sibling process crashed" },
74 { RERR_TERMINATED , "sibling process terminated abnormally" },
75 { RERR_SIGNAL1 , "received SIGUSR1" },
76 { RERR_SIGNAL , "received SIGINT, SIGTERM, or SIGHUP" },
77 { RERR_WAITCHILD , "waitpid() failed" },
78 { RERR_MALLOC , "error allocating core memory buffers" },
79 { RERR_PARTIAL , "some files could not be transferred" },
80 { RERR_VANISHED , "some files vanished before they could be transferred" },
81 { RERR_TIMEOUT , "timeout in data send/receive" },
82 { RERR_CMD_FAILED , "remote shell failed" },
83 { RERR_CMD_KILLED , "remote shell killed" },
84 { RERR_CMD_RUN , "remote command could not be run" },
85 { RERR_CMD_NOTFOUND,"remote command not found" },
86 { RERR_DEL_LIMIT , "the --max-delete limit stopped deletions" },
92 * Map from rsync error code to name, or return NULL.
94 static char const *rerr_name(int code)
97 for (i = 0; rerr_names[i].name; i++) {
98 if (rerr_names[i].code == code)
99 return rerr_names[i].name;
104 static void logit(int priority, char *buf)
106 if (logfile_was_closed)
109 fprintf(logfile_fp, "%s [%d] %s",
110 timestring(time(NULL)), (int)getpid(), buf);
113 syslog(priority, "%s", buf);
117 static void syslog_init()
119 static int been_here = 0;
120 int options = LOG_PID;
127 options |= LOG_NDELAY;
131 openlog("rsyncd", options, lp_syslog_facility());
133 openlog("rsyncd", options);
137 logit(LOG_INFO, "rsyncd started\n");
141 static void logfile_open(void)
143 mode_t old_umask = umask(022 | orig_umask);
144 logfile_fp = fopen(logfile_name, "a");
147 int fopen_errno = errno;
148 /* Rsync falls back to using syslog on failure. */
150 rsyserr(FERROR, fopen_errno,
151 "failed to open log-file %s", logfile_name);
152 rprintf(FINFO, "Ignoring \"log file\" setting.\n");
162 /* This looks pointless, but it is needed in order for the
163 * C library on some systems to fetch the timezone info
164 * before the chroot. */
165 timestring(time(NULL));
167 /* Optionally use a log file instead of syslog. (Non-daemon
168 * rsyncs will have already set logfile_name, as needed.) */
169 if (am_daemon && !logfile_name)
170 logfile_name = lp_log_file();
171 if (logfile_name && *logfile_name)
177 void logfile_close(void)
180 logfile_was_closed = 1;
186 void logfile_reopen(void)
188 if (logfile_was_closed) {
189 logfile_was_closed = 0;
194 static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint)
196 const char *s, *end = buf + len;
197 for (s = buf; s < end; s++) {
199 && *s == '\\' && s[1] == '#'
200 && isdigit(*(uchar*)(s+2))
201 && isdigit(*(uchar*)(s+3))
202 && isdigit(*(uchar*)(s+4)))
204 && ((use_isprint && !isprint(*(uchar*)s))
205 || *(uchar*)s < ' '))) {
206 if (s != buf && fwrite(buf, s - buf, 1, f) != 1)
207 exit_cleanup(RERR_MESSAGEIO);
208 fprintf(f, "\\#%03o", *(uchar*)s);
212 if (buf != end && fwrite(buf, end - buf, 1, f) != 1)
213 exit_cleanup(RERR_MESSAGEIO);
216 /* this is the underlying (unformatted) rsync debugging function. Call
217 * it with FINFO, FERROR or FLOG. Note: recursion can happen with
218 * certain fatal conditions. */
219 void rwrite(enum logcode code, char *buf, int len)
221 int trailing_CR_or_NL;
225 exit_cleanup(RERR_MESSAGEIO);
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 (code == FNAME) {
241 } else if (am_daemon || logfile_name) {
244 int priority = code == FERROR ? LOG_WARNING : LOG_INFO;
249 if (!log_initialised)
251 strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
252 for (s = msg; *s == '\n' && s[1]; s++) {}
256 if (code == FLOG || (am_daemon && !am_server))
258 } else if (code == FLOG)
261 if (quiet && code != FERROR)
265 /* Pass the message to the non-server side. */
266 if (send_msg((enum msgcode)code, buf, len))
269 /* TODO: can we send the error to the user somehow? */
280 f = am_server ? stderr : stdout;
282 while (len > 1 && *buf == '\n') {
289 f = am_server ? stderr : stdout;
292 exit_cleanup(RERR_MESSAGEIO);
295 trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
298 #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
299 if (ic_chck != (iconv_t)-1) {
301 char *in_buf = buf, *out_buf = convbuf;
302 size_t in_cnt = len, out_cnt = sizeof convbuf - 1;
304 iconv(ic_chck, NULL, 0, NULL, 0);
305 while (iconv(ic_chck, &in_buf,&in_cnt,
306 &out_buf,&out_cnt) == (size_t)-1) {
307 if (out_buf != convbuf) {
308 filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
310 out_cnt = sizeof convbuf - 1;
314 fprintf(f, "\\#%03o", *(uchar*)in_buf++);
317 if (out_buf != convbuf)
318 filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
321 filtered_fwrite(f, buf, len, !allow_8bit_chars);
323 if (trailing_CR_or_NL) {
324 fputc(trailing_CR_or_NL, f);
329 /* This is the rsync debugging function. Call it with FINFO, FERROR or
331 void rprintf(enum logcode code, const char *format, ...)
334 char buf[BIGPATHBUFLEN];
337 va_start(ap, format);
338 len = vsnprintf(buf, sizeof buf, format, ap);
341 /* Deal with buffer overruns. Instead of panicking, just
342 * truncate the resulting string. (Note that configure ensures
343 * that we have a vsnprintf() that doesn't ever return -1.) */
344 if (len > sizeof buf - 1) {
345 static const char ellipsis[] = "[...]";
347 /* Reset length, and zero-terminate the end of our buffer */
348 len = sizeof buf - 1;
351 /* Copy the ellipsis to the end of the string, but give
352 * us one extra character:
354 * v--- null byte at buf[sizeof buf - 1]
356 * -> abcd[...]00 <-- now two null bytes at end
358 * If the input format string has a trailing newline,
359 * we copy it into that extra null; if it doesn't, well,
360 * all we lose is one byte. */
361 memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
362 if (format[strlen(format)-1] == '\n') {
367 rwrite(code, buf, len);
370 /* This is like rprintf, but it also tries to print some
371 * representation of the error code. Normally errcode = errno.
373 * Unlike rprintf, this always adds a newline and there should not be
374 * one in the format string.
376 * Note that since strerror might involve dynamically loading a
377 * message catalog we need to call it once before chroot-ing. */
378 void rsyserr(enum logcode code, int errcode, const char *format, ...)
381 char buf[BIGPATHBUFLEN];
384 strcpy(buf, RSYNC_NAME ": ");
385 len = (sizeof RSYNC_NAME ": ") - 1;
387 va_start(ap, format);
388 len += vsnprintf(buf + len, sizeof buf - len, format, ap);
391 if (len < sizeof buf) {
392 len += snprintf(buf + len, sizeof buf - len,
393 ": %s (%d)\n", strerror(errcode), errcode);
395 if (len >= sizeof buf)
396 exit_cleanup(RERR_MESSAGEIO);
398 rwrite(code, buf, len);
401 void rflush(enum logcode code)
405 if (am_daemon || code == FLOG)
408 if (code == FERROR || am_server)
416 /* A generic logging routine for send/recv, with parameter substitiution. */
417 static void log_formatted(enum logcode code, char *format, char *op,
418 struct file_struct *file, struct stats *initial_stats,
419 int iflags, char *hlink)
421 char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32];
428 /* We expand % codes one by one in place in buf. We don't
429 * copy in the terminating null of the inserted strings, but
430 * rather keep going until we reach the null of the format. */
431 total = strlcpy(buf, format, sizeof buf);
432 if (total > MAXPATHLEN) {
433 rprintf(FERROR, "log-format string is WAY too long!\n");
434 exit_cleanup(RERR_MESSAGEIO);
439 for (p = buf; (p = strchr(p, '%')) != NULL; ) {
444 while (isdigit(*(uchar*)p) && n - fmt < (int)(sizeof fmt) - 8)
461 strlcat(fmt, ".0f", sizeof fmt);
462 snprintf(buf2, sizeof buf2, fmt,
463 (double)file->length);
467 strlcat(fmt, "ld", sizeof fmt);
468 snprintf(buf2, sizeof buf2, fmt,
473 if (file->gid == GID_NONE)
476 strlcat(fmt, "ld", sizeof fmt);
477 snprintf(buf2, sizeof buf2, fmt,
483 strlcat(fmt, "ld", sizeof fmt);
484 snprintf(buf2, sizeof buf2, fmt,
489 n = timestring(file->modtime);
492 while ((cp = strchr(cp, ' ')) != NULL)
497 n = buf2 + MAXPATHLEN - PERMSTRING_SIZE;
498 permstring(n - 1, file->mode); /* skip the type char */
504 n = f_name(file, NULL);
505 if (am_sender && file->dir.root) {
506 pathjoin(buf2, sizeof buf2,
508 clean_fname(buf2, 0);
510 strlcpy(n, buf2, MAXPATHLEN);
519 n = f_name(file, NULL);
520 if (S_ISDIR(file->mode))
521 strlcat(n, "/", MAXPATHLEN);
524 if (hlink && *hlink) {
526 strcpy(buf2, " => ");
527 } else if (S_ISLNK(file->mode) && file->u.link) {
529 strcpy(buf2, " -> ");
536 strlcat(fmt, "s", sizeof fmt);
537 snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
541 n = lp_name(module_id);
544 n = timestring(time(NULL));
547 n = lp_path(module_id);
554 b = stats.total_written -
555 initial_stats->total_written;
557 b = stats.total_read -
558 initial_stats->total_read;
560 strlcat(fmt, ".0f", sizeof fmt);
561 snprintf(buf2, sizeof buf2, fmt, (double)b);
566 b = stats.total_written -
567 initial_stats->total_written;
569 b = stats.total_read -
570 initial_stats->total_read;
572 strlcat(fmt, ".0f", sizeof fmt);
573 snprintf(buf2, sizeof buf2, fmt, (double)b);
577 if (iflags & ITEM_DELETED) {
581 n = buf2 + MAXPATHLEN - 32;
582 n[0] = iflags & ITEM_LOCAL_CHANGE
583 ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
584 : !(iflags & ITEM_TRANSFER) ? '.'
585 : !local_server && *op == 's' ? '<' : '>';
586 n[1] = S_ISDIR(file->mode) ? 'd'
587 : IS_SPECIAL(file->mode) ? 'S'
588 : IS_DEVICE(file->mode) ? 'D'
589 : S_ISLNK(file->mode) ? 'L' : 'f';
590 n[2] = !(iflags & ITEM_REPORT_CHECKSUM) ? '.' : 'c';
591 n[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
592 n[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
593 : !preserve_times || S_ISLNK(file->mode) ? 'T' : 't';
594 n[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
595 n[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
596 n[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
600 if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
601 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
603 for (i = 2; n[i]; i++)
605 } else if (n[0] == '.' || n[0] == 'h'
606 || (n[0] == 'c' && n[1] == 'f')) {
608 for (i = 2; n[i]; i++) {
613 for (i = 2; n[i]; i++)
620 /* "n" is the string to be inserted in place of this % code. */
623 if (n != buf2 && fmt[1]) {
624 strlcat(fmt, "s", sizeof fmt);
625 snprintf(buf2, sizeof buf2, fmt, n);
630 /* Subtract the length of the escape from the string's size. */
633 if (len + total >= (size_t)sizeof buf) {
635 "buffer overflow expanding %%%c -- exiting\n",
637 exit_cleanup(RERR_MESSAGEIO);
640 /* Shuffle the rest of the string along to make space for n */
641 if (len != (size_t)(p - s + 1))
642 memmove(s + len, p + 1, total - (s - buf) + 1);
645 /* Insert the contents of string "n", but NOT its null. */
649 /* Skip over inserted string; continue looking */
653 rwrite(code, buf, total);
656 /* Return 1 if the format escape is in the log-format string (e.g. look for
657 * the 'b' in the "%9b" format escape). */
658 int log_format_has(const char *format, char esc)
665 for (p = format; (p = strchr(p, '%')) != NULL; ) {
668 while (isdigit(*(uchar*)p))
678 /* Log the transfer of a file. If the code is FNAME, the output just goes
679 * to stdout. If it is FLOG, it just goes to the log file. Otherwise we
681 void log_item(enum logcode code, struct file_struct *file,
682 struct stats *initial_stats, int iflags, char *hlink)
684 char *s_or_r = am_sender ? "send" : "recv";
686 if (code != FLOG && stdout_format && !am_server) {
687 log_formatted(FNAME, stdout_format, s_or_r,
688 file, initial_stats, iflags, hlink);
690 if (code != FNAME && logfile_format && *logfile_format) {
691 log_formatted(FLOG, logfile_format, s_or_r,
692 file, initial_stats, iflags, hlink);
696 void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
699 int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
700 int see_item = itemizing && (significant_flags || *buf
701 || stdout_format_has_i > 1 || (verbose > 1 && stdout_format_has_i));
702 int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
704 if (logfile_name && !dry_run && see_item)
705 log_item(FLOG, file, &stats, iflags, buf);
706 } else if (see_item || local_change || *buf
707 || (S_ISDIR(file->mode) && significant_flags))
708 log_item(FINFO, file, &stats, iflags, buf);
711 void log_delete(char *fname, int mode)
713 static struct file_struct file;
714 int len = strlen(fname);
718 file.basename = fname;
720 if (!verbose && !stdout_format)
722 else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
724 len++; /* directories include trailing null */
725 send_msg(MSG_DELETED, fname, len);
727 fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n";
728 log_formatted(FCLIENT, fmt, "del.", &file, &stats,
732 if (!logfile_name || dry_run || !logfile_format)
735 fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n";
736 log_formatted(FLOG, fmt, "del.", &file, &stats, ITEM_DELETED, NULL);
740 * Called when the transfer is interrupted for some reason.
742 * Code is one of the RERR_* codes from errcode.h, or terminating
745 void log_exit(int code, const char *file, int line)
748 rprintf(FLOG,"sent %.0f bytes received %.0f bytes total size %.0f\n",
749 (double)stats.total_written,
750 (double)stats.total_read,
751 (double)stats.total_size);
755 name = rerr_name(code);
757 name = "unexplained error";
759 /* VANISHED is not an error, only a warning */
760 if (code == RERR_VANISHED) {
761 rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
762 name, code, file, line, who_am_i(), RSYNC_VERSION);
764 rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
765 name, code, file, line, who_am_i(), RSYNC_VERSION);