Moved the sanitizing of the --*-dest args into main.c.
[rsync.git] / options.c
index 5800abe7e5ea128c52ceea1dead5435e9a3de495..ee7b5222847f4d17597839cea6f163a793e97d9c 100644 (file)
--- a/options.c
+++ b/options.c
@@ -1,7 +1,9 @@
-/*  -*- c-file-style: "linux" -*-
+/*
+ * Command-line (and received via daemon-socket) option parsing.
  *
- * Copyright (C) 1998-2001 by Andrew Tridgell <tridge@samba.org>
- * Copyright (C) 2000, 2001, 2002 by Martin Pool <mbp@samba.org>
+ * Copyright (C) 1998-2001 Andrew Tridgell <tridge@samba.org>
+ * Copyright (C) 2000, 2001, 2002 Martin Pool <mbp@samba.org>
+ * Copyright (C) 2002, 2003, 2004, 2005, 2006 Wayne Davison
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
  */
 
 #include "rsync.h"
-#include "popt.h"
+#include <popt.h>
 #include "zlib/zlib.h"
 
 extern int module_id;
@@ -41,10 +43,12 @@ int whole_file = -1;
 
 int append_mode = 0;
 int keep_dirlinks = 0;
+int copy_dirlinks = 0;
 int copy_links = 0;
 int preserve_links = 0;
 int preserve_hard_links = 0;
 int preserve_perms = 0;
+int preserve_executability = 0;
 int preserve_devices = 0;
 int preserve_specials = 0;
 int preserve_uid = 0;
@@ -56,8 +60,6 @@ int cvs_exclude = 0;
 int dry_run = 0;
 int do_xfers = 1;
 int ignore_times = 0;
-int saw_delete_opt = 0;
-int saw_delete_excluded_opt = 0;
 int delete_mode = 0;
 int delete_during = 0;
 int delete_before = 0;
@@ -74,13 +76,14 @@ int am_server = 0;
 int am_sender = 0;
 int am_generator = 0;
 int am_starting_up = 1;
-int orig_umask = 0;
 int relative_paths = -1;
 int implied_dirs = 1;
 int numeric_ids = 0;
+int allow_8bit_chars = 0;
 int force_delete = 0;
 int io_timeout = 0;
 int allowed_lull = 0;
+int prune_empty_dirs = 0;
 char *files_from = NULL;
 int filesfrom_fd = -1;
 char *filesfrom_host = NULL;
@@ -149,6 +152,7 @@ char *password_file = NULL;
 char *rsync_path = RSYNC_PATH;
 char *backup_dir = NULL;
 char backup_dir_buf[MAXPATHLEN];
+char *sockopts = NULL;
 int rsync_port = 0;
 int compare_dest = 0;
 int copy_dest = 0;
@@ -177,7 +181,7 @@ static int refused_delete, refused_archive_part, refused_compress;
 static int refused_partial, refused_progress, refused_delete_before;
 static int refused_inplace;
 static char *max_size_arg, *min_size_arg;
-static char partialdir_for_delayupdate[] = ".~tmp~";
+static char tmp_partialdir[] = ".~tmp~";
 
 /** Local address to bind.  As a character string because it's
  * interpreted by the IPv6 layer: should be a numeric IP4 or IP6
@@ -219,20 +223,20 @@ static void print_rsync_version(enum logcode f)
        rprintf(f, "Copyright (C) 1996-2006 by Andrew Tridgell, Wayne Davison, and others.\n");
        rprintf(f, "<http://rsync.samba.org/>\n");
        rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
-               "%shard links, %ssymlinks, batchfiles, \n",
+               "%shard links, %ssymlinks, batchfiles,\n",
                (int) (sizeof (OFF_T) * 8),
                got_socketpair, hardlinks, links);
 
        /* Note that this field may not have type ino_t.  It depends
         * on the complicated interaction between largefile feature
         * macros. */
-       rprintf(f, "              %sinplace, %sIPv6, %d-bit system inums, %d-bit internal inums\n",
+       rprintf(f, "              %sinplace, %sIPv6, "
+               "%d-bit system inums, %d-bit internal inums\n",
                have_inplace, ipv6,
                (int) (sizeof dumstat->st_ino * 8),
                (int) (sizeof (int64) * 8));
 #ifdef MAINTAINER_MODE
-       rprintf(f, "              panic action: \"%s\"\n",
-               get_panic_action());
+       rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
 #endif
 
 #if SIZEOF_INT64 < 8
@@ -286,17 +290,20 @@ void usage(enum logcode F)
   rprintf(F," -L, --copy-links            transform symlink into referent file/dir\n");
   rprintf(F,"     --copy-unsafe-links     only \"unsafe\" symlinks are transformed\n");
   rprintf(F,"     --safe-links            ignore symlinks that point outside the source tree\n");
-  rprintf(F," -H, --hard-links            preserve hard links\n");
+  rprintf(F," -k, --copy-dirlinks         transform symlink to a dir into referent dir\n");
   rprintf(F," -K, --keep-dirlinks         treat symlinked dir on receiver as dir\n");
+  rprintf(F," -H, --hard-links            preserve hard links\n");
   rprintf(F," -p, --perms                 preserve permissions\n");
-  rprintf(F," -o, --owner                 preserve owner (root only)\n");
+  rprintf(F," -E, --executability         preserve the file's executability\n");
+  rprintf(F,"     --chmod=CHMOD           change destination permissions\n");
+  rprintf(F," -o, --owner                 preserve owner (super-user only)\n");
   rprintf(F," -g, --group                 preserve group\n");
-  rprintf(F,"     --devices               preserve device files (root only)\n");
+  rprintf(F,"     --devices               preserve device files (super-user only)\n");
   rprintf(F,"     --specials              preserve special files\n");
   rprintf(F," -D                          same as --devices --specials\n");
   rprintf(F," -t, --times                 preserve times\n");
   rprintf(F," -O, --omit-dir-times        omit directories when preserving times\n");
-  rprintf(F,"     --chmod=CHMOD           change destination permissions\n");
+  rprintf(F,"     --super                 receiver attempts super-user activities\n");
   rprintf(F," -S, --sparse                handle sparse files efficiently\n");
   rprintf(F," -n, --dry-run               show what would have been transferred\n");
   rprintf(F," -W, --whole-file            copy files whole (without rsync algorithm)\n");
@@ -321,6 +328,7 @@ void usage(enum logcode F)
   rprintf(F,"     --partial               keep partially transferred files\n");
   rprintf(F,"     --partial-dir=DIR       put a partially transferred file into DIR\n");
   rprintf(F,"     --delay-updates         put all updated files into place at transfer's end\n");
+  rprintf(F," -m, --prune-empty-dirs      prune empty directory chains from the file-list\n");
   rprintf(F,"     --numeric-ids           don't map uid/gid values by user/group name\n");
   rprintf(F,"     --timeout=TIME          set I/O timeout in seconds\n");
   rprintf(F," -I, --ignore-times          don't skip files that match in size and mod-time\n");
@@ -345,10 +353,11 @@ void usage(enum logcode F)
   rprintf(F," -0, --from0                 all *-from/filter files are delimited by 0s\n");
   rprintf(F,"     --address=ADDRESS       bind address for outgoing socket to daemon\n");
   rprintf(F,"     --port=PORT             specify double-colon alternate port number\n");
+  rprintf(F,"     --sockopts=OPTIONS      specify custom TCP options\n");
   rprintf(F,"     --blocking-io           use blocking I/O for the remote shell\n");
   rprintf(F,"     --stats                 give some file-transfer stats\n");
+  rprintf(F," -8, --8-bit-output          leave high-bit chars unescaped in output\n");
   rprintf(F," -h, --human-readable        output numbers in a human-readable format\n");
-  rprintf(F,"     --si                    like human-readable, but use powers of 1000\n");
   rprintf(F,"     --progress              show progress during transfer\n");
   rprintf(F," -P                          same as --partial --progress\n");
   rprintf(F," -i, --itemize-changes       output a change-summary for all updates\n");
@@ -365,7 +374,7 @@ void usage(enum logcode F)
   rprintf(F," -6, --ipv6                  prefer IPv6\n");
 #endif
   rprintf(F,"     --version               print version number\n");
-  rprintf(F,"     --help                  show this help screen\n");
+  rprintf(F,"(-h) --help                  show this help (-h works with no other options)\n");
 
   rprintf(F,"\nUse \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
   rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
@@ -388,8 +397,7 @@ static struct poptOption long_options[] = {
   {"no-v",             0,  POPT_ARG_VAL,    &verbose, 0, 0, 0 },
   {"quiet",           'q', POPT_ARG_NONE,   0, 'q', 0, 0 },
   {"stats",            0,  POPT_ARG_NONE,   &do_stats, 0, 0, 0 },
-  {"human-readable",  'h', POPT_ARG_VAL,    &human_readable, 1, 0, 0},
-  {"si",               0,  POPT_ARG_VAL,    &human_readable, 2, 0, 0},
+  {"human-readable",  'h', POPT_ARG_NONE,   0, 'h', 0, 0},
   {"dry-run",         'n', POPT_ARG_NONE,   &dry_run, 0, 0, 0 },
   {"archive",         'a', POPT_ARG_NONE,   0, 'a', 0, 0 },
   {"recursive",       'r', POPT_ARG_VAL,    &recurse, 2, 0, 0 },
@@ -401,11 +409,14 @@ static struct poptOption long_options[] = {
   {"perms",           'p', POPT_ARG_VAL,    &preserve_perms, 1, 0, 0 },
   {"no-perms",         0,  POPT_ARG_VAL,    &preserve_perms, 0, 0, 0 },
   {"no-p",             0,  POPT_ARG_VAL,    &preserve_perms, 0, 0, 0 },
+  {"executability",   'E', POPT_ARG_NONE,   &preserve_executability, 0, 0, 0 },
   {"times",           't', POPT_ARG_VAL,    &preserve_times, 1, 0, 0 },
   {"no-times",         0,  POPT_ARG_VAL,    &preserve_times, 0, 0, 0 },
   {"no-t",             0,  POPT_ARG_VAL,    &preserve_times, 0, 0, 0 },
   {"omit-dir-times",  'O', POPT_ARG_VAL,    &omit_dir_times, 2, 0, 0 },
   {"modify-window",    0,  POPT_ARG_INT,    &modify_window, OPT_MODIFY_WINDOW, 0, 0 },
+  {"super",            0,  POPT_ARG_VAL,    &am_root, 2, 0, 0 },
+  {"no-super",         0,  POPT_ARG_VAL,    &am_root, 0, 0, 0 },
   {"owner",           'o', POPT_ARG_VAL,    &preserve_uid, 1, 0, 0 },
   {"no-owner",         0,  POPT_ARG_VAL,    &preserve_uid, 0, 0, 0 },
   {"no-o",             0,  POPT_ARG_VAL,    &preserve_uid, 0, 0, 0 },
@@ -424,11 +435,15 @@ static struct poptOption long_options[] = {
   {"copy-links",      'L', POPT_ARG_NONE,   &copy_links, 0, 0, 0 },
   {"copy-unsafe-links",0,  POPT_ARG_NONE,   &copy_unsafe_links, 0, 0, 0 },
   {"safe-links",       0,  POPT_ARG_NONE,   &safe_symlinks, 0, 0, 0 },
+  {"copy-dirlinks",   'k', POPT_ARG_NONE,   &copy_dirlinks, 0, 0, 0 },
   {"keep-dirlinks",   'K', POPT_ARG_NONE,   &keep_dirlinks, 0, 0, 0 },
-  {"hard-links",      'H', POPT_ARG_NONE,   &preserve_hard_links, 0, 0, 0 },
+  {"hard-links",      'H', POPT_ARG_VAL,    &preserve_hard_links, 1, 0, 0 },
+  {"no-hard-links",    0,  POPT_ARG_VAL,    &preserve_hard_links, 0, 0, 0 },
+  {"no-H",             0,  POPT_ARG_VAL,    &preserve_hard_links, 0, 0, 0 },
   {"relative",        'R', POPT_ARG_VAL,    &relative_paths, 1, 0, 0 },
   {"no-relative",      0,  POPT_ARG_VAL,    &relative_paths, 0, 0, 0 },
   {"no-R",             0,  POPT_ARG_VAL,    &relative_paths, 0, 0, 0 },
+  {"implied-dirs",     0,  POPT_ARG_VAL,    &implied_dirs, 1, 0, 0 },
   {"no-implied-dirs",  0,  POPT_ARG_VAL,    &implied_dirs, 0, 0, 0 },
   {"chmod",            0,  POPT_ARG_STRING, 0, OPT_CHMOD, 0, 0 },
   {"ignore-times",    'I', POPT_ARG_NONE,   &ignore_times, 0, 0, 0 },
@@ -478,6 +493,7 @@ static struct poptOption long_options[] = {
   {"no-partial",       0,  POPT_ARG_VAL,    &keep_partial, 0, 0, 0 },
   {"partial-dir",      0,  POPT_ARG_STRING, &partial_dir, 0, 0, 0 },
   {"delay-updates",    0,  POPT_ARG_NONE,   &delay_updates, 0, 0, 0 },
+  {"prune-empty-dirs",'m', POPT_ARG_NONE,   &prune_empty_dirs, 0, 0, 0 },
   {"log-format",       0,  POPT_ARG_STRING, &log_format, 0, 0, 0 },
   {"itemize-changes", 'i', POPT_ARG_NONE,   0, 'i', 0, 0 },
   {"bwlimit",          0,  POPT_ARG_INT,    &bwlimit, 0, 0, 0 },
@@ -499,8 +515,10 @@ static struct poptOption long_options[] = {
   {"ipv4",            '4', POPT_ARG_VAL,    &default_af_hint, AF_INET, 0, 0 },
   {"ipv6",            '6', POPT_ARG_VAL,    &default_af_hint, AF_INET6, 0, 0 },
 #endif
+  {"8-bit-output",    '8', POPT_ARG_NONE,   &allow_8bit_chars, 0, 0, 0 },
   {"address",          0,  POPT_ARG_STRING, &bind_address, 0, 0, 0 },
   {"port",             0,  POPT_ARG_INT,    &rsync_port, 0, 0, 0 },
+  {"sockopts",         0,  POPT_ARG_STRING, &sockopts, 0, 0, 0 },
   {"password-file",    0,  POPT_ARG_STRING, &password_file, 0, 0, 0 },
   {"blocking-io",      0,  POPT_ARG_VAL,    &blocking_io, 1, 0, 0 },
   {"no-blocking-io",   0,  POPT_ARG_VAL,    &blocking_io, 0, 0, 0 },
@@ -526,6 +544,7 @@ static void daemon_usage(enum logcode F)
   rprintf(F,"     --config=FILE           specify alternate rsyncd.conf file\n");
   rprintf(F,"     --no-detach             do not detach from the parent\n");
   rprintf(F,"     --port=PORT             listen on alternate port number\n");
+  rprintf(F,"     --sockopts=OPTIONS      specify custom TCP options\n");
   rprintf(F," -v, --verbose               increase verbosity\n");
 #ifdef INET6
   rprintf(F," -4, --ipv4                  prefer IPv4\n");
@@ -550,6 +569,7 @@ static struct poptOption long_daemon_options[] = {
   {"detach",           0,  POPT_ARG_VAL,    &no_detach, 0, 0, 0 },
   {"no-detach",        0,  POPT_ARG_VAL,    &no_detach, 1, 0, 0 },
   {"port",             0,  POPT_ARG_INT,    &rsync_port, 0, 0, 0 },
+  {"sockopts",         0,  POPT_ARG_STRING, &sockopts, 0, 0, 0 },
   {"protocol",         0,  POPT_ARG_INT,    &protocol_version, 0, 0, 0 },
   {"server",           0,  POPT_ARG_NONE,   &am_server, 0, 0, 0 },
   {"temp-dir",        'T', POPT_ARG_STRING, &tmpdir, 0, 0, 0 },
@@ -577,6 +597,7 @@ void option_error(void)
        }
 
        rprintf(FERROR, RSYNC_NAME ": %s", err_buf);
+       msleep(20);
 }
 
 
@@ -910,6 +931,10 @@ int parse_arguments(int *argc, const char ***argv, int frommain)
                        preserve_devices = preserve_specials = 0;
                        break;
 
+               case 'h':
+                       human_readable++;
+                       break;
+
                case 'i':
                        itemize_changes++;
                        break;
@@ -1023,15 +1048,14 @@ int parse_arguments(int *argc, const char ***argv, int frommain)
                                        MAX_BASIS_DIRS, dest_option);
                                return 0;
                        }
-                       arg = poptGetOptArg(pc);
-                       if (sanitize_paths)
-                               arg = sanitize_path(NULL, arg, NULL, 0);
-                       basis_dir[basis_dir_cnt++] = (char *)arg;
+                       /* We defer sanitizing this arg until we know what
+                        * our destination directory is going to be. */
+                       basis_dir[basis_dir_cnt++] = (char *)poptGetOptArg(pc);
                        break;
 
                case OPT_CHMOD:
                        arg = poptGetOptArg(pc);
-                       if (!(chmod_modes = parse_chmod(arg, chmod_modes))) {
+                       if (!parse_chmod(arg, &chmod_modes)) {
                                snprintf(err_buf, sizeof err_buf,
                                    "Invalid argument passed to --chmod (%s)\n",
                                    arg);
@@ -1059,6 +1083,7 @@ int parse_arguments(int *argc, const char ***argv, int frommain)
        }
 
        if (human_readable && *argc == 2) {
+               /* Allow the old meaning of 'h' (--help) on its own. */
                usage(FINFO);
                exit_cleanup(0);
        }
@@ -1152,11 +1177,10 @@ int parse_arguments(int *argc, const char ***argv, int frommain)
                }
                delete_mode = delete_before = 1;
        }
-       saw_delete_opt = delete_mode;
-       saw_delete_excluded_opt = delete_excluded;
-       if (!xfer_dirs) {
-               delete_before = delete_during = delete_after = 0;
-               delete_mode = delete_excluded = 0;
+       if (!xfer_dirs && delete_mode) {
+               snprintf(err_buf, sizeof err_buf,
+                       "--delete does not work without -r or -d.\n");
+               return 0;
        }
 
        if (delete_mode && refused_delete) {
@@ -1251,7 +1275,7 @@ int parse_arguments(int *argc, const char ***argv, int frommain)
                snprintf(err_buf, sizeof err_buf,
                        "--suffix cannot be a null string without --backup-dir\n");
                return 0;
-       } else if (delete_mode && !delete_excluded) {
+       } else if (make_backups && delete_mode && !delete_excluded) {
                snprintf(backup_dir_buf, sizeof backup_dir_buf,
                        "P *%s", backup_suffix);
                parse_rule(&filter_list, backup_dir_buf, 0, 0);
@@ -1273,8 +1297,7 @@ int parse_arguments(int *argc, const char ***argv, int frommain)
                log_before_transfer = !am_server;
        }
 
-       if ((do_progress || dry_run) && !verbose && !log_before_transfer
-           && !am_server)
+       if (do_progress && !verbose && !log_before_transfer && !am_server)
                verbose = 1;
 
        if (dry_run)
@@ -1319,7 +1342,7 @@ int parse_arguments(int *argc, const char ***argv, int frommain)
        }
 
        if (delay_updates && !partial_dir)
-               partial_dir = partialdir_for_delayupdate;
+               partial_dir = tmp_partialdir;
 
        if (inplace) {
 #ifdef HAVE_FTRUNCATE
@@ -1345,7 +1368,7 @@ int parse_arguments(int *argc, const char ***argv, int frommain)
                return 0;
 #endif
        } else {
-               if (keep_partial && !partial_dir) {
+               if (keep_partial && !partial_dir && !am_server) {
                        if ((arg = getenv("RSYNC_PARTIAL_DIR")) != NULL && *arg)
                                partial_dir = strdup(arg);
                }
@@ -1435,6 +1458,7 @@ void server_options(char **args,int *argc)
        if (blocking_io == -1)
                blocking_io = 0;
 
+       /* This should always remain first on the server's command-line. */
        args[ac++] = "--server";
 
        if (daemon_over_rsh) {
@@ -1457,16 +1481,25 @@ void server_options(char **args,int *argc)
                argstr[x++] = 'b';
        if (update_only)
                argstr[x++] = 'u';
-       if (!do_xfers) /* NOT "dry_run"! */
+       if (!do_xfers) /* Note: NOT "dry_run"! */
                argstr[x++] = 'n';
        if (preserve_links)
                argstr[x++] = 'l';
-       if (copy_links)
-               argstr[x++] = 'L';
        if (xfer_dirs > (recurse || !delete_mode || !am_sender))
                argstr[x++] = 'd';
-       if (keep_dirlinks && am_sender)
-               argstr[x++] = 'K';
+       if (am_sender) {
+               if (keep_dirlinks)
+                       argstr[x++] = 'K';
+               if (prune_empty_dirs)
+                       argstr[x++] = 'm';
+               if (omit_dir_times == 2)
+                       argstr[x++] = 'O';
+       } else {
+               if (copy_links)
+                       argstr[x++] = 'L';
+               if (copy_dirlinks)
+                       argstr[x++] = 'k';
+       }
 
        if (whole_file > 0)
                argstr[x++] = 'W';
@@ -1484,10 +1517,10 @@ void server_options(char **args,int *argc)
                argstr[x++] = 'D';
        if (preserve_times)
                argstr[x++] = 't';
-       if (omit_dir_times == 2 && am_sender)
-               argstr[x++] = 'O';
        if (preserve_perms)
                argstr[x++] = 'p';
+       else if (preserve_executability && am_sender)
+               argstr[x++] = 'E';
        if (recurse)
                argstr[x++] = 'r';
        if (always_checksum)
@@ -1615,11 +1648,12 @@ void server_options(char **args,int *argc)
                        args[ac++] = "--force";
                if (write_batch < 0)
                        args[ac++] = "--only-write-batch=X";
+               if (am_root > 1)
+                       args[ac++] = "--super";
+               if (size_only)
+                       args[ac++] = "--size-only";
        }
 
-       if (size_only)
-               args[ac++] = "--size-only";
-
        if (modify_window_set) {
                if (asprintf(&arg, "--modify-window=%d", modify_window) < 0)
                        goto oom;
@@ -1633,13 +1667,13 @@ void server_options(char **args,int *argc)
        }
 
        if (partial_dir && am_sender) {
-               if (partial_dir != partialdir_for_delayupdate) {
+               if (partial_dir != tmp_partialdir) {
                        args[ac++] = "--partial-dir";
                        args[ac++] = partial_dir;
                }
                if (delay_updates)
                        args[ac++] = "--delay-updates";
-       } else if (keep_partial)
+       } else if (keep_partial && am_sender)
                args[ac++] = "--partial";
 
        if (ignore_errors)
@@ -1666,7 +1700,7 @@ void server_options(char **args,int *argc)
        else if (inplace)
                args[ac++] = "--inplace";
 
-       if (tmpdir) {
+       if (tmpdir && am_sender) {
                args[ac++] = "--temp-dir";
                args[ac++] = tmpdir;
        }