Print strerror when a system error occurs; add a new function rsyserr
[rsync.git] / log.c
diff --git a/log.c b/log.c
index 732a96b7016cceb4c47c8be3650c5fc44e1938f6..8928a3862cceac62944d0b235121d0436977d55f 100644 (file)
--- a/log.c
+++ b/log.c
@@ -1,5 +1,6 @@
-/* 
-   Copyright (C) Andrew Tridgell 1998
+/* -*- c-file-style: "linux"; -*-
+   
+   Copyright (C) 1998-2000 by Andrew Tridgell
    
    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
   */
 #include "rsync.h"
 
+static char *logfname;
 static FILE *logfile;
-
+static int log_error_fd = -1;
 
 static void logit(int priority, char *buf)
 {
-       if (logfile) {
+       if (logfname) {
+               if (!logfile)
+                       log_open();
                fprintf(logfile,"%s [%d] %s", 
                        timestring(time(NULL)), (int)getpid(), buf);
                fflush(logfile);
@@ -37,12 +41,11 @@ static void logit(int priority, char *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;
@@ -54,13 +57,13 @@ void log_open(void)
        localtime(&t);
 
        /* optionally use a log file instead of syslog */
-       logf = lp_log_file();
-       if (logf && *logf) {
-               extern int orig_umask;
-               int old_umask = umask(022 | orig_umask);
-               logfile = fopen(logf, "a");
-               umask(old_umask);
-               return;
+       logfname = lp_log_file();
+       if (logfname) {
+               if (*logfname) {
+                       log_open();
+                       return;
+               }
+               logfname = NULL;
        }
 
 #ifdef LOG_NDELAY
@@ -77,71 +80,155 @@ void log_open(void)
        logit(LOG_INFO,"rsyncd started\n");
 #endif
 }
-               
 
-/* this is the rsync debugging function. Call it with FINFO, FERROR or FLOG */
- void rprintf(int fd, const char *format, ...)
+void log_open()
+{
+       if (logfname && !logfile) {
+               extern int orig_umask;
+               int old_umask = umask(022 | orig_umask);
+               logfile = fopen(logfname, "a");
+               umask(old_umask);
+       }
+}
+
+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;
+}
+
+/* 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 (quiet && code == FINFO) return;
 
-       if (len < 0) exit_cleanup(1);
-
-       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 the our sibling */
+       if (am_server && io_error_write(log_error_fd, code, buf, len)) {
+               return;
+       }
+
+       /* then 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) {
                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);
 }
+               
 
-void rflush(int fd)
+/* 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);
+}
+
+
+/* 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;
@@ -150,15 +237,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;
@@ -166,7 +253,7 @@ void rflush(int fd)
                        f = stdout;
        } 
 
-       if (!f) exit_cleanup(1);
+       if (!f) exit_cleanup(RERR_MESSAGEIO);
        fflush(f);
 }
 
@@ -174,16 +261,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,'%')); ) {
@@ -191,23 +284,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;
@@ -217,7 +340,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) {
@@ -228,29 +351,39 @@ 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)
+void log_exit(int code, const char *file, int line)
 {
        if (code == 0) {
                extern struct stats stats;              
@@ -259,13 +392,17 @@ void log_exit(int code)
                        (double)stats.total_read,
                        (double)stats.total_size);
        } else {
-               rprintf(FLOG,"transfer interrupted\n");
+               rprintf(FLOG,"transfer interrupted (code %d) at %s(%d)\n", 
+                       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;