Fixed a bunch of "warn_unused_result" compiler warnings.
[rsync/rsync.git] / batch.c
diff --git a/batch.c b/batch.c
index 8d3f796..a351041 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-2008 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 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 char *batch_name;
+#ifdef ICONV_OPTION
+extern char *iconv_opt;
+#endif
+
+extern struct filter_list_struct 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_batch_argvs_file(int argc, char *argv[])
+void write_stream_flags(int fd)
 {
-       int fd, i;
-       char filename[MAXPATHLEN];
+       int i, flags;
 
-       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(1);
+       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;
        }
+       write_int(fd, flags);
+}
 
-       /* Write argvs info to BATCH.rsync_argvs file */
-       for (i = 0; i < argc; i++) {
-               if (i == argc - 2) /* Skip source directory on cmdline */
-                       continue;
-               if (strncmp(argv[i], "--files-from", 12) == 0) {
-                       if (strchr(argv[i], '=') == NULL)
-                               i++;
-                       continue;
+void read_stream_flags(int fd)
+{
+       batch_stream_flags = read_int(fd);
+}
+
+void check_batch_flags(void)
+{
+       int i;
+
+       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;
                }
-               if (i != 0)
-                       write(fd, " ", 1);
-               if (strncmp(argv[i], "--write-batch", 13) == 0) {
-                       write(fd, "--read", 6);
-                       write(fd, argv[i] + 7, strlen(argv[i] + 7));
-               } else if (i == argc - 1) {
-                       char *p = find_colon(argv[i]);
-                       if (p) {
-                               if (*++p == ':')
-                                       p++;
-                       } else
-                               p = argv[i];
-                       write(fd, "${1:-", 5);
-                       write(fd, p, strlen(p));
-                       write(fd, "}", 1);
-               } else
-                       write(fd, argv[i], strlen(argv[i]));
        }
-       if (write(fd, "\n", 1) != 1 || close(fd) < 0) {
-               rsyserr(FERROR, errno, "Batch file %s write error", filename);
-               exit_cleanup(1);
+       if (protocol_version < 29) {
+               if (recurse)
+                       xfer_dirs |= 1;
+               else if (xfer_dirs < 2)
+                       xfer_dirs = 0;
        }
+
+       if (tweaked_append)
+               append_mode = 1;
+       else if (tweaked_append_verify)
+               append_mode = 2;
 }
 
-void show_flist(int index, struct file_struct **fptr)
+static int write_arg(int fd, char *arg)
 {
-       /*  for debugging    show_flist(flist->count, flist->files * */
+       char *x, *s;
+       int len, ret = 0;
 
-       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);
+       if (*arg == '-' && (x = strchr(arg, '=')) != NULL) {
+               if (write(fd, arg, x - arg + 1) != x - arg + 1)
+                       ret = -1;
+               arg += x - arg + 1;
        }
+
+       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;
+       }
+
+       len = strlen(arg);
+       if (write(fd, arg, len) != len)
+               ret = -1;
+
+       return ret;
 }
 
-void show_argvs(int argc, char *argv[])
+static void write_filter_rules(int fd)
 {
-       /*  for debugging  * */
+       struct filter_struct *ent;
 
-       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]);
+       write_sbuf(fd, " <<'#E#'\n");
+       for (ent = filter_list.head; ent; ent = ent->next) {
+               unsigned int plen;
+               char *p = get_rule_prefix(ent->match_flags, "- ", 0, &plen);
+               write_buf(fd, p, plen);
+               write_sbuf(fd, ent->pattern);
+               if (ent->match_flags & MATCHFLG_DIRECTORY)
+                       write_byte(fd, '/');
+               write_byte(fd, eol_nulls ? 0 : '\n');
+       }
+       if (eol_nulls)
+               write_sbuf(fd, ";\n");
+       write_sbuf(fd, "#E#");
+}
+
+/* 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)
+{
+       int fd, i, len, err = 0;
+       char *p, filename[MAXPATHLEN];
 
+       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);
+       }
+
+       /* 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=-");
+       }
+       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;
+               }
+       }
+       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);
        }
 }