- Improved option_error() to make sure that the user sees the error in
[rsync.git] / options.c
1 /*  -*- c-file-style: "linux" -*-
2  *
3  * Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4  * Copyright (C) 2000, 2001, 2002 by Martin Pool <mbp@samba.org>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19  */
20
21 #include "rsync.h"
22 #include "popt.h"
23
24 extern int sanitize_paths;
25 extern char curr_dir[MAXPATHLEN];
26 extern struct exclude_list_struct exclude_list;
27
28 int make_backups = 0;
29
30 /**
31  * If 1, send the whole file as literal data rather than trying to
32  * create an incremental diff.
33  *
34  * If -1, then look at whether we're local or remote and go by that.
35  *
36  * @sa disable_deltas_p()
37  **/
38 int whole_file = -1;
39
40 int archive_mode = 0;
41 int copy_links = 0;
42 int preserve_links = 0;
43 int preserve_hard_links = 0;
44 int preserve_perms = 0;
45 int preserve_devices = 0;
46 int preserve_uid = 0;
47 int preserve_gid = 0;
48 int preserve_times = 0;
49 int update_only = 0;
50 int cvs_exclude = 0;
51 int dry_run = 0;
52 int local_server = 0;
53 int ignore_times = 0;
54 int delete_mode = 0;
55 int delete_excluded = 0;
56 int one_file_system = 0;
57 int protocol_version = PROTOCOL_VERSION;
58 int sparse_files = 0;
59 int do_compression = 0;
60 int am_root = 0;
61 int orig_umask = 0;
62 int relative_paths = -1;
63 int implied_dirs = 1;
64 int numeric_ids = 0;
65 int force_delete = 0;
66 int io_timeout = 0;
67 int read_only = 0;
68 int module_id = -1;
69 int am_server = 0;
70 int am_sender = 0;
71 int am_generator = 0;
72 char *files_from = NULL;
73 int filesfrom_fd = -1;
74 char *remote_filesfrom_file = NULL;
75 int eol_nulls = 0;
76 int recurse = 0;
77 int am_daemon = 0;
78 int daemon_over_rsh = 0;
79 int do_stats = 0;
80 int do_progress = 0;
81 int keep_partial = 0;
82 int safe_symlinks = 0;
83 int copy_unsafe_links = 0;
84 int size_only = 0;
85 int bwlimit = 0;
86 int delete_after = 0;
87 int only_existing = 0;
88 int opt_ignore_existing = 0;
89 int max_delete = 0;
90 int ignore_errors = 0;
91 int modify_window = 0;
92 int blocking_io = -1;
93 int checksum_seed = 0;
94 unsigned int block_size = 0;
95
96
97 /** Network address family. **/
98 #ifdef INET6
99 int default_af_hint = 0;        /* Any protocol */
100 #else
101 int default_af_hint = AF_INET;  /* Must use IPv4 */
102 #endif
103
104 /** Do not go into the background when run as --daemon.  Good
105  * for debugging and required for running as a service on W32,
106  * or under Unix process-monitors. **/
107 int no_detach = 0;
108
109 int write_batch = 0;
110 int read_batch = 0;
111 int backup_dir_len = 0;
112 int backup_suffix_len;
113 unsigned int backup_dir_remainder;
114
115 char *backup_suffix = NULL;
116 char *tmpdir = NULL;
117 char *compare_dest = NULL;
118 char *config_file = NULL;
119 char *shell_cmd = NULL;
120 char *log_format = NULL;
121 char *password_file = NULL;
122 char *rsync_path = RSYNC_PATH;
123 char *backup_dir = NULL;
124 char backup_dir_buf[MAXPATHLEN];
125 int rsync_port = RSYNC_PORT;
126 int link_dest = 0;
127
128 int verbose = 0;
129 int quiet = 0;
130 int always_checksum = 0;
131 int list_only = 0;
132
133 #define FIXED_CHECKSUM_SEED 32761
134 #define MAX_BATCH_PREFIX_LEN 256        /* Must be less than MAXPATHLEN-13 */
135 char *batch_prefix = NULL;
136
137 static int daemon_opt;   /* sets am_daemon after option error-reporting */
138 static int modify_window_set;
139
140 /** Local address to bind.  As a character string because it's
141  * interpreted by the IPv6 layer: should be a numeric IP4 or ip6
142  * address, or a hostname. **/
143 char *bind_address;
144
145
146 static void print_rsync_version(enum logcode f)
147 {
148         char const *got_socketpair = "no ";
149         char const *hardlinks = "no ";
150         char const *links = "no ";
151         char const *ipv6 = "no ";
152         STRUCT_STAT *dumstat;
153
154 #ifdef HAVE_SOCKETPAIR
155         got_socketpair = "";
156 #endif
157
158 #if SUPPORT_HARD_LINKS
159         hardlinks = "";
160 #endif
161
162 #if SUPPORT_LINKS
163         links = "";
164 #endif
165
166 #if INET6
167         ipv6 = "";
168 #endif
169
170         rprintf(f, "%s  version %s  protocol version %d\n",
171                 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
172         rprintf(f,
173                 "Copyright (C) 1996-2004 by Andrew Tridgell and others\n");
174         rprintf(f, "<http://rsync.samba.org/>\n");
175         rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
176                 "%shard links, %ssymlinks, batchfiles, \n",
177                 (int) (sizeof (OFF_T) * 8),
178                 got_socketpair, hardlinks, links);
179
180         /* Note that this field may not have type ino_t.  It depends
181          * on the complicated interaction between largefile feature
182          * macros. */
183         rprintf(f, "              %sIPv6, %d-bit system inums, %d-bit internal inums\n",
184                 ipv6,
185                 (int) (sizeof dumstat->st_ino * 8),
186                 (int) (sizeof (uint64) * 8));
187 #ifdef MAINTAINER_MODE
188         rprintf(f, "              panic action: \"%s\"\n",
189                 get_panic_action());
190 #endif
191
192 #ifdef NO_INT64
193         rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
194 #endif
195
196         rprintf(f,
197 "\n"
198 "rsync comes with ABSOLUTELY NO WARRANTY.  This is free software, and you\n"
199 "are welcome to redistribute it under certain conditions.  See the GNU\n"
200 "General Public Licence for details.\n"
201                 );
202 }
203
204
205 void usage(enum logcode F)
206 {
207   print_rsync_version(F);
208
209   rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
210
211   rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
212   rprintf(F,"  or   rsync [OPTION]... [USER@]HOST:SRC DEST\n");
213   rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... DEST\n");
214   rprintf(F,"  or   rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
215   rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
216   rprintf(F,"  or   rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
217   rprintf(F,"  or   rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
218   rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
219   rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
220   rprintf(F,"  sources separated by space as long as they have same top-level\n");
221   rprintf(F,"\nOptions\n");
222   rprintf(F," -v, --verbose               increase verbosity\n");
223   rprintf(F," -q, --quiet                 decrease verbosity\n");
224   rprintf(F," -c, --checksum              always checksum\n");
225   rprintf(F," -a, --archive               archive mode, equivalent to -rlptgoD\n");
226   rprintf(F," -r, --recursive             recurse into directories\n");
227   rprintf(F," -R, --relative              use relative path names\n");
228   rprintf(F,"     --no-relative           turn off --relative\n");
229   rprintf(F,"     --no-implied-dirs       don't send implied dirs with -R\n");
230   rprintf(F," -b, --backup                make backups (see --suffix & --backup-dir)\n");
231   rprintf(F,"     --backup-dir            make backups into this directory\n");
232   rprintf(F,"     --suffix=SUFFIX         backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
233   rprintf(F," -u, --update                update only (don't overwrite newer files)\n");
234   rprintf(F," -l, --links                 copy symlinks as symlinks\n");
235   rprintf(F," -L, --copy-links            copy the referent of all symlinks\n");
236   rprintf(F,"     --copy-unsafe-links     copy the referent of \"unsafe\" symlinks\n");
237   rprintf(F,"     --safe-links            ignore \"unsafe\" symlinks\n");
238   rprintf(F," -H, --hard-links            preserve hard links\n");
239   rprintf(F," -p, --perms                 preserve permissions\n");
240   rprintf(F," -o, --owner                 preserve owner (root only)\n");
241   rprintf(F," -g, --group                 preserve group\n");
242   rprintf(F," -D, --devices               preserve devices (root only)\n");
243   rprintf(F," -t, --times                 preserve times\n");
244   rprintf(F," -S, --sparse                handle sparse files efficiently\n");
245   rprintf(F," -n, --dry-run               show what would have been transferred\n");
246   rprintf(F," -W, --whole-file            copy whole files, no incremental checks\n");
247   rprintf(F,"     --no-whole-file         turn off --whole-file\n");
248   rprintf(F," -x, --one-file-system       don't cross filesystem boundaries\n");
249   rprintf(F," -B, --block-size=SIZE       checksum blocking size (default %d)\n",BLOCK_SIZE);
250   rprintf(F," -e, --rsh=COMMAND           specify the remote shell\n");
251   rprintf(F,"     --rsync-path=PATH       specify path to rsync on the remote machine\n");
252   rprintf(F,"     --existing              only update files that already exist\n");
253   rprintf(F,"     --ignore-existing       ignore files that already exist on receiving side\n");
254   rprintf(F,"     --delete                delete files that don't exist on the sending side\n");
255   rprintf(F,"     --delete-excluded       also delete excluded files on the receiving side\n");
256   rprintf(F,"     --delete-after          receiver deletes after transferring, not before\n");
257   rprintf(F,"     --ignore-errors         delete even if there are I/O errors\n");
258   rprintf(F,"     --max-delete=NUM        don't delete more than NUM files\n");
259   rprintf(F,"     --partial               keep partially transferred files\n");
260   rprintf(F,"     --force                 force deletion of directories even if not empty\n");
261   rprintf(F,"     --numeric-ids           don't map uid/gid values by user/group name\n");
262   rprintf(F,"     --timeout=TIME          set I/O timeout in seconds\n");
263   rprintf(F," -I, --ignore-times          turn off mod time & file size quick check\n");
264   rprintf(F,"     --size-only             ignore mod time for quick check (use size)\n");
265   rprintf(F,"     --modify-window=NUM     compare mod times with reduced accuracy\n");
266   rprintf(F," -T  --temp-dir=DIR          create temporary files in directory DIR\n");
267   rprintf(F,"     --compare-dest=DIR      also compare destination files relative to DIR\n");
268   rprintf(F,"     --link-dest=DIR         create hardlinks to DIR for unchanged files\n");
269   rprintf(F," -P                          equivalent to --partial --progress\n");
270   rprintf(F," -z, --compress              compress file data\n");
271   rprintf(F," -C, --cvs-exclude           auto ignore files in the same way CVS does\n");
272   rprintf(F,"     --exclude=PATTERN       exclude files matching PATTERN\n");
273   rprintf(F,"     --exclude-from=FILE     exclude patterns listed in FILE\n");
274   rprintf(F,"     --include=PATTERN       don't exclude files matching PATTERN\n");
275   rprintf(F,"     --include-from=FILE     don't exclude patterns listed in FILE\n");
276   rprintf(F,"     --files-from=FILE       read FILE for list of source-file names\n");
277   rprintf(F," -0  --from0                 all *-from file lists are delimited by nulls\n");
278   rprintf(F,"     --version               print version number\n");
279   rprintf(F,"     --daemon                run as an rsync daemon\n");
280   rprintf(F,"     --no-detach             do not detach from the parent\n");
281   rprintf(F,"     --address=ADDRESS       bind to the specified address\n");
282   rprintf(F,"     --config=FILE           specify alternate rsyncd.conf file\n");
283   rprintf(F,"     --port=PORT             specify alternate rsyncd port number\n");
284   rprintf(F,"     --blocking-io           use blocking I/O for the remote shell\n");
285   rprintf(F,"     --no-blocking-io        turn off --blocking-io\n");
286   rprintf(F,"     --stats                 give some file transfer stats\n");
287   rprintf(F,"     --progress              show progress during transfer\n");
288   rprintf(F,"     --log-format=FORMAT     log file transfers using specified format\n");
289   rprintf(F,"     --password-file=FILE    get password from FILE\n");
290   rprintf(F,"     --bwlimit=KBPS          limit I/O bandwidth, KBytes per second\n");
291   rprintf(F,"     --write-batch=PREFIX    write batch fileset starting with PREFIX\n");
292   rprintf(F,"     --read-batch=PREFIX     read batch fileset starting with PREFIX\n");
293 #ifdef INET6
294   rprintf(F," -4  --ipv4                  prefer IPv4\n");
295   rprintf(F," -6  --ipv6                  prefer IPv6\n");
296 #endif
297   rprintf(F," -h, --help                  show this help screen\n");
298
299   rprintf(F,"\n");
300
301   rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n");
302   rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
303 }
304
305 enum {OPT_VERSION = 1000, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
306       OPT_DELETE_AFTER, OPT_DELETE_EXCLUDED, OPT_LINK_DEST,
307       OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
308       OPT_READ_BATCH, OPT_WRITE_BATCH,
309       OPT_REFUSED_BASE = 9000};
310
311 static struct poptOption long_options[] = {
312   /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
313   {"version",          0,  POPT_ARG_NONE,   0,              OPT_VERSION, 0, 0},
314   {"suffix",           0,  POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
315   {"rsync-path",       0,  POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
316   {"password-file",    0,  POPT_ARG_STRING, &password_file, 0, 0, 0 },
317   {"ignore-times",    'I', POPT_ARG_NONE,   &ignore_times, 0, 0, 0 },
318   {"size-only",        0,  POPT_ARG_NONE,   &size_only, 0, 0, 0 },
319   {"modify-window",    0,  POPT_ARG_INT,    &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
320   {"one-file-system", 'x', POPT_ARG_NONE,   &one_file_system, 0, 0, 0 },
321   {"delete",           0,  POPT_ARG_NONE,   &delete_mode, 0, 0, 0 },
322   {"existing",         0,  POPT_ARG_NONE,   &only_existing, 0, 0, 0 },
323   {"ignore-existing",  0,  POPT_ARG_NONE,   &opt_ignore_existing, 0, 0, 0 },
324   {"delete-after",     0,  POPT_ARG_NONE,   0,              OPT_DELETE_AFTER, 0, 0 },
325   {"delete-excluded",  0,  POPT_ARG_NONE,   0,              OPT_DELETE_EXCLUDED, 0, 0 },
326   {"force",            0,  POPT_ARG_NONE,   &force_delete, 0, 0, 0 },
327   {"numeric-ids",      0,  POPT_ARG_NONE,   &numeric_ids, 0, 0, 0 },
328   {"exclude",          0,  POPT_ARG_STRING, 0,              OPT_EXCLUDE, 0, 0 },
329   {"include",          0,  POPT_ARG_STRING, 0,              OPT_INCLUDE, 0, 0 },
330   {"exclude-from",     0,  POPT_ARG_STRING, 0,              OPT_EXCLUDE_FROM, 0, 0 },
331   {"include-from",     0,  POPT_ARG_STRING, 0,              OPT_INCLUDE_FROM, 0, 0 },
332   {"safe-links",       0,  POPT_ARG_NONE,   &safe_symlinks, 0, 0, 0 },
333   {"help",            'h', POPT_ARG_NONE,   0,              'h', 0, 0 },
334   {"backup",          'b', POPT_ARG_NONE,   &make_backups, 0, 0, 0 },
335   {"dry-run",         'n', POPT_ARG_NONE,   &dry_run, 0, 0, 0 },
336   {"sparse",          'S', POPT_ARG_NONE,   &sparse_files, 0, 0, 0 },
337   {"cvs-exclude",     'C', POPT_ARG_NONE,   &cvs_exclude, 0, 0, 0 },
338   {"update",          'u', POPT_ARG_NONE,   &update_only, 0, 0, 0 },
339   {"links",           'l', POPT_ARG_NONE,   &preserve_links, 0, 0, 0 },
340   {"copy-links",      'L', POPT_ARG_NONE,   &copy_links, 0, 0, 0 },
341   {"whole-file",      'W', POPT_ARG_VAL,    &whole_file, 1, 0, 0 },
342   {"no-whole-file",    0,  POPT_ARG_VAL,    &whole_file, 0, 0, 0 },
343   {"copy-unsafe-links", 0, POPT_ARG_NONE,   &copy_unsafe_links, 0, 0, 0 },
344   {"perms",           'p', POPT_ARG_NONE,   &preserve_perms, 0, 0, 0 },
345   {"owner",           'o', POPT_ARG_NONE,   &preserve_uid, 0, 0, 0 },
346   {"group",           'g', POPT_ARG_NONE,   &preserve_gid, 0, 0, 0 },
347   {"devices",         'D', POPT_ARG_NONE,   &preserve_devices, 0, 0, 0 },
348   {"times",           't', POPT_ARG_NONE,   &preserve_times, 0, 0, 0 },
349   {"checksum",        'c', POPT_ARG_NONE,   &always_checksum, 0, 0, 0 },
350   {"verbose",         'v', POPT_ARG_NONE,   0,               'v', 0, 0 },
351   {"quiet",           'q', POPT_ARG_NONE,   0,               'q', 0, 0 },
352   {"archive",         'a', POPT_ARG_NONE,   &archive_mode, 0, 0, 0 },
353   {"server",           0,  POPT_ARG_NONE,   &am_server, 0, 0, 0 },
354   {"sender",           0,  POPT_ARG_NONE,   0,              OPT_SENDER, 0, 0 },
355   {"recursive",       'r', POPT_ARG_NONE,   &recurse, 0, 0, 0 },
356   {"relative",        'R', POPT_ARG_VAL,    &relative_paths, 1, 0, 0 },
357   {"no-relative",      0,  POPT_ARG_VAL,    &relative_paths, 0, 0, 0 },
358   {"rsh",             'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
359   {"block-size",      'B', POPT_ARG_INT,    &block_size, 0, 0, 0 },
360   {"max-delete",       0,  POPT_ARG_INT,    &max_delete, 0, 0, 0 },
361   {"timeout",          0,  POPT_ARG_INT,    &io_timeout, 0, 0, 0 },
362   {"temp-dir",        'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
363   {"compare-dest",     0,  POPT_ARG_STRING, &compare_dest, 0, 0, 0 },
364   {"link-dest",        0,  POPT_ARG_STRING, &compare_dest,  OPT_LINK_DEST, 0, 0 },
365   /* TODO: Should this take an optional int giving the compression level? */
366   {"compress",        'z', POPT_ARG_NONE,   &do_compression, 0, 0, 0 },
367   {"daemon",           0,  POPT_ARG_NONE,   &daemon_opt, 0, 0, 0 },
368   {"no-detach",        0,  POPT_ARG_NONE,   &no_detach, 0, 0, 0 },
369   {"stats",            0,  POPT_ARG_NONE,   &do_stats, 0, 0, 0 },
370   {"progress",         0,  POPT_ARG_NONE,   &do_progress, 0, 0, 0 },
371   {"partial",          0,  POPT_ARG_NONE,   &keep_partial, 0, 0, 0 },
372   {"ignore-errors",    0,  POPT_ARG_NONE,   &ignore_errors, 0, 0, 0 },
373   {"blocking-io",      0,  POPT_ARG_VAL,    &blocking_io, 1, 0, 0 },
374   {"no-blocking-io",   0,  POPT_ARG_VAL,    &blocking_io, 0, 0, 0 },
375   {0,                 'P', POPT_ARG_NONE,   0,              'P', 0, 0 },
376   {"config",           0,  POPT_ARG_STRING, &config_file, 0, 0, 0 },
377   {"port",             0,  POPT_ARG_INT,    &rsync_port, 0, 0, 0 },
378   {"log-format",       0,  POPT_ARG_STRING, &log_format, 0, 0, 0 },
379   {"bwlimit",          0,  POPT_ARG_INT,    &bwlimit, 0, 0, 0 },
380   {"address",          0,  POPT_ARG_STRING, &bind_address, 0, 0, 0 },
381   {"backup-dir",       0,  POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
382   {"hard-links",      'H', POPT_ARG_NONE,   &preserve_hard_links, 0, 0, 0 },
383   {"read-batch",       0,  POPT_ARG_STRING, &batch_prefix,  OPT_READ_BATCH, 0, 0 },
384   {"write-batch",      0,  POPT_ARG_STRING, &batch_prefix,  OPT_WRITE_BATCH, 0, 0 },
385   {"files-from",       0,  POPT_ARG_STRING, &files_from, 0, 0, 0 },
386   {"from0",           '0', POPT_ARG_NONE,   &eol_nulls, 0, 0, 0},
387   {"no-implied-dirs",  0,  POPT_ARG_VAL,    &implied_dirs, 0, 0, 0 },
388   {"protocol",         0,  POPT_ARG_INT,    &protocol_version, 0, 0, 0 },
389 #ifdef INET6
390   {"ipv4",            '4', POPT_ARG_VAL,    &default_af_hint, AF_INET, 0, 0 },
391   {"ipv6",            '6', POPT_ARG_VAL,    &default_af_hint, AF_INET6, 0, 0 },
392 #endif
393   {0,0,0,0, 0, 0, 0}
394 };
395
396
397 static char err_buf[200];
398
399
400 /**
401  * Store the option error message, if any, so that we can log the
402  * connection attempt (which requires parsing the options), and then
403  * show the error later on.
404  **/
405 void option_error(void)
406 {
407         int save_daemon = am_daemon;
408
409         if (!err_buf[0]) {
410                 strcpy(err_buf, "Error parsing options: "
411                     "option may be supported on client but not on server?\n");
412         }
413
414         rwrite(FLOG, err_buf, strlen(err_buf));
415         am_daemon = 0;
416         rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
417         am_daemon = save_daemon;
418 }
419
420
421 /**
422  * Tweak the option table to disable all options that the rsyncd.conf
423  * file has told us to refuse.
424  **/
425 static void set_refuse_options(char *bp)
426 {
427         struct poptOption *op;
428         char *cp;
429
430         while (1) {
431                 if ((cp = strchr(bp, ' ')) != NULL)
432                         *cp= '\0';
433                 for (op = long_options; ; op++) {
434                         if (!op->longName) {
435                                 rprintf(FLOG,
436                                     "Unknown option %s in \"refuse options\" setting\n",
437                                     bp);
438                                 break;
439                         }
440                         if (strcmp(bp, op->longName) == 0) {
441                                 op->val = (op - long_options)+OPT_REFUSED_BASE;
442                                 break;
443                         }
444                 }
445                 if (!cp)
446                         break;
447                 *cp = ' ';
448                 bp = cp + 1;
449         }
450 }
451
452
453 static int count_args(char const **argv)
454 {
455         int i = 0;
456
457         while (argv[i] != NULL)
458                 i++;
459
460         return i;
461 }
462
463
464 /**
465  * Process command line arguments.  Called on both local and remote.
466  *
467  * @retval 1 if all options are OK; with globals set to appropriate
468  * values
469  *
470  * @retval 0 on error, with err_buf containing an explanation
471  **/
472 int parse_arguments(int *argc, const char ***argv, int frommain)
473 {
474         int opt;
475         char *ref = lp_refuse_options(module_id);
476         const char *arg;
477         poptContext pc;
478
479         if (ref && *ref)
480                 set_refuse_options(ref);
481
482         /* TODO: Call poptReadDefaultConfig; handle errors. */
483
484         /* The context leaks in case of an error, but if there's a
485          * problem we always exit anyhow. */
486         pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
487
488         while ((opt = poptGetNextOpt(pc)) != -1) {
489                 /* most options are handled automatically by popt;
490                  * only special cases are returned and listed here. */
491
492                 switch (opt) {
493                 case OPT_VERSION:
494                         print_rsync_version(FINFO);
495                         exit_cleanup(0);
496
497                 case OPT_MODIFY_WINDOW:
498                         /* The value has already been set by popt, but
499                          * we need to remember that we're using a
500                          * non-default setting. */
501                         modify_window_set = 1;
502                         break;
503
504                 case OPT_DELETE_AFTER:
505                         delete_after = 1;
506                         delete_mode = 1;
507                         break;
508
509                 case OPT_DELETE_EXCLUDED:
510                         delete_excluded = 1;
511                         delete_mode = 1;
512                         break;
513
514                 case OPT_EXCLUDE:
515                         add_exclude(&exclude_list, poptGetOptArg(pc), 0);
516                         break;
517
518                 case OPT_INCLUDE:
519                         add_exclude(&exclude_list, poptGetOptArg(pc),
520                                     XFLG_DEF_INCLUDE);
521                         break;
522
523                 case OPT_EXCLUDE_FROM:
524                         arg = poptGetOptArg(pc);
525                         if (sanitize_paths)
526                                 arg = alloc_sanitize_path(arg, curr_dir);
527                         add_exclude_file(&exclude_list, arg,
528                                          XFLG_FATAL_ERRORS);
529                         break;
530
531                 case OPT_INCLUDE_FROM:
532                         arg = poptGetOptArg(pc);
533                         if (sanitize_paths)
534                                 arg = alloc_sanitize_path(arg, curr_dir);
535                         add_exclude_file(&exclude_list, arg,
536                                          XFLG_FATAL_ERRORS | XFLG_DEF_INCLUDE);
537                         break;
538
539                 case 'h':
540                         usage(FINFO);
541                         exit_cleanup(0);
542
543                 case 'v':
544                         verbose++;
545                         break;
546
547                 case 'q':
548                         if (frommain)
549                                 quiet++;
550                         break;
551
552                 case OPT_SENDER:
553                         if (!am_server) {
554                                 usage(FERROR);
555                                 exit_cleanup(RERR_SYNTAX);
556                         }
557                         am_sender = 1;
558                         break;
559
560                 case 'P':
561                         do_progress = 1;
562                         keep_partial = 1;
563                         break;
564
565                 case OPT_WRITE_BATCH:
566                         /* popt stores the filename in batch_prefix for us */
567                         write_batch = 1;
568                         checksum_seed = FIXED_CHECKSUM_SEED;
569                         break;
570
571                 case OPT_READ_BATCH:
572                         /* popt stores the filename in batch_prefix for us */
573                         read_batch = 1;
574                         checksum_seed = FIXED_CHECKSUM_SEED;
575                         break;
576
577                 case OPT_LINK_DEST:
578 #if HAVE_LINK
579                         link_dest = 1;
580                         break;
581 #else
582                         snprintf(err_buf, sizeof err_buf,
583                                  "hard links are not supported on this %s\n",
584                                  am_server ? "server" : "client");
585                         return 0;
586 #endif
587
588                 default:
589                         /* A large opt value means that set_refuse_options()
590                          * turned this option off (opt-BASE is its index). */
591                         if (opt >= OPT_REFUSED_BASE) {
592                                 struct poptOption *op =
593                                     &long_options[opt-OPT_REFUSED_BASE];
594                                 int n = snprintf(err_buf, sizeof err_buf,
595                                     "This server does not support --%s\n",
596                                     op->longName) - 1;
597                                 if (op->shortName) {
598                                         snprintf(err_buf+n, sizeof err_buf-n,
599                                             " (-%c)\n", op->shortName);
600                                 }
601                         } else {
602                                 snprintf(err_buf, sizeof err_buf,
603                                     "%s%s: %s\n",
604                                     am_server ? "on remote machine: " : "",
605                                     poptBadOption(pc, POPT_BADOPTION_NOALIAS),
606                                     poptStrerror(opt));
607                         }
608                         return 0;
609                 }
610         }
611
612 #if !SUPPORT_LINKS
613         if (preserve_links && !am_sender) {
614                 snprintf(err_buf, sizeof err_buf,
615                          "symlinks are not supported on this %s\n",
616                          am_server ? "server" : "client");
617                 return 0;
618         }
619 #endif
620
621 #if !SUPPORT_HARD_LINKS
622         if (preserve_hard_links) {
623                 snprintf(err_buf, sizeof err_buf,
624                          "hard links are not supported on this %s\n",
625                          am_server ? "server" : "client");
626                 return 0;
627         }
628 #endif
629
630         if (write_batch && read_batch) {
631                 rprintf(FERROR,
632                         "write-batch and read-batch can not be used together\n");
633                 exit_cleanup(RERR_SYNTAX);
634         }
635         if (batch_prefix && strlen(batch_prefix) > MAX_BATCH_PREFIX_LEN) {
636                 rprintf(FERROR,
637                         "the batch-file prefix must be %d characters or less.\n",
638                         MAX_BATCH_PREFIX_LEN);
639                 exit_cleanup(RERR_SYNTAX);
640         }
641
642         if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
643                 rprintf(FERROR, "the --temp-dir path is WAY too long.\n");
644                 exit_cleanup(RERR_SYNTAX);
645         }
646
647         if (do_compression && (write_batch || read_batch)) {
648                 rprintf(FERROR,
649                         "compress can not be used with write-batch or read-batch\n");
650                 exit_cleanup(RERR_SYNTAX);
651         }
652
653         if (archive_mode) {
654                 if (!files_from)
655                         recurse = 1;
656 #if SUPPORT_LINKS
657                 preserve_links = 1;
658 #endif
659                 preserve_perms = 1;
660                 preserve_times = 1;
661                 preserve_gid = 1;
662                 preserve_uid = 1;
663                 preserve_devices = 1;
664         }
665
666         if (relative_paths < 0)
667                 relative_paths = files_from? 1 : 0;
668
669         *argv = poptGetArgs(pc);
670         if (*argv)
671                 *argc = count_args(*argv);
672         else
673                 *argc = 0;
674
675         if (sanitize_paths) {
676                 int i;
677                 for (i = *argc; i-- > 0; )
678                         (*argv)[i] = alloc_sanitize_path((*argv)[i], NULL);
679                 if (tmpdir)
680                         tmpdir = alloc_sanitize_path(tmpdir, curr_dir);
681                 if (compare_dest)
682                         compare_dest = alloc_sanitize_path(compare_dest, curr_dir);
683                 if (backup_dir)
684                         backup_dir = alloc_sanitize_path(backup_dir, curr_dir);
685                 if (files_from)
686                         files_from = alloc_sanitize_path(files_from, curr_dir);
687         }
688
689         if (daemon_opt) {
690                 daemon_opt = 0;
691                 am_daemon = 1;
692                 return 1;
693         }
694
695         if (!backup_suffix)
696                 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
697         backup_suffix_len = strlen(backup_suffix);
698         if (strchr(backup_suffix, '/') != NULL) {
699                 rprintf(FERROR, "--suffix cannot contain slashes: %s\n",
700                         backup_suffix);
701                 exit_cleanup(RERR_SYNTAX);
702         }
703         if (backup_dir) {
704                 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
705                 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
706                 if (backup_dir_remainder < 32) {
707                         rprintf(FERROR, "the --backup-dir path is WAY too long.\n");
708                         exit_cleanup(RERR_SYNTAX);
709                 }
710                 if (backup_dir_buf[backup_dir_len - 1] != '/') {
711                         backup_dir_buf[backup_dir_len++] = '/';
712                         backup_dir_buf[backup_dir_len] = '\0';
713                 }
714                 if (verbose > 1 && !am_sender)
715                         rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
716         } else if (!backup_suffix_len && (!am_server || !am_sender)) {
717                 rprintf(FERROR,
718                         "--suffix cannot be a null string without --backup-dir\n");
719                 exit_cleanup(RERR_SYNTAX);
720         }
721
722         if (do_progress && !verbose)
723                 verbose = 1;
724
725         if (files_from) {
726                 char *colon;
727                 if (*argc != 2 && !(am_server && am_sender && *argc == 1)) {
728                         usage(FERROR);
729                         exit_cleanup(RERR_SYNTAX);
730                 }
731                 if (strcmp(files_from, "-") == 0) {
732                         filesfrom_fd = 0;
733                         if (am_server)
734                                 remote_filesfrom_file = "-";
735                 }
736                 else if ((colon = find_colon(files_from)) != 0) {
737                         if (am_server) {
738                                 usage(FERROR);
739                                 exit_cleanup(RERR_SYNTAX);
740                         }
741                         remote_filesfrom_file = colon+1 + (colon[1] == ':');
742                         if (strcmp(remote_filesfrom_file, "-") == 0) {
743                                 rprintf(FERROR, "Invalid --files-from remote filename\n");
744                                 exit_cleanup(RERR_SYNTAX);
745                         }
746                 } else {
747                         filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
748                         if (filesfrom_fd < 0) {
749                                 rsyserr(FERROR, errno,
750                                         "failed to open files-from file %s",
751                                         files_from);
752                                 exit_cleanup(RERR_FILEIO);
753                         }
754                 }
755         }
756
757         return 1;
758 }
759
760
761 /**
762  * Construct a filtered list of options to pass through from the
763  * client to the server.
764  *
765  * This involves setting options that will tell the server how to
766  * behave, and also filtering out options that are processed only
767  * locally.
768  **/
769 void server_options(char **args,int *argc)
770 {
771         int ac = *argc;
772         static char argstr[50];
773         char *arg;
774
775         int i, x;
776
777         if (blocking_io == -1)
778                 blocking_io = 0;
779
780         args[ac++] = "--server";
781
782         if (daemon_over_rsh) {
783                 args[ac++] = "--daemon";
784                 *argc = ac;
785                 /* if we're passing --daemon, we're done */
786                 return;
787         }
788
789         if (!am_sender)
790                 args[ac++] = "--sender";
791
792         x = 1;
793         argstr[0] = '-';
794         for (i = 0; i < verbose; i++)
795                 argstr[x++] = 'v';
796
797         /* the -q option is intentionally left out */
798         if (make_backups)
799                 argstr[x++] = 'b';
800         if (update_only)
801                 argstr[x++] = 'u';
802         if (dry_run)
803                 argstr[x++] = 'n';
804         if (preserve_links)
805                 argstr[x++] = 'l';
806         if (copy_links)
807                 argstr[x++] = 'L';
808
809         if (whole_file > 0)
810                 argstr[x++] = 'W';
811         /* We don't need to send --no-whole-file, because it's the
812          * default for remote transfers, and in any case old versions
813          * of rsync will not understand it. */
814
815         if (preserve_hard_links)
816                 argstr[x++] = 'H';
817         if (preserve_uid)
818                 argstr[x++] = 'o';
819         if (preserve_gid)
820                 argstr[x++] = 'g';
821         if (preserve_devices)
822                 argstr[x++] = 'D';
823         if (preserve_times)
824                 argstr[x++] = 't';
825         if (preserve_perms)
826                 argstr[x++] = 'p';
827         if (recurse)
828                 argstr[x++] = 'r';
829         if (always_checksum)
830                 argstr[x++] = 'c';
831         if (cvs_exclude)
832                 argstr[x++] = 'C';
833         if (ignore_times)
834                 argstr[x++] = 'I';
835         if (relative_paths)
836                 argstr[x++] = 'R';
837         if (one_file_system)
838                 argstr[x++] = 'x';
839         if (sparse_files)
840                 argstr[x++] = 'S';
841         if (do_compression)
842                 argstr[x++] = 'z';
843
844         /* this is a complete hack - blame Rusty
845
846            this is a hack to make the list_only (remote file list)
847            more useful */
848         if (list_only && !recurse)
849                 argstr[x++] = 'r';
850
851         argstr[x] = 0;
852
853         if (x != 1)
854                 args[ac++] = argstr;
855
856         if (block_size) {
857                 if (asprintf(&arg, "-B%u", block_size) < 0)
858                         goto oom;
859                 args[ac++] = arg;
860         }
861
862         if (max_delete && am_sender) {
863                 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
864                         goto oom;
865                 args[ac++] = arg;
866         }
867
868         if (batch_prefix) {
869                 char *r_or_w = write_batch ? "write" : "read";
870                 if (asprintf(&arg, "--%s-batch=%s", r_or_w, batch_prefix) < 0)
871                         goto oom;
872                 args[ac++] = arg;
873         }
874
875         if (io_timeout) {
876                 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
877                         goto oom;
878                 args[ac++] = arg;
879         }
880
881         if (bwlimit) {
882                 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
883                         goto oom;
884                 args[ac++] = arg;
885         }
886
887         if (backup_dir) {
888                 args[ac++] = "--backup-dir";
889                 args[ac++] = backup_dir;
890         }
891
892         /* Only send --suffix if it specifies a non-default value. */
893         if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
894                 /* We use the following syntax to avoid weirdness with '~'. */
895                 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
896                         goto oom;
897                 args[ac++] = arg;
898         }
899
900         if (delete_excluded)
901                 args[ac++] = "--delete-excluded";
902         else if (delete_mode)
903                 args[ac++] = "--delete";
904
905         if (size_only)
906                 args[ac++] = "--size-only";
907
908         if (modify_window_set) {
909                 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
910                         goto oom;
911                 args[ac++] = arg;
912         }
913
914         if (keep_partial)
915                 args[ac++] = "--partial";
916
917         if (force_delete)
918                 args[ac++] = "--force";
919
920         if (delete_after)
921                 args[ac++] = "--delete-after";
922
923         if (ignore_errors)
924                 args[ac++] = "--ignore-errors";
925
926         if (copy_unsafe_links)
927                 args[ac++] = "--copy-unsafe-links";
928
929         if (safe_symlinks)
930                 args[ac++] = "--safe-links";
931
932         if (numeric_ids)
933                 args[ac++] = "--numeric-ids";
934
935         if (only_existing && am_sender)
936                 args[ac++] = "--existing";
937
938         if (opt_ignore_existing && am_sender)
939                 args[ac++] = "--ignore-existing";
940
941         if (tmpdir) {
942                 args[ac++] = "--temp-dir";
943                 args[ac++] = tmpdir;
944         }
945
946         if (compare_dest && am_sender) {
947                 /* the server only needs this option if it is not the sender,
948                  *   and it may be an older version that doesn't know this
949                  *   option, so don't send it if client is the sender.
950                  */
951                 args[ac++] = link_dest ? "--link-dest" : "--compare-dest";
952                 args[ac++] = compare_dest;
953         }
954
955         if (files_from && (!am_sender || remote_filesfrom_file)) {
956                 if (remote_filesfrom_file) {
957                         args[ac++] = "--files-from";
958                         args[ac++] = remote_filesfrom_file;
959                         if (eol_nulls)
960                                 args[ac++] = "--from0";
961                 } else {
962                         args[ac++] = "--files-from=-";
963                         args[ac++] = "--from0";
964                 }
965         }
966
967         *argc = ac;
968         return;
969
970     oom:
971         out_of_memory("server_options");
972 }
973
974 /**
975  * Return the position of a ':' IF it is not part of a filename (i.e. as
976  * long as it doesn't occur after a slash.
977  */
978 char *find_colon(char *s)
979 {
980         char *p, *p2;
981
982         p = strchr(s,':');
983         if (!p)
984                 return NULL;
985
986         /* now check to see if there is a / in the string before the : - if there is then
987            discard the colon on the assumption that the : is part of a filename */
988         p2 = strchr(s,'/');
989         if (p2 && p2 < p)
990                 return NULL;
991
992         return p;
993 }