2 * Command-line (and received via daemon-socket) option parsing.
4 * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 2000, 2001, 2002 Martin Pool <mbp@samba.org>
6 * Copyright (C) 2002-2007 Wayne Davison
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
25 #include "zlib/zlib.h"
28 extern int sanitize_paths;
29 extern int daemon_over_rsh;
30 extern unsigned int module_dirlen;
31 extern struct filter_list_struct filter_list;
32 extern struct filter_list_struct server_filter_list;
37 * If 1, send the whole file as literal data rather than trying to
38 * create an incremental diff.
40 * If -1, then look at whether we're local or remote and go by that.
42 * @sa disable_deltas_p()
47 int keep_dirlinks = 0;
48 int copy_dirlinks = 0;
50 int preserve_links = 0;
51 int preserve_hard_links = 0;
52 int preserve_acls = 0;
53 int preserve_xattrs = 0;
54 int preserve_perms = 0;
55 int preserve_executability = 0;
56 int preserve_devices = 0;
57 int preserve_specials = 0;
60 int preserve_times = 0;
67 int delete_during = 0;
68 int delete_before = 0;
70 int delete_excluded = 0;
71 int remove_source_files = 0;
72 int one_file_system = 0;
73 int protocol_version = PROTOCOL_VERSION;
75 int do_compression = 0;
76 int def_compress_level = Z_DEFAULT_COMPRESSION;
77 int am_root = 0; /* 0 = normal, 1 = root, 2 = --super, -1 = --fake-super */
81 int am_starting_up = 1;
82 int relative_paths = -1;
85 int allow_8bit_chars = 0;
89 int prune_empty_dirs = 0;
91 char *files_from = NULL;
92 int filesfrom_fd = -1;
93 char *filesfrom_host = NULL;
96 int human_readable = 0;
98 int allow_inc_recurse = 1;
103 int connect_timeout = 0;
104 int keep_partial = 0;
105 int safe_symlinks = 0;
106 int copy_unsafe_links = 0;
108 int daemon_bwlimit = 0;
111 size_t bwlimit_writemax = 0;
112 int ignore_existing = 0;
113 int ignore_non_existing = 0;
114 int need_messages_from_generator = 0;
115 int max_delete = INT_MIN;
118 int ignore_errors = 0;
119 int modify_window = 0;
120 int blocking_io = -1;
121 int checksum_seed = 0;
123 int delay_updates = 0;
124 long block_size = 0; /* "long" because popt can't set an int32. */
125 char *skip_compress = NULL;
127 /** Network address family. **/
130 = 0; /* Any protocol */
132 = AF_INET; /* Must use IPv4 */
136 # define AF_INET6 AF_INET /* make -6 option a no-op */
139 /** Do not go into the background when run as --daemon. Good
140 * for debugging and required for running as a service on W32,
141 * or under Unix process-monitors. **/
143 #if defined _WIN32 || defined __WIN32__
151 int backup_dir_len = 0;
152 int backup_suffix_len;
153 unsigned int backup_dir_remainder;
155 char *backup_suffix = NULL;
157 char *partial_dir = NULL;
158 char *basis_dir[MAX_BASIS_DIRS+1];
159 char *config_file = NULL;
160 char *shell_cmd = NULL;
161 char *logfile_name = NULL;
162 char *logfile_format = NULL;
163 char *stdout_format = NULL;
164 char *password_file = NULL;
165 char *rsync_path = RSYNC_PATH;
166 char *backup_dir = NULL;
167 char backup_dir_buf[MAXPATHLEN];
168 char *sockopts = NULL;
170 int compare_dest = 0;
173 int basis_dir_cnt = 0;
174 char *dest_option = NULL;
179 int log_before_transfer = 0;
180 int stdout_format_has_i = 0;
181 int stdout_format_has_o_or_i = 0;
182 int logfile_format_has_i = 0;
183 int logfile_format_has_o_or_i = 0;
184 int always_checksum = 0;
187 #define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
188 char *batch_name = NULL;
190 int need_unsorted_flist = 0;
192 char *iconv_opt = ICONV_OPTION;
195 struct chmod_mode_struct *chmod_modes = NULL;
197 static int daemon_opt; /* sets am_daemon after option error-reporting */
198 static int omit_dir_times = 0;
199 static int F_option_cnt = 0;
200 static int modify_window_set;
201 static int itemize_changes = 0;
202 static int refused_delete, refused_archive_part, refused_compress;
203 static int refused_partial, refused_progress, refused_delete_before;
204 static int refused_delete_during;
205 static int refused_inplace, refused_no_iconv;
206 static char *max_size_arg, *min_size_arg;
207 static char tmp_partialdir[] = ".~tmp~";
209 /** Local address to bind. As a character string because it's
210 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
211 * address, or a hostname. **/
215 static void print_rsync_version(enum logcode f)
217 char *subprotocol = "";
218 char const *got_socketpair = "no ";
219 char const *have_inplace = "no ";
220 char const *hardlinks = "no ";
221 char const *acls = "no ";
222 char const *xattrs = "no ";
223 char const *links = "no ";
224 char const *iconv = "no ";
225 char const *ipv6 = "no ";
226 STRUCT_STAT *dumstat;
228 #if SUBPROTOCOL_VERSION != 0
229 asprintf(&subprotocol, ".PR%d", SUBPROTOCOL_VERSION);
231 #ifdef HAVE_SOCKETPAIR
234 #ifdef HAVE_FTRUNCATE
237 #ifdef SUPPORT_HARD_LINKS
243 #ifdef SUPPORT_XATTRS
256 rprintf(f, "%s version %s protocol version %d%s\n",
257 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION, subprotocol);
258 rprintf(f, "Copyright (C) 1996-2007 by Andrew Tridgell, Wayne Davison, and others.\n");
259 rprintf(f, "Web site: http://rsync.samba.org/\n");
260 rprintf(f, "Capabilities:\n");
261 rprintf(f, " %d-bit files, %d-bit inums, %d-bit timestamps, %d-bit long ints,\n",
262 (int)(sizeof (OFF_T) * 8),
263 (int)(sizeof dumstat->st_ino * 8), /* Don't check ino_t! */
264 (int)(sizeof (time_t) * 8),
265 (int)(sizeof (int64) * 8));
266 rprintf(f, " %ssocketpairs, %shardlinks, %ssymlinks, %sIPv6, batchfiles, %sinplace,\n",
267 got_socketpair, hardlinks, links, ipv6, have_inplace);
268 rprintf(f, " %sappend, %sACLs, %sxattrs, %siconv\n",
269 have_inplace, acls, xattrs, iconv);
271 #ifdef MAINTAINER_MODE
272 rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
276 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
278 if (sizeof (int64) != SIZEOF_INT64) {
280 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
281 (int) SIZEOF_INT64, (int) sizeof (int64));
285 rprintf(f,"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n");
286 rprintf(f,"are welcome to redistribute it under certain conditions. See the GNU\n");
287 rprintf(f,"General Public Licence for details.\n");
291 void usage(enum logcode F)
293 print_rsync_version(F);
296 rprintf(F,"rsync is a file transfer program capable of efficient remote update\n");
297 rprintf(F,"via a fast differencing algorithm.\n");
300 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... DEST\n");
301 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
302 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
303 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
304 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC [DEST]\n");
305 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
306 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
307 rprintf(F,"The ':' usages connect via remote shell, while '::' & 'rsync://' usages connect\n");
308 rprintf(F,"to an rsync daemon, and require SRC or DEST to start with a module name.\n");
310 rprintf(F,"Options\n");
311 rprintf(F," -v, --verbose increase verbosity\n");
312 rprintf(F," -q, --quiet suppress non-error messages\n");
313 rprintf(F," --no-motd suppress daemon-mode MOTD (see manpage caveat)\n");
314 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
315 rprintf(F," -a, --archive archive mode; equals -rlptgoD (no -H,-A,-X)\n");
316 rprintf(F," --no-OPTION turn off an implied OPTION (e.g. --no-D)\n");
317 rprintf(F," -r, --recursive recurse into directories\n");
318 rprintf(F," -R, --relative use relative path names\n");
319 rprintf(F," --no-implied-dirs don't send implied dirs with --relative\n");
320 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
321 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
322 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
323 rprintf(F," -u, --update skip files that are newer on the receiver\n");
324 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
325 rprintf(F," --append append data onto shorter files\n");
326 rprintf(F," --append-verify like --append, but with old data in file checksum\n");
327 rprintf(F," -d, --dirs transfer directories without recursing\n");
328 rprintf(F," -l, --links copy symlinks as symlinks\n");
329 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
330 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
331 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
332 rprintf(F," -k, --copy-dirlinks transform symlink to a dir into referent dir\n");
333 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
334 rprintf(F," -H, --hard-links preserve hard links\n");
335 rprintf(F," -p, --perms preserve permissions\n");
336 rprintf(F," -E, --executability preserve the file's executability\n");
337 rprintf(F," --chmod=CHMOD affect file and/or directory permissions\n");
339 rprintf(F," -A, --acls preserve ACLs (implies --perms)\n");
341 #ifdef SUPPORT_XATTRS
342 rprintf(F," -X, --xattrs preserve extended attributes\n");
344 rprintf(F," -o, --owner preserve owner (super-user only)\n");
345 rprintf(F," -g, --group preserve group\n");
346 rprintf(F," --devices preserve device files (super-user only)\n");
347 rprintf(F," --specials preserve special files\n");
348 rprintf(F," -D same as --devices --specials\n");
349 rprintf(F," -t, --times preserve modification times\n");
350 rprintf(F," -O, --omit-dir-times omit directories from --times\n");
351 rprintf(F," --super receiver attempts super-user activities\n");
352 #ifdef SUPPORT_XATTRS
353 rprintf(F," --fake-super store/recover privileged attrs using xattrs\n");
355 rprintf(F," -S, --sparse handle sparse files efficiently\n");
356 rprintf(F," -n, --dry-run perform a trial run with no changes made\n");
357 rprintf(F," -W, --whole-file copy files whole (without delta-xfer algorithm)\n");
358 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
359 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
360 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
361 rprintf(F," --rsync-path=PROGRAM specify the rsync to run on the remote machine\n");
362 rprintf(F," --existing skip creating new files on receiver\n");
363 rprintf(F," --ignore-existing skip updating files that already exist on receiver\n");
364 rprintf(F," --remove-source-files sender removes synchronized files (non-dirs)\n");
365 rprintf(F," --del an alias for --delete-during\n");
366 rprintf(F," --delete delete extraneous files from destination dirs\n");
367 rprintf(F," --delete-before receiver deletes before transfer, not during\n");
368 rprintf(F," --delete-during receiver deletes during transfer (default)\n");
369 rprintf(F," --delete-delay find deletions during, delete after\n");
370 rprintf(F," --delete-after receiver deletes after transfer, not during\n");
371 rprintf(F," --delete-excluded also delete excluded files from destination dirs\n");
372 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
373 rprintf(F," --force force deletion of directories even if not empty\n");
374 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
375 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
376 rprintf(F," --min-size=SIZE don't transfer any file smaller than SIZE\n");
377 rprintf(F," --partial keep partially transferred files\n");
378 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
379 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
380 rprintf(F," -m, --prune-empty-dirs prune empty directory chains from the file-list\n");
381 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
382 rprintf(F," --timeout=SECONDS set I/O timeout in seconds\n");
383 rprintf(F," --contimeout=SECONDS set daemon connection timeout in seconds\n");
384 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
385 rprintf(F," --size-only skip files that match in size\n");
386 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
387 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
388 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
389 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
390 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
391 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
392 rprintf(F," -z, --compress compress file data during the transfer\n");
393 rprintf(F," --compress-level=NUM explicitly set compression level\n");
394 rprintf(F," --skip-compress=LIST skip compressing files with a suffix in LIST\n");
395 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
396 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
397 rprintf(F," -F same as --filter='dir-merge /.rsync-filter'\n");
398 rprintf(F," repeated: --filter='- .rsync-filter'\n");
399 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
400 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
401 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
402 rprintf(F," --include-from=FILE read include patterns from FILE\n");
403 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
404 rprintf(F," -0, --from0 all *-from/filter files are delimited by 0s\n");
405 rprintf(F," -s, --protect-args no space-splitting; only wildcard special-chars\n");
406 rprintf(F," --address=ADDRESS bind address for outgoing socket to daemon\n");
407 rprintf(F," --port=PORT specify double-colon alternate port number\n");
408 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
409 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
410 rprintf(F," --stats give some file-transfer stats\n");
411 rprintf(F," -8, --8-bit-output leave high-bit chars unescaped in output\n");
412 rprintf(F," -h, --human-readable output numbers in a human-readable format\n");
413 rprintf(F," --progress show progress during transfer\n");
414 rprintf(F," -P same as --partial --progress\n");
415 rprintf(F," -i, --itemize-changes output a change-summary for all updates\n");
416 rprintf(F," --out-format=FORMAT output updates using the specified FORMAT\n");
417 rprintf(F," --log-file=FILE log what we're doing to the specified FILE\n");
418 rprintf(F," --log-file-format=FMT log updates using the specified FMT\n");
419 rprintf(F," --password-file=FILE read daemon-access password from FILE\n");
420 rprintf(F," --list-only list the files instead of copying them\n");
421 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
422 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
423 rprintf(F," --only-write-batch=FILE like --write-batch but w/o updating destination\n");
424 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
425 rprintf(F," --protocol=NUM force an older protocol version to be used\n");
427 rprintf(F," --iconv=CONVERT_SPEC request charset conversion of filenames\n");
429 rprintf(F," -4, --ipv4 prefer IPv4\n");
430 rprintf(F," -6, --ipv6 prefer IPv6\n");
431 rprintf(F," --version print version number\n");
432 rprintf(F,"(-h) --help show this help (-h works with no other options)\n");
435 rprintf(F,"Use \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
436 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
437 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
440 enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
441 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST, OPT_HELP,
442 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW, OPT_MIN_SIZE, OPT_CHMOD,
443 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_ONLY_WRITE_BATCH, OPT_MAX_SIZE,
444 OPT_NO_D, OPT_APPEND, OPT_NO_ICONV,
445 OPT_SERVER, OPT_REFUSED_BASE = 9000};
447 static struct poptOption long_options[] = {
448 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
449 {"help", 0, POPT_ARG_NONE, 0, OPT_HELP, 0, 0 },
450 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
451 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
452 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
453 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
454 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
455 {"motd", 0, POPT_ARG_VAL, &output_motd, 1, 0, 0 },
456 {"no-motd", 0, POPT_ARG_VAL, &output_motd, 0, 0, 0 },
457 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
458 {"human-readable", 'h', POPT_ARG_NONE, 0, 'h', 0, 0},
459 {"no-human-readable",0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
460 {"no-h", 0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
461 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
462 {"archive", 'a', POPT_ARG_NONE, 0, 'a', 0, 0 },
463 {"recursive", 'r', POPT_ARG_VAL, &recurse, 2, 0, 0 },
464 {"no-recursive", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
465 {"no-r", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
466 {"inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
467 {"no-inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
468 {"i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
469 {"no-i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
470 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
471 {"no-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
472 {"no-d", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
473 {"perms", 'p', POPT_ARG_VAL, &preserve_perms, 1, 0, 0 },
474 {"no-perms", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
475 {"no-p", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
476 {"executability", 'E', POPT_ARG_NONE, &preserve_executability, 0, 0, 0 },
477 {"acls", 'A', POPT_ARG_NONE, 0, 'A', 0, 0 },
478 {"no-acls", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
479 {"no-A", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
480 {"xattrs", 'X', POPT_ARG_NONE, 0, 'X', 0, 0 },
481 {"no-xattrs", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
482 {"no-X", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
483 {"times", 't', POPT_ARG_VAL, &preserve_times, 2, 0, 0 },
484 {"no-times", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
485 {"no-t", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
486 {"omit-dir-times", 'O', POPT_ARG_VAL, &omit_dir_times, 1, 0, 0 },
487 {"no-omit-dir-times",0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
488 {"no-O", 0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
489 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
490 {"super", 0, POPT_ARG_VAL, &am_root, 2, 0, 0 },
491 {"no-super", 0, POPT_ARG_VAL, &am_root, 0, 0, 0 },
492 {"fake-super", 0, POPT_ARG_VAL, &am_root, -1, 0, 0 },
493 {"owner", 'o', POPT_ARG_VAL, &preserve_uid, 1, 0, 0 },
494 {"no-owner", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
495 {"no-o", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
496 {"group", 'g', POPT_ARG_VAL, &preserve_gid, 1, 0, 0 },
497 {"no-group", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
498 {"no-g", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
499 {0, 'D', POPT_ARG_NONE, 0, 'D', 0, 0 },
500 {"no-D", 0, POPT_ARG_NONE, 0, OPT_NO_D, 0, 0 },
501 {"devices", 0, POPT_ARG_VAL, &preserve_devices, 1, 0, 0 },
502 {"no-devices", 0, POPT_ARG_VAL, &preserve_devices, 0, 0, 0 },
503 {"specials", 0, POPT_ARG_VAL, &preserve_specials, 1, 0, 0 },
504 {"no-specials", 0, POPT_ARG_VAL, &preserve_specials, 0, 0, 0 },
505 {"links", 'l', POPT_ARG_VAL, &preserve_links, 1, 0, 0 },
506 {"no-links", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
507 {"no-l", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
508 {"copy-links", 'L', POPT_ARG_NONE, ©_links, 0, 0, 0 },
509 {"copy-unsafe-links",0, POPT_ARG_NONE, ©_unsafe_links, 0, 0, 0 },
510 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
511 {"copy-dirlinks", 'k', POPT_ARG_NONE, ©_dirlinks, 0, 0, 0 },
512 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
513 {"hard-links", 'H', POPT_ARG_NONE, 0, 'H', 0, 0 },
514 {"no-hard-links", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
515 {"no-H", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
516 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
517 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
518 {"no-R", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
519 {"implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
520 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
521 {"i-d", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
522 {"no-i-d", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
523 {"chmod", 0, POPT_ARG_STRING, 0, OPT_CHMOD, 0, 0 },
524 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
525 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
526 {"one-file-system", 'x', POPT_ARG_NONE, 0, 'x', 0, 0 },
527 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
528 {"existing", 0, POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
529 {"ignore-non-existing",0,POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
530 {"ignore-existing", 0, POPT_ARG_NONE, &ignore_existing, 0, 0, 0 },
531 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
532 {"min-size", 0, POPT_ARG_STRING, &min_size_arg, OPT_MIN_SIZE, 0, 0 },
533 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
534 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
535 {"append", 0, POPT_ARG_NONE, 0, OPT_APPEND, 0, 0 },
536 {"append-verify", 0, POPT_ARG_VAL, &append_mode, 2, 0, 0 },
537 {"no-append", 0, POPT_ARG_VAL, &append_mode, 0, 0, 0 },
538 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
539 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
540 {"delete-before", 0, POPT_ARG_NONE, &delete_before, 0, 0, 0 },
541 {"delete-during", 0, POPT_ARG_VAL, &delete_during, 1, 0, 0 },
542 {"delete-delay", 0, POPT_ARG_VAL, &delete_during, 2, 0, 0 },
543 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
544 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
545 {"remove-sent-files",0, POPT_ARG_VAL, &remove_source_files, 2, 0, 0 }, /* deprecated */
546 {"remove-source-files",0,POPT_ARG_VAL, &remove_source_files, 1, 0, 0 },
547 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
548 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
549 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
550 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
551 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
552 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
553 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
554 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
555 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
556 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
557 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
558 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
559 {"no-W", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
560 {"checksum", 'c', POPT_ARG_VAL, &always_checksum, 1, 0, 0 },
561 {"no-checksum", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
562 {"no-c", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
563 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
564 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
565 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
566 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
567 {"fuzzy", 'y', POPT_ARG_NONE, &fuzzy_basis, 0, 0, 0 },
568 {"compress", 'z', POPT_ARG_NONE, 0, 'z', 0, 0 },
569 {"no-compress", 0, POPT_ARG_VAL, &do_compression, 0, 0, 0 },
570 {"skip-compress", 0, POPT_ARG_STRING, &skip_compress, 0, 0, 0 },
571 {"no-z", 0, POPT_ARG_VAL, &do_compression, 0, 0, 0 },
572 {"compress-level", 0, POPT_ARG_INT, &def_compress_level, 'z', 0, 0 },
573 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
574 {"progress", 0, POPT_ARG_VAL, &do_progress, 1, 0, 0 },
575 {"no-progress", 0, POPT_ARG_VAL, &do_progress, 0, 0, 0 },
576 {"partial", 0, POPT_ARG_VAL, &keep_partial, 1, 0, 0 },
577 {"no-partial", 0, POPT_ARG_VAL, &keep_partial, 0, 0, 0 },
578 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
579 {"delay-updates", 0, POPT_ARG_VAL, &delay_updates, 1, 0, 0 },
580 {"no-delay-updates", 0, POPT_ARG_VAL, &delay_updates, 0, 0, 0 },
581 {"prune-empty-dirs",'m', POPT_ARG_NONE, &prune_empty_dirs, 0, 0, 0 },
582 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
583 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
584 {"out-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 },
585 {"log-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 }, /* DEPRECATED */
586 {"itemize-changes", 'i', POPT_ARG_NONE, 0, 'i', 0, 0 },
587 {"no-itemize-changes",0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
588 {"no-i", 0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
589 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
590 {"no-bwlimit", 0, POPT_ARG_VAL, &bwlimit, 0, 0, 0 },
591 {"backup", 'b', POPT_ARG_VAL, &make_backups, 1, 0, 0 },
592 {"no-backup", 0, POPT_ARG_VAL, &make_backups, 0, 0, 0 },
593 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
594 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
595 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
596 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
597 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
598 {"only-write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_ONLY_WRITE_BATCH, 0, 0 },
599 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
600 {"from0", '0', POPT_ARG_VAL, &eol_nulls, 1, 0, 0},
601 {"no-from0", 0, POPT_ARG_VAL, &eol_nulls, 0, 0, 0},
602 {"protect-args", 's', POPT_ARG_VAL, &protect_args, 1, 0, 0},
603 {"no-protect-args", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
604 {"no-s", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
605 {"numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 1, 0, 0 },
606 {"no-numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 0, 0, 0 },
607 {"timeout", 0, POPT_ARG_INT, &io_timeout, 0, 0, 0 },
608 {"no-timeout", 0, POPT_ARG_VAL, &io_timeout, 0, 0, 0 },
609 {"contimeout", 0, POPT_ARG_INT, &connect_timeout, 0, 0, 0 },
610 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
611 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
612 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
614 {"iconv", 0, POPT_ARG_STRING, &iconv_opt, 0, 0, 0 },
615 {"no-iconv", 0, POPT_ARG_NONE, 0, OPT_NO_ICONV, 0, 0 },
617 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
618 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
619 {"8-bit-output", '8', POPT_ARG_NONE, &allow_8bit_chars, 0, 0, 0 },
620 {"qsort", 0, POPT_ARG_NONE, &use_qsort, 0, 0, 0 },
621 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
622 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
623 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
624 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
625 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
626 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
627 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
628 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
629 {"server", 0, POPT_ARG_NONE, 0, OPT_SERVER, 0, 0 },
630 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
631 /* All the following options switch us into daemon-mode option-parsing. */
632 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
633 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
634 {"detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
635 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
639 static void daemon_usage(enum logcode F)
641 print_rsync_version(F);
644 rprintf(F,"Usage: rsync --daemon [OPTION]...\n");
645 rprintf(F," --address=ADDRESS bind to the specified address\n");
646 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
647 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
648 rprintf(F," --no-detach do not detach from the parent\n");
649 rprintf(F," --port=PORT listen on alternate port number\n");
650 rprintf(F," --log-file=FILE override the \"log file\" setting\n");
651 rprintf(F," --log-file-format=FMT override the \"log format\" setting\n");
652 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
653 rprintf(F," -v, --verbose increase verbosity\n");
654 rprintf(F," -4, --ipv4 prefer IPv4\n");
655 rprintf(F," -6, --ipv6 prefer IPv6\n");
656 rprintf(F," --help show this help screen\n");
659 rprintf(F,"If you were not trying to invoke rsync as a daemon, avoid using any of the\n");
660 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
663 static struct poptOption long_daemon_options[] = {
664 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
665 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
666 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
667 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
668 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
669 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
670 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
671 {"detach", 0, POPT_ARG_VAL, &no_detach, 0, 0, 0 },
672 {"no-detach", 0, POPT_ARG_VAL, &no_detach, 1, 0, 0 },
673 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
674 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
675 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
676 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
677 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
678 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
679 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
680 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
681 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
682 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
683 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
688 static char err_buf[200];
692 * Store the option error message, if any, so that we can log the
693 * connection attempt (which requires parsing the options), and then
694 * show the error later on.
696 void option_error(void)
699 strlcpy(err_buf, "Error parsing options: option may "
700 "be supported on client but not on server?\n",
704 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
710 * Tweak the option table to disable all options that the rsyncd.conf
711 * file has told us to refuse.
713 static void set_refuse_options(char *bp)
715 struct poptOption *op;
716 char *cp, shortname[2];
717 int is_wild, found_match;
722 while (*bp == ' ') bp++;
725 if ((cp = strchr(bp, ' ')) != NULL)
727 is_wild = strpbrk(bp, "*?[") != NULL;
729 for (op = long_options; ; op++) {
730 *shortname = op->shortName;
731 if (!op->longName && !*shortname)
733 if ((op->longName && wildmatch(bp, op->longName))
734 || (*shortname && wildmatch(bp, shortname))) {
735 if (op->argInfo == POPT_ARG_VAL)
736 op->argInfo = POPT_ARG_NONE;
737 op->val = (op - long_options) + OPT_REFUSED_BASE;
739 /* These flags are set to let us easily check
740 * an implied option later in the code. */
741 switch (*shortname) {
742 case 'r': case 'd': case 'l': case 'p':
743 case 't': case 'g': case 'o': case 'D':
744 refused_archive_part = op->val;
747 refused_compress = op->val;
750 if (wildmatch("delete", op->longName))
751 refused_delete = op->val;
752 else if (wildmatch("delete-before", op->longName))
753 refused_delete_before = op->val;
754 else if (wildmatch("delete-during", op->longName))
755 refused_delete_during = op->val;
756 else if (wildmatch("partial", op->longName))
757 refused_partial = op->val;
758 else if (wildmatch("progress", op->longName))
759 refused_progress = op->val;
760 else if (wildmatch("inplace", op->longName))
761 refused_inplace = op->val;
762 else if (wildmatch("no-iconv", op->longName))
763 refused_no_iconv = op->val;
771 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
782 static int count_args(const char **argv)
787 while (argv[i] != NULL)
795 static OFF_T parse_size_arg(char **size_arg, char def_suf)
797 int reps, mult, make_compatible = 0;
801 for (arg = *size_arg; isDigit(arg); arg++) {}
803 for (arg++; isDigit(arg); arg++) {}
804 switch (*arg && *arg != '+' && *arg != '-' ? *arg++ : def_suf) {
820 if (*arg == 'b' || *arg == 'B')
821 mult = 1000, make_compatible = 1, arg++;
822 else if (!*arg || *arg == '+' || *arg == '-')
824 else if (strncasecmp(arg, "ib", 2) == 0)
825 mult = 1024, arg += 2;
830 size *= atof(*size_arg);
831 if ((*arg == '+' || *arg == '-') && arg[1] == '1')
832 size += atoi(arg), make_compatible = 1, arg += 2;
835 if (size > 0 && make_compatible) {
836 /* We convert this manually because we may need %lld precision,
837 * and that's not a portable sprintf() escape. */
838 char buf[128], *s = buf + sizeof buf - 1;
842 *--s = (char)(num % 10) + '0';
845 if (!(*size_arg = strdup(s)))
846 out_of_memory("parse_size_arg");
852 static void create_refuse_error(int which)
854 /* The "which" value is the index + OPT_REFUSED_BASE. */
855 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
856 int n = snprintf(err_buf, sizeof err_buf,
857 "The server is configured to refuse --%s\n",
860 snprintf(err_buf + n, sizeof err_buf - n,
861 " (-%c)\n", op->shortName);
867 * Process command line arguments. Called on both local and remote.
869 * @retval 1 if all options are OK; with globals set to appropriate
872 * @retval 0 on error, with err_buf containing an explanation
874 int parse_arguments(int *argc_p, const char ***argv_p, int frommain)
876 static poptContext pc;
877 char *ref = lp_refuse_options(module_id);
878 const char *arg, **argv = *argv_p;
883 set_refuse_options(ref);
885 set_refuse_options("log-file*");
886 if (!*lp_charset(module_id))
887 set_refuse_options("iconv");
891 if (!am_daemon && !protect_args && (arg = getenv("RSYNC_ICONV")) != NULL && *arg)
892 iconv_opt = strdup(arg);
895 /* TODO: Call poptReadDefaultConfig; handle errors. */
897 /* The context leaks in case of an error, but if there's a
898 * problem we always exit anyhow. */
901 pc = poptGetContext(RSYNC_NAME, argc, argv, long_options, 0);
903 poptReadDefaultConfig(pc, 0);
905 while ((opt = poptGetNextOpt(pc)) != -1) {
906 /* most options are handled automatically by popt;
907 * only special cases are returned and listed here. */
911 print_rsync_version(FINFO);
916 /* Disable popt aliases on the server side and
917 * then start parsing the options again. */
919 pc = poptGetContext(RSYNC_NAME, argc, argv,
931 exit_cleanup(RERR_SYNTAX);
939 "Attempt to hack rsync thwarted!\n",
947 pc = poptGetContext(RSYNC_NAME, argc, argv,
948 long_daemon_options, 0);
949 while ((opt = poptGetNextOpt(pc)) != -1) {
961 "rsync: %s: %s (in daemon mode)\n",
962 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
968 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
969 snprintf(err_buf, sizeof err_buf,
970 "the --temp-dir path is WAY too long.\n");
975 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
978 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
979 exit_cleanup(RERR_SYNTAX);
982 *argv_p = argv = poptGetArgs(pc);
983 *argc_p = argc = count_args(argv);
989 case OPT_MODIFY_WINDOW:
990 /* The value has already been set by popt, but
991 * we need to remember that we're using a
992 * non-default setting. */
993 modify_window_set = 1;
997 parse_rule(&filter_list, poptGetOptArg(pc), 0, 0);
1001 parse_rule(&filter_list, poptGetOptArg(pc),
1002 0, XFLG_OLD_PREFIXES);
1006 parse_rule(&filter_list, poptGetOptArg(pc),
1007 MATCHFLG_INCLUDE, XFLG_OLD_PREFIXES);
1010 case OPT_EXCLUDE_FROM:
1011 case OPT_INCLUDE_FROM:
1012 arg = poptGetOptArg(pc);
1014 arg = sanitize_path(NULL, arg, NULL, 0);
1015 if (server_filter_list.head) {
1017 char *dir, *cp = strdup(arg);
1019 out_of_memory("parse_arguments");
1021 goto options_rejected;
1022 dir = cp + (*cp == '/' ? module_dirlen : 0);
1023 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1024 rej = check_filter(&server_filter_list, dir, 0) < 0;
1027 goto options_rejected;
1029 parse_filter_file(&filter_list, arg,
1030 opt == OPT_INCLUDE_FROM ? MATCHFLG_INCLUDE : 0,
1031 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
1035 if (refused_archive_part) {
1036 create_refuse_error(refused_archive_part);
1039 if (!recurse) /* preserve recurse == 2 */
1041 #ifdef SUPPORT_LINKS
1048 preserve_devices = 1;
1049 preserve_specials = 1;
1053 preserve_devices = preserve_specials = 1;
1057 preserve_devices = preserve_specials = 0;
1065 preserve_hard_links++;
1086 switch (++F_option_cnt) {
1088 parse_rule(&filter_list,": /.rsync-filter",0,0);
1091 parse_rule(&filter_list,"- .rsync-filter",0,0);
1097 if (refused_partial || refused_progress) {
1098 create_refuse_error(refused_partial
1099 ? refused_partial : refused_progress);
1107 if (def_compress_level < Z_DEFAULT_COMPRESSION
1108 || def_compress_level > Z_BEST_COMPRESSION) {
1109 snprintf(err_buf, sizeof err_buf,
1110 "--compress-level value is invalid: %d\n",
1111 def_compress_level);
1114 do_compression = def_compress_level != Z_NO_COMPRESSION;
1115 if (do_compression && refused_compress) {
1116 create_refuse_error(refused_compress);
1121 case OPT_WRITE_BATCH:
1122 /* batch_name is already set */
1126 case OPT_ONLY_WRITE_BATCH:
1127 /* batch_name is already set */
1131 case OPT_READ_BATCH:
1132 /* batch_name is already set */
1141 if ((max_size = parse_size_arg(&max_size_arg, 'b')) <= 0) {
1142 snprintf(err_buf, sizeof err_buf,
1143 "--max-size value is invalid: %s\n",
1150 if ((min_size = parse_size_arg(&min_size_arg, 'b')) <= 0) {
1151 snprintf(err_buf, sizeof err_buf,
1152 "--min-size value is invalid: %s\n",
1166 #ifdef SUPPORT_HARD_LINKS
1168 dest_option = "--link-dest";
1171 snprintf(err_buf, sizeof err_buf,
1172 "hard links are not supported on this %s\n",
1173 am_server ? "server" : "client");
1179 dest_option = "--copy-dest";
1182 case OPT_COMPARE_DEST:
1184 dest_option = "--compare-dest";
1186 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
1187 snprintf(err_buf, sizeof err_buf,
1188 "ERROR: at most %d %s args may be specified\n",
1189 MAX_BASIS_DIRS, dest_option);
1192 /* We defer sanitizing this arg until we know what
1193 * our destination directory is going to be. */
1194 basis_dir[basis_dir_cnt++] = (char *)poptGetOptArg(pc);
1198 arg = poptGetOptArg(pc);
1199 if (!parse_chmod(arg, &chmod_modes)) {
1200 snprintf(err_buf, sizeof err_buf,
1201 "Invalid argument passed to --chmod (%s)\n",
1217 /* FIXME: this should probably be ignored with a
1218 * warning and then countermeasures taken to
1219 * restrict group and other access in the presence
1220 * of any more restrictive ACLs, but this is safe
1222 snprintf(err_buf,sizeof(err_buf),
1223 "ACLs are not supported on this %s\n",
1224 am_server ? "server" : "client");
1229 #ifdef SUPPORT_XATTRS
1233 snprintf(err_buf,sizeof(err_buf),
1234 "extended attributes are not supported on this %s\n",
1235 am_server ? "server" : "client");
1240 /* A large opt value means that set_refuse_options()
1241 * turned this option off. */
1242 if (opt >= OPT_REFUSED_BASE) {
1243 create_refuse_error(opt);
1246 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
1247 am_server ? "on remote machine: " : "",
1248 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1254 if (human_readable && argc == 2) {
1255 /* Allow the old meaning of 'h' (--help) on its own. */
1261 if (iconv_opt && protect_args != 2) {
1262 if (!am_server && strcmp(iconv_opt, "-") == 0)
1265 need_unsorted_flist = 1;
1267 if (refused_no_iconv && !iconv_opt) {
1268 create_refuse_error(refused_no_iconv);
1273 if (protect_args == 1) {
1280 #ifndef SUPPORT_LINKS
1281 if (preserve_links && !am_sender) {
1282 snprintf(err_buf, sizeof err_buf,
1283 "symlinks are not supported on this %s\n",
1284 am_server ? "server" : "client");
1289 #ifndef SUPPORT_HARD_LINKS
1290 if (preserve_hard_links) {
1291 snprintf(err_buf, sizeof err_buf,
1292 "hard links are not supported on this %s\n",
1293 am_server ? "server" : "client");
1298 #ifndef SUPPORT_XATTRS
1300 snprintf(err_buf, sizeof err_buf,
1301 "--fake-super requires an rsync with extended attributes enabled\n");
1306 if (write_batch && read_batch) {
1307 snprintf(err_buf, sizeof err_buf,
1308 "--write-batch and --read-batch can not be used together\n");
1311 if (write_batch > 0 || read_batch) {
1314 "ignoring --%s-batch option sent to server\n",
1315 write_batch ? "write" : "read");
1316 /* We don't actually exit_cleanup(), so that we can
1317 * still service older version clients that still send
1318 * batch args to server. */
1319 read_batch = write_batch = 0;
1323 } else if (write_batch < 0 && dry_run)
1325 if (read_batch && files_from) {
1326 snprintf(err_buf, sizeof err_buf,
1327 "--read-batch cannot be used with --files-from\n");
1330 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
1331 snprintf(err_buf, sizeof err_buf,
1332 "the batch-file name must be %d characters or less.\n",
1333 MAX_BATCH_NAME_LEN);
1337 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
1338 snprintf(err_buf, sizeof err_buf,
1339 "the --temp-dir path is WAY too long.\n");
1343 if (max_delete < 0 && max_delete != INT_MIN) {
1344 /* Negative numbers are treated as "no deletions". */
1348 if (compare_dest + copy_dest + link_dest > 1) {
1349 snprintf(err_buf, sizeof err_buf,
1350 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
1355 if (recurse == 1) /* preserve recurse == 2 */
1362 xfer_dirs = recurse || list_only;
1364 if (relative_paths < 0)
1365 relative_paths = files_from? 1 : 0;
1366 if (!relative_paths)
1369 if (delete_before + !!delete_during + delete_after > 1) {
1370 snprintf(err_buf, sizeof err_buf,
1371 "You may not combine multiple --delete-WHEN options.\n");
1374 if (delete_before || delete_during || delete_after)
1376 else if (delete_mode || delete_excluded) {
1377 /* Only choose now between before & during if one is refused. */
1378 if (refused_delete_before) {
1379 if (!refused_delete_during)
1382 create_refuse_error(refused_delete_before);
1385 } else if (refused_delete_during)
1389 if (!xfer_dirs && delete_mode) {
1390 snprintf(err_buf, sizeof err_buf,
1391 "--delete does not work without -r or -d.\n");
1395 if (delete_mode && refused_delete) {
1396 create_refuse_error(refused_delete);
1400 if (remove_source_files) {
1401 /* We only want to infer this refusal of --remove-source-files
1402 * via the refusal of "delete", not any of the "delete-FOO"
1404 if (refused_delete && am_sender) {
1405 create_refuse_error(refused_delete);
1408 need_messages_from_generator = 1;
1411 *argv_p = argv = poptGetArgs(pc);
1412 *argc_p = argc = count_args(argv);
1414 if (sanitize_paths) {
1416 for (i = argc; i-- > 0; )
1417 argv[i] = sanitize_path(NULL, argv[i], "", 0);
1419 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
1421 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
1423 if (server_filter_list.head && !am_sender) {
1424 struct filter_list_struct *elp = &server_filter_list;
1428 goto options_rejected;
1429 dir = tmpdir + (*tmpdir == '/' ? module_dirlen : 0);
1430 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1431 if (check_filter(elp, dir, 1) < 0)
1432 goto options_rejected;
1437 goto options_rejected;
1438 dir = backup_dir + (*backup_dir == '/' ? module_dirlen : 0);
1439 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1440 if (check_filter(elp, dir, 1) < 0)
1441 goto options_rejected;
1446 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
1447 backup_suffix_len = strlen(backup_suffix);
1448 if (strchr(backup_suffix, '/') != NULL) {
1449 snprintf(err_buf, sizeof err_buf,
1450 "--suffix cannot contain slashes: %s\n",
1455 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
1456 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
1457 if (backup_dir_remainder < 32) {
1458 snprintf(err_buf, sizeof err_buf,
1459 "the --backup-dir path is WAY too long.\n");
1462 if (backup_dir_buf[backup_dir_len - 1] != '/') {
1463 backup_dir_buf[backup_dir_len++] = '/';
1464 backup_dir_buf[backup_dir_len] = '\0';
1466 if (verbose > 1 && !am_sender)
1467 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
1468 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
1469 snprintf(err_buf, sizeof err_buf,
1470 "--suffix cannot be a null string without --backup-dir\n");
1472 } else if (make_backups && delete_mode && !delete_excluded && !am_server) {
1473 snprintf(backup_dir_buf, sizeof backup_dir_buf,
1474 "P *%s", backup_suffix);
1475 parse_rule(&filter_list, backup_dir_buf, 0, 0);
1478 if (make_backups && !backup_dir) {
1479 omit_dir_times = 0; /* Implied, so avoid -O to sender. */
1480 if (preserve_times > 1)
1482 } else if (omit_dir_times) {
1483 if (preserve_times > 1)
1487 if (stdout_format) {
1488 if (am_server && log_format_has(stdout_format, 'I'))
1489 stdout_format_has_i = 2;
1490 else if (log_format_has(stdout_format, 'i'))
1491 stdout_format_has_i = itemize_changes | 1;
1492 if (!log_format_has(stdout_format, 'b')
1493 && !log_format_has(stdout_format, 'c'))
1494 log_before_transfer = !am_server;
1495 } else if (itemize_changes) {
1496 stdout_format = "%i %n%L";
1497 stdout_format_has_i = itemize_changes;
1498 log_before_transfer = !am_server;
1501 if (do_progress && !verbose && !log_before_transfer && !am_server)
1507 set_io_timeout(io_timeout);
1509 if (verbose && !stdout_format) {
1510 stdout_format = "%n%L";
1511 log_before_transfer = !am_server;
1513 if (stdout_format_has_i || log_format_has(stdout_format, 'o'))
1514 stdout_format_has_o_or_i = 1;
1516 if (logfile_name && !am_daemon) {
1517 if (!logfile_format) {
1518 logfile_format = "%i %n%L";
1519 logfile_format_has_i = logfile_format_has_o_or_i = 1;
1521 if (log_format_has(logfile_format, 'i'))
1522 logfile_format_has_i = 1;
1523 if (logfile_format_has_i || log_format_has(logfile_format, 'o'))
1524 logfile_format_has_o_or_i = 1;
1527 } else if (!am_daemon)
1528 logfile_format = NULL;
1530 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
1531 bwlimit = daemon_bwlimit;
1533 bwlimit_writemax = (size_t)bwlimit * 128;
1534 if (bwlimit_writemax < 512)
1535 bwlimit_writemax = 512;
1538 if (sparse_files && inplace) {
1539 /* Note: we don't check for this below, because --append is
1540 * OK with --sparse (as long as redos are handled right). */
1541 snprintf(err_buf, sizeof err_buf,
1542 "--sparse cannot be used with --inplace\n");
1547 if (whole_file > 0) {
1548 snprintf(err_buf, sizeof err_buf,
1549 "--append cannot be used with --whole-file\n");
1552 if (refused_inplace) {
1553 create_refuse_error(refused_inplace);
1559 if (delay_updates && !partial_dir)
1560 partial_dir = tmp_partialdir;
1563 #ifdef HAVE_FTRUNCATE
1565 snprintf(err_buf, sizeof err_buf,
1566 "--%s cannot be used with --%s\n",
1567 append_mode ? "append" : "inplace",
1568 delay_updates ? "delay-updates" : "partial-dir");
1571 /* --inplace implies --partial for refusal purposes, but we
1572 * clear the keep_partial flag for internal logic purposes. */
1573 if (refused_partial) {
1574 create_refuse_error(refused_partial);
1579 snprintf(err_buf, sizeof err_buf,
1580 "--%s is not supported on this %s\n",
1581 append_mode ? "append" : "inplace",
1582 am_server ? "server" : "client");
1586 if (keep_partial && !partial_dir && !am_server) {
1587 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
1588 partial_dir = strdup(arg);
1592 clean_fname(partial_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1593 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1595 if (!partial_dir && refused_partial) {
1596 create_refuse_error(refused_partial);
1606 if (argc > 2 || (!am_daemon && argc == 1)) {
1608 exit_cleanup(RERR_SYNTAX);
1610 if (strcmp(files_from, "-") == 0) {
1613 filesfrom_host = ""; /* reading from socket */
1614 } else if ((p = check_for_hostspec(files_from, &h, &q)) != 0) {
1616 snprintf(err_buf, sizeof err_buf,
1617 "The --files-from sent to the server cannot specify a host.\n");
1622 if (strcmp(files_from, "-") == 0) {
1623 snprintf(err_buf, sizeof err_buf,
1624 "Invalid --files-from remote filename\n");
1629 files_from = sanitize_path(NULL, files_from, NULL, 0);
1630 if (server_filter_list.head) {
1633 goto options_rejected;
1634 dir = files_from + (*files_from == '/' ? module_dirlen : 0);
1635 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1636 if (check_filter(&server_filter_list, dir, 0) < 0)
1637 goto options_rejected;
1639 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1640 if (filesfrom_fd < 0) {
1641 snprintf(err_buf, sizeof err_buf,
1642 "failed to open files-from file %s: %s\n",
1643 files_from, strerror(errno));
1654 snprintf(err_buf, sizeof err_buf,
1655 "Your options have been rejected by the server.\n");
1661 * Construct a filtered list of options to pass through from the
1662 * client to the server.
1664 * This involves setting options that will tell the server how to
1665 * behave, and also filtering out options that are processed only
1668 void server_options(char **args, int *argc_p)
1670 static char argstr[64];
1675 /* This should always remain first on the server's command-line. */
1676 args[ac++] = "--server";
1678 if (daemon_over_rsh > 0) {
1679 args[ac++] = "--daemon";
1681 /* if we're passing --daemon, we're done */
1686 args[ac++] = "--sender";
1694 for (i = 0; i < verbose; i++)
1697 /* the -q option is intentionally left out */
1702 if (!do_xfers) /* Note: NOT "dry_run"! */
1706 if ((list_only && !recurse) || xfer_dirs > 1
1707 || (xfer_dirs && !recurse && delete_mode && am_sender))
1712 if (prune_empty_dirs)
1725 /* We don't need to send --no-whole-file, because it's the
1726 * default for remote transfers, and in any case old versions
1727 * of rsync will not understand it. */
1729 if (preserve_hard_links) {
1731 if (preserve_hard_links > 1)
1738 if (preserve_devices) /* ignore preserve_specials here */
1744 else if (preserve_executability && am_sender)
1750 #ifdef SUPPORT_XATTRS
1751 if (preserve_xattrs) {
1753 if (preserve_xattrs > 1)
1759 if (always_checksum)
1767 if (one_file_system) {
1769 if (one_file_system > 1)
1777 /* We make use of the -e option to let the server know about any
1778 * pre-release protocol version && our allow_inc_recurse status. */
1779 set_allow_inc_recurse();
1780 #if SUBPROTOCOL_VERSION != 0
1781 if (protocol_version == PROTOCOL_VERSION) {
1782 x += snprintf(argstr+x, sizeof argstr - x,
1783 "e%d.%d%s", PROTOCOL_VERSION, SUBPROTOCOL_VERSION,
1784 allow_inc_recurse ? "i" : "");
1787 if (allow_inc_recurse) {
1795 args[ac++] = argstr;
1799 char *set = strchr(iconv_opt, ',');
1804 if (asprintf(&arg, "--iconv=%s", set) < 0)
1810 if (protect_args) /* initial args break here */
1814 args[ac++] = "--list-only";
1816 /* This makes sure that the remote rsync can handle deleting with -d
1817 * sans -r because the --no-r option was added at the same time. */
1818 if (xfer_dirs && !recurse && delete_mode && am_sender)
1819 args[ac++] = "--no-r";
1821 if (do_compression && def_compress_level != Z_DEFAULT_COMPRESSION) {
1822 if (asprintf(&arg, "--compress-level=%d", def_compress_level) < 0)
1827 if (preserve_devices) {
1828 /* Note: sending "--devices" would not be backward-compatible. */
1829 if (!preserve_specials)
1830 args[ac++] = "--no-specials"; /* -D is already set. */
1831 } else if (preserve_specials)
1832 args[ac++] = "--specials";
1834 /* The server side doesn't use our log-format, but in certain
1835 * circumstances they need to know a little about the option. */
1836 if (stdout_format && am_sender) {
1837 /* Use --log-format, not --out-format, for compatibility. */
1838 if (stdout_format_has_i > 1)
1839 args[ac++] = "--log-format=%i%I";
1840 else if (stdout_format_has_i)
1841 args[ac++] = "--log-format=%i";
1842 else if (stdout_format_has_o_or_i)
1843 args[ac++] = "--log-format=%o";
1845 args[ac++] = "--log-format=X";
1849 if (asprintf(&arg, "-B%lu", block_size) < 0)
1855 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1861 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1867 args[ac++] = "--backup-dir";
1868 args[ac++] = backup_dir;
1871 /* Only send --suffix if it specifies a non-default value. */
1872 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
1873 /* We use the following syntax to avoid weirdness with '~'. */
1874 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1880 if (max_delete > 0) {
1881 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1884 } else if (max_delete == 0)
1885 args[ac++] = "--max-delete=-1";
1887 args[ac++] = "--min-size";
1888 args[ac++] = min_size_arg;
1891 args[ac++] = "--max-size";
1892 args[ac++] = max_size_arg;
1895 args[ac++] = "--delete-before";
1896 else if (delete_during == 2)
1897 args[ac++] = "--delete-delay";
1898 else if (delete_during)
1899 args[ac++] = "--delete-during";
1900 else if (delete_after)
1901 args[ac++] = "--delete-after";
1902 else if (delete_mode && !delete_excluded)
1903 args[ac++] = "--delete";
1904 if (delete_excluded)
1905 args[ac++] = "--delete-excluded";
1907 args[ac++] = "--force";
1908 if (write_batch < 0)
1909 args[ac++] = "--only-write-batch=X";
1911 args[ac++] = "--super";
1913 args[ac++] = "--size-only";
1915 if (skip_compress) {
1916 if (asprintf(&arg, "--skip-compress=%s", skip_compress) < 0)
1922 if (modify_window_set) {
1923 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1928 if (checksum_seed) {
1929 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
1934 if (partial_dir && am_sender) {
1935 if (partial_dir != tmp_partialdir) {
1936 args[ac++] = "--partial-dir";
1937 args[ac++] = partial_dir;
1940 args[ac++] = "--delay-updates";
1941 } else if (keep_partial && am_sender)
1942 args[ac++] = "--partial";
1945 args[ac++] = "--ignore-errors";
1947 if (copy_unsafe_links)
1948 args[ac++] = "--copy-unsafe-links";
1951 args[ac++] = "--safe-links";
1954 args[ac++] = "--numeric-ids";
1957 args[ac++] = "--use-qsort";
1960 if (ignore_existing)
1961 args[ac++] = "--ignore-existing";
1963 /* Backward compatibility: send --existing, not --ignore-non-existing. */
1964 if (ignore_non_existing)
1965 args[ac++] = "--existing";
1968 args[ac++] = "--temp-dir";
1969 args[ac++] = tmpdir;
1973 /* the server only needs this option if it is not the sender,
1974 * and it may be an older version that doesn't know this
1975 * option, so don't send it if client is the sender.
1978 for (i = 0; i < basis_dir_cnt; i++) {
1979 args[ac++] = dest_option;
1980 args[ac++] = basis_dir[i];
1986 if (append_mode > 1)
1987 args[ac++] = "--append";
1988 args[ac++] = "--append";
1990 args[ac++] = "--inplace";
1992 if (files_from && (!am_sender || filesfrom_host)) {
1993 if (filesfrom_host) {
1994 args[ac++] = "--files-from";
1995 args[ac++] = files_from;
1997 args[ac++] = "--from0";
1999 args[ac++] = "--files-from=-";
2000 args[ac++] = "--from0";
2002 if (!relative_paths)
2003 args[ac++] = "--no-relative";
2005 /* It's OK that this checks the upper-bound of the protocol_version. */
2006 if (relative_paths && !implied_dirs && (!am_sender || protocol_version >= 30))
2007 args[ac++] = "--no-implied-dirs";
2009 if (fuzzy_basis && am_sender)
2010 args[ac++] = "--fuzzy";
2012 if (remove_source_files == 1)
2013 args[ac++] = "--remove-source-files";
2014 else if (remove_source_files)
2015 args[ac++] = "--remove-sent-files";
2021 out_of_memory("server_options");
2024 /* Look for a HOST specfication of the form "HOST:PATH", "HOST::PATH", or
2025 * "rsync://HOST:PORT/PATH". If found, *host_ptr will be set to some allocated
2026 * memory with the HOST. If a daemon-accessing spec was specified, the value
2027 * of *port_ptr will contain a non-0 port number, otherwise it will be set to
2028 * 0. The return value is a pointer to the PATH. Note that the HOST spec can
2029 * be an IPv6 literal address enclosed in '[' and ']' (such as "[::1]" or
2030 * "[::ffff:127.0.0.1]") which is returned without the '[' and ']'. */
2031 char *check_for_hostspec(char *s, char **host_ptr, int *port_ptr)
2037 if (port_ptr && strncasecmp(URL_PREFIX, s, strlen(URL_PREFIX)) == 0) {
2039 s += strlen(URL_PREFIX);
2040 if ((p = strchr(s, '/')) != NULL) {
2044 hostlen = strlen(s);
2047 if (*s == '[' && (p = strchr(s, ']')) != NULL) {
2051 *port_ptr = atoi(p+2);
2053 if ((p = strchr(s, ':')) != NULL && p < s + hostlen) {
2055 *port_ptr = atoi(p+1);
2059 *port_ptr = RSYNC_PORT;
2060 *host_ptr = new_array(char, hostlen + 1);
2061 strlcpy(*host_ptr, s, hostlen + 1);
2065 if (*s == '[' && (p = strchr(s, ']')) != NULL && p[1] == ':') {
2069 not_host = strchr(s, '/') || !strchr(s, ':');
2075 if (!(p = strchr(s, ':')))
2079 not_host = strchr(s, '/') != NULL;
2085 *host_ptr = new_array(char, hostlen + 1);
2086 strlcpy(*host_ptr, s, hostlen + 1);
2089 if (port_ptr && !*port_ptr)
2090 *port_ptr = RSYNC_PORT;