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 delete_mode;
  31
  32 static struct exclude_struct **exclude_list;
  33
  34 /** Build an exclude structure given a exclude pattern */
  35 static struct exclude_struct *make_exclude(const char *pattern, int include)
  36 {
  37         struct exclude_struct *ret;
  38
  39         ret = (struct exclude_struct *)malloc(sizeof(*ret));
  40         if (!ret) out_of_memory("make_exclude");
  41
  42         memset(ret, 0, sizeof(*ret));
  43
  44         if (strncmp(pattern,"- ",2) == 0) {
  45                 pattern += 2;
  46         } else if (strncmp(pattern,"+ ",2) == 0) {
  47                 ret->include = 1;
  48                 pattern += 2;
  49         } else {
  50                 ret->include = include;
  51         }
  52
  53         ret->pattern = strdup(pattern);
  54
  55         if (!ret->pattern) out_of_memory("make_exclude");
  56
  57         if (strpbrk(pattern, "*[?")) {
  58                 ret->regular_exp = 1;
  59                 ret->fnmatch_flags = FNM_PATHNAME;
  60                 if (strstr(pattern, "**")) {
  61                         static int tested;
  62                         if (!tested) {
  63                                 tested = 1;
  64                                 if (fnmatch("a/b/*","a/b/c/d",FNM_PATHNAME)==0)
  65                                         rprintf(FERROR,"WARNING: fnmatch FNM_PATHNAME is broken on your system\n");
  66                         }
  67                         ret->fnmatch_flags = 0;
  68                 }
  69         }
  70
  71         if (strlen(pattern) > 1 && pattern[strlen(pattern)-1] == '/') {
  72                 ret->pattern[strlen(pattern)-1] = 0;
  73                 ret->directory = 1;
  74         }
  75
  76         if (!strchr(ret->pattern,'/')) {
  77                 ret->local = 1;
  78         }
  79
  80         return ret;
  81 }
  82
  83 static void free_exclude(struct exclude_struct *ex)
  84 {
  85         free(ex->pattern);
  86         memset(ex,0,sizeof(*ex));
  87         free(ex);
  88 }
  89
  90 static int check_one_exclude(char *name, struct exclude_struct *ex,
  91                              STRUCT_STAT *st)
  92 {
  93         char *p;
  94         int match_start = 0;
  95         char *pattern = ex->pattern;
  96
  97         if (ex->local && (p=strrchr(name,'/')))
  98                 name = p+1;
  99
 100         if (!name[0]) return 0;
 101
 102         if (ex->directory && !S_ISDIR(st->st_mode)) return 0;
 103
 104         if (*pattern == '/' && *name != '/') {
 105                 match_start = 1;
 106                 pattern++;
 107         }
 108
 109         if (ex->regular_exp) {
 110                 if (fnmatch(pattern, name, ex->fnmatch_flags) == 0) {
 111                         return 1;
 112                 }
 113         } else {
 114                 int l1 = strlen(name);
 115                 int l2 = strlen(pattern);
 116                 if (l2 <= l1 &&
 117                     strcmp(name+(l1-l2),pattern) == 0 &&
 118                     (l1==l2 || (!match_start && name[l1-(l2+1)] == '/'))) {
 119                         return 1;
 120                 }
 121         }
 122
 123         return 0;
 124 }
 125
 126
 127 static void report_exclude_result(char const *name,
 128                                   struct exclude_struct const *ent,
 129                                   STRUCT_STAT const *st)
 130 {
 131         /* If a trailing slash is present to match only directories,
 132          * then it is stripped out by make_exclude.  So as a special
 133          * case we add it back in here. */
 134
 135         if (verbose >= 2)
 136                 rprintf(FINFO, "%s %s %s because of pattern %s%s\n",
 137                         ent->include ? "including" : "excluding",
 138                         S_ISDIR(st->st_mode) ? "directory" : "file",
 139                         name, ent->pattern,
 140                         ent->directory ? "/" : "");
 141 }
 142
 143
 144 /*
 145  * Return true if file NAME is defined to be excluded by either
 146  * LOCAL_EXCLUDE_LIST or the globals EXCLUDE_LIST.
 147  */
 148 int check_exclude(char *name, struct exclude_struct **local_exclude_list,
 149                   STRUCT_STAT *st)
 150 {
 151         int n;
 152         struct exclude_struct *ent;
 153
 154         if (name && (name[0] == '.') && !name[1])
 155                 /* never exclude '.', even if somebody does --exclude '*' */
 156                 return 0;
 157
 158         if (exclude_list) {
 159                 for (n=0; exclude_list[n]; n++) {
 160                         ent = exclude_list[n];
 161                         if (check_one_exclude(name, ent, st)) {
 162                                 report_exclude_result(name, ent, st);
 163                                 return !ent->include;
 164                         }
 165                 }
 166         }
 167
 168         if (local_exclude_list) {
 169                 for (n=0; local_exclude_list[n]; n++) {
 170                         ent = local_exclude_list[n];
 171                         if (check_one_exclude(name, ent, st)) {
 172                                 report_exclude_result(name, ent, st);
 173                                 return !ent->include;
 174                         }
 175                 }
 176         }
 177
 178         return 0;
 179 }
 180
 181
 182 void add_exclude_list(const char *pattern, struct exclude_struct ***list, int include)
 183 {
 184         int len=0;
 185         if (list && *list)
 186                 for (; (*list)[len]; len++) ;
 187
 188         if (strcmp(pattern,"!") == 0) {
 189                 if (verbose > 2)
 190                         rprintf(FINFO,"clearing exclude list\n");
 191                 while ((len)--) {
 192                         free_exclude((*list)[len]);
 193                 }
 194                 free((*list));
 195                 *list = NULL;
 196                 return;
 197         }
 198
 199         *list = (struct exclude_struct **)Realloc(*list,sizeof(struct exclude_struct *)*(len+2));
 200
 201         if (!*list || !((*list)[len] = make_exclude(pattern, include)))
 202                 out_of_memory("add_exclude");
 203
 204         if (verbose > 2) {
 205                 rprintf(FINFO,"add_exclude(%s,%s)\n",pattern,
 206                         include ? "include" : "exclude");
 207         }
 208
 209         (*list)[len+1] = NULL;
 210 }
 211
 212 void add_exclude(const char *pattern, int include)
 213 {
 214         add_exclude_list(pattern,&exclude_list, include);
 215 }
 216
 217 struct exclude_struct **make_exclude_list(const char *fname,
 218                                           struct exclude_struct **list1,
 219                                           int fatal, int include)
 220 {
 221         struct exclude_struct **list=list1;
 222         int fd;
 223         char line[MAXPATHLEN];
 224         char *eob = line + MAXPATHLEN - 1;
 225         extern int eol_nulls;
 226
 227         if (strcmp(fname, "-") != 0)
 228                 fd = open(fname, O_RDONLY|O_BINARY);
 229         else
 230                 fd = 0;
 231         if (fd < 0) {
 232                 if (fatal) {
 233                         rsyserr(FERROR, errno,
 234                                 "failed to open %s file %s",
 235                                 include ? "include" : "exclude",
 236                                 fname);
 237                         exit_cleanup(RERR_FILEIO);
 238                 }
 239                 return list;
 240         }
 241
 242         while (1) {
 243                 char ch, *s = line;
 244                 int cnt;
 245                 while (1) {
 246                         if ((cnt = read(fd, &ch, 1)) <= 0) {
 247                                 if (cnt < 0 && errno == EINTR)
 248                                         continue;
 249                                 break;
 250                         }
 251                         if (eol_nulls? !ch : (ch == '\n' || ch == '\r'))
 252                                 break;
 253                         if (s < eob)
 254                                 *s++ = ch;
 255                 }
 256                 *s = '\0';
 257                 if (*line && *line != ';' && *line != '#') {
 258                         /* Skip lines starting with semicolon or pound.
 259                          * It probably wouldn't cause any harm to not skip
 260                          * them but there's no need to save them. */
 261                         add_exclude_list(line,&list,include);
 262                 }
 263                 if (cnt <= 0)
 264                         break;
 265         }
 266         close(fd);
 267         return list;
 268 }
 269
 270
 271 void add_exclude_file(const char *fname, int fatal, int include)
 272 {
 273         if (!fname || !*fname) return;
 274
 275         exclude_list = make_exclude_list(fname,exclude_list,fatal,include);
 276 }
 277
 278
 279 void send_exclude_list(int f)
 280 {
 281         int i;
 282         extern int remote_version;
 283         extern int list_only, recurse;
 284
 285         /* This is a complete hack - blame Rusty.
 286          *
 287          * FIXME: This pattern shows up in the output of
 288          * report_exclude_result(), which is not ideal. */
 289         if (list_only && !recurse) {
 290                 add_exclude("/*/*", 0);
 291         }
 292
 293         if (!exclude_list) {
 294                 write_int(f,0);
 295                 return;
 296         }
 297
 298         for (i=0;exclude_list[i];i++) {
 299                 int l;
 300                 char pattern[MAXPATHLEN];
 301
 302                 strlcpy(pattern,exclude_list[i]->pattern,sizeof(pattern));
 303                 if (exclude_list[i]->directory) strlcat(pattern,"/", sizeof(pattern));
 304
 305                 l = strlen(pattern);
 306                 if (l == 0) continue;
 307                 if (exclude_list[i]->include) {
 308                         if (remote_version < 19) {
 309                                 rprintf(FERROR,"remote rsync does not support include syntax - aborting\n");
 310                                 exit_cleanup(RERR_UNSUPPORTED);
 311                         }
 312                         write_int(f,l+2);
 313                         write_buf(f,"+ ",2);
 314                 } else {
 315                         write_int(f,l);
 316                 }
 317                 write_buf(f,pattern,l);
 318         }
 319
 320         write_int(f,0);
 321 }
 322
 323
 324 void recv_exclude_list(int f)
 325 {
 326         char line[MAXPATHLEN];
 327         unsigned int l;
 328
 329         while ((l=read_int(f))) {
 330                 if (l >= MAXPATHLEN) overflow("recv_exclude_list");
 331                 read_sbuf(f,line,l);
 332                 add_exclude(line,0);
 333         }
 334 }
 335
 336 /* Get the next include/exclude arg from the string. It works in a similar way
 337 ** to strtok - initially an arg is sent over, from then on NULL. This
 338 ** routine takes into account any +/- in the strings and does not
 339 ** consider the space following it as a delimeter.
 340 */
 341 char *get_exclude_tok(char *p)
 342 {
 343         static char *s;
 344         static int more;
 345         char *t;
 346
 347         if (p) {
 348                 s=p;
 349                 if (*p)
 350                         more=1;
 351         }
 352
 353         if (!more)
 354                 return(NULL);
 355
 356         /* Skip over any initial spaces */
 357         while (isspace(* (unsigned char *) s))
 358                 s++;
 359
 360         /* Are we at the end of the string? */
 361         if (*s) {
 362                 /* remember the beginning of the token */
 363                 t=s;
 364
 365                 /* Is this a '+' or '-' followed by a space (not whitespace)? */
 366                 if ((*s=='+' || *s=='-') && *(s+1)==' ')
 367                         s+=2;
 368
 369                 /* Skip to the next space or the end of the string */
 370                 while (!isspace(* (unsigned char *) s) && *s != '\0')
 371                         s++;
 372         } else {
 373                 t=NULL;
 374         }
 375
 376         /* Have we reached the end of the string? */
 377         if (*s)
 378                 *s++='\0';
 379         else
 380                 more=0;
 381         return(t);
 382 }
 383
 384
 385 void add_exclude_line(char *p)
 386 {
 387         char *tok;
 388         if (!p || !*p) return;
 389         p = strdup(p);
 390         if (!p) out_of_memory("add_exclude_line");
 391         for (tok=get_exclude_tok(p); tok; tok=get_exclude_tok(NULL))
 392                 add_exclude(tok, 0);
 393         free(p);
 394 }
 395
 396 void add_include_line(char *p)
 397 {
 398         char *tok;
 399         if (!p || !*p) return;
 400         p = strdup(p);
 401         if (!p) out_of_memory("add_include_line");
 402         for (tok=get_exclude_tok(p); tok; tok=get_exclude_tok(NULL))
 403                 add_exclude(tok, 1);
 404         free(p);
 405 }
 406
 407
 408 static char *cvs_ignore_list[] = {
 409   "RCS/", "SCCS/", "CVS/", ".svn/", "CVS.adm", "RCSLOG", "cvslog.*",
 410   "tags", "TAGS", ".make.state", ".nse_depinfo",
 411   "*~", "#*", ".#*", ", *", "*.old", "*.bak", "*.BAK", "*.orig",
 412   "*.rej", ".del-*", "*.a", "*.o", "*.obj", "*.so", "*.Z", "*.elc", "*.ln",
 413   "core", NULL};
 414
 415
 416 void add_cvs_excludes(void)
 417 {
 418         char fname[MAXPATHLEN];
 419         char *p;
 420         int i;
 421
 422         for (i=0; cvs_ignore_list[i]; i++)
 423                 add_exclude(cvs_ignore_list[i], 0);
 424
 425         if ((p=getenv("HOME")) && strlen(p) < (MAXPATHLEN-12)) {
 426                 snprintf(fname,sizeof(fname), "%s/.cvsignore",p);
 427                 add_exclude_file(fname,0,0);
 428         }
 429
 430         add_exclude_line(getenv("CVSIGNORE"));
 431 }