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
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 /* a lot of this stuff was originally derived from GNU tar, although
  22    it has now changed so much that it is hard to tell :) */
  23
  24 /* include/exclude cluestick added by Martin Pool <mbp@samba.org> */
  25
  26 #include "rsync.h"
  27
  28 extern int verbose;
  29 extern int delete_mode;
  30
  31 static struct exclude_struct **exclude_list;
  32
  33 /* build an exclude structure given a exclude pattern */
  34 static struct exclude_struct *make_exclude(const char *pattern, int include)
  35 {
  36         struct exclude_struct *ret;
  37
  38         ret = (struct exclude_struct *)malloc(sizeof(*ret));
  39         if (!ret) out_of_memory("make_exclude");
  40
  41         memset(ret, 0, sizeof(*ret));
  42
  43         if (strncmp(pattern,"- ",2) == 0) {
  44                 pattern += 2;
  45         } else if (strncmp(pattern,"+ ",2) == 0) {
  46                 ret->include = 1;
  47                 pattern += 2;
  48         } else {
  49                 ret->include = include;
  50         }
  51
  52         ret->pattern = strdup(pattern);
  53
  54         if (!ret->pattern) out_of_memory("make_exclude");
  55
  56         if (strpbrk(pattern, "*[?")) {
  57             ret->regular_exp = 1;
  58             ret->fnmatch_flags = FNM_PATHNAME;
  59             if (strstr(pattern, "**")) {
  60                     static int tested;
  61                     if (!tested) {
  62                             tested = 1;
  63                             if (fnmatch("a/b/*", "a/b/c/d", FNM_PATHNAME)==0) {
  64                                     rprintf(FERROR,"WARNING: fnmatch FNM_PATHNAME is broken on your system\n");
  65                             }
  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         FILE *f = fopen(fname,"r");
 223         char line[MAXPATHLEN];
 224         if (!f) {
 225                 if (fatal) {
 226                         rsyserr(FERROR, errno,
 227                                 "failed to open %s file %s",
 228                                 include ? "include" : "exclude",
 229                                 fname);
 230                         exit_cleanup(RERR_FILEIO);
 231                 }
 232                 return list;
 233         }
 234
 235         while (fgets(line,MAXPATHLEN,f)) {
 236                 int l = strlen(line);
 237                 if (l && line[l-1] == '\n') l--;
 238                 line[l] = 0;
 239                 if (line[0] && (line[0] != ';') && (line[0] != '#')) {
 240                         /* Skip lines starting with semicolon or pound.
 241                            It probably wouldn't cause any harm to not skip
 242                              them but there's no need to save them. */
 243                         add_exclude_list(line,&list,include);
 244                 }
 245         }
 246         fclose(f);
 247         return list;
 248 }
 249
 250
 251 void add_exclude_file(const char *fname, int fatal, int include)
 252 {
 253         if (!fname || !*fname) return;
 254
 255         exclude_list = make_exclude_list(fname,exclude_list,fatal,include);
 256 }
 257
 258
 259 void send_exclude_list(int f)
 260 {
 261         int i;
 262         extern int remote_version;
 263         extern int list_only, recurse;
 264
 265         /* This is a complete hack - blame Rusty.
 266          *
 267          * FIXME: This pattern shows up in the output of
 268          * report_exclude_result(), which is not ideal. */
 269         if (list_only && !recurse) {
 270                 add_exclude("/*/*", 0);
 271         }
 272
 273         if (!exclude_list) {
 274                 write_int(f,0);
 275                 return;
 276         }
 277
 278         for (i=0;exclude_list[i];i++) {
 279                 int l;
 280                 char pattern[MAXPATHLEN];
 281
 282                 strlcpy(pattern,exclude_list[i]->pattern,sizeof(pattern));
 283                 if (exclude_list[i]->directory) strlcat(pattern,"/", sizeof(pattern));
 284
 285                 l = strlen(pattern);
 286                 if (l == 0) continue;
 287                 if (exclude_list[i]->include) {
 288                         if (remote_version < 19) {
 289                                 rprintf(FERROR,"remote rsync does not support include syntax - aborting\n");
 290                                 exit_cleanup(RERR_UNSUPPORTED);
 291                         }
 292                         write_int(f,l+2);
 293                         write_buf(f,"+ ",2);
 294                 } else {
 295                         write_int(f,l);
 296                 }
 297                 write_buf(f,pattern,l);
 298         }
 299
 300         write_int(f,0);
 301 }
 302
 303
 304 void recv_exclude_list(int f)
 305 {
 306         char line[MAXPATHLEN];
 307         unsigned int l;
 308
 309         while ((l=read_int(f))) {
 310                 if (l >= MAXPATHLEN) overflow("recv_exclude_list");
 311                 read_sbuf(f,line,l);
 312                 add_exclude(line,0);
 313         }
 314 }
 315
 316 /* Get the next include/exclude arg from the string. It works in a similar way
 317 ** to strtok - initially an arg is sent over, from then on NULL. This
 318 ** routine takes into account any +/- in the strings and does not
 319 ** consider the space following it as a delimeter.
 320 */
 321 char *get_exclude_tok(char *p)
 322 {
 323         static char *s;
 324         static int more;
 325         char *t;
 326
 327         if (p) {
 328                 s=p;
 329                 if (*p)
 330                         more=1;
 331         }
 332
 333         if (!more)
 334                 return(NULL);
 335
 336         /* Skip over any initial spaces */
 337         while(isspace(*s))
 338                 s++;
 339
 340         /* Are we at the end of the string? */
 341         if (*s) {
 342                 /* remember the beginning of the token */
 343                 t=s;
 344
 345                 /* Is this a '+' or '-' followed by a space (not whitespace)? */
 346                 if ((*s=='+' || *s=='-') && *(s+1)==' ')
 347                         s+=2;
 348
 349                 /* Skip to the next space or the end of the string */
 350                 while(!isspace(*s) && *s!='\0')
 351                         s++;
 352         } else {
 353                 t=NULL;
 354         }
 355
 356         /* Have we reached the end of the string? */
 357         if (*s)
 358                 *s++='\0';
 359         else
 360                 more=0;
 361         return(t);
 362 }
 363
 364
 365 void add_exclude_line(char *p)
 366 {
 367         char *tok;
 368         if (!p || !*p) return;
 369         p = strdup(p);
 370         if (!p) out_of_memory("add_exclude_line");
 371         for (tok=get_exclude_tok(p); tok; tok=get_exclude_tok(NULL))
 372                 add_exclude(tok, 0);
 373         free(p);
 374 }
 375
 376 void add_include_line(char *p)
 377 {
 378         char *tok;
 379         if (!p || !*p) return;
 380         p = strdup(p);
 381         if (!p) out_of_memory("add_include_line");
 382         for (tok=get_exclude_tok(p); tok; tok=get_exclude_tok(NULL))
 383                 add_exclude(tok, 1);
 384         free(p);
 385 }
 386
 387
 388 static char *cvs_ignore_list[] = {
 389   "RCS","SCCS","CVS","CVS.adm","RCSLOG","cvslog.*",
 390   "tags","TAGS",".make.state",".nse_depinfo",
 391   "*~", "#*", ".#*", ",*", "*.old", "*.bak", "*.BAK", "*.orig",
 392   "*.rej", ".del-*", "*.a", "*.o", "*.obj", "*.so", "*.Z", "*.elc", "*.ln",
 393   "core",NULL};
 394
 395
 396
 397 void add_cvs_excludes(void)
 398 {
 399         char fname[MAXPATHLEN];
 400         char *p;
 401         int i;
 402
 403         for (i=0; cvs_ignore_list[i]; i++)
 404                 add_exclude(cvs_ignore_list[i], 0);
 405
 406         if ((p=getenv("HOME")) && strlen(p) < (MAXPATHLEN-12)) {
 407                 snprintf(fname,sizeof(fname), "%s/.cvsignore",p);
 408                 add_exclude_file(fname,0,0);
 409         }
 410
 411         add_exclude_line(getenv("CVSIGNORE"));
 412 }