-/* -*- 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
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-*/
-
/*
- Logging and utility functions.
- tridge, May 1998
+ * Logging and utility functions.
+ *
+ * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
+ * Copyright (C) 2000-2001 Martin Pool <mbp@samba.org>
+ * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
- Mapping to human-readable messages added by Martin Pool
- <mbp@samba.org>, Oct 2000.
- */
#include "rsync.h"
+#if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
+#include <iconv.h>
+#endif
extern int verbose;
extern int dry_run;
extern int quiet;
extern int module_id;
extern int msg_fd_out;
+extern int allow_8bit_chars;
extern int protocol_version;
extern int preserve_times;
+extern int log_format_has_i;
extern int log_format_has_o_or_i;
extern int daemon_log_format_has_o_or_i;
+extern mode_t orig_umask;
extern char *auth_user;
extern char *log_format;
+#if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
+extern iconv_t ic_chck;
+#endif
static int log_initialised;
+static int logfile_was_closed;
static char *logfname;
static FILE *logfile;
struct stats stats;
{ RERR_FILESELECT , "errors selecting input/output files, dirs" },
{ RERR_UNSUPPORTED, "requested action not supported" },
{ RERR_STARTCLIENT, "error starting client-server protocol" },
- { RERR_LOG_FAILURE, "daemon unable to append to log-file" },
{ 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_CRASHED , "sibling process crashed" },
+ { RERR_TERMINATED , "sibling process terminated abnormally" },
+ { RERR_SIGNAL1 , "received SIGUSR1" },
+ { RERR_SIGNAL , "received SIGINT, SIGTERM, or SIGHUP" },
+ { RERR_WAITCHILD , "waitpid() failed" },
{ RERR_MALLOC , "error allocating core memory buffers" },
{ RERR_PARTIAL , "some files could not be transferred" },
{ RERR_VANISHED , "some files vanished before they could be transferred" },
};
-
/*
* Map from rsync error code to name, or return NULL.
*/
return NULL;
}
-
static void logit(int priority, char *buf)
{
- if (logfname) {
- if (!logfile)
- log_open();
+ if (logfile_was_closed)
+ logfile_reopen();
+ if (logfile) {
fprintf(logfile,"%s [%d] %s",
timestring(time(NULL)), (int)getpid(), buf);
fflush(logfile);
}
}
-void log_init(void)
+static void syslog_init()
{
+ static int been_here = 0;
int options = LOG_PID;
- time_t t;
- if (log_initialised)
+ if (been_here)
return;
- log_initialised = 1;
-
- /* 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;
- }
+ been_here = 1;
#ifdef LOG_NDELAY
options |= LOG_NDELAY;
#endif
#ifndef LOG_NDELAY
- logit(LOG_INFO,"rsyncd started\n");
+ logit(LOG_INFO, "rsyncd started\n");
#endif
}
-void log_open(void)
+static void logfile_open(void)
{
- if (logfname && !logfile) {
- extern int orig_umask;
- int old_umask = umask(022 | orig_umask);
- logfile = fopen(logfname, "a");
- umask(old_umask);
- if (!logfile) {
- am_daemon = 0; /* avoid trying to log again */
- rsyserr(FERROR, errno, "fopen() of log-file failed");
- exit_cleanup(RERR_LOG_FAILURE);
- }
+ mode_t old_umask = umask(022 | orig_umask);
+ logfile = fopen(logfname, "a");
+ umask(old_umask);
+ if (!logfile) {
+ int fopen_errno = errno;
+ /* Rsync falls back to using syslog on failure. */
+ syslog_init();
+ rsyserr(FERROR, fopen_errno,
+ "failed to open log-file %s", logfname);
+ rprintf(FINFO, "Ignoring \"log file\" setting.\n");
}
}
-void log_close(void)
+void log_init(void)
+{
+ time_t t;
+
+ if (log_initialised)
+ return;
+ log_initialised = 1;
+
+ /* 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 && *logfname)
+ logfile_open();
+ else
+ syslog_init();
+}
+
+void logfile_close(void)
{
if (logfile) {
+ logfile_was_closed = 1;
fclose(logfile);
logfile = NULL;
}
}
+void logfile_reopen(void)
+{
+ if (logfile_was_closed) {
+ logfile_was_closed = 0;
+ logfile_open();
+ }
+}
+
+static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint)
+{
+ const char *s, *end = buf + len;
+ for (s = buf; s < end; s++) {
+ if ((s < end - 4
+ && *s == '\\' && s[1] == '#'
+ && isdigit(*(uchar*)(s+2))
+ && isdigit(*(uchar*)(s+3))
+ && isdigit(*(uchar*)(s+4)))
+ || (*s != '\t'
+ && ((use_isprint && !isprint(*(uchar*)s))
+ || *(uchar*)s < ' '))) {
+ if (s != buf && fwrite(buf, s - buf, 1, f) != 1)
+ exit_cleanup(RERR_MESSAGEIO);
+ fprintf(f, "\\#%03o", *(uchar*)s);
+ buf = s + 1;
+ }
+ }
+ if (buf != end && fwrite(buf, end - buf, 1, f) != 1)
+ exit_cleanup(RERR_MESSAGEIO);
+}
+
/* this is the underlying (unformatted) rsync debugging function. Call
- * it with FINFO, FERROR or FLOG */
+ * it with FINFO, FERROR or FLOG. Note: recursion can happen with
+ * certain fatal conditions. */
void rwrite(enum logcode code, char *buf, int len)
{
+ int trailing_CR_or_NL;
FILE *f = NULL;
- /* recursion can happen with certain fatal conditions */
-
- if (quiet && code == FINFO)
- return;
if (len < 0)
exit_cleanup(RERR_MESSAGEIO);
- buf[len] = 0;
+ if (quiet && code == FINFO)
+ return;
if (am_server && msg_fd_out >= 0) {
/* Pass the message to our sibling. */
return;
}
+ if (code == FSOCKERR) /* This gets simplified for a non-sibling. */
+ code = FERROR;
+
if (code == FCLIENT)
code = FINFO;
else if (am_daemon) {
}
}
- if (code == FERROR) {
+ switch (code) {
+ case FERROR:
log_got_error = 1;
f = stderr;
- }
-
- if (code == FINFO)
+ goto pre_scan;
+ case FINFO:
f = am_server ? stderr : stdout;
-
- if (!f)
+ pre_scan:
+ while (len > 1 && *buf == '\n') {
+ fputc(*buf, f);
+ buf++;
+ len--;
+ }
+ break;
+ case FNAME:
+ f = am_server ? stderr : stdout;
+ break;
+ default:
exit_cleanup(RERR_MESSAGEIO);
+ }
- if (fwrite(buf, len, 1, f) != 1)
- exit_cleanup(RERR_MESSAGEIO);
+ trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
+ ? buf[--len] : 0;
+
+#if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H
+ if (ic_chck != (iconv_t)-1) {
+ char convbuf[1024];
+ char *in_buf = buf, *out_buf = convbuf;
+ size_t in_cnt = len, out_cnt = sizeof convbuf - 1;
+
+ iconv(ic_chck, NULL, 0, NULL, 0);
+ while (iconv(ic_chck, &in_buf,&in_cnt,
+ &out_buf,&out_cnt) == (size_t)-1) {
+ if (out_buf != convbuf) {
+ filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
+ out_buf = convbuf;
+ out_cnt = sizeof convbuf - 1;
+ }
+ if (errno == E2BIG)
+ continue;
+ fprintf(f, "\\#%03o", *(uchar*)in_buf++);
+ in_cnt--;
+ }
+ if (out_buf != convbuf)
+ filtered_fwrite(f, convbuf, out_buf - convbuf, 0);
+ } else
+#endif
+ filtered_fwrite(f, buf, len, !allow_8bit_chars);
- if (buf[len-1] == '\r' || buf[len-1] == '\n')
+ if (trailing_CR_or_NL) {
+ fputc(trailing_CR_or_NL, f);
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[MAXPATHLEN+512];
+ char buf[BIGPATHBUFLEN];
size_t len;
va_start(ap, format);
* truncate the resulting string. (Note that configure ensures
* that we have a vsnprintf() that doesn't ever return -1.) */
if (len > sizeof buf - 1) {
- const char ellipsis[] = "[...]";
+ static const char ellipsis[] = "[...]";
/* Reset length, and zero-terminate the end of our buffer */
len = sizeof buf - 1;
* 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);
+ memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
if (format[strlen(format)-1] == '\n') {
buf[len-1] = '\n';
}
rwrite(code, buf, len);
}
-
/* This is like rprintf, but it also tries to print some
* representation of the error code. Normally errcode = errno.
*
void rsyserr(enum logcode code, int errcode, const char *format, ...)
{
va_list ap;
- char buf[MAXPATHLEN+512];
+ char buf[BIGPATHBUFLEN];
size_t len;
strcpy(buf, RSYNC_NAME ": ");
rwrite(code, buf, len);
}
-
-
void rflush(enum logcode code)
{
FILE *f = NULL;
-
+
if (am_daemon) {
return;
}
fflush(f);
}
-
-
/* a generic logging routine for send/recv, with parameter
* substitiution */
static void log_formatted(enum logcode code, char *format, char *op,
* copy in the terminating null of the inserted strings, but
* rather keep going until we reach the null of the format. */
total = strlcpy(buf, format, sizeof buf);
-
+ if (total > MAXPATHLEN) {
+ rprintf(FERROR, "log-format string is WAY too long!\n");
+ exit_cleanup(RERR_MESSAGEIO);
+ }
+ buf[total++] = '\n';
+ buf[total] = '\0';
+
for (p = buf; (p = strchr(p, '%')) != NULL; ) {
s = p++;
n = fmt + 1;
*n = '\0';
n = NULL;
- switch (*p++) {
- case 'h': if (am_daemon) n = client_name(0); break;
- case 'a': if (am_daemon) n = client_addr(0); break;
+ switch (*p) {
+ case 'h':
+ if (am_daemon)
+ n = client_name(0);
+ break;
+ case 'a':
+ if (am_daemon)
+ n = client_addr(0);
+ break;
case 'l':
strlcat(fmt, ".0f", sizeof fmt);
snprintf(buf2, sizeof buf2, fmt,
(double)file->length);
n = buf2;
break;
+ case 'U':
+ strlcat(fmt, "ld", sizeof fmt);
+ snprintf(buf2, sizeof buf2, fmt,
+ (long)file->uid);
+ n = buf2;
+ break;
+ case 'G':
+ if (file->gid == GID_NONE)
+ n = "DEFAULT";
+ else {
+ strlcat(fmt, "ld", sizeof fmt);
+ snprintf(buf2, sizeof buf2, fmt,
+ (long)file->gid);
+ n = buf2;
+ }
+ break;
case 'p':
strlcat(fmt, "ld", sizeof fmt);
snprintf(buf2, sizeof buf2, fmt,
(long)getpid());
n = buf2;
break;
- case 'o': n = op; break;
+ case 'M':
+ n = timestring(file->modtime);
+ {
+ char *cp = n;
+ while ((cp = strchr(cp, ' ')) != NULL)
+ *cp = '-';
+ }
+ break;
+ case 'B':
+ n = buf2 + MAXPATHLEN - PERMSTRING_SIZE;
+ permstring(n - 1, file->mode); /* skip the type char */
+ break;
+ case 'o':
+ n = op;
+ break;
case 'f':
- n = safe_fname(f_name(file));
+ n = f_name(file, NULL);
if (am_sender && file->dir.root) {
pathjoin(buf2, sizeof buf2,
file->dir.root, n);
- /* The buffer from safe_fname() has more
- * room than MAXPATHLEN, so this is safe. */
+ clean_fname(buf2, 0);
if (fmt[1])
- strcpy(n, buf2);
+ strlcpy(n, buf2, MAXPATHLEN);
else
n = buf2;
- }
- clean_fname(n, 0);
+ } else
+ clean_fname(n, 0);
if (*n == '/')
n++;
break;
case 'n':
- n = safe_fname(f_name(file));
- if (S_ISDIR(file->mode)) {
- /* The buffer from safe_fname() has more
- * room than MAXPATHLEN, so this is safe. */
- strcat(n, "/");
- }
+ n = f_name(file, NULL);
+ if (S_ISDIR(file->mode))
+ strlcat(n, "/", MAXPATHLEN);
break;
case 'L':
if (hlink && *hlink) {
- n = safe_fname(hlink);
+ n = hlink;
strcpy(buf2, " => ");
} else if (S_ISLNK(file->mode) && file->u.link) {
- n = safe_fname(file->u.link);
+ n = file->u.link;
strcpy(buf2, " -> ");
} else {
n = "";
snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
n = buf2;
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 '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':
- strlcat(fmt, ".0f", sizeof fmt);
if (am_sender) {
b = stats.total_written -
initial_stats->total_written;
b = stats.total_read -
initial_stats->total_read;
}
+ strlcat(fmt, ".0f", sizeof fmt);
snprintf(buf2, sizeof buf2, fmt, (double)b);
n = buf2;
break;
case 'c':
- strlcat(fmt, ".0f", sizeof fmt);
if (!am_sender) {
b = stats.total_written -
initial_stats->total_written;
b = stats.total_read -
initial_stats->total_read;
}
+ strlcat(fmt, ".0f", sizeof fmt);
snprintf(buf2, sizeof buf2, fmt, (double)b);
n = buf2;
break;
: !(iflags & ITEM_TRANSFER) ? '.'
: !local_server && *op == 's' ? '<' : '>';
n[1] = S_ISDIR(file->mode) ? 'd'
+ : IS_SPECIAL(file->mode) ? 'S'
: IS_DEVICE(file->mode) ? 'D'
: S_ISLNK(file->mode) ? 'L' : 'f';
n[2] = !(iflags & ITEM_REPORT_CHECKSUM) ? '.' : 'c';
n[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
n[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
- : !preserve_times || IS_DEVICE(file->mode)
- || S_ISLNK(file->mode) ? 'T' : 't';
+ : !preserve_times || S_ISLNK(file->mode) ? 'T' : 't';
n[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
n[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
n[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
- n[8] = !(iflags & ITEM_REPORT_XATTRS) ? '.' : 'a';
+ n[8] = '.';
n[9] = '\0';
if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
int i;
for (i = 2; n[i]; i++)
n[i] = ch;
- } else if (!(iflags & (ITEM_TRANSFER|ITEM_LOCAL_CHANGE))) {
+ } else if (n[0] == '.' || n[0] == 'h'
+ || (n[0] == 'c' && n[1] == 'f')) {
int i;
for (i = 2; n[i]; i++) {
if (n[i] != '.')
len = strlen(n);
/* Subtract the length of the escape from the string's size. */
- total -= p - s;
+ total -= p - s + 1;
- if (len + total >= sizeof buf) {
+ if (len + total >= (size_t)sizeof buf) {
rprintf(FERROR,
"buffer overflow expanding %%%c -- exiting\n",
- p[-1]);
+ p[0]);
exit_cleanup(RERR_MESSAGEIO);
}
/* Shuffle the rest of the string along to make space for n */
- if (len != (size_t)(p - s))
- memmove(s + len, p, total - (s - buf) + 1);
+ if (len != (size_t)(p - s + 1))
+ memmove(s + len, p + 1, total - (s - buf) + 1);
total += len;
/* Insert the contents of string "n", but NOT its null. */
p = s + len;
}
- rprintf(code, "%s\n", buf);
+ rwrite(code, buf, total);
}
+/* Return 1 if the format escape is in the log-format string (e.g. look for
+ * the 'b' in the "%9b" format escape). */
int log_format_has(const char *format, char esc)
{
const char *p;
log_formatted(FLOG, lp_log_format(module_id), s_or_r,
file, initial_stats, iflags, hlink);
} else if (log_format && !am_server) {
- log_formatted(FINFO, log_format, s_or_r,
+ log_formatted(FNAME, log_format, s_or_r,
file, initial_stats, iflags, hlink);
}
}
void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
char *buf)
{
- int see_item = itemizing && (iflags || verbose > 1);
+ int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
+ int see_item = itemizing && (significant_flags || *buf
+ || log_format_has_i > 1 || (verbose > 1 && log_format_has_i));
+ int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
if (am_server) {
if (am_daemon && !dry_run && see_item)
log_item(file, &stats, iflags, buf);
- } else if (see_item || iflags & ITEM_LOCAL_CHANGE || *buf
- || (S_ISDIR(file->mode) && iflags & SIGNIFICANT_ITEM_FLAGS))
+ } else if (see_item || local_change || *buf
+ || (S_ISDIR(file->mode) && significant_flags))
log_item(file, &stats, iflags, buf);
}
log_formatted(FLOG, fmt, "del.", &file, &stats, ITEM_DELETED, NULL);
}
-
/*
* Called when the transfer is interrupted for some reason.
*
/* VANISHED is not an error, only a warning */
if (code == RERR_VANISHED) {
- rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d)\n",
- name, code, file, line);
+ rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
+ name, code, file, line, who_am_i(), RSYNC_VERSION);
} else {
- rprintf(FERROR, "rsync error: %s (code %d) at %s(%d)\n",
- name, code, file, line);
+ rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
+ name, code, file, line, who_am_i(), RSYNC_VERSION);
}
}
}
Matt McCutchen's Web Site / rsync / rsync.git / blobdiff