- Output the new flist time stats (when available).
[rsync/rsync.git] / options.c
CommitLineData
7a24c346 1/* -*- c-file-style: "linux" -*-
dfa32483 2 *
dafe63ca
MP
3 * Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
4 * Copyright (C) 2000, 2001, 2002 by Martin Pool <mbp@samba.org>
dfa32483 5 *
dafe63ca
MP
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
dfa32483 10 *
dafe63ca
MP
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
dfa32483 15 *
dafe63ca
MP
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
7a6421fa 20
7a6421fa 21#include "rsync.h"
2855f61f 22#include "popt.h"
7a6421fa 23
7be73df4 24extern int sanitize_paths;
99218d82 25extern int select_timeout;
7842418b
WD
26extern struct filter_list_struct filter_list;
27extern struct filter_list_struct server_filter_list;
8645af1d 28
7a6421fa 29int make_backups = 0;
1bfbf40b
MP
30
31/**
dfa32483 32 * If 1, send the whole file as literal data rather than trying to
dafe63ca 33 * create an incremental diff.
1bfbf40b 34 *
dfa32483 35 * If -1, then look at whether we're local or remote and go by that.
dafe63ca
MP
36 *
37 * @sa disable_deltas_p()
1bfbf40b 38 **/
dfa32483 39int whole_file = -1;
1bfbf40b 40
dfa32483 41int archive_mode = 0;
716e73d4 42int keep_dirlinks = 0;
7a6421fa
AT
43int copy_links = 0;
44int preserve_links = 0;
45int preserve_hard_links = 0;
46int preserve_perms = 0;
47int preserve_devices = 0;
48int preserve_uid = 0;
49int preserve_gid = 0;
50int preserve_times = 0;
20fb7b91 51int omit_dir_times = 0;
7a6421fa
AT
52int update_only = 0;
53int cvs_exclude = 0;
a5c11139
WD
54int dry_run = 0;
55int local_server = 0;
56int ignore_times = 0;
57int delete_mode = 0;
a51b3168 58int delete_during = 0;
51d48398
WD
59int delete_before = 0;
60int delete_after = 0;
a5c11139
WD
61int delete_excluded = 0;
62int one_file_system = 0;
4f3e9a0f 63int protocol_version = PROTOCOL_VERSION;
a5c11139
WD
64int sparse_files = 0;
65int do_compression = 0;
66int am_root = 0;
67int orig_umask = 0;
ea5164d1
WD
68int relative_paths = -1;
69int implied_dirs = 1;
7a6421fa
AT
70int numeric_ids = 0;
71int force_delete = 0;
72int io_timeout = 0;
7a6421fa
AT
73int read_only = 0;
74int module_id = -1;
75int am_server = 0;
30ce7e8a 76int am_sender = 0;
4337c8f8 77int am_generator = 0;
ea5164d1
WD
78char *files_from = NULL;
79int filesfrom_fd = -1;
80char *remote_filesfrom_file = NULL;
81int eol_nulls = 0;
7a6421fa 82int recurse = 0;
65e4cda0 83int xfer_dirs = 0;
1312d9fc
WD
84int am_daemon = 0;
85int daemon_over_rsh = 0;
a5c11139
WD
86int do_stats = 0;
87int do_progress = 0;
88int keep_partial = 0;
89int safe_symlinks = 0;
90int copy_unsafe_links = 0;
91int size_only = 0;
9fb08441 92int daemon_bwlimit = 0;
a5c11139 93int bwlimit = 0;
3c74c3a3 94size_t bwlimit_writemax = 0;
a5c11139
WD
95int only_existing = 0;
96int opt_ignore_existing = 0;
97int max_delete = 0;
7d5acf1d 98OFF_T max_size = 0;
a5c11139
WD
99int ignore_errors = 0;
100int modify_window = 0;
101int blocking_io = -1;
2289bf64 102int checksum_seed = 0;
a3221d2a 103int inplace = 0;
a06b419d 104long block_size = 0; /* "long" because popt can't set an int32. */
7a6421fa 105
b35d0d8e 106
13e29995 107/** Network address family. **/
6ab6d4bf 108#ifdef INET6
13e29995 109int default_af_hint = 0; /* Any protocol */
6ab6d4bf 110#else
13e29995 111int default_af_hint = AF_INET; /* Must use IPv4 */
6ab6d4bf 112#endif
06963d0f 113
13e29995
MP
114/** Do not go into the background when run as --daemon. Good
115 * for debugging and required for running as a service on W32,
116 * or under Unix process-monitors. **/
117int no_detach = 0;
118
088aac85
DD
119int write_batch = 0;
120int read_batch = 0;
d175d7e1
WD
121int backup_dir_len = 0;
122int backup_suffix_len;
e0391f81 123unsigned int backup_dir_remainder;
6902ed17 124
d175d7e1 125char *backup_suffix = NULL;
7a6421fa 126char *tmpdir = NULL;
a7260c40 127char *partial_dir = NULL;
e012f858 128char *basis_dir[MAX_BASIS_DIRS+1];
30e8c8e1 129char *config_file = NULL;
7a6421fa 130char *shell_cmd = NULL;
b6062654 131char *log_format = NULL;
65575e96 132char *password_file = NULL;
41bd28fe 133char *rsync_path = RSYNC_PATH;
66203a98 134char *backup_dir = NULL;
e0391f81 135char backup_dir_buf[MAXPATHLEN];
0c56b1ad 136int rsync_port = 0;
dfd7d541 137int compare_dest = 0;
e012f858 138int copy_dest = 0;
59c95e42 139int link_dest = 0;
ce0b384f 140int basis_dir_cnt = 0;
7a6421fa
AT
141
142int verbose = 0;
b86f0cef 143int quiet = 0;
7a6421fa 144int always_checksum = 0;
f7632fc6 145int list_only = 0;
7a6421fa 146
9b3318b0
WD
147#define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
148char *batch_name = NULL;
6902ed17 149
e1add893 150static int daemon_opt; /* sets am_daemon after option error-reporting */
aa4d3b4c 151static int F_option_cnt = 0;
5b56cc19 152static int modify_window_set;
12a79db2 153static char *dest_option = NULL;
7d5acf1d 154static char *max_size_arg;
5b56cc19 155
06963d0f 156/** Local address to bind. As a character string because it's
fdf57ede 157 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
06963d0f
MP
158 * address, or a hostname. **/
159char *bind_address;
5c9730a4 160
7a24c346 161
27a12348 162static void print_rsync_version(enum logcode f)
7a24c346 163{
dfa32483 164 char const *got_socketpair = "no ";
a3221d2a 165 char const *have_inplace = "no ";
dfa32483
WD
166 char const *hardlinks = "no ";
167 char const *links = "no ";
a358449a 168 char const *ipv6 = "no ";
736a6a29 169 STRUCT_STAT *dumstat;
0c80cd8e
MP
170
171#ifdef HAVE_SOCKETPAIR
dfa32483 172 got_socketpair = "";
0c80cd8e 173#endif
2855f61f 174
a3221d2a
WD
175#if HAVE_FTRUNCATE
176 have_inplace = "";
177#endif
178
2855f61f 179#if SUPPORT_HARD_LINKS
dfa32483 180 hardlinks = "";
2855f61f
MP
181#endif
182
183#if SUPPORT_LINKS
dfa32483 184 links = "";
2855f61f
MP
185#endif
186
a358449a
MP
187#if INET6
188 ipv6 = "";
dfa32483 189#endif
a358449a 190
dfa32483
WD
191 rprintf(f, "%s version %s protocol version %d\n",
192 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION);
193 rprintf(f,
72a90c75 194 "Copyright (C) 1996-2005 by Andrew Tridgell and others\n");
3b4b1984 195 rprintf(f, "<http://rsync.samba.org/>\n");
dfa32483
WD
196 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
197 "%shard links, %ssymlinks, batchfiles, \n",
a5c11139 198 (int) (sizeof (OFF_T) * 8),
dfa32483 199 got_socketpair, hardlinks, links);
2855f61f 200
736a6a29
MP
201 /* Note that this field may not have type ino_t. It depends
202 * on the complicated interaction between largefile feature
203 * macros. */
a3221d2a
WD
204 rprintf(f, " %sinplace, %sIPv6, %d-bit system inums, %d-bit internal inums\n",
205 have_inplace, ipv6,
a5c11139 206 (int) (sizeof dumstat->st_ino * 8),
1490812a 207 (int) (sizeof (int64) * 8));
fc0302cf
MP
208#ifdef MAINTAINER_MODE
209 rprintf(f, " panic action: \"%s\"\n",
210 get_panic_action());
211#endif
736a6a29 212
28deecca
WD
213#ifdef INT64_IS_OFF_T
214 if (sizeof (int64) < 8)
215 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
7a24c346 216#endif
7b329a2d
MP
217
218 rprintf(f,
219"\n"
220"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n"
221"are welcome to redistribute it under certain conditions. See the GNU\n"
222"General Public Licence for details.\n"
223 );
7a24c346
MP
224}
225
226
0f3203c3 227void usage(enum logcode F)
7a6421fa 228{
2855f61f 229 print_rsync_version(F);
704f908e 230
3ff984d7 231 rprintf(F,"\nrsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n");
704f908e 232
9ef53907 233 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
704f908e 234 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n");
9ef53907 235 rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n");
14d43f1f 236 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
9ef53907 237 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
14d43f1f 238 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
eaa4c150 239 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
9ef53907
DD
240 rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n");
241 rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n");
242 rprintf(F," sources separated by space as long as they have same top-level\n");
704f908e
AT
243 rprintf(F,"\nOptions\n");
244 rprintf(F," -v, --verbose increase verbosity\n");
b86f0cef 245 rprintf(F," -q, --quiet decrease verbosity\n");
704f908e 246 rprintf(F," -c, --checksum always checksum\n");
64444de5 247 rprintf(F," -a, --archive archive mode, equivalent to -rlptgoD (no -H)\n");
704f908e
AT
248 rprintf(F," -r, --recursive recurse into directories\n");
249 rprintf(F," -R, --relative use relative path names\n");
ea5164d1
WD
250 rprintf(F," --no-relative turn off --relative\n");
251 rprintf(F," --no-implied-dirs don't send implied dirs with -R\n");
6839140e 252 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
e20c5e95 253 rprintf(F," --backup-dir make backups into this directory\n");
6839140e 254 rprintf(F," --suffix=SUFFIX backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
704f908e 255 rprintf(F," -u, --update update only (don't overwrite newer files)\n");
4ce838e1 256 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
65e4cda0 257 rprintf(F," -d, --dirs transfer directories without recursing\n");
13e29995 258 rprintf(F," -l, --links copy symlinks as symlinks\n");
06d76beb
WD
259 rprintf(F," -L, --copy-links copy the referent of all symlinks\n");
260 rprintf(F," --copy-unsafe-links copy the referent of \"unsafe\" symlinks\n");
261 rprintf(F," --safe-links ignore \"unsafe\" symlinks\n");
704f908e 262 rprintf(F," -H, --hard-links preserve hard links\n");
65e4cda0 263 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
704f908e
AT
264 rprintf(F," -p, --perms preserve permissions\n");
265 rprintf(F," -o, --owner preserve owner (root only)\n");
266 rprintf(F," -g, --group preserve group\n");
267 rprintf(F," -D, --devices preserve devices (root only)\n");
dfa32483 268 rprintf(F," -t, --times preserve times\n");
20fb7b91 269 rprintf(F," -O, --omit-dir-times omit directories when preserving times\n");
704f908e
AT
270 rprintf(F," -S, --sparse handle sparse files efficiently\n");
271 rprintf(F," -n, --dry-run show what would have been transferred\n");
272 rprintf(F," -W, --whole-file copy whole files, no incremental checks\n");
93689aa5 273 rprintf(F," --no-whole-file turn off --whole-file\n");
704f908e 274 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
9cd339eb 275 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
54170a08 276 rprintf(F," -e, --rsh=COMMAND specify the remote shell\n");
704f908e 277 rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n");
1347d512 278 rprintf(F," --existing only update files that already exist\n");
6839140e 279 rprintf(F," --ignore-existing ignore files that already exist on receiving side\n");
3359acb8 280 rprintf(F," --del an alias for --delete-during\n");
704f908e 281 rprintf(F," --delete delete files that don't exist on the sending side\n");
3359acb8
WD
282 rprintf(F," --delete-during receiver deletes during transfer, not before\n");
283 rprintf(F," --delete-after receiver deletes after transfer, not before\n");
51d48398 284 rprintf(F," --delete-excluded also delete excluded files on the receiving side\n");
db2b5cb7 285 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
51d48398 286 rprintf(F," --force force deletion of directories even if not empty\n");
0b73ca12 287 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
7d5acf1d 288 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
c95da96a 289 rprintf(F," --partial keep partially transferred files\n");
a7260c40 290 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
704f908e 291 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
db2b5cb7 292 rprintf(F," --timeout=TIME set I/O timeout in seconds\n");
6839140e
WD
293 rprintf(F," -I, --ignore-times turn off mod time & file size quick check\n");
294 rprintf(F," --size-only ignore mod time for quick check (use size)\n");
295 rprintf(F," --modify-window=NUM compare mod times with reduced accuracy\n");
4db88e5b 296 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
375a4556 297 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
e012f858
WD
298 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
299 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
d9fcc198 300 rprintf(F," -P equivalent to --partial --progress\n");
704f908e 301 rprintf(F," -z, --compress compress file data\n");
ea5164d1 302 rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n");
aa4d3b4c
WD
303 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
304 rprintf(F," -F same as --filter=': /.rsync-filter'\n");
305 rprintf(F," repeated: --filter='- .rsync-filter'\n");
2acf81eb 306 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
858fb9eb 307 rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n");
2acf81eb 308 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
858fb9eb 309 rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n");
ea5164d1 310 rprintf(F," --files-from=FILE read FILE for list of source-file names\n");
4db88e5b 311 rprintf(F," -0, --from0 all *-from file lists are delimited by nulls\n");
dfa32483 312 rprintf(F," --version print version number\n");
b4713295 313 rprintf(F," --port=PORT specify double-colon alternate port number\n");
db2b5cb7 314 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
dfa32483
WD
315 rprintf(F," --no-blocking-io turn off --blocking-io\n");
316 rprintf(F," --stats give some file transfer stats\n");
317 rprintf(F," --progress show progress during transfer\n");
318 rprintf(F," --log-format=FORMAT log file transfers using specified format\n");
65575e96 319 rprintf(F," --password-file=FILE get password from FILE\n");
65e4cda0 320 rprintf(F," --list-only list the files instead of copying them\n");
ef5d23eb 321 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
9b3318b0
WD
322 rprintf(F," --write-batch=FILE write a batch to FILE\n");
323 rprintf(F," --read-batch=FILE read a batch from FILE\n");
06963d0f 324#ifdef INET6
4db88e5b
WD
325 rprintf(F," -4, --ipv4 prefer IPv4\n");
326 rprintf(F," -6, --ipv6 prefer IPv6\n");
06963d0f 327#endif
3dd22903 328 rprintf(F," -h, --help show this help screen\n");
7a6421fa 329
3ac7f5d4
WD
330 rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
331 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
2855f61f 332 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
7a6421fa
AT
333}
334
3ac7f5d4 335enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
aa4d3b4c 336 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST,
1f3d6cdd 337 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW,
7d5acf1d 338 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_TIMEOUT, OPT_MAX_SIZE,
c67d1386 339 OPT_REFUSED_BASE = 9000};
7a6421fa 340
2855f61f
MP
341static struct poptOption long_options[] = {
342 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
8db7cc2c 343 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
d175d7e1 344 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
3dd22903
WD
345 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
346 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
afb6e945
WD
347 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
348 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
8b54f004 349 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
afb6e945 350 {"one-file-system", 'x', POPT_ARG_NONE, &one_file_system, 0, 0, 0 },
afb6e945
WD
351 {"existing", 0, POPT_ARG_NONE, &only_existing, 0, 0, 0 },
352 {"ignore-existing", 0, POPT_ARG_NONE, &opt_ignore_existing, 0, 0, 0 },
3359acb8
WD
353 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
354 {"delete-during", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
51d48398
WD
355 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
356 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
afb6e945
WD
357 {"force", 0, POPT_ARG_NONE, &force_delete, 0, 0, 0 },
358 {"numeric-ids", 0, POPT_ARG_NONE, &numeric_ids, 0, 0, 0 },
aa4d3b4c 359 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
8db7cc2c
WD
360 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
361 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
362 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
363 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
afb6e945 364 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
8db7cc2c 365 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
afb6e945
WD
366 {"backup", 'b', POPT_ARG_NONE, &make_backups, 0, 0, 0 },
367 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
368 {"sparse", 'S', POPT_ARG_NONE, &sparse_files, 0, 0, 0 },
369 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
370 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
a3221d2a 371 {"inplace", 0, POPT_ARG_NONE, &inplace, 0, 0, 0 },
65e4cda0 372 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
afb6e945
WD
373 {"links", 'l', POPT_ARG_NONE, &preserve_links, 0, 0, 0 },
374 {"copy-links", 'L', POPT_ARG_NONE, &copy_links, 0, 0, 0 },
65e4cda0 375 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
afb6e945
WD
376 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
377 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
378 {"copy-unsafe-links", 0, POPT_ARG_NONE, &copy_unsafe_links, 0, 0, 0 },
379 {"perms", 'p', POPT_ARG_NONE, &preserve_perms, 0, 0, 0 },
380 {"owner", 'o', POPT_ARG_NONE, &preserve_uid, 0, 0, 0 },
381 {"group", 'g', POPT_ARG_NONE, &preserve_gid, 0, 0, 0 },
382 {"devices", 'D', POPT_ARG_NONE, &preserve_devices, 0, 0, 0 },
383 {"times", 't', POPT_ARG_NONE, &preserve_times, 0, 0, 0 },
20fb7b91 384 {"omit-dir-times", 'O', POPT_ARG_NONE, &omit_dir_times, 0, 0, 0 },
afb6e945 385 {"checksum", 'c', POPT_ARG_NONE, &always_checksum, 0, 0, 0 },
8db7cc2c
WD
386 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
387 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
dfa32483 388 {"archive", 'a', POPT_ARG_NONE, &archive_mode, 0, 0, 0 },
afb6e945 389 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
8db7cc2c 390 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
51d48398
WD
391 {"recursive", 'r', POPT_ARG_VAL, &recurse, -1, 0, 0 },
392 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
ea5164d1
WD
393 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
394 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
afb6e945 395 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
a06b419d 396 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
afb6e945 397 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
7d5acf1d 398 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
99218d82 399 {"timeout", 0, POPT_ARG_INT, &io_timeout, OPT_TIMEOUT, 0, 0 },
afb6e945 400 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
e012f858
WD
401 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
402 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
403 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
2855f61f 404 /* TODO: Should this take an optional int giving the compression level? */
afb6e945 405 {"compress", 'z', POPT_ARG_NONE, &do_compression, 0, 0, 0 },
afb6e945
WD
406 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
407 {"progress", 0, POPT_ARG_NONE, &do_progress, 0, 0, 0 },
408 {"partial", 0, POPT_ARG_NONE, &keep_partial, 0, 0, 0 },
a7260c40 409 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
afb6e945
WD
410 {"ignore-errors", 0, POPT_ARG_NONE, &ignore_errors, 0, 0, 0 },
411 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
412 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
aa4d3b4c 413 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
8db7cc2c 414 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
b4713295 415 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
afb6e945
WD
416 {"log-format", 0, POPT_ARG_STRING, &log_format, 0, 0, 0 },
417 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
afb6e945
WD
418 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
419 {"hard-links", 'H', POPT_ARG_NONE, &preserve_hard_links, 0, 0, 0 },
8db7cc2c
WD
420 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
421 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
ea5164d1
WD
422 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
423 {"from0", '0', POPT_ARG_NONE, &eol_nulls, 0, 0, 0},
424 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
4f3e9a0f 425 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
c8d895de 426 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
06963d0f 427#ifdef INET6
3dd22903
WD
428 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
429 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
06963d0f 430#endif
3ac7f5d4
WD
431 /* All these options switch us into daemon-mode option-parsing. */
432 {"address", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
433 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
434 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
435 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
3ac7f5d4
WD
436 {0,0,0,0, 0, 0, 0}
437};
438
439static void daemon_usage(enum logcode F)
440{
441 print_rsync_version(F);
442
443 rprintf(F,"\nUsage: rsync --daemon [OPTION]...\n");
444 rprintf(F," --address=ADDRESS bind to the specified address\n");
9fb08441 445 rprintf(F," --bwlimit=KBPS limit I/O bandwidth, KBytes per second\n");
3ac7f5d4
WD
446 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
447 rprintf(F," --no-detach do not detach from the parent\n");
448 rprintf(F," --port=PORT specify alternate rsyncd port number\n");
449#ifdef INET6
450 rprintf(F," -4, --ipv4 prefer IPv4\n");
451 rprintf(F," -6, --ipv6 prefer IPv6\n");
452#endif
453 rprintf(F," -h, --help show this help screen\n");
454
455 rprintf(F,"\nIf you were not trying to invoke rsync as a daemon, avoid using any of the\n");
456 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
457}
458
459static struct poptOption long_daemon_options[] = {
460 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
461 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
9fb08441 462 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
3ac7f5d4
WD
463 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
464 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
465#ifdef INET6
466 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
467 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
468#endif
469 {"no-detach", 0, POPT_ARG_NONE, &no_detach, 0, 0, 0 },
470 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
471 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
472 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
473 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
ad715008 474 {0,0,0,0, 0, 0, 0}
2855f61f 475};
7a6421fa 476
06963d0f 477
e51094b7 478static char err_buf[200];
cd8185f2 479
2855f61f 480
dafe63ca
MP
481/**
482 * Store the option error message, if any, so that we can log the
483 * connection attempt (which requires parsing the options), and then
484 * show the error later on.
485 **/
cd8185f2
AT
486void option_error(void)
487{
e51094b7
WD
488 if (!err_buf[0]) {
489 strcpy(err_buf, "Error parsing options: "
490 "option may be supported on client but not on server?\n");
cd8185f2 491 }
e51094b7 492
e51094b7 493 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
cd8185f2
AT
494}
495
dafe63ca
MP
496
497/**
27ed20f7
WD
498 * Tweak the option table to disable all options that the rsyncd.conf
499 * file has told us to refuse.
dafe63ca 500 **/
27ed20f7 501static void set_refuse_options(char *bp)
cd8185f2 502{
27ed20f7 503 struct poptOption *op;
093e816c 504 char *cp, shortname[2];
d73e7f6e 505 int is_wild, found_match;
093e816c
WD
506
507 shortname[1] = '\0';
27ed20f7
WD
508
509 while (1) {
06a50542
WD
510 while (*bp == ' ') bp++;
511 if (!*bp)
512 break;
27ed20f7
WD
513 if ((cp = strchr(bp, ' ')) != NULL)
514 *cp= '\0';
06a50542
WD
515 /* If they specify "delete", reject all delete options. */
516 if (strcmp(bp, "delete") == 0)
517 bp = "delete*";
093e816c 518 is_wild = strpbrk(bp, "*?[") != NULL;
d73e7f6e 519 found_match = 0;
55afbb52 520 for (op = long_options; ; op++) {
093e816c 521 *shortname = op->shortName;
d73e7f6e
WD
522 if (!op->longName && !*shortname)
523 break;
524 if ((op->longName && wildmatch(bp, op->longName))
525 || (*shortname && wildmatch(bp, shortname))) {
e57211c5
WD
526 if (op->argInfo == POPT_ARG_VAL)
527 op->argInfo = POPT_ARG_NONE;
06a50542 528 op->val = (op - long_options) + OPT_REFUSED_BASE;
d73e7f6e 529 found_match = 1;
06a50542
WD
530 if (!is_wild)
531 break;
27ed20f7 532 }
cd8185f2 533 }
d73e7f6e
WD
534 if (!found_match) {
535 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
536 bp);
537 }
27ed20f7
WD
538 if (!cp)
539 break;
540 *cp = ' ';
541 bp = cp + 1;
cd8185f2 542 }
cd8185f2
AT
543}
544
545
8db7cc2c 546static int count_args(const char **argv)
2855f61f 547{
dfa32483 548 int i = 0;
2855f61f 549
8db7cc2c
WD
550 if (argv) {
551 while (argv[i] != NULL)
552 i++;
553 }
dfa32483
WD
554
555 return i;
2855f61f
MP
556}
557
558
dafe63ca
MP
559/**
560 * Process command line arguments. Called on both local and remote.
561 *
562 * @retval 1 if all options are OK; with globals set to appropriate
563 * values
564 *
565 * @retval 0 on error, with err_buf containing an explanation
566 **/
2855f61f 567int parse_arguments(int *argc, const char ***argv, int frommain)
7a6421fa 568{
d853783f 569 int opt;
cd8185f2 570 char *ref = lp_refuse_options(module_id);
7be73df4 571 const char *arg;
dfa32483 572 poptContext pc;
d853783f 573
27ed20f7
WD
574 if (ref && *ref)
575 set_refuse_options(ref);
576
dfa32483 577 /* TODO: Call poptReadDefaultConfig; handle errors. */
cd8185f2 578
dfa32483
WD
579 /* The context leaks in case of an error, but if there's a
580 * problem we always exit anyhow. */
581 pc = poptGetContext(RSYNC_NAME, *argc, *argv, long_options, 0);
3359acb8
WD
582 {
583 struct poptAlias my_alias;
584 char **argv = new_array(char *, 1);
585 argv[0] = strdup("--delete-during");
586 my_alias.longName = "del", my_alias.shortName = '\0';
587 my_alias.argc = 1;
588 my_alias.argv = (const char **)argv;
589 if (argv && argv[0])
590 poptAddAlias(pc, my_alias, 0);
591 }
9fb08441 592 poptReadDefaultConfig(pc, 0);
2855f61f
MP
593
594 while ((opt = poptGetNextOpt(pc)) != -1) {
dfa32483
WD
595 /* most options are handled automatically by popt;
596 * only special cases are returned and listed here. */
2855f61f 597
d853783f
AT
598 switch (opt) {
599 case OPT_VERSION:
dfa32483 600 print_rsync_version(FINFO);
d853783f 601 exit_cleanup(0);
dfa32483 602
3ac7f5d4
WD
603 case OPT_DAEMON:
604 if (am_daemon) {
605 strcpy(err_buf, "Attempt to hack rsync thwarted!\n");
606 return 0;
607 }
608 poptFreeContext(pc);
609 pc = poptGetContext(RSYNC_NAME, *argc, *argv,
610 long_daemon_options, 0);
611 while ((opt = poptGetNextOpt(pc)) != -1) {
612 switch (opt) {
613 case 'h':
614 daemon_usage(FINFO);
615 exit_cleanup(0);
616
617 default:
618 rprintf(FERROR,
619 "rsync: %s: %s (in daemon mode)\n",
620 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
621 poptStrerror(opt));
622 goto daemon_error;
623 }
624 }
625 if (!daemon_opt) {
626 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
627 daemon_error:
628 rprintf(FERROR,
629 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
630 exit_cleanup(RERR_SYNTAX);
631 }
632 *argv = poptGetArgs(pc);
633 *argc = count_args(*argv);
634 daemon_opt = 0;
635 am_daemon = 1;
636 return 1;
637
5b56cc19 638 case OPT_MODIFY_WINDOW:
dfa32483
WD
639 /* The value has already been set by popt, but
640 * we need to remember that we're using a
641 * non-default setting. */
5b56cc19
AT
642 modify_window_set = 1;
643 break;
1de50993 644
aa4d3b4c 645 case OPT_FILTER:
7842418b 646 add_filter(&filter_list, poptGetOptArg(pc), 0);
d853783f
AT
647 break;
648
aa4d3b4c 649 case OPT_EXCLUDE:
7842418b
WD
650 add_filter(&filter_list, poptGetOptArg(pc),
651 XFLG_DEF_EXCLUDE);
aa4d3b4c
WD
652 break;
653
d853783f 654 case OPT_INCLUDE:
7842418b
WD
655 add_filter(&filter_list, poptGetOptArg(pc),
656 XFLG_DEF_INCLUDE);
d853783f
AT
657 break;
658
659 case OPT_EXCLUDE_FROM:
93695764 660 case OPT_INCLUDE_FROM:
7be73df4 661 arg = poptGetOptArg(pc);
ba3db479
WD
662 if (sanitize_paths)
663 arg = sanitize_path(NULL, arg, NULL, 0);
7842418b 664 if (server_filter_list.head) {
ba3db479
WD
665 char *cp = (char *)arg;
666 clean_fname(cp, 1);
7842418b 667 if (check_filter(&server_filter_list, cp, 0) < 0)
ba3db479
WD
668 goto options_rejected;
669 }
7842418b 670 add_filter_file(&filter_list, arg, XFLG_FATAL_ERRORS
aa4d3b4c
WD
671 | (opt == OPT_INCLUDE_FROM ? XFLG_DEF_INCLUDE
672 : XFLG_DEF_EXCLUDE));
93695764
DD
673 break;
674
d853783f
AT
675 case 'h':
676 usage(FINFO);
677 exit_cleanup(0);
678
d853783f
AT
679 case 'v':
680 verbose++;
681 break;
7a6421fa 682
b86f0cef 683 case 'q':
f98c60bf
WD
684 if (frommain)
685 quiet++;
b86f0cef
DD
686 break;
687
d853783f
AT
688 case OPT_SENDER:
689 if (!am_server) {
690 usage(FERROR);
65417579 691 exit_cleanup(RERR_SYNTAX);
d853783f
AT
692 }
693 am_sender = 1;
694 break;
695
aa4d3b4c
WD
696 case 'F':
697 switch (++F_option_cnt) {
698 case 1:
7842418b 699 add_filter(&filter_list,
aa4d3b4c
WD
700 ": /.rsync-filter", 0);
701 break;
702 case 2:
7842418b 703 add_filter(&filter_list,
aa4d3b4c
WD
704 "- .rsync-filter", 0);
705 break;
706 }
707 break;
708
d9fcc198
AT
709 case 'P':
710 do_progress = 1;
711 keep_partial = 1;
712 break;
713
088aac85 714 case OPT_WRITE_BATCH:
9b3318b0 715 /* batch_name is already set */
088aac85
DD
716 write_batch = 1;
717 break;
718
76f79ba7 719 case OPT_READ_BATCH:
9b3318b0 720 /* batch_name is already set */
6902ed17
MP
721 read_batch = 1;
722 break;
ea5164d1 723
7d5acf1d
WD
724 case OPT_MAX_SIZE:
725 for (arg = max_size_arg; isdigit(*arg); arg++) {}
726 if (*arg == '.')
727 for (arg++; isdigit(*arg); arg++) {}
728 switch (*arg) {
729 case 'k': case 'K':
730 max_size = atof(max_size_arg) * 1024;
731 break;
732 case 'm': case 'M':
733 max_size = atof(max_size_arg) * 1024*1024;
734 break;
735 case 'g': case 'G':
736 max_size = atof(max_size_arg) * 1024*1024*1024;
737 break;
738 case '\0':
739 max_size = atof(max_size_arg);
740 break;
741 default:
742 max_size = 0;
743 break;
744 }
745 if (max_size <= 0) {
e012f858 746 snprintf(err_buf, sizeof err_buf,
7d5acf1d
WD
747 "--max-size value is invalid: %s\n",
748 max_size_arg);
e012f858 749 return 0;
7d5acf1d
WD
750 }
751 break;
752
99218d82
WD
753 case OPT_TIMEOUT:
754 if (io_timeout && io_timeout < select_timeout)
755 select_timeout = io_timeout;
756 break;
757
59c95e42
DD
758 case OPT_LINK_DEST:
759#if HAVE_LINK
59c95e42 760 link_dest = 1;
e012f858
WD
761 dest_option = "--link-dest";
762 goto set_dest_dir;
59c95e42 763#else
d175d7e1 764 snprintf(err_buf, sizeof err_buf,
dfa32483 765 "hard links are not supported on this %s\n",
59c95e42 766 am_server ? "server" : "client");
59c95e42
DD
767 return 0;
768#endif
769
e012f858
WD
770 case OPT_COPY_DEST:
771 copy_dest = 1;
772 dest_option = "--copy-dest";
773 goto set_dest_dir;
774
775 case OPT_COMPARE_DEST:
776 compare_dest = 1;
777 dest_option = "--compare-dest";
778 set_dest_dir:
3b26bba0 779 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
e012f858
WD
780 snprintf(err_buf, sizeof err_buf,
781 "ERROR: at most %d %s args may be specified\n",
782 MAX_BASIS_DIRS, dest_option);
783 return 0;
784 }
785 arg = poptGetOptArg(pc);
786 if (sanitize_paths)
787 arg = sanitize_path(NULL, arg, NULL, 0);
788 basis_dir[basis_dir_cnt++] = (char *)arg;
789 break;
790
d853783f 791 default:
55afbb52 792 /* A large opt value means that set_refuse_options()
c67d1386
WD
793 * turned this option off (opt-BASE is its index). */
794 if (opt >= OPT_REFUSED_BASE) {
795 struct poptOption *op =
796 &long_options[opt-OPT_REFUSED_BASE];
27ed20f7 797 int n = snprintf(err_buf, sizeof err_buf,
a2570930 798 "The server is configured to refuse --%s\n",
27ed20f7
WD
799 op->longName) - 1;
800 if (op->shortName) {
801 snprintf(err_buf+n, sizeof err_buf-n,
802 " (-%c)\n", op->shortName);
803 }
804 } else {
8db7cc2c 805 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
27ed20f7
WD
806 am_server ? "on remote machine: " : "",
807 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
808 poptStrerror(opt));
809 }
dfa32483 810 return 0;
d853783f 811 }
7a6421fa 812 }
2855f61f 813
e1add893 814#if !SUPPORT_LINKS
54e87b4b 815 if (preserve_links && !am_sender) {
e1add893
WD
816 snprintf(err_buf, sizeof err_buf,
817 "symlinks are not supported on this %s\n",
818 am_server ? "server" : "client");
e1add893
WD
819 return 0;
820 }
821#endif
822
823#if !SUPPORT_HARD_LINKS
824 if (preserve_hard_links) {
825 snprintf(err_buf, sizeof err_buf,
826 "hard links are not supported on this %s\n",
827 am_server ? "server" : "client");
e1add893
WD
828 return 0;
829 }
830#endif
831
088aac85 832 if (write_batch && read_batch) {
c3ea0990 833 snprintf(err_buf, sizeof err_buf,
36119893 834 "--write-batch and --read-batch can not be used together\n");
c3ea0990 835 return 0;
088aac85 836 }
94327ff0
WD
837 if (write_batch || read_batch) {
838 if (dry_run) {
c3ea0990 839 snprintf(err_buf, sizeof err_buf,
94327ff0
WD
840 "--%s-batch cannot be used with --dry_run (-n)\n",
841 write_batch ? "write" : "read");
c3ea0990 842 return 0;
94327ff0
WD
843 }
844 if (am_server) {
845 rprintf(FINFO,
846 "ignoring --%s-batch option sent to server\n",
847 write_batch ? "write" : "read");
848 /* We don't actually exit_cleanup(), so that we can
849 * still service older version clients that still send
850 * batch args to server. */
851 read_batch = write_batch = 0;
852 batch_name = NULL;
853 }
b9f592fb 854 }
36119893 855 if (read_batch && files_from) {
c3ea0990 856 snprintf(err_buf, sizeof err_buf,
36119893 857 "--read-batch cannot be used with --files-from\n");
c3ea0990 858 return 0;
36119893 859 }
9b3318b0 860 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
c3ea0990 861 snprintf(err_buf, sizeof err_buf,
9b3318b0
WD
862 "the batch-file name must be %d characters or less.\n",
863 MAX_BATCH_NAME_LEN);
c3ea0990 864 return 0;
beb93684 865 }
088aac85 866
ce58b1b4 867 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
c3ea0990
WD
868 snprintf(err_buf, sizeof err_buf,
869 "the --temp-dir path is WAY too long.\n");
870 return 0;
ce58b1b4
WD
871 }
872
e012f858
WD
873 if (compare_dest + copy_dest + link_dest > 1) {
874 snprintf(err_buf, sizeof err_buf,
875 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
876 return 0;
877 }
878
dfa32483 879 if (archive_mode) {
ea5164d1 880 if (!files_from)
51d48398 881 recurse = -1; /* infinite recursion */
dfa32483
WD
882#if SUPPORT_LINKS
883 preserve_links = 1;
884#endif
885 preserve_perms = 1;
886 preserve_times = 1;
887 preserve_gid = 1;
888 preserve_uid = 1;
889 preserve_devices = 1;
890 }
51d48398
WD
891
892 if (recurse || list_only || files_from)
65e4cda0 893 xfer_dirs |= 1;
dfa32483 894
ea5164d1
WD
895 if (relative_paths < 0)
896 relative_paths = files_from? 1 : 0;
897
3359acb8
WD
898 if (delete_during && delete_after) {
899 snprintf(err_buf, sizeof err_buf,
900 "You may not combine --delete-during (--del) and --delete-after.\n");
901 return 0;
902 }
903 if (delete_during || delete_after)
51d48398 904 delete_mode = 1;
3359acb8
WD
905 else if (delete_mode || delete_excluded)
906 delete_mode = delete_before = 1;
51d48398 907
7be73df4 908 *argv = poptGetArgs(pc);
8db7cc2c 909 *argc = count_args(*argv);
7be73df4
WD
910
911 if (sanitize_paths) {
912 int i;
913 for (i = *argc; i-- > 0; )
10796f4b 914 (*argv)[i] = sanitize_path(NULL, (*argv)[i], "", 0);
7be73df4 915 if (tmpdir)
10796f4b 916 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0);
a7260c40 917 if (partial_dir)
10796f4b 918 partial_dir = sanitize_path(NULL, partial_dir, NULL, 0);
7be73df4 919 if (backup_dir)
10796f4b 920 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0);
7be73df4 921 if (files_from)
10796f4b 922 files_from = sanitize_path(NULL, files_from, NULL, 0);
7be73df4 923 }
7842418b
WD
924 if (server_filter_list.head && !am_sender) {
925 struct filter_list_struct *elp = &server_filter_list;
e012f858 926 int i;
c3ea0990 927 if (tmpdir) {
58b1999e 928 clean_fname(tmpdir, 1);
7842418b 929 if (check_filter(elp, tmpdir, 1) < 0)
c3ea0990
WD
930 goto options_rejected;
931 }
932 if (partial_dir) {
58b1999e 933 clean_fname(partial_dir, 1);
7842418b 934 if (check_filter(elp, partial_dir, 1) < 0)
c3ea0990
WD
935 goto options_rejected;
936 }
e012f858
WD
937 for (i = 0; i < basis_dir_cnt; i++) {
938 clean_fname(basis_dir[i], 1);
7842418b 939 if (check_filter(elp, basis_dir[i], 1) < 0)
c3ea0990
WD
940 goto options_rejected;
941 }
942 if (backup_dir) {
58b1999e 943 clean_fname(backup_dir, 1);
7842418b 944 if (check_filter(elp, backup_dir, 1) < 0)
c3ea0990
WD
945 goto options_rejected;
946 }
947 }
7842418b 948 if (server_filter_list.head && files_from) {
58b1999e 949 clean_fname(files_from, 1);
7842418b 950 if (check_filter(&server_filter_list, files_from, 0) < 0) {
c3ea0990
WD
951 options_rejected:
952 snprintf(err_buf, sizeof err_buf,
953 "Your options have been rejected by the server.\n");
954 return 0;
955 }
956 }
7be73df4 957
d175d7e1 958 if (!backup_suffix)
e0391f81 959 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
d175d7e1 960 backup_suffix_len = strlen(backup_suffix);
80ddadb7 961 if (strchr(backup_suffix, '/') != NULL) {
c3ea0990
WD
962 snprintf(err_buf, sizeof err_buf,
963 "--suffix cannot contain slashes: %s\n",
80ddadb7 964 backup_suffix);
c3ea0990 965 return 0;
80ddadb7 966 }
e0391f81
WD
967 if (backup_dir) {
968 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
969 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
970 if (backup_dir_remainder < 32) {
c3ea0990
WD
971 snprintf(err_buf, sizeof err_buf,
972 "the --backup-dir path is WAY too long.\n");
973 return 0;
e0391f81
WD
974 }
975 if (backup_dir_buf[backup_dir_len - 1] != '/') {
976 backup_dir_buf[backup_dir_len++] = '/';
977 backup_dir_buf[backup_dir_len] = '\0';
978 }
8dcf9335 979 if (verbose > 1 && !am_sender)
e0391f81 980 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
8dcf9335 981 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
c3ea0990 982 snprintf(err_buf, sizeof err_buf,
d175d7e1 983 "--suffix cannot be a null string without --backup-dir\n");
c3ea0990 984 return 0;
d175d7e1
WD
985 }
986
e2559dbe
S
987 if (do_progress && !verbose)
988 verbose = 1;
989
9fb08441
WD
990 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
991 bwlimit = daemon_bwlimit;
3c74c3a3
WD
992 if (bwlimit) {
993 bwlimit_writemax = (size_t)bwlimit * 128;
994 if (bwlimit_writemax < 512)
995 bwlimit_writemax = 512;
996 }
997
a3221d2a
WD
998 if (inplace) {
999#if HAVE_FTRUNCATE
a7260c40
WD
1000 if (partial_dir) {
1001 snprintf(err_buf, sizeof err_buf,
1002 "--inplace cannot be used with --partial-dir\n");
1003 return 0;
1004 }
a3221d2a 1005 keep_partial = 0;
ded4daf0
WD
1006#else
1007 snprintf(err_buf, sizeof err_buf,
1008 "--inplace is not supported on this %s\n",
1009 am_server ? "server" : "client");
1010 return 0;
1011#endif
075aa18f
WD
1012 } else {
1013 if (keep_partial && !partial_dir)
1014 partial_dir = getenv("RSYNC_PARTIAL_DIR");
1015 if (partial_dir) {
1016 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
1017 partial_dir = NULL;
13791b1e 1018 else if (*partial_dir != '/') {
7842418b 1019 add_filter(&filter_list, partial_dir,
aa4d3b4c 1020 XFLG_DIRECTORY | XFLG_DEF_EXCLUDE);
13791b1e 1021 }
075aa18f
WD
1022 keep_partial = 1;
1023 }
a3221d2a
WD
1024 }
1025
ea5164d1
WD
1026 if (files_from) {
1027 char *colon;
c3ea0990 1028 if (*argc > 2 || (!am_daemon && *argc == 1)) {
ea5164d1
WD
1029 usage(FERROR);
1030 exit_cleanup(RERR_SYNTAX);
1031 }
63596e1c 1032 if (strcmp(files_from, "-") == 0) {
ea5164d1 1033 filesfrom_fd = 0;
63596e1c
WD
1034 if (am_server)
1035 remote_filesfrom_file = "-";
1036 }
ea5164d1
WD
1037 else if ((colon = find_colon(files_from)) != 0) {
1038 if (am_server) {
1039 usage(FERROR);
1040 exit_cleanup(RERR_SYNTAX);
1041 }
1042 remote_filesfrom_file = colon+1 + (colon[1] == ':');
1043 if (strcmp(remote_filesfrom_file, "-") == 0) {
c3ea0990
WD
1044 snprintf(err_buf, sizeof err_buf,
1045 "Invalid --files-from remote filename\n");
1046 return 0;
ea5164d1
WD
1047 }
1048 } else {
ea5164d1
WD
1049 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
1050 if (filesfrom_fd < 0) {
c3ea0990
WD
1051 snprintf(err_buf, sizeof err_buf,
1052 "failed to open files-from file %s: %s\n",
1053 files_from, strerror(errno));
1054 return 0;
ea5164d1
WD
1055 }
1056 }
1057 }
1058
b11ed3b1 1059 return 1;
7a6421fa
AT
1060}
1061
1062
dafe63ca
MP
1063/**
1064 * Construct a filtered list of options to pass through from the
1065 * client to the server.
1066 *
1067 * This involves setting options that will tell the server how to
1068 * behave, and also filtering out options that are processed only
1069 * locally.
1070 **/
7a6421fa
AT
1071void server_options(char **args,int *argc)
1072{
e012f858 1073 static char argstr[50+MAX_BASIS_DIRS*2];
d853783f 1074 int ac = *argc;
f98c60bf 1075 char *arg;
ef5d23eb 1076
d853783f
AT
1077 int i, x;
1078
93689aa5
DD
1079 if (blocking_io == -1)
1080 blocking_io = 0;
1081
d853783f
AT
1082 args[ac++] = "--server";
1083
1312d9fc
WD
1084 if (daemon_over_rsh) {
1085 args[ac++] = "--daemon";
1086 *argc = ac;
1087 /* if we're passing --daemon, we're done */
1088 return;
1089 }
1090
d853783f
AT
1091 if (!am_sender)
1092 args[ac++] = "--sender";
1093
1094 x = 1;
1095 argstr[0] = '-';
f98c60bf 1096 for (i = 0; i < verbose; i++)
d853783f 1097 argstr[x++] = 'v';
f0b36a48 1098
b86f0cef 1099 /* the -q option is intentionally left out */
d853783f
AT
1100 if (make_backups)
1101 argstr[x++] = 'b';
1102 if (update_only)
1103 argstr[x++] = 'u';
1104 if (dry_run)
1105 argstr[x++] = 'n';
1106 if (preserve_links)
1107 argstr[x++] = 'l';
1108 if (copy_links)
1109 argstr[x++] = 'L';
65e4cda0 1110 if (xfer_dirs > 1)
51d48398 1111 argstr[x++] = 'k';
716e73d4
WD
1112 if (keep_dirlinks && am_sender)
1113 argstr[x++] = 'K';
1bfbf40b 1114
dfa32483 1115 if (whole_file > 0)
d853783f 1116 argstr[x++] = 'W';
bceec82f
MP
1117 /* We don't need to send --no-whole-file, because it's the
1118 * default for remote transfers, and in any case old versions
1119 * of rsync will not understand it. */
dfa32483 1120
d853783f
AT
1121 if (preserve_hard_links)
1122 argstr[x++] = 'H';
1123 if (preserve_uid)
1124 argstr[x++] = 'o';
1125 if (preserve_gid)
1126 argstr[x++] = 'g';
1127 if (preserve_devices)
1128 argstr[x++] = 'D';
1129 if (preserve_times)
1130 argstr[x++] = 't';
20fb7b91
WD
1131 if (omit_dir_times && am_sender)
1132 argstr[x++] = 'O';
d853783f
AT
1133 if (preserve_perms)
1134 argstr[x++] = 'p';
51d48398 1135 if (recurse < 0)
d853783f
AT
1136 argstr[x++] = 'r';
1137 if (always_checksum)
1138 argstr[x++] = 'c';
1139 if (cvs_exclude)
1140 argstr[x++] = 'C';
1141 if (ignore_times)
1142 argstr[x++] = 'I';
1143 if (relative_paths)
1144 argstr[x++] = 'R';
1145 if (one_file_system)
1146 argstr[x++] = 'x';
1147 if (sparse_files)
1148 argstr[x++] = 'S';
1149 if (do_compression)
1150 argstr[x++] = 'z';
f0b36a48 1151
51d48398
WD
1152 /* This is a complete hack - blame Rusty. FIXME!
1153 * This hack is only needed for older rsync versions that
1154 * don't understand the --list-only option. */
1155 if (list_only == 1 && recurse >= 0)
f0b36a48
AT
1156 argstr[x++] = 'r';
1157
d853783f
AT
1158 argstr[x] = 0;
1159
f98c60bf
WD
1160 if (x != 1)
1161 args[ac++] = argstr;
d853783f 1162
51d48398
WD
1163 if (list_only > 1)
1164 args[ac++] = "--list-only";
1165
195bd906 1166 if (block_size) {
a06b419d 1167 if (asprintf(&arg, "-B%lu", block_size) < 0)
f98c60bf
WD
1168 goto oom;
1169 args[ac++] = arg;
dfa32483 1170 }
d853783f 1171
0b73ca12 1172 if (max_delete && am_sender) {
f98c60bf
WD
1173 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
1174 goto oom;
1175 args[ac++] = arg;
dfa32483
WD
1176 }
1177
7d5acf1d
WD
1178 if (max_size && am_sender) {
1179 args[ac++] = "--max-size";
1180 args[ac++] = max_size_arg;
1181 }
1182
d853783f 1183 if (io_timeout) {
f98c60bf
WD
1184 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
1185 goto oom;
1186 args[ac++] = arg;
dfa32483 1187 }
d853783f 1188
ef5d23eb 1189 if (bwlimit) {
f98c60bf
WD
1190 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
1191 goto oom;
1192 args[ac++] = arg;
ef5d23eb
DD
1193 }
1194
d175d7e1
WD
1195 if (backup_dir) {
1196 args[ac++] = "--backup-dir";
1197 args[ac++] = backup_dir;
1198 }
1199
1200 /* Only send --suffix if it specifies a non-default value. */
f98c60bf 1201 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
191e40da 1202 /* We use the following syntax to avoid weirdness with '~'. */
f98c60bf
WD
1203 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
1204 goto oom;
1205 args[ac++] = arg;
d853783f
AT
1206 }
1207
06a50542
WD
1208 if (am_sender) {
1209 if (delete_excluded)
1210 args[ac++] = "--delete-excluded";
3359acb8 1211 else if (delete_before || delete_after)
06a50542 1212 args[ac++] = "--delete";
3359acb8
WD
1213 if (delete_during)
1214 args[ac++] = "--delete-during";
06a50542
WD
1215 if (delete_after)
1216 args[ac++] = "--delete-after";
06a50542
WD
1217 if (force_delete)
1218 args[ac++] = "--force";
1219 }
b33b791e 1220
f83f0548
AT
1221 if (size_only)
1222 args[ac++] = "--size-only";
1223
5b56cc19 1224 if (modify_window_set) {
f98c60bf
WD
1225 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
1226 goto oom;
1227 args[ac++] = arg;
5b56cc19
AT
1228 }
1229
c8d895de 1230 if (checksum_seed) {
221ddb94 1231 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
c8d895de
WD
1232 goto oom;
1233 args[ac++] = arg;
1234 }
1235
a7260c40
WD
1236 if (partial_dir && am_sender) {
1237 args[ac++] = "--partial-dir";
1238 args[ac++] = partial_dir;
1239 } else if (keep_partial)
d853783f
AT
1240 args[ac++] = "--partial";
1241
ef55c686
AT
1242 if (ignore_errors)
1243 args[ac++] = "--ignore-errors";
1244
b5313607
DD
1245 if (copy_unsafe_links)
1246 args[ac++] = "--copy-unsafe-links";
1247
d853783f
AT
1248 if (safe_symlinks)
1249 args[ac++] = "--safe-links";
1250
1251 if (numeric_ids)
1252 args[ac++] = "--numeric-ids";
1253
0b73ca12 1254 if (only_existing && am_sender)
1347d512
AT
1255 args[ac++] = "--existing";
1256
dfa32483 1257 if (opt_ignore_existing && am_sender)
3d6feada
MP
1258 args[ac++] = "--ignore-existing";
1259
a3221d2a
WD
1260 if (inplace)
1261 args[ac++] = "--inplace";
1262
d853783f
AT
1263 if (tmpdir) {
1264 args[ac++] = "--temp-dir";
1265 args[ac++] = tmpdir;
1266 }
1267
e012f858 1268 if (basis_dir[0] && am_sender) {
375a4556
DD
1269 /* the server only needs this option if it is not the sender,
1270 * and it may be an older version that doesn't know this
1271 * option, so don't send it if client is the sender.
1272 */
e012f858
WD
1273 int i;
1274 for (i = 0; i < basis_dir_cnt; i++) {
1275 args[ac++] = dest_option;
1276 args[ac++] = basis_dir[i];
1277 }
375a4556
DD
1278 }
1279
ea5164d1
WD
1280 if (files_from && (!am_sender || remote_filesfrom_file)) {
1281 if (remote_filesfrom_file) {
1282 args[ac++] = "--files-from";
1283 args[ac++] = remote_filesfrom_file;
1284 if (eol_nulls)
1285 args[ac++] = "--from0";
1286 } else {
1287 args[ac++] = "--files-from=-";
1288 args[ac++] = "--from0";
1289 }
c0ab28d1
WD
1290 if (!relative_paths)
1291 args[ac++] = "--no-relative";
ea5164d1 1292 }
c72f5bd9 1293 if (!implied_dirs && !am_sender)
3a90ea0a 1294 args[ac++] = "--no-implied-dirs";
ea5164d1 1295
d853783f 1296 *argc = ac;
f98c60bf
WD
1297 return;
1298
1299 oom:
1300 out_of_memory("server_options");
7a6421fa
AT
1301}
1302
ea5164d1
WD
1303/**
1304 * Return the position of a ':' IF it is not part of a filename (i.e. as
1305 * long as it doesn't occur after a slash.
1306 */
1307char *find_colon(char *s)
1308{
1309 char *p, *p2;
1310
1311 p = strchr(s,':');
f98c60bf
WD
1312 if (!p)
1313 return NULL;
ea5164d1
WD
1314
1315 /* now check to see if there is a / in the string before the : - if there is then
1316 discard the colon on the assumption that the : is part of a filename */
1317 p2 = strchr(s,'/');
f98c60bf
WD
1318 if (p2 && p2 < p)
1319 return NULL;
ea5164d1
WD
1320
1321 return p;
1322}