Change 3 alt-dest vars to just one + some defines.
[rsync.git] / main.c
1 /*
2  * The startup routines, including main(), for rsync.
3  *
4  * Copyright (C) 1996-2001 Andrew Tridgell <tridge@samba.org>
5  * Copyright (C) 1996 Paul Mackerras
6  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7  * Copyright (C) 2003-2020 Wayne Davison
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, visit the http://fsf.org website.
21  */
22
23 #include "rsync.h"
24 #include "inums.h"
25 #include "io.h"
26 #if defined CONFIG_LOCALE && defined HAVE_LOCALE_H
27 #include <locale.h>
28 #endif
29 #include <popt.h>
30
31 extern int dry_run;
32 extern int list_only;
33 extern int io_timeout;
34 extern int am_root;
35 extern int am_server;
36 extern int am_sender;
37 extern int am_daemon;
38 extern int inc_recurse;
39 extern int blocking_io;
40 extern int always_checksum;
41 extern int remove_source_files;
42 extern int output_needs_newline;
43 extern int called_from_signal_handler;
44 extern int need_messages_from_generator;
45 extern int kluge_around_eof;
46 extern int got_xfer_error;
47 extern int msgs2stderr;
48 extern int module_id;
49 extern int read_only;
50 extern int copy_links;
51 extern int copy_dirlinks;
52 extern int copy_unsafe_links;
53 extern int keep_dirlinks;
54 extern int preserve_hard_links;
55 extern int protocol_version;
56 extern int file_total;
57 extern int recurse;
58 extern int xfer_dirs;
59 extern int protect_args;
60 extern int relative_paths;
61 extern int sanitize_paths;
62 extern int curr_dir_depth;
63 extern int curr_dir_len;
64 extern int module_id;
65 extern int rsync_port;
66 extern int whole_file;
67 extern int read_batch;
68 extern int write_batch;
69 extern int batch_fd;
70 extern int sock_f_in;
71 extern int sock_f_out;
72 extern int filesfrom_fd;
73 extern int connect_timeout;
74 extern int send_msgs_to_gen;
75 extern dev_t filesystem_dev;
76 extern pid_t cleanup_child_pid;
77 extern size_t bwlimit_writemax;
78 extern unsigned int module_dirlen;
79 extern BOOL flist_receiving_enabled;
80 extern BOOL want_progress_now;
81 extern BOOL shutting_down;
82 extern int backup_dir_len;
83 extern int basis_dir_cnt;
84 extern struct stats stats;
85 extern char *stdout_format;
86 extern char *logfile_format;
87 extern char *filesfrom_host;
88 extern char *partial_dir;
89 extern char *rsync_path;
90 extern char *shell_cmd;
91 extern char *password_file;
92 extern char *backup_dir;
93 extern char *copy_as;
94 extern char curr_dir[MAXPATHLEN];
95 extern char backup_dir_buf[MAXPATHLEN];
96 extern char *basis_dir[MAX_BASIS_DIRS+1];
97 extern struct file_list *first_flist;
98 extern filter_rule_list daemon_filter_list;
99
100 uid_t our_uid;
101 gid_t our_gid;
102 int am_receiver = 0;  /* Only set to 1 after the receiver/generator fork. */
103 int am_generator = 0; /* Only set to 1 after the receiver/generator fork. */
104 int local_server = 0;
105 int daemon_over_rsh = 0;
106 mode_t orig_umask = 0;
107 int batch_gen_fd = -1;
108 int sender_keeps_checksum = 0;
109 int raw_argc, cooked_argc;
110 char **raw_argv, **cooked_argv;
111
112 /* There's probably never more than at most 2 outstanding child processes,
113  * but set it higher, just in case. */
114 #define MAXCHILDPROCS 7
115
116 #ifdef HAVE_SIGACTION
117 # ifdef HAVE_SIGPROCMASK
118 #  define SIGACTMASK(n,h) SIGACTION(n,h), sigaddset(&sigmask,(n))
119 # else
120 #  define SIGACTMASK(n,h) SIGACTION(n,h)
121 # endif
122 static struct sigaction sigact;
123 #endif
124
125 struct pid_status {
126         pid_t pid;
127         int status;
128 } pid_stat_table[MAXCHILDPROCS];
129
130 static time_t starttime, endtime;
131 static int64 total_read, total_written;
132
133 static void show_malloc_stats(void);
134
135 /* Works like waitpid(), but if we already harvested the child pid in our
136  * remember_children(), we succeed instead of returning an error. */
137 pid_t wait_process(pid_t pid, int *status_ptr, int flags)
138 {
139         pid_t waited_pid;
140
141         do {
142                 waited_pid = waitpid(pid, status_ptr, flags);
143         } while (waited_pid == -1 && errno == EINTR);
144
145         if (waited_pid == -1 && errno == ECHILD) {
146                 /* Status of requested child no longer available:  check to
147                  * see if it was processed by remember_children(). */
148                 int cnt;
149                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
150                         if (pid == pid_stat_table[cnt].pid) {
151                                 *status_ptr = pid_stat_table[cnt].status;
152                                 pid_stat_table[cnt].pid = 0;
153                                 return pid;
154                         }
155                 }
156         }
157
158         return waited_pid;
159 }
160
161 int shell_exec(const char *cmd)
162 {
163         char *shell = getenv("RSYNC_SHELL");
164         int status;
165         pid_t pid;
166
167         if (!shell)
168                 return system(cmd);
169
170         if ((pid = fork()) < 0)
171                 return -1;
172
173         if (pid == 0) {
174                 execlp(shell, shell, "-c", cmd, NULL);
175                 _exit(1);
176         }
177
178         int ret = wait_process(pid, &status, 0);
179         return ret < 0 ? -1 : status;
180 }
181
182 /* Wait for a process to exit, calling io_flush while waiting. */
183 static void wait_process_with_flush(pid_t pid, int *exit_code_ptr)
184 {
185         pid_t waited_pid;
186         int status;
187
188         while ((waited_pid = wait_process(pid, &status, WNOHANG)) == 0) {
189                 msleep(20);
190                 io_flush(FULL_FLUSH);
191         }
192
193         /* TODO: If the child exited on a signal, then log an
194          * appropriate error message.  Perhaps we should also accept a
195          * message describing the purpose of the child.  Also indicate
196          * this to the caller so that they know something went wrong. */
197         if (waited_pid < 0) {
198                 rsyserr(FERROR, errno, "waitpid");
199                 *exit_code_ptr = RERR_WAITCHILD;
200         } else if (!WIFEXITED(status)) {
201 #ifdef WCOREDUMP
202                 if (WCOREDUMP(status))
203                         *exit_code_ptr = RERR_CRASHED;
204                 else
205 #endif
206                 if (WIFSIGNALED(status))
207                         *exit_code_ptr = RERR_TERMINATED;
208                 else
209                         *exit_code_ptr = RERR_WAITCHILD;
210         } else
211                 *exit_code_ptr = WEXITSTATUS(status);
212 }
213
214 void write_del_stats(int f)
215 {
216         if (read_batch)
217                 write_int(f, NDX_DEL_STATS);
218         else
219                 write_ndx(f, NDX_DEL_STATS);
220         write_varint(f, stats.deleted_files - stats.deleted_dirs
221                       - stats.deleted_symlinks - stats.deleted_devices
222                       - stats.deleted_specials);
223         write_varint(f, stats.deleted_dirs);
224         write_varint(f, stats.deleted_symlinks);
225         write_varint(f, stats.deleted_devices);
226         write_varint(f, stats.deleted_specials);
227 }
228
229 void read_del_stats(int f)
230 {
231         stats.deleted_files = read_varint(f);
232         stats.deleted_files += stats.deleted_dirs = read_varint(f);
233         stats.deleted_files += stats.deleted_symlinks = read_varint(f);
234         stats.deleted_files += stats.deleted_devices = read_varint(f);
235         stats.deleted_files += stats.deleted_specials = read_varint(f);
236 }
237
238 static void become_copy_as_user()
239 {
240         char *gname;
241         uid_t uid;
242         gid_t gid;
243
244         if (!copy_as)
245                 return;
246
247         if (DEBUG_GTE(CMD, 2))
248                 rprintf(FINFO, "[%s] copy_as=%s\n", who_am_i(), copy_as);
249
250         if ((gname = strchr(copy_as, ':')) != NULL)
251                 *gname++ = '\0';
252
253         if (!user_to_uid(copy_as, &uid, True)) {
254                 rprintf(FERROR, "Invalid copy-as user: %s\n", copy_as);
255                 exit_cleanup(RERR_SYNTAX);
256         }
257
258         if (gname) {
259                 if (!group_to_gid(gname, &gid, True)) {
260                         rprintf(FERROR, "Invalid copy-as group: %s\n", gname);
261                         exit_cleanup(RERR_SYNTAX);
262                 }
263         } else {
264                 struct passwd *pw;
265                 if ((pw = getpwuid(uid)) == NULL) {
266                         rsyserr(FERROR, errno, "getpwuid failed");
267                         exit_cleanup(RERR_SYNTAX);
268                 }
269                 gid = pw->pw_gid;
270         }
271
272         if (setgid(gid) < 0) {
273                 rsyserr(FERROR, errno, "setgid failed");
274                 exit_cleanup(RERR_SYNTAX);
275         }
276 #ifdef HAVE_SETGROUPS
277         if (setgroups(1, &gid)) {
278                 rsyserr(FERROR, errno, "setgroups failed");
279                 exit_cleanup(RERR_SYNTAX);
280         }
281 #endif
282 #ifdef HAVE_INITGROUPS
283         if (!gname && initgroups(copy_as, gid) < 0) {
284                 rsyserr(FERROR, errno, "initgroups failed");
285                 exit_cleanup(RERR_SYNTAX);
286         }
287 #endif
288
289         if (setuid(uid) < 0
290 #ifdef HAVE_SETEUID
291          || seteuid(uid) < 0
292 #endif
293         ) {
294                 rsyserr(FERROR, errno, "setuid failed");
295                 exit_cleanup(RERR_SYNTAX);
296         }
297
298         our_uid = MY_UID();
299         our_gid = MY_GID();
300         am_root = (our_uid == 0);
301
302         if (gname)
303                 gname[-1] = ':';
304 }
305
306 /* This function gets called from all 3 processes.  We want the client side
307  * to actually output the text, but the sender is the only process that has
308  * all the stats we need.  So, if we're a client sender, we do the report.
309  * If we're a server sender, we write the stats on the supplied fd.  If
310  * we're the client receiver we read the stats from the supplied fd and do
311  * the report.  All processes might also generate a set of debug stats, if
312  * the verbose level is high enough (this is the only thing that the
313  * generator process and the server receiver ever do here). */
314 static void handle_stats(int f)
315 {
316         endtime = time(NULL);
317
318         /* Cache two stats because the read/write code can change it. */
319         total_read = stats.total_read;
320         total_written = stats.total_written;
321
322         if (INFO_GTE(STATS, 3)) {
323                 /* These come out from every process */
324                 show_malloc_stats();
325                 show_flist_stats();
326         }
327
328         if (am_generator)
329                 return;
330
331         if (am_daemon) {
332                 if (f == -1 || !am_sender)
333                         return;
334         }
335
336         if (am_server) {
337                 if (am_sender) {
338                         write_varlong30(f, total_read, 3);
339                         write_varlong30(f, total_written, 3);
340                         write_varlong30(f, stats.total_size, 3);
341                         if (protocol_version >= 29) {
342                                 write_varlong30(f, stats.flist_buildtime, 3);
343                                 write_varlong30(f, stats.flist_xfertime, 3);
344                         }
345                 }
346                 return;
347         }
348
349         /* this is the client */
350
351         if (f < 0 && !am_sender) /* e.g. when we got an empty file list. */
352                 ;
353         else if (!am_sender) {
354                 /* Read the first two in opposite order because the meaning of
355                  * read/write swaps when switching from sender to receiver. */
356                 total_written = read_varlong30(f, 3);
357                 total_read = read_varlong30(f, 3);
358                 stats.total_size = read_varlong30(f, 3);
359                 if (protocol_version >= 29) {
360                         stats.flist_buildtime = read_varlong30(f, 3);
361                         stats.flist_xfertime = read_varlong30(f, 3);
362                 }
363         } else if (write_batch) {
364                 /* The --read-batch process is going to be a client
365                  * receiver, so we need to give it the stats. */
366                 write_varlong30(batch_fd, total_read, 3);
367                 write_varlong30(batch_fd, total_written, 3);
368                 write_varlong30(batch_fd, stats.total_size, 3);
369                 if (protocol_version >= 29) {
370                         write_varlong30(batch_fd, stats.flist_buildtime, 3);
371                         write_varlong30(batch_fd, stats.flist_xfertime, 3);
372                 }
373         }
374 }
375
376 static void output_itemized_counts(const char *prefix, int *counts)
377 {
378         static char *labels[] = { "reg", "dir", "link", "dev", "special" };
379         char buf[1024], *pre = " (";
380         int j, len = 0;
381         int total = counts[0];
382         if (total) {
383                 counts[0] -= counts[1] + counts[2] + counts[3] + counts[4];
384                 for (j = 0; j < 5; j++) {
385                         if (counts[j]) {
386                                 len += snprintf(buf+len, sizeof buf - len - 2,
387                                         "%s%s: %s",
388                                         pre, labels[j], comma_num(counts[j]));
389                                 pre = ", ";
390                         }
391                 }
392                 buf[len++] = ')';
393         }
394         buf[len] = '\0';
395         rprintf(FINFO, "%s: %s%s\n", prefix, comma_num(total), buf);
396 }
397
398 static const char *bytes_per_sec_human_dnum(void)
399 {
400         if (starttime == (time_t)-1 || endtime == (time_t)-1)
401                 return "UNKNOWN";
402         return human_dnum((total_written + total_read) / (0.5 + (endtime - starttime)), 2);
403 }
404
405 static void output_summary(void)
406 {
407         if (INFO_GTE(STATS, 2)) {
408                 rprintf(FCLIENT, "\n");
409                 output_itemized_counts("Number of files", &stats.num_files);
410                 if (protocol_version >= 29)
411                         output_itemized_counts("Number of created files", &stats.created_files);
412                 if (protocol_version >= 31)
413                         output_itemized_counts("Number of deleted files", &stats.deleted_files);
414                 rprintf(FINFO,"Number of regular files transferred: %s\n",
415                         comma_num(stats.xferred_files));
416                 rprintf(FINFO,"Total file size: %s bytes\n",
417                         human_num(stats.total_size));
418                 rprintf(FINFO,"Total transferred file size: %s bytes\n",
419                         human_num(stats.total_transferred_size));
420                 rprintf(FINFO,"Literal data: %s bytes\n",
421                         human_num(stats.literal_data));
422                 rprintf(FINFO,"Matched data: %s bytes\n",
423                         human_num(stats.matched_data));
424                 rprintf(FINFO,"File list size: %s\n",
425                         human_num(stats.flist_size));
426                 if (stats.flist_buildtime) {
427                         rprintf(FINFO,
428                                 "File list generation time: %s seconds\n",
429                                 comma_dnum((double)stats.flist_buildtime / 1000, 3));
430                         rprintf(FINFO,
431                                 "File list transfer time: %s seconds\n",
432                                 comma_dnum((double)stats.flist_xfertime / 1000, 3));
433                 }
434                 rprintf(FINFO,"Total bytes sent: %s\n",
435                         human_num(total_written));
436                 rprintf(FINFO,"Total bytes received: %s\n",
437                         human_num(total_read));
438         }
439
440         if (INFO_GTE(STATS, 1)) {
441                 rprintf(FCLIENT, "\n");
442                 rprintf(FINFO,
443                         "sent %s bytes  received %s bytes  %s bytes/sec\n",
444                         human_num(total_written), human_num(total_read),
445                         bytes_per_sec_human_dnum());
446                 rprintf(FINFO, "total size is %s  speedup is %s%s\n",
447                         human_num(stats.total_size),
448                         comma_dnum((double)stats.total_size / (total_written+total_read), 2),
449                         write_batch < 0 ? " (BATCH ONLY)" : dry_run ? " (DRY RUN)" : "");
450         }
451
452         fflush(stdout);
453         fflush(stderr);
454 }
455
456
457 /**
458  * If our C library can get malloc statistics, then show them to FINFO
459  **/
460 static void show_malloc_stats(void)
461 {
462 #ifdef HAVE_MALLINFO
463         struct mallinfo mi;
464
465         mi = mallinfo();
466
467         rprintf(FCLIENT, "\n");
468         rprintf(FINFO, RSYNC_NAME "[%d] (%s%s%s) heap statistics:\n",
469                 (int)getpid(), am_server ? "server " : "",
470                 am_daemon ? "daemon " : "", who_am_i());
471         rprintf(FINFO, "  arena:     %10ld   (bytes from sbrk)\n",
472                 (long)mi.arena);
473         rprintf(FINFO, "  ordblks:   %10ld   (chunks not in use)\n",
474                 (long)mi.ordblks);
475         rprintf(FINFO, "  smblks:    %10ld\n",
476                 (long)mi.smblks);
477         rprintf(FINFO, "  hblks:     %10ld   (chunks from mmap)\n",
478                 (long)mi.hblks);
479         rprintf(FINFO, "  hblkhd:    %10ld   (bytes from mmap)\n",
480                 (long)mi.hblkhd);
481         rprintf(FINFO, "  allmem:    %10ld   (bytes from sbrk + mmap)\n",
482                 (long)mi.arena + mi.hblkhd);
483         rprintf(FINFO, "  usmblks:   %10ld\n",
484                 (long)mi.usmblks);
485         rprintf(FINFO, "  fsmblks:   %10ld\n",
486                 (long)mi.fsmblks);
487         rprintf(FINFO, "  uordblks:  %10ld   (bytes used)\n",
488                 (long)mi.uordblks);
489         rprintf(FINFO, "  fordblks:  %10ld   (bytes free)\n",
490                 (long)mi.fordblks);
491         rprintf(FINFO, "  keepcost:  %10ld   (bytes in releasable chunk)\n",
492                 (long)mi.keepcost);
493 #endif /* HAVE_MALLINFO */
494 }
495
496
497 /* Start the remote shell.   cmd may be NULL to use the default. */
498 static pid_t do_cmd(char *cmd, char *machine, char *user, char **remote_argv, int remote_argc,
499                     int *f_in_p, int *f_out_p)
500 {
501         int i, argc = 0;
502         char *args[MAX_ARGS], *need_to_free = NULL;
503         pid_t pid;
504         int dash_l_set = 0;
505
506         if (!read_batch && !local_server) {
507                 char *t, *f, in_quote = '\0';
508                 char *rsh_env = getenv(RSYNC_RSH_ENV);
509                 if (!cmd)
510                         cmd = rsh_env;
511                 if (!cmd)
512                         cmd = RSYNC_RSH;
513                 cmd = need_to_free = strdup(cmd);
514                 if (!cmd)
515                         goto oom;
516
517                 for (t = f = cmd; *f; f++) {
518                         if (*f == ' ')
519                                 continue;
520                         /* Comparison leaves rooms for server_options(). */
521                         if (argc >= MAX_ARGS - MAX_SERVER_ARGS)
522                                 goto arg_overflow;
523                         args[argc++] = t;
524                         while (*f != ' ' || in_quote) {
525                                 if (!*f) {
526                                         if (in_quote) {
527                                                 rprintf(FERROR,
528                                                     "Missing trailing-%c in remote-shell command.\n",
529                                                     in_quote);
530                                                 exit_cleanup(RERR_SYNTAX);
531                                         }
532                                         f--;
533                                         break;
534                                 }
535                                 if (*f == '\'' || *f == '"') {
536                                         if (!in_quote) {
537                                                 in_quote = *f++;
538                                                 continue;
539                                         }
540                                         if (*f == in_quote && *++f != in_quote) {
541                                                 in_quote = '\0';
542                                                 continue;
543                                         }
544                                 }
545                                 *t++ = *f++;
546                         }
547                         *t++ = '\0';
548                 }
549
550                 /* check to see if we've already been given '-l user' in
551                  * the remote-shell command */
552                 for (i = 0; i < argc-1; i++) {
553                         if (!strcmp(args[i], "-l") && args[i+1][0] != '-')
554                                 dash_l_set = 1;
555                 }
556
557 #ifdef HAVE_REMSH
558                 /* remsh (on HPUX) takes the arguments the other way around */
559                 args[argc++] = machine;
560                 if (user && !(daemon_over_rsh && dash_l_set)) {
561                         args[argc++] = "-l";
562                         args[argc++] = user;
563                 }
564 #else
565                 if (user && !(daemon_over_rsh && dash_l_set)) {
566                         args[argc++] = "-l";
567                         args[argc++] = user;
568                 }
569                 args[argc++] = machine;
570 #endif
571
572                 args[argc++] = rsync_path;
573
574                 if (blocking_io < 0) {
575                         char *cp;
576                         if ((cp = strrchr(cmd, '/')) != NULL)
577                                 cp++;
578                         else
579                                 cp = cmd;
580                         if (strcmp(cp, "rsh") == 0 || strcmp(cp, "remsh") == 0)
581                                 blocking_io = 1;
582                 }
583
584                 server_options(args,&argc);
585
586                 if (argc >= MAX_ARGS - 2)
587                         goto arg_overflow;
588         }
589
590         args[argc++] = ".";
591
592         if (!daemon_over_rsh) {
593                 while (remote_argc > 0) {
594                         if (argc >= MAX_ARGS - 1) {
595                           arg_overflow:
596                                 rprintf(FERROR, "internal: args[] overflowed in do_cmd()\n");
597                                 exit_cleanup(RERR_SYNTAX);
598                         }
599                         if (**remote_argv == '-') {
600                                 if (asprintf(args + argc++, "./%s", *remote_argv++) < 0)
601                                         out_of_memory("do_cmd");
602                         } else
603                                 args[argc++] = *remote_argv++;
604                         remote_argc--;
605                 }
606         }
607
608         args[argc] = NULL;
609
610         if (DEBUG_GTE(CMD, 2)) {
611                 for (i = 0; i < argc; i++)
612                         rprintf(FCLIENT, "cmd[%d]=%s ", i, args[i]);
613                 rprintf(FCLIENT, "\n");
614         }
615
616         if (read_batch) {
617                 int from_gen_pipe[2];
618                 set_allow_inc_recurse();
619                 if (fd_pair(from_gen_pipe) < 0) {
620                         rsyserr(FERROR, errno, "pipe");
621                         exit_cleanup(RERR_IPC);
622                 }
623                 batch_gen_fd = from_gen_pipe[0];
624                 *f_out_p = from_gen_pipe[1];
625                 *f_in_p = batch_fd;
626                 pid = (pid_t)-1; /* no child pid */
627 #ifdef ICONV_CONST
628                 setup_iconv();
629 #endif
630         } else if (local_server) {
631                 /* If the user didn't request --[no-]whole-file, force
632                  * it on, but only if we're not batch processing. */
633                 if (whole_file < 0 && !write_batch)
634                         whole_file = 1;
635                 set_allow_inc_recurse();
636                 pid = local_child(argc, args, f_in_p, f_out_p, child_main);
637 #ifdef ICONV_CONST
638                 setup_iconv();
639 #endif
640         } else {
641                 pid = piped_child(args, f_in_p, f_out_p);
642 #ifdef ICONV_CONST
643                 setup_iconv();
644 #endif
645                 if (protect_args && !daemon_over_rsh)
646                         send_protected_args(*f_out_p, args);
647         }
648
649         if (need_to_free)
650                 free(need_to_free);
651
652         return pid;
653
654   oom:
655         out_of_memory("do_cmd");
656         return 0; /* not reached */
657 }
658
659 /* The receiving side operates in one of two modes:
660  *
661  * 1. it receives any number of files into a destination directory,
662  * placing them according to their names in the file-list.
663  *
664  * 2. it receives a single file and saves it using the name in the
665  * destination path instead of its file-list name.  This requires a
666  * "local name" for writing out the destination file.
667  *
668  * So, our task is to figure out what mode/local-name we need.
669  * For mode 1, we change into the destination directory and return NULL.
670  * For mode 2, we change into the directory containing the destination
671  * file (if we aren't already there) and return the local-name. */
672 static char *get_local_name(struct file_list *flist, char *dest_path)
673 {
674         STRUCT_STAT st;
675         int statret;
676         char *cp;
677
678         if (DEBUG_GTE(RECV, 1)) {
679                 rprintf(FINFO, "get_local_name count=%d %s\n",
680                         file_total, NS(dest_path));
681         }
682
683         if (!dest_path || list_only)
684                 return NULL;
685
686         /* Treat an empty string as a copy into the current directory. */
687         if (!*dest_path)
688             dest_path = ".";
689
690         if (daemon_filter_list.head) {
691                 char *slash = strrchr(dest_path, '/');
692                 if (slash && (slash[1] == '\0' || (slash[1] == '.' && slash[2] == '\0')))
693                         *slash = '\0';
694                 else
695                         slash = NULL;
696                 if ((*dest_path != '.' || dest_path[1] != '\0')
697                  && (check_filter(&daemon_filter_list, FLOG, dest_path, 0) < 0
698                   || check_filter(&daemon_filter_list, FLOG, dest_path, 1) < 0)) {
699                         rprintf(FERROR, "ERROR: daemon has excluded destination \"%s\"\n",
700                                 dest_path);
701                         exit_cleanup(RERR_FILESELECT);
702                 }
703                 if (slash)
704                         *slash = '/';
705         }
706
707         /* See what currently exists at the destination. */
708         if ((statret = do_stat(dest_path, &st)) == 0) {
709                 /* If the destination is a dir, enter it and use mode 1. */
710                 if (S_ISDIR(st.st_mode)) {
711                         if (!change_dir(dest_path, CD_NORMAL)) {
712                                 rsyserr(FERROR, errno, "change_dir#1 %s failed",
713                                         full_fname(dest_path));
714                                 exit_cleanup(RERR_FILESELECT);
715                         }
716                         filesystem_dev = st.st_dev; /* ensures --force works right w/-x */
717                         return NULL;
718                 }
719                 if (file_total > 1) {
720                         rprintf(FERROR,
721                                 "ERROR: destination must be a directory when"
722                                 " copying more than 1 file\n");
723                         exit_cleanup(RERR_FILESELECT);
724                 }
725                 if (file_total == 1 && S_ISDIR(flist->files[0]->mode)) {
726                         rprintf(FERROR,
727                                 "ERROR: cannot overwrite non-directory"
728                                 " with a directory\n");
729                         exit_cleanup(RERR_FILESELECT);
730                 }
731         } else if (errno != ENOENT) {
732                 /* If we don't know what's at the destination, fail. */
733                 rsyserr(FERROR, errno, "ERROR: cannot stat destination %s",
734                         full_fname(dest_path));
735                 exit_cleanup(RERR_FILESELECT);
736         }
737
738         cp = strrchr(dest_path, '/');
739
740         /* If we need a destination directory because the transfer is not
741          * of a single non-directory or the user has requested one via a
742          * destination path ending in a slash, create one and use mode 1. */
743         if (file_total > 1 || (cp && !cp[1])) {
744                 /* Lop off the final slash (if any). */
745                 if (cp && !cp[1])
746                         *cp = '\0';
747
748                 if (statret == 0) {
749                         rprintf(FERROR,
750                             "ERROR: destination path is not a directory\n");
751                         exit_cleanup(RERR_SYNTAX);
752                 }
753
754                 if (do_mkdir(dest_path, ACCESSPERMS) != 0) {
755                         rsyserr(FERROR, errno, "mkdir %s failed",
756                                 full_fname(dest_path));
757                         exit_cleanup(RERR_FILEIO);
758                 }
759
760                 if (flist->high >= flist->low
761                  && strcmp(flist->files[flist->low]->basename, ".") == 0)
762                         flist->files[0]->flags |= FLAG_DIR_CREATED;
763
764                 if (INFO_GTE(NAME, 1))
765                         rprintf(FINFO, "created directory %s\n", dest_path);
766
767                 if (dry_run) {
768                         /* Indicate that dest dir doesn't really exist. */
769                         dry_run++;
770                 }
771
772                 if (!change_dir(dest_path, dry_run > 1 ? CD_SKIP_CHDIR : CD_NORMAL)) {
773                         rsyserr(FERROR, errno, "change_dir#2 %s failed",
774                                 full_fname(dest_path));
775                         exit_cleanup(RERR_FILESELECT);
776                 }
777
778                 return NULL;
779         }
780
781         /* Otherwise, we are writing a single file, possibly on top of an
782          * existing non-directory.  Change to the item's parent directory
783          * (if it has a path component), return the basename of the
784          * destination file as the local name, and use mode 2. */
785         if (!cp)
786                 return dest_path;
787
788         if (cp == dest_path)
789                 dest_path = "/";
790
791         *cp = '\0';
792         if (!change_dir(dest_path, CD_NORMAL)) {
793                 rsyserr(FERROR, errno, "change_dir#3 %s failed",
794                         full_fname(dest_path));
795                 exit_cleanup(RERR_FILESELECT);
796         }
797         *cp = '/';
798
799         return cp + 1;
800 }
801
802 /* This function checks on our alternate-basis directories.  If we're in
803  * dry-run mode and the destination dir does not yet exist, we'll try to
804  * tweak any dest-relative paths to make them work for a dry-run (the
805  * destination dir must be in curr_dir[] when this function is called).
806  * We also warn about any arg that is non-existent or not a directory. */
807 static void check_alt_basis_dirs(void)
808 {
809         STRUCT_STAT st;
810         char *slash = strrchr(curr_dir, '/');
811         int j;
812
813         for (j = 0; j < basis_dir_cnt; j++) {
814                 char *bdir = basis_dir[j];
815                 int bd_len = strlen(bdir);
816                 if (bd_len > 1 && bdir[bd_len-1] == '/')
817                         bdir[--bd_len] = '\0';
818                 if (dry_run > 1 && *bdir != '/') {
819                         int len = curr_dir_len + 1 + bd_len + 1;
820                         char *new = new_array(char, len);
821                         if (!new)
822                                 out_of_memory("check_alt_basis_dirs");
823                         if (slash && strncmp(bdir, "../", 3) == 0) {
824                             /* We want to remove only one leading "../" prefix for
825                              * the directory we couldn't create in dry-run mode:
826                              * this ensures that any other ".." references get
827                              * evaluated the same as they would for a live copy. */
828                             *slash = '\0';
829                             pathjoin(new, len, curr_dir, bdir + 3);
830                             *slash = '/';
831                         } else
832                             pathjoin(new, len, curr_dir, bdir);
833                         basis_dir[j] = bdir = new;
834                 }
835                 if (do_stat(bdir, &st) < 0)
836                         rprintf(FWARNING, "%s arg does not exist: %s\n", alt_dest_name(0), bdir);
837                 else if (!S_ISDIR(st.st_mode))
838                         rprintf(FWARNING, "%s arg is not a dir: %s\n", alt_dest_name(0), bdir);
839         }
840 }
841
842 /* This is only called by the sender. */
843 static void read_final_goodbye(int f_in, int f_out)
844 {
845         int i, iflags, xlen;
846         uchar fnamecmp_type;
847         char xname[MAXPATHLEN];
848
849         shutting_down = True;
850
851         if (protocol_version < 29)
852                 i = read_int(f_in);
853         else {
854                 i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
855                 if (protocol_version >= 31 && i == NDX_DONE) {
856                         if (am_sender)
857                                 write_ndx(f_out, NDX_DONE);
858                         else {
859                                 if (batch_gen_fd >= 0) {
860                                         while (read_int(batch_gen_fd) != NDX_DEL_STATS) {}
861                                         read_del_stats(batch_gen_fd);
862                                 }
863                                 write_int(f_out, NDX_DONE);
864                         }
865                         i = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type, xname, &xlen);
866                 }
867         }
868
869         if (i != NDX_DONE) {
870                 rprintf(FERROR, "Invalid packet at end of run (%d) [%s]\n",
871                         i, who_am_i());
872                 exit_cleanup(RERR_PROTOCOL);
873         }
874 }
875
876 static void do_server_sender(int f_in, int f_out, int argc, char *argv[])
877 {
878         struct file_list *flist;
879         char *dir;
880
881         if (DEBUG_GTE(SEND, 1))
882                 rprintf(FINFO, "server_sender starting pid=%d\n", (int)getpid());
883
884         if (am_daemon && lp_write_only(module_id)) {
885                 rprintf(FERROR, "ERROR: module is write only\n");
886                 exit_cleanup(RERR_SYNTAX);
887         }
888         if (am_daemon && read_only && remove_source_files) {
889                 rprintf(FERROR,
890                         "ERROR: --remove-%s-files cannot be used with a read-only module\n",
891                         remove_source_files == 1 ? "source" : "sent");
892                 exit_cleanup(RERR_SYNTAX);
893         }
894         if (argc < 1) {
895                 rprintf(FERROR, "ERROR: do_server_sender called without args\n");
896                 exit_cleanup(RERR_SYNTAX);
897         }
898
899         become_copy_as_user();
900
901         dir = argv[0];
902         if (!relative_paths) {
903                 if (!change_dir(dir, CD_NORMAL)) {
904                         rsyserr(FERROR, errno, "change_dir#3 %s failed",
905                                 full_fname(dir));
906                         exit_cleanup(RERR_FILESELECT);
907                 }
908         }
909         argc--;
910         argv++;
911
912         if (argc == 0 && (recurse || xfer_dirs || list_only)) {
913                 argc = 1;
914                 argv--;
915                 argv[0] = ".";
916         }
917
918         flist = send_file_list(f_out,argc,argv);
919         if (!flist || flist->used == 0) {
920                 /* Make sure input buffering is off so we can't hang in noop_io_until_death(). */
921                 io_end_buffering_in(0);
922                 /* TODO:  we should really exit in a more controlled manner. */
923                 exit_cleanup(0);
924         }
925
926         io_start_buffering_in(f_in);
927
928         send_files(f_in, f_out);
929         io_flush(FULL_FLUSH);
930         handle_stats(f_out);
931         if (protocol_version >= 24)
932                 read_final_goodbye(f_in, f_out);
933         io_flush(FULL_FLUSH);
934         exit_cleanup(0);
935 }
936
937
938 static int do_recv(int f_in, int f_out, char *local_name)
939 {
940         int pid;
941         int exit_code = 0;
942         int error_pipe[2];
943
944         /* The receiving side mustn't obey this, or an existing symlink that
945          * points to an identical file won't be replaced by the referent. */
946         copy_links = copy_dirlinks = copy_unsafe_links = 0;
947
948 #ifdef SUPPORT_HARD_LINKS
949         if (preserve_hard_links && !inc_recurse)
950                 match_hard_links(first_flist);
951 #endif
952
953         if (fd_pair(error_pipe) < 0) {
954                 rsyserr(FERROR, errno, "pipe failed in do_recv");
955                 exit_cleanup(RERR_IPC);
956         }
957
958         if (backup_dir) {
959                 STRUCT_STAT st;
960                 int ret;
961                 if (backup_dir_len > 1)
962                         backup_dir_buf[backup_dir_len-1] = '\0';
963                 ret = do_stat(backup_dir_buf, &st);
964                 if (ret != 0 || !S_ISDIR(st.st_mode)) {
965                         if (ret == 0) {
966                                 rprintf(FERROR, "The backup-dir is not a directory: %s\n", backup_dir_buf);
967                                 exit_cleanup(RERR_SYNTAX);
968                         }
969                         if (errno != ENOENT) {
970                                 rprintf(FERROR, "Failed to stat %s: %s\n", backup_dir_buf, strerror(errno));
971                                 exit_cleanup(RERR_FILEIO);
972                         }
973                         if (INFO_GTE(BACKUP, 1))
974                                 rprintf(FINFO, "(new) backup_dir is %s\n", backup_dir_buf);
975                 } else if (INFO_GTE(BACKUP, 1))
976                         rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
977                 if (backup_dir_len > 1)
978                         backup_dir_buf[backup_dir_len-1] = '/';
979         }
980
981         io_flush(FULL_FLUSH);
982
983         if ((pid = do_fork()) == -1) {
984                 rsyserr(FERROR, errno, "fork failed in do_recv");
985                 exit_cleanup(RERR_IPC);
986         }
987
988         if (pid == 0) {
989                 am_receiver = 1;
990                 send_msgs_to_gen = am_server;
991
992                 close(error_pipe[0]);
993
994                 /* We can't let two processes write to the socket at one time. */
995                 io_end_multiplex_out(MPLX_SWITCHING);
996                 if (f_in != f_out)
997                         close(f_out);
998                 sock_f_out = -1;
999                 f_out = error_pipe[1];
1000
1001                 bwlimit_writemax = 0; /* receiver doesn't need to do this */
1002
1003                 if (read_batch)
1004                         io_start_buffering_in(f_in);
1005                 io_start_multiplex_out(f_out);
1006
1007                 recv_files(f_in, f_out, local_name);
1008                 io_flush(FULL_FLUSH);
1009                 handle_stats(f_in);
1010
1011                 if (output_needs_newline) {
1012                         fputc('\n', stdout);
1013                         output_needs_newline = 0;
1014                 }
1015
1016                 write_int(f_out, NDX_DONE);
1017                 send_msg(MSG_STATS, (char*)&stats.total_read, sizeof stats.total_read, 0);
1018                 io_flush(FULL_FLUSH);
1019
1020                 /* Handle any keep-alive packets from the post-processing work
1021                  * that the generator does. */
1022                 if (protocol_version >= 29) {
1023                         kluge_around_eof = -1;
1024
1025                         /* This should only get stopped via a USR2 signal. */
1026                         read_final_goodbye(f_in, f_out);
1027
1028                         rprintf(FERROR, "Invalid packet at end of run [%s]\n",
1029                                 who_am_i());
1030                         exit_cleanup(RERR_PROTOCOL);
1031                 }
1032
1033                 /* Finally, we go to sleep until our parent kills us with a
1034                  * USR2 signal.  We sleep for a short time, as on some OSes
1035                  * a signal won't interrupt a sleep! */
1036                 while (1)
1037                         msleep(20);
1038         }
1039
1040         am_generator = 1;
1041         flist_receiving_enabled = True;
1042
1043         io_end_multiplex_in(MPLX_SWITCHING);
1044         if (write_batch && !am_server)
1045                 stop_write_batch();
1046
1047         close(error_pipe[1]);
1048         if (f_in != f_out)
1049                 close(f_in);
1050         sock_f_in = -1;
1051         f_in = error_pipe[0];
1052
1053         io_start_buffering_out(f_out);
1054         io_start_multiplex_in(f_in);
1055
1056 #ifdef SUPPORT_HARD_LINKS
1057         if (preserve_hard_links && inc_recurse) {
1058                 struct file_list *flist;
1059                 for (flist = first_flist; flist; flist = flist->next)
1060                         match_hard_links(flist);
1061         }
1062 #endif
1063
1064         generate_files(f_out, local_name);
1065
1066         handle_stats(-1);
1067         io_flush(FULL_FLUSH);
1068         shutting_down = True;
1069         if (protocol_version >= 24) {
1070                 /* send a final goodbye message */
1071                 write_ndx(f_out, NDX_DONE);
1072         }
1073         io_flush(FULL_FLUSH);
1074
1075         kill(pid, SIGUSR2);
1076         wait_process_with_flush(pid, &exit_code);
1077         return exit_code;
1078 }
1079
1080 static void do_server_recv(int f_in, int f_out, int argc, char *argv[])
1081 {
1082         int exit_code;
1083         struct file_list *flist;
1084         char *local_name = NULL;
1085         int negated_levels;
1086
1087         if (filesfrom_fd >= 0 && !msgs2stderr && protocol_version < 31) {
1088                 /* We can't mix messages with files-from data on the socket,
1089                  * so temporarily turn off info/debug messages. */
1090                 negate_output_levels();
1091                 negated_levels = 1;
1092         } else
1093                 negated_levels = 0;
1094
1095         if (DEBUG_GTE(RECV, 1))
1096                 rprintf(FINFO, "server_recv(%d) starting pid=%d\n", argc, (int)getpid());
1097
1098         if (am_daemon && read_only) {
1099                 rprintf(FERROR,"ERROR: module is read only\n");
1100                 exit_cleanup(RERR_SYNTAX);
1101                 return;
1102         }
1103
1104         become_copy_as_user();
1105
1106         if (argc > 0) {
1107                 char *dir = argv[0];
1108                 argc--;
1109                 argv++;
1110                 if (!am_daemon && !change_dir(dir, CD_NORMAL)) {
1111                         rsyserr(FERROR, errno, "change_dir#4 %s failed",
1112                                 full_fname(dir));
1113                         exit_cleanup(RERR_FILESELECT);
1114                 }
1115         }
1116
1117         if (protocol_version >= 30)
1118                 io_start_multiplex_in(f_in);
1119         else
1120                 io_start_buffering_in(f_in);
1121         recv_filter_list(f_in);
1122
1123         if (filesfrom_fd >= 0) {
1124                 /* We need to send the files-from names to the sender at the
1125                  * same time that we receive the file-list from them, so we
1126                  * need the IO routines to automatically write out the names
1127                  * onto our f_out socket as we read the file-list.  This
1128                  * avoids both deadlock and extra delays/buffers. */
1129                 start_filesfrom_forwarding(filesfrom_fd);
1130                 filesfrom_fd = -1;
1131         }
1132
1133         flist = recv_file_list(f_in, -1);
1134         if (!flist) {
1135                 rprintf(FERROR,"server_recv: recv_file_list error\n");
1136                 exit_cleanup(RERR_FILESELECT);
1137         }
1138         if (inc_recurse && file_total == 1)
1139                 recv_additional_file_list(f_in);
1140
1141         if (negated_levels)
1142                 negate_output_levels();
1143
1144         if (argc > 0)
1145                 local_name = get_local_name(flist,argv[0]);
1146
1147         /* Now that we know what our destination directory turned out to be,
1148          * we can sanitize the --link-/copy-/compare-dest args correctly. */
1149         if (sanitize_paths) {
1150                 char **dir_p;
1151                 for (dir_p = basis_dir; *dir_p; dir_p++)
1152                         *dir_p = sanitize_path(NULL, *dir_p, NULL, curr_dir_depth, SP_DEFAULT);
1153                 if (partial_dir)
1154                         partial_dir = sanitize_path(NULL, partial_dir, NULL, curr_dir_depth, SP_DEFAULT);
1155         }
1156         check_alt_basis_dirs();
1157
1158         if (daemon_filter_list.head) {
1159                 char **dir_p;
1160                 filter_rule_list *elp = &daemon_filter_list;
1161
1162                 for (dir_p = basis_dir; *dir_p; dir_p++) {
1163                         char *dir = *dir_p;
1164                         if (*dir == '/')
1165                                 dir += module_dirlen;
1166                         if (check_filter(elp, FLOG, dir, 1) < 0)
1167                                 goto options_rejected;
1168                 }
1169                 if (partial_dir && *partial_dir == '/'
1170                  && check_filter(elp, FLOG, partial_dir + module_dirlen, 1) < 0) {
1171                     options_rejected:
1172                         rprintf(FERROR,
1173                                 "Your options have been rejected by the server.\n");
1174                         exit_cleanup(RERR_SYNTAX);
1175                 }
1176         }
1177
1178         exit_code = do_recv(f_in, f_out, local_name);
1179         exit_cleanup(exit_code);
1180 }
1181
1182
1183 int child_main(int argc, char *argv[])
1184 {
1185         start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1186         return 0;
1187 }
1188
1189
1190 void start_server(int f_in, int f_out, int argc, char *argv[])
1191 {
1192         set_nonblocking(f_in);
1193         set_nonblocking(f_out);
1194
1195         io_set_sock_fds(f_in, f_out);
1196         setup_protocol(f_out, f_in);
1197
1198         if (protocol_version >= 23)
1199                 io_start_multiplex_out(f_out);
1200         if (am_daemon && io_timeout && protocol_version >= 31)
1201                 send_msg_int(MSG_IO_TIMEOUT, io_timeout);
1202
1203         if (am_sender) {
1204                 keep_dirlinks = 0; /* Must be disabled on the sender. */
1205                 if (need_messages_from_generator)
1206                         io_start_multiplex_in(f_in);
1207                 else
1208                         io_start_buffering_in(f_in);
1209                 recv_filter_list(f_in);
1210                 do_server_sender(f_in, f_out, argc, argv);
1211         } else
1212                 do_server_recv(f_in, f_out, argc, argv);
1213         exit_cleanup(0);
1214 }
1215
1216 /* This is called once the connection has been negotiated.  It is used
1217  * for rsyncd, remote-shell, and local connections. */
1218 int client_run(int f_in, int f_out, pid_t pid, int argc, char *argv[])
1219 {
1220         struct file_list *flist = NULL;
1221         int exit_code = 0, exit_code2 = 0;
1222         char *local_name = NULL;
1223
1224         cleanup_child_pid = pid;
1225         if (!read_batch) {
1226                 set_nonblocking(f_in);
1227                 set_nonblocking(f_out);
1228         }
1229
1230         io_set_sock_fds(f_in, f_out);
1231         setup_protocol(f_out,f_in);
1232
1233         /* We set our stderr file handle to blocking because ssh might have
1234          * set it to non-blocking.  This can be particularly troublesome if
1235          * stderr is a clone of stdout, because ssh would have set our stdout
1236          * to non-blocking at the same time (which can easily cause us to lose
1237          * output from our print statements).  This kluge shouldn't cause ssh
1238          * any problems for how we use it.  Note also that we delayed setting
1239          * this until after the above protocol setup so that we know for sure
1240          * that ssh is done twiddling its file descriptors.  */
1241         set_blocking(STDERR_FILENO);
1242
1243         if (am_sender) {
1244                 keep_dirlinks = 0; /* Must be disabled on the sender. */
1245
1246                 if (always_checksum
1247                  && (log_format_has(stdout_format, 'C')
1248                   || log_format_has(logfile_format, 'C')))
1249                         sender_keeps_checksum = 1;
1250
1251                 if (protocol_version >= 30)
1252                         io_start_multiplex_out(f_out);
1253                 else
1254                         io_start_buffering_out(f_out);
1255                 if (protocol_version >= 31 || (!filesfrom_host && protocol_version >= 23))
1256                         io_start_multiplex_in(f_in);
1257                 else
1258                         io_start_buffering_in(f_in);
1259                 send_filter_list(f_out);
1260                 if (filesfrom_host)
1261                         filesfrom_fd = f_in;
1262
1263                 if (write_batch && !am_server)
1264                         start_write_batch(f_out);
1265
1266                 become_copy_as_user();
1267
1268                 flist = send_file_list(f_out, argc, argv);
1269                 if (DEBUG_GTE(FLIST, 3))
1270                         rprintf(FINFO,"file list sent\n");
1271
1272                 if (protocol_version < 31 && filesfrom_host && protocol_version >= 23)
1273                         io_start_multiplex_in(f_in);
1274
1275                 io_flush(NORMAL_FLUSH);
1276                 send_files(f_in, f_out);
1277                 io_flush(FULL_FLUSH);
1278                 handle_stats(-1);
1279                 if (protocol_version >= 24)
1280                         read_final_goodbye(f_in, f_out);
1281                 if (pid != -1) {
1282                         if (DEBUG_GTE(EXIT, 2))
1283                                 rprintf(FINFO,"client_run waiting on %d\n", (int) pid);
1284                         io_flush(FULL_FLUSH);
1285                         wait_process_with_flush(pid, &exit_code);
1286                 }
1287                 output_summary();
1288                 io_flush(FULL_FLUSH);
1289                 exit_cleanup(exit_code);
1290         }
1291
1292         if (!read_batch) {
1293                 if (protocol_version >= 23)
1294                         io_start_multiplex_in(f_in);
1295                 if (need_messages_from_generator)
1296                         io_start_multiplex_out(f_out);
1297                 else
1298                         io_start_buffering_out(f_out);
1299         }
1300
1301         become_copy_as_user();
1302
1303         send_filter_list(read_batch ? -1 : f_out);
1304
1305         if (filesfrom_fd >= 0) {
1306                 start_filesfrom_forwarding(filesfrom_fd);
1307                 filesfrom_fd = -1;
1308         }
1309
1310         if (write_batch && !am_server)
1311                 start_write_batch(f_in);
1312         flist = recv_file_list(f_in, -1);
1313         if (inc_recurse && file_total == 1)
1314                 recv_additional_file_list(f_in);
1315
1316         if (flist && flist->used > 0) {
1317                 local_name = get_local_name(flist, argv[0]);
1318
1319                 check_alt_basis_dirs();
1320
1321                 exit_code2 = do_recv(f_in, f_out, local_name);
1322         } else {
1323                 handle_stats(-1);
1324                 output_summary();
1325         }
1326
1327         if (pid != -1) {
1328                 if (DEBUG_GTE(RECV, 1))
1329                         rprintf(FINFO,"client_run2 waiting on %d\n", (int) pid);
1330                 io_flush(FULL_FLUSH);
1331                 wait_process_with_flush(pid, &exit_code);
1332         }
1333
1334         return MAX(exit_code, exit_code2);
1335 }
1336
1337 static int copy_argv(char *argv[])
1338 {
1339         int i;
1340
1341         for (i = 0; argv[i]; i++) {
1342                 if (!(argv[i] = strdup(argv[i]))) {
1343                         rprintf (FERROR, "out of memory at %s(%d)\n",
1344                                  __FILE__, __LINE__);
1345                         return RERR_MALLOC;
1346                 }
1347         }
1348
1349         return 0;
1350 }
1351
1352
1353 /* Start a client for either type of remote connection.  Work out
1354  * whether the arguments request a remote shell or rsyncd connection,
1355  * and call the appropriate connection function, then run_client.
1356  *
1357  * Calls either start_socket_client (for sockets) or do_cmd and
1358  * client_run (for ssh). */
1359 static int start_client(int argc, char *argv[])
1360 {
1361         char *p, *shell_machine = NULL, *shell_user = NULL;
1362         char **remote_argv;
1363         int remote_argc, env_port = rsync_port;
1364         int f_in, f_out;
1365         int ret;
1366         pid_t pid;
1367
1368         /* Don't clobber argv[] so that ps(1) can still show the right
1369          * command line. */
1370         if ((ret = copy_argv(argv)) != 0)
1371                 return ret;
1372
1373         if (!read_batch) { /* for read_batch, NO source is specified */
1374                 char *path = check_for_hostspec(argv[0], &shell_machine, &rsync_port);
1375                 if (path) { /* source is remote */
1376                         char *dummy_host;
1377                         int dummy_port = 0;
1378                         *argv = path;
1379                         remote_argv = argv;
1380                         remote_argc = argc;
1381                         argv += argc - 1;
1382                         if (argc == 1 || **argv == ':')
1383                                 argc = 0; /* no dest arg */
1384                         else if (check_for_hostspec(*argv, &dummy_host, &dummy_port)) {
1385                                 rprintf(FERROR,
1386                                         "The source and destination cannot both be remote.\n");
1387                                 exit_cleanup(RERR_SYNTAX);
1388                         } else {
1389                                 remote_argc--; /* don't count dest */
1390                                 argc = 1;
1391                         }
1392                         if (filesfrom_host && *filesfrom_host
1393                             && strcmp(filesfrom_host, shell_machine) != 0) {
1394                                 rprintf(FERROR,
1395                                         "--files-from hostname is not the same as the transfer hostname\n");
1396                                 exit_cleanup(RERR_SYNTAX);
1397                         }
1398                         am_sender = 0;
1399                         if (rsync_port)
1400                                 daemon_over_rsh = shell_cmd ? 1 : -1;
1401                 } else { /* source is local, check dest arg */
1402                         am_sender = 1;
1403
1404                         if (argc > 1) {
1405                                 p = argv[--argc];
1406                                 remote_argv = argv + argc;
1407                         } else {
1408                                 static char *dotarg[1] = { "." };
1409                                 p = dotarg[0];
1410                                 remote_argv = dotarg;
1411                         }
1412                         remote_argc = 1;
1413
1414                         path = check_for_hostspec(p, &shell_machine, &rsync_port);
1415                         if (path && filesfrom_host && *filesfrom_host
1416                             && strcmp(filesfrom_host, shell_machine) != 0) {
1417                                 rprintf(FERROR,
1418                                         "--files-from hostname is not the same as the transfer hostname\n");
1419                                 exit_cleanup(RERR_SYNTAX);
1420                         }
1421                         if (!path) { /* no hostspec found, so src & dest are local */
1422                                 local_server = 1;
1423                                 if (filesfrom_host) {
1424                                         rprintf(FERROR,
1425                                                 "--files-from cannot be remote when the transfer is local\n");
1426                                         exit_cleanup(RERR_SYNTAX);
1427                                 }
1428                                 shell_machine = NULL;
1429                                 rsync_port = 0;
1430                         } else { /* hostspec was found, so dest is remote */
1431                                 argv[argc] = path;
1432                                 if (rsync_port)
1433                                         daemon_over_rsh = shell_cmd ? 1 : -1;
1434                         }
1435                 }
1436         } else {  /* read_batch */
1437                 local_server = 1;
1438                 if (check_for_hostspec(argv[argc-1], &shell_machine, &rsync_port)) {
1439                         rprintf(FERROR, "remote destination is not allowed with --read-batch\n");
1440                         exit_cleanup(RERR_SYNTAX);
1441                 }
1442                 remote_argv = argv += argc - 1;
1443                 remote_argc = argc = 1;
1444                 rsync_port = 0;
1445         }
1446
1447         if (!rsync_port && remote_argc && !**remote_argv) /* Turn an empty arg into a dot dir. */
1448                 *remote_argv = ".";
1449
1450         if (am_sender) {
1451                 char *dummy_host;
1452                 int dummy_port = rsync_port;
1453                 int i;
1454                 /* For local source, extra source args must not have hostspec. */
1455                 for (i = 1; i < argc; i++) {
1456                         if (check_for_hostspec(argv[i], &dummy_host, &dummy_port)) {
1457                                 rprintf(FERROR, "Unexpected remote arg: %s\n", argv[i]);
1458                                 exit_cleanup(RERR_SYNTAX);
1459                         }
1460                 }
1461         } else {
1462                 char *dummy_host;
1463                 int dummy_port = rsync_port;
1464                 int i;
1465                 /* For remote source, any extra source args must have either
1466                  * the same hostname or an empty hostname. */
1467                 for (i = 1; i < remote_argc; i++) {
1468                         char *arg = check_for_hostspec(remote_argv[i], &dummy_host, &dummy_port);
1469                         if (!arg) {
1470                                 rprintf(FERROR, "Unexpected local arg: %s\n", remote_argv[i]);
1471                                 rprintf(FERROR, "If arg is a remote file/dir, prefix it with a colon (:).\n");
1472                                 exit_cleanup(RERR_SYNTAX);
1473                         }
1474                         if (*dummy_host && strcmp(dummy_host, shell_machine) != 0) {
1475                                 rprintf(FERROR, "All source args must come from the same machine.\n");
1476                                 exit_cleanup(RERR_SYNTAX);
1477                         }
1478                         if (rsync_port != dummy_port) {
1479                                 if (!rsync_port || !dummy_port)
1480                                         rprintf(FERROR, "All source args must use the same hostspec format.\n");
1481                                 else
1482                                         rprintf(FERROR, "All source args must use the same port number.\n");
1483                                 exit_cleanup(RERR_SYNTAX);
1484                         }
1485                         if (!rsync_port && !*arg) /* Turn an empty arg into a dot dir. */
1486                                 arg = ".";
1487                         remote_argv[i] = arg;
1488                 }
1489         }
1490
1491         if (rsync_port < 0)
1492                 rsync_port = RSYNC_PORT;
1493         else
1494                 env_port = rsync_port;
1495
1496         if (daemon_over_rsh < 0)
1497                 return start_socket_client(shell_machine, remote_argc, remote_argv, argc, argv);
1498
1499         if (password_file && !daemon_over_rsh) {
1500                 rprintf(FERROR, "The --password-file option may only be "
1501                                 "used when accessing an rsync daemon.\n");
1502                 exit_cleanup(RERR_SYNTAX);
1503         }
1504
1505         if (connect_timeout) {
1506                 rprintf(FERROR, "The --contimeout option may only be "
1507                                 "used when connecting to an rsync daemon.\n");
1508                 exit_cleanup(RERR_SYNTAX);
1509         }
1510
1511         if (shell_machine) {
1512                 p = strrchr(shell_machine,'@');
1513                 if (p) {
1514                         *p = 0;
1515                         shell_user = shell_machine;
1516                         shell_machine = p+1;
1517                 }
1518         }
1519
1520         if (DEBUG_GTE(CMD, 2)) {
1521                 rprintf(FINFO,"cmd=%s machine=%s user=%s path=%s\n",
1522                         NS(shell_cmd), NS(shell_machine), NS(shell_user),
1523                         NS(remote_argv[0]));
1524         }
1525
1526 #ifdef HAVE_PUTENV
1527         if (daemon_over_rsh)
1528                 set_env_num("RSYNC_PORT", env_port);
1529 #endif
1530
1531         pid = do_cmd(shell_cmd, shell_machine, shell_user, remote_argv, remote_argc,
1532                      &f_in, &f_out);
1533
1534         /* if we're running an rsync server on the remote host over a
1535          * remote shell command, we need to do the RSYNCD protocol first */
1536         if (daemon_over_rsh) {
1537                 int tmpret;
1538                 tmpret = start_inband_exchange(f_in, f_out, shell_user, remote_argc, remote_argv);
1539                 if (tmpret < 0)
1540                         return tmpret;
1541         }
1542
1543         ret = client_run(f_in, f_out, pid, argc, argv);
1544
1545         fflush(stdout);
1546         fflush(stderr);
1547
1548         return ret;
1549 }
1550
1551
1552 static void sigusr1_handler(UNUSED(int val))
1553 {
1554         called_from_signal_handler = 1;
1555         exit_cleanup(RERR_SIGNAL1);
1556 }
1557
1558 static void sigusr2_handler(UNUSED(int val))
1559 {
1560         if (!am_server)
1561                 output_summary();
1562         close_all();
1563         if (got_xfer_error)
1564                 _exit(RERR_PARTIAL);
1565         _exit(0);
1566 }
1567
1568 static void siginfo_handler(UNUSED(int val))
1569 {
1570         if (!am_server && !INFO_GTE(PROGRESS, 1))
1571                 want_progress_now = True;
1572 }
1573
1574 void remember_children(UNUSED(int val))
1575 {
1576 #ifdef WNOHANG
1577         int cnt, status;
1578         pid_t pid;
1579         /* An empty waitpid() loop was put here by Tridge and we could never
1580          * get him to explain why he put it in, so rather than taking it
1581          * out we're instead saving the child exit statuses for later use.
1582          * The waitpid() loop presumably eliminates all possibility of leaving
1583          * zombie children, maybe that's why he did it. */
1584         while ((pid = waitpid(-1, &status, WNOHANG)) > 0) {
1585                 /* save the child's exit status */
1586                 for (cnt = 0; cnt < MAXCHILDPROCS; cnt++) {
1587                         if (pid_stat_table[cnt].pid == 0) {
1588                                 pid_stat_table[cnt].pid = pid;
1589                                 pid_stat_table[cnt].status = status;
1590                                 break;
1591                         }
1592                 }
1593         }
1594 #endif
1595 #ifndef HAVE_SIGACTION
1596         signal(SIGCHLD, remember_children);
1597 #endif
1598 }
1599
1600
1601 /**
1602  * This routine catches signals and tries to send them to gdb.
1603  *
1604  * Because it's called from inside a signal handler it ought not to
1605  * use too many library routines.
1606  *
1607  * @todo Perhaps use "screen -X" instead/as well, to help people
1608  * debugging without easy access to X.  Perhaps use an environment
1609  * variable, or just call a script?
1610  *
1611  * @todo The /proc/ magic probably only works on Linux (and
1612  * Solaris?)  Can we be more portable?
1613  **/
1614 #ifdef MAINTAINER_MODE
1615 const char *get_panic_action(void)
1616 {
1617         const char *cmd_fmt = getenv("RSYNC_PANIC_ACTION");
1618
1619         if (cmd_fmt)
1620                 return cmd_fmt;
1621         return "xterm -display :0 -T Panic -n Panic -e gdb /proc/%d/exe %d";
1622 }
1623
1624
1625 /**
1626  * Handle a fatal signal by launching a debugger, controlled by $RSYNC_PANIC_ACTION.
1627  *
1628  * This signal handler is only installed if we were configured with
1629  * --enable-maintainer-mode.  Perhaps it should always be on and we
1630  * should just look at the environment variable, but I'm a bit leery
1631  * of a signal sending us into a busy loop.
1632  **/
1633 static void rsync_panic_handler(UNUSED(int whatsig))
1634 {
1635         char cmd_buf[300];
1636         int ret, pid_int = getpid();
1637
1638         snprintf(cmd_buf, sizeof cmd_buf, get_panic_action(), pid_int, pid_int);
1639
1640         /* Unless we failed to execute gdb, we allow the process to
1641          * continue.  I'm not sure if that's right. */
1642         ret = shell_exec(cmd_buf);
1643         if (ret)
1644                 _exit(ret);
1645 }
1646 #endif
1647
1648
1649 int main(int argc,char *argv[])
1650 {
1651         int ret;
1652
1653         raw_argc = argc;
1654         raw_argv = argv;
1655
1656 #ifdef HAVE_SIGACTION
1657 # ifdef HAVE_SIGPROCMASK
1658         sigset_t sigmask;
1659
1660         sigemptyset(&sigmask);
1661 # endif
1662         sigact.sa_flags = SA_NOCLDSTOP;
1663 #endif
1664         SIGACTMASK(SIGUSR1, sigusr1_handler);
1665         SIGACTMASK(SIGUSR2, sigusr2_handler);
1666         SIGACTMASK(SIGCHLD, remember_children);
1667 #ifdef MAINTAINER_MODE
1668         SIGACTMASK(SIGSEGV, rsync_panic_handler);
1669         SIGACTMASK(SIGFPE, rsync_panic_handler);
1670         SIGACTMASK(SIGABRT, rsync_panic_handler);
1671         SIGACTMASK(SIGBUS, rsync_panic_handler);
1672 #endif
1673 #ifdef SIGINFO
1674         SIGACTMASK(SIGINFO, siginfo_handler);
1675 #endif
1676 #ifdef SIGVTALRM
1677         SIGACTMASK(SIGVTALRM, siginfo_handler);
1678 #endif
1679
1680         starttime = time(NULL);
1681         our_uid = MY_UID();
1682         our_gid = MY_GID();
1683         am_root = our_uid == 0;
1684
1685         memset(&stats, 0, sizeof(stats));
1686
1687         /* Even a non-daemon runs needs the default config values to be set, e.g.
1688          * lp_dont_compress() is queried when no --skip-compress option is set. */
1689         reset_daemon_vars();
1690
1691         if (argc < 2) {
1692                 usage(FERROR);
1693                 exit_cleanup(RERR_SYNTAX);
1694         }
1695
1696         /* Get the umask for use in permission calculations.  We no longer set
1697          * it to zero; that is ugly and pointless now that all the callers that
1698          * relied on it have been reeducated to work with default ACLs. */
1699         umask(orig_umask = umask(0));
1700
1701 #if defined CONFIG_LOCALE && defined HAVE_SETLOCALE
1702         setlocale(LC_CTYPE, "");
1703 #endif
1704
1705         if (!parse_arguments(&argc, (const char ***) &argv)) {
1706                 option_error();
1707                 exit_cleanup(RERR_SYNTAX);
1708         }
1709         if (write_batch
1710          && poptDupArgv(argc, (const char **)argv, &cooked_argc, (const char ***)&cooked_argv) != 0)
1711                 out_of_memory("main");
1712
1713         SIGACTMASK(SIGINT, sig_int);
1714         SIGACTMASK(SIGHUP, sig_int);
1715         SIGACTMASK(SIGTERM, sig_int);
1716 #if defined HAVE_SIGACTION && HAVE_SIGPROCMASK
1717         sigprocmask(SIG_UNBLOCK, &sigmask, NULL);
1718 #endif
1719
1720         /* Ignore SIGPIPE; we consistently check error codes and will
1721          * see the EPIPE. */
1722         SIGACTION(SIGPIPE, SIG_IGN);
1723 #ifdef SIGXFSZ
1724         SIGACTION(SIGXFSZ, SIG_IGN);
1725 #endif
1726
1727         /* Initialize change_dir() here because on some old systems getcwd
1728          * (implemented by forking "pwd" and reading its output) doesn't
1729          * work when there are other child processes.  Also, on all systems
1730          * that implement getcwd that way "pwd" can't be found after chroot. */
1731         change_dir(NULL, CD_NORMAL);
1732
1733         if ((write_batch || read_batch) && !am_server) {
1734                 open_batch_files(); /* sets batch_fd */
1735                 if (read_batch)
1736                         read_stream_flags(batch_fd);
1737                 else
1738                         write_stream_flags(batch_fd);
1739         }
1740         if (write_batch < 0)
1741                 dry_run = 1;
1742
1743         if (am_server) {
1744 #ifdef ICONV_CONST
1745                 setup_iconv();
1746 #endif
1747         } else if (am_daemon)
1748                 return daemon_main();
1749
1750         if (am_server && protect_args) {
1751                 char buf[MAXPATHLEN];
1752                 protect_args = 2;
1753                 read_args(STDIN_FILENO, NULL, buf, sizeof buf, 1, &argv, &argc, NULL);
1754                 if (!parse_arguments(&argc, (const char ***) &argv)) {
1755                         option_error();
1756                         exit_cleanup(RERR_SYNTAX);
1757                 }
1758         }
1759
1760         if (argc < 1) {
1761                 usage(FERROR);
1762                 exit_cleanup(RERR_SYNTAX);
1763         }
1764
1765         if (am_server) {
1766                 set_nonblocking(STDIN_FILENO);
1767                 set_nonblocking(STDOUT_FILENO);
1768                 if (am_daemon)
1769                         return start_daemon(STDIN_FILENO, STDOUT_FILENO);
1770                 start_server(STDIN_FILENO, STDOUT_FILENO, argc, argv);
1771         }
1772
1773         ret = start_client(argc, argv);
1774         if (ret == -1)
1775                 exit_cleanup(RERR_STARTCLIENT);
1776         else
1777                 exit_cleanup(ret);
1778
1779         return ret;
1780 }