options.c

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