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