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-2009 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.
30 extern int local_server
;
31 extern int prune_empty_dirs
;
32 extern int ignore_perishable
;
33 extern int delete_mode
;
34 extern int delete_excluded
;
35 extern int cvs_exclude
;
36 extern int sanitize_paths
;
37 extern int protocol_version
;
40 extern char curr_dir
[MAXPATHLEN
];
41 extern unsigned int curr_dir_len
;
42 extern unsigned int module_dirlen
;
44 struct filter_list_struct filter_list
= { 0, 0, "" };
45 struct filter_list_struct cvs_filter_list
= { 0, 0, " [global CVS]" };
46 struct filter_list_struct daemon_filter_list
= { 0, 0, " [daemon]" };
48 /* Need room enough for ":MODS " prefix plus some room to grow. */
49 #define MAX_RULE_PREFIX (16)
51 #define MODIFIERS_MERGE_FILE "-+Cenw"
52 #define MODIFIERS_INCL_EXCL "/!Crsp"
53 #define MODIFIERS_HIDE_PROTECT "/!p"
55 #define SLASH_WILD3_SUFFIX "/***"
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
;
124 unsigned int pre_len
, suf_len
, slash_cnt
= 0;
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 (pat_len
> 1 && pat
[pat_len
-1] == '/') {
152 mflags
|= MATCHFLG_DIRECTORY
;
155 for (cp
= pat
; cp
< pat
+ pat_len
; cp
++) {
160 if (!(mflags
& (MATCHFLG_ABS_PATH
| MATCHFLG_MERGE_FILE
))
161 && ((xflags
& (XFLG_ANCHORED2ABS
|XFLG_ABS_IF_SLASH
) && *pat
== '/')
162 || (xflags
& XFLG_ABS_IF_SLASH
&& slash_cnt
))) {
163 mflags
|= MATCHFLG_ABS_PATH
;
165 pre_len
= dirbuf_len
- module_dirlen
- 1;
171 /* The daemon wants dir-exclude rules to get an appended "/" + "***". */
172 if (xflags
& XFLG_DIR2WILD3
173 && BITS_SETnUNSET(mflags
, MATCHFLG_DIRECTORY
, MATCHFLG_INCLUDE
)) {
174 mflags
&= ~MATCHFLG_DIRECTORY
;
175 suf_len
= sizeof SLASH_WILD3_SUFFIX
- 1;
179 if (!(ret
->pattern
= new_array(char, pre_len
+ pat_len
+ suf_len
+ 1)))
180 out_of_memory("add_rule");
182 memcpy(ret
->pattern
, dirbuf
+ module_dirlen
, pre_len
);
183 for (cp
= ret
->pattern
; cp
< ret
->pattern
+ pre_len
; cp
++) {
188 strlcpy(ret
->pattern
+ pre_len
, pat
, pat_len
+ 1);
191 memcpy(ret
->pattern
+ pat_len
, SLASH_WILD3_SUFFIX
, suf_len
+1);
196 if (strpbrk(ret
->pattern
, "*[?")) {
197 mflags
|= MATCHFLG_WILD
;
198 if ((cp
= strstr(ret
->pattern
, "**")) != NULL
) {
199 mflags
|= MATCHFLG_WILD2
;
200 /* If the pattern starts with **, note that. */
201 if (cp
== ret
->pattern
)
202 mflags
|= MATCHFLG_WILD2_PREFIX
;
203 /* If the pattern ends with ***, note that. */
205 && ret
->pattern
[pat_len
-3] == '*'
206 && ret
->pattern
[pat_len
-2] == '*'
207 && ret
->pattern
[pat_len
-1] == '*')
208 mflags
|= MATCHFLG_WILD3_SUFFIX
;
212 if (mflags
& MATCHFLG_PERDIR_MERGE
) {
213 struct filter_list_struct
*lp
;
217 if ((cp
= strrchr(ret
->pattern
, '/')) != NULL
)
222 /* If the local merge file was already mentioned, don't
224 for (i
= 0; i
< mergelist_cnt
; i
++) {
225 struct filter_struct
*ex
= mergelist_parents
[i
];
226 const char *s
= strrchr(ex
->pattern
, '/');
232 if (len
== pat_len
- (cp
- ret
->pattern
)
233 && memcmp(s
, cp
, len
) == 0) {
239 if (!(lp
= new_array(struct filter_list_struct
, 1)))
240 out_of_memory("add_rule");
241 lp
->head
= lp
->tail
= NULL
;
242 if (asprintf(&lp
->debug_type
, " [per-dir %s]", cp
) < 0)
243 out_of_memory("add_rule");
244 ret
->u
.mergelist
= lp
;
246 if (mergelist_cnt
== mergelist_size
) {
248 mergelist_parents
= realloc_array(mergelist_parents
,
249 struct filter_struct
*,
251 if (!mergelist_parents
)
252 out_of_memory("add_rule");
254 mergelist_parents
[mergelist_cnt
++] = ret
;
256 ret
->u
.slash_cnt
= slash_cnt
;
258 ret
->match_flags
= mflags
;
261 ret
->next
= listp
->head
;
262 listp
->head
= listp
->tail
= ret
;
264 ret
->next
= listp
->tail
->next
;
265 listp
->tail
->next
= ret
;
270 static void clear_filter_list(struct filter_list_struct
*listp
)
273 struct filter_struct
*ent
, *next
;
274 /* Truncate any inherited items from the local list. */
275 listp
->tail
->next
= NULL
;
276 /* Now free everything that is left. */
277 for (ent
= listp
->head
; ent
; ent
= next
) {
283 listp
->head
= listp
->tail
= NULL
;
286 /* This returns an expanded (absolute) filename for the merge-file name if
287 * the name has any slashes in it OR if the parent_dirscan var is True;
288 * otherwise it returns the original merge_file name. If the len_ptr value
289 * is non-NULL the merge_file name is limited by the referenced length
290 * value and will be updated with the length of the resulting name. We
291 * always return a name that is null terminated, even if the merge_file
293 static char *parse_merge_name(const char *merge_file
, unsigned int *len_ptr
,
294 unsigned int prefix_skip
)
296 static char buf
[MAXPATHLEN
];
297 char *fn
, tmpbuf
[MAXPATHLEN
];
300 if (!parent_dirscan
&& *merge_file
!= '/') {
301 /* Return the name unchanged it doesn't have any slashes. */
303 const char *p
= merge_file
+ *len_ptr
;
304 while (--p
> merge_file
&& *p
!= '/') {}
305 if (p
== merge_file
) {
306 strlcpy(buf
, merge_file
, *len_ptr
+ 1);
309 } else if (strchr(merge_file
, '/') == NULL
)
310 return (char *)merge_file
;
313 fn
= *merge_file
== '/' ? buf
: tmpbuf
;
314 if (sanitize_paths
) {
315 const char *r
= prefix_skip
? "/" : NULL
;
316 /* null-terminate the name if it isn't already */
317 if (len_ptr
&& merge_file
[*len_ptr
]) {
318 char *to
= fn
== buf
? tmpbuf
: buf
;
319 strlcpy(to
, merge_file
, *len_ptr
+ 1);
322 if (!sanitize_path(fn
, merge_file
, r
, dirbuf_depth
, SP_DEFAULT
)) {
323 rprintf(FERROR
, "merge-file name overflows: %s\n",
329 strlcpy(fn
, merge_file
, len_ptr
? *len_ptr
+ 1 : MAXPATHLEN
);
330 fn_len
= clean_fname(fn
, CFN_COLLAPSE_DOT_DOT_DIRS
);
333 /* If the name isn't in buf yet, it's wasn't absolute. */
335 int d_len
= dirbuf_len
- prefix_skip
;
336 if (d_len
+ fn_len
>= MAXPATHLEN
) {
337 rprintf(FERROR
, "merge-file name overflows: %s\n", fn
);
340 memcpy(buf
, dirbuf
+ prefix_skip
, d_len
);
341 memcpy(buf
+ d_len
, fn
, fn_len
+ 1);
342 fn_len
= clean_fname(buf
, CFN_COLLAPSE_DOT_DOT_DIRS
);
350 /* Sets the dirbuf and dirbuf_len values. */
351 void set_filter_dir(const char *dir
, unsigned int dirlen
)
355 memcpy(dirbuf
, curr_dir
, curr_dir_len
);
356 dirbuf
[curr_dir_len
] = '/';
357 len
= curr_dir_len
+ 1;
358 if (len
+ dirlen
>= MAXPATHLEN
)
362 memcpy(dirbuf
+ len
, dir
, dirlen
);
363 dirbuf
[dirlen
+ len
] = '\0';
364 dirbuf_len
= clean_fname(dirbuf
, CFN_COLLAPSE_DOT_DOT_DIRS
);
365 if (dirbuf_len
> 1 && dirbuf
[dirbuf_len
-1] == '.'
366 && dirbuf
[dirbuf_len
-2] == '/')
369 dirbuf
[dirbuf_len
++] = '/';
370 dirbuf
[dirbuf_len
] = '\0';
372 dirbuf_depth
= count_dir_elements(dirbuf
+ module_dirlen
);
375 /* This routine takes a per-dir merge-file entry and finishes its setup.
376 * If the name has a path portion then we check to see if it refers to a
377 * parent directory of the first transfer dir. If it does, we scan all the
378 * dirs from that point through the parent dir of the transfer dir looking
379 * for the per-dir merge-file in each one. */
380 static BOOL
setup_merge_file(struct filter_struct
*ex
,
381 struct filter_list_struct
*lp
)
383 char buf
[MAXPATHLEN
];
384 char *x
, *y
, *pat
= ex
->pattern
;
387 if (!(x
= parse_merge_name(pat
, NULL
, 0)) || *x
!= '/')
392 ex
->pattern
= strdup(y
+1);
396 strlcpy(buf
, x
, MAXPATHLEN
);
398 pathjoin(buf
, MAXPATHLEN
, dirbuf
, x
);
400 len
= clean_fname(buf
, CFN_COLLAPSE_DOT_DOT_DIRS
);
401 if (len
!= 1 && len
< MAXPATHLEN
-1) {
405 /* This ensures that the specified dir is a parent of the transfer. */
406 for (x
= buf
, y
= dirbuf
; *x
&& *x
== *y
; x
++, y
++) {}
408 y
+= strlen(y
); /* nope -- skip the scan */
410 parent_dirscan
= True
;
412 char save
[MAXPATHLEN
];
413 strlcpy(save
, y
, MAXPATHLEN
);
415 dirbuf_len
= y
- dirbuf
;
416 strlcpy(x
, ex
->pattern
, MAXPATHLEN
- (x
- buf
));
417 parse_filter_file(lp
, buf
, ex
->match_flags
, XFLG_ANCHORED2ABS
);
418 if (ex
->match_flags
& MATCHFLG_NO_INHERIT
)
421 strlcpy(y
, save
, MAXPATHLEN
);
422 while ((*x
++ = *y
++) != '/') {}
424 parent_dirscan
= False
;
429 /* Each time rsync changes to a new directory it call this function to
430 * handle all the per-dir merge-files. The "dir" value is the current path
431 * relative to curr_dir (which might not be null-terminated). We copy it
432 * into dirbuf so that we can easily append a file name on the end. */
433 void *push_local_filters(const char *dir
, unsigned int dirlen
)
435 struct filter_list_struct
*ap
, *push
;
438 set_filter_dir(dir
, dirlen
);
443 push
= new_array(struct filter_list_struct
, mergelist_cnt
);
445 out_of_memory("push_local_filters");
447 for (i
= 0, ap
= push
; i
< mergelist_cnt
; i
++) {
448 memcpy(ap
++, mergelist_parents
[i
]->u
.mergelist
,
449 sizeof (struct filter_list_struct
));
452 /* Note: parse_filter_file() might increase mergelist_cnt, so keep
453 * this loop separate from the above loop. */
454 for (i
= 0; i
< mergelist_cnt
; i
++) {
455 struct filter_struct
*ex
= mergelist_parents
[i
];
456 struct filter_list_struct
*lp
= ex
->u
.mergelist
;
459 rprintf(FINFO
, "[%s] pushing filter list%s\n",
460 who_am_i(), lp
->debug_type
);
463 lp
->tail
= NULL
; /* Switch any local rules to inherited. */
464 if (ex
->match_flags
& MATCHFLG_NO_INHERIT
)
467 if (ex
->match_flags
& MATCHFLG_FINISH_SETUP
) {
468 ex
->match_flags
&= ~MATCHFLG_FINISH_SETUP
;
469 if (setup_merge_file(ex
, lp
))
470 set_filter_dir(dir
, dirlen
);
473 if (strlcpy(dirbuf
+ dirbuf_len
, ex
->pattern
,
474 MAXPATHLEN
- dirbuf_len
) < MAXPATHLEN
- dirbuf_len
) {
475 parse_filter_file(lp
, dirbuf
, ex
->match_flags
,
478 io_error
|= IOERR_GENERAL
;
480 "cannot add local filter rules in long-named directory: %s\n",
483 dirbuf
[dirbuf_len
] = '\0';
489 void pop_local_filters(void *mem
)
491 struct filter_list_struct
*ap
, *pop
= (struct filter_list_struct
*)mem
;
494 for (i
= mergelist_cnt
; i
-- > 0; ) {
495 struct filter_struct
*ex
= mergelist_parents
[i
];
496 struct filter_list_struct
*lp
= ex
->u
.mergelist
;
499 rprintf(FINFO
, "[%s] popping filter list%s\n",
500 who_am_i(), lp
->debug_type
);
503 clear_filter_list(lp
);
509 for (i
= 0, ap
= pop
; i
< mergelist_cnt
; i
++) {
510 memcpy(mergelist_parents
[i
]->u
.mergelist
, ap
++,
511 sizeof (struct filter_list_struct
));
517 void change_local_filter_dir(const char *dname
, int dlen
, int dir_depth
)
519 static int cur_depth
= -1;
520 static void *filt_array
[MAXPATHLEN
/2+1];
523 for ( ; cur_depth
>= 0; cur_depth
--) {
524 if (filt_array
[cur_depth
]) {
525 pop_local_filters(filt_array
[cur_depth
]);
526 filt_array
[cur_depth
] = NULL
;
532 assert(dir_depth
< MAXPATHLEN
/2+1);
534 for ( ; cur_depth
>= dir_depth
; cur_depth
--) {
535 if (filt_array
[cur_depth
]) {
536 pop_local_filters(filt_array
[cur_depth
]);
537 filt_array
[cur_depth
] = NULL
;
541 cur_depth
= dir_depth
;
542 filt_array
[cur_depth
] = push_local_filters(dname
, dlen
);
545 static int rule_matches(const char *fname
, struct filter_struct
*ex
, int name_is_dir
)
547 int slash_handling
, str_cnt
= 0, anchored_match
= 0;
548 int ret_match
= ex
->match_flags
& MATCHFLG_NEGATE
? 0 : 1;
549 char *p
, *pattern
= ex
->pattern
;
550 const char *strings
[16]; /* more than enough */
551 const char *name
= fname
+ (*fname
== '/');
556 if (!ex
->u
.slash_cnt
&& !(ex
->match_flags
& MATCHFLG_WILD2
)) {
557 /* If the pattern does not have any slashes AND it does
558 * not have a "**" (which could match a slash), then we
559 * just match the name portion of the path. */
560 if ((p
= strrchr(name
,'/')) != NULL
)
562 } else if (ex
->match_flags
& MATCHFLG_ABS_PATH
&& *fname
!= '/'
563 && curr_dir_len
> module_dirlen
+ 1) {
564 /* If we're matching against an absolute-path pattern,
565 * we need to prepend our full path info. */
566 strings
[str_cnt
++] = curr_dir
+ module_dirlen
+ 1;
567 strings
[str_cnt
++] = "/";
568 } else if (ex
->match_flags
& MATCHFLG_WILD2_PREFIX
&& *fname
!= '/') {
569 /* Allow "**"+"/" to match at the start of the string. */
570 strings
[str_cnt
++] = "/";
572 strings
[str_cnt
++] = name
;
574 /* Allow a trailing "/"+"***" to match the directory. */
575 if (ex
->match_flags
& MATCHFLG_WILD3_SUFFIX
)
576 strings
[str_cnt
++] = "/";
577 } else if (ex
->match_flags
& MATCHFLG_DIRECTORY
)
579 strings
[str_cnt
] = NULL
;
581 if (*pattern
== '/') {
586 if (!anchored_match
&& ex
->u
.slash_cnt
587 && !(ex
->match_flags
& MATCHFLG_WILD2
)) {
588 /* A non-anchored match with an infix slash and no "**"
589 * needs to match the last slash_cnt+1 name elements. */
590 slash_handling
= ex
->u
.slash_cnt
+ 1;
591 } else if (!anchored_match
&& !(ex
->match_flags
& MATCHFLG_WILD2_PREFIX
)
592 && ex
->match_flags
& MATCHFLG_WILD2
) {
593 /* A non-anchored match with an infix or trailing "**" (but not
594 * a prefixed "**") needs to try matching after every slash. */
597 /* The pattern matches only at the start of the path or name. */
601 if (ex
->match_flags
& MATCHFLG_WILD
) {
602 if (wildmatch_array(pattern
, strings
, slash_handling
))
604 } else if (str_cnt
> 1) {
605 if (litmatch_array(pattern
, strings
, slash_handling
))
607 } else if (anchored_match
) {
608 if (strcmp(name
, pattern
) == 0)
611 int l1
= strlen(name
);
612 int l2
= strlen(pattern
);
614 strcmp(name
+(l1
-l2
),pattern
) == 0 &&
615 (l1
==l2
|| name
[l1
-(l2
+1)] == '/')) {
624 static void report_filter_result(enum logcode code
, char const *name
,
625 struct filter_struct
const *ent
,
626 int name_is_dir
, const char *type
)
628 /* If a trailing slash is present to match only directories,
629 * then it is stripped out by add_rule(). So as a special
630 * case we add it back in here. */
633 static char *actions
[2][2]
634 = { {"show", "hid"}, {"risk", "protect"} };
635 const char *w
= who_am_i();
636 rprintf(code
, "[%s] %sing %s %s because of pattern %s%s%s\n",
637 w
, actions
[*w
!='s'][!(ent
->match_flags
&MATCHFLG_INCLUDE
)],
638 name_is_dir
? "directory" : "file", name
, ent
->pattern
,
639 ent
->match_flags
& MATCHFLG_DIRECTORY
? "/" : "", type
);
645 * Return -1 if file "name" is defined to be excluded by the specified
646 * exclude list, 1 if it is included, and 0 if it was not matched.
648 int check_filter(struct filter_list_struct
*listp
, enum logcode code
,
649 const char *name
, int name_is_dir
)
651 struct filter_struct
*ent
;
653 for (ent
= listp
->head
; ent
; ent
= ent
->next
) {
654 if (ignore_perishable
&& ent
->match_flags
& MATCHFLG_PERISHABLE
)
656 if (ent
->match_flags
& MATCHFLG_PERDIR_MERGE
) {
657 int rc
= check_filter(ent
->u
.mergelist
, code
, name
,
663 if (ent
->match_flags
& MATCHFLG_CVS_IGNORE
) {
664 int rc
= check_filter(&cvs_filter_list
, code
, name
,
670 if (rule_matches(name
, ent
, name_is_dir
)) {
671 report_filter_result(code
, name
, ent
, name_is_dir
,
673 return ent
->match_flags
& MATCHFLG_INCLUDE
? 1 : -1;
680 #define RULE_STRCMP(s,r) rule_strcmp((s), (r), sizeof (r) - 1)
682 static const uchar
*rule_strcmp(const uchar
*str
, const char *rule
, int rule_len
)
684 if (strncmp((char*)str
, rule
, rule_len
) != 0)
686 if (isspace(str
[rule_len
]) || str
[rule_len
] == '_' || !str
[rule_len
])
687 return str
+ rule_len
- 1;
688 if (str
[rule_len
] == ',')
689 return str
+ rule_len
;
693 /* Get the next include/exclude arg from the string. The token will not
694 * be '\0' terminated, so use the returned length to limit the string.
695 * Also, be sure to add this length to the returned pointer before passing
696 * it back to ask for the next token. This routine parses the "!" (list-
697 * clearing) token and (depending on the mflags) the various prefixes.
698 * The *mflags_ptr value will be set on exit to the new MATCHFLG_* bits
699 * for the current token. */
700 static const char *parse_rule_tok(const char *p
, uint32 mflags
, int xflags
,
701 unsigned int *len_ptr
, uint32
*mflags_ptr
)
703 const uchar
*s
= (const uchar
*)p
;
707 if (mflags
& MATCHFLG_WORD_SPLIT
) {
708 /* Skip over any initial whitespace. */
711 /* Update to point to real start of rule. */
717 new_mflags
= mflags
& MATCHFLGS_FROM_CONTAINER
;
719 /* Figure out what kind of a filter rule "s" is pointing at. Note
720 * that if MATCHFLG_NO_PREFIXES is set, the rule is either an include
721 * or an exclude based on the inheritance of the MATCHFLG_INCLUDE
722 * flag (above). XFLG_OLD_PREFIXES indicates a compatibility mode
723 * for old include/exclude patterns where just "+ " and "- " are
724 * allowed as optional prefixes. */
725 if (mflags
& MATCHFLG_NO_PREFIXES
) {
726 if (*s
== '!' && mflags
& MATCHFLG_CVS_IGNORE
)
727 new_mflags
|= MATCHFLG_CLEAR_LIST
; /* Tentative! */
728 } else if (xflags
& XFLG_OLD_PREFIXES
) {
729 if (*s
== '-' && s
[1] == ' ') {
730 new_mflags
&= ~MATCHFLG_INCLUDE
;
732 } else if (*s
== '+' && s
[1] == ' ') {
733 new_mflags
|= MATCHFLG_INCLUDE
;
735 } else if (*s
== '!')
736 new_mflags
|= MATCHFLG_CLEAR_LIST
; /* Tentative! */
738 char ch
= 0, *mods
= "";
741 if ((s
= RULE_STRCMP(s
, "clear")) != NULL
)
745 if ((s
= RULE_STRCMP(s
, "dir-merge")) != NULL
)
749 if ((s
= RULE_STRCMP(s
, "exclude")) != NULL
)
753 if ((s
= RULE_STRCMP(s
, "hide")) != NULL
)
757 if ((s
= RULE_STRCMP(s
, "include")) != NULL
)
761 if ((s
= RULE_STRCMP(s
, "merge")) != NULL
)
765 if ((s
= RULE_STRCMP(s
, "protect")) != NULL
)
769 if ((s
= RULE_STRCMP(s
, "risk")) != NULL
)
773 if ((s
= RULE_STRCMP(s
, "show")) != NULL
)
784 new_mflags
|= MATCHFLG_PERDIR_MERGE
785 | MATCHFLG_FINISH_SETUP
;
788 new_mflags
|= MATCHFLG_MERGE_FILE
;
789 mods
= MODIFIERS_INCL_EXCL MODIFIERS_MERGE_FILE
;
792 new_mflags
|= MATCHFLG_INCLUDE
;
795 mods
= MODIFIERS_INCL_EXCL
;
798 new_mflags
|= MATCHFLG_INCLUDE
;
801 new_mflags
|= MATCHFLG_SENDER_SIDE
;
802 mods
= MODIFIERS_HIDE_PROTECT
;
805 new_mflags
|= MATCHFLG_INCLUDE
;
808 new_mflags
|= MATCHFLG_RECEIVER_SIDE
;
809 mods
= MODIFIERS_HIDE_PROTECT
;
812 new_mflags
|= MATCHFLG_CLEAR_LIST
;
816 rprintf(FERROR
, "Unknown filter rule: `%s'\n", p
);
817 exit_cleanup(RERR_SYNTAX
);
819 while (mods
&& *++s
&& *s
!= ' ' && *s
!= '_') {
820 if (strchr(mods
, *s
) == NULL
) {
821 if (mflags
& MATCHFLG_WORD_SPLIT
&& isspace(*s
)) {
827 "invalid modifier sequence at '%c' in filter rule: %s\n",
829 exit_cleanup(RERR_SYNTAX
);
833 if (new_mflags
& MATCHFLG_NO_PREFIXES
)
835 new_mflags
|= MATCHFLG_NO_PREFIXES
;
838 if (new_mflags
& MATCHFLG_NO_PREFIXES
)
840 new_mflags
|= MATCHFLG_NO_PREFIXES
844 new_mflags
|= MATCHFLG_ABS_PATH
;
847 new_mflags
|= MATCHFLG_NEGATE
;
850 if (new_mflags
& MATCHFLG_NO_PREFIXES
)
852 new_mflags
|= MATCHFLG_NO_PREFIXES
853 | MATCHFLG_WORD_SPLIT
854 | MATCHFLG_NO_INHERIT
855 | MATCHFLG_CVS_IGNORE
;
858 new_mflags
|= MATCHFLG_EXCLUDE_SELF
;
861 new_mflags
|= MATCHFLG_NO_INHERIT
;
864 new_mflags
|= MATCHFLG_PERISHABLE
;
867 new_mflags
|= MATCHFLG_RECEIVER_SIDE
;
870 new_mflags
|= MATCHFLG_SENDER_SIDE
;
873 new_mflags
|= MATCHFLG_WORD_SPLIT
;
881 if (mflags
& MATCHFLG_WORD_SPLIT
) {
883 /* Token ends at whitespace or the end of the string. */
884 while (!isspace(*cp
) && *cp
!= '\0')
888 len
= strlen((char*)s
);
890 if (new_mflags
& MATCHFLG_CLEAR_LIST
) {
891 if (!(mflags
& MATCHFLG_NO_PREFIXES
)
892 && !(xflags
& XFLG_OLD_PREFIXES
) && len
) {
894 "'!' rule has trailing characters: %s\n", p
);
895 exit_cleanup(RERR_SYNTAX
);
898 new_mflags
&= ~MATCHFLG_CLEAR_LIST
;
899 } else if (!len
&& !(new_mflags
& MATCHFLG_CVS_IGNORE
)) {
900 rprintf(FERROR
, "unexpected end of filter rule: %s\n", p
);
901 exit_cleanup(RERR_SYNTAX
);
904 /* --delete-excluded turns an un-modified include/exclude into a
905 * sender-side rule. We also affect per-dir merge files that take
906 * no prefixes as a simple optimization. */
908 && !(new_mflags
& (MATCHFLG_RECEIVER_SIDE
|MATCHFLG_SENDER_SIDE
))
909 && (!(new_mflags
& MATCHFLG_PERDIR_MERGE
)
910 || new_mflags
& MATCHFLG_NO_PREFIXES
))
911 new_mflags
|= MATCHFLG_SENDER_SIDE
;
914 *mflags_ptr
= new_mflags
;
915 return (const char *)s
;
919 static char default_cvsignore
[] =
920 /* These default ignored items come from the CVS manual. */
921 "RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS"
922 " .make.state .nse_depinfo *~ #* .#* ,* _$* *$"
923 " *.old *.bak *.BAK *.orig *.rej .del-*"
924 " *.a *.olb *.o *.obj *.so *.exe"
925 " *.Z *.elc *.ln core"
926 /* The rest we added to suit ourself. */
927 " .svn/ .git/ .hg/ .bzr/";
929 static void get_cvs_excludes(uint32 mflags
)
931 static int initialized
= 0;
932 char *p
, fname
[MAXPATHLEN
];
938 parse_rule(&cvs_filter_list
, default_cvsignore
,
939 mflags
| (protocol_version
>= 30 ? MATCHFLG_PERISHABLE
: 0),
942 p
= module_id
>= 0 && lp_use_chroot(module_id
) ? "/" : getenv("HOME");
943 if (p
&& pathjoin(fname
, MAXPATHLEN
, p
, ".cvsignore") < MAXPATHLEN
)
944 parse_filter_file(&cvs_filter_list
, fname
, mflags
, 0);
946 parse_rule(&cvs_filter_list
, getenv("CVSIGNORE"), mflags
, 0);
950 void parse_rule(struct filter_list_struct
*listp
, const char *pattern
,
951 uint32 mflags
, int xflags
)
953 unsigned int pat_len
;
961 /* Remember that the returned string is NOT '\0' terminated! */
962 cp
= parse_rule_tok(pattern
, mflags
, xflags
,
963 &pat_len
, &new_mflags
);
967 pattern
= cp
+ pat_len
;
969 if (pat_len
>= MAXPATHLEN
) {
970 rprintf(FERROR
, "discarding over-long filter: %.*s\n",
975 if (new_mflags
& MATCHFLG_CLEAR_LIST
) {
978 "[%s] clearing filter list%s\n",
979 who_am_i(), listp
->debug_type
);
981 clear_filter_list(listp
);
985 if (new_mflags
& MATCHFLG_MERGE_FILE
) {
992 if (new_mflags
& MATCHFLG_EXCLUDE_SELF
) {
993 const char *name
= cp
+ len
;
994 while (name
> cp
&& name
[-1] != '/') name
--;
996 add_rule(listp
, name
, len
, 0, 0);
997 new_mflags
&= ~MATCHFLG_EXCLUDE_SELF
;
1000 if (new_mflags
& MATCHFLG_PERDIR_MERGE
) {
1001 if (parent_dirscan
) {
1002 if (!(p
= parse_merge_name(cp
, &len
,
1005 add_rule(listp
, p
, len
, new_mflags
, 0);
1009 if (!(p
= parse_merge_name(cp
, &len
, 0)))
1011 parse_filter_file(listp
, p
, new_mflags
,
1017 add_rule(listp
, cp
, pat_len
, new_mflags
, xflags
);
1019 if (new_mflags
& MATCHFLG_CVS_IGNORE
1020 && !(new_mflags
& MATCHFLG_MERGE_FILE
))
1021 get_cvs_excludes(new_mflags
);
1026 void parse_filter_file(struct filter_list_struct
*listp
, const char *fname
,
1027 uint32 mflags
, int xflags
)
1030 char line
[BIGPATHBUFLEN
];
1031 char *eob
= line
+ sizeof line
- 1;
1032 int word_split
= mflags
& MATCHFLG_WORD_SPLIT
;
1034 if (!fname
|| !*fname
)
1037 if (*fname
!= '-' || fname
[1] || am_server
) {
1038 if (daemon_filter_list
.head
) {
1039 strlcpy(line
, fname
, sizeof line
);
1040 clean_fname(line
, CFN_COLLAPSE_DOT_DOT_DIRS
);
1041 if (check_filter(&daemon_filter_list
, FLOG
, line
, 0) < 0)
1044 fp
= fopen(line
, "rb");
1046 fp
= fopen(fname
, "rb");
1051 rprintf(FINFO
, "[%s] parse_filter_file(%s,%x,%x)%s\n",
1052 who_am_i(), fname
, mflags
, xflags
,
1053 fp
? "" : " [not found]");
1057 if (xflags
& XFLG_FATAL_ERRORS
) {
1058 rsyserr(FERROR
, errno
,
1059 "failed to open %sclude file %s",
1060 mflags
& MATCHFLG_INCLUDE
? "in" : "ex",
1062 exit_cleanup(RERR_FILEIO
);
1066 dirbuf
[dirbuf_len
] = '\0';
1070 int ch
, overflow
= 0;
1072 if ((ch
= getc(fp
)) == EOF
) {
1073 if (ferror(fp
) && errno
== EINTR
) {
1079 if (word_split
&& isspace(ch
))
1081 if (eol_nulls
? !ch
: (ch
== '\n' || ch
== '\r'))
1089 rprintf(FERROR
, "discarding over-long filter: %s...\n", line
);
1093 /* Skip an empty token and (when line parsing) comments. */
1094 if (*line
&& (word_split
|| (*line
!= ';' && *line
!= '#')))
1095 parse_rule(listp
, line
, mflags
, xflags
);
1102 /* If the "for_xfer" flag is set, the prefix is made compatible with the
1103 * current protocol_version (if possible) or a NULL is returned (if not
1105 char *get_rule_prefix(int match_flags
, const char *pat
, int for_xfer
,
1106 unsigned int *plen_ptr
)
1108 static char buf
[MAX_RULE_PREFIX
+1];
1110 int legal_len
= for_xfer
&& protocol_version
< 29 ? 1 : MAX_RULE_PREFIX
-1;
1112 if (match_flags
& MATCHFLG_PERDIR_MERGE
) {
1116 } else if (match_flags
& MATCHFLG_INCLUDE
)
1118 else if (legal_len
!= 1
1119 || ((*pat
== '-' || *pat
== '+') && pat
[1] == ' '))
1124 if (match_flags
& MATCHFLG_ABS_PATH
)
1126 if (match_flags
& MATCHFLG_NEGATE
)
1128 if (match_flags
& MATCHFLG_CVS_IGNORE
)
1131 if (match_flags
& MATCHFLG_NO_INHERIT
)
1133 if (match_flags
& MATCHFLG_WORD_SPLIT
)
1135 if (match_flags
& MATCHFLG_NO_PREFIXES
) {
1136 if (match_flags
& MATCHFLG_INCLUDE
)
1142 if (match_flags
& MATCHFLG_EXCLUDE_SELF
)
1144 if (match_flags
& MATCHFLG_SENDER_SIDE
1145 && (!for_xfer
|| protocol_version
>= 29))
1147 if (match_flags
& MATCHFLG_RECEIVER_SIDE
1148 && (!for_xfer
|| protocol_version
>= 29
1149 || (delete_excluded
&& am_sender
)))
1151 if (match_flags
& MATCHFLG_PERISHABLE
) {
1152 if (!for_xfer
|| protocol_version
>= 30)
1157 if (op
- buf
> legal_len
)
1163 *plen_ptr
= op
- buf
;
1167 static void send_rules(int f_out
, struct filter_list_struct
*flp
)
1169 struct filter_struct
*ent
, *prev
= NULL
;
1171 for (ent
= flp
->head
; ent
; ent
= ent
->next
) {
1172 unsigned int len
, plen
, dlen
;
1176 /* Note we need to check delete_excluded here in addition to
1177 * the code in parse_rule_tok() because some rules may have
1178 * been added before we found the --delete-excluded option.
1179 * We must also elide any CVS merge-file rules to avoid a
1180 * backward compatibility problem, and we elide any no-prefix
1181 * merge files as an optimization (since they can only have
1182 * include/exclude rules). */
1183 if (ent
->match_flags
& MATCHFLG_SENDER_SIDE
)
1184 elide
= am_sender
? 1 : -1;
1185 if (ent
->match_flags
& MATCHFLG_RECEIVER_SIDE
)
1186 elide
= elide
? 0 : am_sender
? -1 : 1;
1187 else if (delete_excluded
&& !elide
1188 && (!(ent
->match_flags
& MATCHFLG_PERDIR_MERGE
)
1189 || ent
->match_flags
& MATCHFLG_NO_PREFIXES
))
1190 elide
= am_sender
? 1 : -1;
1193 prev
->next
= ent
->next
;
1195 flp
->head
= ent
->next
;
1200 if (ent
->match_flags
& MATCHFLG_CVS_IGNORE
1201 && !(ent
->match_flags
& MATCHFLG_MERGE_FILE
)) {
1202 int f
= am_sender
|| protocol_version
< 29 ? f_out
: -2;
1203 send_rules(f
, &cvs_filter_list
);
1207 p
= get_rule_prefix(ent
->match_flags
, ent
->pattern
, 1, &plen
);
1210 "filter rules are too modern for remote rsync.\n");
1211 exit_cleanup(RERR_PROTOCOL
);
1215 len
= strlen(ent
->pattern
);
1216 dlen
= ent
->match_flags
& MATCHFLG_DIRECTORY
? 1 : 0;
1217 if (!(plen
+ len
+ dlen
))
1219 write_int(f_out
, plen
+ len
+ dlen
);
1221 write_buf(f_out
, p
, plen
);
1222 write_buf(f_out
, ent
->pattern
, len
);
1224 write_byte(f_out
, '/');
1229 /* This is only called by the client. */
1230 void send_filter_list(int f_out
)
1232 int receiver_wants_list
= prune_empty_dirs
1233 || (delete_mode
&& (!delete_excluded
|| protocol_version
>= 29));
1235 if (local_server
|| (am_sender
&& !receiver_wants_list
))
1237 if (cvs_exclude
&& am_sender
) {
1238 if (protocol_version
>= 29)
1239 parse_rule(&filter_list
, ":C", 0, 0);
1240 parse_rule(&filter_list
, "-C", 0, 0);
1243 send_rules(f_out
, &filter_list
);
1246 write_int(f_out
, 0);
1249 if (!am_sender
|| protocol_version
< 29)
1250 parse_rule(&filter_list
, ":C", 0, 0);
1252 parse_rule(&filter_list
, "-C", 0, 0);
1256 /* This is only called by the server. */
1257 void recv_filter_list(int f_in
)
1259 char line
[BIGPATHBUFLEN
];
1260 int xflags
= protocol_version
>= 29 ? 0 : XFLG_OLD_PREFIXES
;
1261 int receiver_wants_list
= prune_empty_dirs
1263 && (!delete_excluded
|| protocol_version
>= 29));
1266 if (!local_server
&& (am_sender
|| receiver_wants_list
)) {
1267 while ((len
= read_int(f_in
)) != 0) {
1268 if (len
>= sizeof line
)
1269 overflow_exit("recv_rules");
1270 read_sbuf(f_in
, line
, len
);
1271 parse_rule(&filter_list
, line
, 0, xflags
);
1276 if (local_server
|| am_sender
|| protocol_version
< 29)
1277 parse_rule(&filter_list
, ":C", 0, 0);
1278 if (local_server
|| am_sender
)
1279 parse_rule(&filter_list
, "-C", 0, 0);
1282 if (local_server
) /* filter out any rules that aren't for us. */
1283 send_rules(-1, &filter_list
);