usr.bin/grep/util.c

   1 /*      $NetBSD: util.c,v 1.9 2011/02/27 17:33:37 joerg Exp $   */
   2 /*      $FreeBSD$       */
   3 /*      $OpenBSD: util.c,v 1.39 2010/07/02 22:18:03 tedu Exp $  */
   4
   5 /*-
   6  * Copyright (c) 1999 James Howard and Dag-Erling Coïdan Smørgrav
   7  * Copyright (C) 2008-2010 Gabor Kovesdan <gabor@FreeBSD.org>
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #include <sys/cdefs.h>
  33 __FBSDID("$FreeBSD$");
  34
  35 #include <sys/stat.h>
  36 #include <sys/types.h>
  37
  38 #include <ctype.h>
  39 #include <err.h>
  40 #include <errno.h>
  41 #include <fnmatch.h>
  42 #include <fts.h>
  43 #include <libgen.h>
  44 #include <stdbool.h>
  45 #include <stdio.h>
  46 #include <stdlib.h>
  47 #include <string.h>
  48 #include <unistd.h>
  49 #include <wchar.h>
  50 #include <wctype.h>
  51
  52 #include "fastmatch.h"
  53 #include "grep.h"
  54
  55 static int       linesqueued;
  56 static int       procline(struct str *l, int);
  57
  58 bool
  59 file_matching(const char *fname)
  60 {
  61         char *fname_base;
  62         bool ret;
  63
  64         ret = finclude ? false : true;
  65         fname_base = basename(fname);
  66
  67         for (unsigned int i = 0; i < fpatterns; ++i) {
  68                 if (fnmatch(fpattern[i].pat, fname, 0) == 0 ||
  69                     fnmatch(fpattern[i].pat, fname_base, 0) == 0) {
  70                         if (fpattern[i].mode == EXCL_PAT)
  71                                 return (false);
  72                         else
  73                                 ret = true;
  74                 }
  75         }
  76         return (ret);
  77 }
  78
  79 static inline bool
  80 dir_matching(const char *dname)
  81 {
  82         bool ret;
  83
  84         ret = dinclude ? false : true;
  85
  86         for (unsigned int i = 0; i < dpatterns; ++i) {
  87                 if (dname != NULL &&
  88                     fnmatch(dpattern[i].pat, dname, 0) == 0) {
  89                         if (dpattern[i].mode == EXCL_PAT)
  90                                 return (false);
  91                         else
  92                                 ret = true;
  93                 }
  94         }
  95         return (ret);
  96 }
  97
  98 /*
  99  * Processes a directory when a recursive search is performed with
 100  * the -R option.  Each appropriate file is passed to procfile().
 101  */
 102 int
 103 grep_tree(char **argv)
 104 {
 105         FTS *fts;
 106         FTSENT *p;
 107         int c, fts_flags;
 108         bool ok;
 109
 110         c = fts_flags = 0;
 111
 112         switch(linkbehave) {
 113         case LINK_EXPLICIT:
 114                 fts_flags = FTS_COMFOLLOW;
 115                 break;
 116         case LINK_SKIP:
 117                 fts_flags = FTS_PHYSICAL;
 118                 break;
 119         default:
 120                 fts_flags = FTS_LOGICAL;
 121
 122         }
 123
 124         fts_flags |= FTS_NOSTAT | FTS_NOCHDIR;
 125
 126         if (!(fts = fts_open(argv, fts_flags, NULL)))
 127                 err(2, "fts_open");
 128         while ((p = fts_read(fts)) != NULL) {
 129                 switch (p->fts_info) {
 130                 case FTS_DNR:
 131                         /* FALLTHROUGH */
 132                 case FTS_ERR:
 133                         notfound = true;
 134                         if(!sflag)
 135                                 warnx("%s: %s", p->fts_path, strerror(p->fts_errno));
 136                         break;
 137                 case FTS_D:
 138                         /* FALLTHROUGH */
 139                 case FTS_DP:
 140                         if (dexclude || dinclude)
 141                                 if (!dir_matching(p->fts_name) ||
 142                                     !dir_matching(p->fts_path))
 143                                         fts_set(fts, p, FTS_SKIP);
 144                         break;
 145                 case FTS_DC:
 146                         /* Print a warning for recursive directory loop */
 147                         warnx("warning: %s: recursive directory loop",
 148                                 p->fts_path);
 149                         break;
 150                 default:
 151                         /* Check for file exclusion/inclusion */
 152                         ok = true;
 153                         if (fexclude || finclude)
 154                                 ok &= file_matching(p->fts_path);
 155
 156                         if (ok)
 157                                 c += procfile(p->fts_path);
 158                         break;
 159                 }
 160         }
 161
 162         fts_close(fts);
 163         return (c);
 164 }
 165
 166 /*
 167  * Opens a file and processes it.  Each file is processed line-by-line
 168  * passing the lines to procline().
 169  */
 170 int
 171 procfile(const char *fn)
 172 {
 173         struct file *f;
 174         struct stat sb;
 175         struct str ln;
 176         mode_t s;
 177         int c, t;
 178
 179         if (mflag && (mcount <= 0))
 180                 return (0);
 181
 182         if (strcmp(fn, "-") == 0) {
 183                 fn = label != NULL ? label : getstr(1);
 184                 f = grep_open(NULL);
 185         } else {
 186                 if (!stat(fn, &sb)) {
 187                         /* Check if we need to process the file */
 188                         s = sb.st_mode & S_IFMT;
 189                         if (s == S_IFDIR && dirbehave == DIR_SKIP)
 190                                 return (0);
 191                         if ((s == S_IFIFO || s == S_IFCHR || s == S_IFBLK
 192                                 || s == S_IFSOCK) && devbehave == DEV_SKIP)
 193                                         return (0);
 194                 }
 195                 f = grep_open(fn);
 196         }
 197         if (f == NULL) {
 198                 if (!sflag)
 199                         warn("%s", fn);
 200                 if (errno == ENOENT)
 201                         notfound = true;
 202                 return (0);
 203         }
 204
 205         ln.file = grep_malloc(strlen(fn) + 1);
 206         strcpy(ln.file, fn);
 207         ln.line_no = 0;
 208         ln.len = 0;
 209         linesqueued = 0;
 210         tail = 0;
 211         ln.off = -1;
 212
 213         for (c = 0;  c == 0 || !(lflag || qflag); ) {
 214                 ln.off += ln.len + 1;
 215                 if ((ln.dat = grep_fgetln(f, &ln.len)) == NULL || ln.len == 0) {
 216                         if (ln.line_no == 0 && matchall)
 217                                 exit(0);
 218                         else
 219                                 break;
 220                 }
 221                 if (ln.len > 0 && ln.dat[ln.len - 1] == '\n')
 222                         --ln.len;
 223                 ln.line_no++;
 224
 225                 /* Return if we need to skip a binary file */
 226                 if (f->binary && binbehave == BINFILE_SKIP) {
 227                         grep_close(f);
 228                         free(ln.file);
 229                         free(f);
 230                         return (0);
 231                 }
 232                 /* Process the file line-by-line */
 233                 if ((t = procline(&ln, f->binary)) == 0 && Bflag > 0) {
 234                         enqueue(&ln);
 235                         linesqueued++;
 236                 }
 237                 c += t;
 238                 if (mflag && mcount <= 0)
 239                         break;
 240         }
 241         if (Bflag > 0)
 242                 clearqueue();
 243         grep_close(f);
 244
 245         if (cflag) {
 246                 if (!hflag)
 247                         printf("%s:", ln.file);
 248                 printf("%u\n", c);
 249         }
 250         if (lflag && !qflag && c != 0)
 251                 printf("%s%c", fn, nullflag ? 0 : '\n');
 252         if (Lflag && !qflag && c == 0)
 253                 printf("%s%c", fn, nullflag ? 0 : '\n');
 254         if (c && !cflag && !lflag && !Lflag &&
 255             binbehave == BINFILE_BIN && f->binary && !qflag)
 256                 printf(getstr(8), fn);
 257
 258         free(ln.file);
 259         free(f);
 260         return (c);
 261 }
 262
 263 #define iswword(x)      (iswalnum((x)) || (x) == L'_')
 264
 265 /*
 266  * Processes a line comparing it with the specified patterns.  Each pattern
 267  * is looped to be compared along with the full string, saving each and every
 268  * match, which is necessary to colorize the output and to count the
 269  * matches.  The matching lines are passed to printline() to display the
 270  * appropriate output.
 271  */
 272 static int
 273 procline(struct str *l, int nottext)
 274 {
 275         regmatch_t matches[MAX_LINE_MATCHES];
 276         regmatch_t pmatch;
 277         size_t st = 0;
 278         unsigned int i;
 279         int c = 0, m = 0, r = 0;
 280
 281         /* Loop to process the whole line */
 282         while (st <= l->len) {
 283                 pmatch.rm_so = st;
 284                 pmatch.rm_eo = l->len;
 285
 286                 /* Loop to compare with all the patterns */
 287                 for (i = 0; i < patterns; i++) {
 288                         if (fg_pattern[i].pattern)
 289                                 r = fastexec(&fg_pattern[i],
 290                                     l->dat, 1, &pmatch, eflags);
 291                         else
 292                                 r = regexec(&r_pattern[i], l->dat, 1,
 293                                     &pmatch, eflags);
 294                         r = (r == 0) ? 0 : REG_NOMATCH;
 295                         st = (cflags & REG_NOSUB)
 296                                 ? (size_t)l->len
 297                                 : (size_t)pmatch.rm_eo;
 298                         if (r == REG_NOMATCH)
 299                                 continue;
 300                         /* Check for full match */
 301                         if (r == 0 && xflag)
 302                                 if (pmatch.rm_so != 0 ||
 303                                     (size_t)pmatch.rm_eo != l->len)
 304                                         r = REG_NOMATCH;
 305                         /* Check for whole word match */
 306                         if (r == 0 && (wflag || fg_pattern[i].word)) {
 307                                 wint_t wbegin, wend;
 308
 309                                 wbegin = wend = L' ';
 310                                 if (pmatch.rm_so != 0 &&
 311                                     sscanf(&l->dat[pmatch.rm_so - 1],
 312                                     "%lc", &wbegin) != 1)
 313                                         r = REG_NOMATCH;
 314                                 else if ((size_t)pmatch.rm_eo !=
 315                                     l->len &&
 316                                     sscanf(&l->dat[pmatch.rm_eo],
 317                                     "%lc", &wend) != 1)
 318                                         r = REG_NOMATCH;
 319                                 else if (iswword(wbegin) ||
 320                                     iswword(wend))
 321                                         r = REG_NOMATCH;
 322                         }
 323                         if (r == 0) {
 324                                 if (m == 0)
 325                                         c++;
 326                                 if (m < MAX_LINE_MATCHES)
 327                                         matches[m++] = pmatch;
 328                                 /* matches - skip further patterns */
 329                                 if ((color == NULL && !oflag) ||
 330                                     qflag || lflag)
 331                                         break;
 332                         }
 333                 }
 334
 335                 if (vflag) {
 336                         c = !c;
 337                         break;
 338                 }
 339
 340                 /* One pass if we are not recording matches */
 341                 if ((color == NULL && !oflag) || qflag || lflag)
 342                         break;
 343
 344                 if (st == (size_t)pmatch.rm_so)
 345                         break;  /* No matches */
 346         }
 347
 348
 349         /* Count the matches if we have a match limit */
 350         if (mflag)
 351                 mcount -= c;
 352
 353         if (c && binbehave == BINFILE_BIN && nottext)
 354                 return (c); /* Binary file */
 355
 356         /* Dealing with the context */
 357         if ((tail || c) && !cflag && !qflag && !lflag && !Lflag) {
 358                 if (c) {
 359                         if (!first && !prev && !tail && Aflag)
 360                                 printf("--\n");
 361                         tail = Aflag;
 362                         if (Bflag > 0) {
 363                                 if (!first && !prev)
 364                                         printf("--\n");
 365                                 printqueue();
 366                         }
 367                         linesqueued = 0;
 368                         printline(l, ':', matches, m);
 369                 } else {
 370                         printline(l, '-', matches, m);
 371                         tail--;
 372                 }
 373         }
 374
 375         if (c) {
 376                 prev = true;
 377                 first = false;
 378         } else
 379                 prev = false;
 380
 381         return (c);
 382 }
 383
 384 /*
 385  * Safe malloc() for internal use.
 386  */
 387 void *
 388 grep_malloc(size_t size)
 389 {
 390         void *ptr;
 391
 392         if ((ptr = malloc(size)) == NULL)
 393                 err(2, "malloc");
 394         return (ptr);
 395 }
 396
 397 /*
 398  * Safe calloc() for internal use.
 399  */
 400 void *
 401 grep_calloc(size_t nmemb, size_t size)
 402 {
 403         void *ptr;
 404
 405         if ((ptr = calloc(nmemb, size)) == NULL)
 406                 err(2, "calloc");
 407         return (ptr);
 408 }
 409
 410 /*
 411  * Safe realloc() for internal use.
 412  */
 413 void *
 414 grep_realloc(void *ptr, size_t size)
 415 {
 416
 417         if ((ptr = realloc(ptr, size)) == NULL)
 418                 err(2, "realloc");
 419         return (ptr);
 420 }
 421
 422 /*
 423  * Safe strdup() for internal use.
 424  */
 425 char *
 426 grep_strdup(const char *str)
 427 {
 428         char *ret;
 429
 430         if ((ret = strdup(str)) == NULL)
 431                 err(2, "strdup");
 432         return (ret);
 433 }
 434
 435 /*
 436  * Prints a matching line according to the command line options.
 437  */
 438 void
 439 printline(struct str *line, int sep, regmatch_t *matches, int m)
 440 {
 441         size_t a = 0;
 442         int i, n = 0;
 443
 444         if (!hflag) {
 445                 if (!nullflag) {
 446                         fputs(line->file, stdout);
 447                         ++n;
 448                 } else {
 449                         printf("%s", line->file);
 450                         putchar(0);
 451                 }
 452         }
 453         if (nflag) {
 454                 if (n > 0)
 455                         putchar(sep);
 456                 printf("%d", line->line_no);
 457                 ++n;
 458         }
 459         if (bflag) {
 460                 if (n > 0)
 461                         putchar(sep);
 462                 printf("%lld", (long long)line->off);
 463                 ++n;
 464         }
 465         if (n)
 466                 putchar(sep);
 467         /* --color and -o */
 468         if ((oflag || color) && m > 0) {
 469                 for (i = 0; i < m; i++) {
 470                         if (!oflag)
 471                                 fwrite(line->dat + a, matches[i].rm_so - a, 1,
 472                                     stdout);
 473                         if (color)
 474                                 fprintf(stdout, "\33[%sm\33[K", color);
 475
 476                                 fwrite(line->dat + matches[i].rm_so,
 477                                     matches[i].rm_eo - matches[i].rm_so, 1,
 478                                     stdout);
 479                         if (color)
 480                                 fprintf(stdout, "\33[m\33[K");
 481                         a = matches[i].rm_eo;
 482                         if (oflag)
 483                                 putchar('\n');
 484                 }
 485                 if (!oflag) {
 486                         if (line->len - a > 0)
 487                                 fwrite(line->dat + a, line->len - a, 1, stdout);
 488                         putchar('\n');
 489                 }
 490         } else {
 491                 fwrite(line->dat, line->len, 1, stdout);
 492                 putchar('\n');
 493         }
 494 }