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