Commit | Line | Data |
---|---|---|
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> | |
6 | * Copyright (C) 2003, 2004, 2005, 2006 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 2 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 | * | |
e7c67065 WD |
18 | * You should have received a copy of the GNU General Public License along |
19 | * with this program; if not, write to the Free Software Foundation, Inc., | |
20 | * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. | |
0f78b815 | 21 | */ |
0b76cd63 | 22 | |
0b76cd63 | 23 | #include "rsync.h" |
c8563142 | 24 | #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H |
9a31746b WD |
25 | #include <iconv.h> |
26 | #endif | |
0b76cd63 | 27 | |
41b5b5e7 | 28 | extern int verbose; |
088aff1a | 29 | extern int dry_run; |
548abf96 WD |
30 | extern int am_daemon; |
31 | extern int am_server; | |
32 | extern int am_sender; | |
c1759b9f | 33 | extern int local_server; |
548abf96 WD |
34 | extern int quiet; |
35 | extern int module_id; | |
a644fc3c | 36 | extern int msg_fd_out; |
507433f6 | 37 | extern int allow_8bit_chars; |
19bc826d | 38 | extern int protocol_version; |
ef74f5d6 | 39 | extern int preserve_times; |
b5343510 WD |
40 | extern int stdout_format_has_i; |
41 | extern int stdout_format_has_o_or_i; | |
d0133e6e | 42 | extern int logfile_format_has_i; |
13b597fa | 43 | extern int logfile_format_has_o_or_i; |
c5b7aa15 | 44 | extern mode_t orig_umask; |
548abf96 | 45 | extern char *auth_user; |
b5343510 | 46 | extern char *stdout_format; |
13b597fa WD |
47 | extern char *logfile_format; |
48 | extern char *logfile_name; | |
595251de | 49 | #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H |
9a31746b WD |
50 | extern iconv_t ic_chck; |
51 | #endif | |
6fb7cc38 WD |
52 | extern char curr_dir[]; |
53 | extern unsigned int module_dirlen; | |
548abf96 | 54 | |
ceca8cca | 55 | static int log_initialised; |
64c37826 | 56 | static int logfile_was_closed; |
13b597fa | 57 | static FILE *logfile_fp; |
b35d0d8e | 58 | struct stats stats; |
e0414f42 | 59 | |
8fcdc444 | 60 | int log_got_error = 0; |
af642a61 MP |
61 | |
62 | struct { | |
63 | int code; | |
64 | char const *name; | |
65 | } const rerr_names[] = { | |
4a7319be WD |
66 | { RERR_SYNTAX , "syntax or usage error" }, |
67 | { RERR_PROTOCOL , "protocol incompatibility" }, | |
68 | { RERR_FILESELECT , "errors selecting input/output files, dirs" }, | |
69 | { RERR_UNSUPPORTED, "requested action not supported" }, | |
70 | { RERR_STARTCLIENT, "error starting client-server protocol" }, | |
71 | { RERR_SOCKETIO , "error in socket IO" }, | |
72 | { RERR_FILEIO , "error in file IO" }, | |
73 | { RERR_STREAMIO , "error in rsync protocol data stream" }, | |
74 | { RERR_MESSAGEIO , "errors with program diagnostics" }, | |
75 | { RERR_IPC , "error in IPC code" }, | |
60168410 | 76 | { RERR_CRASHED , "sibling process crashed" }, |
0047f535 | 77 | { RERR_TERMINATED , "sibling process terminated abnormally" }, |
4a50a217 WD |
78 | { RERR_SIGNAL1 , "received SIGUSR1" }, |
79 | { RERR_SIGNAL , "received SIGINT, SIGTERM, or SIGHUP" }, | |
f14a65d9 | 80 | { RERR_WAITCHILD , "waitpid() failed" }, |
4a7319be WD |
81 | { RERR_MALLOC , "error allocating core memory buffers" }, |
82 | { RERR_PARTIAL , "some files could not be transferred" }, | |
584ba4eb | 83 | { RERR_VANISHED , "some files vanished before they could be transferred" }, |
4a7319be | 84 | { RERR_TIMEOUT , "timeout in data send/receive" }, |
19b27a48 AT |
85 | { RERR_CMD_FAILED , "remote shell failed" }, |
86 | { RERR_CMD_KILLED , "remote shell killed" }, | |
24cecf13 WD |
87 | { RERR_CMD_RUN , "remote command could not be run" }, |
88 | { RERR_CMD_NOTFOUND,"remote command not found" }, | |
26718401 | 89 | { RERR_DEL_LIMIT , "the --max-delete limit stopped deletions" }, |
4a7319be | 90 | { 0, NULL } |
af642a61 MP |
91 | }; |
92 | ||
af642a61 MP |
93 | /* |
94 | * Map from rsync error code to name, or return NULL. | |
95 | */ | |
96 | static char const *rerr_name(int code) | |
97 | { | |
4a7319be WD |
98 | int i; |
99 | for (i = 0; rerr_names[i].name; i++) { | |
100 | if (rerr_names[i].code == code) | |
101 | return rerr_names[i].name; | |
102 | } | |
103 | return NULL; | |
af642a61 MP |
104 | } |
105 | ||
4f6325c3 AT |
106 | static void logit(int priority, char *buf) |
107 | { | |
64c37826 WD |
108 | if (logfile_was_closed) |
109 | logfile_reopen(); | |
13b597fa WD |
110 | if (logfile_fp) { |
111 | fprintf(logfile_fp, "%s [%d] %s", | |
f7632fc6 | 112 | timestring(time(NULL)), (int)getpid(), buf); |
13b597fa | 113 | fflush(logfile_fp); |
4f6325c3 AT |
114 | } else { |
115 | syslog(priority, "%s", buf); | |
116 | } | |
117 | } | |
e42c9458 | 118 | |
6afb9077 | 119 | static void syslog_init() |
1a016bfd | 120 | { |
6afb9077 | 121 | static int been_here = 0; |
1a016bfd | 122 | int options = LOG_PID; |
6afb9077 WD |
123 | |
124 | if (been_here) | |
125 | return; | |
126 | been_here = 1; | |
127 | ||
128 | #ifdef LOG_NDELAY | |
129 | options |= LOG_NDELAY; | |
130 | #endif | |
131 | ||
132 | #ifdef LOG_DAEMON | |
04c84119 | 133 | openlog("rsyncd", options, lp_syslog_facility(module_id)); |
6afb9077 WD |
134 | #else |
135 | openlog("rsyncd", options); | |
136 | #endif | |
137 | ||
138 | #ifndef LOG_NDELAY | |
139 | logit(LOG_INFO, "rsyncd started\n"); | |
140 | #endif | |
141 | } | |
142 | ||
64c37826 WD |
143 | static void logfile_open(void) |
144 | { | |
c5b7aa15 | 145 | mode_t old_umask = umask(022 | orig_umask); |
13b597fa | 146 | logfile_fp = fopen(logfile_name, "a"); |
64c37826 | 147 | umask(old_umask); |
13b597fa | 148 | if (!logfile_fp) { |
64c37826 WD |
149 | int fopen_errno = errno; |
150 | /* Rsync falls back to using syslog on failure. */ | |
151 | syslog_init(); | |
152 | rsyserr(FERROR, fopen_errno, | |
13b597fa | 153 | "failed to open log-file %s", logfile_name); |
64c37826 WD |
154 | rprintf(FINFO, "Ignoring \"log file\" setting.\n"); |
155 | } | |
156 | } | |
157 | ||
04c84119 | 158 | void log_init(int restart) |
6afb9077 | 159 | { |
04c84119 WD |
160 | if (log_initialised) { |
161 | if (!restart) | |
162 | return; | |
163 | if (strcmp(logfile_name, lp_log_file(module_id)) != 0) { | |
164 | if (logfile_fp) { | |
165 | fclose(logfile_fp); | |
166 | logfile_fp = NULL; | |
167 | } else | |
168 | closelog(); | |
169 | logfile_name = NULL; | |
170 | } else if (*logfile_name) | |
171 | return; /* unchanged, non-empty "log file" names */ | |
172 | else if (lp_syslog_facility(-1) != lp_syslog_facility(module_id)) | |
173 | closelog(); | |
174 | else | |
175 | return; /* unchanged syslog settings */ | |
176 | } else | |
177 | log_initialised = 1; | |
1a016bfd | 178 | |
38de2866 | 179 | /* This looks pointless, but it is needed in order for the |
4a7319be | 180 | * C library on some systems to fetch the timezone info |
38de2866 WD |
181 | * before the chroot. */ |
182 | timestring(time(NULL)); | |
958f3735 | 183 | |
13b597fa WD |
184 | /* Optionally use a log file instead of syslog. (Non-daemon |
185 | * rsyncs will have already set logfile_name, as needed.) */ | |
186 | if (am_daemon && !logfile_name) | |
04c84119 | 187 | logfile_name = lp_log_file(module_id); |
13b597fa | 188 | if (logfile_name && *logfile_name) |
64c37826 WD |
189 | logfile_open(); |
190 | else | |
191 | syslog_init(); | |
1a016bfd | 192 | } |
1a016bfd | 193 | |
64c37826 | 194 | void logfile_close(void) |
4a239e98 | 195 | { |
13b597fa | 196 | if (logfile_fp) { |
64c37826 | 197 | logfile_was_closed = 1; |
13b597fa WD |
198 | fclose(logfile_fp); |
199 | logfile_fp = NULL; | |
4a239e98 WD |
200 | } |
201 | } | |
202 | ||
64c37826 | 203 | void logfile_reopen(void) |
4a239e98 | 204 | { |
64c37826 WD |
205 | if (logfile_was_closed) { |
206 | logfile_was_closed = 0; | |
207 | logfile_open(); | |
4a239e98 WD |
208 | } |
209 | } | |
210 | ||
3648ab3a | 211 | static void filtered_fwrite(FILE *f, const char *buf, int len, int use_isprint) |
be0602ec WD |
212 | { |
213 | const char *s, *end = buf + len; | |
214 | for (s = buf; s < end; s++) { | |
215 | if ((s < end - 4 | |
3648ab3a | 216 | && *s == '\\' && s[1] == '#' |
2dc7b8bd WD |
217 | && isDigit(s + 2) |
218 | && isDigit(s + 3) | |
219 | && isDigit(s + 4)) | |
3648ab3a | 220 | || (*s != '\t' |
2dc7b8bd | 221 | && ((use_isprint && !isPrint(s)) |
3648ab3a | 222 | || *(uchar*)s < ' '))) { |
be0602ec | 223 | if (s != buf && fwrite(buf, s - buf, 1, f) != 1) |
25f637a3 | 224 | exit_cleanup(RERR_MESSAGEIO); |
3648ab3a | 225 | fprintf(f, "\\#%03o", *(uchar*)s); |
be0602ec WD |
226 | buf = s + 1; |
227 | } | |
228 | } | |
229 | if (buf != end && fwrite(buf, end - buf, 1, f) != 1) | |
25f637a3 | 230 | exit_cleanup(RERR_MESSAGEIO); |
be0602ec WD |
231 | } |
232 | ||
554e0a8d | 233 | /* this is the underlying (unformatted) rsync debugging function. Call |
be0602ec WD |
234 | * it with FINFO, FERROR or FLOG. Note: recursion can happen with |
235 | * certain fatal conditions. */ | |
ff41a59f | 236 | void rwrite(enum logcode code, char *buf, int len) |
0b76cd63 | 237 | { |
be0602ec | 238 | int trailing_CR_or_NL; |
8fcdc444 | 239 | FILE *f = NULL; |
8d9dc9f9 | 240 | |
a644fc3c | 241 | if (len < 0) |
25f637a3 | 242 | exit_cleanup(RERR_MESSAGEIO); |
0b76cd63 | 243 | |
0bb4d176 WD |
244 | if (am_server && msg_fd_out >= 0) { |
245 | /* Pass the message to our sibling. */ | |
246 | send_msg((enum msgcode)code, buf, len); | |
11a5a3c7 AT |
247 | return; |
248 | } | |
249 | ||
b66e31bf WD |
250 | if (code == FSOCKERR) /* This gets simplified for a non-sibling. */ |
251 | code = FERROR; | |
252 | ||
1eec003a WD |
253 | if (code == FCLIENT) |
254 | code = FINFO; | |
d0133e6e | 255 | else if (am_daemon || logfile_name) { |
0bb4d176 | 256 | static int in_block; |
d0133e6e | 257 | char msg[2048]; |
0bb4d176 WD |
258 | int priority = code == FERROR ? LOG_WARNING : LOG_INFO; |
259 | ||
260 | if (in_block) | |
a644fc3c | 261 | return; |
0bb4d176 WD |
262 | in_block = 1; |
263 | if (!log_initialised) | |
04c84119 | 264 | log_init(0); |
0bb4d176 | 265 | strlcpy(msg, buf, MIN((int)sizeof msg, len + 1)); |
d0133e6e | 266 | logit(priority, msg); |
0bb4d176 WD |
267 | in_block = 0; |
268 | ||
13b597fa | 269 | if (code == FLOG || (am_daemon && !am_server)) |
a644fc3c | 270 | return; |
0bb4d176 | 271 | } else if (code == FLOG) |
ff8b29b8 | 272 | return; |
0bb4d176 | 273 | |
b3e8e7c7 WD |
274 | if (quiet && code != FERROR) |
275 | return; | |
276 | ||
0bb4d176 WD |
277 | if (am_server) { |
278 | /* Pass the message to the non-server side. */ | |
f1c9bcd0 | 279 | if (send_msg((enum msgcode)code, buf, len)) |
0bb4d176 WD |
280 | return; |
281 | if (am_daemon) { | |
282 | /* TODO: can we send the error to the user somehow? */ | |
283 | return; | |
284 | } | |
0b76cd63 AT |
285 | } |
286 | ||
be0602ec WD |
287 | switch (code) { |
288 | case FERROR: | |
ff81e809 | 289 | log_got_error = 1; |
ff8b29b8 | 290 | f = stderr; |
be0602ec | 291 | break; |
d0133e6e | 292 | case FINFO: |
be0602ec WD |
293 | f = am_server ? stderr : stdout; |
294 | break; | |
295 | default: | |
25f637a3 | 296 | exit_cleanup(RERR_MESSAGEIO); |
be0602ec | 297 | } |
0b76cd63 | 298 | |
be0602ec WD |
299 | trailing_CR_or_NL = len && (buf[len-1] == '\n' || buf[len-1] == '\r') |
300 | ? buf[--len] : 0; | |
8d9dc9f9 | 301 | |
595251de | 302 | #if defined HAVE_ICONV_OPEN && defined HAVE_ICONV_H |
9a31746b WD |
303 | if (ic_chck != (iconv_t)-1) { |
304 | char convbuf[1024]; | |
305 | char *in_buf = buf, *out_buf = convbuf; | |
306 | size_t in_cnt = len, out_cnt = sizeof convbuf - 1; | |
307 | ||
308 | iconv(ic_chck, NULL, 0, NULL, 0); | |
309 | while (iconv(ic_chck, &in_buf,&in_cnt, | |
310 | &out_buf,&out_cnt) == (size_t)-1) { | |
311 | if (out_buf != convbuf) { | |
3648ab3a | 312 | filtered_fwrite(f, convbuf, out_buf - convbuf, 0); |
9a31746b WD |
313 | out_buf = convbuf; |
314 | out_cnt = sizeof convbuf - 1; | |
315 | } | |
316 | if (errno == E2BIG) | |
317 | continue; | |
3648ab3a | 318 | fprintf(f, "\\#%03o", *(uchar*)in_buf++); |
9a31746b WD |
319 | in_cnt--; |
320 | } | |
321 | if (out_buf != convbuf) | |
3648ab3a | 322 | filtered_fwrite(f, convbuf, out_buf - convbuf, 0); |
9a31746b WD |
323 | } else |
324 | #endif | |
507433f6 | 325 | filtered_fwrite(f, buf, len, !allow_8bit_chars); |
be0602ec WD |
326 | |
327 | if (trailing_CR_or_NL) { | |
328 | fputc(trailing_CR_or_NL, f); | |
0bb4d176 | 329 | fflush(f); |
be0602ec | 330 | } |
0b76cd63 | 331 | } |
0455cd93 | 332 | |
a039749b MP |
333 | /* This is the rsync debugging function. Call it with FINFO, FERROR or |
334 | * FLOG. */ | |
335 | void rprintf(enum logcode code, const char *format, ...) | |
554e0a8d | 336 | { |
4a7319be | 337 | va_list ap; |
b74b3d53 | 338 | char buf[BIGPATHBUFLEN]; |
8fcdc444 | 339 | size_t len; |
554e0a8d AT |
340 | |
341 | va_start(ap, format); | |
ef74f5d6 | 342 | len = vsnprintf(buf, sizeof buf, format, ap); |
554e0a8d AT |
343 | va_end(ap); |
344 | ||
b2f02464 | 345 | /* Deal with buffer overruns. Instead of panicking, just |
8fcdc444 WD |
346 | * truncate the resulting string. (Note that configure ensures |
347 | * that we have a vsnprintf() that doesn't ever return -1.) */ | |
348 | if (len > sizeof buf - 1) { | |
b74b3d53 | 349 | static const char ellipsis[] = "[...]"; |
b2f02464 MP |
350 | |
351 | /* Reset length, and zero-terminate the end of our buffer */ | |
ef74f5d6 | 352 | len = sizeof buf - 1; |
b2f02464 MP |
353 | buf[len] = '\0'; |
354 | ||
355 | /* Copy the ellipsis to the end of the string, but give | |
356 | * us one extra character: | |
357 | * | |
ef74f5d6 | 358 | * v--- null byte at buf[sizeof buf - 1] |
b2f02464 MP |
359 | * abcdefghij0 |
360 | * -> abcd[...]00 <-- now two null bytes at end | |
361 | * | |
362 | * If the input format string has a trailing newline, | |
363 | * we copy it into that extra null; if it doesn't, well, | |
364 | * all we lose is one byte. */ | |
b74b3d53 | 365 | memcpy(buf+len-sizeof ellipsis, ellipsis, sizeof ellipsis); |
b2f02464 MP |
366 | if (format[strlen(format)-1] == '\n') { |
367 | buf[len-1] = '\n'; | |
368 | } | |
369 | } | |
554e0a8d | 370 | |
ff41a59f | 371 | rwrite(code, buf, len); |
554e0a8d | 372 | } |
0b76cd63 | 373 | |
a039749b MP |
374 | /* This is like rprintf, but it also tries to print some |
375 | * representation of the error code. Normally errcode = errno. | |
376 | * | |
377 | * Unlike rprintf, this always adds a newline and there should not be | |
378 | * one in the format string. | |
379 | * | |
380 | * Note that since strerror might involve dynamically loading a | |
381 | * message catalog we need to call it once before chroot-ing. */ | |
382 | void rsyserr(enum logcode code, int errcode, const char *format, ...) | |
383 | { | |
4a7319be | 384 | va_list ap; |
b74b3d53 | 385 | char buf[BIGPATHBUFLEN]; |
8fcdc444 WD |
386 | size_t len; |
387 | ||
c9bce0b8 | 388 | strlcpy(buf, RSYNC_NAME ": ", sizeof buf); |
8fcdc444 | 389 | len = (sizeof RSYNC_NAME ": ") - 1; |
a039749b MP |
390 | |
391 | va_start(ap, format); | |
8fcdc444 | 392 | len += vsnprintf(buf + len, sizeof buf - len, format, ap); |
a039749b MP |
393 | va_end(ap); |
394 | ||
8fcdc444 WD |
395 | if (len < sizeof buf) { |
396 | len += snprintf(buf + len, sizeof buf - len, | |
397 | ": %s (%d)\n", strerror(errcode), errcode); | |
398 | } | |
399 | if (len >= sizeof buf) | |
25f637a3 | 400 | exit_cleanup(RERR_MESSAGEIO); |
a039749b | 401 | |
a039749b MP |
402 | rwrite(code, buf, len); |
403 | } | |
404 | ||
ff41a59f | 405 | void rflush(enum logcode code) |
0b76cd63 AT |
406 | { |
407 | FILE *f = NULL; | |
0455cd93 | 408 | |
13b597fa | 409 | if (am_daemon || code == FLOG) |
0b76cd63 | 410 | return; |
0b76cd63 | 411 | |
13b597fa | 412 | if (code == FERROR || am_server) |
0b76cd63 | 413 | f = stderr; |
13b597fa WD |
414 | else |
415 | f = stdout; | |
0b76cd63 | 416 | |
0b76cd63 AT |
417 | fflush(f); |
418 | } | |
419 | ||
b5343510 | 420 | /* A generic logging routine for send/recv, with parameter substitiution. */ |
afc65a5a WD |
421 | static void log_formatted(enum logcode code, char *format, char *op, |
422 | struct file_struct *file, struct stats *initial_stats, | |
423 | int iflags, char *hlink) | |
e08bfe12 | 424 | { |
ddd74b67 WD |
425 | char buf[MAXPATHLEN+1024], buf2[MAXPATHLEN], fmt[32]; |
426 | char *p, *s, *n; | |
ef74f5d6 | 427 | size_t len, total; |
1b7c47cb | 428 | int64 b; |
e08bfe12 | 429 | |
ddd74b67 WD |
430 | *fmt = '%'; |
431 | ||
aa126974 | 432 | /* We expand % codes one by one in place in buf. We don't |
126e7aff WD |
433 | * copy in the terminating null of the inserted strings, but |
434 | * rather keep going until we reach the null of the format. */ | |
ef74f5d6 | 435 | total = strlcpy(buf, format, sizeof buf); |
d9c0051f WD |
436 | if (total > MAXPATHLEN) { |
437 | rprintf(FERROR, "log-format string is WAY too long!\n"); | |
25f637a3 | 438 | exit_cleanup(RERR_MESSAGEIO); |
d9c0051f WD |
439 | } |
440 | buf[total++] = '\n'; | |
441 | buf[total] = '\0'; | |
0455cd93 | 442 | |
16f960fe | 443 | for (p = buf; (p = strchr(p, '%')) != NULL; ) { |
ddd74b67 WD |
444 | s = p++; |
445 | n = fmt + 1; | |
9baed760 WD |
446 | if (*p == '-') |
447 | *n++ = *p++; | |
2dc7b8bd | 448 | while (isDigit(p) && n - fmt < (int)(sizeof fmt) - 8) |
ddd74b67 | 449 | *n++ = *p++; |
e145d51b WD |
450 | if (!*p) |
451 | break; | |
ddd74b67 | 452 | *n = '\0'; |
e08bfe12 | 453 | n = NULL; |
e08bfe12 | 454 | |
0455cd93 | 455 | switch (*p) { |
b74b3d53 WD |
456 | case 'h': |
457 | if (am_daemon) | |
458 | n = client_name(0); | |
459 | break; | |
460 | case 'a': | |
461 | if (am_daemon) | |
462 | n = client_addr(0); | |
463 | break; | |
4a7319be | 464 | case 'l': |
ddd74b67 WD |
465 | strlcat(fmt, ".0f", sizeof fmt); |
466 | snprintf(buf2, sizeof buf2, fmt, | |
4a7319be | 467 | (double)file->length); |
e08bfe12 AT |
468 | n = buf2; |
469 | break; | |
427b6179 WD |
470 | case 'U': |
471 | strlcat(fmt, "ld", sizeof fmt); | |
472 | snprintf(buf2, sizeof buf2, fmt, | |
473 | (long)file->uid); | |
474 | n = buf2; | |
475 | break; | |
476 | case 'G': | |
998113fe WD |
477 | if (file->gid == GID_NONE) |
478 | n = "DEFAULT"; | |
479 | else { | |
480 | strlcat(fmt, "ld", sizeof fmt); | |
481 | snprintf(buf2, sizeof buf2, fmt, | |
482 | (long)file->gid); | |
483 | n = buf2; | |
484 | } | |
427b6179 | 485 | break; |
4a7319be | 486 | case 'p': |
126e7aff | 487 | strlcat(fmt, "ld", sizeof fmt); |
ddd74b67 | 488 | snprintf(buf2, sizeof buf2, fmt, |
126e7aff | 489 | (long)getpid()); |
e08bfe12 AT |
490 | n = buf2; |
491 | break; | |
427b6179 WD |
492 | case 'M': |
493 | n = timestring(file->modtime); | |
494 | { | |
998113fe WD |
495 | char *cp = n; |
496 | while ((cp = strchr(cp, ' ')) != NULL) | |
427b6179 WD |
497 | *cp = '-'; |
498 | } | |
499 | break; | |
500 | case 'B': | |
501 | n = buf2 + MAXPATHLEN - PERMSTRING_SIZE; | |
502 | permstring(n - 1, file->mode); /* skip the type char */ | |
503 | break; | |
b74b3d53 WD |
504 | case 'o': |
505 | n = op; | |
506 | break; | |
4a7319be | 507 | case 'f': |
be0602ec | 508 | n = f_name(file, NULL); |
9baed760 WD |
509 | if (am_sender && file->dir.root) { |
510 | pathjoin(buf2, sizeof buf2, | |
511 | file->dir.root, n); | |
0ee6ca98 | 512 | clean_fname(buf2, 0); |
dcbae654 | 513 | if (fmt[1]) |
0ee6ca98 | 514 | strlcpy(n, buf2, MAXPATHLEN); |
dcbae654 WD |
515 | else |
516 | n = buf2; | |
ec55b4f2 WD |
517 | } else if (*n != '/') { |
518 | pathjoin(buf2, sizeof buf2, | |
519 | curr_dir + module_dirlen, n); | |
520 | clean_fname(buf2, 0); | |
521 | if (fmt[1]) | |
522 | strlcpy(n, buf2, MAXPATHLEN); | |
523 | else | |
524 | n = buf2; | |
525 | } else | |
526 | clean_fname(n, 0); | |
9baed760 WD |
527 | if (*n == '/') |
528 | n++; | |
ab7104da | 529 | break; |
ef74f5d6 | 530 | case 'n': |
be0602ec | 531 | n = f_name(file, NULL); |
0ee6ca98 WD |
532 | if (S_ISDIR(file->mode)) |
533 | strlcat(n, "/", MAXPATHLEN); | |
ef74f5d6 WD |
534 | break; |
535 | case 'L': | |
afc65a5a | 536 | if (hlink && *hlink) { |
0ee6ca98 | 537 | n = hlink; |
c9bce0b8 | 538 | strlcpy(buf2, " => ", sizeof buf2); |
afc65a5a | 539 | } else if (S_ISLNK(file->mode) && file->u.link) { |
0ee6ca98 | 540 | n = file->u.link; |
c9bce0b8 | 541 | strlcpy(buf2, " -> ", sizeof buf2); |
126e7aff | 542 | } else { |
ef74f5d6 | 543 | n = ""; |
126e7aff WD |
544 | if (!fmt[1]) |
545 | break; | |
c9bce0b8 | 546 | strlcpy(buf2, " ", sizeof buf2); |
126e7aff WD |
547 | } |
548 | strlcat(fmt, "s", sizeof fmt); | |
549 | snprintf(buf2 + 4, sizeof buf2 - 4, fmt, n); | |
550 | n = buf2; | |
ef74f5d6 | 551 | break; |
b74b3d53 WD |
552 | case 'm': |
553 | n = lp_name(module_id); | |
554 | break; | |
555 | case 't': | |
556 | n = timestring(time(NULL)); | |
557 | break; | |
558 | case 'P': | |
559 | n = lp_path(module_id); | |
560 | break; | |
561 | case 'u': | |
562 | n = auth_user; | |
563 | break; | |
4a7319be | 564 | case 'b': |
1b7c47cb | 565 | if (am_sender) { |
4a7319be | 566 | b = stats.total_written - |
1b7c47cb AT |
567 | initial_stats->total_written; |
568 | } else { | |
4a7319be | 569 | b = stats.total_read - |
1b7c47cb AT |
570 | initial_stats->total_read; |
571 | } | |
0455cd93 | 572 | strlcat(fmt, ".0f", sizeof fmt); |
ddd74b67 | 573 | snprintf(buf2, sizeof buf2, fmt, (double)b); |
1b7c47cb AT |
574 | n = buf2; |
575 | break; | |
4a7319be | 576 | case 'c': |
1b7c47cb | 577 | if (!am_sender) { |
4a7319be | 578 | b = stats.total_written - |
1b7c47cb AT |
579 | initial_stats->total_written; |
580 | } else { | |
4a7319be | 581 | b = stats.total_read - |
1b7c47cb AT |
582 | initial_stats->total_read; |
583 | } | |
0455cd93 | 584 | strlcat(fmt, ".0f", sizeof fmt); |
ddd74b67 | 585 | snprintf(buf2, sizeof buf2, fmt, (double)b); |
1b7c47cb AT |
586 | n = buf2; |
587 | break; | |
ef74f5d6 | 588 | case 'i': |
19bc826d | 589 | if (iflags & ITEM_DELETED) { |
d5609e96 | 590 | n = "*deleting"; |
19bc826d WD |
591 | break; |
592 | } | |
b4bf2b5a | 593 | n = buf2 + MAXPATHLEN - 32; |
fd84673e WD |
594 | n[0] = iflags & ITEM_LOCAL_CHANGE |
595 | ? iflags & ITEM_XNAME_FOLLOWS ? 'h' : 'c' | |
ca62acc3 | 596 | : !(iflags & ITEM_TRANSFER) ? '.' |
c1759b9f | 597 | : !local_server && *op == 's' ? '<' : '>'; |
19bc826d | 598 | n[1] = S_ISDIR(file->mode) ? 'd' |
f8d47c1c | 599 | : IS_SPECIAL(file->mode) ? 'S' |
19bc826d | 600 | : IS_DEVICE(file->mode) ? 'D' |
ef74f5d6 | 601 | : S_ISLNK(file->mode) ? 'L' : 'f'; |
d4e01963 WD |
602 | n[2] = !(iflags & ITEM_REPORT_CHECKSUM) ? '.' : 'c'; |
603 | n[3] = !(iflags & ITEM_REPORT_SIZE) ? '.' : 's'; | |
604 | n[4] = !(iflags & ITEM_REPORT_TIME) ? '.' | |
4cff7c50 | 605 | : !preserve_times || S_ISLNK(file->mode) ? 'T' : 't'; |
d4e01963 WD |
606 | n[5] = !(iflags & ITEM_REPORT_PERMS) ? '.' : 'p'; |
607 | n[6] = !(iflags & ITEM_REPORT_OWNER) ? '.' : 'o'; | |
608 | n[7] = !(iflags & ITEM_REPORT_GROUP) ? '.' : 'g'; | |
503f1634 WD |
609 | n[8] = '.'; |
610 | n[9] = '\0'; | |
ef74f5d6 WD |
611 | |
612 | if (iflags & (ITEM_IS_NEW|ITEM_MISSING_DATA)) { | |
613 | char ch = iflags & ITEM_IS_NEW ? '+' : '?'; | |
614 | int i; | |
615 | for (i = 2; n[i]; i++) | |
616 | n[i] = ch; | |
45760f5f | 617 | } else if (n[0] == '.' || n[0] == 'h' || n[0] == 'c') { |
19bc826d WD |
618 | int i; |
619 | for (i = 2; n[i]; i++) { | |
620 | if (n[i] != '.') | |
621 | break; | |
622 | } | |
623 | if (!n[i]) { | |
624 | for (i = 2; n[i]; i++) | |
625 | n[i] = ' '; | |
19bc826d | 626 | } |
ef74f5d6 WD |
627 | } |
628 | break; | |
e08bfe12 AT |
629 | } |
630 | ||
ddd74b67 WD |
631 | /* "n" is the string to be inserted in place of this % code. */ |
632 | if (!n) | |
633 | continue; | |
9baed760 WD |
634 | if (n != buf2 && fmt[1]) { |
635 | strlcat(fmt, "s", sizeof fmt); | |
636 | snprintf(buf2, sizeof buf2, fmt, n); | |
637 | n = buf2; | |
638 | } | |
ef74f5d6 | 639 | len = strlen(n); |
e08bfe12 | 640 | |
e145d51b | 641 | /* Subtract the length of the escape from the string's size. */ |
0455cd93 | 642 | total -= p - s + 1; |
e145d51b | 643 | |
d9c0051f | 644 | if (len + total >= (size_t)sizeof buf) { |
1e7098b5 WD |
645 | rprintf(FERROR, |
646 | "buffer overflow expanding %%%c -- exiting\n", | |
0455cd93 | 647 | p[0]); |
25f637a3 | 648 | exit_cleanup(RERR_MESSAGEIO); |
e08bfe12 AT |
649 | } |
650 | ||
aa126974 | 651 | /* Shuffle the rest of the string along to make space for n */ |
0455cd93 WD |
652 | if (len != (size_t)(p - s + 1)) |
653 | memmove(s + len, p + 1, total - (s - buf) + 1); | |
ddd74b67 | 654 | total += len; |
aa126974 | 655 | |
ddd74b67 | 656 | /* Insert the contents of string "n", but NOT its null. */ |
ef74f5d6 | 657 | if (len) |
ddd74b67 | 658 | memcpy(s, n, len); |
e08bfe12 | 659 | |
aa126974 | 660 | /* Skip over inserted string; continue looking */ |
ddd74b67 | 661 | p = s + len; |
e08bfe12 AT |
662 | } |
663 | ||
d9c0051f | 664 | rwrite(code, buf, total); |
e08bfe12 AT |
665 | } |
666 | ||
0455cd93 WD |
667 | /* Return 1 if the format escape is in the log-format string (e.g. look for |
668 | * the 'b' in the "%9b" format escape). */ | |
16f960fe WD |
669 | int log_format_has(const char *format, char esc) |
670 | { | |
671 | const char *p; | |
672 | ||
673 | if (!format) | |
674 | return 0; | |
675 | ||
676 | for (p = format; (p = strchr(p, '%')) != NULL; ) { | |
677 | if (*++p == '-') | |
678 | p++; | |
2dc7b8bd | 679 | while (isDigit(p)) |
16f960fe WD |
680 | p++; |
681 | if (!*p) | |
682 | break; | |
683 | if (*p == esc) | |
684 | return 1; | |
685 | } | |
686 | return 0; | |
687 | } | |
688 | ||
d0133e6e | 689 | /* Log the transfer of a file. If the code is FCLIENT, the output just goes |
b5343510 WD |
690 | * to stdout. If it is FLOG, it just goes to the log file. Otherwise we |
691 | * output to both. */ | |
692 | void log_item(enum logcode code, struct file_struct *file, | |
693 | struct stats *initial_stats, int iflags, char *hlink) | |
11a5a3c7 | 694 | { |
afc65a5a | 695 | char *s_or_r = am_sender ? "send" : "recv"; |
11a5a3c7 | 696 | |
b5343510 | 697 | if (code != FLOG && stdout_format && !am_server) { |
d0133e6e | 698 | log_formatted(FCLIENT, stdout_format, s_or_r, |
afc65a5a | 699 | file, initial_stats, iflags, hlink); |
b5343510 | 700 | } |
d0133e6e | 701 | if (code != FCLIENT && logfile_format && *logfile_format) { |
13b597fa WD |
702 | log_formatted(FLOG, logfile_format, s_or_r, |
703 | file, initial_stats, iflags, hlink); | |
11a5a3c7 AT |
704 | } |
705 | } | |
706 | ||
1c3e3679 WD |
707 | void maybe_log_item(struct file_struct *file, int iflags, int itemizing, |
708 | char *buf) | |
709 | { | |
f2b6fe44 | 710 | int significant_flags = iflags & SIGNIFICANT_ITEM_FLAGS; |
6d4ecad1 | 711 | int see_item = itemizing && (significant_flags || *buf |
b5343510 | 712 | || stdout_format_has_i > 1 || (verbose > 1 && stdout_format_has_i)); |
6d4ecad1 | 713 | int local_change = iflags & ITEM_LOCAL_CHANGE && significant_flags; |
1c3e3679 | 714 | if (am_server) { |
d0133e6e WD |
715 | if (logfile_name && !dry_run && see_item |
716 | && (significant_flags || logfile_format_has_i)) | |
b5343510 | 717 | log_item(FLOG, file, &stats, iflags, buf); |
f2b6fe44 | 718 | } else if (see_item || local_change || *buf |
d0133e6e WD |
719 | || (S_ISDIR(file->mode) && significant_flags)) { |
720 | enum logcode code = significant_flags || logfile_format_has_i ? FINFO : FCLIENT; | |
721 | log_item(code, file, &stats, iflags, buf); | |
722 | } | |
1c3e3679 WD |
723 | } |
724 | ||
19bc826d WD |
725 | void log_delete(char *fname, int mode) |
726 | { | |
727 | static struct file_struct file; | |
728 | int len = strlen(fname); | |
19bc826d WD |
729 | char *fmt; |
730 | ||
731 | file.mode = mode; | |
732 | file.basename = fname; | |
733 | ||
b5343510 | 734 | if (!verbose && !stdout_format) |
41b5b5e7 WD |
735 | ; |
736 | else if (am_server && protocol_version >= 29 && len < MAXPATHLEN) { | |
19bc826d WD |
737 | if (S_ISDIR(mode)) |
738 | len++; /* directories include trailing null */ | |
739 | send_msg(MSG_DELETED, fname, len); | |
19bc826d | 740 | } else { |
b5343510 | 741 | fmt = stdout_format_has_o_or_i ? stdout_format : "deleting %n"; |
afc65a5a WD |
742 | log_formatted(FCLIENT, fmt, "del.", &file, &stats, |
743 | ITEM_DELETED, NULL); | |
19bc826d WD |
744 | } |
745 | ||
13b597fa | 746 | if (!logfile_name || dry_run || !logfile_format) |
1eec003a WD |
747 | return; |
748 | ||
13b597fa | 749 | fmt = logfile_format_has_o_or_i ? logfile_format : "deleting %n"; |
afc65a5a | 750 | log_formatted(FLOG, fmt, "del.", &file, &stats, ITEM_DELETED, NULL); |
19bc826d | 751 | } |
af642a61 | 752 | |
af642a61 MP |
753 | /* |
754 | * Called when the transfer is interrupted for some reason. | |
755 | * | |
756 | * Code is one of the RERR_* codes from errcode.h, or terminating | |
757 | * successfully. | |
758 | */ | |
a9766ef1 | 759 | void log_exit(int code, const char *file, int line) |
9b73d1c0 AT |
760 | { |
761 | if (code == 0) { | |
088aff1a | 762 | rprintf(FLOG,"sent %.0f bytes received %.0f bytes total size %.0f\n", |
9b73d1c0 AT |
763 | (double)stats.total_written, |
764 | (double)stats.total_read, | |
765 | (double)stats.total_size); | |
766 | } else { | |
4a7319be WD |
767 | const char *name; |
768 | ||
769 | name = rerr_name(code); | |
770 | if (!name) | |
771 | name = "unexplained error"; | |
af642a61 | 772 | |
1bca1de6 WD |
773 | /* VANISHED is not an error, only a warning */ |
774 | if (code == RERR_VANISHED) { | |
0f78b815 | 775 | rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d) [%s=%s]\n", |
43eae40e | 776 | name, code, file, line, who_am_i(), RSYNC_VERSION); |
1bca1de6 | 777 | } else { |
43eae40e WD |
778 | rprintf(FERROR, "rsync error: %s (code %d) at %s(%d) [%s=%s]\n", |
779 | name, code, file, line, who_am_i(), RSYNC_VERSION); | |
1bca1de6 | 780 | } |
9b73d1c0 AT |
781 | } |
782 | } |