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