X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/97cb8dc29b9e6a4f46f9b7162d410fdab0f7d8af..19b27a485e833e08160ef0bae8f604c6f60e5ef8:/log.c

diff --git a/log.c b/log.c
index d09094c6..e67477b7 100644
--- a/log.c
+++ b/log.c
@@ -1,5 +1,7 @@
-/* 
-   Copyright (C) Andrew Tridgell 1998
+/* -*- c-file-style: "linux"; -*-
+   
+   Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
+   Copyright (C) 2000-2001 by Martin Pool <mbp@samba.org>
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -17,62 +19,152 @@
 */
 
 /*
-  logging and utility functions
-
+  Logging and utility functions.
   tridge, May 1998
+
+  Mapping to human-readable messages added by Martin Pool
+  <mbp@samba.org>, Oct 2000.
   */
 #include "rsync.h"
 
+static char *logfname;
 static FILE *logfile;
+static int log_error_fd = -1;
+
+int log_got_error=0;
+
+struct {
+        int code;
+        char const *name;
+} const rerr_names[] = {
+	{ RERR_SYNTAX     , "syntax or usage error" }, 
+	{ RERR_PROTOCOL   , "protocol incompatibility" }, 
+	{ RERR_FILESELECT , "errors selecting input/output files, dirs" }, 
+	{ RERR_UNSUPPORTED, "requested action not supported" }, 
+	{ RERR_SOCKETIO   , "error in socket IO" }, 
+	{ RERR_FILEIO     , "error in file IO" }, 
+	{ RERR_STREAMIO   , "error in rsync protocol data stream" }, 
+	{ RERR_MESSAGEIO  , "errors with program diagnostics" }, 
+	{ RERR_IPC        , "error in IPC code" }, 
+	{ RERR_SIGNAL     , "received SIGUSR1 or SIGINT" }, 
+	{ RERR_WAITCHILD  , "some error returned by waitpid()" }, 
+	{ RERR_MALLOC     , "error allocating core memory buffers" }, 
+	{ RERR_PARTIAL    , "partial transfer" }, 
+	{ RERR_TIMEOUT    , "timeout in data send/receive" }, 
+	{ RERR_CMD_FAILED , "remote shell failed" },
+	{ RERR_CMD_KILLED , "remote shell killed" },
+	{ RERR_CMD_RUN,     "remote command could not be run" },
+        { RERR_CMD_NOTFOUND, "remote command not found" },
+        { 0, NULL }
+};
+
 
 
-/****************************************************************************
-  return the date and time as a string
-****************************************************************************/
-static char *timestring(void )
+/*
+ * Map from rsync error code to name, or return NULL.
+ */
+static char const *rerr_name(int code)
 {
-	static char TimeBuf[200];
-	time_t t = time(NULL);
-	struct tm *tm = localtime(&t);
+        int i;
+        for (i = 0; rerr_names[i].name; i++) {
+                if (rerr_names[i].code == code)
+                        return rerr_names[i].name;
+        }
+        return NULL;
+}
 
-#ifdef HAVE_STRFTIME
-	strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %T",tm);
-#else
-	strlcpy(TimeBuf, asctime(tm), sizeof(TimeBuf)-1);
-#endif
+struct err_list {
+	struct err_list *next;
+	char *buf;
+	int len;
+	int written; /* how many bytes we have written so far */
+};
+
+static struct err_list *err_list_head;
+static struct err_list *err_list_tail;
 
-	if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
-		TimeBuf[strlen(TimeBuf)-1] = 0;
+/* add an error message to the pending error list */
+static void err_list_add(int code, char *buf, int len)
+{
+	struct err_list *el;
+	el = (struct err_list *)malloc(sizeof(*el));
+	if (!el) exit_cleanup(RERR_MALLOC);
+	el->next = NULL;
+	el->buf = malloc(len+4);
+	if (!el->buf) exit_cleanup(RERR_MALLOC);
+	memcpy(el->buf+4, buf, len);
+	SIVAL(el->buf, 0, ((code+MPLEX_BASE)<<24) | len);
+	el->len = len+4;
+	el->written = 0;
+	if (err_list_tail) {
+		err_list_tail->next = el;
+	} else {
+		err_list_head = el;
 	}
+	err_list_tail = el;
+}
 
-	return(TimeBuf);
+
+/* try to push errors off the error list onto the wire */
+void err_list_push(void)
+{
+	if (log_error_fd == -1) return;
+
+	while (err_list_head) {
+		struct err_list *el = err_list_head;
+		int n = write(log_error_fd, el->buf+el->written, el->len - el->written);
+		/* don't check for an error if the best way of handling the error is
+		   to ignore it */
+		if (n == -1) break;
+		if (n > 0) {
+			el->written += n;
+		}
+		if (el->written == el->len) {
+			free(el->buf);
+			err_list_head = el->next;
+			if (!err_list_head) err_list_tail = NULL;
+			free(el);
+		}
+	}
 }
 
+
 static void logit(int priority, char *buf)
 {
-	if (logfile) {
+	if (logfname) {
+		if (!logfile)
+			log_open();
 		fprintf(logfile,"%s [%d] %s", 
-			timestring(), (int)getpid(), buf);
+			timestring(time(NULL)), (int)getpid(), buf);
 		fflush(logfile);
 	} else {
 		syslog(priority, "%s", buf);
 	}
 }
 
-void log_open(void)
+void log_init(void)
 {
 	static int initialised;
 	int options = LOG_PID;
 	time_t t;
-	char *logf;
 
 	if (initialised) return;
 	initialised = 1;
 
-	logf = lp_log_file();
-	if (logf && *logf) {
-		logfile = fopen(logf, "a");
-		return;
+	/* this looks pointless, but it is needed in order for the
+	   C library on some systems to fetch the timezone info
+	   before the chroot */
+	t = time(NULL);
+	localtime(&t);
+
+	/* optionally use a log file instead of syslog */
+	logfname = lp_log_file();
+	if (logfname) {
+		if (*logfname) {
+			log_open();
+			return;
+		}
+		logfname = NULL;
 	}
 
 #ifdef LOG_NDELAY
@@ -88,78 +180,160 @@ void log_open(void)
 #ifndef LOG_NDELAY
 	logit(LOG_INFO,"rsyncd started\n");
 #endif
+}
 
-	/* this looks pointless, but it is needed in order for the
-	   C library on some systems to fetch the timezone info
-	   before the chroot */
-	t = time(NULL);
-	localtime(&t);
+void log_open()
+{
+	if (logfname && !logfile) {
+		extern int orig_umask;
+		int old_umask = umask(022 | orig_umask);
+		logfile = fopen(logfname, "a");
+		umask(old_umask);
+	}
 }
-		
 
-/* this is the rsync debugging function. Call it with FINFO, FERROR or FLOG */
- void rprintf(int fd, const char *format, ...)
+void log_close()
+{
+	if (logfile) {
+		fclose(logfile);
+		logfile = NULL;
+	}
+}
+
+/* setup the error file descriptor - used when we are a server
+   that is receiving files */
+void set_error_fd(int fd)
+{
+	log_error_fd = fd;
+	set_nonblocking(log_error_fd);
+}
+
+/* this is the underlying (unformatted) rsync debugging function. Call
+   it with FINFO, FERROR or FLOG */
+void rwrite(enum logcode code, char *buf, int len)
 {
-	va_list ap;  
-	char buf[1024];
-	int len;
 	FILE *f=NULL;
 	extern int am_daemon;
+	extern int am_server;
+	extern int quiet;
 	/* recursion can happen with certain fatal conditions */
 
-	va_start(ap, format);
-	len = vslprintf(buf, sizeof(buf)-1, format, ap);
-	va_end(ap);
-
-	if (len < 0) exit_cleanup(1);
+	if (quiet && code == FINFO) return;
 
-	if (len > sizeof(buf)-1) exit_cleanup(1);
+	if (len < 0) exit_cleanup(RERR_MESSAGEIO);
 
 	buf[len] = 0;
 
-	if (fd == FLOG) {
+	if (code == FLOG) {
 		if (am_daemon) logit(LOG_INFO, buf);
 		return;
 	}
 
+	/* first try to pass it off to our sibling */
+	if (am_server && log_error_fd != -1) {
+		err_list_add(code, buf, len);
+		err_list_push();
+		return;
+	}
+
+	/* if that fails, try to pass it to the other end */
+	if (am_server && io_multiplex_write(code, buf, len)) {
+		return;
+	}
+
 	if (am_daemon) {
 		static int depth;
 		int priority = LOG_INFO;
-		if (fd == FERROR) priority = LOG_WARNING;
+		if (code == FERROR) priority = LOG_WARNING;
 
 		if (depth) return;
 
 		depth++;
 
-		log_open();
-		if (!io_multiplex_write(fd, buf, strlen(buf))) {
-			logit(priority, buf);
-		}
+		log_init();
+		logit(priority, buf);
 
 		depth--;
 		return;
 	}
 
-	if (fd == FERROR) {
+	if (code == FERROR) {
+		log_got_error = 1;
 		f = stderr;
 	} 
 
-	if (fd == FINFO) {
-		extern int am_server;
+	if (code == FINFO) {
 		if (am_server) 
 			f = stderr;
 		else
 			f = stdout;
 	} 
 
-	if (!f) exit_cleanup(1);
+	if (!f) exit_cleanup(RERR_MESSAGEIO);
 
-	if (fwrite(buf, len, 1, f) != 1) exit_cleanup(1);
+	if (fwrite(buf, len, 1, f) != 1) exit_cleanup(RERR_MESSAGEIO);
 
 	if (buf[len-1] == '\r' || buf[len-1] == '\n') fflush(f);
 }
+		
+
+/* This is the rsync debugging function. Call it with FINFO, FERROR or
+ * FLOG. */
+void rprintf(enum logcode code, const char *format, ...)
+{
+	va_list ap;  
+	char buf[1024];
+	int len;
+
+	va_start(ap, format);
+	len = vslprintf(buf, sizeof(buf), format, ap);
+	va_end(ap);
+
+	if (len > sizeof(buf)-1) exit_cleanup(RERR_MESSAGEIO);
+
+	rwrite(code, buf, len);
+}
+
 
-void rflush(int fd)
+/* This is like rprintf, but it also tries to print some
+ * representation of the error code.  Normally errcode = errno.
+ *
+ * Unlike rprintf, this always adds a newline and there should not be
+ * one in the format string.
+ *
+ * Note that since strerror might involve dynamically loading a
+ * message catalog we need to call it once before chroot-ing. */
+void rsyserr(enum logcode code, int errcode, const char *format, ...)
+{
+	va_list ap;  
+	char buf[1024];
+	int len, sys_len;
+        char *sysmsg;
+
+	va_start(ap, format);
+	len = vslprintf(buf, sizeof(buf), format, ap);
+	va_end(ap);
+
+	if (len > sizeof(buf)-1) exit_cleanup(RERR_MESSAGEIO);
+
+        sysmsg = strerror(errcode);
+        sys_len = strlen(sysmsg);
+        if (len + 3 + sys_len > sizeof(buf) - 1)
+                exit_cleanup(RERR_MESSAGEIO);
+
+        strcpy(buf + len, ": ");
+        len += 2;
+        strcpy(buf + len, sysmsg);
+        len += sys_len;
+        strcpy(buf + len, "\n");
+        len++;
+
+	rwrite(code, buf, len);
+}
+
+
+
+void rflush(enum logcode code)
 {
 	FILE *f = NULL;
 	extern int am_daemon;
@@ -168,15 +342,15 @@ void rflush(int fd)
 		return;
 	}
 
-	if (fd == FLOG) {
+	if (code == FLOG) {
 		return;
 	} 
 
-	if (fd == FERROR) {
+	if (code == FERROR) {
 		f = stderr;
 	} 
 
-	if (fd == FINFO) {
+	if (code == FINFO) {
 		extern int am_server;
 		if (am_server) 
 			f = stderr;
@@ -184,7 +358,7 @@ void rflush(int fd)
 			f = stdout;
 	} 
 
-	if (!f) exit_cleanup(1);
+	if (!f) exit_cleanup(RERR_MESSAGEIO);
 	fflush(f);
 }
 
@@ -192,16 +366,22 @@ void rflush(int fd)
 
 /* a generic logging routine for send/recv, with parameter
    substitiution */
-static void log_formatted(char *op, struct file_struct *file)
+static void log_formatted(enum logcode code,
+			  char *format, char *op, struct file_struct *file,
+			  struct stats *initial_stats)
 {
 	extern int module_id;
 	extern char *auth_user;
 	char buf[1024];
+	char buf2[1024];
 	char *p, *s, *n;
-	char buf2[100];
 	int l;
+	extern struct stats stats;		
+	extern int am_sender;
+	extern int am_daemon;
+	int64 b;
 
-	strlcpy(buf, lp_log_format(module_id), sizeof(buf)-1);
+	strlcpy(buf, format, sizeof(buf));
 	
 	for (s=&buf[0]; 
 	     s && (p=strchr(s,'%')); ) {
@@ -209,23 +389,53 @@ static void log_formatted(char *op, struct file_struct *file)
 		s = p + 1;
 
 		switch (p[1]) {
-		case 'h': n = client_name(0); break;
-		case 'a': n = client_addr(0); break;
+		case 'h': if (am_daemon) n = client_name(0); break;
+		case 'a': if (am_daemon) n = client_addr(0); break;
 		case 'l': 
-			slprintf(buf2,sizeof(buf2)-1,"%.0f", 
+			slprintf(buf2,sizeof(buf2),"%.0f", 
 				 (double)file->length); 
 			n = buf2;
 			break;
 		case 'p': 
-			slprintf(buf2,sizeof(buf2)-1,"%d", 
+			slprintf(buf2,sizeof(buf2),"%d", 
 				 (int)getpid()); 
 			n = buf2;
 			break;
 		case 'o': n = op; break;
-		case 'f': n = f_name(file); break;
+		case 'f': 
+			slprintf(buf2, sizeof(buf2), "%s/%s", 
+				 file->basedir?file->basedir:"", 
+				 f_name(file));
+			clean_fname(buf2);
+			n = buf2; 
+			if (*n == '/') n++;
+			break;
 		case 'm': n = lp_name(module_id); break;
+		case 't': n = timestring(time(NULL)); break;
 		case 'P': n = lp_path(module_id); break;
 		case 'u': n = auth_user; break;
+		case 'b': 
+			if (am_sender) {
+				b = stats.total_written - 
+					initial_stats->total_written;
+			} else {
+				b = stats.total_read - 
+					initial_stats->total_read;
+			}
+			slprintf(buf2,sizeof(buf2),"%.0f", (double)b); 
+			n = buf2;
+			break;
+		case 'c': 
+			if (!am_sender) {
+				b = stats.total_written - 
+					initial_stats->total_written;
+			} else {
+				b = stats.total_read - 
+					initial_stats->total_read;
+			}
+			slprintf(buf2,sizeof(buf2),"%.0f", (double)b); 
+			n = buf2;
+			break;
 		}
 
 		if (!n) continue;
@@ -235,7 +445,7 @@ static void log_formatted(char *op, struct file_struct *file)
 		if ((l-1) + ((int)(s - &buf[0])) > sizeof(buf)) {
 			rprintf(FERROR,"buffer overflow expanding %%%c - exiting\n",
 				p[0]);
-			exit_cleanup(1);
+			exit_cleanup(RERR_MESSAGEIO);
 		}
 
 		if (l != 2) {
@@ -246,29 +456,47 @@ static void log_formatted(char *op, struct file_struct *file)
 		s = p+l;
 	}
 
-	rprintf(FLOG,"%s\n", buf);
+	rprintf(code,"%s\n", buf);
 }
 
 /* log the outgoing transfer of a file */
-void log_send(struct file_struct *file)
+void log_send(struct file_struct *file, struct stats *initial_stats)
 {
 	extern int module_id;
+	extern int am_server;
+	extern char *log_format;
+
 	if (lp_transfer_logging(module_id)) {
-		log_formatted("send", file);
+		log_formatted(FLOG, lp_log_format(module_id), "send", file, initial_stats);
+	} else if (log_format && !am_server) {
+		log_formatted(FINFO, log_format, "send", file, initial_stats);
 	}
 }
 
 /* log the incoming transfer of a file */
-void log_recv(struct file_struct *file)
+void log_recv(struct file_struct *file, struct stats *initial_stats)
 {
 	extern int module_id;
+	extern int am_server;
+	extern char *log_format;
+
 	if (lp_transfer_logging(module_id)) {
-		log_formatted("recv", file);
+		log_formatted(FLOG, lp_log_format(module_id), "recv", file, initial_stats);
+	} else if (log_format && !am_server) {
+		log_formatted(FINFO, log_format, "recv", file, initial_stats);
 	}
 }
 
-/* called when the transfer is interrupted for some reason */
-void log_exit(int code)
+
+
+
+/*
+ * Called when the transfer is interrupted for some reason.
+ *
+ * Code is one of the RERR_* codes from errcode.h, or terminating
+ * successfully.
+ */
+void log_exit(int code, const char *file, int line)
 {
 	if (code == 0) {
 		extern struct stats stats;		
@@ -277,13 +505,26 @@ void log_exit(int code)
 			(double)stats.total_read,
 			(double)stats.total_size);
 	} else {
-		rprintf(FLOG,"transfer interrupted\n");
+                const char *name;
+
+                name = rerr_name(code);
+                if (!name)
+                        name = "unexplained error";
+                
+		rprintf(FERROR,"transfer error: %s (code %d) at %s(%d)\n", 
+			name, code, file, line);
 	}
 }
 
+
+
+
 /* log the incoming transfer of a file for interactive use, this
-   will be called at the end where the client was run */
-void log_transfer(struct file_struct *file, char *fname)
+   will be called at the end where the client was run 
+   
+   it i called when a file starts to be transferred
+*/
+void log_transfer(struct file_struct *file, const char *fname)
 {
 	extern int verbose;