2 * The filter include/exclude routines.
4 * Copyright (C) 1996-2001 Andrew Tridgell <tridge@samba.org>
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2002 Martin Pool
7 * Copyright (C) 2003, 2004, 2005, 2006 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
33 extern int local_server;
34 extern int prune_empty_dirs;
35 extern int ignore_perishable;
36 extern int delete_mode;
37 extern int delete_excluded;
38 extern int cvs_exclude;
39 extern int sanitize_paths;
40 extern int protocol_version;
43 extern char curr_dir[];
44 extern unsigned int curr_dir_len;
45 extern unsigned int module_dirlen;
47 struct filter_list_struct filter_list = { 0, 0, "" };
48 struct filter_list_struct cvs_filter_list = { 0, 0, " [global CVS]" };
49 struct filter_list_struct server_filter_list = { 0, 0, " [daemon]" };
51 /* Need room enough for ":MODS " prefix plus some room to grow. */
52 #define MAX_RULE_PREFIX (16)
54 #define MODIFIERS_MERGE_FILE "-+Cenw"
55 #define MODIFIERS_INCL_EXCL "/!Crsp"
56 #define MODIFIERS_HIDE_PROTECT "/!p"
58 /* The dirbuf is set by push_local_filters() to the current subdirectory
59 * relative to curr_dir that is being processed. The path always has a
60 * trailing slash appended, and the variable dirbuf_len contains the length
61 * of this path prefix. The path is always absolute. */
62 static char dirbuf[MAXPATHLEN+1];
63 static unsigned int dirbuf_len = 0;
64 static int dirbuf_depth;
66 /* This is True when we're scanning parent dirs for per-dir merge-files. */
67 static BOOL parent_dirscan = False;
69 /* This array contains a list of all the currently active per-dir merge
70 * files. This makes it easier to save the appropriate values when we
71 * "push" down into each subdirectory. */
72 static struct filter_struct **mergelist_parents;
73 static int mergelist_cnt = 0;
74 static int mergelist_size = 0;
76 /* Each filter_list_struct describes a singly-linked list by keeping track
77 * of both the head and tail pointers. The list is slightly unusual in that
78 * a parent-dir's content can be appended to the end of the local list in a
79 * special way: the last item in the local list has its "next" pointer set
80 * to point to the inherited list, but the local list's tail pointer points
81 * at the end of the local list. Thus, if the local list is empty, the head
82 * will be pointing at the inherited content but the tail will be NULL. To
83 * help you visualize this, here are the possible list arrangements:
85 * Completely Empty Local Content Only
86 * ================================== ====================================
87 * head -> NULL head -> Local1 -> Local2 -> NULL
88 * tail -> NULL tail -------------^
90 * Inherited Content Only Both Local and Inherited Content
91 * ================================== ====================================
92 * head -> Parent1 -> Parent2 -> NULL head -> L1 -> L2 -> P1 -> P2 -> NULL
93 * tail -> NULL tail ---------^
95 * This means that anyone wanting to traverse the whole list to use it just
96 * needs to start at the head and use the "next" pointers until it goes
97 * NULL. To add new local content, we insert the item after the tail item
98 * and update the tail (obviously, if "tail" was NULL, we insert it at the
99 * head). To clear the local list, WE MUST NOT FREE THE INHERITED CONTENT
100 * because it is shared between the current list and our parent list(s).
101 * The easiest way to handle this is to simply truncate the list after the
102 * tail item and then free the local list from the head. When inheriting
103 * the list for a new local dir, we just save off the filter_list_struct
104 * values (so we can pop back to them later) and set the tail to NULL.
107 static void free_filter(struct filter_struct *ex)
109 if (ex->match_flags & MATCHFLG_PERDIR_MERGE) {
110 free(ex->u.mergelist->debug_type);
111 free(ex->u.mergelist);
118 /* Build a filter structure given a filter pattern. The value in "pat"
119 * is not null-terminated. */
120 static void add_rule(struct filter_list_struct *listp, const char *pat,
121 unsigned int pat_len, uint32 mflags, int xflags)
123 struct filter_struct *ret;
128 rprintf(FINFO, "[%s] add_rule(%s%.*s%s)%s\n",
129 who_am_i(), get_rule_prefix(mflags, pat, 0, NULL),
131 (mflags & MATCHFLG_DIRECTORY) ? "/" : "",
135 /* These flags also indicate that we're reading a list that
136 * needs to be filtered now, not post-filtered later. */
137 if (xflags & (XFLG_ANCHORED2ABS|XFLG_ABS_IF_SLASH)) {
138 uint32 mf = mflags & (MATCHFLG_RECEIVER_SIDE|MATCHFLG_SENDER_SIDE);
140 if (mf == MATCHFLG_RECEIVER_SIDE)
143 if (mf == MATCHFLG_SENDER_SIDE)
148 if (!(ret = new(struct filter_struct)))
149 out_of_memory("add_rule");
150 memset(ret, 0, sizeof ret[0]);
152 if (!(mflags & (MATCHFLG_ABS_PATH | MATCHFLG_MERGE_FILE))
153 && ((xflags & (XFLG_ANCHORED2ABS|XFLG_ABS_IF_SLASH) && *pat == '/')
154 || (xflags & XFLG_ABS_IF_SLASH && strchr(pat, '/') != NULL))) {
155 mflags |= MATCHFLG_ABS_PATH;
157 ex_len = dirbuf_len - module_dirlen - 1;
162 if (!(ret->pattern = new_array(char, ex_len + pat_len + 1)))
163 out_of_memory("add_rule");
165 memcpy(ret->pattern, dirbuf + module_dirlen, ex_len);
166 strlcpy(ret->pattern + ex_len, pat, pat_len + 1);
169 if (strpbrk(ret->pattern, "*[?")) {
170 mflags |= MATCHFLG_WILD;
171 if ((cp = strstr(ret->pattern, "**")) != NULL) {
172 mflags |= MATCHFLG_WILD2;
173 /* If the pattern starts with **, note that. */
174 if (cp == ret->pattern)
175 mflags |= MATCHFLG_WILD2_PREFIX;
176 /* If the pattern ends with ***, note that. */
178 && ret->pattern[pat_len-3] == '*'
179 && ret->pattern[pat_len-2] == '*'
180 && ret->pattern[pat_len-1] == '*')
181 mflags |= MATCHFLG_WILD3_SUFFIX;
185 if (pat_len > 1 && ret->pattern[pat_len-1] == '/') {
186 ret->pattern[pat_len-1] = 0;
187 mflags |= MATCHFLG_DIRECTORY;
190 if (mflags & MATCHFLG_PERDIR_MERGE) {
191 struct filter_list_struct *lp;
195 if ((cp = strrchr(ret->pattern, '/')) != NULL)
200 /* If the local merge file was already mentioned, don't
202 for (i = 0; i < mergelist_cnt; i++) {
203 struct filter_struct *ex = mergelist_parents[i];
204 const char *s = strrchr(ex->pattern, '/');
210 if (len == pat_len - (cp - ret->pattern)
211 && memcmp(s, cp, len) == 0) {
217 if (!(lp = new_array(struct filter_list_struct, 1)))
218 out_of_memory("add_rule");
219 lp->head = lp->tail = NULL;
220 if (asprintf(&lp->debug_type, " [per-dir %s]", cp) < 0)
221 out_of_memory("add_rule");
222 ret->u.mergelist = lp;
224 if (mergelist_cnt == mergelist_size) {
226 mergelist_parents = realloc_array(mergelist_parents,
227 struct filter_struct *,
229 if (!mergelist_parents)
230 out_of_memory("add_rule");
232 mergelist_parents[mergelist_cnt++] = ret;
234 for (cp = ret->pattern; (cp = strchr(cp, '/')) != NULL; cp++)
238 ret->match_flags = mflags;
241 ret->next = listp->head;
242 listp->head = listp->tail = ret;
244 ret->next = listp->tail->next;
245 listp->tail->next = ret;
250 static void clear_filter_list(struct filter_list_struct *listp)
253 struct filter_struct *ent, *next;
254 /* Truncate any inherited items from the local list. */
255 listp->tail->next = NULL;
256 /* Now free everything that is left. */
257 for (ent = listp->head; ent; ent = next) {
263 listp->head = listp->tail = NULL;
266 /* This returns an expanded (absolute) filename for the merge-file name if
267 * the name has any slashes in it OR if the parent_dirscan var is True;
268 * otherwise it returns the original merge_file name. If the len_ptr value
269 * is non-NULL the merge_file name is limited by the referenced length
270 * value and will be updated with the length of the resulting name. We
271 * always return a name that is null terminated, even if the merge_file
273 static char *parse_merge_name(const char *merge_file, unsigned int *len_ptr,
274 unsigned int prefix_skip)
276 static char buf[MAXPATHLEN];
277 char *fn, tmpbuf[MAXPATHLEN];
280 if (!parent_dirscan && *merge_file != '/') {
281 /* Return the name unchanged it doesn't have any slashes. */
283 const char *p = merge_file + *len_ptr;
284 while (--p > merge_file && *p != '/') {}
285 if (p == merge_file) {
286 strlcpy(buf, merge_file, *len_ptr + 1);
289 } else if (strchr(merge_file, '/') == NULL)
290 return (char *)merge_file;
293 fn = *merge_file == '/' ? buf : tmpbuf;
294 if (sanitize_paths) {
295 const char *r = prefix_skip ? "/" : NULL;
296 /* null-terminate the name if it isn't already */
297 if (len_ptr && merge_file[*len_ptr]) {
298 char *to = fn == buf ? tmpbuf : buf;
299 strlcpy(to, merge_file, *len_ptr + 1);
302 if (!sanitize_path(fn, merge_file, r, dirbuf_depth, NULL)) {
303 rprintf(FERROR, "merge-file name overflows: %s\n",
309 strlcpy(fn, merge_file, len_ptr ? *len_ptr + 1 : MAXPATHLEN);
310 fn_len = clean_fname(fn, 1);
313 /* If the name isn't in buf yet, it's wasn't absolute. */
315 if (dirbuf_len + fn_len >= MAXPATHLEN) {
316 rprintf(FERROR, "merge-file name overflows: %s\n", fn);
319 memcpy(buf, dirbuf + prefix_skip, dirbuf_len - prefix_skip);
320 memcpy(buf + dirbuf_len - prefix_skip, fn, fn_len + 1);
321 fn_len = clean_fname(buf, 1);
329 /* Sets the dirbuf and dirbuf_len values. */
330 void set_filter_dir(const char *dir, unsigned int dirlen)
334 memcpy(dirbuf, curr_dir, curr_dir_len);
335 dirbuf[curr_dir_len] = '/';
336 len = curr_dir_len + 1;
337 if (len + dirlen >= MAXPATHLEN)
341 memcpy(dirbuf + len, dir, dirlen);
342 dirbuf[dirlen + len] = '\0';
343 dirbuf_len = clean_fname(dirbuf, 1);
344 if (dirbuf_len > 1 && dirbuf[dirbuf_len-1] == '.'
345 && dirbuf[dirbuf_len-2] == '/')
348 dirbuf[dirbuf_len++] = '/';
349 dirbuf[dirbuf_len] = '\0';
351 dirbuf_depth = count_dir_elements(dirbuf + module_dirlen);
354 /* This routine takes a per-dir merge-file entry and finishes its setup.
355 * If the name has a path portion then we check to see if it refers to a
356 * parent directory of the first transfer dir. If it does, we scan all the
357 * dirs from that point through the parent dir of the transfer dir looking
358 * for the per-dir merge-file in each one. */
359 static BOOL setup_merge_file(struct filter_struct *ex,
360 struct filter_list_struct *lp)
362 char buf[MAXPATHLEN];
363 char *x, *y, *pat = ex->pattern;
366 if (!(x = parse_merge_name(pat, NULL, 0)) || *x != '/')
371 ex->pattern = strdup(y+1);
375 strlcpy(buf, x, MAXPATHLEN);
377 pathjoin(buf, MAXPATHLEN, dirbuf, x);
379 len = clean_fname(buf, 1);
380 if (len != 1 && len < MAXPATHLEN-1) {
384 /* This ensures that the specified dir is a parent of the transfer. */
385 for (x = buf, y = dirbuf; *x && *x == *y; x++, y++) {}
387 y += strlen(y); /* nope -- skip the scan */
389 parent_dirscan = True;
391 char save[MAXPATHLEN];
392 strlcpy(save, y, MAXPATHLEN);
394 dirbuf_len = y - dirbuf;
395 strlcpy(x, ex->pattern, MAXPATHLEN - (x - buf));
396 parse_filter_file(lp, buf, ex->match_flags, XFLG_ANCHORED2ABS);
397 if (ex->match_flags & MATCHFLG_NO_INHERIT)
400 strlcpy(y, save, MAXPATHLEN);
401 while ((*x++ = *y++) != '/') {}
403 parent_dirscan = False;
408 /* Each time rsync changes to a new directory it call this function to
409 * handle all the per-dir merge-files. The "dir" value is the current path
410 * relative to curr_dir (which might not be null-terminated). We copy it
411 * into dirbuf so that we can easily append a file name on the end. */
412 void *push_local_filters(const char *dir, unsigned int dirlen)
414 struct filter_list_struct *ap, *push;
417 set_filter_dir(dir, dirlen);
422 push = new_array(struct filter_list_struct, mergelist_cnt);
424 out_of_memory("push_local_filters");
426 for (i = 0, ap = push; i < mergelist_cnt; i++) {
427 memcpy(ap++, mergelist_parents[i]->u.mergelist,
428 sizeof (struct filter_list_struct));
431 /* Note: parse_filter_file() might increase mergelist_cnt, so keep
432 * this loop separate from the above loop. */
433 for (i = 0; i < mergelist_cnt; i++) {
434 struct filter_struct *ex = mergelist_parents[i];
435 struct filter_list_struct *lp = ex->u.mergelist;
438 rprintf(FINFO, "[%s] pushing filter list%s\n",
439 who_am_i(), lp->debug_type);
442 lp->tail = NULL; /* Switch any local rules to inherited. */
443 if (ex->match_flags & MATCHFLG_NO_INHERIT)
446 if (ex->match_flags & MATCHFLG_FINISH_SETUP) {
447 ex->match_flags &= ~MATCHFLG_FINISH_SETUP;
448 if (setup_merge_file(ex, lp))
449 set_filter_dir(dir, dirlen);
452 if (strlcpy(dirbuf + dirbuf_len, ex->pattern,
453 MAXPATHLEN - dirbuf_len) < MAXPATHLEN - dirbuf_len) {
454 parse_filter_file(lp, dirbuf, ex->match_flags,
457 io_error |= IOERR_GENERAL;
459 "cannot add local filter rules in long-named directory: %s\n",
462 dirbuf[dirbuf_len] = '\0';
468 void pop_local_filters(void *mem)
470 struct filter_list_struct *ap, *pop = (struct filter_list_struct*)mem;
473 for (i = mergelist_cnt; i-- > 0; ) {
474 struct filter_struct *ex = mergelist_parents[i];
475 struct filter_list_struct *lp = ex->u.mergelist;
478 rprintf(FINFO, "[%s] popping filter list%s\n",
479 who_am_i(), lp->debug_type);
482 clear_filter_list(lp);
488 for (i = 0, ap = pop; i < mergelist_cnt; i++) {
489 memcpy(mergelist_parents[i]->u.mergelist, ap++,
490 sizeof (struct filter_list_struct));
496 void change_local_filter_dir(const char *dname, int dlen, int dir_depth)
498 static int min_depth = MAXPATHLEN, cur_depth = -1;
499 static void *filt_array[MAXPATHLEN/2+1];
502 while (cur_depth >= min_depth)
503 pop_local_filters(filt_array[cur_depth--]);
504 min_depth = MAXPATHLEN;
509 assert(dir_depth < MAXPATHLEN/2+1);
511 while (cur_depth >= dir_depth && cur_depth >= min_depth)
512 pop_local_filters(filt_array[cur_depth--]);
513 cur_depth = dir_depth;
514 if (cur_depth < min_depth)
515 min_depth = cur_depth;
517 filt_array[cur_depth] = push_local_filters(dname, dlen);
520 static int rule_matches(char *name, struct filter_struct *ex, int name_is_dir)
522 int slash_handling, str_cnt = 0, anchored_match = 0;
523 int ret_match = ex->match_flags & MATCHFLG_NEGATE ? 0 : 1;
524 char *p, *pattern = ex->pattern;
525 const char *strings[16]; /* more than enough */
532 if (!ex->u.slash_cnt && !(ex->match_flags & MATCHFLG_WILD2)) {
533 /* If the pattern does not have any slashes AND it does
534 * not have a "**" (which could match a slash), then we
535 * just match the name portion of the path. */
536 if ((p = strrchr(name,'/')) != NULL)
538 } else if (ex->match_flags & MATCHFLG_ABS_PATH && *name != '/'
539 && curr_dir_len > module_dirlen + 1) {
540 /* If we're matching against an absolute-path pattern,
541 * we need to prepend our full path info. */
542 strings[str_cnt++] = curr_dir + module_dirlen + 1;
543 strings[str_cnt++] = "/";
544 } else if (ex->match_flags & MATCHFLG_WILD2_PREFIX && *name != '/') {
545 /* Allow "**"+"/" to match at the start of the string. */
546 strings[str_cnt++] = "/";
548 strings[str_cnt++] = name;
550 /* Allow a trailing "/"+"***" to match the directory. */
551 if (ex->match_flags & MATCHFLG_WILD3_SUFFIX)
552 strings[str_cnt++] = "/";
553 } else if (ex->match_flags & MATCHFLG_DIRECTORY)
555 strings[str_cnt] = NULL;
557 if (*pattern == '/') {
562 if (!anchored_match && ex->u.slash_cnt
563 && !(ex->match_flags & MATCHFLG_WILD2)) {
564 /* A non-anchored match with an infix slash and no "**"
565 * needs to match the last slash_cnt+1 name elements. */
566 slash_handling = ex->u.slash_cnt + 1;
567 } else if (!anchored_match && !(ex->match_flags & MATCHFLG_WILD2_PREFIX)
568 && ex->match_flags & MATCHFLG_WILD2) {
569 /* A non-anchored match with an infix or trailing "**" (but not
570 * a prefixed "**") needs to try matching after every slash. */
573 /* The pattern matches only at the start of the path or name. */
577 if (ex->match_flags & MATCHFLG_WILD) {
578 if (wildmatch_array(pattern, strings, slash_handling))
580 } else if (str_cnt > 1) {
581 if (litmatch_array(pattern, strings, slash_handling))
583 } else if (anchored_match) {
584 if (strcmp(name, pattern) == 0)
587 int l1 = strlen(name);
588 int l2 = strlen(pattern);
590 strcmp(name+(l1-l2),pattern) == 0 &&
591 (l1==l2 || name[l1-(l2+1)] == '/')) {
600 static void report_filter_result(char const *name,
601 struct filter_struct const *ent,
602 int name_is_dir, const char *type)
604 /* If a trailing slash is present to match only directories,
605 * then it is stripped out by add_rule(). So as a special
606 * case we add it back in here. */
609 static char *actions[2][2]
610 = { {"show", "hid"}, {"risk", "protect"} };
611 const char *w = who_am_i();
612 rprintf(FINFO, "[%s] %sing %s %s because of pattern %s%s%s\n",
613 w, actions[*w!='s'][!(ent->match_flags&MATCHFLG_INCLUDE)],
614 name_is_dir ? "directory" : "file", name, ent->pattern,
615 ent->match_flags & MATCHFLG_DIRECTORY ? "/" : "", type);
621 * Return -1 if file "name" is defined to be excluded by the specified
622 * exclude list, 1 if it is included, and 0 if it was not matched.
624 int check_filter(struct filter_list_struct *listp, char *name, int name_is_dir)
626 struct filter_struct *ent;
628 for (ent = listp->head; ent; ent = ent->next) {
629 if (ignore_perishable && ent->match_flags & MATCHFLG_PERISHABLE)
631 if (ent->match_flags & MATCHFLG_PERDIR_MERGE) {
632 int rc = check_filter(ent->u.mergelist, name,
638 if (ent->match_flags & MATCHFLG_CVS_IGNORE) {
639 int rc = check_filter(&cvs_filter_list, name,
645 if (rule_matches(name, ent, name_is_dir)) {
646 report_filter_result(name, ent, name_is_dir,
648 return ent->match_flags & MATCHFLG_INCLUDE ? 1 : -1;
655 #define RULE_STRCMP(s,r) rule_strcmp((s), (r), sizeof (r) - 1)
657 static const uchar *rule_strcmp(const uchar *str, const char *rule, int rule_len)
659 if (strncmp((char*)str, rule, rule_len) != 0)
661 if (isspace(str[rule_len]) || str[rule_len] == '_' || !str[rule_len])
662 return str + rule_len - 1;
663 if (str[rule_len] == ',')
664 return str + rule_len;
668 /* Get the next include/exclude arg from the string. The token will not
669 * be '\0' terminated, so use the returned length to limit the string.
670 * Also, be sure to add this length to the returned pointer before passing
671 * it back to ask for the next token. This routine parses the "!" (list-
672 * clearing) token and (depending on the mflags) the various prefixes.
673 * The *mflags_ptr value will be set on exit to the new MATCHFLG_* bits
674 * for the current token. */
675 static const char *parse_rule_tok(const char *p, uint32 mflags, int xflags,
676 unsigned int *len_ptr, uint32 *mflags_ptr)
678 const uchar *s = (const uchar *)p;
682 if (mflags & MATCHFLG_WORD_SPLIT) {
683 /* Skip over any initial whitespace. */
686 /* Update to point to real start of rule. */
692 new_mflags = mflags & MATCHFLGS_FROM_CONTAINER;
694 /* Figure out what kind of a filter rule "s" is pointing at. Note
695 * that if MATCHFLG_NO_PREFIXES is set, the rule is either an include
696 * or an exclude based on the inheritance of the MATCHFLG_INCLUDE
697 * flag (above). XFLG_OLD_PREFIXES indicates a compatibility mode
698 * for old include/exclude patterns where just "+ " and "- " are
699 * allowed as optional prefixes. */
700 if (mflags & MATCHFLG_NO_PREFIXES) {
701 if (*s == '!' && mflags & MATCHFLG_CVS_IGNORE)
702 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
703 } else if (xflags & XFLG_OLD_PREFIXES) {
704 if (*s == '-' && s[1] == ' ') {
705 new_mflags &= ~MATCHFLG_INCLUDE;
707 } else if (*s == '+' && s[1] == ' ') {
708 new_mflags |= MATCHFLG_INCLUDE;
710 } else if (*s == '!')
711 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
713 char ch = 0, *mods = "";
716 if ((s = RULE_STRCMP(s, "clear")) != NULL)
720 if ((s = RULE_STRCMP(s, "dir-merge")) != NULL)
724 if ((s = RULE_STRCMP(s, "exclude")) != NULL)
728 if ((s = RULE_STRCMP(s, "hide")) != NULL)
732 if ((s = RULE_STRCMP(s, "include")) != NULL)
736 if ((s = RULE_STRCMP(s, "merge")) != NULL)
740 if ((s = RULE_STRCMP(s, "protect")) != NULL)
744 if ((s = RULE_STRCMP(s, "risk")) != NULL)
748 if ((s = RULE_STRCMP(s, "show")) != NULL)
759 new_mflags |= MATCHFLG_PERDIR_MERGE
760 | MATCHFLG_FINISH_SETUP;
763 new_mflags |= MATCHFLG_MERGE_FILE;
764 mods = MODIFIERS_INCL_EXCL MODIFIERS_MERGE_FILE;
767 new_mflags |= MATCHFLG_INCLUDE;
770 mods = MODIFIERS_INCL_EXCL;
773 new_mflags |= MATCHFLG_INCLUDE;
776 new_mflags |= MATCHFLG_SENDER_SIDE;
777 mods = MODIFIERS_HIDE_PROTECT;
780 new_mflags |= MATCHFLG_INCLUDE;
783 new_mflags |= MATCHFLG_RECEIVER_SIDE;
784 mods = MODIFIERS_HIDE_PROTECT;
787 new_mflags |= MATCHFLG_CLEAR_LIST;
791 rprintf(FERROR, "Unknown filter rule: `%s'\n", p);
792 exit_cleanup(RERR_SYNTAX);
794 while (mods && *++s && *s != ' ' && *s != '_') {
795 if (strchr(mods, *s) == NULL) {
796 if (mflags & MATCHFLG_WORD_SPLIT && isspace(*s)) {
802 "invalid modifier sequence at '%c' in filter rule: %s\n",
804 exit_cleanup(RERR_SYNTAX);
808 if (new_mflags & MATCHFLG_NO_PREFIXES)
810 new_mflags |= MATCHFLG_NO_PREFIXES;
813 if (new_mflags & MATCHFLG_NO_PREFIXES)
815 new_mflags |= MATCHFLG_NO_PREFIXES
819 new_mflags |= MATCHFLG_ABS_PATH;
822 new_mflags |= MATCHFLG_NEGATE;
825 if (new_mflags & MATCHFLG_NO_PREFIXES)
827 new_mflags |= MATCHFLG_NO_PREFIXES
828 | MATCHFLG_WORD_SPLIT
829 | MATCHFLG_NO_INHERIT
830 | MATCHFLG_CVS_IGNORE;
833 new_mflags |= MATCHFLG_EXCLUDE_SELF;
836 new_mflags |= MATCHFLG_NO_INHERIT;
839 new_mflags |= MATCHFLG_PERISHABLE;
842 new_mflags |= MATCHFLG_RECEIVER_SIDE;
845 new_mflags |= MATCHFLG_SENDER_SIDE;
848 new_mflags |= MATCHFLG_WORD_SPLIT;
856 if (mflags & MATCHFLG_WORD_SPLIT) {
858 /* Token ends at whitespace or the end of the string. */
859 while (!isspace(*cp) && *cp != '\0')
863 len = strlen((char*)s);
865 if (new_mflags & MATCHFLG_CLEAR_LIST) {
866 if (!(mflags & MATCHFLG_NO_PREFIXES)
867 && !(xflags & XFLG_OLD_PREFIXES) && len) {
869 "'!' rule has trailing characters: %s\n", p);
870 exit_cleanup(RERR_SYNTAX);
873 new_mflags &= ~MATCHFLG_CLEAR_LIST;
874 } else if (!len && !(new_mflags & MATCHFLG_CVS_IGNORE)) {
875 rprintf(FERROR, "unexpected end of filter rule: %s\n", p);
876 exit_cleanup(RERR_SYNTAX);
879 /* --delete-excluded turns an un-modified include/exclude into a
880 * sender-side rule. We also affect per-dir merge files that take
881 * no prefixes as a simple optimization. */
883 && !(new_mflags & (MATCHFLG_RECEIVER_SIDE|MATCHFLG_SENDER_SIDE))
884 && (!(new_mflags & MATCHFLG_PERDIR_MERGE)
885 || new_mflags & MATCHFLG_NO_PREFIXES))
886 new_mflags |= MATCHFLG_SENDER_SIDE;
889 *mflags_ptr = new_mflags;
890 return (const char *)s;
894 static char default_cvsignore[] =
895 /* These default ignored items come from the CVS manual. */
896 "RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS"
897 " .make.state .nse_depinfo *~ #* .#* ,* _$* *$"
898 " *.old *.bak *.BAK *.orig *.rej .del-*"
899 " *.a *.olb *.o *.obj *.so *.exe"
900 " *.Z *.elc *.ln core"
901 /* The rest we added to suit ourself. */
904 static void get_cvs_excludes(uint32 mflags)
906 static int initialized = 0;
907 char *p, fname[MAXPATHLEN];
913 parse_rule(&cvs_filter_list, default_cvsignore,
914 mflags | (protocol_version >= 30 ? MATCHFLG_PERISHABLE : 0),
917 p = module_id >= 0 && lp_use_chroot(module_id) ? "/" : getenv("HOME");
918 if (p && pathjoin(fname, MAXPATHLEN, p, ".cvsignore") < MAXPATHLEN)
919 parse_filter_file(&cvs_filter_list, fname, mflags, 0);
921 parse_rule(&cvs_filter_list, getenv("CVSIGNORE"), mflags, 0);
925 void parse_rule(struct filter_list_struct *listp, const char *pattern,
926 uint32 mflags, int xflags)
928 unsigned int pat_len;
936 /* Remember that the returned string is NOT '\0' terminated! */
937 cp = parse_rule_tok(pattern, mflags, xflags,
938 &pat_len, &new_mflags);
942 pattern = cp + pat_len;
944 if (pat_len >= MAXPATHLEN) {
945 rprintf(FERROR, "discarding over-long filter: %.*s\n",
950 if (new_mflags & MATCHFLG_CLEAR_LIST) {
953 "[%s] clearing filter list%s\n",
954 who_am_i(), listp->debug_type);
956 clear_filter_list(listp);
960 if (new_mflags & MATCHFLG_MERGE_FILE) {
967 if (new_mflags & MATCHFLG_EXCLUDE_SELF) {
968 const char *name = cp + len;
969 while (name > cp && name[-1] != '/') name--;
971 add_rule(listp, name, len, 0, 0);
972 new_mflags &= ~MATCHFLG_EXCLUDE_SELF;
975 if (new_mflags & MATCHFLG_PERDIR_MERGE) {
976 if (parent_dirscan) {
977 if (!(p = parse_merge_name(cp, &len,
980 add_rule(listp, p, len, new_mflags, 0);
984 if (!(p = parse_merge_name(cp, &len, 0)))
986 parse_filter_file(listp, p, new_mflags,
992 add_rule(listp, cp, pat_len, new_mflags, xflags);
994 if (new_mflags & MATCHFLG_CVS_IGNORE
995 && !(new_mflags & MATCHFLG_MERGE_FILE))
996 get_cvs_excludes(new_mflags);
1001 void parse_filter_file(struct filter_list_struct *listp, const char *fname,
1002 uint32 mflags, int xflags)
1005 char line[BIGPATHBUFLEN];
1006 char *eob = line + sizeof line - 1;
1007 int word_split = mflags & MATCHFLG_WORD_SPLIT;
1009 if (!fname || !*fname)
1012 if (*fname != '-' || fname[1] || am_server) {
1013 if (server_filter_list.head) {
1014 strlcpy(line, fname, sizeof line);
1015 clean_fname(line, 1);
1016 if (check_filter(&server_filter_list, line, 0) < 0)
1019 fp = fopen(line, "rb");
1021 fp = fopen(fname, "rb");
1026 rprintf(FINFO, "[%s] parse_filter_file(%s,%x,%x)%s\n",
1027 who_am_i(), fname, mflags, xflags,
1028 fp ? "" : " [not found]");
1032 if (xflags & XFLG_FATAL_ERRORS) {
1033 rsyserr(FERROR, errno,
1034 "failed to open %sclude file %s",
1035 mflags & MATCHFLG_INCLUDE ? "in" : "ex",
1037 exit_cleanup(RERR_FILEIO);
1041 dirbuf[dirbuf_len] = '\0';
1045 int ch, overflow = 0;
1047 if ((ch = getc(fp)) == EOF) {
1048 if (ferror(fp) && errno == EINTR) {
1054 if (word_split && isspace(ch))
1056 if (eol_nulls? !ch : (ch == '\n' || ch == '\r'))
1064 rprintf(FERROR, "discarding over-long filter: %s...\n", line);
1068 /* Skip an empty token and (when line parsing) comments. */
1069 if (*line && (word_split || (*line != ';' && *line != '#')))
1070 parse_rule(listp, line, mflags, xflags);
1077 /* If the "for_xfer" flag is set, the prefix is made compatible with the
1078 * current protocol_version (if possible) or a NULL is returned (if not
1080 char *get_rule_prefix(int match_flags, const char *pat, int for_xfer,
1081 unsigned int *plen_ptr)
1083 static char buf[MAX_RULE_PREFIX+1];
1085 int legal_len = for_xfer && protocol_version < 29 ? 1 : MAX_RULE_PREFIX-1;
1087 if (match_flags & MATCHFLG_PERDIR_MERGE) {
1091 } else if (match_flags & MATCHFLG_INCLUDE)
1093 else if (legal_len != 1
1094 || ((*pat == '-' || *pat == '+') && pat[1] == ' '))
1099 if (match_flags & MATCHFLG_NEGATE)
1101 if (match_flags & MATCHFLG_CVS_IGNORE)
1104 if (match_flags & MATCHFLG_NO_INHERIT)
1106 if (match_flags & MATCHFLG_WORD_SPLIT)
1108 if (match_flags & MATCHFLG_NO_PREFIXES) {
1109 if (match_flags & MATCHFLG_INCLUDE)
1115 if (match_flags & MATCHFLG_EXCLUDE_SELF)
1117 if (match_flags & MATCHFLG_SENDER_SIDE
1118 && (!for_xfer || protocol_version >= 29))
1120 if (match_flags & MATCHFLG_RECEIVER_SIDE
1121 && (!for_xfer || protocol_version >= 29
1122 || (delete_excluded && am_sender)))
1124 if (match_flags & MATCHFLG_PERISHABLE) {
1125 if (!for_xfer || protocol_version >= 30)
1130 if (op - buf > legal_len)
1136 *plen_ptr = op - buf;
1140 static void send_rules(int f_out, struct filter_list_struct *flp)
1142 struct filter_struct *ent, *prev = NULL;
1144 for (ent = flp->head; ent; ent = ent->next) {
1145 unsigned int len, plen, dlen;
1149 /* Note we need to check delete_excluded here in addition to
1150 * the code in parse_rule_tok() because some rules may have
1151 * been added before we found the --delete-excluded option.
1152 * We must also elide any CVS merge-file rules to avoid a
1153 * backward compatibility problem, and we elide any no-prefix
1154 * merge files as an optimization (since they can only have
1155 * include/exclude rules). */
1156 if (ent->match_flags & MATCHFLG_SENDER_SIDE)
1157 elide = am_sender ? 1 : -1;
1158 if (ent->match_flags & MATCHFLG_RECEIVER_SIDE)
1159 elide = elide ? 0 : am_sender ? -1 : 1;
1160 else if (delete_excluded && !elide
1161 && (!(ent->match_flags & MATCHFLG_PERDIR_MERGE)
1162 || ent->match_flags & MATCHFLG_NO_PREFIXES))
1163 elide = am_sender ? 1 : -1;
1166 prev->next = ent->next;
1168 flp->head = ent->next;
1173 if (ent->match_flags & MATCHFLG_CVS_IGNORE
1174 && !(ent->match_flags & MATCHFLG_MERGE_FILE)) {
1175 int f = am_sender || protocol_version < 29 ? f_out : -2;
1176 send_rules(f, &cvs_filter_list);
1180 p = get_rule_prefix(ent->match_flags, ent->pattern, 1, &plen);
1183 "filter rules are too modern for remote rsync.\n");
1184 exit_cleanup(RERR_PROTOCOL);
1188 len = strlen(ent->pattern);
1189 dlen = ent->match_flags & MATCHFLG_DIRECTORY ? 1 : 0;
1190 if (!(plen + len + dlen))
1192 write_int(f_out, plen + len + dlen);
1194 write_buf(f_out, p, plen);
1195 write_buf(f_out, ent->pattern, len);
1197 write_byte(f_out, '/');
1202 /* This is only called by the client. */
1203 void send_filter_list(int f_out)
1205 int receiver_wants_list = prune_empty_dirs
1206 || (delete_mode && (!delete_excluded || protocol_version >= 29));
1208 if (local_server || (am_sender && !receiver_wants_list))
1210 if (cvs_exclude && am_sender) {
1211 if (protocol_version >= 29)
1212 parse_rule(&filter_list, ":C", 0, 0);
1213 parse_rule(&filter_list, "-C", 0, 0);
1216 /* This is a complete hack - blame Rusty. FIXME!
1217 * Remove this hack when older rsyncs (below 2.6.4) are gone. */
1218 if (list_only == 1 && !recurse)
1219 parse_rule(&filter_list, "/*/*", MATCHFLG_NO_PREFIXES, 0);
1221 send_rules(f_out, &filter_list);
1224 write_int(f_out, 0);
1227 if (!am_sender || protocol_version < 29)
1228 parse_rule(&filter_list, ":C", 0, 0);
1230 parse_rule(&filter_list, "-C", 0, 0);
1234 /* This is only called by the server. */
1235 void recv_filter_list(int f_in)
1237 char line[BIGPATHBUFLEN];
1238 int xflags = protocol_version >= 29 ? 0 : XFLG_OLD_PREFIXES;
1239 int receiver_wants_list = prune_empty_dirs
1241 && (!delete_excluded || protocol_version >= 29));
1244 if (!local_server && (am_sender || receiver_wants_list)) {
1245 while ((len = read_int(f_in)) != 0) {
1246 if (len >= sizeof line)
1247 overflow_exit("recv_rules");
1248 read_sbuf(f_in, line, len);
1249 parse_rule(&filter_list, line, 0, xflags);
1254 if (local_server || am_sender || protocol_version < 29)
1255 parse_rule(&filter_list, ":C", 0, 0);
1256 if (local_server || am_sender)
1257 parse_rule(&filter_list, "-C", 0, 0);
1260 if (local_server) /* filter out any rules that aren't for us. */
1261 send_rules(-1, &filter_list);