Improved a couple sentences.
[rsync/rsync.git] / exclude.c
... / ...
CommitLineData
1/* -*- c-file-style: "linux" -*-
2 *
3 * Copyright (C) 1996-2001 by Andrew Tridgell <tridge@samba.org>
4 * Copyright (C) 1996 by Paul Mackerras
5 * Copyright (C) 2002 by Martin Pool
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22/* a lot of this stuff was originally derived from GNU tar, although
23 it has now changed so much that it is hard to tell :) */
24
25/* include/exclude cluestick added by Martin Pool <mbp@samba.org> */
26
27#include "rsync.h"
28
29extern int verbose;
30extern int am_server;
31extern int am_sender;
32extern int eol_nulls;
33extern int list_only;
34extern int recurse;
35extern int io_error;
36extern int local_server;
37extern int delete_mode;
38extern int delete_excluded;
39extern int cvs_exclude;
40extern int sanitize_paths;
41extern int protocol_version;
42extern int module_id;
43
44extern char curr_dir[];
45extern unsigned int curr_dir_len;
46extern unsigned int module_dirlen;
47
48struct filter_list_struct filter_list = { 0, 0, "" };
49struct filter_list_struct cvs_filter_list = { 0, 0, " [global CVS]" };
50struct filter_list_struct server_filter_list = { 0, 0, " [daemon]" };
51
52/* Need room enough for ":MODS " prefix plus some room to grow. */
53#define MAX_RULE_PREFIX (16)
54
55#define MODIFIERS_MERGE_FILE "-+Cenw"
56#define MODIFIERS_INCL_EXCL "/!Crs"
57#define MODIFIERS_HIDE_PROTECT "/!"
58
59/* The dirbuf is set by push_local_filters() to the current subdirectory
60 * relative to curr_dir that is being processed. The path always has a
61 * trailing slash appended, and the variable dirbuf_len contains the length
62 * of this path prefix. The path is always absolute. */
63static char dirbuf[MAXPATHLEN+1];
64static unsigned int dirbuf_len = 0;
65static int dirbuf_depth;
66
67/* This is True when we're scanning parent dirs for per-dir merge-files. */
68static BOOL parent_dirscan = False;
69
70/* This array contains a list of all the currently active per-dir merge
71 * files. This makes it easier to save the appropriate values when we
72 * "push" down into each subdirectory. */
73static struct filter_struct **mergelist_parents;
74static int mergelist_cnt = 0;
75static int mergelist_size = 0;
76
77/* Each filter_list_struct describes a singly-linked list by keeping track
78 * of both the head and tail pointers. The list is slightly unusual in that
79 * a parent-dir's content can be appended to the end of the local list in a
80 * special way: the last item in the local list has its "next" pointer set
81 * to point to the inherited list, but the local list's tail pointer points
82 * at the end of the local list. Thus, if the local list is empty, the head
83 * will be pointing at the inherited content but the tail will be NULL. To
84 * help you visualize this, here are the possible list arrangements:
85 *
86 * Completely Empty Local Content Only
87 * ================================== ====================================
88 * head -> NULL head -> Local1 -> Local2 -> NULL
89 * tail -> NULL tail -------------^
90 *
91 * Inherited Content Only Both Local and Inherited Content
92 * ================================== ====================================
93 * head -> Parent1 -> Parent2 -> NULL head -> L1 -> L2 -> P1 -> P2 -> NULL
94 * tail -> NULL tail ---------^
95 *
96 * This means that anyone wanting to traverse the whole list to use it just
97 * needs to start at the head and use the "next" pointers until it goes
98 * NULL. To add new local content, we insert the item after the tail item
99 * and update the tail (obviously, if "tail" was NULL, we insert it at the
100 * head). To clear the local list, WE MUST NOT FREE THE INHERITED CONTENT
101 * because it is shared between the current list and our parent list(s).
102 * The easiest way to handle this is to simply truncate the list after the
103 * tail item and then free the local list from the head. When inheriting
104 * the list for a new local dir, we just save off the filter_list_struct
105 * values (so we can pop back to them later) and set the tail to NULL.
106 */
107
108static void free_filter(struct filter_struct *ex)
109{
110 if (ex->match_flags & MATCHFLG_PERDIR_MERGE) {
111 free(ex->u.mergelist->debug_type);
112 free(ex->u.mergelist);
113 mergelist_cnt--;
114 }
115 free(ex->pattern);
116 free(ex);
117}
118
119/* Build a filter structure given a filter pattern. The value in "pat"
120 * is not null-terminated. */
121static void add_rule(struct filter_list_struct *listp, const char *pat,
122 unsigned int pat_len, uint32 mflags, int xflags)
123{
124 struct filter_struct *ret;
125 const char *cp;
126 unsigned int ex_len;
127
128 if (verbose > 2) {
129 rprintf(FINFO, "[%s] add_rule(%s%.*s%s)%s\n",
130 who_am_i(), get_rule_prefix(mflags, pat, 0, NULL),
131 (int)pat_len, pat,
132 (mflags & MATCHFLG_DIRECTORY) ? "/" : "",
133 listp->debug_type);
134 }
135
136 /* These flags also indicate that we're reading a list that
137 * needs to be filtered now, not post-filtered later. */
138 if (xflags & (XFLG_ANCHORED2ABS|XFLG_ABS_IF_SLASH)) {
139 uint32 mf = mflags & (MATCHFLG_RECEIVER_SIDE|MATCHFLG_SENDER_SIDE);
140 if (am_sender) {
141 if (mf == MATCHFLG_RECEIVER_SIDE)
142 return;
143 } else {
144 if (mf == MATCHFLG_SENDER_SIDE)
145 return;
146 }
147 }
148
149 if (!(ret = new(struct filter_struct)))
150 out_of_memory("add_rule");
151 memset(ret, 0, sizeof ret[0]);
152
153 if (!(mflags & (MATCHFLG_ABS_PATH | MATCHFLG_MERGE_FILE))
154 && ((xflags & (XFLG_ANCHORED2ABS|XFLG_ABS_IF_SLASH) && *pat == '/')
155 || (xflags & XFLG_ABS_IF_SLASH && strchr(pat, '/') != NULL))) {
156 mflags |= MATCHFLG_ABS_PATH;
157 if (*pat == '/')
158 ex_len = dirbuf_len - module_dirlen - 1;
159 else
160 ex_len = 0;
161 } else
162 ex_len = 0;
163 if (!(ret->pattern = new_array(char, ex_len + pat_len + 1)))
164 out_of_memory("add_rule");
165 if (ex_len)
166 memcpy(ret->pattern, dirbuf + module_dirlen, ex_len);
167 strlcpy(ret->pattern + ex_len, pat, pat_len + 1);
168 pat_len += ex_len;
169
170 if (strpbrk(ret->pattern, "*[?")) {
171 mflags |= MATCHFLG_WILD;
172 if ((cp = strstr(ret->pattern, "**")) != NULL) {
173 mflags |= MATCHFLG_WILD2;
174 /* If the pattern starts with **, note that. */
175 if (cp == ret->pattern)
176 mflags |= MATCHFLG_WILD2_PREFIX;
177 /* If the pattern ends with ***, note that. */
178 if (pat_len >= 3
179 && ret->pattern[pat_len-3] == '*'
180 && ret->pattern[pat_len-2] == '*'
181 && ret->pattern[pat_len-1] == '*')
182 mflags |= MATCHFLG_WILD3_SUFFIX;
183 }
184 }
185
186 if (pat_len > 1 && ret->pattern[pat_len-1] == '/') {
187 ret->pattern[pat_len-1] = 0;
188 mflags |= MATCHFLG_DIRECTORY;
189 }
190
191 if (mflags & MATCHFLG_PERDIR_MERGE) {
192 struct filter_list_struct *lp;
193 unsigned int len;
194 int i;
195
196 if ((cp = strrchr(ret->pattern, '/')) != NULL)
197 cp++;
198 else
199 cp = ret->pattern;
200
201 /* If the local merge file was already mentioned, don't
202 * add it again. */
203 for (i = 0; i < mergelist_cnt; i++) {
204 struct filter_struct *ex = mergelist_parents[i];
205 const char *s = strrchr(ex->pattern, '/');
206 if (s)
207 s++;
208 else
209 s = ex->pattern;
210 len = strlen(s);
211 if (len == pat_len - (cp - ret->pattern)
212 && memcmp(s, cp, len) == 0) {
213 free_filter(ret);
214 return;
215 }
216 }
217
218 if (!(lp = new_array(struct filter_list_struct, 1)))
219 out_of_memory("add_rule");
220 lp->head = lp->tail = NULL;
221 if (asprintf(&lp->debug_type, " [per-dir %s]", cp) < 0)
222 out_of_memory("add_rule");
223 ret->u.mergelist = lp;
224
225 if (mergelist_cnt == mergelist_size) {
226 mergelist_size += 5;
227 mergelist_parents = realloc_array(mergelist_parents,
228 struct filter_struct *,
229 mergelist_size);
230 if (!mergelist_parents)
231 out_of_memory("add_rule");
232 }
233 mergelist_parents[mergelist_cnt++] = ret;
234 } else {
235 for (cp = ret->pattern; (cp = strchr(cp, '/')) != NULL; cp++)
236 ret->u.slash_cnt++;
237 }
238
239 ret->match_flags = mflags;
240
241 if (!listp->tail) {
242 ret->next = listp->head;
243 listp->head = listp->tail = ret;
244 } else {
245 ret->next = listp->tail->next;
246 listp->tail->next = ret;
247 listp->tail = ret;
248 }
249}
250
251static void clear_filter_list(struct filter_list_struct *listp)
252{
253 if (listp->tail) {
254 struct filter_struct *ent, *next;
255 /* Truncate any inherited items from the local list. */
256 listp->tail->next = NULL;
257 /* Now free everything that is left. */
258 for (ent = listp->head; ent; ent = next) {
259 next = ent->next;
260 free_filter(ent);
261 }
262 }
263
264 listp->head = listp->tail = NULL;
265}
266
267/* This returns an expanded (absolute) filename for the merge-file name if
268 * the name has any slashes in it OR if the parent_dirscan var is True;
269 * otherwise it returns the original merge_file name. If the len_ptr value
270 * is non-NULL the merge_file name is limited by the referenced length
271 * value and will be updated with the length of the resulting name. We
272 * always return a name that is null terminated, even if the merge_file
273 * name was not. */
274static char *parse_merge_name(const char *merge_file, unsigned int *len_ptr,
275 unsigned int prefix_skip)
276{
277 static char buf[MAXPATHLEN];
278 char *fn, tmpbuf[MAXPATHLEN];
279 unsigned int fn_len;
280
281 if (!parent_dirscan && *merge_file != '/') {
282 /* Return the name unchanged it doesn't have any slashes. */
283 if (len_ptr) {
284 const char *p = merge_file + *len_ptr;
285 while (--p > merge_file && *p != '/') {}
286 if (p == merge_file) {
287 strlcpy(buf, merge_file, *len_ptr + 1);
288 return buf;
289 }
290 } else if (strchr(merge_file, '/') == NULL)
291 return (char *)merge_file;
292 }
293
294 fn = *merge_file == '/' ? buf : tmpbuf;
295 if (sanitize_paths) {
296 const char *r = prefix_skip ? "/" : NULL;
297 /* null-terminate the name if it isn't already */
298 if (len_ptr && merge_file[*len_ptr]) {
299 char *to = fn == buf ? tmpbuf : buf;
300 strlcpy(to, merge_file, *len_ptr + 1);
301 merge_file = to;
302 }
303 if (!sanitize_path(fn, merge_file, r, dirbuf_depth)) {
304 rprintf(FERROR, "merge-file name overflows: %s\n",
305 safe_fname(merge_file));
306 return NULL;
307 }
308 } else {
309 strlcpy(fn, merge_file, len_ptr ? *len_ptr + 1 : MAXPATHLEN);
310 clean_fname(fn, 1);
311 }
312
313 fn_len = strlen(fn);
314 if (fn == buf)
315 goto done;
316
317 if (dirbuf_len + fn_len >= MAXPATHLEN) {
318 rprintf(FERROR, "merge-file name overflows: %s\n",
319 safe_fname(fn));
320 return NULL;
321 }
322 memcpy(buf, dirbuf + prefix_skip, dirbuf_len - prefix_skip);
323 memcpy(buf + dirbuf_len - prefix_skip, fn, fn_len + 1);
324 fn_len = clean_fname(buf, 1);
325
326 done:
327 if (len_ptr)
328 *len_ptr = fn_len;
329 return buf;
330}
331
332/* Sets the dirbuf and dirbuf_len values. */
333void set_filter_dir(const char *dir, unsigned int dirlen)
334{
335 unsigned int len;
336 if (*dir != '/') {
337 memcpy(dirbuf, curr_dir, curr_dir_len);
338 dirbuf[curr_dir_len] = '/';
339 len = curr_dir_len + 1;
340 if (len + dirlen >= MAXPATHLEN)
341 dirlen = 0;
342 } else
343 len = 0;
344 memcpy(dirbuf + len, dir, dirlen);
345 dirbuf[dirlen + len] = '\0';
346 dirbuf_len = clean_fname(dirbuf, 1);
347 if (dirbuf_len > 1 && dirbuf[dirbuf_len-1] == '.'
348 && dirbuf[dirbuf_len-2] == '/')
349 dirbuf_len -= 2;
350 if (dirbuf_len != 1)
351 dirbuf[dirbuf_len++] = '/';
352 dirbuf[dirbuf_len] = '\0';
353 if (sanitize_paths)
354 dirbuf_depth = count_dir_elements(dirbuf + module_dirlen);
355}
356
357/* This routine takes a per-dir merge-file entry and finishes its setup.
358 * If the name has a path portion then we check to see if it refers to a
359 * parent directory of the first transfer dir. If it does, we scan all the
360 * dirs from that point through the parent dir of the transfer dir looking
361 * for the per-dir merge-file in each one. */
362static BOOL setup_merge_file(struct filter_struct *ex,
363 struct filter_list_struct *lp)
364{
365 char buf[MAXPATHLEN];
366 char *x, *y, *pat = ex->pattern;
367 unsigned int len;
368
369 if (!(x = parse_merge_name(pat, NULL, 0)) || *x != '/')
370 return 0;
371
372 y = strrchr(x, '/');
373 *y = '\0';
374 ex->pattern = strdup(y+1);
375 if (!*x)
376 x = "/";
377 if (*x == '/')
378 strlcpy(buf, x, MAXPATHLEN);
379 else
380 pathjoin(buf, MAXPATHLEN, dirbuf, x);
381
382 len = clean_fname(buf, 1);
383 if (len != 1 && len < MAXPATHLEN-1) {
384 buf[len++] = '/';
385 buf[len] = '\0';
386 }
387 /* This ensures that the specified dir is a parent of the transfer. */
388 for (x = buf, y = dirbuf; *x && *x == *y; x++, y++) {}
389 if (*x)
390 y += strlen(y); /* nope -- skip the scan */
391
392 parent_dirscan = True;
393 while (*y) {
394 char save[MAXPATHLEN];
395 strlcpy(save, y, MAXPATHLEN);
396 *y = '\0';
397 dirbuf_len = y - dirbuf;
398 strlcpy(x, ex->pattern, MAXPATHLEN - (x - buf));
399 parse_filter_file(lp, buf, ex->match_flags, XFLG_ANCHORED2ABS);
400 if (ex->match_flags & MATCHFLG_NO_INHERIT)
401 lp->head = NULL;
402 lp->tail = NULL;
403 strlcpy(y, save, MAXPATHLEN);
404 while ((*x++ = *y++) != '/') {}
405 }
406 parent_dirscan = False;
407 free(pat);
408 return 1;
409}
410
411/* Each time rsync changes to a new directory it call this function to
412 * handle all the per-dir merge-files. The "dir" value is the current path
413 * relative to curr_dir (which might not be null-terminated). We copy it
414 * into dirbuf so that we can easily append a file name on the end. */
415void *push_local_filters(const char *dir, unsigned int dirlen)
416{
417 struct filter_list_struct *ap, *push;
418 int i;
419
420 set_filter_dir(dir, dirlen);
421
422 if (!mergelist_cnt)
423 return NULL;
424
425 push = new_array(struct filter_list_struct, mergelist_cnt);
426 if (!push)
427 out_of_memory("push_local_filters");
428
429 for (i = 0, ap = push; i < mergelist_cnt; i++) {
430 memcpy(ap++, mergelist_parents[i]->u.mergelist,
431 sizeof (struct filter_list_struct));
432 }
433
434 /* Note: parse_filter_file() might increase mergelist_cnt, so keep
435 * this loop separate from the above loop. */
436 for (i = 0; i < mergelist_cnt; i++) {
437 struct filter_struct *ex = mergelist_parents[i];
438 struct filter_list_struct *lp = ex->u.mergelist;
439
440 if (verbose > 2) {
441 rprintf(FINFO, "[%s] pushing filter list%s\n",
442 who_am_i(), lp->debug_type);
443 }
444
445 lp->tail = NULL; /* Switch any local rules to inherited. */
446 if (ex->match_flags & MATCHFLG_NO_INHERIT)
447 lp->head = NULL;
448
449 if (ex->match_flags & MATCHFLG_FINISH_SETUP) {
450 ex->match_flags &= ~MATCHFLG_FINISH_SETUP;
451 if (setup_merge_file(ex, lp))
452 set_filter_dir(dir, dirlen);
453 }
454
455 if (strlcpy(dirbuf + dirbuf_len, ex->pattern,
456 MAXPATHLEN - dirbuf_len) < MAXPATHLEN - dirbuf_len) {
457 parse_filter_file(lp, dirbuf, ex->match_flags,
458 XFLG_ANCHORED2ABS);
459 } else {
460 io_error |= IOERR_GENERAL;
461 rprintf(FINFO,
462 "cannot add local filter rules in long-named directory: %s\n",
463 full_fname(dirbuf));
464 }
465 dirbuf[dirbuf_len] = '\0';
466 }
467
468 return (void*)push;
469}
470
471void pop_local_filters(void *mem)
472{
473 struct filter_list_struct *ap, *pop = (struct filter_list_struct*)mem;
474 int i;
475
476 for (i = mergelist_cnt; i-- > 0; ) {
477 struct filter_struct *ex = mergelist_parents[i];
478 struct filter_list_struct *lp = ex->u.mergelist;
479
480 if (verbose > 2) {
481 rprintf(FINFO, "[%s] popping filter list%s\n",
482 who_am_i(), lp->debug_type);
483 }
484
485 clear_filter_list(lp);
486 }
487
488 if (!pop)
489 return;
490
491 for (i = 0, ap = pop; i < mergelist_cnt; i++) {
492 memcpy(mergelist_parents[i]->u.mergelist, ap++,
493 sizeof (struct filter_list_struct));
494 }
495
496 free(pop);
497}
498
499static int rule_matches(char *name, struct filter_struct *ex, int name_is_dir)
500{
501 int slash_handling, str_cnt = 0, anchored_match = 0;
502 int ret_match = ex->match_flags & MATCHFLG_NEGATE ? 0 : 1;
503 char *p, *pattern = ex->pattern;
504 const char *strings[16]; /* more than enough */
505
506 if (!*name)
507 return 0;
508
509 if (!ex->u.slash_cnt && !(ex->match_flags & MATCHFLG_WILD2)) {
510 /* If the pattern does not have any slashes AND it does
511 * not have a "**" (which could match a slash), then we
512 * just match the name portion of the path. */
513 if ((p = strrchr(name,'/')) != NULL)
514 name = p+1;
515 } else if (ex->match_flags & MATCHFLG_ABS_PATH && *name != '/'
516 && curr_dir_len > module_dirlen + 1) {
517 /* If we're matching against an absolute-path pattern,
518 * we need to prepend our full path info. */
519 strings[str_cnt++] = curr_dir + module_dirlen + 1;
520 strings[str_cnt++] = "/";
521 } else if (ex->match_flags & MATCHFLG_WILD2_PREFIX && *name != '/') {
522 /* Allow "**"+"/" to match at the start of the string. */
523 strings[str_cnt++] = "/";
524 }
525 strings[str_cnt++] = name;
526 if (name_is_dir) {
527 /* Allow a trailing "/"+"***" to match the directory. */
528 if (ex->match_flags & MATCHFLG_WILD3_SUFFIX)
529 strings[str_cnt++] = "/";
530 } else if (ex->match_flags & MATCHFLG_DIRECTORY)
531 return !ret_match;
532 strings[str_cnt] = NULL;
533
534 if (*pattern == '/') {
535 anchored_match = 1;
536 pattern++;
537 if (strings[0][0] == '/')
538 strings[0]++;
539 }
540
541 if (!anchored_match && ex->u.slash_cnt
542 && !(ex->match_flags & MATCHFLG_WILD2)) {
543 /* A non-anchored match with an infix slash and no "**"
544 * needs to match the last slash_cnt+1 name elements. */
545 slash_handling = ex->u.slash_cnt + 1;
546 } else if (!anchored_match && !(ex->match_flags & MATCHFLG_WILD2_PREFIX)
547 && ex->match_flags & MATCHFLG_WILD2) {
548 /* A non-anchored match with an infix or trailing "**" (but not
549 * a prefixed "**") needs to try matching after every slash. */
550 slash_handling = -1;
551 } else {
552 /* The pattern matches only at the start of the path or name. */
553 slash_handling = 0;
554 }
555
556 if (ex->match_flags & MATCHFLG_WILD) {
557 if (wildmatch_array(pattern, strings, slash_handling))
558 return ret_match;
559 } else if (str_cnt > 1) {
560 if (litmatch_array(pattern, strings, slash_handling))
561 return ret_match;
562 } else if (anchored_match) {
563 if (strcmp(name,pattern) == 0)
564 return ret_match;
565 } else {
566 int l1 = strlen(name);
567 int l2 = strlen(pattern);
568 if (l2 <= l1 &&
569 strcmp(name+(l1-l2),pattern) == 0 &&
570 (l1==l2 || name[l1-(l2+1)] == '/')) {
571 return ret_match;
572 }
573 }
574
575 return !ret_match;
576}
577
578
579static void report_filter_result(char const *name,
580 struct filter_struct const *ent,
581 int name_is_dir, const char *type)
582{
583 /* If a trailing slash is present to match only directories,
584 * then it is stripped out by add_rule(). So as a special
585 * case we add it back in here. */
586
587 if (verbose >= 2) {
588 rprintf(FINFO, "[%s] %scluding %s %s because of pattern %s%s%s\n",
589 who_am_i(),
590 ent->match_flags & MATCHFLG_INCLUDE ? "in" : "ex",
591 name_is_dir ? "directory" : "file", name, ent->pattern,
592 ent->match_flags & MATCHFLG_DIRECTORY ? "/" : "", type);
593 }
594}
595
596
597/*
598 * Return -1 if file "name" is defined to be excluded by the specified
599 * exclude list, 1 if it is included, and 0 if it was not matched.
600 */
601int check_filter(struct filter_list_struct *listp, char *name, int name_is_dir)
602{
603 struct filter_struct *ent;
604
605 for (ent = listp->head; ent; ent = ent->next) {
606 if (ent->match_flags & MATCHFLG_PERDIR_MERGE) {
607 int rc = check_filter(ent->u.mergelist, name,
608 name_is_dir);
609 if (rc)
610 return rc;
611 continue;
612 }
613 if (ent->match_flags & MATCHFLG_CVS_IGNORE) {
614 int rc = check_filter(&cvs_filter_list, name,
615 name_is_dir);
616 if (rc)
617 return rc;
618 continue;
619 }
620 if (rule_matches(name, ent, name_is_dir)) {
621 report_filter_result(name, ent, name_is_dir,
622 listp->debug_type);
623 return ent->match_flags & MATCHFLG_INCLUDE ? 1 : -1;
624 }
625 }
626
627 return 0;
628}
629
630#define RULE_STRCMP(s,r) rule_strcmp((s), (r), sizeof (r) - 1)
631
632static const uchar *rule_strcmp(const uchar *str, const char *rule, int rule_len)
633{
634 if (strncmp((char*)str, rule, rule_len) != 0)
635 return NULL;
636 if (isspace(str[rule_len]) || str[rule_len] == '_' || !str[rule_len])
637 return str + rule_len - 1;
638 if (str[rule_len] == ',')
639 return str + rule_len;
640 return NULL;
641}
642
643/* Get the next include/exclude arg from the string. The token will not
644 * be '\0' terminated, so use the returned length to limit the string.
645 * Also, be sure to add this length to the returned pointer before passing
646 * it back to ask for the next token. This routine parses the "!" (list-
647 * clearing) token and (depending on the mflags) the various prefixes.
648 * The *mflags_ptr value will be set on exit to the new MATCHFLG_* bits
649 * for the current token. */
650static const char *parse_rule_tok(const char *p, uint32 mflags, int xflags,
651 unsigned int *len_ptr, uint32 *mflags_ptr)
652{
653 const uchar *s = (const uchar *)p;
654 uint32 new_mflags;
655 unsigned int len;
656
657 if (mflags & MATCHFLG_WORD_SPLIT) {
658 /* Skip over any initial whitespace. */
659 while (isspace(*s))
660 s++;
661 /* Update to point to real start of rule. */
662 p = (const char *)s;
663 }
664 if (!*s)
665 return NULL;
666
667 new_mflags = mflags & MATCHFLGS_FROM_CONTAINER;
668
669 /* Figure out what kind of a filter rule "s" is pointing at. Note
670 * that if MATCHFLG_NO_PREFIXES is set, the rule is either an include
671 * or an exclude based on the inheritance of the MATCHFLG_INCLUDE
672 * flag (above). XFLG_OLD_PREFIXES indicates a compatibility mode
673 * for old include/exclude patterns where just "+ " and "- " are
674 * allowed as optional prefixes. */
675 if (mflags & MATCHFLG_NO_PREFIXES) {
676 if (*s == '!' && mflags & MATCHFLG_CVS_IGNORE)
677 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
678 } else if (xflags & XFLG_OLD_PREFIXES) {
679 if (*s == '-' && s[1] == ' ') {
680 new_mflags &= ~MATCHFLG_INCLUDE;
681 s += 2;
682 } else if (*s == '+' && s[1] == ' ') {
683 new_mflags |= MATCHFLG_INCLUDE;
684 s += 2;
685 } else if (*s == '!')
686 new_mflags |= MATCHFLG_CLEAR_LIST; /* Tentative! */
687 } else {
688 char ch = 0, *mods = "";
689 switch (*s) {
690 case 'c':
691 if ((s = RULE_STRCMP(s, "clear")) != NULL)
692 ch = '!';
693 break;
694 case 'd':
695 if ((s = RULE_STRCMP(s, "dir-merge")) != NULL)
696 ch = ':';
697 break;
698 case 'e':
699 if ((s = RULE_STRCMP(s, "exclude")) != NULL)
700 ch = '-';
701 break;
702 case 'h':
703 if ((s = RULE_STRCMP(s, "hide")) != NULL)
704 ch = 'H';
705 break;
706 case 'i':
707 if ((s = RULE_STRCMP(s, "include")) != NULL)
708 ch = '+';
709 break;
710 case 'm':
711 if ((s = RULE_STRCMP(s, "merge")) != NULL)
712 ch = '.';
713 break;
714 case 'p':
715 if ((s = RULE_STRCMP(s, "protect")) != NULL)
716 ch = 'P';
717 break;
718 case 'r':
719 if ((s = RULE_STRCMP(s, "risk")) != NULL)
720 ch = 'R';
721 break;
722 case 's':
723 if ((s = RULE_STRCMP(s, "show")) != NULL)
724 ch = 'S';
725 break;
726 default:
727 ch = *s;
728 if (s[1] == ',')
729 s++;
730 break;
731 }
732 switch (ch) {
733 case ':':
734 new_mflags |= MATCHFLG_PERDIR_MERGE
735 | MATCHFLG_FINISH_SETUP;
736 /* FALL THROUGH */
737 case '.':
738 new_mflags |= MATCHFLG_MERGE_FILE;
739 mods = MODIFIERS_INCL_EXCL MODIFIERS_MERGE_FILE;
740 break;
741 case '+':
742 new_mflags |= MATCHFLG_INCLUDE;
743 /* FALL THROUGH */
744 case '-':
745 mods = MODIFIERS_INCL_EXCL;
746 break;
747 case 'S':
748 new_mflags |= MATCHFLG_INCLUDE;
749 /* FALL THROUGH */
750 case 'H':
751 new_mflags |= MATCHFLG_SENDER_SIDE;
752 mods = MODIFIERS_HIDE_PROTECT;
753 break;
754 case 'R':
755 new_mflags |= MATCHFLG_INCLUDE;
756 /* FALL THROUGH */
757 case 'P':
758 new_mflags |= MATCHFLG_RECEIVER_SIDE;
759 mods = MODIFIERS_HIDE_PROTECT;
760 break;
761 case '!':
762 new_mflags |= MATCHFLG_CLEAR_LIST;
763 mods = NULL;
764 break;
765 default:
766 rprintf(FERROR, "Unknown filter rule: `%s'\n", p);
767 exit_cleanup(RERR_SYNTAX);
768 }
769 while (mods && *++s && *s != ' ' && *s != '_') {
770 if (strchr(mods, *s) == NULL) {
771 if (mflags & MATCHFLG_WORD_SPLIT && isspace(*s)) {
772 s--;
773 break;
774 }
775 invalid:
776 rprintf(FERROR,
777 "invalid modifier sequence at '%c' in filter rule: %s\n",
778 *s, p);
779 exit_cleanup(RERR_SYNTAX);
780 }
781 switch (*s) {
782 case '-':
783 if (new_mflags & MATCHFLG_NO_PREFIXES)
784 goto invalid;
785 new_mflags |= MATCHFLG_NO_PREFIXES;
786 break;
787 case '+':
788 if (new_mflags & MATCHFLG_NO_PREFIXES)
789 goto invalid;
790 new_mflags |= MATCHFLG_NO_PREFIXES
791 | MATCHFLG_INCLUDE;
792 break;
793 case '/':
794 new_mflags |= MATCHFLG_ABS_PATH;
795 break;
796 case '!':
797 new_mflags |= MATCHFLG_NEGATE;
798 break;
799 case 'C':
800 if (new_mflags & MATCHFLG_NO_PREFIXES)
801 goto invalid;
802 new_mflags |= MATCHFLG_NO_PREFIXES
803 | MATCHFLG_WORD_SPLIT
804 | MATCHFLG_NO_INHERIT
805 | MATCHFLG_CVS_IGNORE;
806 break;
807 case 'e':
808 new_mflags |= MATCHFLG_EXCLUDE_SELF;
809 break;
810 case 'n':
811 new_mflags |= MATCHFLG_NO_INHERIT;
812 break;
813 case 'r':
814 new_mflags |= MATCHFLG_RECEIVER_SIDE;
815 break;
816 case 's':
817 new_mflags |= MATCHFLG_SENDER_SIDE;
818 break;
819 case 'w':
820 new_mflags |= MATCHFLG_WORD_SPLIT;
821 break;
822 }
823 }
824 if (*s)
825 s++;
826 }
827
828 if (mflags & MATCHFLG_WORD_SPLIT) {
829 const uchar *cp = s;
830 /* Token ends at whitespace or the end of the string. */
831 while (!isspace(*cp) && *cp != '\0')
832 cp++;
833 len = cp - s;
834 } else
835 len = strlen((char*)s);
836
837 if (new_mflags & MATCHFLG_CLEAR_LIST) {
838 if (!(mflags & MATCHFLG_NO_PREFIXES)
839 && !(xflags & XFLG_OLD_PREFIXES) && len) {
840 rprintf(FERROR,
841 "'!' rule has trailing characters: %s\n", p);
842 exit_cleanup(RERR_SYNTAX);
843 }
844 if (len > 1)
845 new_mflags &= ~MATCHFLG_CLEAR_LIST;
846 } else if (!len && !(new_mflags & MATCHFLG_CVS_IGNORE)) {
847 rprintf(FERROR, "unexpected end of filter rule: %s\n", p);
848 exit_cleanup(RERR_SYNTAX);
849 }
850
851 *len_ptr = len;
852 *mflags_ptr = new_mflags;
853 return (const char *)s;
854}
855
856
857static char default_cvsignore[] =
858 /* These default ignored items come from the CVS manual. */
859 "RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS"
860 " .make.state .nse_depinfo *~ #* .#* ,* _$* *$"
861 " *.old *.bak *.BAK *.orig *.rej .del-*"
862 " *.a *.olb *.o *.obj *.so *.exe"
863 " *.Z *.elc *.ln core"
864 /* The rest we added to suit ourself. */
865 " .svn/";
866
867static void get_cvs_excludes(uint32 mflags)
868{
869 char *p, fname[MAXPATHLEN];
870 static int initialized = 0;
871
872 if (initialized)
873 return;
874 initialized = 1;
875
876 parse_rule(&cvs_filter_list, default_cvsignore, mflags, 0);
877
878 p = module_id >= 0 && lp_use_chroot(module_id) ? "/" : getenv("HOME");
879 if (p && pathjoin(fname, MAXPATHLEN, p, ".cvsignore") < MAXPATHLEN)
880 parse_filter_file(&cvs_filter_list, fname, mflags, 0);
881
882 parse_rule(&cvs_filter_list, getenv("CVSIGNORE"), mflags, 0);
883}
884
885
886void parse_rule(struct filter_list_struct *listp, const char *pattern,
887 uint32 mflags, int xflags)
888{
889 unsigned int pat_len;
890 uint32 new_mflags;
891 const char *cp, *p;
892
893 if (!pattern)
894 return;
895
896 while (1) {
897 /* Remember that the returned string is NOT '\0' terminated! */
898 cp = parse_rule_tok(pattern, mflags, xflags,
899 &pat_len, &new_mflags);
900 if (!cp)
901 break;
902 if (pat_len >= MAXPATHLEN) {
903 rprintf(FERROR, "discarding over-long filter: %s\n",
904 cp);
905 continue;
906 }
907 pattern = cp + pat_len;
908
909 if (new_mflags & MATCHFLG_CLEAR_LIST) {
910 if (verbose > 2) {
911 rprintf(FINFO,
912 "[%s] clearing filter list%s\n",
913 who_am_i(), listp->debug_type);
914 }
915 clear_filter_list(listp);
916 continue;
917 }
918
919 if (new_mflags & MATCHFLG_MERGE_FILE) {
920 unsigned int len;
921 if (!pat_len) {
922 cp = ".cvsignore";
923 pat_len = 10;
924 }
925 len = pat_len;
926 if (new_mflags & MATCHFLG_EXCLUDE_SELF) {
927 const char *name = strrchr(cp, '/');
928 if (name)
929 len -= ++name - cp;
930 else
931 name = cp;
932 add_rule(listp, name, len, 0, 0);
933 new_mflags &= ~MATCHFLG_EXCLUDE_SELF;
934 len = pat_len;
935 }
936 if (new_mflags & MATCHFLG_PERDIR_MERGE) {
937 if (parent_dirscan) {
938 if (!(p = parse_merge_name(cp, &len,
939 module_dirlen)))
940 continue;
941 add_rule(listp, p, len, new_mflags, 0);
942 continue;
943 }
944 } else {
945 if (!(p = parse_merge_name(cp, &len, 0)))
946 continue;
947 parse_filter_file(listp, p, new_mflags,
948 XFLG_FATAL_ERRORS);
949 continue;
950 }
951 }
952
953 add_rule(listp, cp, pat_len, new_mflags, xflags);
954
955 if (new_mflags & MATCHFLG_CVS_IGNORE
956 && !(new_mflags & MATCHFLG_MERGE_FILE))
957 get_cvs_excludes(new_mflags);
958 }
959}
960
961
962void parse_filter_file(struct filter_list_struct *listp, const char *fname,
963 uint32 mflags, int xflags)
964{
965 FILE *fp;
966 char line[BIGPATHBUFLEN];
967 char *eob = line + sizeof line - 1;
968 int word_split = mflags & MATCHFLG_WORD_SPLIT;
969
970 if (!fname || !*fname)
971 return;
972
973 if (*fname != '-' || fname[1] || am_server) {
974 if (server_filter_list.head) {
975 strlcpy(line, fname, sizeof line);
976 clean_fname(line, 1);
977 if (check_filter(&server_filter_list, line, 0) < 0)
978 fp = NULL;
979 else
980 fp = fopen(line, "rb");
981 } else
982 fp = fopen(fname, "rb");
983 } else
984 fp = stdin;
985
986 if (verbose > 2) {
987 rprintf(FINFO, "[%s] parse_filter_file(%s,%x,%x)%s\n",
988 who_am_i(), safe_fname(fname), mflags, xflags,
989 fp ? "" : " [not found]");
990 }
991
992 if (!fp) {
993 if (xflags & XFLG_FATAL_ERRORS) {
994 rsyserr(FERROR, errno,
995 "failed to open %sclude file %s",
996 mflags & MATCHFLG_INCLUDE ? "in" : "ex",
997 safe_fname(fname));
998 exit_cleanup(RERR_FILEIO);
999 }
1000 return;
1001 }
1002 dirbuf[dirbuf_len] = '\0';
1003
1004 while (1) {
1005 char *s = line;
1006 int ch, overflow = 0;
1007 while (1) {
1008 if ((ch = getc(fp)) == EOF) {
1009 if (ferror(fp) && errno == EINTR) {
1010 clearerr(fp);
1011 continue;
1012 }
1013 break;
1014 }
1015 if (word_split && isspace(ch))
1016 break;
1017 if (eol_nulls? !ch : (ch == '\n' || ch == '\r'))
1018 break;
1019 if (s < eob)
1020 *s++ = ch;
1021 else
1022 overflow = 1;
1023 }
1024 if (overflow) {
1025 rprintf(FERROR, "discarding over-long filter: %s...\n", line);
1026 s = line;
1027 }
1028 *s = '\0';
1029 /* Skip an empty token and (when line parsing) comments. */
1030 if (*line && (word_split || (*line != ';' && *line != '#')))
1031 parse_rule(listp, line, mflags, xflags);
1032 if (ch == EOF)
1033 break;
1034 }
1035 fclose(fp);
1036}
1037
1038/* If the "for_xfer" flag is set, the prefix is made compatible with the
1039 * current protocol_version (if possible) or a NULL is returned (if not
1040 * possible). */
1041char *get_rule_prefix(int match_flags, const char *pat, int for_xfer,
1042 unsigned int *plen_ptr)
1043{
1044 static char buf[MAX_RULE_PREFIX+1];
1045 char *op = buf;
1046 int legal_len = for_xfer && protocol_version < 29 ? 1 : MAX_RULE_PREFIX-1;
1047
1048 if (match_flags & MATCHFLG_PERDIR_MERGE) {
1049 if (legal_len == 1)
1050 return NULL;
1051 *op++ = ':';
1052 } else if (match_flags & MATCHFLG_INCLUDE)
1053 *op++ = '+';
1054 else if (legal_len != 1
1055 || ((*pat == '-' || *pat == '+') && pat[1] == ' '))
1056 *op++ = '-';
1057 else
1058 legal_len = 0;
1059
1060 if (match_flags & MATCHFLG_CVS_IGNORE)
1061 *op++ = 'C';
1062 else {
1063 if (match_flags & MATCHFLG_NO_INHERIT)
1064 *op++ = 'n';
1065 if (match_flags & MATCHFLG_WORD_SPLIT)
1066 *op++ = 'w';
1067 if (match_flags & MATCHFLG_NO_PREFIXES) {
1068 if (match_flags & MATCHFLG_INCLUDE)
1069 *op++ = '+';
1070 else
1071 *op++ = '-';
1072 }
1073 }
1074 if (match_flags & MATCHFLG_EXCLUDE_SELF)
1075 *op++ = 'e';
1076 if (match_flags & MATCHFLG_SENDER_SIDE
1077 && (!for_xfer || protocol_version >= 29))
1078 *op++ = 's';
1079 if (match_flags & MATCHFLG_RECEIVER_SIDE
1080 && (!for_xfer || protocol_version >= 29
1081 || (delete_excluded && am_sender)))
1082 *op++ = 'r';
1083 if (op - buf > legal_len)
1084 return NULL;
1085 if (legal_len)
1086 *op++ = ' ';
1087 *op = '\0';
1088 if (plen_ptr)
1089 *plen_ptr = op - buf;
1090 return buf;
1091}
1092
1093static void send_rules(int f_out, struct filter_list_struct *flp)
1094{
1095 struct filter_struct *ent, *prev = NULL;
1096
1097 for (ent = flp->head; ent; ent = ent->next) {
1098 unsigned int len, plen, dlen;
1099 int elide = 0;
1100 char *p;
1101
1102 if (ent->match_flags & MATCHFLG_SENDER_SIDE)
1103 elide = am_sender ? 1 : -1;
1104 if (ent->match_flags & MATCHFLG_RECEIVER_SIDE)
1105 elide = elide ? 0 : am_sender ? -1 : 1;
1106 else if (delete_excluded && !elide)
1107 elide = am_sender ? 1 : -1;
1108 if (elide < 0) {
1109 if (prev)
1110 prev->next = ent->next;
1111 else
1112 flp->head = ent->next;
1113 } else
1114 prev = ent;
1115 if (elide > 0)
1116 continue;
1117 if (ent->match_flags & MATCHFLG_CVS_IGNORE
1118 && !(ent->match_flags & MATCHFLG_MERGE_FILE)) {
1119 int f = am_sender || protocol_version < 29 ? f_out : -2;
1120 send_rules(f, &cvs_filter_list);
1121 if (f == f_out)
1122 continue;
1123 }
1124 p = get_rule_prefix(ent->match_flags, ent->pattern, 1, &plen);
1125 if (!p) {
1126 rprintf(FERROR,
1127 "filter rules are too modern for remote rsync.\n");
1128 exit_cleanup(RERR_SYNTAX);
1129 }
1130 if (f_out < 0)
1131 continue;
1132 len = strlen(ent->pattern);
1133 dlen = ent->match_flags & MATCHFLG_DIRECTORY ? 1 : 0;
1134 if (!(plen + len + dlen))
1135 continue;
1136 write_int(f_out, plen + len + dlen);
1137 if (plen)
1138 write_buf(f_out, p, plen);
1139 write_buf(f_out, ent->pattern, len);
1140 if (dlen)
1141 write_byte(f_out, '/');
1142 }
1143 flp->tail = prev;
1144}
1145
1146/* This is only called by the client. */
1147void send_filter_list(int f_out)
1148{
1149 int receiver_wants_list = delete_mode
1150 && (!delete_excluded || protocol_version >= 29);
1151
1152 if (local_server || (am_sender && !receiver_wants_list))
1153 f_out = -1;
1154 if (cvs_exclude && am_sender) {
1155 if (protocol_version >= 29)
1156 parse_rule(&filter_list, ":C", 0, 0);
1157 parse_rule(&filter_list, "-C", 0, 0);
1158 }
1159
1160 /* This is a complete hack - blame Rusty. FIXME!
1161 * Remove this hack when older rsyncs (below 2.6.4) are gone. */
1162 if (list_only == 1 && !recurse)
1163 parse_rule(&filter_list, "/*/*", MATCHFLG_NO_PREFIXES, 0);
1164
1165 send_rules(f_out, &filter_list);
1166
1167 if (f_out >= 0)
1168 write_int(f_out, 0);
1169
1170 if (cvs_exclude) {
1171 if (!am_sender || protocol_version < 29)
1172 parse_rule(&filter_list, ":C", 0, 0);
1173 if (!am_sender)
1174 parse_rule(&filter_list, "-C", 0, 0);
1175 }
1176}
1177
1178/* This is only called by the server. */
1179void recv_filter_list(int f_in)
1180{
1181 char line[BIGPATHBUFLEN];
1182 int xflags = protocol_version >= 29 ? 0 : XFLG_OLD_PREFIXES;
1183 int receiver_wants_list = delete_mode
1184 && (!delete_excluded || protocol_version >= 29);
1185 unsigned int len;
1186
1187 if (!local_server && (am_sender || receiver_wants_list)) {
1188 while ((len = read_int(f_in)) != 0) {
1189 if (len >= sizeof line)
1190 overflow_exit("recv_rules");
1191 read_sbuf(f_in, line, len);
1192 parse_rule(&filter_list, line, 0, xflags);
1193 }
1194 }
1195
1196 if (cvs_exclude) {
1197 if (local_server || am_sender || protocol_version < 29)
1198 parse_rule(&filter_list, ":C", 0, 0);
1199 if (local_server || am_sender)
1200 parse_rule(&filter_list, "-C", 0, 0);
1201 }
1202
1203 if (local_server) /* filter out any rules that aren't for us. */
1204 send_rules(-1, &filter_list);
1205}