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