Re-indent some code in set_file_attrs() to make the flow clearer.
[rsync.git] / options.c
blob5a24dd2fe980c0a4bc0d9c8c65c5814e2bc99294
1 /*
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.
22 #include "rsync.h"
23 #include "ifuncs.h"
24 #include <popt.h>
25 #include "zlib/zlib.h"
27 extern int module_id;
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;
34 int make_backups = 0;
36 /**
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()
43 **/
44 int whole_file = -1;
46 int append_mode = 0;
47 int keep_dirlinks = 0;
48 int copy_dirlinks = 0;
49 int copy_links = 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;
58 int preserve_uid = 0;
59 int preserve_gid = 0;
60 int preserve_times = 0;
61 int update_only = 0;
62 int cvs_exclude = 0;
63 int dry_run = 0;
64 int do_xfers = 1;
65 int ignore_times = 0;
66 int delete_mode = 0;
67 int delete_during = 0;
68 int delete_before = 0;
69 int delete_after = 0;
70 int delete_excluded = 0;
71 int remove_source_files = 0;
72 int one_file_system = 0;
73 int protocol_version = PROTOCOL_VERSION;
74 int sparse_files = 0;
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 */
78 int am_server = 0;
79 int am_sender = 0;
80 int am_generator = 0;
81 int am_starting_up = 1;
82 int relative_paths = -1;
83 int implied_dirs = 1;
84 int numeric_ids = 0;
85 int allow_8bit_chars = 0;
86 int force_delete = 0;
87 int io_timeout = 0;
88 int allowed_lull = 0;
89 int prune_empty_dirs = 0;
90 int use_qsort = 0;
91 char *files_from = NULL;
92 int filesfrom_fd = -1;
93 char *filesfrom_host = NULL;
94 int eol_nulls = 0;
95 int protect_args = 0;
96 int human_readable = 0;
97 int recurse = 0;
98 int allow_inc_recurse = 1;
99 int xfer_dirs = -1;
100 int am_daemon = 0;
101 int do_stats = 0;
102 int do_progress = 0;
103 int connect_timeout = 0;
104 int keep_partial = 0;
105 int safe_symlinks = 0;
106 int copy_unsafe_links = 0;
107 int size_only = 0;
108 int daemon_bwlimit = 0;
109 int bwlimit = 0;
110 int fuzzy_basis = 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;
116 OFF_T max_size = 0;
117 OFF_T min_size = 0;
118 int ignore_errors = 0;
119 int modify_window = 0;
120 int blocking_io = -1;
121 int checksum_seed = 0;
122 int inplace = 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. **/
128 int default_af_hint
129 #ifdef INET6
130 = 0; /* Any protocol */
131 #else
132 = AF_INET; /* Must use IPv4 */
133 # ifdef AF_INET6
134 # undef AF_INET6
135 # endif
136 # define AF_INET6 AF_INET /* make -6 option a no-op */
137 #endif
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. **/
142 int no_detach
143 #if defined _WIN32 || defined __WIN32__
144 = 1;
145 #else
146 = 0;
147 #endif
149 int write_batch = 0;
150 int read_batch = 0;
151 int backup_dir_len = 0;
152 int backup_suffix_len;
153 unsigned int backup_dir_remainder;
155 char *backup_suffix = NULL;
156 char *tmpdir = 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;
169 int rsync_port = 0;
170 int compare_dest = 0;
171 int copy_dest = 0;
172 int link_dest = 0;
173 int basis_dir_cnt = 0;
174 char *dest_option = NULL;
176 int verbose = 0;
177 int quiet = 0;
178 int output_motd = 1;
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;
185 int list_only = 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;
191 #ifdef ICONV_OPTION
192 char *iconv_opt = ICONV_OPTION;
193 #endif
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;
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. **/
212 char *bind_address;
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);
230 #endif
231 #ifdef HAVE_SOCKETPAIR
232 got_socketpair = "";
233 #endif
234 #ifdef HAVE_FTRUNCATE
235 have_inplace = "";
236 #endif
237 #ifdef SUPPORT_HARD_LINKS
238 hardlinks = "";
239 #endif
240 #ifdef SUPPORT_ACLS
241 acls = "";
242 #endif
243 #ifdef SUPPORT_XATTRS
244 xattrs = "";
245 #endif
246 #ifdef SUPPORT_LINKS
247 links = "";
248 #endif
249 #ifdef INET6
250 ipv6 = "";
251 #endif
252 #ifdef ICONV_OPTION
253 iconv = "";
254 #endif
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());
273 #endif
275 #if SIZEOF_INT64 < 8
276 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
277 #endif
278 if (sizeof (int64) != SIZEOF_INT64) {
279 rprintf(f,
280 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
281 (int) SIZEOF_INT64, (int) sizeof (int64));
284 rprintf(f,"\n");
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);
295 rprintf(F,"\n");
296 rprintf(F,"rsync is a file transfer program capable of efficient remote update\n");
297 rprintf(F,"via a fast differencing algorithm.\n");
299 rprintf(F,"\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");
309 rprintf(F,"\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");
338 #ifdef SUPPORT_ACLS
339 rprintf(F," -A, --acls preserve ACLs (implies --perms)\n");
340 #endif
341 #ifdef SUPPORT_XATTRS
342 rprintf(F," -X, --xattrs preserve extended attributes\n");
343 #endif
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");
354 #endif
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");
426 #ifdef ICONV_OPTION
427 rprintf(F," --iconv=CONVERT_SPEC request charset conversion of filenames\n");
428 #endif
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");
434 rprintf(F,"\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,
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, &copy_links, 0, 0, 0 },
509 {"copy-unsafe-links",0, POPT_ARG_NONE, &copy_unsafe_links, 0, 0, 0 },
510 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
511 {"copy-dirlinks", 'k', POPT_ARG_NONE, &copy_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 },
613 #ifdef ICONV_OPTION
614 {"iconv", 0, POPT_ARG_STRING, &iconv_opt, 0, 0, 0 },
615 #endif
616 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
617 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
618 {"8-bit-output", '8', POPT_ARG_NONE, &allow_8bit_chars, 0, 0, 0 },
619 {"qsort", 0, POPT_ARG_NONE, &use_qsort, 0, 0, 0 },
620 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
621 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
622 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
623 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
624 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
625 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
626 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
627 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
628 {"server", 0, POPT_ARG_NONE, 0, OPT_SERVER, 0, 0 },
629 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
630 /* All the following options switch us into daemon-mode option-parsing. */
631 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
632 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
633 {"detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
634 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
635 {0,0,0,0, 0, 0, 0}
638 static void daemon_usage(enum logcode F)
640 print_rsync_version(F);
642 rprintf(F,"\n");
643 rprintf(F,"Usage: rsync --daemon [OPTION]...\n");
644 rprintf(F," --address=ADDRESS bind to the specified address\n");
645 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
646 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
647 rprintf(F," --no-detach do not detach from the parent\n");
648 rprintf(F," --port=PORT listen on alternate port number\n");
649 rprintf(F," --log-file=FILE override the \"log file\" setting\n");
650 rprintf(F," --log-file-format=FMT override the \"log format\" setting\n");
651 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
652 rprintf(F," -v, --verbose increase verbosity\n");
653 rprintf(F," -4, --ipv4 prefer IPv4\n");
654 rprintf(F," -6, --ipv6 prefer IPv6\n");
655 rprintf(F," --help show this help screen\n");
657 rprintf(F,"\n");
658 rprintf(F,"If you were not trying to invoke rsync as a daemon, avoid using any of the\n");
659 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
662 static struct poptOption long_daemon_options[] = {
663 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
664 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
665 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
666 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
667 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
668 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
669 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
670 {"detach", 0, POPT_ARG_VAL, &no_detach, 0, 0, 0 },
671 {"no-detach", 0, POPT_ARG_VAL, &no_detach, 1, 0, 0 },
672 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
673 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
674 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
675 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
676 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
677 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
678 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
679 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
680 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
681 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
682 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
683 {0,0,0,0, 0, 0, 0}
687 static char err_buf[200];
691 * Store the option error message, if any, so that we can log the
692 * connection attempt (which requires parsing the options), and then
693 * show the error later on.
695 void option_error(void)
697 if (!err_buf[0]) {
698 strlcpy(err_buf, "Error parsing options: option may "
699 "be supported on client but not on server?\n",
700 sizeof err_buf);
703 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
704 msleep(20);
709 * Tweak the option table to disable all options that the rsyncd.conf
710 * file has told us to refuse.
712 static void set_refuse_options(char *bp)
714 struct poptOption *op;
715 char *cp, shortname[2];
716 int is_wild, found_match;
718 shortname[1] = '\0';
720 while (1) {
721 while (*bp == ' ') bp++;
722 if (!*bp)
723 break;
724 if ((cp = strchr(bp, ' ')) != NULL)
725 *cp= '\0';
726 is_wild = strpbrk(bp, "*?[") != NULL;
727 found_match = 0;
728 for (op = long_options; ; op++) {
729 *shortname = op->shortName;
730 if (!op->longName && !*shortname)
731 break;
732 if ((op->longName && wildmatch(bp, op->longName))
733 || (*shortname && wildmatch(bp, shortname))) {
734 if (op->argInfo == POPT_ARG_VAL)
735 op->argInfo = POPT_ARG_NONE;
736 op->val = (op - long_options) + OPT_REFUSED_BASE;
737 found_match = 1;
738 /* These flags are set to let us easily check
739 * an implied option later in the code. */
740 switch (*shortname) {
741 case 'r': case 'd': case 'l': case 'p':
742 case 't': case 'g': case 'o': case 'D':
743 refused_archive_part = op->val;
744 break;
745 case 'z':
746 refused_compress = op->val;
747 break;
748 case '\0':
749 if (wildmatch("delete", op->longName))
750 refused_delete = op->val;
751 else if (wildmatch("delete-before", op->longName))
752 refused_delete_before = op->val;
753 else if (wildmatch("delete-during", op->longName))
754 refused_delete_during = op->val;
755 else if (wildmatch("partial", op->longName))
756 refused_partial = op->val;
757 else if (wildmatch("progress", op->longName))
758 refused_progress = op->val;
759 else if (wildmatch("inplace", op->longName))
760 refused_inplace = op->val;
761 break;
763 if (!is_wild)
764 break;
767 if (!found_match) {
768 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
769 bp);
771 if (!cp)
772 break;
773 *cp = ' ';
774 bp = cp + 1;
779 static int count_args(const char **argv)
781 int i = 0;
783 if (argv) {
784 while (argv[i] != NULL)
785 i++;
788 return i;
792 static OFF_T parse_size_arg(char **size_arg, char def_suf)
794 int reps, mult, make_compatible = 0;
795 const char *arg;
796 OFF_T size = 1;
798 for (arg = *size_arg; isDigit(arg); arg++) {}
799 if (*arg == '.')
800 for (arg++; isDigit(arg); arg++) {}
801 switch (*arg && *arg != '+' && *arg != '-' ? *arg++ : def_suf) {
802 case 'b': case 'B':
803 reps = 0;
804 break;
805 case 'k': case 'K':
806 reps = 1;
807 break;
808 case 'm': case 'M':
809 reps = 2;
810 break;
811 case 'g': case 'G':
812 reps = 3;
813 break;
814 default:
815 return -1;
817 if (*arg == 'b' || *arg == 'B')
818 mult = 1000, make_compatible = 1, arg++;
819 else if (!*arg || *arg == '+' || *arg == '-')
820 mult = 1024;
821 else if (strncasecmp(arg, "ib", 2) == 0)
822 mult = 1024, arg += 2;
823 else
824 return -1;
825 while (reps--)
826 size *= mult;
827 size *= atof(*size_arg);
828 if ((*arg == '+' || *arg == '-') && arg[1] == '1')
829 size += atoi(arg), make_compatible = 1, arg += 2;
830 if (*arg)
831 return -1;
832 if (size > 0 && make_compatible) {
833 /* We convert this manually because we may need %lld precision,
834 * and that's not a portable sprintf() escape. */
835 char buf[128], *s = buf + sizeof buf - 1;
836 OFF_T num = size;
837 *s = '\0';
838 while (num) {
839 *--s = (char)(num % 10) + '0';
840 num /= 10;
842 if (!(*size_arg = strdup(s)))
843 out_of_memory("parse_size_arg");
845 return size;
849 static void create_refuse_error(int which)
851 /* The "which" value is the index + OPT_REFUSED_BASE. */
852 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
853 int n = snprintf(err_buf, sizeof err_buf,
854 "The server is configured to refuse --%s\n",
855 op->longName) - 1;
856 if (op->shortName) {
857 snprintf(err_buf + n, sizeof err_buf - n,
858 " (-%c)\n", op->shortName);
864 * Process command line arguments. Called on both local and remote.
866 * @retval 1 if all options are OK; with globals set to appropriate
867 * values
869 * @retval 0 on error, with err_buf containing an explanation
871 int parse_arguments(int *argc_p, const char ***argv_p, int frommain)
873 static poptContext pc;
874 char *ref = lp_refuse_options(module_id);
875 const char *arg, **argv = *argv_p;
876 int argc = *argc_p;
877 int opt;
879 if (ref && *ref)
880 set_refuse_options(ref);
881 if (am_daemon)
882 set_refuse_options("log-file*");
884 #ifdef ICONV_OPTION
885 if (!am_daemon && !protect_args && (arg = getenv("RSYNC_ICONV")) != NULL && *arg)
886 iconv_opt = strdup(arg);
887 #endif
889 /* TODO: Call poptReadDefaultConfig; handle errors. */
891 /* The context leaks in case of an error, but if there's a
892 * problem we always exit anyhow. */
893 if (pc)
894 poptFreeContext(pc);
895 pc = poptGetContext(RSYNC_NAME, argc, argv, long_options, 0);
896 if (!am_server)
897 poptReadDefaultConfig(pc, 0);
899 while ((opt = poptGetNextOpt(pc)) != -1) {
900 /* most options are handled automatically by popt;
901 * only special cases are returned and listed here. */
903 switch (opt) {
904 case OPT_VERSION:
905 print_rsync_version(FINFO);
906 exit_cleanup(0);
908 case OPT_SERVER:
909 if (!am_server) {
910 /* Disable popt aliases on the server side and
911 * then start parsing the options again. */
912 poptFreeContext(pc);
913 pc = poptGetContext(RSYNC_NAME, argc, argv,
914 long_options, 0);
915 am_server = 1;
917 #ifdef ICONV_OPTION
918 iconv_opt = NULL;
919 #endif
920 break;
922 case OPT_SENDER:
923 if (!am_server) {
924 usage(FERROR);
925 exit_cleanup(RERR_SYNTAX);
927 am_sender = 1;
928 break;
930 case OPT_DAEMON:
931 if (am_daemon) {
932 strlcpy(err_buf,
933 "Attempt to hack rsync thwarted!\n",
934 sizeof err_buf);
935 return 0;
937 #ifdef ICONV_OPTION
938 iconv_opt = NULL;
939 #endif
940 poptFreeContext(pc);
941 pc = poptGetContext(RSYNC_NAME, argc, argv,
942 long_daemon_options, 0);
943 while ((opt = poptGetNextOpt(pc)) != -1) {
944 switch (opt) {
945 case 'h':
946 daemon_usage(FINFO);
947 exit_cleanup(0);
949 case 'v':
950 verbose++;
951 break;
953 default:
954 rprintf(FERROR,
955 "rsync: %s: %s (in daemon mode)\n",
956 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
957 poptStrerror(opt));
958 goto daemon_error;
962 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
963 snprintf(err_buf, sizeof err_buf,
964 "the --temp-dir path is WAY too long.\n");
965 return 0;
968 if (!daemon_opt) {
969 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
970 daemon_error:
971 rprintf(FERROR,
972 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
973 exit_cleanup(RERR_SYNTAX);
976 *argv_p = argv = poptGetArgs(pc);
977 *argc_p = argc = count_args(argv);
978 am_starting_up = 0;
979 daemon_opt = 0;
980 am_daemon = 1;
981 return 1;
983 case OPT_MODIFY_WINDOW:
984 /* The value has already been set by popt, but
985 * we need to remember that we're using a
986 * non-default setting. */
987 modify_window_set = 1;
988 break;
990 case OPT_FILTER:
991 parse_rule(&filter_list, poptGetOptArg(pc), 0, 0);
992 break;
994 case OPT_EXCLUDE:
995 parse_rule(&filter_list, poptGetOptArg(pc),
996 0, XFLG_OLD_PREFIXES);
997 break;
999 case OPT_INCLUDE:
1000 parse_rule(&filter_list, poptGetOptArg(pc),
1001 MATCHFLG_INCLUDE, XFLG_OLD_PREFIXES);
1002 break;
1004 case OPT_EXCLUDE_FROM:
1005 case OPT_INCLUDE_FROM:
1006 arg = poptGetOptArg(pc);
1007 if (sanitize_paths)
1008 arg = sanitize_path(NULL, arg, NULL, 0);
1009 if (server_filter_list.head) {
1010 int rej;
1011 char *dir, *cp = strdup(arg);
1012 if (!cp)
1013 out_of_memory("parse_arguments");
1014 if (!*cp)
1015 goto options_rejected;
1016 dir = cp + (*cp == '/' ? module_dirlen : 0);
1017 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1018 rej = check_filter(&server_filter_list, dir, 0) < 0;
1019 free(cp);
1020 if (rej)
1021 goto options_rejected;
1023 parse_filter_file(&filter_list, arg,
1024 opt == OPT_INCLUDE_FROM ? MATCHFLG_INCLUDE : 0,
1025 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
1026 break;
1028 case 'a':
1029 if (refused_archive_part) {
1030 create_refuse_error(refused_archive_part);
1031 return 0;
1033 if (!recurse) /* preserve recurse == 2 */
1034 recurse = 1;
1035 #ifdef SUPPORT_LINKS
1036 preserve_links = 1;
1037 #endif
1038 preserve_perms = 1;
1039 preserve_times = 2;
1040 preserve_gid = 1;
1041 preserve_uid = 1;
1042 preserve_devices = 1;
1043 preserve_specials = 1;
1044 break;
1046 case 'D':
1047 preserve_devices = preserve_specials = 1;
1048 break;
1050 case OPT_NO_D:
1051 preserve_devices = preserve_specials = 0;
1052 break;
1054 case 'h':
1055 human_readable++;
1056 break;
1058 case 'H':
1059 preserve_hard_links++;
1060 break;
1062 case 'i':
1063 itemize_changes++;
1064 break;
1066 case 'v':
1067 verbose++;
1068 break;
1070 case 'q':
1071 if (frommain)
1072 quiet++;
1073 break;
1075 case 'x':
1076 one_file_system++;
1077 break;
1079 case 'F':
1080 switch (++F_option_cnt) {
1081 case 1:
1082 parse_rule(&filter_list,": /.rsync-filter",0,0);
1083 break;
1084 case 2:
1085 parse_rule(&filter_list,"- .rsync-filter",0,0);
1086 break;
1088 break;
1090 case 'P':
1091 if (refused_partial || refused_progress) {
1092 create_refuse_error(refused_partial
1093 ? refused_partial : refused_progress);
1094 return 0;
1096 do_progress = 1;
1097 keep_partial = 1;
1098 break;
1100 case 'z':
1101 if (def_compress_level < Z_DEFAULT_COMPRESSION
1102 || def_compress_level > Z_BEST_COMPRESSION) {
1103 snprintf(err_buf, sizeof err_buf,
1104 "--compress-level value is invalid: %d\n",
1105 def_compress_level);
1106 return 0;
1108 do_compression = def_compress_level != Z_NO_COMPRESSION;
1109 if (do_compression && refused_compress) {
1110 create_refuse_error(refused_compress);
1111 return 0;
1113 break;
1115 case OPT_WRITE_BATCH:
1116 /* batch_name is already set */
1117 write_batch = 1;
1118 break;
1120 case OPT_ONLY_WRITE_BATCH:
1121 /* batch_name is already set */
1122 write_batch = -1;
1123 break;
1125 case OPT_READ_BATCH:
1126 /* batch_name is already set */
1127 read_batch = 1;
1128 break;
1130 case OPT_MAX_SIZE:
1131 if ((max_size = parse_size_arg(&max_size_arg, 'b')) <= 0) {
1132 snprintf(err_buf, sizeof err_buf,
1133 "--max-size value is invalid: %s\n",
1134 max_size_arg);
1135 return 0;
1137 break;
1139 case OPT_MIN_SIZE:
1140 if ((min_size = parse_size_arg(&min_size_arg, 'b')) <= 0) {
1141 snprintf(err_buf, sizeof err_buf,
1142 "--min-size value is invalid: %s\n",
1143 min_size_arg);
1144 return 0;
1146 break;
1148 case OPT_APPEND:
1149 if (am_server)
1150 append_mode++;
1151 else
1152 append_mode = 1;
1153 break;
1155 case OPT_LINK_DEST:
1156 #ifdef SUPPORT_HARD_LINKS
1157 link_dest = 1;
1158 dest_option = "--link-dest";
1159 goto set_dest_dir;
1160 #else
1161 snprintf(err_buf, sizeof err_buf,
1162 "hard links are not supported on this %s\n",
1163 am_server ? "server" : "client");
1164 return 0;
1165 #endif
1167 case OPT_COPY_DEST:
1168 copy_dest = 1;
1169 dest_option = "--copy-dest";
1170 goto set_dest_dir;
1172 case OPT_COMPARE_DEST:
1173 compare_dest = 1;
1174 dest_option = "--compare-dest";
1175 set_dest_dir:
1176 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
1177 snprintf(err_buf, sizeof err_buf,
1178 "ERROR: at most %d %s args may be specified\n",
1179 MAX_BASIS_DIRS, dest_option);
1180 return 0;
1182 /* We defer sanitizing this arg until we know what
1183 * our destination directory is going to be. */
1184 basis_dir[basis_dir_cnt++] = (char *)poptGetOptArg(pc);
1185 break;
1187 case OPT_CHMOD:
1188 arg = poptGetOptArg(pc);
1189 if (!parse_chmod(arg, &chmod_modes)) {
1190 snprintf(err_buf, sizeof err_buf,
1191 "Invalid argument passed to --chmod (%s)\n",
1192 arg);
1193 return 0;
1195 break;
1197 case OPT_HELP:
1198 usage(FINFO);
1199 exit_cleanup(0);
1201 case 'A':
1202 #ifdef SUPPORT_ACLS
1203 preserve_acls = 1;
1204 preserve_perms = 1;
1205 break;
1206 #else
1207 /* FIXME: this should probably be ignored with a
1208 * warning and then countermeasures taken to
1209 * restrict group and other access in the presence
1210 * of any more restrictive ACLs, but this is safe
1211 * for now */
1212 snprintf(err_buf,sizeof(err_buf),
1213 "ACLs are not supported on this %s\n",
1214 am_server ? "server" : "client");
1215 return 0;
1216 #endif
1218 case 'X':
1219 #ifdef SUPPORT_XATTRS
1220 preserve_xattrs++;
1221 break;
1222 #else
1223 snprintf(err_buf,sizeof(err_buf),
1224 "extended attributes are not supported on this %s\n",
1225 am_server ? "server" : "client");
1226 return 0;
1227 #endif
1229 default:
1230 /* A large opt value means that set_refuse_options()
1231 * turned this option off. */
1232 if (opt >= OPT_REFUSED_BASE) {
1233 create_refuse_error(opt);
1234 return 0;
1236 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
1237 am_server ? "on remote machine: " : "",
1238 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1239 poptStrerror(opt));
1240 return 0;
1244 if (human_readable && argc == 2) {
1245 /* Allow the old meaning of 'h' (--help) on its own. */
1246 usage(FINFO);
1247 exit_cleanup(0);
1250 #ifdef ICONV_OPTION
1251 if (iconv_opt && protect_args != 2) {
1252 if (!am_server && strcmp(iconv_opt, "-") == 0)
1253 iconv_opt = NULL;
1254 else
1255 need_unsorted_flist = 1;
1257 #endif
1259 if (protect_args == 1) {
1260 if (!frommain)
1261 protect_args = 0;
1262 else if (am_server)
1263 return 1;
1266 #ifndef SUPPORT_LINKS
1267 if (preserve_links && !am_sender) {
1268 snprintf(err_buf, sizeof err_buf,
1269 "symlinks are not supported on this %s\n",
1270 am_server ? "server" : "client");
1271 return 0;
1273 #endif
1275 #ifndef SUPPORT_HARD_LINKS
1276 if (preserve_hard_links) {
1277 snprintf(err_buf, sizeof err_buf,
1278 "hard links are not supported on this %s\n",
1279 am_server ? "server" : "client");
1280 return 0;
1282 #endif
1284 #ifndef SUPPORT_XATTRS
1285 if (am_root < 0) {
1286 snprintf(err_buf, sizeof err_buf,
1287 "--fake-super requires an rsync with extended attributes enabled\n");
1288 return 0;
1290 #endif
1292 if (write_batch && read_batch) {
1293 snprintf(err_buf, sizeof err_buf,
1294 "--write-batch and --read-batch can not be used together\n");
1295 return 0;
1297 if (write_batch > 0 || read_batch) {
1298 if (am_server) {
1299 rprintf(FINFO,
1300 "ignoring --%s-batch option sent to server\n",
1301 write_batch ? "write" : "read");
1302 /* We don't actually exit_cleanup(), so that we can
1303 * still service older version clients that still send
1304 * batch args to server. */
1305 read_batch = write_batch = 0;
1306 batch_name = NULL;
1307 } else if (dry_run)
1308 write_batch = 0;
1309 } else if (write_batch < 0 && dry_run)
1310 write_batch = 0;
1311 if (read_batch && files_from) {
1312 snprintf(err_buf, sizeof err_buf,
1313 "--read-batch cannot be used with --files-from\n");
1314 return 0;
1316 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
1317 snprintf(err_buf, sizeof err_buf,
1318 "the batch-file name must be %d characters or less.\n",
1319 MAX_BATCH_NAME_LEN);
1320 return 0;
1323 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
1324 snprintf(err_buf, sizeof err_buf,
1325 "the --temp-dir path is WAY too long.\n");
1326 return 0;
1329 if (max_delete < 0 && max_delete != INT_MIN) {
1330 /* Negative numbers are treated as "no deletions". */
1331 max_delete = 0;
1334 if (compare_dest + copy_dest + link_dest > 1) {
1335 snprintf(err_buf, sizeof err_buf,
1336 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
1337 return 0;
1340 if (files_from) {
1341 if (recurse == 1) /* preserve recurse == 2 */
1342 recurse = 0;
1343 if (xfer_dirs < 0)
1344 xfer_dirs = 1;
1347 if (xfer_dirs < 1)
1348 xfer_dirs = recurse || list_only;
1350 if (relative_paths < 0)
1351 relative_paths = files_from? 1 : 0;
1352 if (!relative_paths)
1353 implied_dirs = 0;
1355 if (delete_before + !!delete_during + delete_after > 1) {
1356 snprintf(err_buf, sizeof err_buf,
1357 "You may not combine multiple --delete-WHEN options.\n");
1358 return 0;
1360 if (delete_before || delete_during || delete_after)
1361 delete_mode = 1;
1362 else if (delete_mode || delete_excluded) {
1363 /* Only choose now between before & during if one is refused. */
1364 if (refused_delete_before) {
1365 if (!refused_delete_during)
1366 delete_during = 1;
1367 else {
1368 create_refuse_error(refused_delete_before);
1369 return 0;
1371 } else if (refused_delete_during)
1372 delete_before = 1;
1373 delete_mode = 1;
1375 if (!xfer_dirs && delete_mode) {
1376 snprintf(err_buf, sizeof err_buf,
1377 "--delete does not work without -r or -d.\n");
1378 return 0;
1381 if (delete_mode && refused_delete) {
1382 create_refuse_error(refused_delete);
1383 return 0;
1386 if (remove_source_files) {
1387 /* We only want to infer this refusal of --remove-source-files
1388 * via the refusal of "delete", not any of the "delete-FOO"
1389 * options. */
1390 if (refused_delete && am_sender) {
1391 create_refuse_error(refused_delete);
1392 return 0;
1394 need_messages_from_generator = 1;
1397 *argv_p = argv = poptGetArgs(pc);
1398 *argc_p = argc = count_args(argv);
1400 if (sanitize_paths) {
1401 int i;
1402 for (i = argc; i-- > 0; )
1403 argv[i] = sanitize_path(NULL, argv[i], "", 0);
1404 if (tmpdir)
1405 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
1406 if (backup_dir)
1407 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
1409 if (server_filter_list.head && !am_sender) {
1410 struct filter_list_struct *elp = &server_filter_list;
1411 if (tmpdir) {
1412 char *dir;
1413 if (!*tmpdir)
1414 goto options_rejected;
1415 dir = tmpdir + (*tmpdir == '/' ? module_dirlen : 0);
1416 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1417 if (check_filter(elp, dir, 1) < 0)
1418 goto options_rejected;
1420 if (backup_dir) {
1421 char *dir;
1422 if (!*backup_dir)
1423 goto options_rejected;
1424 dir = backup_dir + (*backup_dir == '/' ? module_dirlen : 0);
1425 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1426 if (check_filter(elp, dir, 1) < 0)
1427 goto options_rejected;
1431 if (!backup_suffix)
1432 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
1433 backup_suffix_len = strlen(backup_suffix);
1434 if (strchr(backup_suffix, '/') != NULL) {
1435 snprintf(err_buf, sizeof err_buf,
1436 "--suffix cannot contain slashes: %s\n",
1437 backup_suffix);
1438 return 0;
1440 if (backup_dir) {
1441 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
1442 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
1443 if (backup_dir_remainder < 32) {
1444 snprintf(err_buf, sizeof err_buf,
1445 "the --backup-dir path is WAY too long.\n");
1446 return 0;
1448 if (backup_dir_buf[backup_dir_len - 1] != '/') {
1449 backup_dir_buf[backup_dir_len++] = '/';
1450 backup_dir_buf[backup_dir_len] = '\0';
1452 if (verbose > 1 && !am_sender)
1453 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
1454 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
1455 snprintf(err_buf, sizeof err_buf,
1456 "--suffix cannot be a null string without --backup-dir\n");
1457 return 0;
1458 } else if (make_backups && delete_mode && !delete_excluded && !am_server) {
1459 snprintf(backup_dir_buf, sizeof backup_dir_buf,
1460 "P *%s", backup_suffix);
1461 parse_rule(&filter_list, backup_dir_buf, 0, 0);
1464 if (make_backups && !backup_dir) {
1465 omit_dir_times = 0; /* Implied, so avoid -O to sender. */
1466 if (preserve_times > 1)
1467 preserve_times = 1;
1468 } else if (omit_dir_times) {
1469 if (preserve_times > 1)
1470 preserve_times = 1;
1473 if (stdout_format) {
1474 if (am_server && log_format_has(stdout_format, 'I'))
1475 stdout_format_has_i = 2;
1476 else if (log_format_has(stdout_format, 'i'))
1477 stdout_format_has_i = itemize_changes | 1;
1478 if (!log_format_has(stdout_format, 'b')
1479 && !log_format_has(stdout_format, 'c'))
1480 log_before_transfer = !am_server;
1481 } else if (itemize_changes) {
1482 stdout_format = "%i %n%L";
1483 stdout_format_has_i = itemize_changes;
1484 log_before_transfer = !am_server;
1487 if (do_progress && !verbose && !log_before_transfer && !am_server)
1488 verbose = 1;
1490 if (dry_run)
1491 do_xfers = 0;
1493 set_io_timeout(io_timeout);
1495 if (verbose && !stdout_format) {
1496 stdout_format = "%n%L";
1497 log_before_transfer = !am_server;
1499 if (stdout_format_has_i || log_format_has(stdout_format, 'o'))
1500 stdout_format_has_o_or_i = 1;
1502 if (logfile_name && !am_daemon) {
1503 if (!logfile_format) {
1504 logfile_format = "%i %n%L";
1505 logfile_format_has_i = logfile_format_has_o_or_i = 1;
1506 } else {
1507 if (log_format_has(logfile_format, 'i'))
1508 logfile_format_has_i = 1;
1509 if (logfile_format_has_i || log_format_has(logfile_format, 'o'))
1510 logfile_format_has_o_or_i = 1;
1512 log_init(0);
1513 } else if (!am_daemon)
1514 logfile_format = NULL;
1516 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
1517 bwlimit = daemon_bwlimit;
1518 if (bwlimit) {
1519 bwlimit_writemax = (size_t)bwlimit * 128;
1520 if (bwlimit_writemax < 512)
1521 bwlimit_writemax = 512;
1524 if (sparse_files && inplace) {
1525 /* Note: we don't check for this below, because --append is
1526 * OK with --sparse (as long as redos are handled right). */
1527 snprintf(err_buf, sizeof err_buf,
1528 "--sparse cannot be used with --inplace\n");
1529 return 0;
1532 if (append_mode) {
1533 if (whole_file > 0) {
1534 snprintf(err_buf, sizeof err_buf,
1535 "--append cannot be used with --whole-file\n");
1536 return 0;
1538 if (refused_inplace) {
1539 create_refuse_error(refused_inplace);
1540 return 0;
1542 inplace = 1;
1545 if (delay_updates && !partial_dir)
1546 partial_dir = tmp_partialdir;
1548 if (inplace) {
1549 #ifdef HAVE_FTRUNCATE
1550 if (partial_dir) {
1551 snprintf(err_buf, sizeof err_buf,
1552 "--%s cannot be used with --%s\n",
1553 append_mode ? "append" : "inplace",
1554 delay_updates ? "delay-updates" : "partial-dir");
1555 return 0;
1557 /* --inplace implies --partial for refusal purposes, but we
1558 * clear the keep_partial flag for internal logic purposes. */
1559 if (refused_partial) {
1560 create_refuse_error(refused_partial);
1561 return 0;
1563 keep_partial = 0;
1564 #else
1565 snprintf(err_buf, sizeof err_buf,
1566 "--%s is not supported on this %s\n",
1567 append_mode ? "append" : "inplace",
1568 am_server ? "server" : "client");
1569 return 0;
1570 #endif
1571 } else {
1572 if (keep_partial && !partial_dir && !am_server) {
1573 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
1574 partial_dir = strdup(arg);
1576 if (partial_dir) {
1577 if (*partial_dir)
1578 clean_fname(partial_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1579 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1580 partial_dir = NULL;
1581 if (!partial_dir && refused_partial) {
1582 create_refuse_error(refused_partial);
1583 return 0;
1585 keep_partial = 1;
1589 if (files_from) {
1590 char *h, *p;
1591 int q;
1592 if (argc > 2 || (!am_daemon && argc == 1)) {
1593 usage(FERROR);
1594 exit_cleanup(RERR_SYNTAX);
1596 if (strcmp(files_from, "-") == 0) {
1597 filesfrom_fd = 0;
1598 if (am_server)
1599 filesfrom_host = ""; /* reading from socket */
1600 } else if ((p = check_for_hostspec(files_from, &h, &q)) != 0) {
1601 if (am_server) {
1602 snprintf(err_buf, sizeof err_buf,
1603 "The --files-from sent to the server cannot specify a host.\n");
1604 return 0;
1606 files_from = p;
1607 filesfrom_host = h;
1608 if (strcmp(files_from, "-") == 0) {
1609 snprintf(err_buf, sizeof err_buf,
1610 "Invalid --files-from remote filename\n");
1611 return 0;
1613 } else {
1614 if (sanitize_paths)
1615 files_from = sanitize_path(NULL, files_from, NULL, 0);
1616 if (server_filter_list.head) {
1617 char *dir;
1618 if (!*files_from)
1619 goto options_rejected;
1620 dir = files_from + (*files_from == '/' ? module_dirlen : 0);
1621 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1622 if (check_filter(&server_filter_list, dir, 0) < 0)
1623 goto options_rejected;
1625 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1626 if (filesfrom_fd < 0) {
1627 snprintf(err_buf, sizeof err_buf,
1628 "failed to open files-from file %s: %s\n",
1629 files_from, strerror(errno));
1630 return 0;
1635 am_starting_up = 0;
1637 return 1;
1639 options_rejected:
1640 snprintf(err_buf, sizeof err_buf,
1641 "Your options have been rejected by the server.\n");
1642 return 0;
1647 * Construct a filtered list of options to pass through from the
1648 * client to the server.
1650 * This involves setting options that will tell the server how to
1651 * behave, and also filtering out options that are processed only
1652 * locally.
1654 void server_options(char **args, int *argc_p)
1656 static char argstr[64];
1657 int ac = *argc_p;
1658 char *arg;
1659 int i, x;
1661 /* This should always remain first on the server's command-line. */
1662 args[ac++] = "--server";
1664 if (daemon_over_rsh > 0) {
1665 args[ac++] = "--daemon";
1666 *argc_p = ac;
1667 /* if we're passing --daemon, we're done */
1668 return;
1671 if (!am_sender)
1672 args[ac++] = "--sender";
1674 x = 1;
1675 argstr[0] = '-';
1677 if (protect_args)
1678 argstr[x++] = 's';
1680 for (i = 0; i < verbose; i++)
1681 argstr[x++] = 'v';
1683 /* the -q option is intentionally left out */
1684 if (make_backups)
1685 argstr[x++] = 'b';
1686 if (update_only)
1687 argstr[x++] = 'u';
1688 if (!do_xfers) /* Note: NOT "dry_run"! */
1689 argstr[x++] = 'n';
1690 if (preserve_links)
1691 argstr[x++] = 'l';
1692 if ((list_only && !recurse) || xfer_dirs > 1
1693 || (xfer_dirs && !recurse && delete_mode && am_sender))
1694 argstr[x++] = 'd';
1695 if (am_sender) {
1696 if (keep_dirlinks)
1697 argstr[x++] = 'K';
1698 if (prune_empty_dirs)
1699 argstr[x++] = 'm';
1700 if (omit_dir_times)
1701 argstr[x++] = 'O';
1702 } else {
1703 if (copy_links)
1704 argstr[x++] = 'L';
1705 if (copy_dirlinks)
1706 argstr[x++] = 'k';
1709 if (whole_file > 0)
1710 argstr[x++] = 'W';
1711 /* We don't need to send --no-whole-file, because it's the
1712 * default for remote transfers, and in any case old versions
1713 * of rsync will not understand it. */
1715 if (preserve_hard_links) {
1716 argstr[x++] = 'H';
1717 if (preserve_hard_links > 1)
1718 argstr[x++] = 'H';
1720 if (preserve_uid)
1721 argstr[x++] = 'o';
1722 if (preserve_gid)
1723 argstr[x++] = 'g';
1724 if (preserve_devices) /* ignore preserve_specials here */
1725 argstr[x++] = 'D';
1726 if (preserve_times)
1727 argstr[x++] = 't';
1728 if (preserve_perms)
1729 argstr[x++] = 'p';
1730 else if (preserve_executability && am_sender)
1731 argstr[x++] = 'E';
1732 #ifdef SUPPORT_ACLS
1733 if (preserve_acls)
1734 argstr[x++] = 'A';
1735 #endif
1736 #ifdef SUPPORT_XATTRS
1737 if (preserve_xattrs) {
1738 argstr[x++] = 'X';
1739 if (preserve_xattrs > 1)
1740 argstr[x++] = 'X';
1742 #endif
1743 if (recurse)
1744 argstr[x++] = 'r';
1745 if (always_checksum)
1746 argstr[x++] = 'c';
1747 if (cvs_exclude)
1748 argstr[x++] = 'C';
1749 if (ignore_times)
1750 argstr[x++] = 'I';
1751 if (relative_paths)
1752 argstr[x++] = 'R';
1753 if (one_file_system) {
1754 argstr[x++] = 'x';
1755 if (one_file_system > 1)
1756 argstr[x++] = 'x';
1758 if (sparse_files)
1759 argstr[x++] = 'S';
1760 if (do_compression)
1761 argstr[x++] = 'z';
1763 /* We make use of the -e option to let the server know about any
1764 * pre-release protocol version && our allow_inc_recurse status. */
1765 set_allow_inc_recurse();
1766 #if SUBPROTOCOL_VERSION != 0
1767 if (protocol_version == PROTOCOL_VERSION) {
1768 x += snprintf(argstr+x, sizeof argstr - x,
1769 "e%d.%d%s", PROTOCOL_VERSION, SUBPROTOCOL_VERSION,
1770 allow_inc_recurse ? "i" : "");
1771 } else
1772 #endif
1773 if (allow_inc_recurse) {
1774 argstr[x++] = 'e';
1775 argstr[x++] = 'i';
1778 argstr[x] = '\0';
1780 if (x != 1)
1781 args[ac++] = argstr;
1783 #ifdef ICONV_OPTION
1784 if (iconv_opt) {
1785 char *set = strchr(iconv_opt, ',');
1786 if (set)
1787 set++;
1788 else
1789 set = iconv_opt;
1790 if (asprintf(&arg, "--iconv=%s", set) < 0)
1791 goto oom;
1792 args[ac++] = arg;
1794 #endif
1796 if (protect_args) /* initial args break here */
1797 args[ac++] = NULL;
1799 if (list_only > 1)
1800 args[ac++] = "--list-only";
1802 /* This makes sure that the remote rsync can handle deleting with -d
1803 * sans -r because the --no-r option was added at the same time. */
1804 if (xfer_dirs && !recurse && delete_mode && am_sender)
1805 args[ac++] = "--no-r";
1807 if (do_compression && def_compress_level != Z_DEFAULT_COMPRESSION) {
1808 if (asprintf(&arg, "--compress-level=%d", def_compress_level) < 0)
1809 goto oom;
1810 args[ac++] = arg;
1813 if (preserve_devices) {
1814 /* Note: sending "--devices" would not be backward-compatible. */
1815 if (!preserve_specials)
1816 args[ac++] = "--no-specials"; /* -D is already set. */
1817 } else if (preserve_specials)
1818 args[ac++] = "--specials";
1820 /* The server side doesn't use our log-format, but in certain
1821 * circumstances they need to know a little about the option. */
1822 if (stdout_format && am_sender) {
1823 /* Use --log-format, not --out-format, for compatibility. */
1824 if (stdout_format_has_i > 1)
1825 args[ac++] = "--log-format=%i%I";
1826 else if (stdout_format_has_i)
1827 args[ac++] = "--log-format=%i";
1828 else if (stdout_format_has_o_or_i)
1829 args[ac++] = "--log-format=%o";
1830 else if (!verbose)
1831 args[ac++] = "--log-format=X";
1834 if (block_size) {
1835 if (asprintf(&arg, "-B%lu", block_size) < 0)
1836 goto oom;
1837 args[ac++] = arg;
1840 if (io_timeout) {
1841 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1842 goto oom;
1843 args[ac++] = arg;
1846 if (bwlimit) {
1847 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1848 goto oom;
1849 args[ac++] = arg;
1852 if (backup_dir) {
1853 args[ac++] = "--backup-dir";
1854 args[ac++] = backup_dir;
1857 /* Only send --suffix if it specifies a non-default value. */
1858 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
1859 /* We use the following syntax to avoid weirdness with '~'. */
1860 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1861 goto oom;
1862 args[ac++] = arg;
1865 if (am_sender) {
1866 if (max_delete > 0) {
1867 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1868 goto oom;
1869 args[ac++] = arg;
1870 } else if (max_delete == 0)
1871 args[ac++] = "--max-delete=-1";
1872 if (min_size) {
1873 args[ac++] = "--min-size";
1874 args[ac++] = min_size_arg;
1876 if (max_size) {
1877 args[ac++] = "--max-size";
1878 args[ac++] = max_size_arg;
1880 if (delete_before)
1881 args[ac++] = "--delete-before";
1882 else if (delete_during == 2)
1883 args[ac++] = "--delete-delay";
1884 else if (delete_during)
1885 args[ac++] = "--delete-during";
1886 else if (delete_after)
1887 args[ac++] = "--delete-after";
1888 else if (delete_mode && !delete_excluded)
1889 args[ac++] = "--delete";
1890 if (delete_excluded)
1891 args[ac++] = "--delete-excluded";
1892 if (force_delete)
1893 args[ac++] = "--force";
1894 if (write_batch < 0)
1895 args[ac++] = "--only-write-batch=X";
1896 if (am_root > 1)
1897 args[ac++] = "--super";
1898 if (size_only)
1899 args[ac++] = "--size-only";
1900 } else {
1901 if (skip_compress) {
1902 if (asprintf(&arg, "--skip-compress=%s", skip_compress) < 0)
1903 goto oom;
1904 args[ac++] = arg;
1908 if (modify_window_set) {
1909 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1910 goto oom;
1911 args[ac++] = arg;
1914 if (checksum_seed) {
1915 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
1916 goto oom;
1917 args[ac++] = arg;
1920 if (partial_dir && am_sender) {
1921 if (partial_dir != tmp_partialdir) {
1922 args[ac++] = "--partial-dir";
1923 args[ac++] = partial_dir;
1925 if (delay_updates)
1926 args[ac++] = "--delay-updates";
1927 } else if (keep_partial && am_sender)
1928 args[ac++] = "--partial";
1930 if (ignore_errors)
1931 args[ac++] = "--ignore-errors";
1933 if (copy_unsafe_links)
1934 args[ac++] = "--copy-unsafe-links";
1936 if (safe_symlinks)
1937 args[ac++] = "--safe-links";
1939 if (numeric_ids)
1940 args[ac++] = "--numeric-ids";
1942 if (use_qsort)
1943 args[ac++] = "--use-qsort";
1945 if (am_sender) {
1946 if (ignore_existing)
1947 args[ac++] = "--ignore-existing";
1949 /* Backward compatibility: send --existing, not --ignore-non-existing. */
1950 if (ignore_non_existing)
1951 args[ac++] = "--existing";
1953 if (tmpdir) {
1954 args[ac++] = "--temp-dir";
1955 args[ac++] = tmpdir;
1958 if (basis_dir[0]) {
1959 /* the server only needs this option if it is not the sender,
1960 * and it may be an older version that doesn't know this
1961 * option, so don't send it if client is the sender.
1963 int i;
1964 for (i = 0; i < basis_dir_cnt; i++) {
1965 args[ac++] = dest_option;
1966 args[ac++] = basis_dir[i];
1971 if (append_mode) {
1972 if (append_mode > 1)
1973 args[ac++] = "--append";
1974 args[ac++] = "--append";
1975 } else if (inplace)
1976 args[ac++] = "--inplace";
1978 if (files_from && (!am_sender || filesfrom_host)) {
1979 if (filesfrom_host) {
1980 args[ac++] = "--files-from";
1981 args[ac++] = files_from;
1982 if (eol_nulls)
1983 args[ac++] = "--from0";
1984 } else {
1985 args[ac++] = "--files-from=-";
1986 args[ac++] = "--from0";
1988 if (!relative_paths)
1989 args[ac++] = "--no-relative";
1991 /* It's OK that this checks the upper-bound of the protocol_version. */
1992 if (relative_paths && !implied_dirs && (!am_sender || protocol_version >= 30))
1993 args[ac++] = "--no-implied-dirs";
1995 if (fuzzy_basis && am_sender)
1996 args[ac++] = "--fuzzy";
1998 if (remove_source_files == 1)
1999 args[ac++] = "--remove-source-files";
2000 else if (remove_source_files)
2001 args[ac++] = "--remove-sent-files";
2003 *argc_p = ac;
2004 return;
2006 oom:
2007 out_of_memory("server_options");
2010 /* Look for a HOST specfication of the form "HOST:PATH", "HOST::PATH", or
2011 * "rsync://HOST:PORT/PATH". If found, *host_ptr will be set to some allocated
2012 * memory with the HOST. If a daemon-accessing spec was specified, the value
2013 * of *port_ptr will contain a non-0 port number, otherwise it will be set to
2014 * 0. The return value is a pointer to the PATH. Note that the HOST spec can
2015 * be an IPv6 literal address enclosed in '[' and ']' (such as "[::1]" or
2016 * "[::ffff:127.0.0.1]") which is returned without the '[' and ']'. */
2017 char *check_for_hostspec(char *s, char **host_ptr, int *port_ptr)
2019 char *p;
2020 int not_host;
2021 int hostlen;
2023 if (port_ptr && strncasecmp(URL_PREFIX, s, strlen(URL_PREFIX)) == 0) {
2024 char *path;
2025 s += strlen(URL_PREFIX);
2026 if ((p = strchr(s, '/')) != NULL) {
2027 hostlen = p - s;
2028 path = p + 1;
2029 } else {
2030 hostlen = strlen(s);
2031 path = "";
2033 if (*s == '[' && (p = strchr(s, ']')) != NULL) {
2034 s++;
2035 hostlen = p - s;
2036 if (p[1] == ':')
2037 *port_ptr = atoi(p+2);
2038 } else {
2039 if ((p = strchr(s, ':')) != NULL && p < s + hostlen) {
2040 hostlen = p - s;
2041 *port_ptr = atoi(p+1);
2044 if (!*port_ptr)
2045 *port_ptr = RSYNC_PORT;
2046 *host_ptr = new_array(char, hostlen + 1);
2047 strlcpy(*host_ptr, s, hostlen + 1);
2048 return path;
2051 if (*s == '[' && (p = strchr(s, ']')) != NULL && p[1] == ':') {
2052 s++;
2053 hostlen = p - s;
2054 *p = '\0';
2055 not_host = strchr(s, '/') || !strchr(s, ':');
2056 *p = ']';
2057 if (not_host)
2058 return NULL;
2059 p++;
2060 } else {
2061 if (!(p = strchr(s, ':')))
2062 return NULL;
2063 hostlen = p - s;
2064 *p = '\0';
2065 not_host = strchr(s, '/') != NULL;
2066 *p = ':';
2067 if (not_host)
2068 return NULL;
2071 *host_ptr = new_array(char, hostlen + 1);
2072 strlcpy(*host_ptr, s, hostlen + 1);
2074 if (p[1] == ':') {
2075 if (port_ptr && !*port_ptr)
2076 *port_ptr = RSYNC_PORT;
2077 return p + 2;
2079 if (port_ptr)
2080 *port_ptr = 0;
2082 return p + 1;