John E. Malmberg convinced me to standardize on #ifs for defined
[rsync/rsync.git] / util.c
diff --git a/util.c b/util.c
index 449b101..eb55713 100644 (file)
--- a/util.c
+++ b/util.c
@@ -32,7 +32,7 @@ extern int dry_run;
 extern int module_id;
 extern int modify_window;
 extern char *partial_dir;
-extern struct exclude_list_struct server_exclude_list;
+extern struct filter_list_struct server_filter_list;
 
 int sanitize_paths = 0;
 
@@ -79,7 +79,7 @@ int fd_pair(int fd[2])
 {
        int ret;
 
-#if HAVE_SOCKETPAIR
+#ifdef HAVE_SOCKETPAIR
        ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
 #else
        ret = pipe(fd);
@@ -105,9 +105,9 @@ void print_child_argv(char **cmd)
                           "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
                           "0123456789"
                           ",.-_=+@/") != strlen(*cmd)) {
-                       rprintf(FINFO, "\"%s\" ", *cmd);
+                       rprintf(FINFO, "\"%s\" ", safe_fname(*cmd));
                } else {
-                       rprintf(FINFO, "%s ", *cmd);
+                       rprintf(FINFO, "%s ", safe_fname(*cmd));
                }
        }
        rprintf(FINFO, "\n");
@@ -130,22 +130,22 @@ void overflow(char *str)
 
 int set_modtime(char *fname, time_t modtime)
 {
-       if (dry_run)
-               return 0;
-
        if (verbose > 2) {
                rprintf(FINFO, "set modtime of %s to (%ld) %s",
-                       fname, (long)modtime,
+                       safe_fname(fname), (long)modtime,
                        asctime(localtime(&modtime)));
        }
 
+       if (dry_run)
+               return 0;
+
        {
 #ifdef HAVE_UTIMBUF
                struct utimbuf tbuf;
                tbuf.actime = time(NULL);
                tbuf.modtime = modtime;
                return utime(fname,&tbuf);
-#elif defined(HAVE_UTIME)
+#elif defined HAVE_UTIME
                time_t t[2];
                t[0] = time(NULL);
                t[1] = modtime;
@@ -197,7 +197,7 @@ int create_directory_path(char *fname, int base_umask)
  *
  * Derived from GNU C's cccp.c.
  */
-static int full_write(int desc, char *ptr, size_t len)
+int full_write(int desc, char *ptr, size_t len)
 {
        int total_written;
 
@@ -245,7 +245,7 @@ static int safe_read(int desc, char *ptr, size_t len)
 
 /** Copy a file.
  *
- * This is used in conjunction with the --temp-dir option */
+ * This is used in conjunction with the --temp-dir and --backup options */
 int copy_file(char *source, char *dest, mode_t mode)
 {
        int ifd;
@@ -350,7 +350,7 @@ int robust_unlink(char *fname)
 
        if (verbose > 0) {
                rprintf(FINFO,"renaming %s to %s because of text busy\n",
-                       fname, path);
+                       safe_fname(fname), safe_fname(path));
        }
 
        /* maybe we should return rename()'s exit status? Nah. */
@@ -479,14 +479,14 @@ int lock_range(int fd, int offset, int len)
        return fcntl(fd,F_SETLK,&lock) == 0;
 }
 
-static int exclude_server_path(char *arg)
+static int filter_server_path(char *arg)
 {
        char *s;
 
-       if (server_exclude_list.head) {
+       if (server_filter_list.head) {
                for (s = arg; (s = strchr(s, '/')) != NULL; ) {
                        *s = '\0';
-                       if (check_exclude(&server_exclude_list, arg, 1) < 0) {
+                       if (check_filter(&server_filter_list, arg, 1) < 0) {
                                /* We must leave arg truncated! */
                                return 1;
                        }
@@ -502,7 +502,7 @@ static void glob_expand_one(char *s, char ***argv_ptr, int *argc_ptr,
        char **argv = *argv_ptr;
        int argc = *argc_ptr;
        int maxargs = *maxargs_ptr;
-#if !(defined(HAVE_GLOB) && defined(HAVE_GLOB_H))
+#if !defined HAVE_GLOB || !defined HAVE_GLOB_H
        if (argc == maxargs) {
                maxargs += MAX_ARGS;
                if (!(argv = realloc_array(argv, char *, maxargs)))
@@ -513,7 +513,7 @@ static void glob_expand_one(char *s, char ***argv_ptr, int *argc_ptr,
        if (!*s)
                s = ".";
        s = argv[argc++] = strdup(s);
-       exclude_server_path(s);
+       filter_server_path(s);
 #else
        glob_t globbuf;
        int i;
@@ -524,12 +524,12 @@ static void glob_expand_one(char *s, char ***argv_ptr, int *argc_ptr,
                s = ".";
 
        if (sanitize_paths)
-               s = sanitize_path(NULL, s, NULL);
+               s = sanitize_path(NULL, s, "", 0);
        else
                s = strdup(s);
 
        memset(&globbuf, 0, sizeof globbuf);
-       if (!exclude_server_path(s))
+       if (!filter_server_path(s))
                glob(s, 0, NULL, &globbuf);
        if (MAX((int)globbuf.gl_pathc, 1) > maxargs - argc) {
                maxargs += globbuf.gl_pathc + MAX_ARGS;
@@ -650,7 +650,25 @@ size_t stringjoin(char *dest, size_t destsize, ...)
        return ret;
 }
 
-unsigned int clean_fname(char *name)
+int count_dir_elements(const char *p)
+{
+       int cnt = 0, new_component = 1;
+       while (*p) {
+               if (*p++ == '/')
+                       new_component = 1;
+               else if (new_component) {
+                       new_component = 0;
+                       cnt++;
+               }
+       }
+       return cnt;
+}
+
+/* Turns multiple adjacent slashes into a single slash, gets rid of "./"
+ * elements (but not a trailing dot dir), removes a trailing slash, and
+ * optionally collapses ".." elements (except for those at the start of the
+ * string).  If the resulting name would be empty, change it into a ".". */
+unsigned int clean_fname(char *name, BOOL collapse_dot_dot)
 {
        char *limit = name - 1, *t = name, *f = name;
        int anchored;
@@ -673,7 +691,8 @@ unsigned int clean_fname(char *name)
                                continue;
                        }
                        /* collapse ".." dirs */
-                       if (f[1] == '.' && (f[2] == '/' || !f[2])) {
+                       if (collapse_dot_dot
+                           && f[1] == '.' && (f[2] == '/' || !f[2])) {
                                char *s = t - 1;
                                if (s == name && anchored) {
                                        f += 2;
@@ -685,9 +704,7 @@ unsigned int clean_fname(char *name)
                                        f += 2;
                                        continue;
                                }
-                               *t++ = *f++;
-                               *t++ = *f++;
-                               limit = t;
+                               limit = t + 2;
                        }
                }
                while (*f && (*t++ = *f++) != '/') {}
@@ -706,37 +723,36 @@ unsigned int clean_fname(char *name)
  * "/" (either removing it or expanding it) and any leading or embedded
  * ".." components that attempt to escape past the module's top dir.
  *
- * If dest is NULL, a buffer is allocated to hold the result.  If dest is
- * the same buffer as p (the path) OR if reldir is NULL, a leading slash
- * is dropped instead of being expanded to be the module's top dir.
+ * If dest is NULL, a buffer is allocated to hold the result.  It is legal
+ * to call with the dest and the path (p) pointing to the same buffer, but
+ * rootdir will be ignored to avoid expansion of the string.
  *
- * If reldir is non-NULL (and non-empty), it is a sanitized directory that
- * the path will be relative to, so allow as many '..'s at the beginning of
- * the path as there are components in reldir.  This is used for symbolic
- * link targets.  If reldir is non-null and the path began with "/", to be
- * completely like a chroot we should add in depth levels of ".." at the
- * beginning of the path, but that would blow the assumption that the path
- * doesn't grow and it is not likely to end up being a valid symlink
- * anyway, so just do the normal removal of the leading "/" instead.
+ * The rootdir string contains a value to use in place of a leading slash.
+ * Specify NULL to get the default of lp_path(module_id).
  *
- * While we're at it, remove double slashes and "." components like
- * clean_fname() does, but DON'T remove a trailing slash because that is
- * sometimes significant on command line arguments.
+ * If depth is >= 0, it is a count of how many '..'s to allow at the start
+ * of the path.  Use -1 to allow unlimited depth.
  *
- * If the resulting path would be empty, change it into ".".
- */
-char *sanitize_path(char *dest, const char *p, const char *reldir)
+ * We also clean the path in a manner similar to clean_fname() but with a
+ * few differences: 
+ *
+ * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
+ * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
+ * ALWAYS collapses ".." elements (except for those at the start of the
+ * string up to "depth" deep).  If the resulting name would be empty,
+ * change it into a ".". */
+char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth)
 {
        char *start, *sanp;
-       int depth = 0;
-       int allowdotdot = 0;
        int rlen = 0;
 
        if (dest != p) {
                int plen = strlen(p);
-               if (*p == '/' && reldir) {
-                       rlen = strlen(lp_path(module_id));
-                       reldir = NULL;
+               if (*p == '/') {
+                       if (!rootdir)
+                               rootdir = lp_path(module_id);
+                       rlen = strlen(rootdir);
+                       depth = 0;
                        p++;
                }
                if (dest) {
@@ -745,53 +761,32 @@ char *sanitize_path(char *dest, const char *p, const char *reldir)
                } else if (!(dest = new_array(char, rlen + plen + 1)))
                        out_of_memory("sanitize_path");
                if (rlen) {
-                       memcpy(dest, lp_path(module_id), rlen);
+                       memcpy(dest, rootdir, rlen);
                        if (rlen > 1)
                                dest[rlen++] = '/';
                }
        }
 
-       if (reldir) {
-               int new_component = 1;
-               while (*reldir) {
-                       if (*reldir++ == '/')
-                               new_component = 1;
-                       else if (new_component) {
-                               new_component = 0;
-                               depth++;
-                       }
-               }
-       }
-
        start = sanp = dest + rlen;
-       while (*p == '/') {
-               /* remove leading slashes */
-               p++;
-       }
        while (*p != '\0') {
+               /* discard leading or extra slashes */
+               if (*p == '/') {
+                       p++;
+                       continue;
+               }
                /* this loop iterates once per filename component in p.
                 * both p (and sanp if the original had a slash) should
                 * always be left pointing after a slash
                 */
                if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
                        /* skip "." component */
-                       while (*++p == '/') {
-                               /* skip following slashes */
-                               ;
-                       }
+                       p++;
                        continue;
                }
-               allowdotdot = 0;
                if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
                        /* ".." component followed by slash or end */
-                       if (depth > 0 && sanp == start) {
-                               /* allow depth levels of .. at the beginning */
-                               --depth;
-                               allowdotdot = 1;
-                       } else {
+                       if (depth <= 0 || sanp != start) {
                                p += 2;
-                               if (*p == '/')
-                                       p++;
                                if (sanp != start) {
                                        /* back up sanp one level */
                                        --sanp; /* now pointing at slash */
@@ -802,22 +797,13 @@ char *sanitize_path(char *dest, const char *p, const char *reldir)
                                }
                                continue;
                        }
-               }
-               while (1) {
-                       /* copy one component through next slash */
-                       *sanp++ = *p++;
-                       if (*p == '\0' || p[-1] == '/') {
-                               while (*p == '/') {
-                                       /* skip multiple slashes */
-                                       p++;
-                               }
-                               break;
-                       }
-               }
-               if (allowdotdot) {
+                       /* allow depth levels of .. at the beginning */
+                       depth--;
                        /* move the virtual beginning to leave the .. alone */
-                       start = sanp;
+                       start = sanp + 3;
                }
+               /* copy one component through next slash */
+               while (*p && (*sanp++ = *p++) != '/') {}
        }
        if (sanp == dest) {
                /* ended up with nothing, so put in "." component */
@@ -869,7 +855,7 @@ int push_dir(char *dir)
                curr_dir_len += len;
        }
 
-       curr_dir_len = clean_fname(curr_dir);
+       curr_dir_len = clean_fname(curr_dir, 1);
 
        return 1;
 }
@@ -897,21 +883,24 @@ int pop_dir(char *dir)
  **/
 const char *safe_fname(const char *fname)
 {
-       static char fbuf1[MAXPATHLEN], fbuf2[MAXPATHLEN];
-       static char *fbuf = fbuf2;
-       char *nl = strchr(fname, '\n');
-
-       if (!nl)
-               return fname;
-
-       fbuf = fbuf == fbuf1 ? fbuf2 : fbuf1;
-       strlcpy(fbuf, fname, MAXPATHLEN);
-       nl = fbuf + (nl - (char *)fname);
-       do {
-               *nl = '?';
-       } while ((nl = strchr(nl+1, '\n')) != NULL);
+#define MAX_SAFE_NAMES 4
+       static char fbuf[MAX_SAFE_NAMES][MAXPATHLEN*2];
+       static int ndx = 0;
+       int limit = sizeof fbuf / MAX_SAFE_NAMES - 1;
+       char *t;
+
+       ndx = (ndx + 1) % MAX_SAFE_NAMES;
+       for (t = fbuf[ndx]; *fname; fname++) {
+               if (!isprint(*fname))
+                       *t++ = '?';
+               else
+                       *t++ = *fname;
+               if (--limit == 0)
+                       break;
+       }
+       *t = '\0';
 
-       return fbuf;
+       return fbuf[ndx];
 }
 
 /**
@@ -980,9 +969,17 @@ char *partial_dir_fname(const char *fname)
                fn = fname;
        if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
                return NULL;
-       if (server_exclude_list.head
-           && check_exclude(&server_exclude_list, partial_fname, 0) < 0)
-               return NULL;
+       if (server_filter_list.head) {
+               static int len;
+               if (!len)
+                       len = strlen(partial_dir);
+               t[len] = '\0';
+               if (check_filter(&server_filter_list, partial_fname, 1) < 0)
+                       return NULL;
+               t[len] = '/';
+               if (check_filter(&server_filter_list, partial_fname, 0) < 0)
+                       return NULL;
+       }
 
        return partial_fname;
 }
@@ -1004,11 +1001,7 @@ int handle_partial_dir(const char *fname, int create)
        dir = partial_fname;
        if (create) {
                STRUCT_STAT st;
-#if SUPPORT_LINKS
                int statret = do_lstat(dir, &st);
-#else
-               int statret = do_stat(dir, &st);
-#endif
                if (statret == 0 && !S_ISDIR(st.st_mode)) {
                        if (do_unlink(dir) < 0)
                                return 0;