Man page: Move the description of --info=progress2 to a better place.
[rsync/rsync.git] / batch.c
diff --git a/batch.c b/batch.c
index ade9484..b63f0c5 100644 (file)
--- a/batch.c
+++ b/batch.c
-/* -*- c-file-style: "linux" -*-
-
-   Weiss 1/1999
-   Batch utilities for rsync.
-
-*/
+/*
+ * Support for the batch-file options.
+ *
+ * Copyright (C) 1999 Weiss
+ * Copyright (C) 2004 Chris Shoemaker
+ * Copyright (C) 2004-2009 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
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * 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, visit the http://fsf.org website.
+ */
 
 #include "rsync.h"
+#include "zlib/zlib.h"
 #include <time.h>
 
-extern char *batch_prefix;
-extern int csum_length;
+extern int eol_nulls;
+extern int recurse;
+extern int xfer_dirs;
+extern int preserve_links;
+extern int preserve_hard_links;
+extern int preserve_devices;
+extern int preserve_uid;
+extern int preserve_gid;
+extern int preserve_acls;
+extern int preserve_xattrs;
+extern int always_checksum;
+extern int do_compression;
+extern int inplace;
+extern int append_mode;
 extern int protocol_version;
-extern struct stats stats;
-
-struct file_list *batch_flist;
-
-static char rsync_flist_file[] = ".rsync_flist";
-static char rsync_csums_file[] = ".rsync_csums";
-static char rsync_delta_file[] = ".rsync_delta";
-static char rsync_argvs_file[] = ".rsync_argvs";
-
-static int f_csums = -1;
-static int f_delta = -1;
-
-void write_batch_flist_info(int flist_count, struct file_struct **files)
+extern char *batch_name;
+#ifdef ICONV_OPTION
+extern char *iconv_opt;
+#endif
+
+extern filter_rule_list filter_list;
+
+int batch_stream_flags;
+
+static int tweaked_append;
+static int tweaked_append_verify;
+static int tweaked_iconv;
+
+static int *flag_ptr[] = {
+       &recurse,               /* 0 */
+       &preserve_uid,          /* 1 */
+       &preserve_gid,          /* 2 */
+       &preserve_links,        /* 3 */
+       &preserve_devices,      /* 4 */
+       &preserve_hard_links,   /* 5 */
+       &always_checksum,       /* 6 */
+       &xfer_dirs,             /* 7 (protocol 29) */
+       &do_compression,        /* 8 (protocol 29) */
+       &tweaked_iconv,         /* 9  (protocol 30) */
+       &preserve_acls,         /* 10 (protocol 30) */
+       &preserve_xattrs,       /* 11 (protocol 30) */
+       &inplace,               /* 12 (protocol 30) */
+       &tweaked_append,        /* 13 (protocol 30) */
+       &tweaked_append_verify, /* 14 (protocol 30) */
+       NULL
+};
+
+static char *flag_name[] = {
+       "--recurse (-r)",
+       "--owner (-o)",
+       "--group (-g)",
+       "--links (-l)",
+       "--devices (-D)",
+       "--hard-links (-H)",
+       "--checksum (-c)",
+       "--dirs (-d)",
+       "--compress (-z)",
+       "--iconv",
+       "--acls (-A)",
+       "--xattrs (-X)",
+       "--inplace",
+       "--append",
+       "--append-verify",
+       NULL
+};
+
+void write_stream_flags(int fd)
 {
-       char filename[MAXPATHLEN];
-       int i, f, save_pv;
-       int64 save_written;
-
-       stringjoin(filename, sizeof filename,
-           batch_prefix, rsync_flist_file, NULL);
-
-       f = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
-       if (f < 0) {
-               rsyserr(FERROR, errno, "Batch file %s open error", filename);
-               exit_cleanup(1);
-       }
-
-       save_written = stats.total_written;
-       save_pv = protocol_version;
-       protocol_version = PROTOCOL_VERSION;
-       write_int(f, protocol_version);
-       write_int(f, flist_count);
-
-       for (i = 0; i < flist_count; i++) {
-               send_file_entry(files[i], f,
-                   files[i]->flags & FLAG_TOP_DIR ?  XMIT_TOP_DIR : 0);
+       int i, flags;
+
+       tweaked_append = append_mode == 1;
+       tweaked_append_verify = append_mode == 2;
+#ifdef ICONV_OPTION
+       tweaked_iconv = iconv_opt != NULL;
+#endif
+
+       /* Start the batch file with a bitmap of data-stream-affecting
+        * flags. */
+       for (i = 0, flags = 0; flag_ptr[i]; i++) {
+               if (*flag_ptr[i])
+                       flags |= 1 << i;
        }
-       send_file_entry(NULL, f, 0);
-
-       protocol_version = save_pv;
-       stats.total_written = save_written;
-
-       close(f);
+       write_int(fd, flags);
 }
 
-
-void write_batch_argvs_file(int argc, char *argv[])
+void read_stream_flags(int fd)
 {
-       int f;
-       int i;
-       char buff[256]; /* XXX */
-       char buff2[MAXPATHLEN + 6];
-       char filename[MAXPATHLEN];
-
-       stringjoin(filename, sizeof filename,
-           batch_prefix, rsync_argvs_file, NULL);
-
-       f = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
-           S_IRUSR | S_IWUSR | S_IEXEC);
-       if (f < 0) {
-               rsyserr(FERROR, errno, "Batch file %s open error", filename);
-               exit_cleanup(1);
-       }
-       buff[0] = '\0';
-
-       /* Write argvs info to batch file */
-
-       for (i = 0; i < argc; ++i) {
-               if (i == argc - 2) /* Skip source directory on cmdline */
-                       continue;
-               /*
-                * FIXME:
-                * I think directly manipulating argv[] is probably bogus
-                */
-               if (!strncmp(argv[i], "--write-batch",
-                   strlen("--write-batch"))) {
-                       /* Safer to change it here than script */
-                       /*
-                        * Change to --read-batch=prefix
-                        * to get ready for remote
-                        */
-                       strlcat(buff, "--read-batch=", sizeof buff);
-                       strlcat(buff, batch_prefix, sizeof buff);
-               } else
-               if (i == argc - 1) {
-                       snprintf(buff2, sizeof buff2, "${1:-%s}", argv[i]);
-                       strlcat(buff, buff2, sizeof buff);
-               }
-               else {
-                       strlcat(buff, argv[i], sizeof buff);
-               }
-
-               if (i < (argc - 1)) {
-                       strlcat(buff, " ", sizeof buff);
-               }
-       }
-       strlcat(buff, "\n", sizeof buff);
-       if (!write(f, buff, strlen(buff))) {
-               rsyserr(FERROR, errno, "Batch file %s write error", filename);
-               close(f);
-               exit_cleanup(1);
-       }
-       close(f);
+       batch_stream_flags = read_int(fd);
 }
 
-struct file_list *create_flist_from_batch(void)
+void check_batch_flags(void)
 {
-       char filename[MAXPATHLEN];
-       unsigned short flags;
-       int i, f, save_pv;
-       int64 save_read;
-
-       stringjoin(filename, sizeof filename,
-           batch_prefix, rsync_flist_file, NULL);
+       int i;
 
-       f = do_open(filename, O_RDONLY, 0);
-       if (f < 0) {
-               rsyserr(FERROR, errno, "Batch file %s open error", filename);
-               exit_cleanup(1);
+       if (protocol_version < 29)
+               flag_ptr[7] = NULL;
+       else if (protocol_version < 30)
+               flag_ptr[9] = NULL;
+       tweaked_append = append_mode == 1;
+       tweaked_append_verify = append_mode == 2;
+#ifdef ICONV_OPTION
+       tweaked_iconv = iconv_opt != NULL;
+#endif
+       for (i = 0; flag_ptr[i]; i++) {
+               int set = batch_stream_flags & (1 << i) ? 1 : 0;
+               if (*flag_ptr[i] != set) {
+                       if (i == 9) {
+                               rprintf(FERROR,
+                                       "%s specify the --iconv option to use this batch file.\n",
+                                       set ? "Please" : "Do not");
+                               exit_cleanup(RERR_SYNTAX);
+                       }
+                       if (INFO_GTE(MISC, 1)) {
+                               rprintf(FINFO,
+                                       "%sing the %s option to match the batchfile.\n",
+                                       set ? "Sett" : "Clear", flag_name[i]);
+                       }
+                       *flag_ptr[i] = set;
+               }
        }
-
-       batch_flist = flist_new(WITH_HLINK, "create_flist_from_batch");
-
-       save_read = stats.total_read;
-       save_pv = protocol_version;
-       protocol_version = read_int(f);
-
-       batch_flist->count = read_int(f);
-       flist_expand(batch_flist);
-
-       for (i = 0; (flags = read_byte(f)) != 0; i++) {
-               if (protocol_version >= 28 && (flags & XMIT_EXTENDED_FLAGS))
-                       flags |= read_byte(f) << 8;
-               receive_file_entry(&batch_flist->files[i], flags, batch_flist, f);
+       if (protocol_version < 29) {
+               if (recurse)
+                       xfer_dirs |= 1;
+               else if (xfer_dirs < 2)
+                       xfer_dirs = 0;
        }
-       receive_file_entry(NULL, 0, NULL, 0); /* Signal that we're done. */
-
-       protocol_version = save_pv;
-       stats.total_read = save_read;
 
-       return batch_flist;
+       if (tweaked_append)
+               append_mode = 1;
+       else if (tweaked_append_verify)
+               append_mode = 2;
 }
 
-void write_batch_csums_file(void *buff, int bytes_to_write)
+static int write_arg(int fd, char *arg)
 {
-       if (write(f_csums, buff, bytes_to_write) < 0) {
-               rsyserr(FERROR, errno, "Batch file write error");
-               close(f_csums);
-               exit_cleanup(1);
-       }
-}
-
-void close_batch_csums_file(void)
-{
-       close(f_csums);
-       f_csums = -1;
-}
-
+       char *x, *s;
+       int len, ret = 0;
 
-/**
- * Write csum info to batch file
- *
- * @todo This will break if s->count is ever larger than maxint.  The
- * batch code should probably be changed to consistently use the
- * variable-length integer routines, which is probably a compatible
- * change.
- **/
-void write_batch_csum_info(int *flist_entry, struct sum_struct *s)
-{
-       size_t i;
-       int int_count;
-       char filename[MAXPATHLEN];
-
-       if (f_csums < 0) {
-               stringjoin(filename, sizeof filename,
-                   batch_prefix, rsync_csums_file, NULL);
-
-               f_csums = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
-                   S_IRUSR | S_IWUSR);
-               if (f_csums < 0) {
-                       rsyserr(FERROR, errno, "Batch file %s open error",
-                               filename);
-                       close(f_csums);
-                       exit_cleanup(1);
-               }
+       if (*arg == '-' && (x = strchr(arg, '=')) != NULL) {
+               if (write(fd, arg, x - arg + 1) != x - arg + 1)
+                       ret = -1;
+               arg += x - arg + 1;
        }
 
-       write_batch_csums_file(flist_entry, sizeof (int));
-       int_count = s ? (int) s->count : 0;
-       write_batch_csums_file(&int_count, sizeof int_count);
-
-       if (s) {
-               for (i = 0; i < s->count; i++) {
-                       write_batch_csums_file(&s->sums[i].sum1,
-                           sizeof (uint32));
-                       write_batch_csums_file(s->sums[i].sum2, csum_length);
+       if (strpbrk(arg, " \"'&;|[]()$#!*?^\\") != NULL) {
+               if (write(fd, "'", 1) != 1)
+                       ret = -1;
+               for (s = arg; (x = strchr(s, '\'')) != NULL; s = x + 1) {
+                       if (write(fd, s, x - s + 1) != x - s + 1
+                        || write(fd, "'", 1) != 1)
+                               ret = -1;
                }
+               len = strlen(s);
+               if (write(fd, s, len) != len
+                || write(fd, "'", 1) != 1)
+                       ret = -1;
+               return ret;
        }
-}
 
-int read_batch_csums_file(char *buff, int len)
-{
-       int bytes_read;
+       len = strlen(arg);
+       if (write(fd, arg, len) != len)
+               ret = -1;
 
-       if ((bytes_read = read(f_csums, buff, len)) < 0) {
-               rsyserr(FERROR, errno, "Batch file read error");
-               close(f_csums);
-               exit_cleanup(1);
-       }
-       return bytes_read;
+       return ret;
 }
 
-void read_batch_csum_info(int flist_entry, struct sum_struct *s,
-                         int *checksums_match)
+static void write_filter_rules(int fd)
 {
-       int i;
-       int file_flist_entry;
-       int file_chunk_ct;
-       uint32 file_sum1;
-       char file_sum2[SUM_LENGTH];
-       char filename[MAXPATHLEN];
-
-       if (f_csums < 0) {
-               stringjoin(filename, sizeof filename,
-                   batch_prefix, rsync_csums_file, NULL);
-
-               f_csums = do_open(filename, O_RDONLY, 0);
-               if (f_csums < 0) {
-                       rsyserr(FERROR, errno, "Batch file %s open error",
-                               filename);
-                       close(f_csums);
-                       exit_cleanup(1);
-               }
-       }
-
-       read_batch_csums_file((char *) &file_flist_entry, sizeof (int));
-       if (file_flist_entry != flist_entry) {
-               rprintf(FINFO, "file_flist_entry (%d) != flist_entry (%d)\n",
-                   file_flist_entry, flist_entry);
-               close(f_csums);
-               exit_cleanup(1);
-
-       } else {
-               read_batch_csums_file((char *) &file_chunk_ct, sizeof (int));
-               *checksums_match = 1;
-               for (i = 0; i < file_chunk_ct; i++) {
-                       read_batch_csums_file((char *) &file_sum1,
-                           sizeof (uint32));
-                       read_batch_csums_file(file_sum2, csum_length);
-
-                       if ((s->sums[i].sum1 != file_sum1)
-                           || memcmp(s->sums[i].sum2, file_sum2, csum_length))
-                               *checksums_match = 0;
-               }               /*  end for  */
+       filter_rule *ent;
+
+       write_sbuf(fd, " <<'#E#'\n");
+       for (ent = filter_list.head; ent; ent = ent->next) {
+               unsigned int plen;
+               char *p = get_rule_prefix(ent, "- ", 0, &plen);
+               write_buf(fd, p, plen);
+               write_sbuf(fd, ent->pattern);
+               if (ent->rflags & FILTRULE_DIRECTORY)
+                       write_byte(fd, '/');
+               write_byte(fd, eol_nulls ? 0 : '\n');
        }
+       if (eol_nulls)
+               write_sbuf(fd, ";\n");
+       write_sbuf(fd, "#E#");
 }
 
-void write_batch_delta_file(char *buff, int bytes_to_write)
+/* This routine tries to write out an equivalent --read-batch command
+ * given the user's --write-batch args.  However, it doesn't really
+ * understand most of the options, so it uses some overly simple
+ * heuristics to munge the command line into something that will
+ * (hopefully) work. */
+void write_batch_shell_file(int argc, char *argv[], int file_arg_cnt)
 {
-       char filename[MAXPATHLEN];
-
-       if (f_delta < 0) {
-               stringjoin(filename, sizeof filename,
-                   batch_prefix, rsync_delta_file, NULL);
+       int fd, i, len, err = 0;
+       char *p, filename[MAXPATHLEN];
 
-               f_delta = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
-                                 S_IRUSR | S_IWUSR);
-               if (f_delta < 0) {
-                       rsyserr(FERROR, errno, "Batch file %s open error",
-                               filename);
-                       exit_cleanup(1);
-               }
+       stringjoin(filename, sizeof filename,
+                  batch_name, ".sh", NULL);
+       fd = do_open(filename, O_WRONLY | O_CREAT | O_TRUNC,
+                    S_IRUSR | S_IWUSR | S_IEXEC);
+       if (fd < 0) {
+               rsyserr(FERROR, errno, "Batch file %s open error",
+                       filename);
+               exit_cleanup(RERR_FILESELECT);
        }
 
-       if (write(f_delta, buff, bytes_to_write) < 0) {
-               rsyserr(FERROR, errno, "Batch file %s write error", filename);
-               close(f_delta);
-               exit_cleanup(1);
+       /* Write argvs info to BATCH.sh file */
+       if (write_arg(fd, argv[0]) < 0)
+               err = 1;
+       if (filter_list.head) {
+               if (protocol_version >= 29)
+                       write_sbuf(fd, " --filter=._-");
+               else
+                       write_sbuf(fd, " --exclude-from=-");
        }
-}
-
-void close_batch_delta_file(void)
-{
-       close(f_delta);
-       f_delta = -1;
-}
-
-int read_batch_delta_file(char *buff, int len)
-{
-       int bytes_read;
-       char filename[MAXPATHLEN];
-
-       if (f_delta < 0) {
-               stringjoin(filename, sizeof filename,
-                   batch_prefix, rsync_delta_file, NULL);
-
-               f_delta = do_open(filename, O_RDONLY, 0);
-               if (f_delta < 0) {
-                       rsyserr(FERROR, errno, "Batch file %s open error",
-                               filename);
-                       close(f_delta);
-                       exit_cleanup(1);
+       for (i = 1; i < argc - file_arg_cnt; i++) {
+               p = argv[i];
+               if (strncmp(p, "--files-from", 12) == 0
+                   || strncmp(p, "--filter", 8) == 0
+                   || strncmp(p, "--include", 9) == 0
+                   || strncmp(p, "--exclude", 9) == 0) {
+                       if (strchr(p, '=') == NULL)
+                               i++;
+                       continue;
+               }
+               if (strcmp(p, "-f") == 0) {
+                       i++;
+                       continue;
+               }
+               if (write(fd, " ", 1) != 1)
+                       err = 1;
+               if (strncmp(p, "--write-batch", len = 13) == 0
+                || strncmp(p, "--only-write-batch", len = 18) == 0) {
+                       if (write(fd, "--read-batch", 12) != 12)
+                               err = 1;
+                       if (p[len] == '=') {
+                               if (write(fd, "=", 1) != 1
+                                || write_arg(fd, p + len + 1) < 0)
+                                       err = 1;
+                       }
+               } else {
+                       if (write_arg(fd, p) < 0)
+                               err = 1;
                }
        }
-
-       bytes_read = read(f_delta, buff, len);
-       if (bytes_read < 0) {
-               rsyserr(FERROR, errno, "Batch file %s read error", filename);
-               close(f_delta);
-               exit_cleanup(1);
-       }
-
-       return bytes_read;
-}
-
-void show_flist(int index, struct file_struct **fptr)
-{
-       /*  for debugging    show_flist(flist->count, flist->files * */
-
-       int i;
-       for (i = 0; i < index; i++) {
-               rprintf(FINFO, "flist->flags=%#x\n", fptr[i]->flags);
-               rprintf(FINFO, "flist->modtime=%#lx\n",
-                       (long unsigned) fptr[i]->modtime);
-               rprintf(FINFO, "flist->length=%.0f\n",
-                       (double) fptr[i]->length);
-               rprintf(FINFO, "flist->mode=%#o\n", (int) fptr[i]->mode);
-               rprintf(FINFO, "flist->basename=%s\n", fptr[i]->basename);
-               if (fptr[i]->dirname)
-                       rprintf(FINFO, "flist->dirname=%s\n",
-                               fptr[i]->dirname);
-               if (fptr[i]->basedir)
-                       rprintf(FINFO, "flist->basedir=%s\n",
-                               fptr[i]->basedir);
-       }
-}
-
-void show_argvs(int argc, char *argv[])
-{
-       /*  for debugging  * */
-
-       int i;
-       rprintf(FINFO, "BATCH.C:show_argvs,argc=%d\n", argc);
-       for (i = 0; i < argc; i++) {
-               /*    if (argv[i])   */
-               rprintf(FINFO, "i=%d,argv[i]=%s\n", i, argv[i]);
-
+       if (!(p = check_for_hostspec(argv[argc - 1], &p, &i)))
+               p = argv[argc - 1];
+       if (write(fd, " ${1:-", 6) != 6
+        || write_arg(fd, p) < 0)
+               err = 1;
+       write_byte(fd, '}');
+       if (filter_list.head)
+               write_filter_rules(fd);
+       if (write(fd, "\n", 1) != 1 || close(fd) < 0 || err) {
+               rsyserr(FERROR, errno, "Batch file %s write error",
+                       filename);
+               exit_cleanup(RERR_FILEIO);
        }
 }