Split code out into separate files and remove some global variables to
[rsync/rsync.git] / log.c
diff --git a/log.c b/log.c
index a216b6a..e79bc22 100644 (file)
--- a/log.c
+++ b/log.c
@@ -1,6 +1,6 @@
 /* -*- c-file-style: "linux"; -*-
    
-   Copyright (C) 1998-2001 by Andrew Tridgell <mbp@samba.org>
+   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
@@ -20,6 +20,7 @@
 
 /*
   Logging and utility functions.
+  tridge, May 1998
 
   Mapping to human-readable messages added by Martin Pool
   <mbp@samba.org>, Oct 2000.
@@ -29,7 +30,9 @@
 static char *logfname;
 static FILE *logfile;
 static int log_error_fd = -1;
+struct stats stats;
 
+int log_got_error=0;
 
 struct {
         int code;
@@ -38,7 +41,8 @@ struct {
        { 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_UNSUPPORTED, "requested action not supported" }, 
+       { RERR_STARTCLIENT, "error starting client-server protocol" }, 
        { RERR_SOCKETIO   , "error in socket IO" }, 
        { RERR_FILEIO     , "error in file IO" }, 
        { RERR_STREAMIO   , "error in rsync protocol data stream" }, 
@@ -47,7 +51,12 @@ struct {
        { 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 }
 };
 
@@ -66,6 +75,61 @@ static char const *rerr_name(int code)
         return NULL;
 }
 
+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;
+
+/* 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;
+}
+
+
+/* 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)
 {
@@ -143,6 +207,7 @@ void log_close()
 void set_error_fd(int fd)
 {
        log_error_fd = fd;
+       set_nonblocking(log_error_fd);
 }
 
 /* this is the underlying (unformatted) rsync debugging function. Call
@@ -166,12 +231,18 @@ void rwrite(enum logcode code, char *buf, int len)
                return;
        }
 
-       /* first try to pass it off the our sibling */
-       if (am_server && io_error_write(log_error_fd, code, buf, len)) {
+       /* 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 that fails, try to pass it to the other end.
+        *
+        * io_multiplex_write can fail if we do not have a multiplexed
+        * connection at the moment, in which case we fall through and
+        * log locally instead. */
        if (am_server && io_multiplex_write(code, buf, len)) {
                return;
        }
@@ -193,6 +264,7 @@ void rwrite(enum logcode code, char *buf, int len)
        }
 
        if (code == FERROR) {
+               log_got_error = 1;
                f = stderr;
        } 
 
@@ -220,10 +292,35 @@ void rprintf(enum logcode code, const char *format, ...)
        int len;
 
        va_start(ap, format);
-       len = vslprintf(buf, sizeof(buf), format, ap);
+       /* Note: might return -1 */
+       len = vsnprintf(buf, sizeof(buf), format, ap);
        va_end(ap);
 
-       if (len > sizeof(buf)-1) exit_cleanup(RERR_MESSAGEIO);
+       /* Deal with buffer overruns.  Instead of panicking, just
+        * truncate the resulting string.  Note that some vsnprintf()s
+        * return -1 on truncation, e.g., glibc 2.0.6 and earlier. */
+       if ((size_t) len > sizeof(buf)-1  ||  len < 0) {
+               const char ellipsis[] = "[...]";
+
+               /* Reset length, and zero-terminate the end of our buffer */
+               len = sizeof(buf)-1;
+               buf[len] = '\0';
+
+               /* Copy the ellipsis to the end of the string, but give
+                * us one extra character:
+                *
+                *                  v--- null byte at buf[sizeof(buf)-1]
+                *        abcdefghij0
+                *     -> abcd[...]00  <-- now two null bytes at end
+                *
+                * If the input format string has a trailing newline,
+                * we copy it into that extra null; if it doesn't, well,
+                * all we lose is one byte.  */
+               strncpy(buf+len-sizeof(ellipsis), ellipsis, sizeof(ellipsis));
+               if (format[strlen(format)-1] == '\n') {
+                       buf[len-1] = '\n';
+               }
+       }
 
        rwrite(code, buf, len);
 }
@@ -241,18 +338,23 @@ void rsyserr(enum logcode code, int errcode, const char *format, ...)
 {
        va_list ap;  
        char buf[1024];
-       int len, sys_len;
+       int len;
+       size_t sys_len;
         char *sysmsg;
 
        va_start(ap, format);
-       len = vslprintf(buf, sizeof(buf), format, ap);
+       /* Note: might return <0 */
+       len = vsnprintf(buf, sizeof(buf), format, ap);
        va_end(ap);
 
-       if (len > sizeof(buf)-1) exit_cleanup(RERR_MESSAGEIO);
+       /* TODO: Put in RSYNC_NAME at the start. */
+
+       if ((size_t) len > sizeof(buf)-1)
+               exit_cleanup(RERR_MESSAGEIO);
 
         sysmsg = strerror(errcode);
         sys_len = strlen(sysmsg);
-        if (len + 3 + sys_len > sizeof(buf) - 1)
+        if ((size_t) len + 3 + sys_len > sizeof(buf) - 1)
                 exit_cleanup(RERR_MESSAGEIO);
 
         strcpy(buf + len, ": ");
@@ -309,12 +411,18 @@ static void log_formatted(enum logcode code,
        char buf[1024];
        char buf2[1024];
        char *p, *s, *n;
-       int l;
+       size_t l;
        extern struct stats stats;              
        extern int am_sender;
        extern int am_daemon;
        int64 b;
 
+       /* We expand % codes one by one in place in buf.  We don't
+        * copy in the terminating nul of the inserted strings, but
+        * rather keep going until we reach the nul of the format.
+        * Just to make sure we don't clobber that nul and therefore
+        * accidentally keep going, we zero the buffer now. */
+       memset(buf, 0, sizeof buf);
        strlcpy(buf, format, sizeof(buf));
        
        for (s=&buf[0]; 
@@ -326,18 +434,18 @@ static void log_formatted(enum logcode code,
                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),"%.0f", 
+                       snprintf(buf2,sizeof(buf2),"%.0f", 
                                 (double)file->length); 
                        n = buf2;
                        break;
                case 'p': 
-                       slprintf(buf2,sizeof(buf2),"%d", 
+                       snprintf(buf2,sizeof(buf2),"%d", 
                                 (int)getpid()); 
                        n = buf2;
                        break;
                case 'o': n = op; break;
                case 'f': 
-                       slprintf(buf2, sizeof(buf2), "%s/%s", 
+                       snprintf(buf2, sizeof(buf2), "%s/%s", 
                                 file->basedir?file->basedir:"", 
                                 f_name(file));
                        clean_fname(buf2);
@@ -356,7 +464,7 @@ static void log_formatted(enum logcode code,
                                b = stats.total_read - 
                                        initial_stats->total_read;
                        }
-                       slprintf(buf2,sizeof(buf2),"%.0f", (double)b); 
+                       snprintf(buf2,sizeof(buf2),"%.0f", (double)b); 
                        n = buf2;
                        break;
                case 'c': 
@@ -367,26 +475,35 @@ static void log_formatted(enum logcode code,
                                b = stats.total_read - 
                                        initial_stats->total_read;
                        }
-                       slprintf(buf2,sizeof(buf2),"%.0f", (double)b); 
+                       snprintf(buf2,sizeof(buf2),"%.0f", (double)b); 
                        n = buf2;
                        break;
                }
 
-               if (!n) continue;
+               /* n is the string to be inserted in place of this %
+                * code; l is its length not including the trailing
+                * NUL */
+               if (!n)
+                       continue;
 
                l = strlen(n);
 
-               if ((l-1) + ((int)(s - &buf[0])) > sizeof(buf)) {
+               if (l + ((int)(s - &buf[0])) >= sizeof(buf)) {
                        rprintf(FERROR,"buffer overflow expanding %%%c - exiting\n",
                                p[0]);
                        exit_cleanup(RERR_MESSAGEIO);
                }
 
+               /* Shuffle the rest of the string along to make space for n */
                if (l != 2) {
                        memmove(s+(l-1), s+1, strlen(s+1)+1);
                }
+
+               /* Copy in n but NOT its nul, because the format sting
+                * probably continues after this. */
                memcpy(p, n, l);
 
+               /* Skip over inserted string; continue looking */
                s = p+l;
        }
 
@@ -445,25 +562,21 @@ void log_exit(int code, const char *file, int line)
                 if (!name)
                         name = "unexplained error";
                 
-               rprintf(FLOG,"transfer interrupted: %s (code %d) at %s(%d)\n", 
+               rprintf(FERROR,"rsync 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 
-   
-   it i called when a file starts to be transferred
-*/
+/*
+ * Log the incoming transfer of a file for interactive use,
+ * this will be called at the end where the client was run.
+ * Called when a file starts to be transferred.
+ */
 void log_transfer(struct file_struct *file, const char *fname)
 {
        extern int verbose;
 
        if (!verbose) return;
 
-       rprintf(FINFO,"%s\n", fname);
+       rprintf(FINFO, "%s\n", fname);
 }
-