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