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-2007 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 3 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, visit the http://fsf.org website.
31 extern int local_server;
32 extern int prune_empty_dirs;
33 extern int ignore_perishable;
34 extern int delete_mode;
35 extern int delete_excluded;
36 extern int cvs_exclude;
37 extern int sanitize_paths;
38 extern int protocol_version;
41 extern char curr_dir[];
42 extern unsigned int curr_dir_len;
43 extern unsigned int module_dirlen;
45 struct filter_list_struct filter_list = { 0, 0, "" };
46 struct filter_list_struct cvs_filter_list = { 0, 0, " [global CVS]" };
47 struct filter_list_struct server_filter_list = { 0, 0, " [daemon]" };
49 /* Need room enough for ":MODS " prefix plus some room to grow. */
50 #define MAX_RULE_PREFIX (16)
52 #define MODIFIERS_MERGE_FILE "-+Cenw"
53 #define MODIFIERS_INCL_EXCL "/!Crsp"
54 #define MODIFIERS_HIDE_PROTECT "/!p"
56 /* The dirbuf is set by push_local_filters() to the current subdirectory
57 * relative to curr_dir that is being processed. The path always has a
58 * trailing slash appended, and the variable dirbuf_len contains the length
59 * of this path prefix. The path is always absolute. */
60 static char dirbuf[MAXPATHLEN+1];
61 static unsigned int dirbuf_len = 0;
62 static int dirbuf_depth;
64 /* This is True when we're scanning parent dirs for per-dir merge-files. */
65 static BOOL parent_dirscan = False;
67 /* This array contains a list of all the currently active per-dir merge
68 * files. This makes it easier to save the appropriate values when we
69 * "push" down into each subdirectory. */
70 static struct filter_struct **mergelist_parents;
71 static int mergelist_cnt = 0;
72 static int mergelist_size = 0;
74 /* Each filter_list_struct describes a singly-linked list by keeping track
75 * of both the head and tail pointers. The list is slightly unusual in that
76 * a parent-dir's content can be appended to the end of the local list in a
77 * special way: the last item in the local list has its "next" pointer set
78 * to point to the inherited list, but the local list's tail pointer points
79 * at the end of the local list. Thus, if the local list is empty, the head
80 * will be pointing at the inherited content but the tail will be NULL. To
81 * help you visualize this, here are the possible list arrangements:
83 * Completely Empty Local Content Only
84 * ================================== ====================================
85 * head -> NULL head -> Local1 -> Local2 -> NULL
86 * tail -> NULL tail -------------^
88 * Inherited Content Only Both Local and Inherited Content
89 * ================================== ====================================
90 * head -> Parent1 -> Parent2 -> NULL head -> L1 -> L2 -> P1 -> P2 -> NULL
91 * tail -> NULL tail ---------^
93 * This means that anyone wanting to traverse the whole list to use it just
94 * needs to start at the head and use the "next" pointers until it goes
95 * NULL. To add new local content, we insert the item after the tail item
96 * and update the tail (obviously, if "tail" was NULL, we insert it at the
97 * head). To clear the local list, WE MUST NOT FREE THE INHERITED CONTENT
98 * because it is shared between the current list and our parent list(s).
99 * The easiest way to handle this is to simply truncate the list after the
100 * tail item and then free the local list from the head. When inheriting
101 * the list for a new local dir, we just save off the filter_list_struct
102 * values (so we can pop back to them later) and set the tail to NULL.
105 static void free_filter(struct filter_struct *ex)
107 if (ex->match_flags & MATCHFLG_PERDIR_MERGE) {
108 free(ex->u.mergelist->debug_type);
109 free(ex->u.mergelist);
116 /* Build a filter structure given a filter pattern. The value in "pat"
117 * is not null-terminated. */
118 static void add_rule(struct filter_list_struct *listp, const char *pat,
119 unsigned int pat_len, uint32 mflags, int xflags)
121 struct filter_struct *ret;
126 rprintf(FINFO, "[%s] add_rule(%s%.*s%s)%s\n",
127 who_am_i(), get_rule_prefix(mflags, pat, 0, NULL),
129 (mflags & MATCHFLG_DIRECTORY) ? "/" : "",
133 /* These flags also indicate that we're reading a list that
134 * needs to be filtered now, not post-filtered later. */
135 if (xflags & (XFLG_ANCHORED2ABS|XFLG_ABS_IF_SLASH)) {
136 uint32 mf = mflags & (MATCHFLG_RECEIVER_SIDE|MATCHFLG_SENDER_SIDE);
138 if (mf == MATCHFLG_RECEIVER_SIDE)
141 if (mf == MATCHFLG_SENDER_SIDE)
146 if (!(ret = new0(struct filter_struct)))
147 out_of_memory("add_rule");
149 if (!(mflags & (MATCHFLG_ABS_PATH | MATCHFLG_MERGE_FILE))
150 && ((xflags & (XFLG_ANCHORED2ABS|XFLG_ABS_IF_SLASH) && *pat == '/')
151 || (xflags & XFLG_ABS_IF_SLASH && strchr(pat, '/') != NULL))) {
152 mflags |= MATCHFLG_ABS_PATH;
154 ex_len = dirbuf_len - module_dirlen - 1;
159 if (!(ret->pattern = new_array(char, ex_len + pat_len + 1)))
160 out_of_memory("add_rule");
162 memcpy(ret->pattern, dirbuf + module_dirlen, ex_len);
163 strlcpy(ret->pattern + ex_len, pat, pat_len + 1);
166 if (strpbrk(ret->pattern, "*[?")) {
167 mflags |= MATCHFLG_WILD;
168 if ((cp = strstr(ret->pattern, "**")) != NULL) {
169 mflags |= MATCHFLG_WILD2;
170 /* If the pattern starts with **, note that. */
171 if (cp == ret->pattern)
172 mflags |= MATCHFLG_WILD2_PREFIX;
173 /* If the pattern ends with ***, note that. */
175 && ret->pattern[pat_len-3] == '*'
176 && ret->pattern[pat_len-2] == '*'
177 && ret->pattern[pat_len-1] == '*')
178 mflags |= MATCHFLG_WILD3_SUFFIX;
182 if (pat_len > 1 && ret->pattern[pat_len-1] == '/') {
183 ret->pattern[pat_len-1] = 0;
184 mflags |= MATCHFLG_DIRECTORY;
187 if (mflags & MATCHFLG_PERDIR_MERGE) {
188 struct filter_list_struct *lp;
192 if ((cp = strrchr(ret->pattern, '/')) != NULL)
197 /* If the local merge file was already mentioned, don't
199 for (i = 0; i < mergelist_cnt; i++) {
200 struct filter_struct *ex = mergelist_parents[i];
201 const char *s = strrchr(ex->pattern, '/');
207 if (len == pat_len - (cp - ret->pattern)
208 && memcmp(s, cp, len) == 0) {
214 if (!(lp = new_array(struct filter_list_struct, 1)))
215 out_of_memory("add_rule");
216 lp->head = lp->tail = NULL;
217 if (asprintf(&lp->debug_type, " [per-dir %s]", cp) < 0)
218 out_of_memory("add_rule");
219 ret->u.mergelist = lp;
221 if (mergelist_cnt == mergelist_size) {
223 mergelist_parents = realloc_array(mergelist_parents,
224 struct filter_struct *,
226 if (!mergelist_parents)
227 out_of_memory("add_rule");
229 mergelist_parents[mergelist_cnt++] = ret;
231 for (cp = ret->pattern; (cp = strchr(cp, '/')) != NULL; cp++)
235 ret->match_flags = mflags;
238 ret->next = listp->head;
239 listp->head = listp->tail = ret;
241 ret->next = listp->tail->next;
242 listp->tail->next = ret;
247 static void clear_filter_list(struct filter_list_struct *listp)
250 struct filter_struct *ent, *next;
251 /* Truncate any inherited items from the local list. */
252 listp->tail->next = NULL;
253 /* Now free everything that is left. */
254 for (ent = listp->head; ent; ent = next) {
260 listp->head = listp->tail = NULL;
263 /* This returns an expanded (absolute) filename for the merge-file name if
264 * the name has any slashes in it OR if the parent_dirscan var is True;
265 * otherwise it returns the original merge_file name. If the len_ptr value
266 * is non-NULL the merge_file name is limited by the referenced length
267 * value and will be updated with the length of the resulting name. We
268 * always return a name that is null terminated, even if the merge_file
270 static char *parse_merge_name(const char *merge_file, unsigned int *len_ptr,
271 unsigned int prefix_skip)
273 static char buf[MAXPATHLEN];
274 char *fn, tmpbuf[MAXPATHLEN];
277 if (!parent_dirscan && *merge_file != '/') {
278 /* Return the name unchanged it doesn't have any slashes. */
280 const char *p = merge_file + *len_ptr;
281 while (--p > merge_file && *p != '/') {}
282 if (p == merge_file) {
283 strlcpy(buf, merge_file, *len_ptr + 1);
286 } else if (strchr(merge_file, '/') == NULL)
287 return (char *)merge_file;
290 fn = *merge_file == '/' ? buf : tmpbuf;
291 if (sanitize_paths) {
292 const char *r = prefix_skip ? "/" : NULL;
293 /* null-terminate the name if it isn't already */
294 if (len_ptr && merge_file[*len_ptr]) {
295 char *to = fn == buf ? tmpbuf : buf;
296 strlcpy(to, merge_file, *len_ptr + 1);
299 if (!sanitize_path(fn, merge_file, r, dirbuf_depth, NULL)) {
300 rprintf(FERROR, "merge-file name overflows: %s\n",
306 strlcpy(fn, merge_file, len_ptr ? *len_ptr + 1 : MAXPATHLEN);
307 fn_len = clean_fname(fn, 1);
310 /* If the name isn't in buf yet, it's wasn't absolute. */
312 if (dirbuf_len + fn_len >= MAXPATHLEN) {
313 rprintf(FERROR, "merge-file name overflows: %s\n", fn);
316 memcpy(buf, dirbuf + prefix_skip, dirbuf_len - prefix_skip);
317 memcpy(buf + dirbuf_len - prefix_skip, fn, fn_len + 1);
318 fn_len = clean_fname(buf, 1);
326 /* Sets the dirbuf and dirbuf_len values. */
327 void set_filter_dir(const char *dir, unsigned int dirlen)
331 memcpy(dirbuf, curr_dir, curr_dir_len);
332 dirbuf[curr_dir_len] = '/';
333 len = curr_dir_len + 1;
334 if (len + dirlen >= MAXPATHLEN)
338 memcpy(dirbuf + len, dir, dirlen);
339 dirbuf[dirlen + len] = '\0';
340 dirbuf_len = clean_fname(dirbuf, 1);
341 if (dirbuf_len > 1 && dirbuf[dirbuf_len-1] == '.'
342 && dirbuf[dirbuf_len-2] == '/')
345 dirbuf[dirbuf_len++] = '/';
346 dirbuf[dirbuf_len] = '\0';
348 dirbuf_depth = count_dir_elements(dirbuf + module_dirlen);
351 /* This routine takes a per-dir merge-file entry and finishes its setup.
352 * If the name has a path portion then we check to see if it refers to a
353 * parent directory of the first transfer dir. If it does, we scan all the
354 * dirs from that point through the parent dir of the transfer dir looking
355 * for the per-dir merge-file in each one. */
356 static BOOL setup_merge_file(struct filter_struct *ex,
357 struct filter_list_struct *lp)
359 char buf[MAXPATHLEN];
360 char *x, *y, *pat = ex->pattern;
363 if (!(x = parse_merge_name(pat, NULL, 0)) || *x != '/')
368 ex->pattern = strdup(y+1);
372 strlcpy(buf, x, MAXPATHLEN);
374 pathjoin(buf, MAXPATHLEN, dirbuf, x);
376 len = clean_fname(buf, 1);
377 if (len != 1 && len < MAXPATHLEN-1) {
381 /* This ensures that the specified dir is a parent of the transfer. */
382 for (x = buf, y = dirbuf; *x && *x == *y; x++, y++) {}
384 y += strlen(y); /* nope -- skip the scan */
386 parent_dirscan = True;
388 char save[MAXPATHLEN];
389 strlcpy(save, y, MAXPATHLEN);
391 dirbuf_len = y - dirbuf;
392 strlcpy(x, ex->pattern, MAXPATHLEN - (x - buf));
393 parse_filter_file(lp, buf, ex->match_flags, XFLG_ANCHORED2ABS);
394 if (ex->match_flags & MATCHFLG_NO_INHERIT)
397 strlcpy(y, save, MAXPATHLEN);
398 while ((*x++ = *y++) != '/') {}
400 parent_dirscan = False;
405 /* Each time rsync changes to a new directory it call this function to
406 * handle all the per-dir merge-files. The "dir" value is the current path
407 * relative to curr_dir (which might not be null-terminated). We copy it
408 * into dirbuf so that we can easily append a file name on the end. */
409 void *push_local_filters(const char *dir, unsigned int dirlen)
411 struct filter_list_struct *ap, *push;
414 set_filter_dir(dir, dirlen);
419 push = new_array(struct filter_list_struct, mergelist_cnt);
421 out_of_memory("push_local_filters");
423 for (i = 0, ap = push; i < mergelist_cnt; i++) {
424 memcpy(ap++, mergelist_parents[i]->u.mergelist,
425 sizeof (struct filter_list_struct));
428 /* Note: parse_filter_file() might increase mergelist_cnt, so keep
429 * this loop separate from the above loop. */
430 for (i = 0; i < mergelist_cnt; i++) {
431 struct filter_struct *ex = mergelist_parents[i];
432 struct filter_list_struct *lp = ex->u.mergelist;
435 rprintf(FINFO, "[%s] pushing filter list%s\n",
436 who_am_i(), lp->debug_type);
439 lp->tail = NULL; /* Switch any local rules to inherited. */
440 if (ex->match_flags & MATCHFLG_NO_INHERIT)
443 if (ex->match_flags & MATCHFLG_FINISH_SETUP) {
444 ex->match_flags &= ~MATCHFLG_FINISH_SETUP;
445 if (setup_merge_file(ex, lp))
446 set_filter_dir(dir, dirlen);
449 if (strlcpy(dirbuf + dirbuf_len, ex->pattern,
450 MAXPATHLEN - dirbuf_len) < MAXPATHLEN - dirbuf_len) {
451 parse_filter_file(lp, dirbuf, ex->match_flags,
454 io_error |= IOERR_GENERAL;
456 "cannot add local filter rules in long-named directory: %s\n",
459 dirbuf[dirbuf_len] = '\0';
465 void pop_local_filters(void *mem)
467 struct filter_list_struct *ap, *pop = (struct filter_list_struct*)mem;
470 for (i = mergelist_cnt; i-- > 0; ) {
471 struct filter_struct *ex = mergelist_parents[i];
472 struct filter_list_struct *lp = ex->u.mergelist;
475 rprintf(FINFO, "[%s] popping filter list%s\n",
476 who_am_i(), lp->debug_type);
479 clear_filter_list(lp);
485 for (i = 0, ap = pop; i < mergelist_cnt; i++) {
486 memcpy(mergelist_parents[i]->u.mergelist, ap++,
487 sizeof (struct filter_list_struct));
493 void change_local_filter_dir(const char *dname, int dlen, int dir_depth)
495 static int cur_depth = -1;
496 static void *filt_array[MAXPATHLEN/2+1];
499 for ( ; cur_depth >= 0; cur_depth--) {
500 if (filt_array[cur_depth]) {
501 pop_local_filters(filt_array[cur_depth]);
502 filt_array[cur_depth] = NULL;
508 assert(dir_depth < MAXPATHLEN/2+1);
510 for ( ; cur_depth >= dir_depth; cur_depth--) {
511 if (filt_array[cur_depth]) {
512 pop_local_filters(filt_array[cur_depth]);
513 filt_array[cur_depth] = NULL;
517 cur_depth = dir_depth;
518 filt_array[cur_depth] = push_local_filters(dname, dlen);
521 static int rule_matches(char *name, struct filter_struct *ex, int name_is_dir)
523 int slash_handling, str_cnt = 0, anchored_match = 0;
524 int ret_match = ex->match_flags & MATCHFLG_NEGATE ? 0 : 1;
525 char *p, *pattern = ex->pattern;
526 const char *strings[16]; /* more than enough */
533 if (!ex->u.slash_cnt && !(ex->match_flags & MATCHFLG_WILD2)) {
534 /* If the pattern does not have any slashes AND it does
535 * not have a "**" (which could match a slash), then we
536 * just match the name portion of the path. */
537 if ((p = strrchr(name,'/')) != NULL)
539 } else if (ex->match_flags & MATCHFLG_ABS_PATH && *name != '/'
540 && curr_dir_len > module_dirlen + 1) {
541 /* If we're matching against an absolute-path pattern,
542 * we need to prepend our full path info. */
543 strings[str_cnt++] = curr_dir + module_dirlen + 1;
544 strings[str_cnt++] = "/";
545 } else if (ex->match_flags & MATCHFLG_WILD2_PREFIX && *name != '/') {
546 /* Allow "**"+"/" to match at the start of the string. */
547 strings[str_cnt++] = "/";
549 strings[str_cnt++] = name;
551 /* Allow a trailing "/"+"***" to match the directory. */
552 if (ex->match_flags & MATCHFLG_WILD3_SUFFIX)
553 strings[str_cnt++] = "/";
554 } else if (ex->match_flags & MATCHFLG_DIRECTORY)
556 strings[str_cnt] = NULL;
558 if (*pattern == '/') {
563 if (!anchored_match && ex->u.slash_cnt
564 && !(ex->match_flags & MATCHFLG_WILD2)) {
565 /* A non-anchored match with an infix slash and no "**"
566 * needs to match the last slash_cnt+1 name elements. */
567 slash_handling = ex->u.slash_cnt + 1;
568 } else if (!anchored_match && !(ex->match_flags & MATCHFLG_WILD2_PREFIX)
569 && ex->match_flags & MATCHFLG_WILD2) {
570 /* A non-anchored match with an infix or trailing "**" (but not
571 * a prefixed "**") needs to try matching after every slash. */
574 /* The pattern matches only at the start of the path or name. */
578 if (ex->match_flags & MATCHFLG_WILD) {
579 if (wildmatch_array(pattern, strings, slash_handling))
581 } else if (str_cnt > 1) {
582 if (litmatch_array(pattern, strings, slash_handling))
584 } else if (anchored_match) {
585 if (strcmp(name, pattern) == 0)
588 int l1 = strlen(name);
589 int l2 = strlen(pattern);
591 strcmp(name+(l1-l2),pattern) == 0 &&
592 (l1==l2 || name[l1-(l2+1)] == '/')) {
601 static void report_filter_result(char const *name,
602 struct filter_struct const *ent,
603 int name_is_dir, const char *type)
605 /* If a trailing slash is present to match only directories,
606 * then it is stripped out by add_rule(). So as a special
607 * case we add it back in here. */
610 static char *actions[2][2]
611 = { {"show", "hid"}, {"risk", "protect"} };
612 const char *w = who_am_i();
613 rprintf(FINFO, "[%s] %sing %s %s because of pattern %s%s%s\n",
614 w, actions[*w!='s'][!(ent->match_flags&MATCHFLG_INCLUDE)],
615 name_is_dir ? "directory" : "file", name, ent->pattern,
616 ent->match_flags & MATCHFLG_DIRECTORY ? "/" : "", type);
622 * Return -1 if file "name" is defined to be excluded by the specified
623 * exclude list, 1 if it is included, and 0 if it was not matched.
625 int check_filter(struct filter_list_struct *listp, char *name, int name_is_dir)
627 struct filter_struct *ent;
629 for (ent = listp->head; ent; ent = ent->next) {
630 if (ignore_perishable && ent->match_flags & MATCHFLG_PERISHABLE)
632 if (ent->match_flags & MATCHFLG_PERDIR_MERGE) {
633 int rc = check_filter(ent->u.mergelist, name,
639 if (ent->match_flags & MATCHFLG_CVS_IGNORE) {
640 int rc = check_filter(&cvs_filter_list, name,
646 if (rule_matches(name, ent, name_is_dir)) {
647 report_filter_result(name, ent, name_is_dir,
649 return ent->match_flags & MATCHFLG_INCLUDE ? 1 : -1;
656 #define RULE_STRCMP(s,r) rule_strcmp((s), (r), sizeof (r) - 1)
658 static const uchar *rule_strcmp(const uchar *str, const char *rule, int rule_len)
660 if (strncmp((char*)str, rule, rule_len) != 0)
662 if (isspace(str[rule_len]) || str[rule_len] == '_' || !str[rule_len])
663 return str + rule_len - 1;
664 if (str[rule_len] == ',')
665 return str + rule_len;
669 /* Get the next include/exclude arg from the string. The token will not
670 * be '\0' terminated, so use the returned length to limit the string.
671 * Also, be sure to add this length to the returned pointer before passing
672 * it back to ask for the next token. This routine parses the "!" (list-
673 * clearing) token and (depending on the mflags) the various prefixes.
674 * The *mflags_ptr value will be set on exit to the new MATCHFLG_* bits
675 * for the current token. */
676 static const char *parse_rule_tok(const char *p, uint32 mflags, int xflags,
677 unsigned int *len_ptr, uint32 *mflags_ptr)
679 const uchar *s = (const uchar *)p;
683 if (mflags & MATCHFLG_WORD_SPLIT) {
684 /* Skip over any initial whitespace. */
687 /* Update to point to real start of rule. */
693 new_mflags = mflags & MATCHFLGS_FROM_CONTAINER;
695 /* Figure out what kind of a filter rule "s" is pointing at. Note
696 * that if MATCHFLG_NO_PREFIXES is set, the rule is either an include
697 * or an exclude based on the inheritance of the MATCHFLG_INCLUDE
698 * flag (above). XFLG_OLD_PREFIXES indicates a compatibility mode
699 * for old include/exclude patterns where just "+ " and "- " are
700 * allowed as optional prefixes. */
701 if (mflags & MATCHFLG_NO_PREFIXES) {
702 if (*s == '!' && mflags & MATCHFLG_CVS_IGNORE)
703 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
704 } else if (xflags & XFLG_OLD_PREFIXES) {
705 if (*s == '-' && s[1] == ' ') {
706 new_mflags &= ~MATCHFLG_INCLUDE;
708 } else if (*s == '+' && s[1] == ' ') {
709 new_mflags |= MATCHFLG_INCLUDE;
711 } else if (*s == '!')
712 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
714 char ch = 0, *mods = "";
717 if ((s = RULE_STRCMP(s, "clear")) != NULL)
721 if ((s = RULE_STRCMP(s, "dir-merge")) != NULL)
725 if ((s = RULE_STRCMP(s, "exclude")) != NULL)
729 if ((s = RULE_STRCMP(s, "hide")) != NULL)
733 if ((s = RULE_STRCMP(s, "include")) != NULL)
737 if ((s = RULE_STRCMP(s, "merge")) != NULL)
741 if ((s = RULE_STRCMP(s, "protect")) != NULL)
745 if ((s = RULE_STRCMP(s, "risk")) != NULL)
749 if ((s = RULE_STRCMP(s, "show")) != NULL)
760 new_mflags |= MATCHFLG_PERDIR_MERGE
761 | MATCHFLG_FINISH_SETUP;
764 new_mflags |= MATCHFLG_MERGE_FILE;
765 mods = MODIFIERS_INCL_EXCL MODIFIERS_MERGE_FILE;
768 new_mflags |= MATCHFLG_INCLUDE;
771 mods = MODIFIERS_INCL_EXCL;
774 new_mflags |= MATCHFLG_INCLUDE;
777 new_mflags |= MATCHFLG_SENDER_SIDE;
778 mods = MODIFIERS_HIDE_PROTECT;
781 new_mflags |= MATCHFLG_INCLUDE;
784 new_mflags |= MATCHFLG_RECEIVER_SIDE;
785 mods = MODIFIERS_HIDE_PROTECT;
788 new_mflags |= MATCHFLG_CLEAR_LIST;
792 rprintf(FERROR, "Unknown filter rule: `%s'\n", p);
793 exit_cleanup(RERR_SYNTAX);
795 while (mods && *++s && *s != ' ' && *s != '_') {
796 if (strchr(mods, *s) == NULL) {
797 if (mflags & MATCHFLG_WORD_SPLIT && isspace(*s)) {
803 "invalid modifier sequence at '%c' in filter rule: %s\n",
805 exit_cleanup(RERR_SYNTAX);
809 if (new_mflags & MATCHFLG_NO_PREFIXES)
811 new_mflags |= MATCHFLG_NO_PREFIXES;
814 if (new_mflags & MATCHFLG_NO_PREFIXES)
816 new_mflags |= MATCHFLG_NO_PREFIXES
820 new_mflags |= MATCHFLG_ABS_PATH;
823 new_mflags |= MATCHFLG_NEGATE;
826 if (new_mflags & MATCHFLG_NO_PREFIXES)
828 new_mflags |= MATCHFLG_NO_PREFIXES
829 | MATCHFLG_WORD_SPLIT
830 | MATCHFLG_NO_INHERIT
831 | MATCHFLG_CVS_IGNORE;
834 new_mflags |= MATCHFLG_EXCLUDE_SELF;
837 new_mflags |= MATCHFLG_NO_INHERIT;
840 new_mflags |= MATCHFLG_PERISHABLE;
843 new_mflags |= MATCHFLG_RECEIVER_SIDE;
846 new_mflags |= MATCHFLG_SENDER_SIDE;
849 new_mflags |= MATCHFLG_WORD_SPLIT;
857 if (mflags & MATCHFLG_WORD_SPLIT) {
859 /* Token ends at whitespace or the end of the string. */
860 while (!isspace(*cp) && *cp != '\0')
864 len = strlen((char*)s);
866 if (new_mflags & MATCHFLG_CLEAR_LIST) {
867 if (!(mflags & MATCHFLG_NO_PREFIXES)
868 && !(xflags & XFLG_OLD_PREFIXES) && len) {
870 "'!' rule has trailing characters: %s\n", p);
871 exit_cleanup(RERR_SYNTAX);
874 new_mflags &= ~MATCHFLG_CLEAR_LIST;
875 } else if (!len && !(new_mflags & MATCHFLG_CVS_IGNORE)) {
876 rprintf(FERROR, "unexpected end of filter rule: %s\n", p);
877 exit_cleanup(RERR_SYNTAX);
880 /* --delete-excluded turns an un-modified include/exclude into a
881 * sender-side rule. We also affect per-dir merge files that take
882 * no prefixes as a simple optimization. */
884 && !(new_mflags & (MATCHFLG_RECEIVER_SIDE|MATCHFLG_SENDER_SIDE))
885 && (!(new_mflags & MATCHFLG_PERDIR_MERGE)
886 || new_mflags & MATCHFLG_NO_PREFIXES))
887 new_mflags |= MATCHFLG_SENDER_SIDE;
890 *mflags_ptr = new_mflags;
891 return (const char *)s;
895 static char default_cvsignore[] =
896 /* These default ignored items come from the CVS manual. */
897 "RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS"
898 " .make.state .nse_depinfo *~ #* .#* ,* _$* *$"
899 " *.old *.bak *.BAK *.orig *.rej .del-*"
900 " *.a *.olb *.o *.obj *.so *.exe"
901 " *.Z *.elc *.ln core"
902 /* The rest we added to suit ourself. */
905 static void get_cvs_excludes(uint32 mflags)
907 static int initialized = 0;
908 char *p, fname[MAXPATHLEN];
914 parse_rule(&cvs_filter_list, default_cvsignore,
915 mflags | (protocol_version >= 30 ? MATCHFLG_PERISHABLE : 0),
918 p = module_id >= 0 && lp_use_chroot(module_id) ? "/" : getenv("HOME");
919 if (p && pathjoin(fname, MAXPATHLEN, p, ".cvsignore") < MAXPATHLEN)
920 parse_filter_file(&cvs_filter_list, fname, mflags, 0);
922 parse_rule(&cvs_filter_list, getenv("CVSIGNORE"), mflags, 0);
926 void parse_rule(struct filter_list_struct *listp, const char *pattern,
927 uint32 mflags, int xflags)
929 unsigned int pat_len;
937 /* Remember that the returned string is NOT '\0' terminated! */
938 cp = parse_rule_tok(pattern, mflags, xflags,
939 &pat_len, &new_mflags);
943 pattern = cp + pat_len;
945 if (pat_len >= MAXPATHLEN) {
946 rprintf(FERROR, "discarding over-long filter: %.*s\n",
951 if (new_mflags & MATCHFLG_CLEAR_LIST) {
954 "[%s] clearing filter list%s\n",
955 who_am_i(), listp->debug_type);
957 clear_filter_list(listp);
961 if (new_mflags & MATCHFLG_MERGE_FILE) {
968 if (new_mflags & MATCHFLG_EXCLUDE_SELF) {
969 const char *name = cp + len;
970 while (name > cp && name[-1] != '/') name--;
972 add_rule(listp, name, len, 0, 0);
973 new_mflags &= ~MATCHFLG_EXCLUDE_SELF;
976 if (new_mflags & MATCHFLG_PERDIR_MERGE) {
977 if (parent_dirscan) {
978 if (!(p = parse_merge_name(cp, &len,
981 add_rule(listp, p, len, new_mflags, 0);
985 if (!(p = parse_merge_name(cp, &len, 0)))
987 parse_filter_file(listp, p, new_mflags,
993 add_rule(listp, cp, pat_len, new_mflags, xflags);
995 if (new_mflags & MATCHFLG_CVS_IGNORE
996 && !(new_mflags & MATCHFLG_MERGE_FILE))
997 get_cvs_excludes(new_mflags);
1002 void parse_filter_file(struct filter_list_struct *listp, const char *fname,
1003 uint32 mflags, int xflags)
1006 char line[BIGPATHBUFLEN];
1007 char *eob = line + sizeof line - 1;
1008 int word_split = mflags & MATCHFLG_WORD_SPLIT;
1010 if (!fname || !*fname)
1013 if (*fname != '-' || fname[1] || am_server) {
1014 if (server_filter_list.head) {
1015 strlcpy(line, fname, sizeof line);
1016 clean_fname(line, 1);
1017 if (check_filter(&server_filter_list, line, 0) < 0)
1020 fp = fopen(line, "rb");
1022 fp = fopen(fname, "rb");
1027 rprintf(FINFO, "[%s] parse_filter_file(%s,%x,%x)%s\n",
1028 who_am_i(), fname, mflags, xflags,
1029 fp ? "" : " [not found]");
1033 if (xflags & XFLG_FATAL_ERRORS) {
1034 rsyserr(FERROR, errno,
1035 "failed to open %sclude file %s",
1036 mflags & MATCHFLG_INCLUDE ? "in" : "ex",
1038 exit_cleanup(RERR_FILEIO);
1042 dirbuf[dirbuf_len] = '\0';
1046 int ch, overflow = 0;
1048 if ((ch = getc(fp)) == EOF) {
1049 if (ferror(fp) && errno == EINTR) {
1055 if (word_split && isspace(ch))
1057 if (eol_nulls? !ch : (ch == '\n' || ch == '\r'))
1065 rprintf(FERROR, "discarding over-long filter: %s...\n", line);
1069 /* Skip an empty token and (when line parsing) comments. */
1070 if (*line && (word_split || (*line != ';' && *line != '#')))
1071 parse_rule(listp, line, mflags, xflags);
1078 /* If the "for_xfer" flag is set, the prefix is made compatible with the
1079 * current protocol_version (if possible) or a NULL is returned (if not
1081 char *get_rule_prefix(int match_flags, const char *pat, int for_xfer,
1082 unsigned int *plen_ptr)
1084 static char buf[MAX_RULE_PREFIX+1];
1086 int legal_len = for_xfer && protocol_version < 29 ? 1 : MAX_RULE_PREFIX-1;
1088 if (match_flags & MATCHFLG_PERDIR_MERGE) {
1092 } else if (match_flags & MATCHFLG_INCLUDE)
1094 else if (legal_len != 1
1095 || ((*pat == '-' || *pat == '+') && pat[1] == ' '))
1100 if (match_flags & MATCHFLG_NEGATE)
1102 if (match_flags & MATCHFLG_CVS_IGNORE)
1105 if (match_flags & MATCHFLG_NO_INHERIT)
1107 if (match_flags & MATCHFLG_WORD_SPLIT)
1109 if (match_flags & MATCHFLG_NO_PREFIXES) {
1110 if (match_flags & MATCHFLG_INCLUDE)
1116 if (match_flags & MATCHFLG_EXCLUDE_SELF)
1118 if (match_flags & MATCHFLG_SENDER_SIDE
1119 && (!for_xfer || protocol_version >= 29))
1121 if (match_flags & MATCHFLG_RECEIVER_SIDE
1122 && (!for_xfer || protocol_version >= 29
1123 || (delete_excluded && am_sender)))
1125 if (match_flags & MATCHFLG_PERISHABLE) {
1126 if (!for_xfer || protocol_version >= 30)
1131 if (op - buf > legal_len)
1137 *plen_ptr = op - buf;
1141 static void send_rules(int f_out, struct filter_list_struct *flp)
1143 struct filter_struct *ent, *prev = NULL;
1145 for (ent = flp->head; ent; ent = ent->next) {
1146 unsigned int len, plen, dlen;
1150 /* Note we need to check delete_excluded here in addition to
1151 * the code in parse_rule_tok() because some rules may have
1152 * been added before we found the --delete-excluded option.
1153 * We must also elide any CVS merge-file rules to avoid a
1154 * backward compatibility problem, and we elide any no-prefix
1155 * merge files as an optimization (since they can only have
1156 * include/exclude rules). */
1157 if (ent->match_flags & MATCHFLG_SENDER_SIDE)
1158 elide = am_sender ? 1 : -1;
1159 if (ent->match_flags & MATCHFLG_RECEIVER_SIDE)
1160 elide = elide ? 0 : am_sender ? -1 : 1;
1161 else if (delete_excluded && !elide
1162 && (!(ent->match_flags & MATCHFLG_PERDIR_MERGE)
1163 || ent->match_flags & MATCHFLG_NO_PREFIXES))
1164 elide = am_sender ? 1 : -1;
1167 prev->next = ent->next;
1169 flp->head = ent->next;
1174 if (ent->match_flags & MATCHFLG_CVS_IGNORE
1175 && !(ent->match_flags & MATCHFLG_MERGE_FILE)) {
1176 int f = am_sender || protocol_version < 29 ? f_out : -2;
1177 send_rules(f, &cvs_filter_list);
1181 p = get_rule_prefix(ent->match_flags, ent->pattern, 1, &plen);
1184 "filter rules are too modern for remote rsync.\n");
1185 exit_cleanup(RERR_PROTOCOL);
1189 len = strlen(ent->pattern);
1190 dlen = ent->match_flags & MATCHFLG_DIRECTORY ? 1 : 0;
1191 if (!(plen + len + dlen))
1193 write_int(f_out, plen + len + dlen);
1195 write_buf(f_out, p, plen);
1196 write_buf(f_out, ent->pattern, len);
1198 write_byte(f_out, '/');
1203 /* This is only called by the client. */
1204 void send_filter_list(int f_out)
1206 int receiver_wants_list = prune_empty_dirs
1207 || (delete_mode && (!delete_excluded || protocol_version >= 29));
1209 if (local_server || (am_sender && !receiver_wants_list))
1211 if (cvs_exclude && am_sender) {
1212 if (protocol_version >= 29)
1213 parse_rule(&filter_list, ":C", 0, 0);
1214 parse_rule(&filter_list, "-C", 0, 0);
1217 send_rules(f_out, &filter_list);
1220 write_int(f_out, 0);
1223 if (!am_sender || protocol_version < 29)
1224 parse_rule(&filter_list, ":C", 0, 0);
1226 parse_rule(&filter_list, "-C", 0, 0);
1230 /* This is only called by the server. */
1231 void recv_filter_list(int f_in)
1233 char line[BIGPATHBUFLEN];
1234 int xflags = protocol_version >= 29 ? 0 : XFLG_OLD_PREFIXES;
1235 int receiver_wants_list = prune_empty_dirs
1237 && (!delete_excluded || protocol_version >= 29));
1240 if (!local_server && (am_sender || receiver_wants_list)) {
1241 while ((len = read_int(f_in)) != 0) {
1242 if (len >= sizeof line)
1243 overflow_exit("recv_rules");
1244 read_sbuf(f_in, line, len);
1245 parse_rule(&filter_list, line, 0, xflags);
1250 if (local_server || am_sender || protocol_version < 29)
1251 parse_rule(&filter_list, ":C", 0, 0);
1252 if (local_server || am_sender)
1253 parse_rule(&filter_list, "-C", 0, 0);
1256 if (local_server) /* filter out any rules that aren't for us. */
1257 send_rules(-1, &filter_list);