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 version 3 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * 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 = new(struct filter_struct)))
147 out_of_memory("add_rule");
148 memset(ret, 0, sizeof ret[0]);
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 min_depth = MAXPATHLEN, cur_depth = -1;
497 static void *filt_array[MAXPATHLEN/2+1];
500 while (cur_depth >= min_depth)
501 pop_local_filters(filt_array[cur_depth--]);
502 min_depth = MAXPATHLEN;
507 assert(dir_depth < MAXPATHLEN/2+1);
509 while (cur_depth >= dir_depth && cur_depth >= min_depth)
510 pop_local_filters(filt_array[cur_depth--]);
511 cur_depth = dir_depth;
512 if (cur_depth < min_depth)
513 min_depth = cur_depth;
515 filt_array[cur_depth] = push_local_filters(dname, dlen);
518 static int rule_matches(char *name, struct filter_struct *ex, int name_is_dir)
520 int slash_handling, str_cnt = 0, anchored_match = 0;
521 int ret_match = ex->match_flags & MATCHFLG_NEGATE ? 0 : 1;
522 char *p, *pattern = ex->pattern;
523 const char *strings[16]; /* more than enough */
530 if (!ex->u.slash_cnt && !(ex->match_flags & MATCHFLG_WILD2)) {
531 /* If the pattern does not have any slashes AND it does
532 * not have a "**" (which could match a slash), then we
533 * just match the name portion of the path. */
534 if ((p = strrchr(name,'/')) != NULL)
536 } else if (ex->match_flags & MATCHFLG_ABS_PATH && *name != '/'
537 && curr_dir_len > module_dirlen + 1) {
538 /* If we're matching against an absolute-path pattern,
539 * we need to prepend our full path info. */
540 strings[str_cnt++] = curr_dir + module_dirlen + 1;
541 strings[str_cnt++] = "/";
542 } else if (ex->match_flags & MATCHFLG_WILD2_PREFIX && *name != '/') {
543 /* Allow "**"+"/" to match at the start of the string. */
544 strings[str_cnt++] = "/";
546 strings[str_cnt++] = name;
548 /* Allow a trailing "/"+"***" to match the directory. */
549 if (ex->match_flags & MATCHFLG_WILD3_SUFFIX)
550 strings[str_cnt++] = "/";
551 } else if (ex->match_flags & MATCHFLG_DIRECTORY)
553 strings[str_cnt] = NULL;
555 if (*pattern == '/') {
560 if (!anchored_match && ex->u.slash_cnt
561 && !(ex->match_flags & MATCHFLG_WILD2)) {
562 /* A non-anchored match with an infix slash and no "**"
563 * needs to match the last slash_cnt+1 name elements. */
564 slash_handling = ex->u.slash_cnt + 1;
565 } else if (!anchored_match && !(ex->match_flags & MATCHFLG_WILD2_PREFIX)
566 && ex->match_flags & MATCHFLG_WILD2) {
567 /* A non-anchored match with an infix or trailing "**" (but not
568 * a prefixed "**") needs to try matching after every slash. */
571 /* The pattern matches only at the start of the path or name. */
575 if (ex->match_flags & MATCHFLG_WILD) {
576 if (wildmatch_array(pattern, strings, slash_handling))
578 } else if (str_cnt > 1) {
579 if (litmatch_array(pattern, strings, slash_handling))
581 } else if (anchored_match) {
582 if (strcmp(name, pattern) == 0)
585 int l1 = strlen(name);
586 int l2 = strlen(pattern);
588 strcmp(name+(l1-l2),pattern) == 0 &&
589 (l1==l2 || name[l1-(l2+1)] == '/')) {
598 static void report_filter_result(char const *name,
599 struct filter_struct const *ent,
600 int name_is_dir, const char *type)
602 /* If a trailing slash is present to match only directories,
603 * then it is stripped out by add_rule(). So as a special
604 * case we add it back in here. */
607 static char *actions[2][2]
608 = { {"show", "hid"}, {"risk", "protect"} };
609 const char *w = who_am_i();
610 rprintf(FINFO, "[%s] %sing %s %s because of pattern %s%s%s\n",
611 w, actions[*w!='s'][!(ent->match_flags&MATCHFLG_INCLUDE)],
612 name_is_dir ? "directory" : "file", name, ent->pattern,
613 ent->match_flags & MATCHFLG_DIRECTORY ? "/" : "", type);
619 * Return -1 if file "name" is defined to be excluded by the specified
620 * exclude list, 1 if it is included, and 0 if it was not matched.
622 int check_filter(struct filter_list_struct *listp, char *name, int name_is_dir)
624 struct filter_struct *ent;
626 for (ent = listp->head; ent; ent = ent->next) {
627 if (ignore_perishable && ent->match_flags & MATCHFLG_PERISHABLE)
629 if (ent->match_flags & MATCHFLG_PERDIR_MERGE) {
630 int rc = check_filter(ent->u.mergelist, name,
636 if (ent->match_flags & MATCHFLG_CVS_IGNORE) {
637 int rc = check_filter(&cvs_filter_list, name,
643 if (rule_matches(name, ent, name_is_dir)) {
644 report_filter_result(name, ent, name_is_dir,
646 return ent->match_flags & MATCHFLG_INCLUDE ? 1 : -1;
653 #define RULE_STRCMP(s,r) rule_strcmp((s), (r), sizeof (r) - 1)
655 static const uchar *rule_strcmp(const uchar *str, const char *rule, int rule_len)
657 if (strncmp((char*)str, rule, rule_len) != 0)
659 if (isspace(str[rule_len]) || str[rule_len] == '_' || !str[rule_len])
660 return str + rule_len - 1;
661 if (str[rule_len] == ',')
662 return str + rule_len;
666 /* Get the next include/exclude arg from the string. The token will not
667 * be '\0' terminated, so use the returned length to limit the string.
668 * Also, be sure to add this length to the returned pointer before passing
669 * it back to ask for the next token. This routine parses the "!" (list-
670 * clearing) token and (depending on the mflags) the various prefixes.
671 * The *mflags_ptr value will be set on exit to the new MATCHFLG_* bits
672 * for the current token. */
673 static const char *parse_rule_tok(const char *p, uint32 mflags, int xflags,
674 unsigned int *len_ptr, uint32 *mflags_ptr)
676 const uchar *s = (const uchar *)p;
680 if (mflags & MATCHFLG_WORD_SPLIT) {
681 /* Skip over any initial whitespace. */
684 /* Update to point to real start of rule. */
690 new_mflags = mflags & MATCHFLGS_FROM_CONTAINER;
692 /* Figure out what kind of a filter rule "s" is pointing at. Note
693 * that if MATCHFLG_NO_PREFIXES is set, the rule is either an include
694 * or an exclude based on the inheritance of the MATCHFLG_INCLUDE
695 * flag (above). XFLG_OLD_PREFIXES indicates a compatibility mode
696 * for old include/exclude patterns where just "+ " and "- " are
697 * allowed as optional prefixes. */
698 if (mflags & MATCHFLG_NO_PREFIXES) {
699 if (*s == '!' && mflags & MATCHFLG_CVS_IGNORE)
700 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
701 } else if (xflags & XFLG_OLD_PREFIXES) {
702 if (*s == '-' && s[1] == ' ') {
703 new_mflags &= ~MATCHFLG_INCLUDE;
705 } else if (*s == '+' && s[1] == ' ') {
706 new_mflags |= MATCHFLG_INCLUDE;
708 } else if (*s == '!')
709 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
711 char ch = 0, *mods = "";
714 if ((s = RULE_STRCMP(s, "clear")) != NULL)
718 if ((s = RULE_STRCMP(s, "dir-merge")) != NULL)
722 if ((s = RULE_STRCMP(s, "exclude")) != NULL)
726 if ((s = RULE_STRCMP(s, "hide")) != NULL)
730 if ((s = RULE_STRCMP(s, "include")) != NULL)
734 if ((s = RULE_STRCMP(s, "merge")) != NULL)
738 if ((s = RULE_STRCMP(s, "protect")) != NULL)
742 if ((s = RULE_STRCMP(s, "risk")) != NULL)
746 if ((s = RULE_STRCMP(s, "show")) != NULL)
757 new_mflags |= MATCHFLG_PERDIR_MERGE
758 | MATCHFLG_FINISH_SETUP;
761 new_mflags |= MATCHFLG_MERGE_FILE;
762 mods = MODIFIERS_INCL_EXCL MODIFIERS_MERGE_FILE;
765 new_mflags |= MATCHFLG_INCLUDE;
768 mods = MODIFIERS_INCL_EXCL;
771 new_mflags |= MATCHFLG_INCLUDE;
774 new_mflags |= MATCHFLG_SENDER_SIDE;
775 mods = MODIFIERS_HIDE_PROTECT;
778 new_mflags |= MATCHFLG_INCLUDE;
781 new_mflags |= MATCHFLG_RECEIVER_SIDE;
782 mods = MODIFIERS_HIDE_PROTECT;
785 new_mflags |= MATCHFLG_CLEAR_LIST;
789 rprintf(FERROR, "Unknown filter rule: `%s'\n", p);
790 exit_cleanup(RERR_SYNTAX);
792 while (mods && *++s && *s != ' ' && *s != '_') {
793 if (strchr(mods, *s) == NULL) {
794 if (mflags & MATCHFLG_WORD_SPLIT && isspace(*s)) {
800 "invalid modifier sequence at '%c' in filter rule: %s\n",
802 exit_cleanup(RERR_SYNTAX);
806 if (new_mflags & MATCHFLG_NO_PREFIXES)
808 new_mflags |= MATCHFLG_NO_PREFIXES;
811 if (new_mflags & MATCHFLG_NO_PREFIXES)
813 new_mflags |= MATCHFLG_NO_PREFIXES
817 new_mflags |= MATCHFLG_ABS_PATH;
820 new_mflags |= MATCHFLG_NEGATE;
823 if (new_mflags & MATCHFLG_NO_PREFIXES)
825 new_mflags |= MATCHFLG_NO_PREFIXES
826 | MATCHFLG_WORD_SPLIT
827 | MATCHFLG_NO_INHERIT
828 | MATCHFLG_CVS_IGNORE;
831 new_mflags |= MATCHFLG_EXCLUDE_SELF;
834 new_mflags |= MATCHFLG_NO_INHERIT;
837 new_mflags |= MATCHFLG_PERISHABLE;
840 new_mflags |= MATCHFLG_RECEIVER_SIDE;
843 new_mflags |= MATCHFLG_SENDER_SIDE;
846 new_mflags |= MATCHFLG_WORD_SPLIT;
854 if (mflags & MATCHFLG_WORD_SPLIT) {
856 /* Token ends at whitespace or the end of the string. */
857 while (!isspace(*cp) && *cp != '\0')
861 len = strlen((char*)s);
863 if (new_mflags & MATCHFLG_CLEAR_LIST) {
864 if (!(mflags & MATCHFLG_NO_PREFIXES)
865 && !(xflags & XFLG_OLD_PREFIXES) && len) {
867 "'!' rule has trailing characters: %s\n", p);
868 exit_cleanup(RERR_SYNTAX);
871 new_mflags &= ~MATCHFLG_CLEAR_LIST;
872 } else if (!len && !(new_mflags & MATCHFLG_CVS_IGNORE)) {
873 rprintf(FERROR, "unexpected end of filter rule: %s\n", p);
874 exit_cleanup(RERR_SYNTAX);
877 /* --delete-excluded turns an un-modified include/exclude into a
878 * sender-side rule. We also affect per-dir merge files that take
879 * no prefixes as a simple optimization. */
881 && !(new_mflags & (MATCHFLG_RECEIVER_SIDE|MATCHFLG_SENDER_SIDE))
882 && (!(new_mflags & MATCHFLG_PERDIR_MERGE)
883 || new_mflags & MATCHFLG_NO_PREFIXES))
884 new_mflags |= MATCHFLG_SENDER_SIDE;
887 *mflags_ptr = new_mflags;
888 return (const char *)s;
892 static char default_cvsignore[] =
893 /* These default ignored items come from the CVS manual. */
894 "RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS"
895 " .make.state .nse_depinfo *~ #* .#* ,* _$* *$"
896 " *.old *.bak *.BAK *.orig *.rej .del-*"
897 " *.a *.olb *.o *.obj *.so *.exe"
898 " *.Z *.elc *.ln core"
899 /* The rest we added to suit ourself. */
902 static void get_cvs_excludes(uint32 mflags)
904 static int initialized = 0;
905 char *p, fname[MAXPATHLEN];
911 parse_rule(&cvs_filter_list, default_cvsignore,
912 mflags | (protocol_version >= 30 ? MATCHFLG_PERISHABLE : 0),
915 p = module_id >= 0 && lp_use_chroot(module_id) ? "/" : getenv("HOME");
916 if (p && pathjoin(fname, MAXPATHLEN, p, ".cvsignore") < MAXPATHLEN)
917 parse_filter_file(&cvs_filter_list, fname, mflags, 0);
919 parse_rule(&cvs_filter_list, getenv("CVSIGNORE"), mflags, 0);
923 void parse_rule(struct filter_list_struct *listp, const char *pattern,
924 uint32 mflags, int xflags)
926 unsigned int pat_len;
934 /* Remember that the returned string is NOT '\0' terminated! */
935 cp = parse_rule_tok(pattern, mflags, xflags,
936 &pat_len, &new_mflags);
940 pattern = cp + pat_len;
942 if (pat_len >= MAXPATHLEN) {
943 rprintf(FERROR, "discarding over-long filter: %.*s\n",
948 if (new_mflags & MATCHFLG_CLEAR_LIST) {
951 "[%s] clearing filter list%s\n",
952 who_am_i(), listp->debug_type);
954 clear_filter_list(listp);
958 if (new_mflags & MATCHFLG_MERGE_FILE) {
965 if (new_mflags & MATCHFLG_EXCLUDE_SELF) {
966 const char *name = cp + len;
967 while (name > cp && name[-1] != '/') name--;
969 add_rule(listp, name, len, 0, 0);
970 new_mflags &= ~MATCHFLG_EXCLUDE_SELF;
973 if (new_mflags & MATCHFLG_PERDIR_MERGE) {
974 if (parent_dirscan) {
975 if (!(p = parse_merge_name(cp, &len,
978 add_rule(listp, p, len, new_mflags, 0);
982 if (!(p = parse_merge_name(cp, &len, 0)))
984 parse_filter_file(listp, p, new_mflags,
990 add_rule(listp, cp, pat_len, new_mflags, xflags);
992 if (new_mflags & MATCHFLG_CVS_IGNORE
993 && !(new_mflags & MATCHFLG_MERGE_FILE))
994 get_cvs_excludes(new_mflags);
999 void parse_filter_file(struct filter_list_struct *listp, const char *fname,
1000 uint32 mflags, int xflags)
1003 char line[BIGPATHBUFLEN];
1004 char *eob = line + sizeof line - 1;
1005 int word_split = mflags & MATCHFLG_WORD_SPLIT;
1007 if (!fname || !*fname)
1010 if (*fname != '-' || fname[1] || am_server) {
1011 if (server_filter_list.head) {
1012 strlcpy(line, fname, sizeof line);
1013 clean_fname(line, 1);
1014 if (check_filter(&server_filter_list, line, 0) < 0)
1017 fp = fopen(line, "rb");
1019 fp = fopen(fname, "rb");
1024 rprintf(FINFO, "[%s] parse_filter_file(%s,%x,%x)%s\n",
1025 who_am_i(), fname, mflags, xflags,
1026 fp ? "" : " [not found]");
1030 if (xflags & XFLG_FATAL_ERRORS) {
1031 rsyserr(FERROR, errno,
1032 "failed to open %sclude file %s",
1033 mflags & MATCHFLG_INCLUDE ? "in" : "ex",
1035 exit_cleanup(RERR_FILEIO);
1039 dirbuf[dirbuf_len] = '\0';
1043 int ch, overflow = 0;
1045 if ((ch = getc(fp)) == EOF) {
1046 if (ferror(fp) && errno == EINTR) {
1052 if (word_split && isspace(ch))
1054 if (eol_nulls? !ch : (ch == '\n' || ch == '\r'))
1062 rprintf(FERROR, "discarding over-long filter: %s...\n", line);
1066 /* Skip an empty token and (when line parsing) comments. */
1067 if (*line && (word_split || (*line != ';' && *line != '#')))
1068 parse_rule(listp, line, mflags, xflags);
1075 /* If the "for_xfer" flag is set, the prefix is made compatible with the
1076 * current protocol_version (if possible) or a NULL is returned (if not
1078 char *get_rule_prefix(int match_flags, const char *pat, int for_xfer,
1079 unsigned int *plen_ptr)
1081 static char buf[MAX_RULE_PREFIX+1];
1083 int legal_len = for_xfer && protocol_version < 29 ? 1 : MAX_RULE_PREFIX-1;
1085 if (match_flags & MATCHFLG_PERDIR_MERGE) {
1089 } else if (match_flags & MATCHFLG_INCLUDE)
1091 else if (legal_len != 1
1092 || ((*pat == '-' || *pat == '+') && pat[1] == ' '))
1097 if (match_flags & MATCHFLG_NEGATE)
1099 if (match_flags & MATCHFLG_CVS_IGNORE)
1102 if (match_flags & MATCHFLG_NO_INHERIT)
1104 if (match_flags & MATCHFLG_WORD_SPLIT)
1106 if (match_flags & MATCHFLG_NO_PREFIXES) {
1107 if (match_flags & MATCHFLG_INCLUDE)
1113 if (match_flags & MATCHFLG_EXCLUDE_SELF)
1115 if (match_flags & MATCHFLG_SENDER_SIDE
1116 && (!for_xfer || protocol_version >= 29))
1118 if (match_flags & MATCHFLG_RECEIVER_SIDE
1119 && (!for_xfer || protocol_version >= 29
1120 || (delete_excluded && am_sender)))
1122 if (match_flags & MATCHFLG_PERISHABLE) {
1123 if (!for_xfer || protocol_version >= 30)
1128 if (op - buf > legal_len)
1134 *plen_ptr = op - buf;
1138 static void send_rules(int f_out, struct filter_list_struct *flp)
1140 struct filter_struct *ent, *prev = NULL;
1142 for (ent = flp->head; ent; ent = ent->next) {
1143 unsigned int len, plen, dlen;
1147 /* Note we need to check delete_excluded here in addition to
1148 * the code in parse_rule_tok() because some rules may have
1149 * been added before we found the --delete-excluded option.
1150 * We must also elide any CVS merge-file rules to avoid a
1151 * backward compatibility problem, and we elide any no-prefix
1152 * merge files as an optimization (since they can only have
1153 * include/exclude rules). */
1154 if (ent->match_flags & MATCHFLG_SENDER_SIDE)
1155 elide = am_sender ? 1 : -1;
1156 if (ent->match_flags & MATCHFLG_RECEIVER_SIDE)
1157 elide = elide ? 0 : am_sender ? -1 : 1;
1158 else if (delete_excluded && !elide
1159 && (!(ent->match_flags & MATCHFLG_PERDIR_MERGE)
1160 || ent->match_flags & MATCHFLG_NO_PREFIXES))
1161 elide = am_sender ? 1 : -1;
1164 prev->next = ent->next;
1166 flp->head = ent->next;
1171 if (ent->match_flags & MATCHFLG_CVS_IGNORE
1172 && !(ent->match_flags & MATCHFLG_MERGE_FILE)) {
1173 int f = am_sender || protocol_version < 29 ? f_out : -2;
1174 send_rules(f, &cvs_filter_list);
1178 p = get_rule_prefix(ent->match_flags, ent->pattern, 1, &plen);
1181 "filter rules are too modern for remote rsync.\n");
1182 exit_cleanup(RERR_PROTOCOL);
1186 len = strlen(ent->pattern);
1187 dlen = ent->match_flags & MATCHFLG_DIRECTORY ? 1 : 0;
1188 if (!(plen + len + dlen))
1190 write_int(f_out, plen + len + dlen);
1192 write_buf(f_out, p, plen);
1193 write_buf(f_out, ent->pattern, len);
1195 write_byte(f_out, '/');
1200 /* This is only called by the client. */
1201 void send_filter_list(int f_out)
1203 int receiver_wants_list = prune_empty_dirs
1204 || (delete_mode && (!delete_excluded || protocol_version >= 29));
1206 if (local_server || (am_sender && !receiver_wants_list))
1208 if (cvs_exclude && am_sender) {
1209 if (protocol_version >= 29)
1210 parse_rule(&filter_list, ":C", 0, 0);
1211 parse_rule(&filter_list, "-C", 0, 0);
1214 /* This is a complete hack - blame Rusty. FIXME!
1215 * Remove this hack when older rsyncs (below 2.6.4) are gone. */
1216 if (list_only == 1 && !recurse)
1217 parse_rule(&filter_list, "/*/*", MATCHFLG_NO_PREFIXES, 0);
1219 send_rules(f_out, &filter_list);
1222 write_int(f_out, 0);
1225 if (!am_sender || protocol_version < 29)
1226 parse_rule(&filter_list, ":C", 0, 0);
1228 parse_rule(&filter_list, "-C", 0, 0);
1232 /* This is only called by the server. */
1233 void recv_filter_list(int f_in)
1235 char line[BIGPATHBUFLEN];
1236 int xflags = protocol_version >= 29 ? 0 : XFLG_OLD_PREFIXES;
1237 int receiver_wants_list = prune_empty_dirs
1239 && (!delete_excluded || protocol_version >= 29));
1242 if (!local_server && (am_sender || receiver_wants_list)) {
1243 while ((len = read_int(f_in)) != 0) {
1244 if (len >= sizeof line)
1245 overflow_exit("recv_rules");
1246 read_sbuf(f_in, line, len);
1247 parse_rule(&filter_list, line, 0, xflags);
1252 if (local_server || am_sender || protocol_version < 29)
1253 parse_rule(&filter_list, ":C", 0, 0);
1254 if (local_server || am_sender)
1255 parse_rule(&filter_list, "-C", 0, 0);
1258 if (local_server) /* filter out any rules that aren't for us. */
1259 send_rules(-1, &filter_list);