Support for ": dirconf/per-dir-rules", in progress. wip/perdir-merge-2.1
authorMatt McCutchen <matt@mattmccutchen.net>
Mon, 18 Aug 2008 01:36:51 +0000 (21:36 -0400)
committerMatt McCutchen <matt@mattmccutchen.net>
Mon, 10 Nov 2008 16:08:28 +0000 (11:08 -0500)
exclude.c

index d449144..f46b3e7 100644 (file)
--- a/exclude.c
+++ b/exclude.c
@@ -150,6 +150,15 @@ static void free_filters(struct filter_struct *head)
        }
 }
 
+/* Helper for identifying duplicate per-dir merge rules. */
+static const char *perdir_merge_relative_part(const char *merge_file)
+{
+       if (merge_file[0] == '/' || strncmp(merge_file, "../", 3) == 0)
+               return strrchr(merge_file, '/') + 1; /* There is a slash. */
+       else
+               return merge_file;
+}
+
 /* Build a filter structure given a filter pattern.  The value in "pat"
  * is not null-terminated. */
 static void add_rule(struct filter_list_struct *listp, const char *pat,
@@ -247,26 +256,22 @@ static void add_rule(struct filter_list_struct *listp, const char *pat,
 
        if (mflags & MATCHFLG_PERDIR_MERGE) {
                struct filter_list_struct *lp;
-               unsigned int len;
                int i;
 
-               if ((cp = strrchr(ret->pattern, '/')) != NULL)
-                       cp++;
-               else
-                       cp = ret->pattern;
-
-               /* If the local merge file was already mentioned, don't
+               clean_fname(ret->pattern, CFN_COLLAPSE_DOT_DOT_DIRS);
+               /* Throw out a corner case so that we are left with either a
+                * ..-free path (relative) or an absolute or ../-starting path
+                * (parent_dirscanning).. */
+               if (strcmp(ret->pattern, "..") == 0) {
+                       rprintf(FERROR, "Dir-merging .. is not allowed.\n");
+                       exit_cleanup(RERR_UNSUPPORTED);
+               }
+               /* If this per-dir merge file was already mentioned, don't
                 * add it again. */
+               cp = perdir_merge_relative_part(ret->pattern);
                for (i = 0; i < mergelist_cnt; i++) {
                        struct filter_struct *ex = mergelist_parents[i];
-                       const char *s = strrchr(ex->pattern, '/');
-                       if (s)
-                               s++;
-                       else
-                               s = ex->pattern;
-                       len = strlen(s);
-                       if (len == pat_len - (cp - ret->pattern)
-                           && memcmp(s, cp, len) == 0) {
+                       if (strcmp(cp, perdir_merge_relative_part(ex->pattern)) == 0) {
                                free_filter(ret);
                                return;
                        }
@@ -319,33 +324,53 @@ static void clear_filter_list(struct filter_list_struct *listp)
        listp->head = listp->tail = NULL;
 }
 
-/* This returns an expanded (absolute) filename for the merge-file name if
- * the name has any slashes in it OR if the parent_dirscan var is True;
- * otherwise it returns the original merge_file name.  If the len_ptr value
- * is non-NULL the merge_file name is limited by the referenced length
- * value and will be updated with the length of the resulting name.  We
- * always return a name that is null terminated, even if the merge_file
- * name was not. */
+/* parse_merge_name is called to process merge-file names in three cases:
+ *
+ * 1. When an non-per-dir merge rule is added.
+ *    - Sanitize path using NULL (module_dir) and dirbuf_depth (which is 0 as
+ *      desired if the rule came from initial filter processing rather than a
+ *      per-dir merge file).  If non-sanitizing, just cancel .. components.
+ *    - If the path is relative, prepend dirbuf.  During initial filter
+ *      processing, dirbuf is empty, so this step has no effect and we will
+ *      follow the path relative to the current directory, as desired.  From a
+ *      per-dir merge file, this step makes the path absolute so that we
+ *      interpret it correctly.
+ * 2. When a dir-merge rule is set up (setup_merge_file), with dirbuf containing
+ *    the topmost dir to which it will apply.
+ *    - Sanitize path using NULL (module_dir) and dirbuf_depth.  If non-
+ *      sanitizing, just cancel .. components.
+ *    - If the path begins with ../, then prepend the dirbuf, yielding an
+ *      absolute path.
+ *    - A path that is absolute at this point will activate the parent_dirscan
+ *      in setup_merge_file, while a relative path (which contains no .. due to
+ *      sanitization/cleaning) will be stored for following from each dir.
+ * 3. When a dir-merge rule is added during another parent_dirscan.
+ *    - We want to interpret the rule relative to the ancestor dir in which it
+ *      was defined, even though we don't actually push into that dir to set up
+ *      the rule.  Thus, we apply the same processing as in #2 while we have the
+ *      desired dirbuf value, leaving an absolute or ..-free relative path that
+ *      #2 won't modify further, except...
+ *    - #2 will prepend the module_dir to an absolute path, so we are passed
+ *      prefix_skip == module_dirlen to avoid prepending a duplicate module_dir
+ *      now.
+ *
+ * FIXME: A per-dir merge rule added during a parent-dirscan needs to load
+ * files in the same ancestor dirs, so it should be made absolute
+ * unconditionally.  This might make a relative rule parent-dirscanning, and
+ * it will mess up multicomponent relative rules.  Quite possibly I should
+ * introduce a better syntax that allows separate specification of the relative
+ * and parent-dirscanning parts of the path, like ./ for --relative.
+ *
+ * When this is called on a rule addition (#1 or #3), merge_file is not null-
+ * terminated, but len_ptr points to its length and is updated with the length
+ * of the result.  In all cases, the result is null-terminated. */
 static char *parse_merge_name(const char *merge_file, unsigned int *len_ptr,
-                             unsigned int prefix_skip)
+                             unsigned int prefix_skip, BOOL is_perdir)
 {
        static char buf[MAXPATHLEN];
        char *fn, tmpbuf[MAXPATHLEN];
        unsigned int fn_len;
 
-       if (!parent_dirscan && *merge_file != '/') {
-               /* Return the name unchanged it doesn't have any slashes. */
-               if (len_ptr) {
-                       const char *p = merge_file + *len_ptr;
-                       while (--p > merge_file && *p != '/') {}
-                       if (p == merge_file) {
-                               strlcpy(buf, merge_file, *len_ptr + 1);
-                               return buf;
-                       }
-               } else if (strchr(merge_file, '/') == NULL)
-                       return (char *)merge_file;
-       }
-
        fn = *merge_file == '/' ? buf : tmpbuf;
        if (sanitize_paths) {
                const char *r = prefix_skip ? "/" : NULL;
@@ -366,8 +391,10 @@ static char *parse_merge_name(const char *merge_file, unsigned int *len_ptr,
                fn_len = clean_fname(fn, CFN_COLLAPSE_DOT_DOT_DIRS);
        }
 
-       /* If the name isn't in buf yet, it's wasn't absolute. */
-       if (fn != buf) {
+       /* If the name isn't in buf yet, it's relative.  In case #1, we want to
+        * prepend the dirbuf unconditionally.  Otherwise, we want to make
+        * parent_dirscan-activating paths absolute but leave others alone. */
+       if (fn != buf && (!is_perdir || strncmp(fn, "../", 3) == 0)) {
                int d_len = dirbuf_len - prefix_skip;
                if (d_len + fn_len >= MAXPATHLEN) {
                        rprintf(FERROR, "merge-file name overflows: %s\n", fn);
@@ -375,12 +402,13 @@ static char *parse_merge_name(const char *merge_file, unsigned int *len_ptr,
                }
                memcpy(buf, dirbuf + prefix_skip, d_len);
                memcpy(buf + d_len, fn, fn_len + 1);
+               fn = buf;
                fn_len = clean_fname(buf, CFN_COLLAPSE_DOT_DOT_DIRS);
        }
 
        if (len_ptr)
                *len_ptr = fn_len;
-       return buf;
+       return fn;
 }
 
 /* Sets the dirbuf and dirbuf_len values. */
@@ -420,7 +448,9 @@ static BOOL setup_merge_file(int mergelist_num, struct filter_struct *ex,
        char *x, *y, *pat = ex->pattern;
        unsigned int len;
 
-       if (!(x = parse_merge_name(pat, NULL, 0)) || *x != '/')
+       /* Case #2 in parse_merge_name comment: make a parent_dirscanning path
+        * absolute. */
+       if (!(x = parse_merge_name(pat, NULL, 0, True)) || *x != '/')
                return 0;
 
        if (DEBUG_GTE(FILTER, 2)) {
@@ -1091,14 +1121,21 @@ void parse_rule(struct filter_list_struct *listp, const char *pattern,
                        }
                        if (new_mflags & MATCHFLG_PERDIR_MERGE) {
                                if (parent_dirscan) {
+                                       /* Case #3 in parse_merge_name comment:
+                                        * record correct starting dir for a
+                                        * parent_dirscanning per-dir merge rule
+                                        * found during another parent_dirscan. */
                                        if (!(p = parse_merge_name(cp, &len,
-                                                               module_dirlen)))
+                                                               module_dirlen, True)))
                                                continue;
                                        add_rule(listp, p, len, new_mflags, 0);
                                        continue;
                                }
                        } else {
-                               if (!(p = parse_merge_name(cp, &len, 0)))
+                               /* Case #1 in parse_merge_name comment:
+                                * interpret the path w.r.t. the correct
+                                * directory. */
+                               if (!(p = parse_merge_name(cp, &len, 0, False)))
                                        continue;
                                parse_filter_file(listp, p, new_mflags,
                                                  XFLG_FATAL_ERRORS);