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