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-2008 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.
29 extern int local_server;
30 extern int prune_empty_dirs;
31 extern int ignore_perishable;
32 extern int delete_mode;
33 extern int delete_excluded;
34 extern int cvs_exclude;
35 extern int sanitize_paths;
36 extern int protocol_version;
39 extern char curr_dir[];
40 extern unsigned int curr_dir_len;
41 extern unsigned int module_dirlen;
43 struct filter_list_struct filter_list = { 0, 0, "" };
44 struct filter_list_struct cvs_filter_list = { 0, 0, " [global CVS]" };
45 struct filter_list_struct daemon_filter_list = { 0, 0, " [daemon]" };
47 /* Need room enough for ":MODS " prefix plus some room to grow. */
48 #define MAX_RULE_PREFIX (16)
50 #define MODIFIERS_MERGE_FILE "-+Cenw"
51 #define MODIFIERS_INCL_EXCL "/!Crsp"
52 #define MODIFIERS_HIDE_PROTECT "/!p"
54 #define SLASH_WILD3_SUFFIX "/***"
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;
123 unsigned int pre_len, suf_len, slash_cnt = 0;
125 if (DEBUG_GTE(FILTER, 2)) {
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 (pat_len > 1 && pat[pat_len-1] == '/') {
151 mflags |= MATCHFLG_DIRECTORY;
154 for (cp = pat; cp < pat + pat_len; cp++) {
159 if (!(mflags & (MATCHFLG_ABS_PATH | MATCHFLG_MERGE_FILE))
160 && ((xflags & (XFLG_ANCHORED2ABS|XFLG_ABS_IF_SLASH) && *pat == '/')
161 || (xflags & XFLG_ABS_IF_SLASH && slash_cnt))) {
162 mflags |= MATCHFLG_ABS_PATH;
164 pre_len = dirbuf_len - module_dirlen - 1;
170 /* The daemon wants dir-exclude rules to get an appended "/" + "***". */
171 if (xflags & XFLG_DIR2WILD3
172 && BITS_SETnUNSET(mflags, MATCHFLG_DIRECTORY, MATCHFLG_INCLUDE)) {
173 mflags &= ~MATCHFLG_DIRECTORY;
174 suf_len = sizeof SLASH_WILD3_SUFFIX - 1;
178 if (!(ret->pattern = new_array(char, pre_len + pat_len + suf_len + 1)))
179 out_of_memory("add_rule");
181 memcpy(ret->pattern, dirbuf + module_dirlen, pre_len);
182 for (cp = ret->pattern; cp < ret->pattern + pre_len; cp++) {
187 strlcpy(ret->pattern + pre_len, pat, pat_len + 1);
190 memcpy(ret->pattern + pat_len, SLASH_WILD3_SUFFIX, suf_len+1);
195 if (strpbrk(ret->pattern, "*[?")) {
196 mflags |= MATCHFLG_WILD;
197 if ((cp = strstr(ret->pattern, "**")) != NULL) {
198 mflags |= MATCHFLG_WILD2;
199 /* If the pattern starts with **, note that. */
200 if (cp == ret->pattern)
201 mflags |= MATCHFLG_WILD2_PREFIX;
202 /* If the pattern ends with ***, note that. */
204 && ret->pattern[pat_len-3] == '*'
205 && ret->pattern[pat_len-2] == '*'
206 && ret->pattern[pat_len-1] == '*')
207 mflags |= MATCHFLG_WILD3_SUFFIX;
211 if (mflags & MATCHFLG_PERDIR_MERGE) {
212 struct filter_list_struct *lp;
216 if ((cp = strrchr(ret->pattern, '/')) != NULL)
221 /* If the local merge file was already mentioned, don't
223 for (i = 0; i < mergelist_cnt; i++) {
224 struct filter_struct *ex = mergelist_parents[i];
225 const char *s = strrchr(ex->pattern, '/');
231 if (len == pat_len - (cp - ret->pattern)
232 && memcmp(s, cp, len) == 0) {
238 if (!(lp = new_array(struct filter_list_struct, 1)))
239 out_of_memory("add_rule");
240 lp->head = lp->tail = NULL;
241 if (asprintf(&lp->debug_type, " [per-dir %s]", cp) < 0)
242 out_of_memory("add_rule");
243 ret->u.mergelist = lp;
245 if (mergelist_cnt == mergelist_size) {
247 mergelist_parents = realloc_array(mergelist_parents,
248 struct filter_struct *,
250 if (!mergelist_parents)
251 out_of_memory("add_rule");
253 mergelist_parents[mergelist_cnt++] = ret;
255 ret->u.slash_cnt = slash_cnt;
257 ret->match_flags = mflags;
260 ret->next = listp->head;
261 listp->head = listp->tail = ret;
263 ret->next = listp->tail->next;
264 listp->tail->next = ret;
269 static void clear_filter_list(struct filter_list_struct *listp)
272 struct filter_struct *ent, *next;
273 /* Truncate any inherited items from the local list. */
274 listp->tail->next = NULL;
275 /* Now free everything that is left. */
276 for (ent = listp->head; ent; ent = next) {
282 listp->head = listp->tail = NULL;
285 /* This returns an expanded (absolute) filename for the merge-file name if
286 * the name has any slashes in it OR if the parent_dirscan var is True;
287 * otherwise it returns the original merge_file name. If the len_ptr value
288 * is non-NULL the merge_file name is limited by the referenced length
289 * value and will be updated with the length of the resulting name. We
290 * always return a name that is null terminated, even if the merge_file
292 static char *parse_merge_name(const char *merge_file, unsigned int *len_ptr,
293 unsigned int prefix_skip)
295 static char buf[MAXPATHLEN];
296 char *fn, tmpbuf[MAXPATHLEN];
299 if (!parent_dirscan && *merge_file != '/') {
300 /* Return the name unchanged it doesn't have any slashes. */
302 const char *p = merge_file + *len_ptr;
303 while (--p > merge_file && *p != '/') {}
304 if (p == merge_file) {
305 strlcpy(buf, merge_file, *len_ptr + 1);
308 } else if (strchr(merge_file, '/') == NULL)
309 return (char *)merge_file;
312 fn = *merge_file == '/' ? buf : tmpbuf;
313 if (sanitize_paths) {
314 const char *r = prefix_skip ? "/" : NULL;
315 /* null-terminate the name if it isn't already */
316 if (len_ptr && merge_file[*len_ptr]) {
317 char *to = fn == buf ? tmpbuf : buf;
318 strlcpy(to, merge_file, *len_ptr + 1);
321 if (!sanitize_path(fn, merge_file, r, dirbuf_depth, SP_DEFAULT)) {
322 rprintf(FERROR, "merge-file name overflows: %s\n",
328 strlcpy(fn, merge_file, len_ptr ? *len_ptr + 1 : MAXPATHLEN);
329 fn_len = clean_fname(fn, CFN_COLLAPSE_DOT_DOT_DIRS);
332 /* If the name isn't in buf yet, it's wasn't absolute. */
334 int d_len = dirbuf_len - prefix_skip;
335 if (d_len + fn_len >= MAXPATHLEN) {
336 rprintf(FERROR, "merge-file name overflows: %s\n", fn);
339 memcpy(buf, dirbuf + prefix_skip, d_len);
340 memcpy(buf + d_len, fn, fn_len + 1);
341 fn_len = clean_fname(buf, CFN_COLLAPSE_DOT_DOT_DIRS);
349 /* Sets the dirbuf and dirbuf_len values. */
350 void set_filter_dir(const char *dir, unsigned int dirlen)
354 memcpy(dirbuf, curr_dir, curr_dir_len);
355 dirbuf[curr_dir_len] = '/';
356 len = curr_dir_len + 1;
357 if (len + dirlen >= MAXPATHLEN)
361 memcpy(dirbuf + len, dir, dirlen);
362 dirbuf[dirlen + len] = '\0';
363 dirbuf_len = clean_fname(dirbuf, CFN_COLLAPSE_DOT_DOT_DIRS);
364 if (dirbuf_len > 1 && dirbuf[dirbuf_len-1] == '.'
365 && dirbuf[dirbuf_len-2] == '/')
368 dirbuf[dirbuf_len++] = '/';
369 dirbuf[dirbuf_len] = '\0';
371 dirbuf_depth = count_dir_elements(dirbuf + module_dirlen);
374 /* This routine takes a per-dir merge-file entry and finishes its setup.
375 * If the name has a path portion then we check to see if it refers to a
376 * parent directory of the first transfer dir. If it does, we scan all the
377 * dirs from that point through the parent dir of the transfer dir looking
378 * for the per-dir merge-file in each one. */
379 static BOOL setup_merge_file(struct filter_struct *ex,
380 struct filter_list_struct *lp)
382 char buf[MAXPATHLEN];
383 char *x, *y, *pat = ex->pattern;
386 if (!(x = parse_merge_name(pat, NULL, 0)) || *x != '/')
391 ex->pattern = strdup(y+1);
395 strlcpy(buf, x, MAXPATHLEN);
397 pathjoin(buf, MAXPATHLEN, dirbuf, x);
399 len = clean_fname(buf, CFN_COLLAPSE_DOT_DOT_DIRS);
400 if (len != 1 && len < MAXPATHLEN-1) {
404 /* This ensures that the specified dir is a parent of the transfer. */
405 for (x = buf, y = dirbuf; *x && *x == *y; x++, y++) {}
407 y += strlen(y); /* nope -- skip the scan */
409 parent_dirscan = True;
411 char save[MAXPATHLEN];
412 strlcpy(save, y, MAXPATHLEN);
414 dirbuf_len = y - dirbuf;
415 strlcpy(x, ex->pattern, MAXPATHLEN - (x - buf));
416 parse_filter_file(lp, buf, ex->match_flags, XFLG_ANCHORED2ABS);
417 if (ex->match_flags & MATCHFLG_NO_INHERIT)
420 strlcpy(y, save, MAXPATHLEN);
421 while ((*x++ = *y++) != '/') {}
423 parent_dirscan = False;
428 /* Each time rsync changes to a new directory it call this function to
429 * handle all the per-dir merge-files. The "dir" value is the current path
430 * relative to curr_dir (which might not be null-terminated). We copy it
431 * into dirbuf so that we can easily append a file name on the end. */
432 void *push_local_filters(const char *dir, unsigned int dirlen)
434 struct filter_list_struct *ap, *push;
437 set_filter_dir(dir, dirlen);
442 push = new_array(struct filter_list_struct, mergelist_cnt);
444 out_of_memory("push_local_filters");
446 for (i = 0, ap = push; i < mergelist_cnt; i++) {
447 memcpy(ap++, mergelist_parents[i]->u.mergelist,
448 sizeof (struct filter_list_struct));
451 /* Note: parse_filter_file() might increase mergelist_cnt, so keep
452 * this loop separate from the above loop. */
453 for (i = 0; i < mergelist_cnt; i++) {
454 struct filter_struct *ex = mergelist_parents[i];
455 struct filter_list_struct *lp = ex->u.mergelist;
457 if (DEBUG_GTE(FILTER, 2)) {
458 rprintf(FINFO, "[%s] pushing filter list%s\n",
459 who_am_i(), lp->debug_type);
462 lp->tail = NULL; /* Switch any local rules to inherited. */
463 if (ex->match_flags & MATCHFLG_NO_INHERIT)
466 if (ex->match_flags & MATCHFLG_FINISH_SETUP) {
467 ex->match_flags &= ~MATCHFLG_FINISH_SETUP;
468 if (setup_merge_file(ex, lp))
469 set_filter_dir(dir, dirlen);
472 if (strlcpy(dirbuf + dirbuf_len, ex->pattern,
473 MAXPATHLEN - dirbuf_len) < MAXPATHLEN - dirbuf_len) {
474 parse_filter_file(lp, dirbuf, ex->match_flags,
477 io_error |= IOERR_GENERAL;
479 "cannot add local filter rules in long-named directory: %s\n",
482 dirbuf[dirbuf_len] = '\0';
488 void pop_local_filters(void *mem)
490 struct filter_list_struct *ap, *pop = (struct filter_list_struct*)mem;
493 for (i = mergelist_cnt; i-- > 0; ) {
494 struct filter_struct *ex = mergelist_parents[i];
495 struct filter_list_struct *lp = ex->u.mergelist;
497 if (DEBUG_GTE(FILTER, 2)) {
498 rprintf(FINFO, "[%s] popping filter list%s\n",
499 who_am_i(), lp->debug_type);
502 clear_filter_list(lp);
508 for (i = 0, ap = pop; i < mergelist_cnt; i++) {
509 memcpy(mergelist_parents[i]->u.mergelist, ap++,
510 sizeof (struct filter_list_struct));
516 void change_local_filter_dir(const char *dname, int dlen, int dir_depth)
518 static int cur_depth = -1;
519 static void *filt_array[MAXPATHLEN/2+1];
522 for ( ; cur_depth >= 0; cur_depth--) {
523 if (filt_array[cur_depth]) {
524 pop_local_filters(filt_array[cur_depth]);
525 filt_array[cur_depth] = NULL;
531 assert(dir_depth < MAXPATHLEN/2+1);
533 for ( ; cur_depth >= dir_depth; cur_depth--) {
534 if (filt_array[cur_depth]) {
535 pop_local_filters(filt_array[cur_depth]);
536 filt_array[cur_depth] = NULL;
540 cur_depth = dir_depth;
541 filt_array[cur_depth] = push_local_filters(dname, dlen);
544 static int rule_matches(const char *fname, struct filter_struct *ex, int name_is_dir)
546 int slash_handling, str_cnt = 0, anchored_match = 0;
547 int ret_match = ex->match_flags & MATCHFLG_NEGATE ? 0 : 1;
548 char *p, *pattern = ex->pattern;
549 const char *strings[16]; /* more than enough */
550 const char *name = fname + (*fname == '/');
555 if (!ex->u.slash_cnt && !(ex->match_flags & MATCHFLG_WILD2)) {
556 /* If the pattern does not have any slashes AND it does
557 * not have a "**" (which could match a slash), then we
558 * just match the name portion of the path. */
559 if ((p = strrchr(name,'/')) != NULL)
561 } else if (ex->match_flags & MATCHFLG_ABS_PATH && *fname != '/'
562 && curr_dir_len > module_dirlen + 1) {
563 /* If we're matching against an absolute-path pattern,
564 * we need to prepend our full path info. */
565 strings[str_cnt++] = curr_dir + module_dirlen + 1;
566 strings[str_cnt++] = "/";
567 } else if (ex->match_flags & MATCHFLG_WILD2_PREFIX && *fname != '/') {
568 /* Allow "**"+"/" to match at the start of the string. */
569 strings[str_cnt++] = "/";
571 strings[str_cnt++] = name;
573 /* Allow a trailing "/"+"***" to match the directory. */
574 if (ex->match_flags & MATCHFLG_WILD3_SUFFIX)
575 strings[str_cnt++] = "/";
576 } else if (ex->match_flags & MATCHFLG_DIRECTORY)
578 strings[str_cnt] = NULL;
580 if (*pattern == '/') {
585 if (!anchored_match && ex->u.slash_cnt
586 && !(ex->match_flags & MATCHFLG_WILD2)) {
587 /* A non-anchored match with an infix slash and no "**"
588 * needs to match the last slash_cnt+1 name elements. */
589 slash_handling = ex->u.slash_cnt + 1;
590 } else if (!anchored_match && !(ex->match_flags & MATCHFLG_WILD2_PREFIX)
591 && ex->match_flags & MATCHFLG_WILD2) {
592 /* A non-anchored match with an infix or trailing "**" (but not
593 * a prefixed "**") needs to try matching after every slash. */
596 /* The pattern matches only at the start of the path or name. */
600 if (ex->match_flags & MATCHFLG_WILD) {
601 if (wildmatch_array(pattern, strings, slash_handling))
603 } else if (str_cnt > 1) {
604 if (litmatch_array(pattern, strings, slash_handling))
606 } else if (anchored_match) {
607 if (strcmp(name, pattern) == 0)
610 int l1 = strlen(name);
611 int l2 = strlen(pattern);
613 strcmp(name+(l1-l2),pattern) == 0 &&
614 (l1==l2 || name[l1-(l2+1)] == '/')) {
623 static void report_filter_result(enum logcode code, char const *name,
624 struct filter_struct const *ent,
625 int name_is_dir, const char *type)
627 /* If a trailing slash is present to match only directories,
628 * then it is stripped out by add_rule(). So as a special
629 * case we add it back in here. */
631 if (DEBUG_GTE(FILTER, 1)) {
632 static char *actions[2][2]
633 = { {"show", "hid"}, {"risk", "protect"} };
634 const char *w = who_am_i();
635 rprintf(code, "[%s] %sing %s %s because of pattern %s%s%s\n",
636 w, actions[*w!='s'][!(ent->match_flags&MATCHFLG_INCLUDE)],
637 name_is_dir ? "directory" : "file", name, ent->pattern,
638 ent->match_flags & MATCHFLG_DIRECTORY ? "/" : "", type);
644 * Return -1 if file "name" is defined to be excluded by the specified
645 * exclude list, 1 if it is included, and 0 if it was not matched.
647 int check_filter(struct filter_list_struct *listp, enum logcode code,
648 const char *name, int name_is_dir)
650 struct filter_struct *ent;
652 for (ent = listp->head; ent; ent = ent->next) {
653 if (ignore_perishable && ent->match_flags & MATCHFLG_PERISHABLE)
655 if (ent->match_flags & MATCHFLG_PERDIR_MERGE) {
656 int rc = check_filter(ent->u.mergelist, code, name,
662 if (ent->match_flags & MATCHFLG_CVS_IGNORE) {
663 int rc = check_filter(&cvs_filter_list, code, name,
669 if (rule_matches(name, ent, name_is_dir)) {
670 report_filter_result(code, name, ent, name_is_dir,
672 return ent->match_flags & MATCHFLG_INCLUDE ? 1 : -1;
679 #define RULE_STRCMP(s,r) rule_strcmp((s), (r), sizeof (r) - 1)
681 static const uchar *rule_strcmp(const uchar *str, const char *rule, int rule_len)
683 if (strncmp((char*)str, rule, rule_len) != 0)
685 if (isspace(str[rule_len]) || str[rule_len] == '_' || !str[rule_len])
686 return str + rule_len - 1;
687 if (str[rule_len] == ',')
688 return str + rule_len;
692 /* Get the next include/exclude arg from the string. The token will not
693 * be '\0' terminated, so use the returned length to limit the string.
694 * Also, be sure to add this length to the returned pointer before passing
695 * it back to ask for the next token. This routine parses the "!" (list-
696 * clearing) token and (depending on the mflags) the various prefixes.
697 * The *mflags_ptr value will be set on exit to the new MATCHFLG_* bits
698 * for the current token. */
699 static const char *parse_rule_tok(const char *p, uint32 mflags, int xflags,
700 unsigned int *len_ptr, uint32 *mflags_ptr)
702 const uchar *s = (const uchar *)p;
706 if (mflags & MATCHFLG_WORD_SPLIT) {
707 /* Skip over any initial whitespace. */
710 /* Update to point to real start of rule. */
716 new_mflags = mflags & MATCHFLGS_FROM_CONTAINER;
718 /* Figure out what kind of a filter rule "s" is pointing at. Note
719 * that if MATCHFLG_NO_PREFIXES is set, the rule is either an include
720 * or an exclude based on the inheritance of the MATCHFLG_INCLUDE
721 * flag (above). XFLG_OLD_PREFIXES indicates a compatibility mode
722 * for old include/exclude patterns where just "+ " and "- " are
723 * allowed as optional prefixes. */
724 if (mflags & MATCHFLG_NO_PREFIXES) {
725 if (*s == '!' && mflags & MATCHFLG_CVS_IGNORE)
726 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
727 } else if (xflags & XFLG_OLD_PREFIXES) {
728 if (*s == '-' && s[1] == ' ') {
729 new_mflags &= ~MATCHFLG_INCLUDE;
731 } else if (*s == '+' && s[1] == ' ') {
732 new_mflags |= MATCHFLG_INCLUDE;
734 } else if (*s == '!')
735 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
737 char ch = 0, *mods = "";
740 if ((s = RULE_STRCMP(s, "clear")) != NULL)
744 if ((s = RULE_STRCMP(s, "dir-merge")) != NULL)
748 if ((s = RULE_STRCMP(s, "exclude")) != NULL)
752 if ((s = RULE_STRCMP(s, "hide")) != NULL)
756 if ((s = RULE_STRCMP(s, "include")) != NULL)
760 if ((s = RULE_STRCMP(s, "merge")) != NULL)
764 if ((s = RULE_STRCMP(s, "protect")) != NULL)
768 if ((s = RULE_STRCMP(s, "risk")) != NULL)
772 if ((s = RULE_STRCMP(s, "show")) != NULL)
783 new_mflags |= MATCHFLG_PERDIR_MERGE
784 | MATCHFLG_FINISH_SETUP;
787 new_mflags |= MATCHFLG_MERGE_FILE;
788 mods = MODIFIERS_INCL_EXCL MODIFIERS_MERGE_FILE;
791 new_mflags |= MATCHFLG_INCLUDE;
794 mods = MODIFIERS_INCL_EXCL;
797 new_mflags |= MATCHFLG_INCLUDE;
800 new_mflags |= MATCHFLG_SENDER_SIDE;
801 mods = MODIFIERS_HIDE_PROTECT;
804 new_mflags |= MATCHFLG_INCLUDE;
807 new_mflags |= MATCHFLG_RECEIVER_SIDE;
808 mods = MODIFIERS_HIDE_PROTECT;
811 new_mflags |= MATCHFLG_CLEAR_LIST;
815 rprintf(FERROR, "Unknown filter rule: `%s'\n", p);
816 exit_cleanup(RERR_SYNTAX);
818 while (mods && *++s && *s != ' ' && *s != '_') {
819 if (strchr(mods, *s) == NULL) {
820 if (mflags & MATCHFLG_WORD_SPLIT && isspace(*s)) {
826 "invalid modifier sequence at '%c' in filter rule: %s\n",
828 exit_cleanup(RERR_SYNTAX);
832 if (new_mflags & MATCHFLG_NO_PREFIXES)
834 new_mflags |= MATCHFLG_NO_PREFIXES;
837 if (new_mflags & MATCHFLG_NO_PREFIXES)
839 new_mflags |= MATCHFLG_NO_PREFIXES
843 new_mflags |= MATCHFLG_ABS_PATH;
846 new_mflags |= MATCHFLG_NEGATE;
849 if (new_mflags & MATCHFLG_NO_PREFIXES)
851 new_mflags |= MATCHFLG_NO_PREFIXES
852 | MATCHFLG_WORD_SPLIT
853 | MATCHFLG_NO_INHERIT
854 | MATCHFLG_CVS_IGNORE;
857 new_mflags |= MATCHFLG_EXCLUDE_SELF;
860 new_mflags |= MATCHFLG_NO_INHERIT;
863 new_mflags |= MATCHFLG_PERISHABLE;
866 new_mflags |= MATCHFLG_RECEIVER_SIDE;
869 new_mflags |= MATCHFLG_SENDER_SIDE;
872 new_mflags |= MATCHFLG_WORD_SPLIT;
880 if (mflags & MATCHFLG_WORD_SPLIT) {
882 /* Token ends at whitespace or the end of the string. */
883 while (!isspace(*cp) && *cp != '\0')
887 len = strlen((char*)s);
889 if (new_mflags & MATCHFLG_CLEAR_LIST) {
890 if (!(mflags & MATCHFLG_NO_PREFIXES)
891 && !(xflags & XFLG_OLD_PREFIXES) && len) {
893 "'!' rule has trailing characters: %s\n", p);
894 exit_cleanup(RERR_SYNTAX);
897 new_mflags &= ~MATCHFLG_CLEAR_LIST;
898 } else if (!len && !(new_mflags & MATCHFLG_CVS_IGNORE)) {
899 rprintf(FERROR, "unexpected end of filter rule: %s\n", p);
900 exit_cleanup(RERR_SYNTAX);
903 /* --delete-excluded turns an un-modified include/exclude into a
904 * sender-side rule. We also affect per-dir merge files that take
905 * no prefixes as a simple optimization. */
907 && !(new_mflags & (MATCHFLG_RECEIVER_SIDE|MATCHFLG_SENDER_SIDE))
908 && (!(new_mflags & MATCHFLG_PERDIR_MERGE)
909 || new_mflags & MATCHFLG_NO_PREFIXES))
910 new_mflags |= MATCHFLG_SENDER_SIDE;
913 *mflags_ptr = new_mflags;
914 return (const char *)s;
918 static char default_cvsignore[] =
919 /* These default ignored items come from the CVS manual. */
920 "RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS"
921 " .make.state .nse_depinfo *~ #* .#* ,* _$* *$"
922 " *.old *.bak *.BAK *.orig *.rej .del-*"
923 " *.a *.olb *.o *.obj *.so *.exe"
924 " *.Z *.elc *.ln core"
925 /* The rest we added to suit ourself. */
926 " .svn/ .git/ .bzr/";
928 static void get_cvs_excludes(uint32 mflags)
930 static int initialized = 0;
931 char *p, fname[MAXPATHLEN];
937 parse_rule(&cvs_filter_list, default_cvsignore,
938 mflags | (protocol_version >= 30 ? MATCHFLG_PERISHABLE : 0),
941 p = module_id >= 0 && lp_use_chroot(module_id) ? "/" : getenv("HOME");
942 if (p && pathjoin(fname, MAXPATHLEN, p, ".cvsignore") < MAXPATHLEN)
943 parse_filter_file(&cvs_filter_list, fname, mflags, 0);
945 parse_rule(&cvs_filter_list, getenv("CVSIGNORE"), mflags, 0);
949 void parse_rule(struct filter_list_struct *listp, const char *pattern,
950 uint32 mflags, int xflags)
952 unsigned int pat_len;
960 /* Remember that the returned string is NOT '\0' terminated! */
961 cp = parse_rule_tok(pattern, mflags, xflags,
962 &pat_len, &new_mflags);
966 pattern = cp + pat_len;
968 if (pat_len >= MAXPATHLEN) {
969 rprintf(FERROR, "discarding over-long filter: %.*s\n",
974 if (new_mflags & MATCHFLG_CLEAR_LIST) {
975 if (DEBUG_GTE(FILTER, 2)) {
977 "[%s] clearing filter list%s\n",
978 who_am_i(), listp->debug_type);
980 clear_filter_list(listp);
984 if (new_mflags & MATCHFLG_MERGE_FILE) {
991 if (new_mflags & MATCHFLG_EXCLUDE_SELF) {
992 const char *name = cp + len;
993 while (name > cp && name[-1] != '/') name--;
995 add_rule(listp, name, len, 0, 0);
996 new_mflags &= ~MATCHFLG_EXCLUDE_SELF;
999 if (new_mflags & MATCHFLG_PERDIR_MERGE) {
1000 if (parent_dirscan) {
1001 if (!(p = parse_merge_name(cp, &len,
1004 add_rule(listp, p, len, new_mflags, 0);
1008 if (!(p = parse_merge_name(cp, &len, 0)))
1010 parse_filter_file(listp, p, new_mflags,
1016 add_rule(listp, cp, pat_len, new_mflags, xflags);
1018 if (new_mflags & MATCHFLG_CVS_IGNORE
1019 && !(new_mflags & MATCHFLG_MERGE_FILE))
1020 get_cvs_excludes(new_mflags);
1025 void parse_filter_file(struct filter_list_struct *listp, const char *fname,
1026 uint32 mflags, int xflags)
1029 char line[BIGPATHBUFLEN];
1030 char *eob = line + sizeof line - 1;
1031 int word_split = mflags & MATCHFLG_WORD_SPLIT;
1033 if (!fname || !*fname)
1036 if (*fname != '-' || fname[1] || am_server) {
1037 if (daemon_filter_list.head) {
1038 strlcpy(line, fname, sizeof line);
1039 clean_fname(line, CFN_COLLAPSE_DOT_DOT_DIRS);
1040 if (check_filter(&daemon_filter_list, FLOG, line, 0) < 0)
1043 fp = fopen(line, "rb");
1045 fp = fopen(fname, "rb");
1049 if (DEBUG_GTE(FILTER, 2)) {
1050 rprintf(FINFO, "[%s] parse_filter_file(%s,%x,%x)%s\n",
1051 who_am_i(), fname, mflags, xflags,
1052 fp ? "" : " [not found]");
1056 if (xflags & XFLG_FATAL_ERRORS) {
1057 rsyserr(FERROR, errno,
1058 "failed to open %sclude file %s",
1059 mflags & MATCHFLG_INCLUDE ? "in" : "ex",
1061 exit_cleanup(RERR_FILEIO);
1065 dirbuf[dirbuf_len] = '\0';
1069 int ch, overflow = 0;
1071 if ((ch = getc(fp)) == EOF) {
1072 if (ferror(fp) && errno == EINTR) {
1078 if (word_split && isspace(ch))
1080 if (eol_nulls? !ch : (ch == '\n' || ch == '\r'))
1088 rprintf(FERROR, "discarding over-long filter: %s...\n", line);
1092 /* Skip an empty token and (when line parsing) comments. */
1093 if (*line && (word_split || (*line != ';' && *line != '#')))
1094 parse_rule(listp, line, mflags, xflags);
1101 /* If the "for_xfer" flag is set, the prefix is made compatible with the
1102 * current protocol_version (if possible) or a NULL is returned (if not
1104 char *get_rule_prefix(int match_flags, const char *pat, int for_xfer,
1105 unsigned int *plen_ptr)
1107 static char buf[MAX_RULE_PREFIX+1];
1109 int legal_len = for_xfer && protocol_version < 29 ? 1 : MAX_RULE_PREFIX-1;
1111 if (match_flags & MATCHFLG_PERDIR_MERGE) {
1115 } else if (match_flags & MATCHFLG_INCLUDE)
1117 else if (legal_len != 1
1118 || ((*pat == '-' || *pat == '+') && pat[1] == ' '))
1123 if (match_flags & MATCHFLG_NEGATE)
1125 if (match_flags & MATCHFLG_CVS_IGNORE)
1128 if (match_flags & MATCHFLG_NO_INHERIT)
1130 if (match_flags & MATCHFLG_WORD_SPLIT)
1132 if (match_flags & MATCHFLG_NO_PREFIXES) {
1133 if (match_flags & MATCHFLG_INCLUDE)
1139 if (match_flags & MATCHFLG_EXCLUDE_SELF)
1141 if (match_flags & MATCHFLG_SENDER_SIDE
1142 && (!for_xfer || protocol_version >= 29))
1144 if (match_flags & MATCHFLG_RECEIVER_SIDE
1145 && (!for_xfer || protocol_version >= 29
1146 || (delete_excluded && am_sender)))
1148 if (match_flags & MATCHFLG_PERISHABLE) {
1149 if (!for_xfer || protocol_version >= 30)
1154 if (op - buf > legal_len)
1160 *plen_ptr = op - buf;
1164 static void send_rules(int f_out, struct filter_list_struct *flp)
1166 struct filter_struct *ent, *prev = NULL;
1168 for (ent = flp->head; ent; ent = ent->next) {
1169 unsigned int len, plen, dlen;
1173 /* Note we need to check delete_excluded here in addition to
1174 * the code in parse_rule_tok() because some rules may have
1175 * been added before we found the --delete-excluded option.
1176 * We must also elide any CVS merge-file rules to avoid a
1177 * backward compatibility problem, and we elide any no-prefix
1178 * merge files as an optimization (since they can only have
1179 * include/exclude rules). */
1180 if (ent->match_flags & MATCHFLG_SENDER_SIDE)
1181 elide = am_sender ? 1 : -1;
1182 if (ent->match_flags & MATCHFLG_RECEIVER_SIDE)
1183 elide = elide ? 0 : am_sender ? -1 : 1;
1184 else if (delete_excluded && !elide
1185 && (!(ent->match_flags & MATCHFLG_PERDIR_MERGE)
1186 || ent->match_flags & MATCHFLG_NO_PREFIXES))
1187 elide = am_sender ? 1 : -1;
1190 prev->next = ent->next;
1192 flp->head = ent->next;
1197 if (ent->match_flags & MATCHFLG_CVS_IGNORE
1198 && !(ent->match_flags & MATCHFLG_MERGE_FILE)) {
1199 int f = am_sender || protocol_version < 29 ? f_out : -2;
1200 send_rules(f, &cvs_filter_list);
1204 p = get_rule_prefix(ent->match_flags, ent->pattern, 1, &plen);
1207 "filter rules are too modern for remote rsync.\n");
1208 exit_cleanup(RERR_PROTOCOL);
1212 len = strlen(ent->pattern);
1213 dlen = ent->match_flags & MATCHFLG_DIRECTORY ? 1 : 0;
1214 if (!(plen + len + dlen))
1216 write_int(f_out, plen + len + dlen);
1218 write_buf(f_out, p, plen);
1219 write_buf(f_out, ent->pattern, len);
1221 write_byte(f_out, '/');
1226 /* This is only called by the client. */
1227 void send_filter_list(int f_out)
1229 int receiver_wants_list = prune_empty_dirs
1230 || (delete_mode && (!delete_excluded || protocol_version >= 29));
1232 if (local_server || (am_sender && !receiver_wants_list))
1234 if (cvs_exclude && am_sender) {
1235 if (protocol_version >= 29)
1236 parse_rule(&filter_list, ":C", 0, 0);
1237 parse_rule(&filter_list, "-C", 0, 0);
1240 send_rules(f_out, &filter_list);
1243 write_int(f_out, 0);
1246 if (!am_sender || protocol_version < 29)
1247 parse_rule(&filter_list, ":C", 0, 0);
1249 parse_rule(&filter_list, "-C", 0, 0);
1253 /* This is only called by the server. */
1254 void recv_filter_list(int f_in)
1256 char line[BIGPATHBUFLEN];
1257 int xflags = protocol_version >= 29 ? 0 : XFLG_OLD_PREFIXES;
1258 int receiver_wants_list = prune_empty_dirs
1260 && (!delete_excluded || protocol_version >= 29));
1263 if (!local_server && (am_sender || receiver_wants_list)) {
1264 while ((len = read_int(f_in)) != 0) {
1265 if (len >= sizeof line)
1266 overflow_exit("recv_rules");
1267 read_sbuf(f_in, line, len);
1268 parse_rule(&filter_list, line, 0, xflags);
1273 if (local_server || am_sender || protocol_version < 29)
1274 parse_rule(&filter_list, ":C", 0, 0);
1275 if (local_server || am_sender)
1276 parse_rule(&filter_list, "-C", 0, 0);
1279 if (local_server) /* filter out any rules that aren't for us. */
1280 send_rules(-1, &filter_list);