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