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