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