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