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.
37 extern int msg_fd_out;
38 extern int protocol_version;
39 extern int preserve_times;
40 extern int log_format_has_o_or_i;
41 extern int daemon_log_format_has_o_or_i;
42 extern char *auth_user;
43 extern char *log_format;
45 static int log_initialised;
46 static char *logfname;
50 int log_got_error = 0;
55 } const rerr_names[] = {
56 { RERR_SYNTAX , "syntax or usage error" },
57 { RERR_PROTOCOL , "protocol incompatibility" },
58 { RERR_FILESELECT , "errors selecting input/output files, dirs" },
59 { RERR_UNSUPPORTED, "requested action not supported" },
60 { RERR_STARTCLIENT, "error starting client-server protocol" },
61 { RERR_SOCKETIO , "error in socket IO" },
62 { RERR_FILEIO , "error in file IO" },
63 { RERR_STREAMIO , "error in rsync protocol data stream" },
64 { RERR_MESSAGEIO , "errors with program diagnostics" },
65 { RERR_IPC , "error in IPC code" },
66 { RERR_SIGNAL , "received SIGUSR1 or SIGINT" },
67 { RERR_WAITCHILD , "some error returned by waitpid()" },
68 { RERR_MALLOC , "error allocating core memory buffers" },
69 { RERR_PARTIAL , "some files could not be transferred" },
70 { RERR_VANISHED , "some files vanished before they could be transferred" },
71 { RERR_TIMEOUT , "timeout in data send/receive" },
72 { RERR_CMD_FAILED , "remote shell failed" },
73 { RERR_CMD_KILLED , "remote shell killed" },
74 { RERR_CMD_RUN, "remote command could not be run" },
75 { RERR_CMD_NOTFOUND, "remote command not found" },
82 * Map from rsync error code to name, or return NULL.
84 static char const *rerr_name(int code)
87 for (i = 0; rerr_names[i].name; i++) {
88 if (rerr_names[i].code == code)
89 return rerr_names[i].name;
95 static void logit(int priority, char *buf)
100 fprintf(logfile,"%s [%d] %s",
101 timestring(time(NULL)), (int)getpid(), buf);
104 syslog(priority, "%s", buf);
110 int options = LOG_PID;
117 /* this looks pointless, but it is needed in order for the
118 * C library on some systems to fetch the timezone info
119 * before the chroot */
123 /* optionally use a log file instead of syslog */
124 logfname = lp_log_file();
134 options |= LOG_NDELAY;
138 openlog("rsyncd", options, lp_syslog_facility());
140 openlog("rsyncd", options);
144 logit(LOG_INFO,"rsyncd started\n");
150 if (logfname && !logfile) {
151 extern int orig_umask;
152 int old_umask = umask(022 | orig_umask);
153 logfile = fopen(logfname, "a");
156 am_daemon = 0; /* avoid trying to log again */
157 rsyserr(FERROR, errno, "fopen() of log-file failed");
158 exit_cleanup(RERR_FILESELECT);
171 /* this is the underlying (unformatted) rsync debugging function. Call
172 * it with FINFO, FERROR or FLOG */
173 void rwrite(enum logcode code, char *buf, int len)
176 /* recursion can happen with certain fatal conditions */
178 if (quiet && code == FINFO)
182 exit_cleanup(RERR_MESSAGEIO);
186 if (am_server && msg_fd_out >= 0) {
187 /* Pass the message to our sibling. */
188 send_msg((enum msgcode)code, buf, len);
194 else if (am_daemon) {
197 int priority = code == FERROR ? LOG_WARNING : LOG_INFO;
202 if (!log_initialised)
204 strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
205 logit(priority, msg);
208 if (code == FLOG || !am_server)
210 } else if (code == FLOG)
214 /* Pass the message to the non-server side. */
215 if (io_multiplex_write((enum msgcode)code, buf, len))
218 /* TODO: can we send the error to the user somehow? */
223 if (code == FERROR) {
229 f = am_server ? stderr : stdout;
232 exit_cleanup(RERR_MESSAGEIO);
234 if (fwrite(buf, len, 1, f) != 1)
235 exit_cleanup(RERR_MESSAGEIO);
237 if (buf[len-1] == '\r' || buf[len-1] == '\n')
242 /* This is the rsync debugging function. Call it with FINFO, FERROR or
244 void rprintf(enum logcode code, const char *format, ...)
247 char buf[MAXPATHLEN+512];
250 va_start(ap, format);
251 len = vsnprintf(buf, sizeof buf, format, ap);
254 /* Deal with buffer overruns. Instead of panicking, just
255 * truncate the resulting string. (Note that configure ensures
256 * that we have a vsnprintf() that doesn't ever return -1.) */
257 if (len > sizeof buf - 1) {
258 const char ellipsis[] = "[...]";
260 /* Reset length, and zero-terminate the end of our buffer */
261 len = sizeof buf - 1;
264 /* Copy the ellipsis to the end of the string, but give
265 * us one extra character:
267 * v--- null byte at buf[sizeof buf - 1]
269 * -> abcd[...]00 <-- now two null bytes at end
271 * If the input format string has a trailing newline,
272 * we copy it into that extra null; if it doesn't, well,
273 * all we lose is one byte. */
274 strncpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
275 if (format[strlen(format)-1] == '\n') {
280 rwrite(code, buf, len);
284 /* This is like rprintf, but it also tries to print some
285 * representation of the error code. Normally errcode = errno.
287 * Unlike rprintf, this always adds a newline and there should not be
288 * one in the format string.
290 * Note that since strerror might involve dynamically loading a
291 * message catalog we need to call it once before chroot-ing. */
292 void rsyserr(enum logcode code, int errcode, const char *format, ...)
295 char buf[MAXPATHLEN+512];
298 strcpy(buf, RSYNC_NAME ": ");
299 len = (sizeof RSYNC_NAME ": ") - 1;
301 va_start(ap, format);
302 len += vsnprintf(buf + len, sizeof buf - len, format, ap);
305 if (len < sizeof buf) {
306 len += snprintf(buf + len, sizeof buf - len,
307 ": %s (%d)\n", strerror(errcode), errcode);
309 if (len >= sizeof buf)
310 exit_cleanup(RERR_MESSAGEIO);
312 rwrite(code, buf, len);
317 void rflush(enum logcode code)
329 if (code == FERROR) {
340 if (!f) exit_cleanup(RERR_MESSAGEIO);
346 /* a generic logging routine for send/recv, with parameter
348 static void log_formatted(enum logcode code,
349 char *format, char *op, struct file_struct *file,
350 struct stats *initial_stats, int iflags)
352 char buf[MAXPATHLEN+1024];
353 char buf2[MAXPATHLEN];
358 /* We expand % codes one by one in place in buf. We don't
359 * copy in the terminating nul of the inserted strings, but
360 * rather keep going until we reach the nul of the format. */
361 total = strlcpy(buf, format, sizeof buf);
363 for (p = buf; (p = strchr(p, '%')) != NULL && p[1]; ) {
367 case 'h': if (am_daemon) n = client_name(0); break;
368 case 'a': if (am_daemon) n = client_addr(0); break;
370 snprintf(buf2, sizeof buf2, "%.0f",
371 (double)file->length);
375 snprintf(buf2, sizeof buf2, "%d",
379 case 'o': n = op; break;
381 pathjoin(buf2, sizeof buf2,
382 am_sender && file->dir.root ? file->dir.root : "",
383 safe_fname(f_name(file)));
384 clean_fname(buf2, 0);
389 n = (char*)safe_fname(f_name(file));
390 if (S_ISDIR(file->mode)) {
391 /* The buffer from safe_fname() has more
392 * room than MAXPATHLEN, so this is safe. */
397 if (S_ISLNK(file->mode) && file->u.link) {
398 snprintf(buf2, sizeof buf2, " -> %s",
399 safe_fname(file->u.link));
404 case 'm': n = lp_name(module_id); break;
405 case 't': n = timestring(time(NULL)); break;
406 case 'P': n = lp_path(module_id); break;
407 case 'u': n = auth_user; break;
410 b = stats.total_written -
411 initial_stats->total_written;
413 b = stats.total_read -
414 initial_stats->total_read;
416 snprintf(buf2, sizeof buf2, "%.0f", (double)b);
421 b = stats.total_written -
422 initial_stats->total_written;
424 b = stats.total_read -
425 initial_stats->total_read;
427 snprintf(buf2, sizeof buf2, "%.0f", (double)b);
431 if (iflags & ITEM_DELETED) {
436 n[0] = !(iflags & ITEM_UPDATING) ? '.'
437 : *op == 's' ? '>' : '<';
438 n[1] = S_ISDIR(file->mode) ? 'd'
439 : IS_DEVICE(file->mode) ? 'D'
440 : S_ISLNK(file->mode) ? 'L' : 'f';
441 n[2] = !(iflags & ITEM_REPORT_CHECKSUM) ? '.' : 'c';
442 n[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
443 n[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
444 : !preserve_times || IS_DEVICE(file->mode)
445 || S_ISLNK(file->mode) ? 'T' : 't';
446 n[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
447 n[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
448 n[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
451 if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
452 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
454 for (i = 2; n[i]; i++)
456 } else if (!(iflags & ITEM_UPDATING)) {
458 for (i = 2; n[i]; i++) {
463 for (i = 2; n[i]; i++)
471 /* n is the string to be inserted in place of this %
472 * code; len is its length not including the trailing
481 if (len + total - 2 >= sizeof buf) {
483 "buffer overflow expanding %%%c -- exiting\n",
485 exit_cleanup(RERR_MESSAGEIO);
488 /* Shuffle the rest of the string along to make space for n */
490 memmove(p + len, p + 2, total - (p + 2 - buf) + 1);
493 /* Insert the contents of string "n", but NOT its nul. */
497 /* Skip over inserted string; continue looking */
501 rprintf(code, "%s\n", buf);
504 /* log the outgoing transfer of a file */
505 void log_send(struct file_struct *file, struct stats *initial_stats, int iflags)
507 if (lp_transfer_logging(module_id)) {
508 log_formatted(FLOG, lp_log_format(module_id), "send",
509 file, initial_stats, iflags);
510 } else if (log_format && !am_server) {
511 log_formatted(FINFO, log_format, "send",
512 file, initial_stats, iflags);
516 /* log the incoming transfer of a file */
517 void log_recv(struct file_struct *file, struct stats *initial_stats, int iflags)
519 if (lp_transfer_logging(module_id)) {
520 log_formatted(FLOG, lp_log_format(module_id), "recv",
521 file, initial_stats, iflags);
522 } else if (log_format && !am_server) {
523 log_formatted(FINFO, log_format, "recv",
524 file, initial_stats, iflags);
529 void log_delete(char *fname, int mode)
531 static struct file_struct file;
532 int len = strlen(fname);
536 file.basename = fname;
538 if (!verbose && !log_format)
540 else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
542 len++; /* directories include trailing null */
543 send_msg(MSG_DELETED, fname, len);
545 fmt = log_format_has_o_or_i ? log_format : "%i %n";
546 log_formatted(FCLIENT, fmt, "del.", &file, &stats, ITEM_DELETED);
549 if (!am_daemon || dry_run || !lp_transfer_logging(module_id))
552 fmt = daemon_log_format_has_o_or_i ? lp_log_format(module_id) : "%i %n";
553 log_formatted(FLOG, fmt, "del.", &file, &stats, ITEM_DELETED);
558 * Called when the transfer is interrupted for some reason.
560 * Code is one of the RERR_* codes from errcode.h, or terminating
563 void log_exit(int code, const char *file, int line)
566 rprintf(FLOG,"sent %.0f bytes received %.0f bytes total size %.0f\n",
567 (double)stats.total_written,
568 (double)stats.total_read,
569 (double)stats.total_size);
573 name = rerr_name(code);
575 name = "unexplained error";
577 /* VANISHED is not an error, only a warning */
578 if (code == RERR_VANISHED) {
579 rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d)\n",
580 name, code, file, line);
582 rprintf(FERROR, "rsync error: %s (code %d) at %s(%d)\n",
583 name, code, file, line);