Renamed sDefault to Locals.
[rsync/rsync.git] / options.c
... / ...
CommitLineData
1/*
2 * Command-line (and received via daemon-socket) option parsing.
3 *
4 * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 2000, 2001, 2002 Martin Pool <mbp@samba.org>
6 * Copyright (C) 2002-2009 Wayne Davison
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, visit the http://fsf.org website.
20 */
21
22#include "rsync.h"
23#include "itypes.h"
24#include <popt.h>
25#include "zlib/zlib.h"
26
27extern int module_id;
28extern int local_server;
29extern int sanitize_paths;
30extern int daemon_over_rsh;
31extern unsigned int module_dirlen;
32extern struct filter_list_struct filter_list;
33extern struct filter_list_struct daemon_filter_list;
34
35int make_backups = 0;
36
37/**
38 * If 1, send the whole file as literal data rather than trying to
39 * create an incremental diff.
40 *
41 * If -1, then look at whether we're local or remote and go by that.
42 *
43 * @sa disable_deltas_p()
44 **/
45int whole_file = -1;
46
47int append_mode = 0;
48int keep_dirlinks = 0;
49int copy_dirlinks = 0;
50int copy_links = 0;
51int preserve_links = 0;
52int preserve_hard_links = 0;
53int preserve_acls = 0;
54int preserve_xattrs = 0;
55int preserve_perms = 0;
56int preserve_executability = 0;
57int preserve_devices = 0;
58int preserve_specials = 0;
59int preserve_uid = 0;
60int preserve_gid = 0;
61int preserve_times = 0;
62int update_only = 0;
63int cvs_exclude = 0;
64int dry_run = 0;
65int do_xfers = 1;
66int ignore_times = 0;
67int delete_mode = 0;
68int delete_during = 0;
69int delete_before = 0;
70int delete_after = 0;
71int delete_excluded = 0;
72int remove_source_files = 0;
73int one_file_system = 0;
74int protocol_version = PROTOCOL_VERSION;
75int sparse_files = 0;
76int do_compression = 0;
77int def_compress_level = Z_DEFAULT_COMPRESSION;
78int am_root = 0; /* 0 = normal, 1 = root, 2 = --super, -1 = --fake-super */
79int am_server = 0;
80int am_sender = 0;
81int am_starting_up = 1;
82int relative_paths = -1;
83int implied_dirs = 1;
84int numeric_ids = 0;
85int msgs2stderr = 0;
86int allow_8bit_chars = 0;
87int force_delete = 0;
88int io_timeout = 0;
89int prune_empty_dirs = 0;
90int use_qsort = 0;
91char *files_from = NULL;
92int filesfrom_fd = -1;
93char *filesfrom_host = NULL;
94int eol_nulls = 0;
95int protect_args = 0;
96int human_readable = 1;
97int recurse = 0;
98int allow_inc_recurse = 1;
99int xfer_dirs = -1;
100int am_daemon = 0;
101int connect_timeout = 0;
102int keep_partial = 0;
103int safe_symlinks = 0;
104int copy_unsafe_links = 0;
105int munge_symlinks = 0;
106int size_only = 0;
107int daemon_bwlimit = 0;
108int bwlimit = 0;
109int fuzzy_basis = 0;
110size_t bwlimit_writemax = 0;
111int ignore_existing = 0;
112int ignore_non_existing = 0;
113int need_messages_from_generator = 0;
114int max_delete = INT_MIN;
115OFF_T max_size = 0;
116OFF_T min_size = 0;
117int ignore_errors = 0;
118int modify_window = 0;
119int blocking_io = -1;
120int checksum_seed = 0;
121int inplace = 0;
122int delay_updates = 0;
123long block_size = 0; /* "long" because popt can't set an int32. */
124char number_separator;
125char *skip_compress = NULL;
126item_list dparam_list = EMPTY_ITEM_LIST;
127
128/** Network address family. **/
129int default_af_hint
130#ifdef INET6
131 = 0; /* Any protocol */
132#else
133 = AF_INET; /* Must use IPv4 */
134# ifdef AF_INET6
135# undef AF_INET6
136# endif
137# define AF_INET6 AF_INET /* make -6 option a no-op */
138#endif
139
140/** Do not go into the background when run as --daemon. Good
141 * for debugging and required for running as a service on W32,
142 * or under Unix process-monitors. **/
143int no_detach
144#if defined _WIN32 || defined __WIN32__
145 = 1;
146#else
147 = 0;
148#endif
149
150int write_batch = 0;
151int read_batch = 0;
152int backup_dir_len = 0;
153int backup_suffix_len;
154unsigned int backup_dir_remainder;
155
156char *backup_suffix = NULL;
157char *tmpdir = NULL;
158char *partial_dir = NULL;
159char *basis_dir[MAX_BASIS_DIRS+1];
160char *config_file = NULL;
161char *shell_cmd = NULL;
162char *logfile_name = NULL;
163char *logfile_format = NULL;
164char *stdout_format = NULL;
165char *password_file = NULL;
166char *rsync_path = RSYNC_PATH;
167char *backup_dir = NULL;
168char backup_dir_buf[MAXPATHLEN];
169char *sockopts = NULL;
170char *usermap = NULL;
171char *groupmap = NULL;
172int rsync_port = 0;
173int compare_dest = 0;
174int copy_dest = 0;
175int link_dest = 0;
176int basis_dir_cnt = 0;
177char *dest_option = NULL;
178
179static int remote_option_alloc = 0;
180int remote_option_cnt = 0;
181const char **remote_options = NULL;
182
183int quiet = 0;
184int output_motd = 1;
185int log_before_transfer = 0;
186int stdout_format_has_i = 0;
187int stdout_format_has_o_or_i = 0;
188int logfile_format_has_i = 0;
189int logfile_format_has_o_or_i = 0;
190int always_checksum = 0;
191int list_only = 0;
192
193#define MAX_BATCH_NAME_LEN 256 /* Must be less than MAXPATHLEN-13 */
194char *batch_name = NULL;
195
196int need_unsorted_flist = 0;
197#ifdef ICONV_OPTION
198char *iconv_opt = ICONV_OPTION;
199#endif
200
201struct chmod_mode_struct *chmod_modes = NULL;
202
203static const char *debug_verbosity[] = {
204 /*0*/ NULL,
205 /*1*/ NULL,
206 /*2*/ "bind,cmd,connect,del,deltasum,dup,filter,flist,iconv",
207 /*3*/ "acl,backup,deltasum2,del2,exit,filter2,flist2,fuzzy,genr,own,recv,send,time",
208 /*4*/ "cmd2,deltasum3,del3,exit2,flist3,iconv2,own2,proto,time2",
209 /*5*/ "chdir,deltasum4,flist4,fuzzy2,hash,hlink",
210};
211
212#define MAX_VERBOSITY ((int)(sizeof debug_verbosity / sizeof debug_verbosity[0]) - 1)
213
214static const char *info_verbosity[1+MAX_VERBOSITY] = {
215 /*0*/ NULL,
216 /*1*/ "copy,del,flist,misc,name,stats,symsafe",
217 /*2*/ "backup,mount,name2,remove,skip",
218};
219
220#define MAX_OUT_LEVEL 4 /* The largest N allowed for any flagN word. */
221
222short info_levels[COUNT_INFO], debug_levels[COUNT_DEBUG];
223
224#define DEFAULT_PRIORITY 0 /* Default/implied/--verbose set values. */
225#define HELP_PRIORITY 1 /* The help output uses this level. */
226#define USER_PRIORITY 2 /* User-specified via --info or --debug */
227#define LIMIT_PRIORITY 3 /* Overriding priority when limiting values. */
228
229#define W_CLI (1<<0) /* client side */
230#define W_SRV (1<<1) /* server side */
231#define W_SND (1<<2) /* sending side */
232#define W_REC (1<<3) /* receiving side */
233
234struct output_struct {
235 char *name; /* The name of the info/debug flag. */
236 char *help; /* The description of the info/debug flag. */
237 uchar namelen; /* The length of the name string. */
238 uchar flag; /* The flag's value, for consistency check. */
239 uchar where; /* Bits indicating where the flag is used. */
240 uchar priority; /* See *_PRIORITY defines. */
241};
242
243#define INFO_WORD(flag, where, help) { #flag, help, sizeof #flag - 1, INFO_##flag, where, 0 }
244
245static struct output_struct info_words[COUNT_INFO+1] = {
246 INFO_WORD(BACKUP, W_REC, "Mention files backed up"),
247 INFO_WORD(COPY, W_REC, "Mention files copied locally on the receiving side"),
248 INFO_WORD(DEL, W_REC, "Mention deletions on the receiving side"),
249 INFO_WORD(FLIST, W_CLI, "Mention file-list receiving/sending (levels 1-2)"),
250 INFO_WORD(MISC, W_SND|W_REC, "Mention miscellaneous information"),
251 INFO_WORD(MOUNT, W_SND|W_REC, "Mention mounts that were found or skipped"),
252 INFO_WORD(NAME, W_SND|W_REC, "Mention 1) updated file/dir names, 2) unchanged names"),
253 INFO_WORD(PROGRESS, W_CLI, "Mention 1) per-file progress or 2) total transfer progress"),
254 INFO_WORD(REMOVE, W_SND, "Mention files removed on the sending side"),
255 INFO_WORD(SKIP, W_REC, "Mention files that are skipped due to options used"),
256 INFO_WORD(STATS, W_CLI|W_SRV, "Mention statistics at end of run (levels 1-3)"),
257 INFO_WORD(SYMSAFE, W_SND|W_REC, "Mention symlinks that are unsafe"),
258 { NULL, "--info", 0, 0, 0, 0 }
259};
260
261#define DEBUG_WORD(flag, where, help) { #flag, help, sizeof #flag - 1, DEBUG_##flag, where, 0 }
262
263static struct output_struct debug_words[COUNT_DEBUG+1] = {
264 DEBUG_WORD(ACL, W_SND|W_REC, "Debug extra ACL info"),
265 DEBUG_WORD(BACKUP, W_REC, "Debug backup actions (levels 1-2)"),
266 DEBUG_WORD(BIND, W_CLI, "Debug socket bind actions"),
267 DEBUG_WORD(CHDIR, W_CLI|W_SRV, "Debug when the current directory changes"),
268 DEBUG_WORD(CONNECT, W_CLI, "Debug connection events"),
269 DEBUG_WORD(CMD, W_CLI, "Debug commands+options that are issued (levels 1-2)"),
270 DEBUG_WORD(DEL, W_REC, "Debug delete actions (levels 1-3)"),
271 DEBUG_WORD(DELTASUM, W_SND|W_REC, "Debug delta-transfer checksumming (levels 1-4)"),
272 DEBUG_WORD(DUP, W_REC, "Debug weeding of duplicate names"),
273 DEBUG_WORD(EXIT, W_CLI|W_SRV, "Debug exit events (levels 1-2)"),
274 DEBUG_WORD(FILTER, W_SND|W_REC, "Debug filter actions (levels 1-2)"),
275 DEBUG_WORD(FLIST, W_SND|W_REC, "Debug file-list operations (levels 1-4)"),
276 DEBUG_WORD(FUZZY, W_REC, "Debug fuzzy scoring (levels 1-2)"),
277 DEBUG_WORD(GENR, W_REC, "Debug generator functions"),
278 DEBUG_WORD(HASH, W_SND|W_REC, "Debug hashtable code"),
279 DEBUG_WORD(HLINK, W_SND|W_REC, "Debug hard-link actions"),
280 DEBUG_WORD(ICONV, W_CLI|W_SRV, "Debug iconv character conversions (levels 1-2)"),
281 DEBUG_WORD(OWN, W_REC, "Debug ownership changes in users & groups (levels 1-2)"),
282 DEBUG_WORD(PROTO, W_CLI|W_SRV, "Debug protocol information"),
283 DEBUG_WORD(RECV, W_REC, "Debug receiver functions"),
284 DEBUG_WORD(SEND, W_SND, "Debug sender functions"),
285 DEBUG_WORD(TIME, W_REC, "Debug setting of modified times (levels 1-2)"),
286 { NULL, "--debug", 0, 0, 0, 0 }
287};
288
289static int verbose = 0;
290static int do_stats = 0;
291static int do_progress = 0;
292static int daemon_opt; /* sets am_daemon after option error-reporting */
293static int omit_dir_times = 0;
294static int F_option_cnt = 0;
295static int modify_window_set;
296static int itemize_changes = 0;
297static int refused_delete, refused_archive_part, refused_compress;
298static int refused_partial, refused_progress, refused_delete_before;
299static int refused_delete_during;
300static int refused_inplace, refused_no_iconv;
301static BOOL usermap_via_chown, groupmap_via_chown;
302static char *max_size_arg, *min_size_arg;
303static char tmp_partialdir[] = ".~tmp~";
304
305/** Local address to bind. As a character string because it's
306 * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
307 * address, or a hostname. **/
308char *bind_address;
309
310static void output_item_help(struct output_struct *words);
311
312/* This constructs a string that represents all the options set for either
313 * the --info or --debug setting, skipping any implied options (by -v, etc.).
314 * This is used both when conveying the user's options to the server, and
315 * when the help output wants to tell the user what options are implied. */
316static char *make_output_option(struct output_struct *words, short *levels, uchar where)
317{
318 char *str = words == info_words ? "--info=" : "--debug=";
319 int j, counts[MAX_OUT_LEVEL+1], pos, skipped = 0, len = 0, max = 0, lev = 0;
320 int word_count = words == info_words ? COUNT_INFO : COUNT_DEBUG;
321 char *buf;
322
323 memset(counts, 0, sizeof counts);
324
325 for (j = 0; words[j].name; j++) {
326 if (words[j].flag != j) {
327 rprintf(FERROR, "rsync: internal error on %s%s: %d != %d\n",
328 words == info_words ? "INFO_" : "DEBUG_",
329 words[j].name, words[j].flag, j);
330 exit_cleanup(RERR_UNSUPPORTED);
331 }
332 if (!(words[j].where & where))
333 continue;
334 if (words[j].priority == DEFAULT_PRIORITY) {
335 /* Implied items don't need to be mentioned. */
336 skipped++;
337 continue;
338 }
339 len += len ? 1 : strlen(str);
340 len += strlen(words[j].name);
341 len += levels[j] == 1 ? 0 : 1;
342
343 if (words[j].priority == HELP_PRIORITY)
344 continue; /* no abbreviating for help */
345
346 assert(levels[j] <= MAX_OUT_LEVEL);
347 if (++counts[levels[j]] > max) {
348 /* Determine which level has the most items. */
349 lev = levels[j];
350 max = counts[lev];
351 }
352 }
353
354 /* Sanity check the COUNT_* define against the length of the table. */
355 if (j != word_count) {
356 rprintf(FERROR, "rsync: internal error: %s is wrong! (%d != %d)\n",
357 words == info_words ? "COUNT_INFO" : "COUNT_DEBUG",
358 j, word_count);
359 exit_cleanup(RERR_UNSUPPORTED);
360 }
361
362 if (!len)
363 return NULL;
364
365 len++;
366 if (!(buf = new_array(char, len)))
367 out_of_memory("make_output_option");
368 pos = 0;
369
370 if (skipped || max < 5)
371 lev = -1;
372 else {
373 if (lev == 0)
374 pos += snprintf(buf, len, "%sNONE", str);
375 else if (lev == 1)
376 pos += snprintf(buf, len, "%sALL", str);
377 else
378 pos += snprintf(buf, len, "%sALL%d", str, lev);
379 }
380
381 for (j = 0; words[j].name && pos < len; j++) {
382 if (words[j].priority == DEFAULT_PRIORITY || levels[j] == lev || !(words[j].where & where))
383 continue;
384 if (pos)
385 buf[pos++] = ',';
386 else
387 pos += strlcpy(buf+pos, str, len-pos);
388 if (pos < len)
389 pos += strlcpy(buf+pos, words[j].name, len-pos);
390 /* Level 1 is implied by the name alone. */
391 if (levels[j] != 1 && pos < len)
392 buf[pos++] = '0' + levels[j];
393 }
394
395 buf[pos] = '\0';
396
397 return buf;
398}
399
400static void parse_output_words(struct output_struct *words, short *levels,
401 const char *str, uchar priority)
402{
403 const char *s;
404 int j, len, lev;
405
406 if (!str)
407 return;
408
409 while (*str) {
410 if ((s = strchr(str, ',')) != NULL)
411 len = s++ - str;
412 else
413 len = strlen(str);
414 while (len && isDigit(str+len-1))
415 len--;
416 lev = isDigit(str+len) ? atoi(str+len) : 1;
417 if (lev > MAX_OUT_LEVEL)
418 lev = MAX_OUT_LEVEL;
419 if (len == 4 && strncasecmp(str, "help", 4) == 0) {
420 output_item_help(words);
421 exit_cleanup(0);
422 }
423 if (len == 4 && strncasecmp(str, "none", 4) == 0)
424 len = lev = 0;
425 else if (len == 3 && strncasecmp(str, "all", 3) == 0)
426 len = 0;
427 for (j = 0; words[j].name; j++) {
428 if (!len
429 || (len == words[j].namelen && strncasecmp(str, words[j].name, len) == 0)) {
430 if (priority >= words[j].priority) {
431 words[j].priority = priority;
432 levels[j] = lev;
433 }
434 if (len)
435 break;
436 }
437 }
438 if (len && !words[j].name) {
439 rprintf(FERROR, "Unknown %s item: \"%.*s\"\n",
440 words[j].help, len, str);
441 exit_cleanup(RERR_SYNTAX);
442 }
443 if (!s)
444 break;
445 str = s;
446 }
447}
448
449/* Tell the user what all the info or debug flags mean. */
450static void output_item_help(struct output_struct *words)
451{
452 short *levels = words == info_words ? info_levels : debug_levels;
453 const char **verbosity = words == info_words ? info_verbosity : debug_verbosity;
454 char buf[128], *opt, *fmt = "%-10s %s\n";
455 int j;
456
457 reset_output_levels();
458
459 rprintf(FINFO, "Use OPT or OPT1 for level 1 output, OPT2 for level 2, etc.; OPT0 silences.\n");
460 rprintf(FINFO, "\n");
461 for (j = 0; words[j].name; j++)
462 rprintf(FINFO, fmt, words[j].name, words[j].help);
463 rprintf(FINFO, "\n");
464
465 snprintf(buf, sizeof buf, "Set all %s options (e.g. all%d)",
466 words[j].help, MAX_OUT_LEVEL);
467 rprintf(FINFO, fmt, "ALL", buf);
468
469 snprintf(buf, sizeof buf, "Silence all %s options (same as all0)",
470 words[j].help);
471 rprintf(FINFO, fmt, "NONE", buf);
472
473 rprintf(FINFO, fmt, "HELP", "Output this help message");
474 rprintf(FINFO, "\n");
475 rprintf(FINFO, "Options added for each increase in verbose level:\n");
476
477 for (j = 1; j <= MAX_VERBOSITY; j++) {
478 parse_output_words(words, levels, verbosity[j], HELP_PRIORITY);
479 opt = make_output_option(words, levels, W_CLI|W_SRV|W_SND|W_REC);
480 if (opt) {
481 rprintf(FINFO, "%d) %s\n", j, strchr(opt, '=')+1);
482 free(opt);
483 }
484 reset_output_levels();
485 }
486}
487
488/* The --verbose option now sets info+debug flags. */
489static void set_output_verbosity(int level, uchar priority)
490{
491 int j;
492
493 if (level > MAX_VERBOSITY)
494 level = MAX_VERBOSITY;
495
496 for (j = 1; j <= level; j++) {
497 parse_output_words(info_words, info_levels, info_verbosity[j], priority);
498 parse_output_words(debug_words, debug_levels, debug_verbosity[j], priority);
499 }
500}
501
502/* Limit the info+debug flag levels given a verbose-option level limit. */
503void limit_output_verbosity(int level)
504{
505 short info_limits[COUNT_INFO], debug_limits[COUNT_DEBUG];
506 int j;
507
508 if (level > MAX_VERBOSITY)
509 return;
510
511 memset(info_limits, 0, sizeof info_limits);
512 memset(debug_limits, 0, sizeof debug_limits);
513
514 /* Compute the level limits in the above arrays. */
515 for (j = 1; j <= level; j++) {
516 parse_output_words(info_words, info_limits, info_verbosity[j], LIMIT_PRIORITY);
517 parse_output_words(debug_words, debug_limits, debug_verbosity[j], LIMIT_PRIORITY);
518 }
519
520 for (j = 0; j < COUNT_INFO; j++) {
521 if (info_levels[j] > info_limits[j])
522 info_levels[j] = info_limits[j];
523 }
524
525 for (j = 0; j < COUNT_DEBUG; j++) {
526 if (debug_levels[j] > debug_limits[j])
527 debug_levels[j] = debug_limits[j];
528 }
529}
530
531void reset_output_levels(void)
532{
533 int j;
534
535 memset(info_levels, 0, sizeof info_levels);
536 memset(debug_levels, 0, sizeof debug_levels);
537
538 for (j = 0; j < COUNT_INFO; j++)
539 info_words[j].priority = DEFAULT_PRIORITY;
540
541 for (j = 0; j < COUNT_DEBUG; j++)
542 debug_words[j].priority = DEFAULT_PRIORITY;
543}
544
545void negate_output_levels(void)
546{
547 int j;
548
549 for (j = 0; j < COUNT_INFO; j++)
550 info_levels[j] *= -1;
551
552 for (j = 0; j < COUNT_DEBUG; j++)
553 debug_levels[j] *= -1;
554}
555
556static void print_rsync_version(enum logcode f)
557{
558 char *subprotocol = "";
559 char const *got_socketpair = "no ";
560 char const *have_inplace = "no ";
561 char const *hardlinks = "no ";
562 char const *symtimes = "no ";
563 char const *acls = "no ";
564 char const *xattrs = "no ";
565 char const *links = "no ";
566 char const *iconv = "no ";
567 char const *ipv6 = "no ";
568 STRUCT_STAT *dumstat;
569
570#if SUBPROTOCOL_VERSION != 0
571 if (asprintf(&subprotocol, ".PR%d", SUBPROTOCOL_VERSION) < 0)
572 out_of_memory("print_rsync_version");
573#endif
574#ifdef HAVE_SOCKETPAIR
575 got_socketpair = "";
576#endif
577#ifdef HAVE_FTRUNCATE
578 have_inplace = "";
579#endif
580#ifdef SUPPORT_HARD_LINKS
581 hardlinks = "";
582#endif
583#ifdef SUPPORT_ACLS
584 acls = "";
585#endif
586#ifdef SUPPORT_XATTRS
587 xattrs = "";
588#endif
589#ifdef SUPPORT_LINKS
590 links = "";
591#endif
592#ifdef INET6
593 ipv6 = "";
594#endif
595#ifdef ICONV_OPTION
596 iconv = "";
597#endif
598#if defined HAVE_LUTIMES && defined HAVE_UTIMES
599 symtimes = "";
600#endif
601
602 rprintf(f, "%s version %s protocol version %d%s\n",
603 RSYNC_NAME, RSYNC_VERSION, PROTOCOL_VERSION, subprotocol);
604 rprintf(f, "Copyright (C) 1996-2009 by Andrew Tridgell, Wayne Davison, and others.\n");
605 rprintf(f, "Web site: http://rsync.samba.org/\n");
606 rprintf(f, "Capabilities:\n");
607 rprintf(f, " %d-bit files, %d-bit inums, %d-bit timestamps, %d-bit long ints,\n",
608 (int)(sizeof (OFF_T) * 8),
609 (int)(sizeof dumstat->st_ino * 8), /* Don't check ino_t! */
610 (int)(sizeof (time_t) * 8),
611 (int)(sizeof (int64) * 8));
612 rprintf(f, " %ssocketpairs, %shardlinks, %ssymlinks, %sIPv6, batchfiles, %sinplace,\n",
613 got_socketpair, hardlinks, links, ipv6, have_inplace);
614 rprintf(f, " %sappend, %sACLs, %sxattrs, %siconv, %ssymtimes\n",
615 have_inplace, acls, xattrs, iconv, symtimes);
616
617#ifdef MAINTAINER_MODE
618 rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
619#endif
620
621#if SIZEOF_INT64 < 8
622 rprintf(f, "WARNING: no 64-bit integers on this platform!\n");
623#endif
624 if (sizeof (int64) != SIZEOF_INT64) {
625 rprintf(f,
626 "WARNING: size mismatch in SIZEOF_INT64 define (%d != %d)\n",
627 (int) SIZEOF_INT64, (int) sizeof (int64));
628 }
629
630 rprintf(f,"\n");
631 rprintf(f,"rsync comes with ABSOLUTELY NO WARRANTY. This is free software, and you\n");
632 rprintf(f,"are welcome to redistribute it under certain conditions. See the GNU\n");
633 rprintf(f,"General Public Licence for details.\n");
634}
635
636
637void usage(enum logcode F)
638{
639 print_rsync_version(F);
640
641 rprintf(F,"\n");
642 rprintf(F,"rsync is a file transfer program capable of efficient remote update\n");
643 rprintf(F,"via a fast differencing algorithm.\n");
644
645 rprintf(F,"\n");
646 rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... DEST\n");
647 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n");
648 rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n");
649 rprintf(F," or rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST\n");
650 rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC [DEST]\n");
651 rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n");
652 rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n");
653 rprintf(F,"The ':' usages connect via remote shell, while '::' & 'rsync://' usages connect\n");
654 rprintf(F,"to an rsync daemon, and require SRC or DEST to start with a module name.\n");
655 rprintf(F,"\n");
656 rprintf(F,"Options\n");
657 rprintf(F," -v, --verbose increase verbosity\n");
658 rprintf(F," --info=FLAGS fine-grained informational verbosity\n");
659 rprintf(F," --debug=FLAGS fine-grained debug verbosity\n");
660 rprintf(F," -q, --quiet suppress non-error messages\n");
661 rprintf(F," --no-motd suppress daemon-mode MOTD (see manpage caveat)\n");
662 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
663 rprintf(F," -a, --archive archive mode; equals -rlptgoD (no -H,-A,-X)\n");
664 rprintf(F," --no-OPTION turn off an implied OPTION (e.g. --no-D)\n");
665 rprintf(F," -r, --recursive recurse into directories\n");
666 rprintf(F," -R, --relative use relative path names\n");
667 rprintf(F," --no-implied-dirs don't send implied dirs with --relative\n");
668 rprintf(F," -b, --backup make backups (see --suffix & --backup-dir)\n");
669 rprintf(F," --backup-dir=DIR make backups into hierarchy based in DIR\n");
670 rprintf(F," --suffix=SUFFIX set backup suffix (default %s w/o --backup-dir)\n",BACKUP_SUFFIX);
671 rprintf(F," -u, --update skip files that are newer on the receiver\n");
672 rprintf(F," --inplace update destination files in-place (SEE MAN PAGE)\n");
673 rprintf(F," --append append data onto shorter files\n");
674 rprintf(F," --append-verify like --append, but with old data in file checksum\n");
675 rprintf(F," -d, --dirs transfer directories without recursing\n");
676 rprintf(F," -l, --links copy symlinks as symlinks\n");
677 rprintf(F," -L, --copy-links transform symlink into referent file/dir\n");
678 rprintf(F," --copy-unsafe-links only \"unsafe\" symlinks are transformed\n");
679 rprintf(F," --safe-links ignore symlinks that point outside the source tree\n");
680 rprintf(F," --munge-links munge symlinks to make them safer (but unusable)\n");
681 rprintf(F," -k, --copy-dirlinks transform symlink to a dir into referent dir\n");
682 rprintf(F," -K, --keep-dirlinks treat symlinked dir on receiver as dir\n");
683 rprintf(F," -H, --hard-links preserve hard links\n");
684 rprintf(F," -p, --perms preserve permissions\n");
685 rprintf(F," -E, --executability preserve the file's executability\n");
686 rprintf(F," --chmod=CHMOD affect file and/or directory permissions\n");
687#ifdef SUPPORT_ACLS
688 rprintf(F," -A, --acls preserve ACLs (implies --perms)\n");
689#endif
690#ifdef SUPPORT_XATTRS
691 rprintf(F," -X, --xattrs preserve extended attributes\n");
692#endif
693 rprintf(F," -o, --owner preserve owner (super-user only)\n");
694 rprintf(F," -g, --group preserve group\n");
695 rprintf(F," --devices preserve device files (super-user only)\n");
696 rprintf(F," --specials preserve special files\n");
697 rprintf(F," -D same as --devices --specials\n");
698 rprintf(F," -t, --times preserve modification times\n");
699 rprintf(F," -O, --omit-dir-times omit directories from --times\n");
700 rprintf(F," --super receiver attempts super-user activities\n");
701#ifdef SUPPORT_XATTRS
702 rprintf(F," --fake-super store/recover privileged attrs using xattrs\n");
703#endif
704 rprintf(F," -S, --sparse handle sparse files efficiently\n");
705 rprintf(F," -n, --dry-run perform a trial run with no changes made\n");
706 rprintf(F," -W, --whole-file copy files whole (without delta-xfer algorithm)\n");
707 rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n");
708 rprintf(F," -B, --block-size=SIZE force a fixed checksum block-size\n");
709 rprintf(F," -e, --rsh=COMMAND specify the remote shell to use\n");
710 rprintf(F," --rsync-path=PROGRAM specify the rsync to run on the remote machine\n");
711 rprintf(F," --existing skip creating new files on receiver\n");
712 rprintf(F," --ignore-existing skip updating files that already exist on receiver\n");
713 rprintf(F," --remove-source-files sender removes synchronized files (non-dirs)\n");
714 rprintf(F," --del an alias for --delete-during\n");
715 rprintf(F," --delete delete extraneous files from destination dirs\n");
716 rprintf(F," --delete-before receiver deletes before transfer, not during\n");
717 rprintf(F," --delete-during receiver deletes during transfer (default)\n");
718 rprintf(F," --delete-delay find deletions during, delete after\n");
719 rprintf(F," --delete-after receiver deletes after transfer, not during\n");
720 rprintf(F," --delete-excluded also delete excluded files from destination dirs\n");
721 rprintf(F," --ignore-errors delete even if there are I/O errors\n");
722 rprintf(F," --force force deletion of directories even if not empty\n");
723 rprintf(F," --max-delete=NUM don't delete more than NUM files\n");
724 rprintf(F," --max-size=SIZE don't transfer any file larger than SIZE\n");
725 rprintf(F," --min-size=SIZE don't transfer any file smaller than SIZE\n");
726 rprintf(F," --partial keep partially transferred files\n");
727 rprintf(F," --partial-dir=DIR put a partially transferred file into DIR\n");
728 rprintf(F," --delay-updates put all updated files into place at transfer's end\n");
729 rprintf(F," -m, --prune-empty-dirs prune empty directory chains from the file-list\n");
730 rprintf(F," --numeric-ids don't map uid/gid values by user/group name\n");
731 rprintf(F," --usermap=STRING custom username mapping\n");
732 rprintf(F," --groupmap=STRING custom groupname mapping\n");
733 rprintf(F," --chown=USER:GROUP simple username/groupname mapping\n");
734 rprintf(F," --timeout=SECONDS set I/O timeout in seconds\n");
735 rprintf(F," --contimeout=SECONDS set daemon connection timeout in seconds\n");
736 rprintf(F," -I, --ignore-times don't skip files that match in size and mod-time\n");
737 rprintf(F," -M, --remote-option=OPTION send OPTION to the remote side only\n");
738 rprintf(F," --size-only skip files that match in size\n");
739 rprintf(F," --modify-window=NUM compare mod-times with reduced accuracy\n");
740 rprintf(F," -T, --temp-dir=DIR create temporary files in directory DIR\n");
741 rprintf(F," -y, --fuzzy find similar file for basis if no dest file\n");
742 rprintf(F," --compare-dest=DIR also compare destination files relative to DIR\n");
743 rprintf(F," --copy-dest=DIR ... and include copies of unchanged files\n");
744 rprintf(F," --link-dest=DIR hardlink to files in DIR when unchanged\n");
745 rprintf(F," -z, --compress compress file data during the transfer\n");
746 rprintf(F," --compress-level=NUM explicitly set compression level\n");
747 rprintf(F," --skip-compress=LIST skip compressing files with a suffix in LIST\n");
748 rprintf(F," -C, --cvs-exclude auto-ignore files the same way CVS does\n");
749 rprintf(F," -f, --filter=RULE add a file-filtering RULE\n");
750 rprintf(F," -F same as --filter='dir-merge /.rsync-filter'\n");
751 rprintf(F," repeated: --filter='- .rsync-filter'\n");
752 rprintf(F," --exclude=PATTERN exclude files matching PATTERN\n");
753 rprintf(F," --exclude-from=FILE read exclude patterns from FILE\n");
754 rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n");
755 rprintf(F," --include-from=FILE read include patterns from FILE\n");
756 rprintf(F," --files-from=FILE read list of source-file names from FILE\n");
757 rprintf(F," -0, --from0 all *-from/filter files are delimited by 0s\n");
758 rprintf(F," -s, --protect-args no space-splitting; only wildcard special-chars\n");
759 rprintf(F," --address=ADDRESS bind address for outgoing socket to daemon\n");
760 rprintf(F," --port=PORT specify double-colon alternate port number\n");
761 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
762 rprintf(F," --blocking-io use blocking I/O for the remote shell\n");
763 rprintf(F," --stats give some file-transfer stats\n");
764 rprintf(F," -8, --8-bit-output leave high-bit chars unescaped in output\n");
765 rprintf(F," -h, --human-readable output numbers in a human-readable format\n");
766 rprintf(F," --progress show progress during transfer\n");
767 rprintf(F," -P same as --partial --progress\n");
768 rprintf(F," -i, --itemize-changes output a change-summary for all updates\n");
769 rprintf(F," --out-format=FORMAT output updates using the specified FORMAT\n");
770 rprintf(F," --log-file=FILE log what we're doing to the specified FILE\n");
771 rprintf(F," --log-file-format=FMT log updates using the specified FMT\n");
772 rprintf(F," --password-file=FILE read daemon-access password from FILE\n");
773 rprintf(F," --list-only list the files instead of copying them\n");
774 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
775 rprintf(F," --write-batch=FILE write a batched update to FILE\n");
776 rprintf(F," --only-write-batch=FILE like --write-batch but w/o updating destination\n");
777 rprintf(F," --read-batch=FILE read a batched update from FILE\n");
778 rprintf(F," --protocol=NUM force an older protocol version to be used\n");
779#ifdef ICONV_OPTION
780 rprintf(F," --iconv=CONVERT_SPEC request charset conversion of filenames\n");
781#endif
782 rprintf(F," -4, --ipv4 prefer IPv4\n");
783 rprintf(F," -6, --ipv6 prefer IPv6\n");
784 rprintf(F," --version print version number\n");
785 rprintf(F,"(-h) --help show this help (-h works with no other options)\n");
786
787 rprintf(F,"\n");
788 rprintf(F,"Use \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
789 rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
790 rprintf(F,"See http://rsync.samba.org/ for updates, bug reports, and answers\n");
791}
792
793enum {OPT_VERSION = 1000, OPT_DAEMON, OPT_SENDER, OPT_EXCLUDE, OPT_EXCLUDE_FROM,
794 OPT_FILTER, OPT_COMPARE_DEST, OPT_COPY_DEST, OPT_LINK_DEST, OPT_HELP,
795 OPT_INCLUDE, OPT_INCLUDE_FROM, OPT_MODIFY_WINDOW, OPT_MIN_SIZE, OPT_CHMOD,
796 OPT_READ_BATCH, OPT_WRITE_BATCH, OPT_ONLY_WRITE_BATCH, OPT_MAX_SIZE,
797 OPT_NO_D, OPT_APPEND, OPT_NO_ICONV, OPT_INFO, OPT_DEBUG,
798 OPT_USERMAP, OPT_GROUPMAP, OPT_CHOWN,
799 OPT_SERVER, OPT_REFUSED_BASE = 9000};
800
801static struct poptOption long_options[] = {
802 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
803 {"help", 0, POPT_ARG_NONE, 0, OPT_HELP, 0, 0 },
804 {"version", 0, POPT_ARG_NONE, 0, OPT_VERSION, 0, 0},
805 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
806 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
807 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
808 {"info", 0, POPT_ARG_STRING, 0, OPT_INFO, 0, 0 },
809 {"debug", 0, POPT_ARG_STRING, 0, OPT_DEBUG, 0, 0 },
810 {"msgs2stderr", 0, POPT_ARG_NONE, &msgs2stderr, 0, 0, 0 },
811 {"quiet", 'q', POPT_ARG_NONE, 0, 'q', 0, 0 },
812 {"motd", 0, POPT_ARG_VAL, &output_motd, 1, 0, 0 },
813 {"no-motd", 0, POPT_ARG_VAL, &output_motd, 0, 0, 0 },
814 {"stats", 0, POPT_ARG_NONE, &do_stats, 0, 0, 0 },
815 {"human-readable", 'h', POPT_ARG_NONE, 0, 'h', 0, 0},
816 {"no-human-readable",0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
817 {"no-h", 0, POPT_ARG_VAL, &human_readable, 0, 0, 0},
818 {"dry-run", 'n', POPT_ARG_NONE, &dry_run, 0, 0, 0 },
819 {"archive", 'a', POPT_ARG_NONE, 0, 'a', 0, 0 },
820 {"recursive", 'r', POPT_ARG_VAL, &recurse, 2, 0, 0 },
821 {"no-recursive", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
822 {"no-r", 0, POPT_ARG_VAL, &recurse, 0, 0, 0 },
823 {"inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
824 {"no-inc-recursive", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
825 {"i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 1, 0, 0 },
826 {"no-i-r", 0, POPT_ARG_VAL, &allow_inc_recurse, 0, 0, 0 },
827 {"dirs", 'd', POPT_ARG_VAL, &xfer_dirs, 2, 0, 0 },
828 {"no-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
829 {"no-d", 0, POPT_ARG_VAL, &xfer_dirs, 0, 0, 0 },
830 {"old-dirs", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
831 {"old-d", 0, POPT_ARG_VAL, &xfer_dirs, 4, 0, 0 },
832 {"perms", 'p', POPT_ARG_VAL, &preserve_perms, 1, 0, 0 },
833 {"no-perms", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
834 {"no-p", 0, POPT_ARG_VAL, &preserve_perms, 0, 0, 0 },
835 {"executability", 'E', POPT_ARG_NONE, &preserve_executability, 0, 0, 0 },
836 {"acls", 'A', POPT_ARG_NONE, 0, 'A', 0, 0 },
837 {"no-acls", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
838 {"no-A", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
839 {"xattrs", 'X', POPT_ARG_NONE, 0, 'X', 0, 0 },
840 {"no-xattrs", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
841 {"no-X", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
842 {"times", 't', POPT_ARG_VAL, &preserve_times, 2, 0, 0 },
843 {"no-times", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
844 {"no-t", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
845 {"omit-dir-times", 'O', POPT_ARG_VAL, &omit_dir_times, 1, 0, 0 },
846 {"no-omit-dir-times",0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
847 {"no-O", 0, POPT_ARG_VAL, &omit_dir_times, 0, 0, 0 },
848 {"modify-window", 0, POPT_ARG_INT, &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
849 {"super", 0, POPT_ARG_VAL, &am_root, 2, 0, 0 },
850 {"no-super", 0, POPT_ARG_VAL, &am_root, 0, 0, 0 },
851 {"fake-super", 0, POPT_ARG_VAL, &am_root, -1, 0, 0 },
852 {"owner", 'o', POPT_ARG_VAL, &preserve_uid, 1, 0, 0 },
853 {"no-owner", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
854 {"no-o", 0, POPT_ARG_VAL, &preserve_uid, 0, 0, 0 },
855 {"group", 'g', POPT_ARG_VAL, &preserve_gid, 1, 0, 0 },
856 {"no-group", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
857 {"no-g", 0, POPT_ARG_VAL, &preserve_gid, 0, 0, 0 },
858 {0, 'D', POPT_ARG_NONE, 0, 'D', 0, 0 },
859 {"no-D", 0, POPT_ARG_NONE, 0, OPT_NO_D, 0, 0 },
860 {"devices", 0, POPT_ARG_VAL, &preserve_devices, 1, 0, 0 },
861 {"no-devices", 0, POPT_ARG_VAL, &preserve_devices, 0, 0, 0 },
862 {"specials", 0, POPT_ARG_VAL, &preserve_specials, 1, 0, 0 },
863 {"no-specials", 0, POPT_ARG_VAL, &preserve_specials, 0, 0, 0 },
864 {"links", 'l', POPT_ARG_VAL, &preserve_links, 1, 0, 0 },
865 {"no-links", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
866 {"no-l", 0, POPT_ARG_VAL, &preserve_links, 0, 0, 0 },
867 {"copy-links", 'L', POPT_ARG_NONE, &copy_links, 0, 0, 0 },
868 {"copy-unsafe-links",0, POPT_ARG_NONE, &copy_unsafe_links, 0, 0, 0 },
869 {"safe-links", 0, POPT_ARG_NONE, &safe_symlinks, 0, 0, 0 },
870 {"munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 1, 0, 0 },
871 {"no-munge-links", 0, POPT_ARG_VAL, &munge_symlinks, 0, 0, 0 },
872 {"copy-dirlinks", 'k', POPT_ARG_NONE, &copy_dirlinks, 0, 0, 0 },
873 {"keep-dirlinks", 'K', POPT_ARG_NONE, &keep_dirlinks, 0, 0, 0 },
874 {"hard-links", 'H', POPT_ARG_NONE, 0, 'H', 0, 0 },
875 {"no-hard-links", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
876 {"no-H", 0, POPT_ARG_VAL, &preserve_hard_links, 0, 0, 0 },
877 {"relative", 'R', POPT_ARG_VAL, &relative_paths, 1, 0, 0 },
878 {"no-relative", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
879 {"no-R", 0, POPT_ARG_VAL, &relative_paths, 0, 0, 0 },
880 {"implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
881 {"no-implied-dirs", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
882 {"i-d", 0, POPT_ARG_VAL, &implied_dirs, 1, 0, 0 },
883 {"no-i-d", 0, POPT_ARG_VAL, &implied_dirs, 0, 0, 0 },
884 {"chmod", 0, POPT_ARG_STRING, 0, OPT_CHMOD, 0, 0 },
885 {"ignore-times", 'I', POPT_ARG_NONE, &ignore_times, 0, 0, 0 },
886 {"size-only", 0, POPT_ARG_NONE, &size_only, 0, 0, 0 },
887 {"one-file-system", 'x', POPT_ARG_NONE, 0, 'x', 0, 0 },
888 {"no-one-file-system",'x',POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
889 {"no-x", 'x', POPT_ARG_VAL, &one_file_system, 0, 0, 0 },
890 {"update", 'u', POPT_ARG_NONE, &update_only, 0, 0, 0 },
891 {"existing", 0, POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
892 {"ignore-non-existing",0,POPT_ARG_NONE, &ignore_non_existing, 0, 0, 0 },
893 {"ignore-existing", 0, POPT_ARG_NONE, &ignore_existing, 0, 0, 0 },
894 {"max-size", 0, POPT_ARG_STRING, &max_size_arg, OPT_MAX_SIZE, 0, 0 },
895 {"min-size", 0, POPT_ARG_STRING, &min_size_arg, OPT_MIN_SIZE, 0, 0 },
896 {"sparse", 'S', POPT_ARG_VAL, &sparse_files, 1, 0, 0 },
897 {"no-sparse", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
898 {"no-S", 0, POPT_ARG_VAL, &sparse_files, 0, 0, 0 },
899 {"inplace", 0, POPT_ARG_VAL, &inplace, 1, 0, 0 },
900 {"no-inplace", 0, POPT_ARG_VAL, &inplace, 0, 0, 0 },
901 {"append", 0, POPT_ARG_NONE, 0, OPT_APPEND, 0, 0 },
902 {"append-verify", 0, POPT_ARG_VAL, &append_mode, 2, 0, 0 },
903 {"no-append", 0, POPT_ARG_VAL, &append_mode, 0, 0, 0 },
904 {"del", 0, POPT_ARG_NONE, &delete_during, 0, 0, 0 },
905 {"delete", 0, POPT_ARG_NONE, &delete_mode, 0, 0, 0 },
906 {"delete-before", 0, POPT_ARG_NONE, &delete_before, 0, 0, 0 },
907 {"delete-during", 0, POPT_ARG_VAL, &delete_during, 1, 0, 0 },
908 {"delete-delay", 0, POPT_ARG_VAL, &delete_during, 2, 0, 0 },
909 {"delete-after", 0, POPT_ARG_NONE, &delete_after, 0, 0, 0 },
910 {"delete-excluded", 0, POPT_ARG_NONE, &delete_excluded, 0, 0, 0 },
911 {"remove-sent-files",0, POPT_ARG_VAL, &remove_source_files, 2, 0, 0 }, /* deprecated */
912 {"remove-source-files",0,POPT_ARG_VAL, &remove_source_files, 1, 0, 0 },
913 {"force", 0, POPT_ARG_VAL, &force_delete, 1, 0, 0 },
914 {"no-force", 0, POPT_ARG_VAL, &force_delete, 0, 0, 0 },
915 {"ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 1, 0, 0 },
916 {"no-ignore-errors", 0, POPT_ARG_VAL, &ignore_errors, 0, 0, 0 },
917 {"max-delete", 0, POPT_ARG_INT, &max_delete, 0, 0, 0 },
918 {0, 'F', POPT_ARG_NONE, 0, 'F', 0, 0 },
919 {"filter", 'f', POPT_ARG_STRING, 0, OPT_FILTER, 0, 0 },
920 {"exclude", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE, 0, 0 },
921 {"include", 0, POPT_ARG_STRING, 0, OPT_INCLUDE, 0, 0 },
922 {"exclude-from", 0, POPT_ARG_STRING, 0, OPT_EXCLUDE_FROM, 0, 0 },
923 {"include-from", 0, POPT_ARG_STRING, 0, OPT_INCLUDE_FROM, 0, 0 },
924 {"cvs-exclude", 'C', POPT_ARG_NONE, &cvs_exclude, 0, 0, 0 },
925 {"whole-file", 'W', POPT_ARG_VAL, &whole_file, 1, 0, 0 },
926 {"no-whole-file", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
927 {"no-W", 0, POPT_ARG_VAL, &whole_file, 0, 0, 0 },
928 {"checksum", 'c', POPT_ARG_VAL, &always_checksum, 1, 0, 0 },
929 {"no-checksum", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
930 {"no-c", 0, POPT_ARG_VAL, &always_checksum, 0, 0, 0 },
931 {"block-size", 'B', POPT_ARG_LONG, &block_size, 0, 0, 0 },
932 {"compare-dest", 0, POPT_ARG_STRING, 0, OPT_COMPARE_DEST, 0, 0 },
933 {"copy-dest", 0, POPT_ARG_STRING, 0, OPT_COPY_DEST, 0, 0 },
934 {"link-dest", 0, POPT_ARG_STRING, 0, OPT_LINK_DEST, 0, 0 },
935 {"fuzzy", 'y', POPT_ARG_VAL, &fuzzy_basis, 1, 0, 0 },
936 {"no-fuzzy", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
937 {"no-y", 0, POPT_ARG_VAL, &fuzzy_basis, 0, 0, 0 },
938 {"compress", 'z', POPT_ARG_NONE, 0, 'z', 0, 0 },
939 {"no-compress", 0, POPT_ARG_VAL, &do_compression, 0, 0, 0 },
940 {"no-z", 0, POPT_ARG_VAL, &do_compression, 0, 0, 0 },
941 {"skip-compress", 0, POPT_ARG_STRING, &skip_compress, 0, 0, 0 },
942 {"compress-level", 0, POPT_ARG_INT, &def_compress_level, 'z', 0, 0 },
943 {0, 'P', POPT_ARG_NONE, 0, 'P', 0, 0 },
944 {"progress", 0, POPT_ARG_VAL, &do_progress, 1, 0, 0 },
945 {"no-progress", 0, POPT_ARG_VAL, &do_progress, 0, 0, 0 },
946 {"partial", 0, POPT_ARG_VAL, &keep_partial, 1, 0, 0 },
947 {"no-partial", 0, POPT_ARG_VAL, &keep_partial, 0, 0, 0 },
948 {"partial-dir", 0, POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
949 {"delay-updates", 0, POPT_ARG_VAL, &delay_updates, 1, 0, 0 },
950 {"no-delay-updates", 0, POPT_ARG_VAL, &delay_updates, 0, 0, 0 },
951 {"prune-empty-dirs",'m', POPT_ARG_VAL, &prune_empty_dirs, 1, 0, 0 },
952 {"no-prune-empty-dirs",0,POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
953 {"no-m", 0, POPT_ARG_VAL, &prune_empty_dirs, 0, 0, 0 },
954 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
955 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
956 {"out-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 },
957 {"log-format", 0, POPT_ARG_STRING, &stdout_format, 0, 0, 0 }, /* DEPRECATED */
958 {"itemize-changes", 'i', POPT_ARG_NONE, 0, 'i', 0, 0 },
959 {"no-itemize-changes",0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
960 {"no-i", 0, POPT_ARG_VAL, &itemize_changes, 0, 0, 0 },
961 {"bwlimit", 0, POPT_ARG_INT, &bwlimit, 0, 0, 0 },
962 {"no-bwlimit", 0, POPT_ARG_VAL, &bwlimit, 0, 0, 0 },
963 {"backup", 'b', POPT_ARG_VAL, &make_backups, 1, 0, 0 },
964 {"no-backup", 0, POPT_ARG_VAL, &make_backups, 0, 0, 0 },
965 {"backup-dir", 0, POPT_ARG_STRING, &backup_dir, 0, 0, 0 },
966 {"suffix", 0, POPT_ARG_STRING, &backup_suffix, 0, 0, 0 },
967 {"list-only", 0, POPT_ARG_VAL, &list_only, 2, 0, 0 },
968 {"read-batch", 0, POPT_ARG_STRING, &batch_name, OPT_READ_BATCH, 0, 0 },
969 {"write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_WRITE_BATCH, 0, 0 },
970 {"only-write-batch", 0, POPT_ARG_STRING, &batch_name, OPT_ONLY_WRITE_BATCH, 0, 0 },
971 {"files-from", 0, POPT_ARG_STRING, &files_from, 0, 0, 0 },
972 {"from0", '0', POPT_ARG_VAL, &eol_nulls, 1, 0, 0},
973 {"no-from0", 0, POPT_ARG_VAL, &eol_nulls, 0, 0, 0},
974 {"protect-args", 's', POPT_ARG_VAL, &protect_args, 1, 0, 0},
975 {"no-protect-args", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
976 {"no-s", 0, POPT_ARG_VAL, &protect_args, 0, 0, 0},
977 {"numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 1, 0, 0 },
978 {"no-numeric-ids", 0, POPT_ARG_VAL, &numeric_ids, 0, 0, 0 },
979 {"usermap", 0, POPT_ARG_STRING, 0, OPT_USERMAP, 0, 0 },
980 {"groupmap", 0, POPT_ARG_STRING, 0, OPT_GROUPMAP, 0, 0 },
981 {"chown", 0, POPT_ARG_STRING, 0, OPT_CHOWN, 0, 0 },
982 {"timeout", 0, POPT_ARG_INT, &io_timeout, 0, 0, 0 },
983 {"no-timeout", 0, POPT_ARG_VAL, &io_timeout, 0, 0, 0 },
984 {"contimeout", 0, POPT_ARG_INT, &connect_timeout, 0, 0, 0 },
985 {"no-contimeout", 0, POPT_ARG_VAL, &connect_timeout, 0, 0, 0 },
986 {"rsh", 'e', POPT_ARG_STRING, &shell_cmd, 0, 0, 0 },
987 {"rsync-path", 0, POPT_ARG_STRING, &rsync_path, 0, 0, 0 },
988 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
989#ifdef ICONV_OPTION
990 {"iconv", 0, POPT_ARG_STRING, &iconv_opt, 0, 0, 0 },
991 {"no-iconv", 0, POPT_ARG_NONE, 0, OPT_NO_ICONV, 0, 0 },
992#endif
993 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
994 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
995 {"8-bit-output", '8', POPT_ARG_VAL, &allow_8bit_chars, 1, 0, 0 },
996 {"no-8-bit-output", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
997 {"no-8", 0, POPT_ARG_VAL, &allow_8bit_chars, 0, 0, 0 },
998 {"qsort", 0, POPT_ARG_NONE, &use_qsort, 0, 0, 0 },
999 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
1000 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
1001 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
1002 {"password-file", 0, POPT_ARG_STRING, &password_file, 0, 0, 0 },
1003 {"blocking-io", 0, POPT_ARG_VAL, &blocking_io, 1, 0, 0 },
1004 {"no-blocking-io", 0, POPT_ARG_VAL, &blocking_io, 0, 0, 0 },
1005 {"remote-option", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
1006 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
1007 {"checksum-seed", 0, POPT_ARG_INT, &checksum_seed, 0, 0, 0 },
1008 {"server", 0, POPT_ARG_NONE, 0, OPT_SERVER, 0, 0 },
1009 {"sender", 0, POPT_ARG_NONE, 0, OPT_SENDER, 0, 0 },
1010 /* All the following options switch us into daemon-mode option-parsing. */
1011 {"config", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
1012 {"daemon", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1013 {"dparam", 0, POPT_ARG_STRING, 0, OPT_DAEMON, 0, 0 },
1014 {"detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1015 {"no-detach", 0, POPT_ARG_NONE, 0, OPT_DAEMON, 0, 0 },
1016 {0,0,0,0, 0, 0, 0}
1017};
1018
1019static void daemon_usage(enum logcode F)
1020{
1021 print_rsync_version(F);
1022
1023 rprintf(F,"\n");
1024 rprintf(F,"Usage: rsync --daemon [OPTION]...\n");
1025 rprintf(F," --address=ADDRESS bind to the specified address\n");
1026 rprintf(F," --bwlimit=KBPS limit I/O bandwidth; KBytes per second\n");
1027 rprintf(F," --config=FILE specify alternate rsyncd.conf file\n");
1028 rprintf(F," -M, --dparam=OVERRIDE override global daemon config parameter\n");
1029 rprintf(F," --no-detach do not detach from the parent\n");
1030 rprintf(F," --port=PORT listen on alternate port number\n");
1031 rprintf(F," --log-file=FILE override the \"log file\" setting\n");
1032 rprintf(F," --log-file-format=FMT override the \"log format\" setting\n");
1033 rprintf(F," --sockopts=OPTIONS specify custom TCP options\n");
1034 rprintf(F," -v, --verbose increase verbosity\n");
1035 rprintf(F," -4, --ipv4 prefer IPv4\n");
1036 rprintf(F," -6, --ipv6 prefer IPv6\n");
1037 rprintf(F," --help show this help screen\n");
1038
1039 rprintf(F,"\n");
1040 rprintf(F,"If you were not trying to invoke rsync as a daemon, avoid using any of the\n");
1041 rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
1042}
1043
1044static struct poptOption long_daemon_options[] = {
1045 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
1046 {"address", 0, POPT_ARG_STRING, &bind_address, 0, 0, 0 },
1047 {"bwlimit", 0, POPT_ARG_INT, &daemon_bwlimit, 0, 0, 0 },
1048 {"config", 0, POPT_ARG_STRING, &config_file, 0, 0, 0 },
1049 {"daemon", 0, POPT_ARG_NONE, &daemon_opt, 0, 0, 0 },
1050 {"dparam", 'M', POPT_ARG_STRING, 0, 'M', 0, 0 },
1051 {"ipv4", '4', POPT_ARG_VAL, &default_af_hint, AF_INET, 0, 0 },
1052 {"ipv6", '6', POPT_ARG_VAL, &default_af_hint, AF_INET6, 0, 0 },
1053 {"detach", 0, POPT_ARG_VAL, &no_detach, 0, 0, 0 },
1054 {"no-detach", 0, POPT_ARG_VAL, &no_detach, 1, 0, 0 },
1055 {"log-file", 0, POPT_ARG_STRING, &logfile_name, 0, 0, 0 },
1056 {"log-file-format", 0, POPT_ARG_STRING, &logfile_format, 0, 0, 0 },
1057 {"port", 0, POPT_ARG_INT, &rsync_port, 0, 0, 0 },
1058 {"sockopts", 0, POPT_ARG_STRING, &sockopts, 0, 0, 0 },
1059 {"protocol", 0, POPT_ARG_INT, &protocol_version, 0, 0, 0 },
1060 {"server", 0, POPT_ARG_NONE, &am_server, 0, 0, 0 },
1061 {"temp-dir", 'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
1062 {"verbose", 'v', POPT_ARG_NONE, 0, 'v', 0, 0 },
1063 {"no-verbose", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1064 {"no-v", 0, POPT_ARG_VAL, &verbose, 0, 0, 0 },
1065 {"help", 'h', POPT_ARG_NONE, 0, 'h', 0, 0 },
1066 {0,0,0,0, 0, 0, 0}
1067};
1068
1069
1070static char err_buf[200];
1071
1072
1073/**
1074 * Store the option error message, if any, so that we can log the
1075 * connection attempt (which requires parsing the options), and then
1076 * show the error later on.
1077 **/
1078void option_error(void)
1079{
1080 if (!err_buf[0]) {
1081 strlcpy(err_buf, "Error parsing options: option may "
1082 "be supported on client but not on server?\n",
1083 sizeof err_buf);
1084 }
1085
1086 rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
1087 msleep(20);
1088}
1089
1090
1091/**
1092 * Tweak the option table to disable all options that the rsyncd.conf
1093 * file has told us to refuse.
1094 **/
1095static void set_refuse_options(char *bp)
1096{
1097 struct poptOption *op;
1098 char *cp, shortname[2];
1099 int is_wild, found_match;
1100
1101 shortname[1] = '\0';
1102
1103 while (1) {
1104 while (*bp == ' ') bp++;
1105 if (!*bp)
1106 break;
1107 if ((cp = strchr(bp, ' ')) != NULL)
1108 *cp= '\0';
1109 is_wild = strpbrk(bp, "*?[") != NULL;
1110 found_match = 0;
1111 for (op = long_options; ; op++) {
1112 *shortname = op->shortName;
1113 if (!op->longName && !*shortname)
1114 break;
1115 if ((op->longName && wildmatch(bp, op->longName))
1116 || (*shortname && wildmatch(bp, shortname))) {
1117 if (op->argInfo == POPT_ARG_VAL)
1118 op->argInfo = POPT_ARG_NONE;
1119 op->val = (op - long_options) + OPT_REFUSED_BASE;
1120 found_match = 1;
1121 /* These flags are set to let us easily check
1122 * an implied option later in the code. */
1123 switch (*shortname) {
1124 case 'r': case 'd': case 'l': case 'p':
1125 case 't': case 'g': case 'o': case 'D':
1126 refused_archive_part = op->val;
1127 break;
1128 case 'z':
1129 refused_compress = op->val;
1130 break;
1131 case '\0':
1132 if (wildmatch("delete", op->longName))
1133 refused_delete = op->val;
1134 else if (wildmatch("delete-before", op->longName))
1135 refused_delete_before = op->val;
1136 else if (wildmatch("delete-during", op->longName))
1137 refused_delete_during = op->val;
1138 else if (wildmatch("partial", op->longName))
1139 refused_partial = op->val;
1140 else if (wildmatch("progress", op->longName))
1141 refused_progress = op->val;
1142 else if (wildmatch("inplace", op->longName))
1143 refused_inplace = op->val;
1144 else if (wildmatch("no-iconv", op->longName))
1145 refused_no_iconv = op->val;
1146 break;
1147 }
1148 if (!is_wild)
1149 break;
1150 }
1151 }
1152 if (!found_match) {
1153 rprintf(FLOG, "No match for refuse-options string \"%s\"\n",
1154 bp);
1155 }
1156 if (!cp)
1157 break;
1158 *cp = ' ';
1159 bp = cp + 1;
1160 }
1161}
1162
1163
1164static int count_args(const char **argv)
1165{
1166 int i = 0;
1167
1168 if (argv) {
1169 while (argv[i] != NULL)
1170 i++;
1171 }
1172
1173 return i;
1174}
1175
1176
1177static OFF_T parse_size_arg(char **size_arg, char def_suf)
1178{
1179 int reps, mult, make_compatible = 0;
1180 const char *arg;
1181 OFF_T size = 1;
1182
1183 for (arg = *size_arg; isDigit(arg); arg++) {}
1184 if (*arg == '.')
1185 for (arg++; isDigit(arg); arg++) {}
1186 switch (*arg && *arg != '+' && *arg != '-' ? *arg++ : def_suf) {
1187 case 'b': case 'B':
1188 reps = 0;
1189 break;
1190 case 'k': case 'K':
1191 reps = 1;
1192 break;
1193 case 'm': case 'M':
1194 reps = 2;
1195 break;
1196 case 'g': case 'G':
1197 reps = 3;
1198 break;
1199 default:
1200 return -1;
1201 }
1202 if (*arg == 'b' || *arg == 'B')
1203 mult = 1000, make_compatible = 1, arg++;
1204 else if (!*arg || *arg == '+' || *arg == '-')
1205 mult = 1024;
1206 else if (strncasecmp(arg, "ib", 2) == 0)
1207 mult = 1024, arg += 2;
1208 else
1209 return -1;
1210 while (reps--)
1211 size *= mult;
1212 size *= atof(*size_arg);
1213 if ((*arg == '+' || *arg == '-') && arg[1] == '1')
1214 size += atoi(arg), make_compatible = 1, arg += 2;
1215 if (*arg)
1216 return -1;
1217 if (size > 0 && make_compatible) {
1218 /* We convert this manually because we may need %lld precision,
1219 * and that's not a portable sprintf() escape. */
1220 char buf[128], *s = buf + sizeof buf - 1;
1221 OFF_T num = size;
1222 *s = '\0';
1223 while (num) {
1224 *--s = (char)(num % 10) + '0';
1225 num /= 10;
1226 }
1227 if (!(*size_arg = strdup(s)))
1228 out_of_memory("parse_size_arg");
1229 }
1230 return size;
1231}
1232
1233
1234static void create_refuse_error(int which)
1235{
1236 /* The "which" value is the index + OPT_REFUSED_BASE. */
1237 struct poptOption *op = &long_options[which - OPT_REFUSED_BASE];
1238 int n = snprintf(err_buf, sizeof err_buf,
1239 "The server is configured to refuse --%s\n",
1240 op->longName) - 1;
1241 if (op->shortName) {
1242 snprintf(err_buf + n, sizeof err_buf - n,
1243 " (-%c)\n", op->shortName);
1244 }
1245}
1246
1247
1248/**
1249 * Process command line arguments. Called on both local and remote.
1250 *
1251 * @retval 1 if all options are OK; with globals set to appropriate
1252 * values
1253 *
1254 * @retval 0 on error, with err_buf containing an explanation
1255 **/
1256int parse_arguments(int *argc_p, const char ***argv_p)
1257{
1258 static poptContext pc;
1259 char *ref = lp_refuse_options(module_id);
1260 const char *arg, **argv = *argv_p;
1261 int argc = *argc_p;
1262 int opt;
1263
1264 if (ref && *ref)
1265 set_refuse_options(ref);
1266 if (am_daemon) {
1267 set_refuse_options("log-file*");
1268#ifdef ICONV_OPTION
1269 if (!*lp_charset(module_id))
1270 set_refuse_options("iconv");
1271#endif
1272 }
1273
1274#ifdef ICONV_OPTION
1275 if (!am_daemon && !protect_args && (arg = getenv("RSYNC_ICONV")) != NULL && *arg)
1276 iconv_opt = strdup(arg);
1277#endif
1278
1279 /* TODO: Call poptReadDefaultConfig; handle errors. */
1280
1281 /* The context leaks in case of an error, but if there's a
1282 * problem we always exit anyhow. */
1283 if (pc)
1284 poptFreeContext(pc);
1285 pc = poptGetContext(RSYNC_NAME, argc, argv, long_options, 0);
1286 if (!am_server)
1287 poptReadDefaultConfig(pc, 0);
1288
1289 while ((opt = poptGetNextOpt(pc)) != -1) {
1290 /* most options are handled automatically by popt;
1291 * only special cases are returned and listed here. */
1292
1293 switch (opt) {
1294 case OPT_VERSION:
1295 print_rsync_version(FINFO);
1296 exit_cleanup(0);
1297
1298 case OPT_SERVER:
1299 if (!am_server) {
1300 /* Disable popt aliases on the server side and
1301 * then start parsing the options again. */
1302 poptFreeContext(pc);
1303 pc = poptGetContext(RSYNC_NAME, argc, argv,
1304 long_options, 0);
1305 am_server = 1;
1306 }
1307#ifdef ICONV_OPTION
1308 iconv_opt = NULL;
1309#endif
1310 break;
1311
1312 case OPT_SENDER:
1313 if (!am_server) {
1314 usage(FERROR);
1315 exit_cleanup(RERR_SYNTAX);
1316 }
1317 am_sender = 1;
1318 break;
1319
1320 case OPT_DAEMON:
1321 if (am_daemon) {
1322 strlcpy(err_buf,
1323 "Attempt to hack rsync thwarted!\n",
1324 sizeof err_buf);
1325 return 0;
1326 }
1327#ifdef ICONV_OPTION
1328 iconv_opt = NULL;
1329#endif
1330 poptFreeContext(pc);
1331 pc = poptGetContext(RSYNC_NAME, argc, argv,
1332 long_daemon_options, 0);
1333 while ((opt = poptGetNextOpt(pc)) != -1) {
1334 char **cpp;
1335 switch (opt) {
1336 case 'h':
1337 daemon_usage(FINFO);
1338 exit_cleanup(0);
1339
1340 case 'M':
1341 arg = poptGetOptArg(pc);
1342 if (!strchr(arg, '=')) {
1343 rprintf(FERROR,
1344 "--dparam value is missing an '=': %s\n",
1345 arg);
1346 goto daemon_error;
1347 }
1348 cpp = EXPAND_ITEM_LIST(&dparam_list, char *, 4);
1349 *cpp = strdup(arg);
1350 break;
1351
1352 case 'v':
1353 verbose++;
1354 break;
1355
1356 default:
1357 rprintf(FERROR,
1358 "rsync: %s: %s (in daemon mode)\n",
1359 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1360 poptStrerror(opt));
1361 goto daemon_error;
1362 }
1363 }
1364
1365 if (dparam_list.count && !set_dparams(1))
1366 exit_cleanup(RERR_SYNTAX);
1367
1368 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
1369 snprintf(err_buf, sizeof err_buf,
1370 "the --temp-dir path is WAY too long.\n");
1371 return 0;
1372 }
1373
1374 if (!daemon_opt) {
1375 rprintf(FERROR, "Daemon option(s) used without --daemon.\n");
1376 daemon_error:
1377 rprintf(FERROR,
1378 "(Type \"rsync --daemon --help\" for assistance with daemon mode.)\n");
1379 exit_cleanup(RERR_SYNTAX);
1380 }
1381
1382 *argv_p = argv = poptGetArgs(pc);
1383 *argc_p = argc = count_args(argv);
1384 am_starting_up = 0;
1385 daemon_opt = 0;
1386 am_daemon = 1;
1387 return 1;
1388
1389 case OPT_MODIFY_WINDOW:
1390 /* The value has already been set by popt, but
1391 * we need to remember that we're using a
1392 * non-default setting. */
1393 modify_window_set = 1;
1394 break;
1395
1396 case OPT_FILTER:
1397 parse_rule(&filter_list, poptGetOptArg(pc), 0, 0);
1398 break;
1399
1400 case OPT_EXCLUDE:
1401 parse_rule(&filter_list, poptGetOptArg(pc),
1402 0, XFLG_OLD_PREFIXES);
1403 break;
1404
1405 case OPT_INCLUDE:
1406 parse_rule(&filter_list, poptGetOptArg(pc),
1407 MATCHFLG_INCLUDE, XFLG_OLD_PREFIXES);
1408 break;
1409
1410 case OPT_EXCLUDE_FROM:
1411 case OPT_INCLUDE_FROM:
1412 arg = poptGetOptArg(pc);
1413 if (sanitize_paths)
1414 arg = sanitize_path(NULL, arg, NULL, 0, SP_DEFAULT);
1415 if (daemon_filter_list.head) {
1416 int rej;
1417 char *dir, *cp = strdup(arg);
1418 if (!cp)
1419 out_of_memory("parse_arguments");
1420 if (!*cp)
1421 goto options_rejected;
1422 dir = cp + (*cp == '/' ? module_dirlen : 0);
1423 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1424 rej = check_filter(&daemon_filter_list, FLOG, dir, 0) < 0;
1425 free(cp);
1426 if (rej)
1427 goto options_rejected;
1428 }
1429 parse_filter_file(&filter_list, arg,
1430 opt == OPT_INCLUDE_FROM ? MATCHFLG_INCLUDE : 0,
1431 XFLG_FATAL_ERRORS | XFLG_OLD_PREFIXES);
1432 break;
1433
1434 case 'a':
1435 if (refused_archive_part) {
1436 create_refuse_error(refused_archive_part);
1437 return 0;
1438 }
1439 if (!recurse) /* preserve recurse == 2 */
1440 recurse = 1;
1441#ifdef SUPPORT_LINKS
1442 preserve_links = 1;
1443#endif
1444 preserve_perms = 1;
1445 preserve_times = 2;
1446 preserve_gid = 1;
1447 preserve_uid = 1;
1448 preserve_devices = 1;
1449 preserve_specials = 1;
1450 break;
1451
1452 case 'D':
1453 preserve_devices = preserve_specials = 1;
1454 break;
1455
1456 case OPT_NO_D:
1457 preserve_devices = preserve_specials = 0;
1458 break;
1459
1460 case 'h':
1461 human_readable++;
1462 break;
1463
1464 case 'H':
1465 preserve_hard_links++;
1466 break;
1467
1468 case 'i':
1469 itemize_changes++;
1470 break;
1471
1472 case 'v':
1473 verbose++;
1474 break;
1475
1476 case 'q':
1477 quiet++;
1478 break;
1479
1480 case 'x':
1481 one_file_system++;
1482 break;
1483
1484 case 'F':
1485 switch (++F_option_cnt) {
1486 case 1:
1487 parse_rule(&filter_list,": /.rsync-filter",0,0);
1488 break;
1489 case 2:
1490 parse_rule(&filter_list,"- .rsync-filter",0,0);
1491 break;
1492 }
1493 break;
1494
1495 case 'P':
1496 if (refused_partial || refused_progress) {
1497 create_refuse_error(refused_partial
1498 ? refused_partial : refused_progress);
1499 return 0;
1500 }
1501 do_progress = 1;
1502 keep_partial = 1;
1503 break;
1504
1505 case 'z':
1506 if (def_compress_level < Z_DEFAULT_COMPRESSION
1507 || def_compress_level > Z_BEST_COMPRESSION) {
1508 snprintf(err_buf, sizeof err_buf,
1509 "--compress-level value is invalid: %d\n",
1510 def_compress_level);
1511 return 0;
1512 }
1513 do_compression = def_compress_level != Z_NO_COMPRESSION;
1514 if (do_compression && refused_compress) {
1515 create_refuse_error(refused_compress);
1516 return 0;
1517 }
1518 break;
1519
1520 case 'M':
1521 arg = poptGetOptArg(pc);
1522 if (*arg != '-') {
1523 snprintf(err_buf, sizeof err_buf,
1524 "Remote option must start with a dash: %s\n", arg);
1525 return 0;
1526 }
1527 if (remote_option_cnt+2 >= remote_option_alloc) {
1528 remote_option_alloc += 16;
1529 remote_options = realloc_array(remote_options,
1530 const char *, remote_option_alloc);
1531 if (!remote_options)
1532 out_of_memory("parse_arguments");
1533 if (!remote_option_cnt)
1534 remote_options[0] = "ARG0";
1535 }
1536 remote_options[++remote_option_cnt] = arg;
1537 remote_options[remote_option_cnt+1] = NULL;
1538 break;
1539
1540 case OPT_WRITE_BATCH:
1541 /* batch_name is already set */
1542 write_batch = 1;
1543 break;
1544
1545 case OPT_ONLY_WRITE_BATCH:
1546 /* batch_name is already set */
1547 write_batch = -1;
1548 break;
1549
1550 case OPT_READ_BATCH:
1551 /* batch_name is already set */
1552 read_batch = 1;
1553 break;
1554
1555 case OPT_NO_ICONV:
1556#ifdef ICONV_OPTION
1557 iconv_opt = NULL;
1558#endif
1559 break;
1560
1561 case OPT_MAX_SIZE:
1562 if ((max_size = parse_size_arg(&max_size_arg, 'b')) <= 0) {
1563 snprintf(err_buf, sizeof err_buf,
1564 "--max-size value is invalid: %s\n",
1565 max_size_arg);
1566 return 0;
1567 }
1568 break;
1569
1570 case OPT_MIN_SIZE:
1571 if ((min_size = parse_size_arg(&min_size_arg, 'b')) <= 0) {
1572 snprintf(err_buf, sizeof err_buf,
1573 "--min-size value is invalid: %s\n",
1574 min_size_arg);
1575 return 0;
1576 }
1577 break;
1578
1579 case OPT_APPEND:
1580 if (am_server)
1581 append_mode++;
1582 else
1583 append_mode = 1;
1584 break;
1585
1586 case OPT_LINK_DEST:
1587#ifdef SUPPORT_HARD_LINKS
1588 link_dest = 1;
1589 dest_option = "--link-dest";
1590 goto set_dest_dir;
1591#else
1592 snprintf(err_buf, sizeof err_buf,
1593 "hard links are not supported on this %s\n",
1594 am_server ? "server" : "client");
1595 return 0;
1596#endif
1597
1598 case OPT_COPY_DEST:
1599 copy_dest = 1;
1600 dest_option = "--copy-dest";
1601 goto set_dest_dir;
1602
1603 case OPT_COMPARE_DEST:
1604 compare_dest = 1;
1605 dest_option = "--compare-dest";
1606 set_dest_dir:
1607 if (basis_dir_cnt >= MAX_BASIS_DIRS) {
1608 snprintf(err_buf, sizeof err_buf,
1609 "ERROR: at most %d %s args may be specified\n",
1610 MAX_BASIS_DIRS, dest_option);
1611 return 0;
1612 }
1613 /* We defer sanitizing this arg until we know what
1614 * our destination directory is going to be. */
1615 basis_dir[basis_dir_cnt++] = (char *)poptGetOptArg(pc);
1616 break;
1617
1618 case OPT_CHMOD:
1619 arg = poptGetOptArg(pc);
1620 if (!parse_chmod(arg, &chmod_modes)) {
1621 snprintf(err_buf, sizeof err_buf,
1622 "Invalid argument passed to --chmod (%s)\n",
1623 arg);
1624 return 0;
1625 }
1626 break;
1627
1628 case OPT_INFO:
1629 arg = poptGetOptArg(pc);
1630 parse_output_words(info_words, info_levels, arg, USER_PRIORITY);
1631 break;
1632
1633 case OPT_DEBUG:
1634 arg = poptGetOptArg(pc);
1635 parse_output_words(debug_words, debug_levels, arg, USER_PRIORITY);
1636 break;
1637
1638 case OPT_USERMAP:
1639 if (usermap) {
1640 if (usermap_via_chown) {
1641 snprintf(err_buf, sizeof err_buf,
1642 "--usermap conflicts with prior --chown.\n");
1643 return 0;
1644 }
1645 snprintf(err_buf, sizeof err_buf,
1646 "You can only specify --usermap once.\n");
1647 return 0;
1648 }
1649 usermap = (char *)poptGetOptArg(pc);
1650 usermap_via_chown = False;
1651 break;
1652
1653 case OPT_GROUPMAP:
1654 if (groupmap) {
1655 if (groupmap_via_chown) {
1656 snprintf(err_buf, sizeof err_buf,
1657 "--groupmap conflicts with prior --chown.\n");
1658 return 0;
1659 }
1660 snprintf(err_buf, sizeof err_buf,
1661 "You can only specify --groupmap once.\n");
1662 return 0;
1663 }
1664 groupmap = (char *)poptGetOptArg(pc);
1665 groupmap_via_chown = False;
1666 break;
1667
1668 case OPT_CHOWN: {
1669 const char *chown = poptGetOptArg(pc);
1670 int len;
1671 if ((arg = strchr(chown, ':')) != NULL)
1672 len = arg++ - chown;
1673 else
1674 len = strlen(chown);
1675 if (len) {
1676 if (usermap) {
1677 if (!usermap_via_chown) {
1678 snprintf(err_buf, sizeof err_buf,
1679 "--chown conflicts with prior --usermap.\n");
1680 return 0;
1681 }
1682 snprintf(err_buf, sizeof err_buf,
1683 "You can only specify a user-affecting --chown once.\n");
1684 return 0;
1685 }
1686 if (asprintf(&usermap, "*:%.*s", len, chown) < 0)
1687 out_of_memory("parse_arguments");
1688 usermap_via_chown = True;
1689 }
1690 if (arg && *arg) {
1691 if (groupmap) {
1692 if (!groupmap_via_chown) {
1693 snprintf(err_buf, sizeof err_buf,
1694 "--chown conflicts with prior --groupmap.\n");
1695 return 0;
1696 }
1697 snprintf(err_buf, sizeof err_buf,
1698 "You can only specify a group-affecting --chown once.\n");
1699 return 0;
1700 }
1701 if (asprintf(&groupmap, "*:%s", arg) < 0)
1702 out_of_memory("parse_arguments");
1703 groupmap_via_chown = True;
1704 }
1705 break;
1706 }
1707
1708 case OPT_HELP:
1709 usage(FINFO);
1710 exit_cleanup(0);
1711
1712 case 'A':
1713#ifdef SUPPORT_ACLS
1714 preserve_acls = 1;
1715 preserve_perms = 1;
1716 break;
1717#else
1718 /* FIXME: this should probably be ignored with a
1719 * warning and then countermeasures taken to
1720 * restrict group and other access in the presence
1721 * of any more restrictive ACLs, but this is safe
1722 * for now */
1723 snprintf(err_buf,sizeof(err_buf),
1724 "ACLs are not supported on this %s\n",
1725 am_server ? "server" : "client");
1726 return 0;
1727#endif
1728
1729 case 'X':
1730#ifdef SUPPORT_XATTRS
1731 preserve_xattrs++;
1732 break;
1733#else
1734 snprintf(err_buf,sizeof(err_buf),
1735 "extended attributes are not supported on this %s\n",
1736 am_server ? "server" : "client");
1737 return 0;
1738#endif
1739
1740 default:
1741 /* A large opt value means that set_refuse_options()
1742 * turned this option off. */
1743 if (opt >= OPT_REFUSED_BASE) {
1744 create_refuse_error(opt);
1745 return 0;
1746 }
1747 snprintf(err_buf, sizeof err_buf, "%s%s: %s\n",
1748 am_server ? "on remote machine: " : "",
1749 poptBadOption(pc, POPT_BADOPTION_NOALIAS),
1750 poptStrerror(opt));
1751 return 0;
1752 }
1753 }
1754
1755 if (human_readable > 1 && argc == 2 && !am_server) {
1756 /* Allow the old meaning of 'h' (--help) on its own. */
1757 usage(FINFO);
1758 exit_cleanup(0);
1759 }
1760
1761 set_output_verbosity(verbose, DEFAULT_PRIORITY);
1762
1763 if (do_stats) {
1764 parse_output_words(info_words, info_levels,
1765 verbose > 1 ? "stats3" : "stats2", DEFAULT_PRIORITY);
1766 }
1767
1768 if (human_readable) {
1769 char buf[32];
1770 snprintf(buf, sizeof buf, "%f", 3.14);
1771 if (strchr(buf, '.') != NULL)
1772 number_separator = ',';
1773 else
1774 number_separator = '.';
1775 }
1776
1777#ifdef ICONV_OPTION
1778 if (iconv_opt && protect_args != 2) {
1779 if (!am_server && strcmp(iconv_opt, "-") == 0)
1780 iconv_opt = NULL;
1781 else
1782 need_unsorted_flist = 1;
1783 }
1784 if (refused_no_iconv && !iconv_opt) {
1785 create_refuse_error(refused_no_iconv);
1786 return 0;
1787 }
1788#endif
1789
1790 if (protect_args == 1 && am_server)
1791 return 1;
1792
1793 *argv_p = argv = poptGetArgs(pc);
1794 *argc_p = argc = count_args(argv);
1795
1796#ifndef SUPPORT_LINKS
1797 if (preserve_links && !am_sender) {
1798 snprintf(err_buf, sizeof err_buf,
1799 "symlinks are not supported on this %s\n",
1800 am_server ? "server" : "client");
1801 return 0;
1802 }
1803#endif
1804
1805#ifndef SUPPORT_HARD_LINKS
1806 if (preserve_hard_links) {
1807 snprintf(err_buf, sizeof err_buf,
1808 "hard links are not supported on this %s\n",
1809 am_server ? "server" : "client");
1810 return 0;
1811 }
1812#endif
1813
1814#ifdef SUPPORT_XATTRS
1815 if (am_root < 0 && preserve_xattrs > 1) {
1816 snprintf(err_buf, sizeof err_buf,
1817 "--fake-super conflicts with -XX\n");
1818 return 0;
1819 }
1820#else
1821 if (am_root < 0) {
1822 snprintf(err_buf, sizeof err_buf,
1823 "--fake-super requires an rsync with extended attributes enabled\n");
1824 return 0;
1825 }
1826#endif
1827
1828 if (write_batch && read_batch) {
1829 snprintf(err_buf, sizeof err_buf,
1830 "--write-batch and --read-batch can not be used together\n");
1831 return 0;
1832 }
1833 if (write_batch > 0 || read_batch) {
1834 if (am_server) {
1835 rprintf(FINFO,
1836 "ignoring --%s-batch option sent to server\n",
1837 write_batch ? "write" : "read");
1838 /* We don't actually exit_cleanup(), so that we can
1839 * still service older version clients that still send
1840 * batch args to server. */
1841 read_batch = write_batch = 0;
1842 batch_name = NULL;
1843 } else if (dry_run)
1844 write_batch = 0;
1845 } else if (write_batch < 0 && dry_run)
1846 write_batch = 0;
1847 if (read_batch && files_from) {
1848 snprintf(err_buf, sizeof err_buf,
1849 "--read-batch cannot be used with --files-from\n");
1850 return 0;
1851 }
1852 if (batch_name && strlen(batch_name) > MAX_BATCH_NAME_LEN) {
1853 snprintf(err_buf, sizeof err_buf,
1854 "the batch-file name must be %d characters or less.\n",
1855 MAX_BATCH_NAME_LEN);
1856 return 0;
1857 }
1858
1859 if (tmpdir && strlen(tmpdir) >= MAXPATHLEN - 10) {
1860 snprintf(err_buf, sizeof err_buf,
1861 "the --temp-dir path is WAY too long.\n");
1862 return 0;
1863 }
1864
1865 if (max_delete < 0 && max_delete != INT_MIN) {
1866 /* Negative numbers are treated as "no deletions". */
1867 max_delete = 0;
1868 }
1869
1870 if (compare_dest + copy_dest + link_dest > 1) {
1871 snprintf(err_buf, sizeof err_buf,
1872 "You may not mix --compare-dest, --copy-dest, and --link-dest.\n");
1873 return 0;
1874 }
1875
1876 if (files_from) {
1877 if (recurse == 1) /* preserve recurse == 2 */
1878 recurse = 0;
1879 if (xfer_dirs < 0)
1880 xfer_dirs = 1;
1881 }
1882
1883 if (argc < 2 && !read_batch && !am_server)
1884 list_only |= 1;
1885
1886 if (xfer_dirs >= 4) {
1887 parse_rule(&filter_list, "- /*/*", 0, 0);
1888 recurse = xfer_dirs = 1;
1889 } else if (recurse)
1890 xfer_dirs = 1;
1891 else if (xfer_dirs < 0)
1892 xfer_dirs = list_only ? 1 : 0;
1893
1894 if (relative_paths < 0)
1895 relative_paths = files_from? 1 : 0;
1896 if (!relative_paths)
1897 implied_dirs = 0;
1898
1899 if (delete_before + !!delete_during + delete_after > 1) {
1900 snprintf(err_buf, sizeof err_buf,
1901 "You may not combine multiple --delete-WHEN options.\n");
1902 return 0;
1903 }
1904 if (delete_before || delete_during || delete_after)
1905 delete_mode = 1;
1906 else if (delete_mode || delete_excluded) {
1907 /* Only choose now between before & during if one is refused. */
1908 if (refused_delete_before) {
1909 if (!refused_delete_during)
1910 delete_during = 1;
1911 else {
1912 create_refuse_error(refused_delete_before);
1913 return 0;
1914 }
1915 } else if (refused_delete_during)
1916 delete_before = 1;
1917 delete_mode = 1;
1918 }
1919 if (!xfer_dirs && delete_mode) {
1920 snprintf(err_buf, sizeof err_buf,
1921 "--delete does not work without -r or -d.\n");
1922 return 0;
1923 }
1924
1925 if (delete_mode && refused_delete) {
1926 create_refuse_error(refused_delete);
1927 return 0;
1928 }
1929
1930 if (remove_source_files) {
1931 /* We only want to infer this refusal of --remove-source-files
1932 * via the refusal of "delete", not any of the "delete-FOO"
1933 * options. */
1934 if (refused_delete && am_sender) {
1935 create_refuse_error(refused_delete);
1936 return 0;
1937 }
1938 need_messages_from_generator = 1;
1939 }
1940
1941 if (munge_symlinks && !am_daemon) {
1942 STRUCT_STAT st;
1943 char prefix[SYMLINK_PREFIX_LEN]; /* NOT +1 ! */
1944 strlcpy(prefix, SYMLINK_PREFIX, sizeof prefix); /* trim the trailing slash */
1945 if (do_stat(prefix, &st) == 0 && S_ISDIR(st.st_mode)) {
1946 rprintf(FERROR, "Symlink munging is unsafe when a %s directory exists.\n",
1947 prefix);
1948 exit_cleanup(RERR_UNSUPPORTED);
1949 }
1950 }
1951
1952 if (sanitize_paths) {
1953 int i;
1954 for (i = argc; i-- > 0; )
1955 argv[i] = sanitize_path(NULL, argv[i], "", 0, SP_KEEP_DOT_DIRS);
1956 if (tmpdir)
1957 tmpdir = sanitize_path(NULL, tmpdir, NULL, 0, SP_DEFAULT);
1958 if (backup_dir)
1959 backup_dir = sanitize_path(NULL, backup_dir, NULL, 0, SP_DEFAULT);
1960 }
1961 if (daemon_filter_list.head && !am_sender) {
1962 struct filter_list_struct *elp = &daemon_filter_list;
1963 if (tmpdir) {
1964 char *dir;
1965 if (!*tmpdir)
1966 goto options_rejected;
1967 dir = tmpdir + (*tmpdir == '/' ? module_dirlen : 0);
1968 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1969 if (check_filter(elp, FLOG, dir, 1) < 0)
1970 goto options_rejected;
1971 }
1972 if (backup_dir) {
1973 char *dir;
1974 if (!*backup_dir)
1975 goto options_rejected;
1976 dir = backup_dir + (*backup_dir == '/' ? module_dirlen : 0);
1977 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1978 if (check_filter(elp, FLOG, dir, 1) < 0)
1979 goto options_rejected;
1980 }
1981 }
1982
1983 if (!backup_suffix)
1984 backup_suffix = backup_dir ? "" : BACKUP_SUFFIX;
1985 backup_suffix_len = strlen(backup_suffix);
1986 if (strchr(backup_suffix, '/') != NULL) {
1987 snprintf(err_buf, sizeof err_buf,
1988 "--suffix cannot contain slashes: %s\n",
1989 backup_suffix);
1990 return 0;
1991 }
1992 if (backup_dir) {
1993 backup_dir_len = strlcpy(backup_dir_buf, backup_dir, sizeof backup_dir_buf);
1994 backup_dir_remainder = sizeof backup_dir_buf - backup_dir_len;
1995 if (backup_dir_remainder < 32) {
1996 snprintf(err_buf, sizeof err_buf,
1997 "the --backup-dir path is WAY too long.\n");
1998 return 0;
1999 }
2000 if (backup_dir_buf[backup_dir_len - 1] != '/') {
2001 backup_dir_buf[backup_dir_len++] = '/';
2002 backup_dir_buf[backup_dir_len] = '\0';
2003 }
2004 if (INFO_GTE(BACKUP, 1) && !am_sender)
2005 rprintf(FINFO, "backup_dir is %s\n", backup_dir_buf);
2006 } else if (!backup_suffix_len && (!am_server || !am_sender)) {
2007 snprintf(err_buf, sizeof err_buf,
2008 "--suffix cannot be a null string without --backup-dir\n");
2009 return 0;
2010 } else if (make_backups && delete_mode && !delete_excluded && !am_server) {
2011 snprintf(backup_dir_buf, sizeof backup_dir_buf,
2012 "P *%s", backup_suffix);
2013 parse_rule(&filter_list, backup_dir_buf, 0, 0);
2014 }
2015
2016 if (make_backups && !backup_dir) {
2017 omit_dir_times = 0; /* Implied, so avoid -O to sender. */
2018 if (preserve_times > 1)
2019 preserve_times = 1;
2020 } else if (omit_dir_times) {
2021 if (preserve_times > 1)
2022 preserve_times = 1;
2023 }
2024
2025 if (stdout_format) {
2026 if (am_server && log_format_has(stdout_format, 'I'))
2027 stdout_format_has_i = 2;
2028 else if (log_format_has(stdout_format, 'i'))
2029 stdout_format_has_i = itemize_changes | 1;
2030 if (!log_format_has(stdout_format, 'b')
2031 && !log_format_has(stdout_format, 'c')
2032 && !log_format_has(stdout_format, 'C'))
2033 log_before_transfer = !am_server;
2034 } else if (itemize_changes) {
2035 stdout_format = "%i %n%L";
2036 stdout_format_has_i = itemize_changes;
2037 log_before_transfer = !am_server;
2038 }
2039
2040 if (do_progress && !am_server) {
2041 if (!log_before_transfer && INFO_EQ(NAME, 0))
2042 parse_output_words(info_words, info_levels, "name", DEFAULT_PRIORITY);
2043 parse_output_words(info_words, info_levels, "flist2,progress", DEFAULT_PRIORITY);
2044 }
2045
2046 if (dry_run)
2047 do_xfers = 0;
2048
2049 set_io_timeout(io_timeout);
2050
2051 if (INFO_GTE(NAME, 1) && !stdout_format) {
2052 stdout_format = "%n%L";
2053 log_before_transfer = !am_server;
2054 }
2055 if (stdout_format_has_i || log_format_has(stdout_format, 'o'))
2056 stdout_format_has_o_or_i = 1;
2057
2058 if (logfile_name && !am_daemon) {
2059 if (!logfile_format) {
2060 logfile_format = "%i %n%L";
2061 logfile_format_has_i = logfile_format_has_o_or_i = 1;
2062 } else {
2063 if (log_format_has(logfile_format, 'i'))
2064 logfile_format_has_i = 1;
2065 if (logfile_format_has_i || log_format_has(logfile_format, 'o'))
2066 logfile_format_has_o_or_i = 1;
2067 }
2068 log_init(0);
2069 } else if (!am_daemon)
2070 logfile_format = NULL;
2071
2072 if (daemon_bwlimit && (!bwlimit || bwlimit > daemon_bwlimit))
2073 bwlimit = daemon_bwlimit;
2074 if (bwlimit) {
2075 bwlimit_writemax = (size_t)bwlimit * 128;
2076 if (bwlimit_writemax < 512)
2077 bwlimit_writemax = 512;
2078 }
2079
2080 if (sparse_files && inplace) {
2081 /* Note: we don't check for this below, because --append is
2082 * OK with --sparse (as long as redos are handled right). */
2083 snprintf(err_buf, sizeof err_buf,
2084 "--sparse cannot be used with --inplace\n");
2085 return 0;
2086 }
2087
2088 if (append_mode) {
2089 if (whole_file > 0) {
2090 snprintf(err_buf, sizeof err_buf,
2091 "--append cannot be used with --whole-file\n");
2092 return 0;
2093 }
2094 if (refused_inplace) {
2095 create_refuse_error(refused_inplace);
2096 return 0;
2097 }
2098 inplace = 1;
2099 }
2100
2101 if (delay_updates && !partial_dir)
2102 partial_dir = tmp_partialdir;
2103
2104 if (inplace) {
2105#ifdef HAVE_FTRUNCATE
2106 if (partial_dir) {
2107 snprintf(err_buf, sizeof err_buf,
2108 "--%s cannot be used with --%s\n",
2109 append_mode ? "append" : "inplace",
2110 delay_updates ? "delay-updates" : "partial-dir");
2111 return 0;
2112 }
2113 /* --inplace implies --partial for refusal purposes, but we
2114 * clear the keep_partial flag for internal logic purposes. */
2115 if (refused_partial) {
2116 create_refuse_error(refused_partial);
2117 return 0;
2118 }
2119 keep_partial = 0;
2120#else
2121 snprintf(err_buf, sizeof err_buf,
2122 "--%s is not supported on this %s\n",
2123 append_mode ? "append" : "inplace",
2124 am_server ? "server" : "client");
2125 return 0;
2126#endif
2127 } else {
2128 if (keep_partial && !partial_dir && !am_server) {
2129 if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
2130 partial_dir = strdup(arg);
2131 }
2132 if (partial_dir) {
2133 if (*partial_dir)
2134 clean_fname(partial_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2135 if (!*partial_dir || strcmp(partial_dir, ".") == 0)
2136 partial_dir = NULL;
2137 if (!partial_dir && refused_partial) {
2138 create_refuse_error(refused_partial);
2139 return 0;
2140 }
2141 keep_partial = 1;
2142 }
2143 }
2144
2145 if (files_from) {
2146 char *h, *p;
2147 int q;
2148 if (argc > 2 || (!am_daemon && argc == 1)) {
2149 usage(FERROR);
2150 exit_cleanup(RERR_SYNTAX);
2151 }
2152 if (strcmp(files_from, "-") == 0) {
2153 filesfrom_fd = 0;
2154 if (am_server)
2155 filesfrom_host = ""; /* reading from socket */
2156 } else if ((p = check_for_hostspec(files_from, &h, &q)) != 0) {
2157 if (am_server) {
2158 snprintf(err_buf, sizeof err_buf,
2159 "The --files-from sent to the server cannot specify a host.\n");
2160 return 0;
2161 }
2162 files_from = p;
2163 filesfrom_host = h;
2164 if (strcmp(files_from, "-") == 0) {
2165 snprintf(err_buf, sizeof err_buf,
2166 "Invalid --files-from remote filename\n");
2167 return 0;
2168 }
2169 } else {
2170 if (sanitize_paths)
2171 files_from = sanitize_path(NULL, files_from, NULL, 0, SP_DEFAULT);
2172 if (daemon_filter_list.head) {
2173 char *dir;
2174 if (!*files_from)
2175 goto options_rejected;
2176 dir = files_from + (*files_from == '/' ? module_dirlen : 0);
2177 clean_fname(dir, CFN_COLLAPSE_DOT_DOT_DIRS);
2178 if (check_filter(&daemon_filter_list, FLOG, dir, 0) < 0)
2179 goto options_rejected;
2180 }
2181 filesfrom_fd = open(files_from, O_RDONLY|O_BINARY);
2182 if (filesfrom_fd < 0) {
2183 snprintf(err_buf, sizeof err_buf,
2184 "failed to open files-from file %s: %s\n",
2185 files_from, strerror(errno));
2186 return 0;
2187 }
2188 }
2189 }
2190
2191 am_starting_up = 0;
2192
2193 return 1;
2194
2195 options_rejected:
2196 snprintf(err_buf, sizeof err_buf,
2197 "Your options have been rejected by the server.\n");
2198 return 0;
2199}
2200
2201
2202/**
2203 * Construct a filtered list of options to pass through from the
2204 * client to the server.
2205 *
2206 * This involves setting options that will tell the server how to
2207 * behave, and also filtering out options that are processed only
2208 * locally.
2209 **/
2210void server_options(char **args, int *argc_p)
2211{
2212 static char argstr[64];
2213 int ac = *argc_p;
2214 uchar where;
2215 char *arg;
2216 int i, x;
2217
2218 /* This should always remain first on the server's command-line. */
2219 args[ac++] = "--server";
2220
2221 if (daemon_over_rsh > 0) {
2222 args[ac++] = "--daemon";
2223 *argc_p = ac;
2224 /* if we're passing --daemon, we're done */
2225 return;
2226 }
2227
2228 if (!am_sender)
2229 args[ac++] = "--sender";
2230
2231 x = 1;
2232 argstr[0] = '-';
2233
2234 if (protect_args)
2235 argstr[x++] = 's';
2236
2237 for (i = 0; i < verbose; i++)
2238 argstr[x++] = 'v';
2239
2240 /* the -q option is intentionally left out */
2241 if (make_backups)
2242 argstr[x++] = 'b';
2243 if (update_only)
2244 argstr[x++] = 'u';
2245 if (!do_xfers) /* Note: NOT "dry_run"! */
2246 argstr[x++] = 'n';
2247 if (preserve_links)
2248 argstr[x++] = 'l';
2249 if ((xfer_dirs >= 2 && xfer_dirs < 4)
2250 || (xfer_dirs && !recurse && (list_only || (delete_mode && am_sender))))
2251 argstr[x++] = 'd';
2252 if (am_sender) {
2253 if (keep_dirlinks)
2254 argstr[x++] = 'K';
2255 if (prune_empty_dirs)
2256 argstr[x++] = 'm';
2257 if (omit_dir_times)
2258 argstr[x++] = 'O';
2259 } else {
2260 if (copy_links)
2261 argstr[x++] = 'L';
2262 if (copy_dirlinks)
2263 argstr[x++] = 'k';
2264 }
2265
2266 if (whole_file > 0)
2267 argstr[x++] = 'W';
2268 /* We don't need to send --no-whole-file, because it's the
2269 * default for remote transfers, and in any case old versions
2270 * of rsync will not understand it. */
2271
2272 if (preserve_hard_links) {
2273 argstr[x++] = 'H';
2274 if (preserve_hard_links > 1)
2275 argstr[x++] = 'H';
2276 }
2277 if (preserve_uid)
2278 argstr[x++] = 'o';
2279 if (preserve_gid)
2280 argstr[x++] = 'g';
2281 if (preserve_devices) /* ignore preserve_specials here */
2282 argstr[x++] = 'D';
2283 if (preserve_times)
2284 argstr[x++] = 't';
2285 if (preserve_perms)
2286 argstr[x++] = 'p';
2287 else if (preserve_executability && am_sender)
2288 argstr[x++] = 'E';
2289#ifdef SUPPORT_ACLS
2290 if (preserve_acls)
2291 argstr[x++] = 'A';
2292#endif
2293#ifdef SUPPORT_XATTRS
2294 if (preserve_xattrs) {
2295 argstr[x++] = 'X';
2296 if (preserve_xattrs > 1)
2297 argstr[x++] = 'X';
2298 }
2299#endif
2300 if (recurse)
2301 argstr[x++] = 'r';
2302 if (always_checksum)
2303 argstr[x++] = 'c';
2304 if (cvs_exclude)
2305 argstr[x++] = 'C';
2306 if (ignore_times)
2307 argstr[x++] = 'I';
2308 if (relative_paths)
2309 argstr[x++] = 'R';
2310 if (one_file_system) {
2311 argstr[x++] = 'x';
2312 if (one_file_system > 1)
2313 argstr[x++] = 'x';
2314 }
2315 if (sparse_files)
2316 argstr[x++] = 'S';
2317 if (do_compression)
2318 argstr[x++] = 'z';
2319
2320 set_allow_inc_recurse();
2321
2322 /* Checking the pre-negotiated value allows --protocol=29 override. */
2323 if (protocol_version >= 30) {
2324 /* We make use of the -e option to let the server know about
2325 * any pre-release protocol version && some behavior flags. */
2326 argstr[x++] = 'e';
2327#if SUBPROTOCOL_VERSION != 0
2328 if (protocol_version == PROTOCOL_VERSION) {
2329 x += snprintf(argstr+x, sizeof argstr - x,
2330 "%d.%d",
2331 PROTOCOL_VERSION, SUBPROTOCOL_VERSION);
2332 } else
2333#endif
2334 argstr[x++] = '.';
2335 if (allow_inc_recurse)
2336 argstr[x++] = 'i';
2337#if defined HAVE_LUTIMES && defined HAVE_UTIMES
2338 argstr[x++] = 'L';
2339#endif
2340#ifdef ICONV_OPTION
2341 argstr[x++] = 's';
2342#endif
2343 }
2344
2345 if (x >= (int)sizeof argstr) { /* Not possible... */
2346 rprintf(FERROR, "argstr overflow in server_options().\n");
2347 exit_cleanup(RERR_MALLOC);
2348 }
2349
2350 argstr[x] = '\0';
2351
2352 if (x > 1)
2353 args[ac++] = argstr;
2354
2355#ifdef ICONV_OPTION
2356 if (iconv_opt) {
2357 char *set = strchr(iconv_opt, ',');
2358 if (set)
2359 set++;
2360 else
2361 set = iconv_opt;
2362 if (asprintf(&arg, "--iconv=%s", set) < 0)
2363 goto oom;
2364 args[ac++] = arg;
2365 }
2366#endif
2367
2368 if (protect_args && !local_server) /* unprotected args stop here */
2369 args[ac++] = NULL;
2370
2371 if (do_stats)
2372 args[ac++] = "--stats";
2373
2374 if (list_only > 1)
2375 args[ac++] = "--list-only";
2376
2377 /* This makes sure that the remote rsync can handle deleting with -d
2378 * sans -r because the --no-r option was added at the same time. */
2379 if (xfer_dirs && !recurse && delete_mode && am_sender)
2380 args[ac++] = "--no-r";
2381
2382 if (do_compression && def_compress_level != Z_DEFAULT_COMPRESSION) {
2383 if (asprintf(&arg, "--compress-level=%d", def_compress_level) < 0)
2384 goto oom;
2385 args[ac++] = arg;
2386 }
2387
2388 if (preserve_devices) {
2389 /* Note: sending "--devices" would not be backward-compatible. */
2390 if (!preserve_specials)
2391 args[ac++] = "--no-specials"; /* -D is already set. */
2392 } else if (preserve_specials)
2393 args[ac++] = "--specials";
2394
2395 /* The server side doesn't use our log-format, but in certain
2396 * circumstances they need to know a little about the option. */
2397 if (stdout_format && am_sender) {
2398 /* Use --log-format, not --out-format, for compatibility. */
2399 if (stdout_format_has_i > 1)
2400 args[ac++] = "--log-format=%i%I";
2401 else if (stdout_format_has_i)
2402 args[ac++] = "--log-format=%i";
2403 else if (stdout_format_has_o_or_i)
2404 args[ac++] = "--log-format=%o";
2405 else if (!verbose)
2406 args[ac++] = "--log-format=X";
2407 }
2408
2409 if (block_size) {
2410 if (asprintf(&arg, "-B%lu", block_size) < 0)
2411 goto oom;
2412 args[ac++] = arg;
2413 }
2414
2415 if (io_timeout) {
2416 if (asprintf(&arg, "--timeout=%d", io_timeout) < 0)
2417 goto oom;
2418 args[ac++] = arg;
2419 }
2420
2421 if (bwlimit) {
2422 if (asprintf(&arg, "--bwlimit=%d", bwlimit) < 0)
2423 goto oom;
2424 args[ac++] = arg;
2425 }
2426
2427 if (backup_dir) {
2428 args[ac++] = "--backup-dir";
2429 args[ac++] = backup_dir;
2430 }
2431
2432 /* Only send --suffix if it specifies a non-default value. */
2433 if (strcmp(backup_suffix, backup_dir ? "" : BACKUP_SUFFIX) != 0) {
2434 /* We use the following syntax to avoid weirdness with '~'. */
2435 if (asprintf(&arg, "--suffix=%s", backup_suffix) < 0)
2436 goto oom;
2437 args[ac++] = arg;
2438 }
2439
2440 if (am_sender) {
2441 if (max_delete > 0) {
2442 if (asprintf(&arg, "--max-delete=%d", max_delete) < 0)
2443 goto oom;
2444 args[ac++] = arg;
2445 } else if (max_delete == 0)
2446 args[ac++] = "--max-delete=-1";
2447 if (min_size) {
2448 args[ac++] = "--min-size";
2449 args[ac++] = min_size_arg;
2450 }
2451 if (max_size) {
2452 args[ac++] = "--max-size";
2453 args[ac++] = max_size_arg;
2454 }
2455 if (delete_before)
2456 args[ac++] = "--delete-before";
2457 else if (delete_during == 2)
2458 args[ac++] = "--delete-delay";
2459 else if (delete_during)
2460 args[ac++] = "--delete-during";
2461 else if (delete_after)
2462 args[ac++] = "--delete-after";
2463 else if (delete_mode && !delete_excluded)
2464 args[ac++] = "--delete";
2465 if (delete_excluded)
2466 args[ac++] = "--delete-excluded";
2467 if (force_delete)
2468 args[ac++] = "--force";
2469 if (write_batch < 0)
2470 args[ac++] = "--only-write-batch=X";
2471 if (am_root > 1)
2472 args[ac++] = "--super";
2473 if (size_only)
2474 args[ac++] = "--size-only";
2475 } else {
2476 if (skip_compress) {
2477 if (asprintf(&arg, "--skip-compress=%s", skip_compress) < 0)
2478 goto oom;
2479 args[ac++] = arg;
2480 }
2481 }
2482
2483 if (modify_window_set) {
2484 if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
2485 goto oom;
2486 args[ac++] = arg;
2487 }
2488
2489 if (checksum_seed) {
2490 if (asprintf(&arg, "--checksum-seed=%d", checksum_seed) < 0)
2491 goto oom;
2492 args[ac++] = arg;
2493 }
2494
2495 if (partial_dir && am_sender) {
2496 if (partial_dir != tmp_partialdir) {
2497 args[ac++] = "--partial-dir";
2498 args[ac++] = partial_dir;
2499 }
2500 if (delay_updates)
2501 args[ac++] = "--delay-updates";
2502 } else if (keep_partial && am_sender)
2503 args[ac++] = "--partial";
2504
2505 if (ignore_errors)
2506 args[ac++] = "--ignore-errors";
2507
2508 if (copy_unsafe_links)
2509 args[ac++] = "--copy-unsafe-links";
2510
2511 if (safe_symlinks)
2512 args[ac++] = "--safe-links";
2513
2514 if (numeric_ids)
2515 args[ac++] = "--numeric-ids";
2516
2517 if (use_qsort)
2518 args[ac++] = "--use-qsort";
2519
2520 if (am_sender) {
2521 if (usermap) {
2522 if (asprintf(&arg, "--usermap=%s", usermap) < 0)
2523 goto oom;
2524 args[ac++] = arg;
2525 }
2526
2527 if (groupmap) {
2528 if (asprintf(&arg, "--groupmap=%s", groupmap) < 0)
2529 goto oom;
2530 args[ac++] = arg;
2531 }
2532
2533 if (ignore_existing)
2534 args[ac++] = "--ignore-existing";
2535
2536 /* Backward compatibility: send --existing, not --ignore-non-existing. */
2537 if (ignore_non_existing)
2538 args[ac++] = "--existing";
2539
2540 if (tmpdir) {
2541 args[ac++] = "--temp-dir";
2542 args[ac++] = tmpdir;
2543 }
2544
2545 if (basis_dir[0]) {
2546 /* the server only needs this option if it is not the sender,
2547 * and it may be an older version that doesn't know this
2548 * option, so don't send it if client is the sender.
2549 */
2550 for (i = 0; i < basis_dir_cnt; i++) {
2551 args[ac++] = dest_option;
2552 args[ac++] = basis_dir[i];
2553 }
2554 }
2555 }
2556
2557 /* What flags do we need to send to the other side? */
2558 where = (am_server ? W_CLI : W_SRV) | (am_sender ? W_REC : W_SND);
2559 arg = make_output_option(info_words, info_levels, where);
2560 if (arg)
2561 args[ac++] = arg;
2562
2563 arg = make_output_option(debug_words, debug_levels, where);
2564 if (arg)
2565 args[ac++] = arg;
2566
2567 if (append_mode) {
2568 if (append_mode > 1)
2569 args[ac++] = "--append";
2570 args[ac++] = "--append";
2571 } else if (inplace)
2572 args[ac++] = "--inplace";
2573
2574 if (files_from && (!am_sender || filesfrom_host)) {
2575 if (filesfrom_host) {
2576 args[ac++] = "--files-from";
2577 args[ac++] = files_from;
2578 if (eol_nulls)
2579 args[ac++] = "--from0";
2580 } else {
2581 args[ac++] = "--files-from=-";
2582 args[ac++] = "--from0";
2583 }
2584 if (!relative_paths)
2585 args[ac++] = "--no-relative";
2586 }
2587 /* It's OK that this checks the upper-bound of the protocol_version. */
2588 if (relative_paths && !implied_dirs && (!am_sender || protocol_version >= 30))
2589 args[ac++] = "--no-implied-dirs";
2590
2591 if (fuzzy_basis && am_sender)
2592 args[ac++] = "--fuzzy";
2593
2594 if (remove_source_files == 1)
2595 args[ac++] = "--remove-source-files";
2596 else if (remove_source_files)
2597 args[ac++] = "--remove-sent-files";
2598
2599 if (ac > MAX_SERVER_ARGS) { /* Not possible... */
2600 rprintf(FERROR, "argc overflow in server_options().\n");
2601 exit_cleanup(RERR_MALLOC);
2602 }
2603
2604 if (remote_option_cnt) {
2605 int j;
2606 if (ac + remote_option_cnt > MAX_SERVER_ARGS) {
2607 rprintf(FERROR, "too many remote options specified.\n");
2608 exit_cleanup(RERR_SYNTAX);
2609 }
2610 for (j = 1; j <= remote_option_cnt; j++)
2611 args[ac++] = (char*)remote_options[j];
2612 }
2613
2614 *argc_p = ac;
2615 return;
2616
2617 oom:
2618 out_of_memory("server_options");
2619}
2620
2621/* Look for a HOST specfication of the form "HOST:PATH", "HOST::PATH", or
2622 * "rsync://HOST:PORT/PATH". If found, *host_ptr will be set to some allocated
2623 * memory with the HOST. If a daemon-accessing spec was specified, the value
2624 * of *port_ptr will contain a non-0 port number, otherwise it will be set to
2625 * 0. The return value is a pointer to the PATH. Note that the HOST spec can
2626 * be an IPv6 literal address enclosed in '[' and ']' (such as "[::1]" or
2627 * "[::ffff:127.0.0.1]") which is returned without the '[' and ']'. */
2628char *check_for_hostspec(char *s, char **host_ptr, int *port_ptr)
2629{
2630 char *p;
2631 int not_host;
2632 int hostlen;
2633
2634 if (port_ptr && strncasecmp(URL_PREFIX, s, strlen(URL_PREFIX)) == 0) {
2635 char *path;
2636 s += strlen(URL_PREFIX);
2637 if ((p = strchr(s, '/')) != NULL) {
2638 hostlen = p - s;
2639 path = p + 1;
2640 } else {
2641 hostlen = strlen(s);
2642 path = "";
2643 }
2644 if (*s == '[' && (p = strchr(s, ']')) != NULL) {
2645 s++;
2646 hostlen = p - s;
2647 if (p[1] == ':')
2648 *port_ptr = atoi(p+2);
2649 } else {
2650 if ((p = strchr(s, ':')) != NULL && p < s + hostlen) {
2651 hostlen = p - s;
2652 *port_ptr = atoi(p+1);
2653 }
2654 }
2655 if (!*port_ptr)
2656 *port_ptr = RSYNC_PORT;
2657 *host_ptr = new_array(char, hostlen + 1);
2658 strlcpy(*host_ptr, s, hostlen + 1);
2659 return path;
2660 }
2661
2662 if (*s == '[' && (p = strchr(s, ']')) != NULL && p[1] == ':') {
2663 s++;
2664 hostlen = p - s;
2665 *p = '\0';
2666 not_host = strchr(s, '/') || !strchr(s, ':');
2667 *p = ']';
2668 if (not_host)
2669 return NULL;
2670 p++;
2671 } else {
2672 if (!(p = strchr(s, ':')))
2673 return NULL;
2674 hostlen = p - s;
2675 *p = '\0';
2676 not_host = strchr(s, '/') != NULL;
2677 *p = ':';
2678 if (not_host)
2679 return NULL;
2680 }
2681
2682 *host_ptr = new_array(char, hostlen + 1);
2683 strlcpy(*host_ptr, s, hostlen + 1);
2684
2685 if (p[1] == ':') {
2686 if (port_ptr && !*port_ptr)
2687 *port_ptr = RSYNC_PORT;
2688 return p + 2;
2689 }
2690 if (port_ptr)
2691 *port_ptr = 0;
2692
2693 return p + 1;
2694}