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