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