Output numbers in 3-digit groups by default (e.g. 1,234,567).
[rsync.git] / log.c
1 /*
2  * Logging and utility functions.
3  *
4  * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
5  * Copyright (C) 2000-2001 Martin Pool <mbp@samba.org>
6  * Copyright (C) 2003-2008 Wayne Davison
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along
19  * with this program; if not, visit the http://fsf.org website.
20  */
21
22 #include "rsync.h"
23 #include "ifuncs.h"
24
25 extern int dry_run;
26 extern int am_daemon;
27 extern int am_server;
28 extern int am_sender;
29 extern int am_generator;
30 extern int local_server;
31 extern int quiet;
32 extern int module_id;
33 extern int msg_fd_out;
34 extern int checksum_len;
35 extern int allow_8bit_chars;
36 extern int protocol_version;
37 extern int always_checksum;
38 extern int preserve_times;
39 extern int msgs2stderr;
40 extern int uid_ndx;
41 extern int gid_ndx;
42 extern int stdout_format_has_i;
43 extern int stdout_format_has_o_or_i;
44 extern int logfile_format_has_i;
45 extern int logfile_format_has_o_or_i;
46 extern int receiver_symlink_times;
47 extern mode_t orig_umask;
48 extern char *auth_user;
49 extern char *stdout_format;
50 extern char *logfile_format;
51 extern char *logfile_name;
52 #ifdef ICONV_CONST
53 extern iconv_t ic_chck;
54 #endif
55 #ifdef ICONV_OPTION
56 extern iconv_t ic_recv;
57 #endif
58 extern char curr_dir[MAXPATHLEN];
59 extern char *module_dir;
60 extern unsigned int module_dirlen;
61 extern char sender_file_sum[MAX_DIGEST_LEN];
62
63 static int log_initialised;
64 static int logfile_was_closed;
65 static FILE *logfile_fp;
66 struct stats stats;
67
68 int got_xfer_error = 0;
69 int output_needs_newline = 0;
70
71 struct {
72         int code;
73         char const *name;
74 } const rerr_names[] = {
75         { RERR_SYNTAX     , "syntax or usage error" },
76         { RERR_PROTOCOL   , "protocol incompatibility" },
77         { RERR_FILESELECT , "errors selecting input/output files, dirs" },
78         { RERR_UNSUPPORTED, "requested action not supported" },
79         { RERR_STARTCLIENT, "error starting client-server protocol" },
80         { RERR_SOCKETIO   , "error in socket IO" },
81         { RERR_FILEIO     , "error in file IO" },
82         { RERR_STREAMIO   , "error in rsync protocol data stream" },
83         { RERR_MESSAGEIO  , "errors with program diagnostics" },
84         { RERR_IPC        , "error in IPC code" },
85         { RERR_CRASHED    , "sibling process crashed" },
86         { RERR_TERMINATED , "sibling process terminated abnormally" },
87         { RERR_SIGNAL1    , "received SIGUSR1" },
88         { RERR_SIGNAL     , "received SIGINT, SIGTERM, or SIGHUP" },
89         { RERR_WAITCHILD  , "waitpid() failed" },
90         { RERR_MALLOC     , "error allocating core memory buffers" },
91         { RERR_PARTIAL    , "some files/attrs were not transferred (see previous errors)" },
92         { RERR_VANISHED   , "some files vanished before they could be transferred" },
93         { RERR_TIMEOUT    , "timeout in data send/receive" },
94         { RERR_CONTIMEOUT , "timeout waiting for daemon connection" },
95         { RERR_CMD_FAILED , "remote shell failed" },
96         { RERR_CMD_KILLED , "remote shell killed" },
97         { RERR_CMD_RUN    , "remote command could not be run" },
98         { RERR_CMD_NOTFOUND,"remote command not found" },
99         { RERR_DEL_LIMIT  , "the --max-delete limit stopped deletions" },
100         { 0, NULL }
101 };
102
103 /*
104  * Map from rsync error code to name, or return NULL.
105  */
106 static char const *rerr_name(int code)
107 {
108         int i;
109         for (i = 0; rerr_names[i].name; i++) {
110                 if (rerr_names[i].code == code)
111                         return rerr_names[i].name;
112         }
113         return NULL;
114 }
115
116 static void logit(int priority, const char *buf)
117 {
118         if (logfile_was_closed)
119                 logfile_reopen();
120         if (logfile_fp) {
121                 fprintf(logfile_fp, "%s [%d] %s",
122                         timestring(time(NULL)), (int)getpid(), buf);
123                 fflush(logfile_fp);
124         } else {
125                 syslog(priority, "%s", buf);
126         }
127 }
128
129 static void syslog_init()
130 {
131         static int been_here = 0;
132         int options = LOG_PID;
133
134         if (been_here)
135                 return;
136         been_here = 1;
137
138 #ifdef LOG_NDELAY
139         options |= LOG_NDELAY;
140 #endif
141
142 #ifdef LOG_DAEMON
143         openlog("rsyncd", options, lp_syslog_facility(module_id));
144 #else
145         openlog("rsyncd", options);
146 #endif
147
148 #ifndef LOG_NDELAY
149         logit(LOG_INFO, "rsyncd started\n");
150 #endif
151 }
152
153 static void logfile_open(void)
154 {
155         mode_t old_umask = umask(022 | orig_umask);
156         logfile_fp = fopen(logfile_name, "a");
157         umask(old_umask);
158         if (!logfile_fp) {
159                 int fopen_errno = errno;
160                 /* Rsync falls back to using syslog on failure. */
161                 syslog_init();
162                 rsyserr(FERROR, fopen_errno,
163                         "failed to open log-file %s", logfile_name);
164                 rprintf(FINFO, "Ignoring \"log file\" setting.\n");
165         }
166 }
167
168 void log_init(int restart)
169 {
170         if (log_initialised) {
171                 if (!restart)
172                         return;
173                 if (strcmp(logfile_name, lp_log_file(module_id)) != 0) {
174                         if (logfile_fp) {
175                                 fclose(logfile_fp);
176                                 logfile_fp = NULL;
177                         } else
178                                 closelog();
179                         logfile_name = NULL;
180                 } else if (*logfile_name)
181                         return; /* unchanged, non-empty "log file" names */
182                 else if (lp_syslog_facility(-1) != lp_syslog_facility(module_id))
183                         closelog();
184                 else
185                         return; /* unchanged syslog settings */
186         } else
187                 log_initialised = 1;
188
189         /* This looks pointless, but it is needed in order for the
190          * C library on some systems to fetch the timezone info
191          * before the chroot. */
192         timestring(time(NULL));
193
194         /* Optionally use a log file instead of syslog.  (Non-daemon
195          * rsyncs will have already set logfile_name, as needed.) */
196         if (am_daemon && !logfile_name)
197                 logfile_name = lp_log_file(module_id);
198         if (logfile_name && *logfile_name)
199                 logfile_open();
200         else
201                 syslog_init();
202 }
203
204 void logfile_close(void)
205 {
206         if (logfile_fp) {
207                 logfile_was_closed = 1;
208                 fclose(logfile_fp);
209                 logfile_fp = NULL;
210         }
211 }
212
213 void logfile_reopen(void)
214 {
215         if (logfile_was_closed) {
216                 logfile_was_closed = 0;
217                 logfile_open();
218         }
219 }
220
221 static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint)
222 {
223         const char *s, *end = buf + len;
224         for (s = buf; s < end; s++) {
225                 if ((s < end - 4
226                   && *s == '\\' && s[1] == '#'
227                   && isDigit(s + 2)
228                   && isDigit(s + 3)
229                   && isDigit(s + 4))
230                  || (*s != '\t'
231                   && ((use_isprint && !isPrint(s))
232                    || *(uchar*)s < ' '))) {
233                         if (s != buf && fwrite(buf, s - buf, 1, f) != 1)
234                                 exit_cleanup(RERR_MESSAGEIO);
235                         fprintf(f, "\\#%03o", *(uchar*)s);
236                         buf = s + 1;
237                 }
238         }
239         if (buf != end && fwrite(buf, end - buf, 1, f) != 1)
240                 exit_cleanup(RERR_MESSAGEIO);
241 }
242
243 /* this is the underlying (unformatted) rsync debugging function. Call
244  * it with FINFO, FERROR_*, FWARNING, FLOG, or FCLIENT.  Note: recursion
245  * can happen with certain fatal conditions. */
246 void rwrite(enum logcode code, const char *buf, int len, int is_utf8)
247 {
248         int trailing_CR_or_NL;
249         FILE *f = msgs2stderr ? stderr : stdout;
250 #ifdef ICONV_OPTION
251         iconv_t ic = is_utf8 && ic_recv != (iconv_t)-1 ? ic_recv : ic_chck;
252 #else
253 #ifdef ICONV_CONST
254         iconv_t ic = ic_chck;
255 #endif
256 #endif
257
258         if (len < 0)
259                 exit_cleanup(RERR_MESSAGEIO);
260
261         if (msgs2stderr && code != FLOG)
262                 goto output_msg;
263
264         if (am_server && msg_fd_out >= 0) {
265                 assert(!is_utf8);
266                 /* Pass the message to our sibling in native charset. */
267                 send_msg((enum msgcode)code, buf, len, 0);
268                 return;
269         }
270
271         if (code == FERROR_SOCKET) /* This gets simplified for a non-sibling. */
272                 code = FERROR;
273         else if (code == FERROR_UTF8) {
274                 is_utf8 = 1;
275                 code = FERROR;
276         }
277
278         if (code == FCLIENT)
279                 code = FINFO;
280         else if (am_daemon || logfile_name) {
281                 static int in_block;
282                 char msg[2048];
283                 int priority = code == FINFO || code == FLOG ? LOG_INFO :  LOG_WARNING;
284
285                 if (in_block)
286                         return;
287                 in_block = 1;
288                 if (!log_initialised)
289                         log_init(0);
290                 strlcpy(msg, buf, MIN((int)sizeof msg, len + 1));
291                 logit(priority, msg);
292                 in_block = 0;
293
294                 if (code == FLOG || (am_daemon && !am_server))
295                         return;
296         } else if (code == FLOG)
297                 return;
298
299         if (quiet && code == FINFO)
300                 return;
301
302         if (am_server) {
303                 enum msgcode msg = (enum msgcode)code;
304                 if (protocol_version < 30) {
305                         if (msg == MSG_ERROR)
306                                 msg = MSG_ERROR_XFER;
307                         else if (msg == MSG_WARNING)
308                                 msg = MSG_INFO;
309                 }
310                 /* Pass the message to the non-server side. */
311                 if (send_msg(msg, buf, len, !is_utf8))
312                         return;
313                 if (am_daemon) {
314                         /* TODO: can we send the error to the user somehow? */
315                         return;
316                 }
317                 f = stderr;
318         }
319
320 output_msg:
321         switch (code) {
322         case FERROR_XFER:
323                 got_xfer_error = 1;
324                 /* FALL THROUGH */
325         case FERROR:
326         case FWARNING:
327                 f = stderr;
328                 break;
329         case FINFO:
330         case FCLIENT:
331                 break;
332         default:
333                 exit_cleanup(RERR_MESSAGEIO);
334         }
335
336         if (output_needs_newline) {
337                 fputc('\n', f);
338                 output_needs_newline = 0;
339         }
340
341         trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r')
342                           ? buf[--len] : 0;
343
344         if (len && buf[0] == '\r') {
345                 fputc('\r', f);
346                 buf++;
347                 len--;
348         }
349
350 #ifdef ICONV_CONST
351         if (ic != (iconv_t)-1) {
352                 xbuf outbuf, inbuf;
353                 char convbuf[1024];
354                 int ierrno;
355
356                 INIT_CONST_XBUF(outbuf, convbuf);
357                 INIT_XBUF(inbuf, (char*)buf, len, (size_t)-1);
358
359                 while (inbuf.len) {
360                         iconvbufs(ic, &inbuf, &outbuf, 0);
361                         ierrno = errno;
362                         if (outbuf.len) {
363                                 filtered_fwrite(f, convbuf, outbuf.len, 0);
364                                 outbuf.len = 0;
365                         }
366                         if (!ierrno || ierrno == E2BIG)
367                                 continue;
368                         fprintf(f, "\\#%03o", CVAL(inbuf.buf, inbuf.pos++));
369                         inbuf.len--;
370                 }
371         } else
372 #endif
373                 filtered_fwrite(f, buf, len, !allow_8bit_chars);
374
375         if (trailing_CR_or_NL) {
376                 fputc(trailing_CR_or_NL, f);
377                 fflush(f);
378         }
379 }
380
381 /* This is the rsync debugging function. Call it with FINFO, FERROR_*,
382  * FWARNING, FLOG, or FCLIENT. */
383 void rprintf(enum logcode code, const char *format, ...)
384 {
385         va_list ap;
386         char buf[BIGPATHBUFLEN];
387         size_t len;
388
389         va_start(ap, format);
390         len = vsnprintf(buf, sizeof buf, format, ap);
391         va_end(ap);
392
393         /* Deal with buffer overruns.  Instead of panicking, just
394          * truncate the resulting string.  (Note that configure ensures
395          * that we have a vsnprintf() that doesn't ever return -1.) */
396         if (len > sizeof buf - 1) {
397                 static const char ellipsis[] = "[...]";
398
399                 /* Reset length, and zero-terminate the end of our buffer */
400                 len = sizeof buf - 1;
401                 buf[len] = '\0';
402
403                 /* Copy the ellipsis to the end of the string, but give
404                  * us one extra character:
405                  *
406                  *                  v--- null byte at buf[sizeof buf - 1]
407                  *        abcdefghij0
408                  *     -> abcd[...]00  <-- now two null bytes at end
409                  *
410                  * If the input format string has a trailing newline,
411                  * we copy it into that extra null; if it doesn't, well,
412                  * all we lose is one byte.  */
413                 memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis);
414                 if (format[strlen(format)-1] == '\n') {
415                         buf[len-1] = '\n';
416                 }
417         }
418
419         rwrite(code, buf, len, 0);
420 }
421
422 /* This is like rprintf, but it also tries to print some
423  * representation of the error code.  Normally errcode = errno.
424  *
425  * Unlike rprintf, this always adds a newline and there should not be
426  * one in the format string.
427  *
428  * Note that since strerror might involve dynamically loading a
429  * message catalog we need to call it once before chroot-ing. */
430 void rsyserr(enum logcode code, int errcode, const char *format, ...)
431 {
432         va_list ap;
433         char buf[BIGPATHBUFLEN];
434         size_t len;
435
436         strlcpy(buf, RSYNC_NAME ": ", sizeof buf);
437         len = (sizeof RSYNC_NAME ": ") - 1;
438
439         va_start(ap, format);
440         len += vsnprintf(buf + len, sizeof buf - len, format, ap);
441         va_end(ap);
442
443         if (len < sizeof buf) {
444                 len += snprintf(buf + len, sizeof buf - len,
445                                 ": %s (%d)\n", strerror(errcode), errcode);
446         }
447         if (len >= sizeof buf)
448                 exit_cleanup(RERR_MESSAGEIO);
449
450         rwrite(code, buf, len, 0);
451 }
452
453 void rflush(enum logcode code)
454 {
455         FILE *f;
456
457         if (am_daemon || code == FLOG)
458                 return;
459
460         if (!am_server && (code == FINFO || code == FCLIENT))
461                 f = stdout;
462         else
463                 f = stderr;
464
465         fflush(f);
466 }
467
468 /* A generic logging routine for send/recv, with parameter substitiution. */
469 static void log_formatted(enum logcode code, const char *format, const char *op,
470                           struct file_struct *file, const char *fname,
471                           struct stats *initial_stats, int iflags,
472                           const char *hlink)
473 {
474         char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32];
475         char *p, *s, *c;
476         const char *n;
477         size_t len, total;
478         int64 b;
479
480         *fmt = '%';
481
482         /* We expand % codes one by one in place in buf.  We don't
483          * copy in the terminating null of the inserted strings, but
484          * rather keep going until we reach the null of the format. */
485         total = strlcpy(buf, format, sizeof buf);
486         if (total > MAXPATHLEN) {
487                 rprintf(FERROR, "log-format string is WAY too long!\n");
488                 exit_cleanup(RERR_MESSAGEIO);
489         }
490         buf[total++] = '\n';
491         buf[total] = '\0';
492
493         for (p = buf; (p = strchr(p, '%')) != NULL; ) {
494                 s = p++;
495                 c = fmt + 1;
496                 if (*p == '-')
497                         *c++ = *p++;
498                 while (isDigit(p) && c - fmt < (int)(sizeof fmt) - 8)
499                         *c++ = *p++;
500                 if (!*p)
501                         break;
502                 *c = '\0';
503                 n = NULL;
504
505                 switch (*p) {
506                 case 'h':
507                         if (am_daemon)
508                                 n = client_name(0);
509                         break;
510                 case 'a':
511                         if (am_daemon)
512                                 n = client_addr(0);
513                         break;
514                 case 'l':
515                         strlcat(fmt, "s", sizeof fmt);
516                         snprintf(buf2, sizeof buf2, fmt,
517                                  comma_num(F_LENGTH(file)));
518                         n = buf2;
519                         break;
520                 case 'U':
521                         strlcat(fmt, "u", sizeof fmt);
522                         snprintf(buf2, sizeof buf2, fmt,
523                                  uid_ndx ? F_OWNER(file) : 0);
524                         n = buf2;
525                         break;
526                 case 'G':
527                         if (!gid_ndx || file->flags & FLAG_SKIP_GROUP)
528                                 n = "DEFAULT";
529                         else {
530                                 strlcat(fmt, "u", sizeof fmt);
531                                 snprintf(buf2, sizeof buf2, fmt,
532                                          F_GROUP(file));
533                                 n = buf2;
534                         }
535                         break;
536                 case 'p':
537                         strlcat(fmt, "ld", sizeof fmt);
538                         snprintf(buf2, sizeof buf2, fmt,
539                                  (long)getpid());
540                         n = buf2;
541                         break;
542                 case 'M':
543                         n = c = timestring(file->modtime);
544                         while ((c = strchr(c, ' ')) != NULL)
545                                 *c = '-';
546                         break;
547                 case 'B':
548                         c = buf2 + MAXPATHLEN - PERMSTRING_SIZE - 1;
549                         permstring(c, file->mode);
550                         n = c + 1; /* skip the type char */
551                         break;
552                 case 'o':
553                         n = op;
554                         break;
555                 case 'f':
556                         if (fname) {
557                                 c = f_name_buf();
558                                 strlcpy(c, fname, MAXPATHLEN);
559                         } else
560                                 c = f_name(file, NULL);
561                         if (am_sender && F_PATHNAME(file)) {
562                                 pathjoin(buf2, sizeof buf2,
563                                          F_PATHNAME(file), c);
564                                 clean_fname(buf2, 0);
565                                 if (fmt[1]) {
566                                         strlcpy(c, buf2, MAXPATHLEN);
567                                         n = c;
568                                 } else
569                                         n = buf2;
570                         } else if (am_daemon && *c != '/') {
571                                 pathjoin(buf2, sizeof buf2,
572                                          curr_dir + module_dirlen, c);
573                                 clean_fname(buf2, 0);
574                                 if (fmt[1]) {
575                                         strlcpy(c, buf2, MAXPATHLEN);
576                                         n = c;
577                                 } else
578                                         n = buf2;
579                         } else {
580                                 clean_fname(c, 0);
581                                 n = c;
582                         }
583                         if (*n == '/')
584                                 n++;
585                         break;
586                 case 'n':
587                         if (fname) {
588                                 c = f_name_buf();
589                                 strlcpy(c, fname, MAXPATHLEN);
590                         } else
591                                 c = f_name(file, NULL);
592                         if (S_ISDIR(file->mode))
593                                 strlcat(c, "/", MAXPATHLEN);
594                         n = c;
595                         break;
596                 case 'L':
597                         if (hlink && *hlink) {
598                                 n = hlink;
599                                 strlcpy(buf2, " => ", sizeof buf2);
600                         } else if (S_ISLNK(file->mode) && !fname) {
601                                 n = F_SYMLINK(file);
602                                 strlcpy(buf2, " -> ", sizeof buf2);
603                         } else {
604                                 n = "";
605                                 if (!fmt[1])
606                                         break;
607                                 strlcpy(buf2, "    ", sizeof buf2);
608                         }
609                         strlcat(fmt, "s", sizeof fmt);
610                         snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n);
611                         n = buf2;
612                         break;
613                 case 'm':
614                         n = lp_name(module_id);
615                         break;
616                 case 't':
617                         n = timestring(time(NULL));
618                         break;
619                 case 'P':
620                         n = module_dir;
621                         break;
622                 case 'u':
623                         n = auth_user;
624                         break;
625                 case 'b':
626                         if (am_sender) {
627                                 b = stats.total_written -
628                                         initial_stats->total_written;
629                         } else {
630                                 b = stats.total_read -
631                                         initial_stats->total_read;
632                         }
633                         strlcat(fmt, "s", sizeof fmt);
634                         snprintf(buf2, sizeof buf2, fmt, comma_num(b));
635                         n = buf2;
636                         break;
637                 case 'c':
638                         if (!am_sender) {
639                                 b = stats.total_written -
640                                         initial_stats->total_written;
641                         } else {
642                                 b = stats.total_read -
643                                         initial_stats->total_read;
644                         }
645                         strlcat(fmt, "s", sizeof fmt);
646                         snprintf(buf2, sizeof buf2, fmt, comma_num(b));
647                         n = buf2;
648                         break;
649                 case 'C':
650                         if (protocol_version >= 30
651                          && (iflags & ITEM_TRANSFER
652                           || (always_checksum && S_ISREG(file->mode)))) {
653                                 int i, x1, x2;
654                                 const char *sum = iflags & ITEM_TRANSFER
655                                                 ? sender_file_sum : F_SUM(file);
656                                 c = buf2 + checksum_len*2;
657                                 *c = '\0';
658                                 for (i = checksum_len; --i >= 0; ) {
659                                         x1 = CVAL(sum, i);
660                                         x2 = x1 >> 4;
661                                         x1 &= 0xF;
662                                         *--c = x1 <= 9 ? x1 + '0' : x1 + 'a' - 10;
663                                         *--c = x2 <= 9 ? x2 + '0' : x2 + 'a' - 10;
664                                 }
665                         } else {
666                                 memset(buf2, ' ', checksum_len*2);
667                                 buf2[checksum_len*2] = '\0';
668                         }
669                         n = buf2;
670                         break;
671                 case 'i':
672                         if (iflags & ITEM_DELETED) {
673                                 n = "*deleting  ";
674                                 break;
675                         }
676                         n  = c = buf2 + MAXPATHLEN - 32;
677                         c[0] = iflags & ITEM_LOCAL_CHANGE
678                               ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c'
679                              : !(iflags & ITEM_TRANSFER) ? '.'
680                              : !local_server && *op == 's' ? '<' : '>';
681                         if (S_ISLNK(file->mode)) {
682                                 c[1] = 'L';
683                                 c[3] = '.';
684                                 c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
685                                      : !preserve_times || !receiver_symlink_times
686                                     || (iflags & ITEM_REPORT_TIMEFAIL) ? 'T' : 't';
687                         } else {
688                                 c[1] = S_ISDIR(file->mode) ? 'd'
689                                      : IS_SPECIAL(file->mode) ? 'S'
690                                      : IS_DEVICE(file->mode) ? 'D' : 'f';
691                                 c[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's';
692                                 c[4] = !(iflags & ITEM_REPORT_TIME) ? '.'
693                                      : !preserve_times ? 'T' : 't';
694                         }
695                         c[2] = !(iflags & ITEM_REPORT_CHANGE) ? '.' : 'c';
696                         c[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p';
697                         c[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o';
698                         c[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g';
699                         c[8] = !(iflags & ITEM_REPORT_ATIME) ? '.' : 'u';
700                         c[9] = !(iflags & ITEM_REPORT_ACL) ? '.' : 'a';
701                         c[10] = !(iflags & ITEM_REPORT_XATTR) ? '.' : 'x';
702                         c[11] = '\0';
703
704                         if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) {
705                                 char ch = iflags & ITEM_IS_NEW ? '+' : '?';
706                                 int i;
707                                 for (i = 2; c[i]; i++)
708                                         c[i] = ch;
709                         } else if (c[0] == '.' || c[0] == 'h' || c[0] == 'c') {
710                                 int i;
711                                 for (i = 2; c[i]; i++) {
712                                         if (c[i] != '.')
713                                                 break;
714                                 }
715                                 if (!c[i]) {
716                                         for (i = 2; c[i]; i++)
717                                                 c[i] = ' ';
718                                 }
719                         }
720                         break;
721                 }
722
723                 /* "n" is the string to be inserted in place of this % code. */
724                 if (!n)
725                         continue;
726                 if (n != buf2 && fmt[1]) {
727                         strlcat(fmt, "s", sizeof fmt);
728                         snprintf(buf2, sizeof buf2, fmt, n);
729                         n = buf2;
730                 }
731                 len = strlen(n);
732
733                 /* Subtract the length of the escape from the string's size. */
734                 total -= p - s + 1;
735
736                 if (len + total >= (size_t)sizeof buf) {
737                         rprintf(FERROR,
738                                 "buffer overflow expanding %%%c -- exiting\n",
739                                 p[0]);
740                         exit_cleanup(RERR_MESSAGEIO);
741                 }
742
743                 /* Shuffle the rest of the string along to make space for n */
744                 if (len != (size_t)(p - s + 1))
745                         memmove(s + len, p + 1, total - (s - buf) + 1);
746                 total += len;
747
748                 /* Insert the contents of string "n", but NOT its null. */
749                 if (len)
750                         memcpy(s, n, len);
751
752                 /* Skip over inserted string; continue looking */
753                 p = s + len;
754         }
755
756         rwrite(code, buf, total, 0);
757 }
758
759 /* Return 1 if the format escape is in the log-format string (e.g. look for
760  * the 'b' in the "%9b" format escape). */
761 int log_format_has(const char *format, char esc)
762 {
763         const char *p;
764
765         if (!format)
766                 return 0;
767
768         for (p = format; (p = strchr(p, '%')) != NULL; ) {
769                 if (*++p == '-')
770                         p++;
771                 while (isDigit(p))
772                         p++;
773                 if (!*p)
774                         break;
775                 if (*p == esc)
776                         return 1;
777         }
778         return 0;
779 }
780
781 /* Log the transfer of a file.  If the code is FCLIENT, the output just goes
782  * to stdout.  If it is FLOG, it just goes to the log file.  Otherwise we
783  * output to both. */
784 void log_item(enum logcode code, struct file_struct *file,
785               struct stats *initial_stats, int iflags, const char *hlink)
786 {
787         const char *s_or_r = am_sender ? "send" : "recv";
788
789         if (code != FLOG && stdout_format && !am_server) {
790                 log_formatted(FCLIENT, stdout_format, s_or_r,
791                               file, NULL, initial_stats, iflags, hlink);
792         }
793         if (code != FCLIENT && logfile_format && *logfile_format) {
794                 log_formatted(FLOG, logfile_format, s_or_r,
795                               file, NULL, initial_stats, iflags, hlink);
796         }
797 }
798
799 void maybe_log_item(struct file_struct *file, int iflags, int itemizing,
800                     const char *buf)
801 {
802         int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS;
803         int see_item = itemizing && (significant_flags || *buf
804                 || stdout_format_has_i > 1 || (INFO_GTE(NAME, 2) && stdout_format_has_i));
805         int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags;
806         if (am_server) {
807                 if (logfile_name && !dry_run && see_item
808                  && (significant_flags || logfile_format_has_i))
809                         log_item(FLOG, file, &stats, iflags, buf);
810         } else if (see_item || local_change || *buf
811             || (S_ISDIR(file->mode) && significant_flags)) {
812                 enum logcode code = significant_flags || logfile_format_has_i ? FINFO : FCLIENT;
813                 log_item(code, file, &stats, iflags, buf);
814         }
815 }
816
817 void log_delete(const char *fname, int mode)
818 {
819         static struct {
820                 union file_extras ex[4]; /* just in case... */
821                 struct file_struct file;
822         } x;
823         int len = strlen(fname);
824         const char *fmt;
825
826         x.file.mode = mode;
827
828         if (!INFO_GTE(DEL, 1) && !stdout_format)
829                 ;
830         else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) {
831                 if (S_ISDIR(mode))
832                         len++; /* directories include trailing null */
833                 send_msg(MSG_DELETED, fname, len, am_generator);
834         } else {
835                 fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n";
836                 log_formatted(FCLIENT, fmt, "del.", &x.file, fname, &stats,
837                               ITEM_DELETED, NULL);
838         }
839
840         if (!logfile_name || dry_run || !logfile_format)
841                 return;
842
843         fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n";
844         log_formatted(FLOG, fmt, "del.", &x.file, fname, &stats, ITEM_DELETED, NULL);
845 }
846
847 /*
848  * Called when the transfer is interrupted for some reason.
849  *
850  * Code is one of the RERR_* codes from errcode.h, or terminating
851  * successfully.
852  */
853 void log_exit(int code, const char *file, int line)
854 {
855         if (code == 0) {
856                 rprintf(FLOG,"sent %s bytes  received %s bytes  total size %s\n",
857                         comma_num(stats.total_written),
858                         comma_num(stats.total_read),
859                         comma_num(stats.total_size));
860         } else if (am_server != 2) {
861                 const char *name;
862
863                 name = rerr_name(code);
864                 if (!name)
865                         name = "unexplained error";
866
867                 /* VANISHED is not an error, only a warning */
868                 if (code == RERR_VANISHED) {
869                         rprintf(FWARNING, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n",
870                                 name, code, file, line, who_am_i(), RSYNC_VERSION);
871                 } else {
872                         rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n",
873                                 name, code, file, line, who_am_i(), RSYNC_VERSION);
874                 }
875         }
876 }