usr.bin/patch/inp.c

   1 /*
   2  * $OpenBSD: inp.c,v 1.34 2006/03/11 19:41:30 otto Exp $
   3  * $DragonFly: src/usr.bin/patch/inp.c,v 1.6 2007/09/29 23:11:10 swildner Exp $
   4  * $NetBSD: inp.c,v 1.22 2009/06/05 19:55:43 joerg Exp $
   5  */
   6
   7 /*
   8  * patch - a program to apply diffs to original files
   9  *
  10  * Copyright 1986, Larry Wall
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following condition is met:
  14  * 1. Redistributions of source code must retain the above copyright notice,
  15  * this condition and the following disclaimer.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  21  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  23  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  24  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * -C option added in 1998, original code by Marc Espie, based on FreeBSD
  30  * behaviour
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __RCSID("$NetBSD: inp.c,v 1.22 2009/06/05 19:55:43 joerg Exp $");
  35
  36 #include <sys/types.h>
  37 #include <sys/file.h>
  38 #include <sys/stat.h>
  39 #include <sys/mman.h>
  40
  41 #include <ctype.h>
  42 #include <fcntl.h>
  43 #include <libgen.h>
  44 #include <limits.h>
  45 #include <stddef.h>
  46 #include <stdio.h>
  47 #include <stdlib.h>
  48 #include <string.h>
  49 #include <unistd.h>
  50
  51 #include "common.h"
  52 #include "util.h"
  53 #include "pch.h"
  54 #include "inp.h"
  55
  56
  57 /* Input-file-with-indexable-lines abstract type */
  58
  59 static off_t    i_size;         /* size of the input file */
  60 static char     *i_womp;        /* plan a buffer for entire file */
  61 static char     **i_ptr;        /* pointers to lines in i_womp */
  62 static char     empty_line[] = { '\0' };
  63
  64 static int      tifd = -1;      /* plan b virtual string array */
  65 static char     *tibuf[2];      /* plan b buffers */
  66 static LINENUM  tiline[2] = {-1, -1};   /* 1st line in each buffer */
  67 static LINENUM  lines_per_buf;  /* how many lines per buffer */
  68 static int      tireclen;       /* length of records in tmp file */
  69
  70 static bool     rev_in_string(const char *);
  71 static bool     reallocate_lines(size_t *);
  72
  73 /* returns false if insufficient memory */
  74 static bool     plan_a(const char *);
  75
  76 static void     plan_b(const char *);
  77
  78 /* New patch--prepare to edit another file. */
  79
  80 void
  81 re_input(void)
  82 {
  83         if (using_plan_a) {
  84                 i_size = 0;
  85                 free(i_ptr);
  86                 i_ptr = NULL;
  87                 if (i_womp != NULL) {
  88                         munmap(i_womp, i_size);
  89                         i_womp = NULL;
  90                 }
  91         } else {
  92                 using_plan_a = true;    /* maybe the next one is smaller */
  93                 close(tifd);
  94                 tifd = -1;
  95                 free(tibuf[0]);
  96                 free(tibuf[1]);
  97                 tibuf[0] = tibuf[1] = NULL;
  98                 tiline[0] = tiline[1] = -1;
  99                 tireclen = 0;
 100         }
 101 }
 102
 103 /* Construct the line index, somehow or other. */
 104
 105 void
 106 scan_input(const char *filename)
 107 {
 108         if (!plan_a(filename))
 109                 plan_b(filename);
 110         if (verbose) {
 111                 say("Patching file %s using Plan %s...\n", filename,
 112                     (using_plan_a ? "A" : "B"));
 113         }
 114 }
 115
 116 static bool
 117 reallocate_lines(size_t *lines_allocated)
 118 {
 119         char    **p;
 120         size_t  new_size;
 121
 122         new_size = *lines_allocated * 3 / 2;
 123         p = realloc(i_ptr, (new_size + 2) * sizeof(char *));
 124         if (p == NULL) {        /* shucks, it was a near thing */
 125                 munmap(i_womp, i_size);
 126                 i_womp = NULL;
 127                 free(i_ptr);
 128                 i_ptr = NULL;
 129                 *lines_allocated = 0;
 130                 return false;
 131         }
 132         *lines_allocated = new_size;
 133         i_ptr = p;
 134         return true;
 135 }
 136
 137 /* Try keeping everything in memory. */
 138
 139 static bool
 140 plan_a(const char *filename)
 141 {
 142         int             ifd, statfailed;
 143         char            *p, *s, lbuf[MAXLINELEN];
 144         struct stat     filestat;
 145         off_t           i;
 146         ptrdiff_t       sz;
 147         size_t          iline, lines_allocated;
 148
 149 #ifdef DEBUGGING
 150         if (debug & 8)
 151                 return false;
 152 #endif
 153
 154         if (filename == NULL || *filename == '\0')
 155                 return false;
 156
 157         statfailed = stat(filename, &filestat);
 158         if (statfailed && ok_to_create_file) {
 159                 if (verbose)
 160                         say("(Creating file %s...)\n", filename);
 161
 162                 /*
 163                  * in check_patch case, we still display `Creating file' even
 164                  * though we're not. The rule is that -C should be as similar
 165                  * to normal patch behavior as possible
 166                  */
 167                 if (check_only)
 168                         return true;
 169                 makedirs(filename, true);
 170                 close(creat(filename, 0666));
 171                 statfailed = stat(filename, &filestat);
 172         }
 173         if (statfailed && check_only)
 174                 fatal("%s not found, -C mode, can't probe further\n", filename);
 175         /* For nonexistent or read-only files, look for RCS or SCCS versions.  */
 176         if (statfailed ||
 177             /* No one can write to it.  */
 178             (filestat.st_mode & 0222) == 0 ||
 179             /* I can't write to it.  */
 180             ((filestat.st_mode & 0022) == 0 && filestat.st_uid != getuid())) {
 181                 const char      *cs = NULL, *filebase, *filedir;
 182                 struct stat     cstat;
 183                 char *tmp_filename1, *tmp_filename2;
 184
 185                 tmp_filename1 = strdup(filename);
 186                 tmp_filename2 = strdup(filename);
 187                 if (tmp_filename1 == NULL || tmp_filename2 == NULL)
 188                         fatal("strdupping filename");
 189                 filebase = basename(tmp_filename1);
 190                 filedir = dirname(tmp_filename2);
 191
 192                 /* Leave room in lbuf for the diff command.  */
 193                 s = lbuf + 20;
 194
 195 #define try(f, a1, a2, a3) \
 196         (snprintf(s, sizeof lbuf - 20, f, a1, a2, a3), stat(s, &cstat) == 0)
 197
 198                 if (try("%s/RCS/%s%s", filedir, filebase, RCSSUFFIX) ||
 199                     try("%s/RCS/%s%s", filedir, filebase, "") ||
 200                     try("%s/%s%s", filedir, filebase, RCSSUFFIX)) {
 201                         snprintf(buf, buf_len, CHECKOUT, filename);
 202                         snprintf(lbuf, sizeof lbuf, RCSDIFF, filename);
 203                         cs = "RCS";
 204                 } else if (try("%s/SCCS/%s%s", filedir, SCCSPREFIX, filebase) ||
 205                     try("%s/%s%s", filedir, SCCSPREFIX, filebase)) {
 206                         snprintf(buf, buf_len, GET, s);
 207                         snprintf(lbuf, sizeof lbuf, SCCSDIFF, s, filename);
 208                         cs = "SCCS";
 209                 } else if (statfailed)
 210                         fatal("can't find %s\n", filename);
 211
 212                 free(tmp_filename1);
 213                 free(tmp_filename2);
 214
 215                 /*
 216                  * else we can't write to it but it's not under a version
 217                  * control system, so just proceed.
 218                  */
 219                 if (cs) {
 220                         if (!statfailed) {
 221                                 if ((filestat.st_mode & 0222) != 0)
 222                                         /* The owner can write to it.  */
 223                                         fatal("file %s seems to be locked "
 224                                             "by somebody else under %s\n",
 225                                             filename, cs);
 226                                 /*
 227                                  * It might be checked out unlocked.  See if
 228                                  * it's safe to check out the default version
 229                                  * locked.
 230                                  */
 231                                 if (verbose)
 232                                         say("Comparing file %s to default "
 233                                             "%s version...\n",
 234                                             filename, cs);
 235                                 if (system(lbuf))
 236                                         fatal("can't check out file %s: "
 237                                             "differs from default %s version\n",
 238                                             filename, cs);
 239                         }
 240                         if (verbose)
 241                                 say("Checking out file %s from %s...\n",
 242                                     filename, cs);
 243                         if (system(buf) || stat(filename, &filestat))
 244                                 fatal("can't check out file %s from %s\n",
 245                                     filename, cs);
 246                 }
 247         }
 248         filemode = filestat.st_mode;
 249         if (!S_ISREG(filemode))
 250                 fatal("%s is not a normal file--can't patch\n", filename);
 251         i_size = filestat.st_size;
 252         if (out_of_mem) {
 253                 set_hunkmax();  /* make sure dynamic arrays are allocated */
 254                 out_of_mem = false;
 255                 return false;   /* force plan b because plan a bombed */
 256         }
 257         if ((uintmax_t)i_size > (uintmax_t)SIZE_MAX) {
 258                 say("block too large to mmap\n");
 259                 return false;
 260         }
 261         if ((ifd = open(filename, O_RDONLY)) < 0)
 262                 pfatal("can't open file %s", filename);
 263
 264         if (i_size) {
 265                 i_womp = mmap(NULL, i_size, PROT_READ, MAP_PRIVATE, ifd, 0);
 266                 if (i_womp == MAP_FAILED) {
 267                         perror("mmap failed");
 268                         i_womp = NULL;
 269                         close(ifd);
 270                         return false;
 271                 }
 272         } else {
 273                 i_womp = NULL;
 274         }
 275
 276         close(ifd);
 277         if (i_size)
 278                 madvise(i_womp, i_size, MADV_SEQUENTIAL);
 279
 280         /* estimate the number of lines */
 281         lines_allocated = i_size / 25;
 282         if (lines_allocated < 100)
 283                 lines_allocated = 100;
 284
 285         if (!reallocate_lines(&lines_allocated))
 286                 return false;
 287
 288         /* now scan the buffer and build pointer array */
 289         iline = 1;
 290         i_ptr[iline] = i_womp;
 291         /* test for NUL too, to maintain the behavior of the original code */
 292         for (s = i_womp, i = 0; i < i_size && *s != '\0'; s++, i++) {
 293                 if (*s == '\n') {
 294                         if (iline == lines_allocated) {
 295                                 if (!reallocate_lines(&lines_allocated))
 296                                         return false;
 297                         }
 298                         /* these are NOT NUL terminated */
 299                         i_ptr[++iline] = s + 1;
 300                 }
 301         }
 302         /* if the last line contains no EOL, append one */
 303         if (i_size > 0 && i_womp[i_size - 1] != '\n') {
 304                 last_line_missing_eol = true;
 305                 /* fix last line */
 306                 sz = s - i_ptr[iline];
 307                 p = malloc(sz + 1);
 308                 if (p == NULL) {
 309                         free(i_ptr);
 310                         i_ptr = NULL;
 311                         munmap(i_womp, i_size);
 312                         i_womp = NULL;
 313                         return false;
 314                 }
 315
 316                 memcpy(p, i_ptr[iline], sz);
 317                 p[sz] = '\n';
 318                 i_ptr[iline] = p;
 319                 /* count the extra line and make it point to some valid mem */
 320                 i_ptr[++iline] = empty_line;
 321         } else
 322                 last_line_missing_eol = false;
 323
 324         input_lines = iline - 1;
 325
 326         /* now check for revision, if any */
 327
 328         if (revision != NULL) {
 329                 if (!rev_in_string(i_womp)) {
 330                         if (force) {
 331                                 if (verbose)
 332                                         say("Warning: this file doesn't appear "
 333                                             "to be the %s version--patching anyway.\n",
 334                                             revision);
 335                         } else if (batch) {
 336                                 fatal("this file doesn't appear to be the "
 337                                     "%s version--aborting.\n",
 338                                     revision);
 339                         } else {
 340                                 ask("This file doesn't appear to be the "
 341                                     "%s version--patch anyway? [n] ",
 342                                     revision);
 343                                 if (*buf != 'y')
 344                                         fatal("aborted\n");
 345                         }
 346                 } else if (verbose)
 347                         say("Good.  This file appears to be the %s version.\n",
 348                             revision);
 349         }
 350         return true;            /* plan a will work */
 351 }
 352
 353 /* Keep (virtually) nothing in memory. */
 354
 355 static void
 356 plan_b(const char *filename)
 357 {
 358         FILE    *ifp;
 359         size_t  i = 0, j, maxlen = 1;
 360         char    *p;
 361         bool    found_revision = (revision == NULL);
 362
 363         using_plan_a = false;
 364         if ((ifp = fopen(filename, "r")) == NULL)
 365                 pfatal("can't open file %s", filename);
 366         unlink(TMPINNAME);
 367         if ((tifd = open(TMPINNAME, O_EXCL | O_CREAT | O_WRONLY, 0666)) < 0)
 368                 pfatal("can't open file %s", TMPINNAME);
 369         while (fgets(buf, buf_len, ifp) != NULL) {
 370                 if (revision != NULL && !found_revision && rev_in_string(buf))
 371                         found_revision = true;
 372                 if ((i = strlen(buf)) > maxlen)
 373                         maxlen = i;     /* find longest line */
 374         }
 375         last_line_missing_eol = i > 0 && buf[i - 1] != '\n';
 376         if (last_line_missing_eol && maxlen == i)
 377                 maxlen++;
 378
 379         if (revision != NULL) {
 380                 if (!found_revision) {
 381                         if (force) {
 382                                 if (verbose)
 383                                         say("Warning: this file doesn't appear "
 384                                             "to be the %s version--patching anyway.\n",
 385                                             revision);
 386                         } else if (batch) {
 387                                 fatal("this file doesn't appear to be the "
 388                                     "%s version--aborting.\n",
 389                                     revision);
 390                         } else {
 391                                 ask("This file doesn't appear to be the %s "
 392                                     "version--patch anyway? [n] ",
 393                                     revision);
 394                                 if (*buf != 'y')
 395                                         fatal("aborted\n");
 396                         }
 397                 } else if (verbose)
 398                         say("Good.  This file appears to be the %s version.\n",
 399                             revision);
 400         }
 401         fseek(ifp, 0L, SEEK_SET);       /* rewind file */
 402         lines_per_buf = BUFFERSIZE / maxlen;
 403         tireclen = maxlen;
 404         tibuf[0] = malloc(BUFFERSIZE + 1);
 405         if (tibuf[0] == NULL)
 406                 fatal("out of memory\n");
 407         tibuf[1] = malloc(BUFFERSIZE + 1);
 408         if (tibuf[1] == NULL)
 409                 fatal("out of memory\n");
 410         for (i = 1;; i++) {
 411                 p = tibuf[0] + maxlen * (i % lines_per_buf);
 412                 if (i % lines_per_buf == 0)     /* new block */
 413                         if (write(tifd, tibuf[0], BUFFERSIZE) < BUFFERSIZE)
 414                                 pfatal("can't write temp file");
 415                 if (fgets(p, maxlen + 1, ifp) == NULL) {
 416                         input_lines = i - 1;
 417                         if (i % lines_per_buf != 0)
 418                                 if (write(tifd, tibuf[0], BUFFERSIZE) < BUFFERSIZE)
 419                                         pfatal("can't write temp file");
 420                         break;
 421                 }
 422                 j = strlen(p);
 423                 /* These are '\n' terminated strings, so no need to add a NUL */
 424                 if (j == 0 || p[j - 1] != '\n')
 425                         p[j] = '\n';
 426         }
 427         fclose(ifp);
 428         close(tifd);
 429         if ((tifd = open(TMPINNAME, O_RDONLY)) < 0)
 430                 pfatal("can't reopen file %s", TMPINNAME);
 431 }
 432
 433 /*
 434  * Fetch a line from the input file, \n terminated, not necessarily \0.
 435  */
 436 char *
 437 ifetch(LINENUM line, int whichbuf)
 438 {
 439         if (line < 1 || line > input_lines) {
 440                 if (warn_on_invalid_line) {
 441                         say("No such line %ld in input file, ignoring\n", line);
 442                         warn_on_invalid_line = false;
 443                 }
 444                 return NULL;
 445         }
 446         if (using_plan_a)
 447                 return i_ptr[line];
 448         else {
 449                 LINENUM offline = line % lines_per_buf;
 450                 LINENUM baseline = line - offline;
 451
 452                 if (tiline[0] == baseline)
 453                         whichbuf = 0;
 454                 else if (tiline[1] == baseline)
 455                         whichbuf = 1;
 456                 else {
 457                         tiline[whichbuf] = baseline;
 458
 459                         if (lseek(tifd, (off_t) (baseline / lines_per_buf *
 460                             BUFFERSIZE), SEEK_SET) < 0)
 461                                 pfatal("cannot seek in the temporary input file");
 462
 463                         if (read(tifd, tibuf[whichbuf], BUFFERSIZE) < 0)
 464                                 pfatal("error reading tmp file %s", TMPINNAME);
 465                 }
 466                 return tibuf[whichbuf] + (tireclen * offline);
 467         }
 468 }
 469
 470 /*
 471  * True if the string argument contains the revision number we want.
 472  */
 473 static bool
 474 rev_in_string(const char *string)
 475 {
 476         const char      *s;
 477         size_t          patlen;
 478
 479         if (revision == NULL)
 480                 return true;
 481         patlen = strlen(revision);
 482         if (strnEQ(string, revision, patlen) && isspace((unsigned char)string[patlen]))
 483                 return true;
 484         for (s = string; *s; s++) {
 485                 if (isspace((unsigned char)*s) && strnEQ(s + 1, revision, patlen) &&
 486                     isspace((unsigned char)s[patlen + 1])) {
 487                         return true;
 488                 }
 489         }
 490         return false;
 491 }