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.
32 extern int local_server;
33 extern int prune_empty_dirs;
34 extern int ignore_perishable;
35 extern int delete_mode;
36 extern int delete_excluded;
37 extern int cvs_exclude;
38 extern int sanitize_paths;
39 extern int protocol_version;
42 extern char curr_dir[];
43 extern unsigned int curr_dir_len;
44 extern unsigned int module_dirlen;
46 struct filter_list_struct filter_list = { 0, 0, "" };
47 struct filter_list_struct cvs_filter_list = { 0, 0, " [global CVS]" };
48 struct filter_list_struct server_filter_list = { 0, 0, " [daemon]" };
50 /* Need room enough for ":MODS " prefix plus some room to grow. */
51 #define MAX_RULE_PREFIX (16)
53 #define MODIFIERS_MERGE_FILE "-+Cenw"
54 #define MODIFIERS_INCL_EXCL "/!Crsp"
55 #define MODIFIERS_HIDE_PROTECT "/!p"
57 /* The dirbuf is set by push_local_filters() to the current subdirectory
58 * relative to curr_dir that is being processed. The path always has a
59 * trailing slash appended, and the variable dirbuf_len contains the length
60 * of this path prefix. The path is always absolute. */
61 static char dirbuf[MAXPATHLEN+1];
62 static unsigned int dirbuf_len = 0;
63 static int dirbuf_depth;
65 /* This is True when we're scanning parent dirs for per-dir merge-files. */
66 static BOOL parent_dirscan = False;
68 /* This array contains a list of all the currently active per-dir merge
69 * files. This makes it easier to save the appropriate values when we
70 * "push" down into each subdirectory. */
71 static struct filter_struct **mergelist_parents;
72 static int mergelist_cnt = 0;
73 static int mergelist_size = 0;
75 /* Each filter_list_struct describes a singly-linked list by keeping track
76 * of both the head and tail pointers. The list is slightly unusual in that
77 * a parent-dir's content can be appended to the end of the local list in a
78 * special way: the last item in the local list has its "next" pointer set
79 * to point to the inherited list, but the local list's tail pointer points
80 * at the end of the local list. Thus, if the local list is empty, the head
81 * will be pointing at the inherited content but the tail will be NULL. To
82 * help you visualize this, here are the possible list arrangements:
84 * Completely Empty Local Content Only
85 * ================================== ====================================
86 * head -> NULL head -> Local1 -> Local2 -> NULL
87 * tail -> NULL tail -------------^
89 * Inherited Content Only Both Local and Inherited Content
90 * ================================== ====================================
91 * head -> Parent1 -> Parent2 -> NULL head -> L1 -> L2 -> P1 -> P2 -> NULL
92 * tail -> NULL tail ---------^
94 * This means that anyone wanting to traverse the whole list to use it just
95 * needs to start at the head and use the "next" pointers until it goes
96 * NULL. To add new local content, we insert the item after the tail item
97 * and update the tail (obviously, if "tail" was NULL, we insert it at the
98 * head). To clear the local list, WE MUST NOT FREE THE INHERITED CONTENT
99 * because it is shared between the current list and our parent list(s).
100 * The easiest way to handle this is to simply truncate the list after the
101 * tail item and then free the local list from the head. When inheriting
102 * the list for a new local dir, we just save off the filter_list_struct
103 * values (so we can pop back to them later) and set the tail to NULL.
106 static void free_filter(struct filter_struct *ex)
108 if (ex->match_flags & MATCHFLG_PERDIR_MERGE) {
109 free(ex->u.mergelist->debug_type);
110 free(ex->u.mergelist);
117 /* Build a filter structure given a filter pattern. The value in "pat"
118 * is not null-terminated. */
119 static void add_rule(struct filter_list_struct *listp, const char *pat,
120 unsigned int pat_len, uint32 mflags, int xflags)
122 struct filter_struct *ret;
127 rprintf(FINFO, "[%s] add_rule(%s%.*s%s)%s\n",
128 who_am_i(), get_rule_prefix(mflags, pat, 0, NULL),
130 (mflags & MATCHFLG_DIRECTORY) ? "/" : "",
134 /* These flags also indicate that we're reading a list that
135 * needs to be filtered now, not post-filtered later. */
136 if (xflags & (XFLG_ANCHORED2ABS|XFLG_ABS_IF_SLASH)) {
137 uint32 mf = mflags & (MATCHFLG_RECEIVER_SIDE|MATCHFLG_SENDER_SIDE);
139 if (mf == MATCHFLG_RECEIVER_SIDE)
142 if (mf == MATCHFLG_SENDER_SIDE)
147 if (!(ret = new0(struct filter_struct)))
148 out_of_memory("add_rule");
150 if (!(mflags & (MATCHFLG_ABS_PATH | MATCHFLG_MERGE_FILE))
151 && ((xflags & (XFLG_ANCHORED2ABS|XFLG_ABS_IF_SLASH) && *pat == '/')
152 || (xflags & XFLG_ABS_IF_SLASH && strchr(pat, '/') != NULL))) {
153 mflags |= MATCHFLG_ABS_PATH;
155 ex_len = dirbuf_len - module_dirlen - 1;
160 if (!(ret->pattern = new_array(char, ex_len + pat_len + 1)))
161 out_of_memory("add_rule");
163 memcpy(ret->pattern, dirbuf + module_dirlen, ex_len);
164 strlcpy(ret->pattern + ex_len, pat, pat_len + 1);
167 if (strpbrk(ret->pattern, "*[?")) {
168 mflags |= MATCHFLG_WILD;
169 if ((cp = strstr(ret->pattern, "**")) != NULL) {
170 mflags |= MATCHFLG_WILD2;
171 /* If the pattern starts with **, note that. */
172 if (cp == ret->pattern)
173 mflags |= MATCHFLG_WILD2_PREFIX;
174 /* If the pattern ends with ***, note that. */
176 && ret->pattern[pat_len-3] == '*'
177 && ret->pattern[pat_len-2] == '*'
178 && ret->pattern[pat_len-1] == '*')
179 mflags |= MATCHFLG_WILD3_SUFFIX;
183 if (pat_len > 1 && ret->pattern[pat_len-1] == '/') {
184 ret->pattern[pat_len-1] = 0;
185 mflags |= MATCHFLG_DIRECTORY;
188 if (mflags & MATCHFLG_PERDIR_MERGE) {
189 struct filter_list_struct *lp;
193 if ((cp = strrchr(ret->pattern, '/')) != NULL)
198 /* If the local merge file was already mentioned, don't
200 for (i = 0; i < mergelist_cnt; i++) {
201 struct filter_struct *ex = mergelist_parents[i];
202 const char *s = strrchr(ex->pattern, '/');
208 if (len == pat_len - (cp - ret->pattern)
209 && memcmp(s, cp, len) == 0) {
215 if (!(lp = new_array(struct filter_list_struct, 1)))
216 out_of_memory("add_rule");
217 lp->head = lp->tail = NULL;
218 if (asprintf(&lp->debug_type, " [per-dir %s]", cp) < 0)
219 out_of_memory("add_rule");
220 ret->u.mergelist = lp;
222 if (mergelist_cnt == mergelist_size) {
224 mergelist_parents = realloc_array(mergelist_parents,
225 struct filter_struct *,
227 if (!mergelist_parents)
228 out_of_memory("add_rule");
230 mergelist_parents[mergelist_cnt++] = ret;
232 for (cp = ret->pattern; (cp = strchr(cp, '/')) != NULL; cp++)
236 ret->match_flags = mflags;
239 ret->next = listp->head;
240 listp->head = listp->tail = ret;
242 ret->next = listp->tail->next;
243 listp->tail->next = ret;
248 static void clear_filter_list(struct filter_list_struct *listp)
251 struct filter_struct *ent, *next;
252 /* Truncate any inherited items from the local list. */
253 listp->tail->next = NULL;
254 /* Now free everything that is left. */
255 for (ent = listp->head; ent; ent = next) {
261 listp->head = listp->tail = NULL;
264 /* This returns an expanded (absolute) filename for the merge-file name if
265 * the name has any slashes in it OR if the parent_dirscan var is True;
266 * otherwise it returns the original merge_file name. If the len_ptr value
267 * is non-NULL the merge_file name is limited by the referenced length
268 * value and will be updated with the length of the resulting name. We
269 * always return a name that is null terminated, even if the merge_file
271 static char *parse_merge_name(const char *merge_file, unsigned int *len_ptr,
272 unsigned int prefix_skip)
274 static char buf[MAXPATHLEN];
275 char *fn, tmpbuf[MAXPATHLEN];
278 if (!parent_dirscan && *merge_file != '/') {
279 /* Return the name unchanged it doesn't have any slashes. */
281 const char *p = merge_file + *len_ptr;
282 while (--p > merge_file && *p != '/') {}
283 if (p == merge_file) {
284 strlcpy(buf, merge_file, *len_ptr + 1);
287 } else if (strchr(merge_file, '/') == NULL)
288 return (char *)merge_file;
291 fn = *merge_file == '/' ? buf : tmpbuf;
292 if (sanitize_paths) {
293 const char *r = prefix_skip ? "/" : NULL;
294 /* null-terminate the name if it isn't already */
295 if (len_ptr && merge_file[*len_ptr]) {
296 char *to = fn == buf ? tmpbuf : buf;
297 strlcpy(to, merge_file, *len_ptr + 1);
300 if (!sanitize_path(fn, merge_file, r, dirbuf_depth, NULL)) {
301 rprintf(FERROR, "merge-file name overflows: %s\n",
307 strlcpy(fn, merge_file, len_ptr ? *len_ptr + 1 : MAXPATHLEN);
308 fn_len = clean_fname(fn, 1);
311 /* If the name isn't in buf yet, it's wasn't absolute. */
313 if (dirbuf_len + fn_len >= MAXPATHLEN) {
314 rprintf(FERROR, "merge-file name overflows: %s\n", fn);
317 memcpy(buf, dirbuf + prefix_skip, dirbuf_len - prefix_skip);
318 memcpy(buf + dirbuf_len - prefix_skip, fn, fn_len + 1);
319 fn_len = clean_fname(buf, 1);
327 /* Sets the dirbuf and dirbuf_len values. */
328 void set_filter_dir(const char *dir, unsigned int dirlen)
332 memcpy(dirbuf, curr_dir, curr_dir_len);
333 dirbuf[curr_dir_len] = '/';
334 len = curr_dir_len + 1;
335 if (len + dirlen >= MAXPATHLEN)
339 memcpy(dirbuf + len, dir, dirlen);
340 dirbuf[dirlen + len] = '\0';
341 dirbuf_len = clean_fname(dirbuf, 1);
342 if (dirbuf_len > 1 && dirbuf[dirbuf_len-1] == '.'
343 && dirbuf[dirbuf_len-2] == '/')
346 dirbuf[dirbuf_len++] = '/';
347 dirbuf[dirbuf_len] = '\0';
349 dirbuf_depth = count_dir_elements(dirbuf + module_dirlen);
352 /* This routine takes a per-dir merge-file entry and finishes its setup.
353 * If the name has a path portion then we check to see if it refers to a
354 * parent directory of the first transfer dir. If it does, we scan all the
355 * dirs from that point through the parent dir of the transfer dir looking
356 * for the per-dir merge-file in each one. */
357 static BOOL setup_merge_file(struct filter_struct *ex,
358 struct filter_list_struct *lp)
360 char buf[MAXPATHLEN];
361 char *x, *y, *pat = ex->pattern;
364 if (!(x = parse_merge_name(pat, NULL, 0)) || *x != '/')
369 ex->pattern = strdup(y+1);
373 strlcpy(buf, x, MAXPATHLEN);
375 pathjoin(buf, MAXPATHLEN, dirbuf, x);
377 len = clean_fname(buf, 1);
378 if (len != 1 && len < MAXPATHLEN-1) {
382 /* This ensures that the specified dir is a parent of the transfer. */
383 for (x = buf, y = dirbuf; *x && *x == *y; x++, y++) {}
385 y += strlen(y); /* nope -- skip the scan */
387 parent_dirscan = True;
389 char save[MAXPATHLEN];
390 strlcpy(save, y, MAXPATHLEN);
392 dirbuf_len = y - dirbuf;
393 strlcpy(x, ex->pattern, MAXPATHLEN - (x - buf));
394 parse_filter_file(lp, buf, ex->match_flags, XFLG_ANCHORED2ABS);
395 if (ex->match_flags & MATCHFLG_NO_INHERIT)
398 strlcpy(y, save, MAXPATHLEN);
399 while ((*x++ = *y++) != '/') {}
401 parent_dirscan = False;
406 /* Each time rsync changes to a new directory it call this function to
407 * handle all the per-dir merge-files. The "dir" value is the current path
408 * relative to curr_dir (which might not be null-terminated). We copy it
409 * into dirbuf so that we can easily append a file name on the end. */
410 void *push_local_filters(const char *dir, unsigned int dirlen)
412 struct filter_list_struct *ap, *push;
415 set_filter_dir(dir, dirlen);
420 push = new_array(struct filter_list_struct, mergelist_cnt);
422 out_of_memory("push_local_filters");
424 for (i = 0, ap = push; i < mergelist_cnt; i++) {
425 memcpy(ap++, mergelist_parents[i]->u.mergelist,
426 sizeof (struct filter_list_struct));
429 /* Note: parse_filter_file() might increase mergelist_cnt, so keep
430 * this loop separate from the above loop. */
431 for (i = 0; i < mergelist_cnt; i++) {
432 struct filter_struct *ex = mergelist_parents[i];
433 struct filter_list_struct *lp = ex->u.mergelist;
436 rprintf(FINFO, "[%s] pushing filter list%s\n",
437 who_am_i(), lp->debug_type);
440 lp->tail = NULL; /* Switch any local rules to inherited. */
441 if (ex->match_flags & MATCHFLG_NO_INHERIT)
444 if (ex->match_flags & MATCHFLG_FINISH_SETUP) {
445 ex->match_flags &= ~MATCHFLG_FINISH_SETUP;
446 if (setup_merge_file(ex, lp))
447 set_filter_dir(dir, dirlen);
450 if (strlcpy(dirbuf + dirbuf_len, ex->pattern,
451 MAXPATHLEN - dirbuf_len) < MAXPATHLEN - dirbuf_len) {
452 parse_filter_file(lp, dirbuf, ex->match_flags,
455 io_error |= IOERR_GENERAL;
457 "cannot add local filter rules in long-named directory: %s\n",
460 dirbuf[dirbuf_len] = '\0';
466 void pop_local_filters(void *mem)
468 struct filter_list_struct *ap, *pop = (struct filter_list_struct*)mem;
471 for (i = mergelist_cnt; i-- > 0; ) {
472 struct filter_struct *ex = mergelist_parents[i];
473 struct filter_list_struct *lp = ex->u.mergelist;
476 rprintf(FINFO, "[%s] popping filter list%s\n",
477 who_am_i(), lp->debug_type);
480 clear_filter_list(lp);
486 for (i = 0, ap = pop; i < mergelist_cnt; i++) {
487 memcpy(mergelist_parents[i]->u.mergelist, ap++,
488 sizeof (struct filter_list_struct));
494 void change_local_filter_dir(const char *dname, int dlen, int dir_depth)
496 static int cur_depth = -1;
497 static void *filt_array[MAXPATHLEN/2+1];
500 for ( ; cur_depth >= 0; cur_depth--) {
501 if (filt_array[cur_depth]) {
502 pop_local_filters(filt_array[cur_depth]);
503 filt_array[cur_depth] = NULL;
509 assert(dir_depth < MAXPATHLEN/2+1);
511 for ( ; cur_depth >= dir_depth; cur_depth--) {
512 if (filt_array[cur_depth]) {
513 pop_local_filters(filt_array[cur_depth]);
514 filt_array[cur_depth] = NULL;
518 cur_depth = dir_depth;
519 filt_array[cur_depth] = push_local_filters(dname, dlen);
522 static int rule_matches(char *name, struct filter_struct *ex, int name_is_dir)
524 int slash_handling, str_cnt = 0, anchored_match = 0;
525 int ret_match = ex->match_flags & MATCHFLG_NEGATE ? 0 : 1;
526 char *p, *pattern = ex->pattern;
527 const char *strings[16]; /* more than enough */
534 if (!ex->u.slash_cnt && !(ex->match_flags & MATCHFLG_WILD2)) {
535 /* If the pattern does not have any slashes AND it does
536 * not have a "**" (which could match a slash), then we
537 * just match the name portion of the path. */
538 if ((p = strrchr(name,'/')) != NULL)
540 } else if (ex->match_flags & MATCHFLG_ABS_PATH && *name != '/'
541 && curr_dir_len > module_dirlen + 1) {
542 /* If we're matching against an absolute-path pattern,
543 * we need to prepend our full path info. */
544 strings[str_cnt++] = curr_dir + module_dirlen + 1;
545 strings[str_cnt++] = "/";
546 } else if (ex->match_flags & MATCHFLG_WILD2_PREFIX && *name != '/') {
547 /* Allow "**"+"/" to match at the start of the string. */
548 strings[str_cnt++] = "/";
550 strings[str_cnt++] = name;
552 /* Allow a trailing "/"+"***" to match the directory. */
553 if (ex->match_flags & MATCHFLG_WILD3_SUFFIX)
554 strings[str_cnt++] = "/";
555 } else if (ex->match_flags & MATCHFLG_DIRECTORY)
557 strings[str_cnt] = NULL;
559 if (*pattern == '/') {
564 if (!anchored_match && ex->u.slash_cnt
565 && !(ex->match_flags & MATCHFLG_WILD2)) {
566 /* A non-anchored match with an infix slash and no "**"
567 * needs to match the last slash_cnt+1 name elements. */
568 slash_handling = ex->u.slash_cnt + 1;
569 } else if (!anchored_match && !(ex->match_flags & MATCHFLG_WILD2_PREFIX)
570 && ex->match_flags & MATCHFLG_WILD2) {
571 /* A non-anchored match with an infix or trailing "**" (but not
572 * a prefixed "**") needs to try matching after every slash. */
575 /* The pattern matches only at the start of the path or name. */
579 if (ex->match_flags & MATCHFLG_WILD) {
580 if (wildmatch_array(pattern, strings, slash_handling))
582 } else if (str_cnt > 1) {
583 if (litmatch_array(pattern, strings, slash_handling))
585 } else if (anchored_match) {
586 if (strcmp(name, pattern) == 0)
589 int l1 = strlen(name);
590 int l2 = strlen(pattern);
592 strcmp(name+(l1-l2),pattern) == 0 &&
593 (l1==l2 || name[l1-(l2+1)] == '/')) {
602 static void report_filter_result(char const *name,
603 struct filter_struct const *ent,
604 int name_is_dir, const char *type)
606 /* If a trailing slash is present to match only directories,
607 * then it is stripped out by add_rule(). So as a special
608 * case we add it back in here. */
611 static char *actions[2][2]
612 = { {"show", "hid"}, {"risk", "protect"} };
613 const char *w = who_am_i();
614 rprintf(FINFO, "[%s] %sing %s %s because of pattern %s%s%s\n",
615 w, actions[*w!='s'][!(ent->match_flags&MATCHFLG_INCLUDE)],
616 name_is_dir ? "directory" : "file", name, ent->pattern,
617 ent->match_flags & MATCHFLG_DIRECTORY ? "/" : "", type);
623 * Return -1 if file "name" is defined to be excluded by the specified
624 * exclude list, 1 if it is included, and 0 if it was not matched.
626 int check_filter(struct filter_list_struct *listp, char *name, int name_is_dir)
628 struct filter_struct *ent;
630 for (ent = listp->head; ent; ent = ent->next) {
631 if (ignore_perishable && ent->match_flags & MATCHFLG_PERISHABLE)
633 if (ent->match_flags & MATCHFLG_PERDIR_MERGE) {
634 int rc = check_filter(ent->u.mergelist, name,
640 if (ent->match_flags & MATCHFLG_CVS_IGNORE) {
641 int rc = check_filter(&cvs_filter_list, name,
647 if (rule_matches(name, ent, name_is_dir)) {
648 report_filter_result(name, ent, name_is_dir,
650 return ent->match_flags & MATCHFLG_INCLUDE ? 1 : -1;
657 #define RULE_STRCMP(s,r) rule_strcmp((s), (r), sizeof (r) - 1)
659 static const uchar *rule_strcmp(const uchar *str, const char *rule, int rule_len)
661 if (strncmp((char*)str, rule, rule_len) != 0)
663 if (isspace(str[rule_len]) || str[rule_len] == '_' || !str[rule_len])
664 return str + rule_len - 1;
665 if (str[rule_len] == ',')
666 return str + rule_len;
670 /* Get the next include/exclude arg from the string. The token will not
671 * be '\0' terminated, so use the returned length to limit the string.
672 * Also, be sure to add this length to the returned pointer before passing
673 * it back to ask for the next token. This routine parses the "!" (list-
674 * clearing) token and (depending on the mflags) the various prefixes.
675 * The *mflags_ptr value will be set on exit to the new MATCHFLG_* bits
676 * for the current token. */
677 static const char *parse_rule_tok(const char *p, uint32 mflags, int xflags,
678 unsigned int *len_ptr, uint32 *mflags_ptr)
680 const uchar *s = (const uchar *)p;
684 if (mflags & MATCHFLG_WORD_SPLIT) {
685 /* Skip over any initial whitespace. */
688 /* Update to point to real start of rule. */
694 new_mflags = mflags & MATCHFLGS_FROM_CONTAINER;
696 /* Figure out what kind of a filter rule "s" is pointing at. Note
697 * that if MATCHFLG_NO_PREFIXES is set, the rule is either an include
698 * or an exclude based on the inheritance of the MATCHFLG_INCLUDE
699 * flag (above). XFLG_OLD_PREFIXES indicates a compatibility mode
700 * for old include/exclude patterns where just "+ " and "- " are
701 * allowed as optional prefixes. */
702 if (mflags & MATCHFLG_NO_PREFIXES) {
703 if (*s == '!' && mflags & MATCHFLG_CVS_IGNORE)
704 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
705 } else if (xflags & XFLG_OLD_PREFIXES) {
706 if (*s == '-' && s[1] == ' ') {
707 new_mflags &= ~MATCHFLG_INCLUDE;
709 } else if (*s == '+' && s[1] == ' ') {
710 new_mflags |= MATCHFLG_INCLUDE;
712 } else if (*s == '!')
713 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
715 char ch = 0, *mods = "";
718 if ((s = RULE_STRCMP(s, "clear")) != NULL)
722 if ((s = RULE_STRCMP(s, "dir-merge")) != NULL)
726 if ((s = RULE_STRCMP(s, "exclude")) != NULL)
730 if ((s = RULE_STRCMP(s, "hide")) != NULL)
734 if ((s = RULE_STRCMP(s, "include")) != NULL)
738 if ((s = RULE_STRCMP(s, "merge")) != NULL)
742 if ((s = RULE_STRCMP(s, "protect")) != NULL)
746 if ((s = RULE_STRCMP(s, "risk")) != NULL)
750 if ((s = RULE_STRCMP(s, "show")) != NULL)
761 new_mflags |= MATCHFLG_PERDIR_MERGE
762 | MATCHFLG_FINISH_SETUP;
765 new_mflags |= MATCHFLG_MERGE_FILE;
766 mods = MODIFIERS_INCL_EXCL MODIFIERS_MERGE_FILE;
769 new_mflags |= MATCHFLG_INCLUDE;
772 mods = MODIFIERS_INCL_EXCL;
775 new_mflags |= MATCHFLG_INCLUDE;
778 new_mflags |= MATCHFLG_SENDER_SIDE;
779 mods = MODIFIERS_HIDE_PROTECT;
782 new_mflags |= MATCHFLG_INCLUDE;
785 new_mflags |= MATCHFLG_RECEIVER_SIDE;
786 mods = MODIFIERS_HIDE_PROTECT;
789 new_mflags |= MATCHFLG_CLEAR_LIST;
793 rprintf(FERROR, "Unknown filter rule: `%s'\n", p);
794 exit_cleanup(RERR_SYNTAX);
796 while (mods && *++s && *s != ' ' && *s != '_') {
797 if (strchr(mods, *s) == NULL) {
798 if (mflags & MATCHFLG_WORD_SPLIT && isspace(*s)) {
804 "invalid modifier sequence at '%c' in filter rule: %s\n",
806 exit_cleanup(RERR_SYNTAX);
810 if (new_mflags & MATCHFLG_NO_PREFIXES)
812 new_mflags |= MATCHFLG_NO_PREFIXES;
815 if (new_mflags & MATCHFLG_NO_PREFIXES)
817 new_mflags |= MATCHFLG_NO_PREFIXES
821 new_mflags |= MATCHFLG_ABS_PATH;
824 new_mflags |= MATCHFLG_NEGATE;
827 if (new_mflags & MATCHFLG_NO_PREFIXES)
829 new_mflags |= MATCHFLG_NO_PREFIXES
830 | MATCHFLG_WORD_SPLIT
831 | MATCHFLG_NO_INHERIT
832 | MATCHFLG_CVS_IGNORE;
835 new_mflags |= MATCHFLG_EXCLUDE_SELF;
838 new_mflags |= MATCHFLG_NO_INHERIT;
841 new_mflags |= MATCHFLG_PERISHABLE;
844 new_mflags |= MATCHFLG_RECEIVER_SIDE;
847 new_mflags |= MATCHFLG_SENDER_SIDE;
850 new_mflags |= MATCHFLG_WORD_SPLIT;
858 if (mflags & MATCHFLG_WORD_SPLIT) {
860 /* Token ends at whitespace or the end of the string. */
861 while (!isspace(*cp) && *cp != '\0')
865 len = strlen((char*)s);
867 if (new_mflags & MATCHFLG_CLEAR_LIST) {
868 if (!(mflags & MATCHFLG_NO_PREFIXES)
869 && !(xflags & XFLG_OLD_PREFIXES) && len) {
871 "'!' rule has trailing characters: %s\n", p);
872 exit_cleanup(RERR_SYNTAX);
875 new_mflags &= ~MATCHFLG_CLEAR_LIST;
876 } else if (!len && !(new_mflags & MATCHFLG_CVS_IGNORE)) {
877 rprintf(FERROR, "unexpected end of filter rule: %s\n", p);
878 exit_cleanup(RERR_SYNTAX);
881 /* --delete-excluded turns an un-modified include/exclude into a
882 * sender-side rule. We also affect per-dir merge files that take
883 * no prefixes as a simple optimization. */
885 && !(new_mflags & (MATCHFLG_RECEIVER_SIDE|MATCHFLG_SENDER_SIDE))
886 && (!(new_mflags & MATCHFLG_PERDIR_MERGE)
887 || new_mflags & MATCHFLG_NO_PREFIXES))
888 new_mflags |= MATCHFLG_SENDER_SIDE;
891 *mflags_ptr = new_mflags;
892 return (const char *)s;
896 static char default_cvsignore[] =
897 /* These default ignored items come from the CVS manual. */
898 "RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS"
899 " .make.state .nse_depinfo *~ #* .#* ,* _$* *$"
900 " *.old *.bak *.BAK *.orig *.rej .del-*"
901 " *.a *.olb *.o *.obj *.so *.exe"
902 " *.Z *.elc *.ln core"
903 /* The rest we added to suit ourself. */
906 static void get_cvs_excludes(uint32 mflags)
908 static int initialized = 0;
909 char *p, fname[MAXPATHLEN];
915 parse_rule(&cvs_filter_list, default_cvsignore,
916 mflags | (protocol_version >= 30 ? MATCHFLG_PERISHABLE : 0),
919 p = module_id >= 0 && lp_use_chroot(module_id) ? "/" : getenv("HOME");
920 if (p && pathjoin(fname, MAXPATHLEN, p, ".cvsignore") < MAXPATHLEN)
921 parse_filter_file(&cvs_filter_list, fname, mflags, 0);
923 parse_rule(&cvs_filter_list, getenv("CVSIGNORE"), mflags, 0);
927 void parse_rule(struct filter_list_struct *listp, const char *pattern,
928 uint32 mflags, int xflags)
930 unsigned int pat_len;
938 /* Remember that the returned string is NOT '\0' terminated! */
939 cp = parse_rule_tok(pattern, mflags, xflags,
940 &pat_len, &new_mflags);
944 pattern = cp + pat_len;
946 if (pat_len >= MAXPATHLEN) {
947 rprintf(FERROR, "discarding over-long filter: %.*s\n",
952 if (new_mflags & MATCHFLG_CLEAR_LIST) {
955 "[%s] clearing filter list%s\n",
956 who_am_i(), listp->debug_type);
958 clear_filter_list(listp);
962 if (new_mflags & MATCHFLG_MERGE_FILE) {
969 if (new_mflags & MATCHFLG_EXCLUDE_SELF) {
970 const char *name = cp + len;
971 while (name > cp && name[-1] != '/') name--;
973 add_rule(listp, name, len, 0, 0);
974 new_mflags &= ~MATCHFLG_EXCLUDE_SELF;
977 if (new_mflags & MATCHFLG_PERDIR_MERGE) {
978 if (parent_dirscan) {
979 if (!(p = parse_merge_name(cp, &len,
982 add_rule(listp, p, len, new_mflags, 0);
986 if (!(p = parse_merge_name(cp, &len, 0)))
988 parse_filter_file(listp, p, new_mflags,
994 add_rule(listp, cp, pat_len, new_mflags, xflags);
996 if (new_mflags & MATCHFLG_CVS_IGNORE
997 && !(new_mflags & MATCHFLG_MERGE_FILE))
998 get_cvs_excludes(new_mflags);
1003 void parse_filter_file(struct filter_list_struct *listp, const char *fname,
1004 uint32 mflags, int xflags)
1007 char line[BIGPATHBUFLEN];
1008 char *eob = line + sizeof line - 1;
1009 int word_split = mflags & MATCHFLG_WORD_SPLIT;
1011 if (!fname || !*fname)
1014 if (*fname != '-' || fname[1] || am_server) {
1015 if (server_filter_list.head) {
1016 strlcpy(line, fname, sizeof line);
1017 clean_fname(line, 1);
1018 if (check_filter(&server_filter_list, line, 0) < 0)
1021 fp = fopen(line, "rb");
1023 fp = fopen(fname, "rb");
1028 rprintf(FINFO, "[%s] parse_filter_file(%s,%x,%x)%s\n",
1029 who_am_i(), fname, mflags, xflags,
1030 fp ? "" : " [not found]");
1034 if (xflags & XFLG_FATAL_ERRORS) {
1035 rsyserr(FERROR, errno,
1036 "failed to open %sclude file %s",
1037 mflags & MATCHFLG_INCLUDE ? "in" : "ex",
1039 exit_cleanup(RERR_FILEIO);
1043 dirbuf[dirbuf_len] = '\0';
1047 int ch, overflow = 0;
1049 if ((ch = getc(fp)) == EOF) {
1050 if (ferror(fp) && errno == EINTR) {
1056 if (word_split && isspace(ch))
1058 if (eol_nulls? !ch : (ch == '\n' || ch == '\r'))
1066 rprintf(FERROR, "discarding over-long filter: %s...\n", line);
1070 /* Skip an empty token and (when line parsing) comments. */
1071 if (*line && (word_split || (*line != ';' && *line != '#')))
1072 parse_rule(listp, line, mflags, xflags);
1079 /* If the "for_xfer" flag is set, the prefix is made compatible with the
1080 * current protocol_version (if possible) or a NULL is returned (if not
1082 char *get_rule_prefix(int match_flags, const char *pat, int for_xfer,
1083 unsigned int *plen_ptr)
1085 static char buf[MAX_RULE_PREFIX+1];
1087 int legal_len = for_xfer && protocol_version < 29 ? 1 : MAX_RULE_PREFIX-1;
1089 if (match_flags & MATCHFLG_PERDIR_MERGE) {
1093 } else if (match_flags & MATCHFLG_INCLUDE)
1095 else if (legal_len != 1
1096 || ((*pat == '-' || *pat == '+') && pat[1] == ' '))
1101 if (match_flags & MATCHFLG_NEGATE)
1103 if (match_flags & MATCHFLG_CVS_IGNORE)
1106 if (match_flags & MATCHFLG_NO_INHERIT)
1108 if (match_flags & MATCHFLG_WORD_SPLIT)
1110 if (match_flags & MATCHFLG_NO_PREFIXES) {
1111 if (match_flags & MATCHFLG_INCLUDE)
1117 if (match_flags & MATCHFLG_EXCLUDE_SELF)
1119 if (match_flags & MATCHFLG_SENDER_SIDE
1120 && (!for_xfer || protocol_version >= 29))
1122 if (match_flags & MATCHFLG_RECEIVER_SIDE
1123 && (!for_xfer || protocol_version >= 29
1124 || (delete_excluded && am_sender)))
1126 if (match_flags & MATCHFLG_PERISHABLE) {
1127 if (!for_xfer || protocol_version >= 30)
1132 if (op - buf > legal_len)
1138 *plen_ptr = op - buf;
1142 static void send_rules(int f_out, struct filter_list_struct *flp)
1144 struct filter_struct *ent, *prev = NULL;
1146 for (ent = flp->head; ent; ent = ent->next) {
1147 unsigned int len, plen, dlen;
1151 /* Note we need to check delete_excluded here in addition to
1152 * the code in parse_rule_tok() because some rules may have
1153 * been added before we found the --delete-excluded option.
1154 * We must also elide any CVS merge-file rules to avoid a
1155 * backward compatibility problem, and we elide any no-prefix
1156 * merge files as an optimization (since they can only have
1157 * include/exclude rules). */
1158 if (ent->match_flags & MATCHFLG_SENDER_SIDE)
1159 elide = am_sender ? 1 : -1;
1160 if (ent->match_flags & MATCHFLG_RECEIVER_SIDE)
1161 elide = elide ? 0 : am_sender ? -1 : 1;
1162 else if (delete_excluded && !elide
1163 && (!(ent->match_flags & MATCHFLG_PERDIR_MERGE)
1164 || ent->match_flags & MATCHFLG_NO_PREFIXES))
1165 elide = am_sender ? 1 : -1;
1168 prev->next = ent->next;
1170 flp->head = ent->next;
1175 if (ent->match_flags & MATCHFLG_CVS_IGNORE
1176 && !(ent->match_flags & MATCHFLG_MERGE_FILE)) {
1177 int f = am_sender || protocol_version < 29 ? f_out : -2;
1178 send_rules(f, &cvs_filter_list);
1182 p = get_rule_prefix(ent->match_flags, ent->pattern, 1, &plen);
1185 "filter rules are too modern for remote rsync.\n");
1186 exit_cleanup(RERR_PROTOCOL);
1190 len = strlen(ent->pattern);
1191 dlen = ent->match_flags & MATCHFLG_DIRECTORY ? 1 : 0;
1192 if (!(plen + len + dlen))
1194 write_int(f_out, plen + len + dlen);
1196 write_buf(f_out, p, plen);
1197 write_buf(f_out, ent->pattern, len);
1199 write_byte(f_out, '/');
1204 /* This is only called by the client. */
1205 void send_filter_list(int f_out)
1207 int receiver_wants_list = prune_empty_dirs
1208 || (delete_mode && (!delete_excluded || protocol_version >= 29));
1210 if (local_server || (am_sender && !receiver_wants_list))
1212 if (cvs_exclude && am_sender) {
1213 if (protocol_version >= 29)
1214 parse_rule(&filter_list, ":C", 0, 0);
1215 parse_rule(&filter_list, "-C", 0, 0);
1218 /* This is a complete hack - blame Rusty. FIXME!
1219 * Remove this hack when older rsyncs (below 2.6.4) are gone. */
1220 if (list_only == 1 && !recurse)
1221 parse_rule(&filter_list, "/*/*", MATCHFLG_NO_PREFIXES, 0);
1223 send_rules(f_out, &filter_list);
1226 write_int(f_out, 0);
1229 if (!am_sender || protocol_version < 29)
1230 parse_rule(&filter_list, ":C", 0, 0);
1232 parse_rule(&filter_list, "-C", 0, 0);
1236 /* This is only called by the server. */
1237 void recv_filter_list(int f_in)
1239 char line[BIGPATHBUFLEN];
1240 int xflags = protocol_version >= 29 ? 0 : XFLG_OLD_PREFIXES;
1241 int receiver_wants_list = prune_empty_dirs
1243 && (!delete_excluded || protocol_version >= 29));
1246 if (!local_server && (am_sender || receiver_wants_list)) {
1247 while ((len = read_int(f_in)) != 0) {
1248 if (len >= sizeof line)
1249 overflow_exit("recv_rules");
1250 read_sbuf(f_in, line, len);
1251 parse_rule(&filter_list, line, 0, xflags);
1256 if (local_server || am_sender || protocol_version < 29)
1257 parse_rule(&filter_list, ":C", 0, 0);
1258 if (local_server || am_sender)
1259 parse_rule(&filter_list, "-C", 0, 0);
1262 if (local_server) /* filter out any rules that aren't for us. */
1263 send_rules(-1, &filter_list);