Commit | Line | Data |
---|---|---|
a039749b | 1 | /* -*- c-file-style: "linux"; -*- |
4a7319be | 2 | |
0c5a792a | 3 | Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org> |
18c71e96 | 4 | Copyright (C) 2000-2001 by Martin Pool <mbp@samba.org> |
4a7319be | 5 | |
0b76cd63 AT |
6 | This program is free software; you can redistribute it and/or modify |
7 | it under the terms of the GNU General Public License as published by | |
8 | the Free Software Foundation; either version 2 of the License, or | |
9 | (at your option) any later version. | |
4a7319be | 10 | |
0b76cd63 AT |
11 | This program is distributed in the hope that it will be useful, |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
4a7319be | 15 | |
0b76cd63 AT |
16 | You should have received a copy of the GNU General Public License |
17 | along with this program; if not, write to the Free Software | |
18 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
19 | */ | |
20 | ||
21 | /* | |
3e3dcd62 | 22 | Logging and utility functions. |
0c5a792a | 23 | tridge, May 1998 |
0b76cd63 | 24 | |
3e3dcd62 MP |
25 | Mapping to human-readable messages added by Martin Pool |
26 | <mbp@samba.org>, Oct 2000. | |
0b76cd63 AT |
27 | */ |
28 | #include "rsync.h" | |
29 | ||
548abf96 WD |
30 | extern int am_daemon; |
31 | extern int am_server; | |
32 | extern int am_sender; | |
33 | extern int quiet; | |
34 | extern int module_id; | |
a644fc3c | 35 | extern int msg_fd_out; |
548abf96 WD |
36 | extern char *auth_user; |
37 | extern char *log_format; | |
38 | ||
30e8c8e1 | 39 | static int log_initialised; |
45a83540 | 40 | static char *logfname; |
4f6325c3 | 41 | static FILE *logfile; |
b35d0d8e | 42 | struct stats stats; |
e0414f42 | 43 | |
ff81e809 | 44 | int log_got_error=0; |
af642a61 MP |
45 | |
46 | struct { | |
47 | int code; | |
48 | char const *name; | |
49 | } const rerr_names[] = { | |
4a7319be WD |
50 | { RERR_SYNTAX , "syntax or usage error" }, |
51 | { RERR_PROTOCOL , "protocol incompatibility" }, | |
52 | { RERR_FILESELECT , "errors selecting input/output files, dirs" }, | |
53 | { RERR_UNSUPPORTED, "requested action not supported" }, | |
54 | { RERR_STARTCLIENT, "error starting client-server protocol" }, | |
55 | { RERR_SOCKETIO , "error in socket IO" }, | |
56 | { RERR_FILEIO , "error in file IO" }, | |
57 | { RERR_STREAMIO , "error in rsync protocol data stream" }, | |
58 | { RERR_MESSAGEIO , "errors with program diagnostics" }, | |
59 | { RERR_IPC , "error in IPC code" }, | |
60 | { RERR_SIGNAL , "received SIGUSR1 or SIGINT" }, | |
61 | { RERR_WAITCHILD , "some error returned by waitpid()" }, | |
62 | { RERR_MALLOC , "error allocating core memory buffers" }, | |
63 | { RERR_PARTIAL , "some files could not be transferred" }, | |
1bca1de6 | 64 | { RERR_VANISHED , "some files vanished before they could be transfered" }, |
4a7319be | 65 | { RERR_TIMEOUT , "timeout in data send/receive" }, |
19b27a48 AT |
66 | { RERR_CMD_FAILED , "remote shell failed" }, |
67 | { RERR_CMD_KILLED , "remote shell killed" }, | |
68 | { RERR_CMD_RUN, "remote command could not be run" }, | |
4a7319be WD |
69 | { RERR_CMD_NOTFOUND, "remote command not found" }, |
70 | { 0, NULL } | |
af642a61 MP |
71 | }; |
72 | ||
73 | ||
74 | ||
75 | /* | |
76 | * Map from rsync error code to name, or return NULL. | |
77 | */ | |
78 | static char const *rerr_name(int code) | |
79 | { | |
4a7319be WD |
80 | int i; |
81 | for (i = 0; rerr_names[i].name; i++) { | |
82 | if (rerr_names[i].code == code) | |
83 | return rerr_names[i].name; | |
84 | } | |
85 | return NULL; | |
af642a61 MP |
86 | } |
87 | ||
88 | ||
4f6325c3 AT |
89 | static void logit(int priority, char *buf) |
90 | { | |
45a83540 | 91 | if (logfname) { |
15b84e14 DD |
92 | if (!logfile) |
93 | log_open(); | |
4a7319be | 94 | fprintf(logfile,"%s [%d] %s", |
f7632fc6 | 95 | timestring(time(NULL)), (int)getpid(), buf); |
4f6325c3 AT |
96 | fflush(logfile); |
97 | } else { | |
98 | syslog(priority, "%s", buf); | |
99 | } | |
100 | } | |
e42c9458 | 101 | |
45a83540 | 102 | void log_init(void) |
1a016bfd | 103 | { |
1a016bfd | 104 | int options = LOG_PID; |
bcf5b133 | 105 | time_t t; |
1a016bfd | 106 | |
30e8c8e1 DD |
107 | if (log_initialised) return; |
108 | log_initialised = 1; | |
1a016bfd | 109 | |
958f3735 | 110 | /* this looks pointless, but it is needed in order for the |
4a7319be WD |
111 | * C library on some systems to fetch the timezone info |
112 | * before the chroot */ | |
958f3735 AT |
113 | t = time(NULL); |
114 | localtime(&t); | |
115 | ||
116 | /* optionally use a log file instead of syslog */ | |
45a83540 DD |
117 | logfname = lp_log_file(); |
118 | if (logfname) { | |
15b84e14 DD |
119 | if (*logfname) { |
120 | log_open(); | |
45a83540 | 121 | return; |
15b84e14 | 122 | } |
45a83540 | 123 | logfname = NULL; |
4f6325c3 AT |
124 | } |
125 | ||
1a016bfd AT |
126 | #ifdef LOG_NDELAY |
127 | options |= LOG_NDELAY; | |
128 | #endif | |
129 | ||
130 | #ifdef LOG_DAEMON | |
131 | openlog("rsyncd", options, lp_syslog_facility()); | |
132 | #else | |
133 | openlog("rsyncd", options); | |
134 | #endif | |
135 | ||
136 | #ifndef LOG_NDELAY | |
4f6325c3 | 137 | logit(LOG_INFO,"rsyncd started\n"); |
1a016bfd AT |
138 | #endif |
139 | } | |
1a016bfd | 140 | |
1e34e4b7 | 141 | void log_open(void) |
15b84e14 DD |
142 | { |
143 | if (logfname && !logfile) { | |
144 | extern int orig_umask; | |
145 | int old_umask = umask(022 | orig_umask); | |
146 | logfile = fopen(logfname, "a"); | |
147 | umask(old_umask); | |
148 | } | |
149 | } | |
150 | ||
1e34e4b7 | 151 | void log_close(void) |
45a83540 DD |
152 | { |
153 | if (logfile) { | |
154 | fclose(logfile); | |
155 | logfile = NULL; | |
156 | } | |
157 | } | |
158 | ||
554e0a8d | 159 | /* this is the underlying (unformatted) rsync debugging function. Call |
4a7319be | 160 | * it with FINFO, FERROR or FLOG */ |
ff41a59f | 161 | void rwrite(enum logcode code, char *buf, int len) |
0b76cd63 | 162 | { |
0b76cd63 | 163 | FILE *f=NULL; |
8d9dc9f9 | 164 | /* recursion can happen with certain fatal conditions */ |
8d9dc9f9 | 165 | |
a644fc3c WD |
166 | if (quiet && code == FINFO) |
167 | return; | |
b86f0cef | 168 | |
a644fc3c WD |
169 | if (len < 0) |
170 | exit_cleanup(RERR_MESSAGEIO); | |
0b76cd63 | 171 | |
ff8b29b8 AT |
172 | buf[len] = 0; |
173 | ||
ff41a59f | 174 | if (code == FLOG) { |
11a5a3c7 | 175 | if (am_daemon) logit(LOG_INFO, buf); |
11a5a3c7 AT |
176 | return; |
177 | } | |
178 | ||
a644fc3c WD |
179 | if (am_server) { |
180 | /* Pass it to non-server side, perhaps through our sibling. */ | |
181 | if (msg_fd_out >= 0) { | |
182 | send_msg((enum msgcode)code, buf, len); | |
183 | return; | |
184 | } | |
185 | if (io_multiplex_write((enum msgcode)code, buf, len)) | |
186 | return; | |
6d7b6081 | 187 | } |
ff41a59f | 188 | |
30e8c8e1 DD |
189 | /* otherwise, if in daemon mode and either we are not a server |
190 | * (that is, we are not running --daemon over a remote shell) or | |
191 | * the log has already been initialised, log the message on this | |
192 | * side because we don't want the client to see most errors for | |
193 | * security reasons. We do want early messages when running daemon | |
194 | * mode over a remote shell to go to the remote side; those will | |
b45b059a DD |
195 | * fall through to the next case. |
196 | * Note that this is only for the time before multiplexing is enabled. | |
197 | */ | |
30e8c8e1 | 198 | if (am_daemon && (!am_server || log_initialised)) { |
b24203b3 | 199 | static int depth; |
ff8b29b8 | 200 | int priority = LOG_INFO; |
ff41a59f | 201 | if (code == FERROR) priority = LOG_WARNING; |
45ccc5c0 | 202 | |
b24203b3 AT |
203 | if (depth) return; |
204 | ||
f27b53f5 AT |
205 | depth++; |
206 | ||
45a83540 | 207 | log_init(); |
6d7b6081 | 208 | logit(priority, buf); |
8d9dc9f9 AT |
209 | |
210 | depth--; | |
ff8b29b8 | 211 | return; |
0b76cd63 AT |
212 | } |
213 | ||
ff41a59f | 214 | if (code == FERROR) { |
ff81e809 | 215 | log_got_error = 1; |
ff8b29b8 | 216 | f = stderr; |
4a7319be | 217 | } |
ff8b29b8 | 218 | |
ff41a59f | 219 | if (code == FINFO) { |
4a7319be | 220 | if (am_server) |
ff8b29b8 AT |
221 | f = stderr; |
222 | else | |
223 | f = stdout; | |
4a7319be | 224 | } |
ff8b29b8 | 225 | |
65417579 | 226 | if (!f) exit_cleanup(RERR_MESSAGEIO); |
0b76cd63 | 227 | |
65417579 | 228 | if (fwrite(buf, len, 1, f) != 1) exit_cleanup(RERR_MESSAGEIO); |
8d9dc9f9 | 229 | |
bcf5b133 | 230 | if (buf[len-1] == '\r' || buf[len-1] == '\n') fflush(f); |
0b76cd63 | 231 | } |
554e0a8d AT |
232 | |
233 | ||
a039749b MP |
234 | /* This is the rsync debugging function. Call it with FINFO, FERROR or |
235 | * FLOG. */ | |
236 | void rprintf(enum logcode code, const char *format, ...) | |
554e0a8d | 237 | { |
4a7319be | 238 | va_list ap; |
554e0a8d AT |
239 | char buf[1024]; |
240 | int len; | |
241 | ||
242 | va_start(ap, format); | |
59ee743c | 243 | /* Note: might return -1 */ |
8950ac03 | 244 | len = vsnprintf(buf, sizeof(buf), format, ap); |
554e0a8d AT |
245 | va_end(ap); |
246 | ||
b2f02464 MP |
247 | /* Deal with buffer overruns. Instead of panicking, just |
248 | * truncate the resulting string. Note that some vsnprintf()s | |
249 | * return -1 on truncation, e.g., glibc 2.0.6 and earlier. */ | |
59ee743c | 250 | if ((size_t) len > sizeof(buf)-1 || len < 0) { |
b2f02464 MP |
251 | const char ellipsis[] = "[...]"; |
252 | ||
253 | /* Reset length, and zero-terminate the end of our buffer */ | |
254 | len = sizeof(buf)-1; | |
255 | buf[len] = '\0'; | |
256 | ||
257 | /* Copy the ellipsis to the end of the string, but give | |
258 | * us one extra character: | |
259 | * | |
260 | * v--- null byte at buf[sizeof(buf)-1] | |
261 | * abcdefghij0 | |
262 | * -> abcd[...]00 <-- now two null bytes at end | |
263 | * | |
264 | * If the input format string has a trailing newline, | |
265 | * we copy it into that extra null; if it doesn't, well, | |
266 | * all we lose is one byte. */ | |
267 | strncpy(buf+len-sizeof(ellipsis), ellipsis, sizeof(ellipsis)); | |
268 | if (format[strlen(format)-1] == '\n') { | |
269 | buf[len-1] = '\n'; | |
270 | } | |
271 | } | |
554e0a8d | 272 | |
ff41a59f | 273 | rwrite(code, buf, len); |
554e0a8d | 274 | } |
0b76cd63 | 275 | |
a039749b MP |
276 | |
277 | /* This is like rprintf, but it also tries to print some | |
278 | * representation of the error code. Normally errcode = errno. | |
279 | * | |
280 | * Unlike rprintf, this always adds a newline and there should not be | |
281 | * one in the format string. | |
282 | * | |
283 | * Note that since strerror might involve dynamically loading a | |
284 | * message catalog we need to call it once before chroot-ing. */ | |
285 | void rsyserr(enum logcode code, int errcode, const char *format, ...) | |
286 | { | |
4a7319be | 287 | va_list ap; |
a039749b | 288 | char buf[1024]; |
59ee743c MP |
289 | int len; |
290 | size_t sys_len; | |
4a7319be | 291 | char *sysmsg; |
a039749b MP |
292 | |
293 | va_start(ap, format); | |
59ee743c | 294 | /* Note: might return <0 */ |
8950ac03 | 295 | len = vsnprintf(buf, sizeof(buf), format, ap); |
a039749b MP |
296 | va_end(ap); |
297 | ||
4f092bee MP |
298 | /* TODO: Put in RSYNC_NAME at the start. */ |
299 | ||
59ee743c MP |
300 | if ((size_t) len > sizeof(buf)-1) |
301 | exit_cleanup(RERR_MESSAGEIO); | |
a039749b | 302 | |
4a7319be WD |
303 | sysmsg = strerror(errcode); |
304 | sys_len = strlen(sysmsg); | |
305 | if ((size_t) len + 3 + sys_len > sizeof(buf) - 1) | |
306 | exit_cleanup(RERR_MESSAGEIO); | |
a039749b | 307 | |
4a7319be WD |
308 | strcpy(buf + len, ": "); |
309 | len += 2; | |
310 | strcpy(buf + len, sysmsg); | |
311 | len += sys_len; | |
312 | strcpy(buf + len, "\n"); | |
313 | len++; | |
a039749b MP |
314 | |
315 | rwrite(code, buf, len); | |
316 | } | |
317 | ||
318 | ||
319 | ||
ff41a59f | 320 | void rflush(enum logcode code) |
0b76cd63 AT |
321 | { |
322 | FILE *f = NULL; | |
0b76cd63 AT |
323 | |
324 | if (am_daemon) { | |
325 | return; | |
326 | } | |
327 | ||
ff41a59f | 328 | if (code == FLOG) { |
e08bfe12 | 329 | return; |
4a7319be | 330 | } |
e08bfe12 | 331 | |
ff41a59f | 332 | if (code == FERROR) { |
0b76cd63 | 333 | f = stderr; |
4a7319be | 334 | } |
0b76cd63 | 335 | |
ff41a59f | 336 | if (code == FINFO) { |
4a7319be | 337 | if (am_server) |
0b76cd63 AT |
338 | f = stderr; |
339 | else | |
340 | f = stdout; | |
4a7319be | 341 | } |
0b76cd63 | 342 | |
65417579 | 343 | if (!f) exit_cleanup(RERR_MESSAGEIO); |
0b76cd63 AT |
344 | fflush(f); |
345 | } | |
346 | ||
11a5a3c7 | 347 | |
e08bfe12 AT |
348 | |
349 | /* a generic logging routine for send/recv, with parameter | |
4a7319be | 350 | * substitiution */ |
0f3203c3 | 351 | static void log_formatted(enum logcode code, |
b6062654 | 352 | char *format, char *op, struct file_struct *file, |
1b7c47cb | 353 | struct stats *initial_stats) |
e08bfe12 | 354 | { |
e08bfe12 | 355 | char buf[1024]; |
ab7104da | 356 | char buf2[1024]; |
e08bfe12 | 357 | char *p, *s, *n; |
59ee743c | 358 | size_t l; |
1b7c47cb | 359 | int64 b; |
e08bfe12 | 360 | |
aa126974 MP |
361 | /* We expand % codes one by one in place in buf. We don't |
362 | * copy in the terminating nul of the inserted strings, but | |
363 | * rather keep going until we reach the nul of the format. | |
364 | * Just to make sure we don't clobber that nul and therefore | |
365 | * accidentally keep going, we zero the buffer now. */ | |
366 | memset(buf, 0, sizeof buf); | |
37f9805d | 367 | strlcpy(buf, format, sizeof(buf)); |
e08bfe12 | 368 | |
4a7319be | 369 | for (s = &buf[0]; s && (p = strchr(s,'%')); ) { |
e08bfe12 AT |
370 | n = NULL; |
371 | s = p + 1; | |
372 | ||
373 | switch (p[1]) { | |
af77cc6b AT |
374 | case 'h': if (am_daemon) n = client_name(0); break; |
375 | case 'a': if (am_daemon) n = client_addr(0); break; | |
4a7319be WD |
376 | case 'l': |
377 | snprintf(buf2,sizeof(buf2),"%.0f", | |
378 | (double)file->length); | |
e08bfe12 AT |
379 | n = buf2; |
380 | break; | |
4a7319be WD |
381 | case 'p': |
382 | snprintf(buf2,sizeof(buf2),"%d", | |
383 | (int)getpid()); | |
e08bfe12 AT |
384 | n = buf2; |
385 | break; | |
386 | case 'o': n = op; break; | |
4a7319be WD |
387 | case 'f': |
388 | snprintf(buf2, sizeof(buf2), "%s/%s", | |
389 | file->basedir?file->basedir:"", | |
ab7104da AT |
390 | f_name(file)); |
391 | clean_fname(buf2); | |
4a7319be | 392 | n = buf2; |
b6062654 | 393 | if (*n == '/') n++; |
ab7104da | 394 | break; |
97cb8dc2 | 395 | case 'm': n = lp_name(module_id); break; |
b6062654 | 396 | case 't': n = timestring(time(NULL)); break; |
97cb8dc2 AT |
397 | case 'P': n = lp_path(module_id); break; |
398 | case 'u': n = auth_user; break; | |
4a7319be | 399 | case 'b': |
1b7c47cb | 400 | if (am_sender) { |
4a7319be | 401 | b = stats.total_written - |
1b7c47cb AT |
402 | initial_stats->total_written; |
403 | } else { | |
4a7319be | 404 | b = stats.total_read - |
1b7c47cb AT |
405 | initial_stats->total_read; |
406 | } | |
4a7319be | 407 | snprintf(buf2,sizeof(buf2),"%.0f", (double)b); |
1b7c47cb AT |
408 | n = buf2; |
409 | break; | |
4a7319be | 410 | case 'c': |
1b7c47cb | 411 | if (!am_sender) { |
4a7319be | 412 | b = stats.total_written - |
1b7c47cb AT |
413 | initial_stats->total_written; |
414 | } else { | |
4a7319be | 415 | b = stats.total_read - |
1b7c47cb AT |
416 | initial_stats->total_read; |
417 | } | |
4a7319be | 418 | snprintf(buf2,sizeof(buf2),"%.0f", (double)b); |
1b7c47cb AT |
419 | n = buf2; |
420 | break; | |
e08bfe12 AT |
421 | } |
422 | ||
aa126974 MP |
423 | /* n is the string to be inserted in place of this % |
424 | * code; l is its length not including the trailing | |
425 | * NUL */ | |
426 | if (!n) | |
427 | continue; | |
e08bfe12 AT |
428 | |
429 | l = strlen(n); | |
430 | ||
9dd891bb | 431 | if (l + ((int)(s - &buf[0])) >= sizeof(buf)) { |
e08bfe12 AT |
432 | rprintf(FERROR,"buffer overflow expanding %%%c - exiting\n", |
433 | p[0]); | |
65417579 | 434 | exit_cleanup(RERR_MESSAGEIO); |
e08bfe12 AT |
435 | } |
436 | ||
aa126974 | 437 | /* Shuffle the rest of the string along to make space for n */ |
e08bfe12 | 438 | if (l != 2) { |
34720097 | 439 | memmove(s+(l-1), s+1, strlen(s+1)+1); |
e08bfe12 | 440 | } |
aa126974 MP |
441 | |
442 | /* Copy in n but NOT its nul, because the format sting | |
443 | * probably continues after this. */ | |
e08bfe12 AT |
444 | memcpy(p, n, l); |
445 | ||
aa126974 | 446 | /* Skip over inserted string; continue looking */ |
e08bfe12 AT |
447 | s = p+l; |
448 | } | |
449 | ||
0f3203c3 | 450 | rprintf(code,"%s\n", buf); |
e08bfe12 AT |
451 | } |
452 | ||
11a5a3c7 | 453 | /* log the outgoing transfer of a file */ |
1b7c47cb | 454 | void log_send(struct file_struct *file, struct stats *initial_stats) |
11a5a3c7 | 455 | { |
11a5a3c7 | 456 | if (lp_transfer_logging(module_id)) { |
b6062654 AT |
457 | log_formatted(FLOG, lp_log_format(module_id), "send", file, initial_stats); |
458 | } else if (log_format && !am_server) { | |
459 | log_formatted(FINFO, log_format, "send", file, initial_stats); | |
11a5a3c7 AT |
460 | } |
461 | } | |
462 | ||
463 | /* log the incoming transfer of a file */ | |
1b7c47cb | 464 | void log_recv(struct file_struct *file, struct stats *initial_stats) |
11a5a3c7 | 465 | { |
11a5a3c7 | 466 | if (lp_transfer_logging(module_id)) { |
117af102 | 467 | log_formatted(FLOG, lp_log_format(module_id), "recv", file, initial_stats); |
b6062654 | 468 | } else if (log_format && !am_server) { |
117af102 | 469 | log_formatted(FINFO, log_format, "recv", file, initial_stats); |
11a5a3c7 AT |
470 | } |
471 | } | |
472 | ||
af642a61 MP |
473 | |
474 | ||
475 | ||
476 | /* | |
477 | * Called when the transfer is interrupted for some reason. | |
478 | * | |
479 | * Code is one of the RERR_* codes from errcode.h, or terminating | |
480 | * successfully. | |
481 | */ | |
a9766ef1 | 482 | void log_exit(int code, const char *file, int line) |
9b73d1c0 AT |
483 | { |
484 | if (code == 0) { | |
67ea0d48 | 485 | rprintf(FLOG,"wrote %.0f bytes read %.0f bytes total size %.0f\n", |
9b73d1c0 AT |
486 | (double)stats.total_written, |
487 | (double)stats.total_read, | |
488 | (double)stats.total_size); | |
489 | } else { | |
4a7319be WD |
490 | const char *name; |
491 | ||
492 | name = rerr_name(code); | |
493 | if (!name) | |
494 | name = "unexplained error"; | |
af642a61 | 495 | |
1bca1de6 WD |
496 | /* VANISHED is not an error, only a warning */ |
497 | if (code == RERR_VANISHED) { | |
498 | rprintf(FINFO, "rsync warning: %s (code %d) at %s(%d)\n", | |
499 | name, code, file, line); | |
500 | } else { | |
501 | rprintf(FERROR, "rsync error: %s (code %d) at %s(%d)\n", | |
502 | name, code, file, line); | |
503 | } | |
9b73d1c0 AT |
504 | } |
505 | } |