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