editors/patch.c

   1 /* vi: set sw=4 ts=4:
   2  *
   3  * Apply a "universal" diff.
   4  * Adapted from toybox's patch implementation.
   5  *
   6  * Copyright 2007 Rob Landley <rob@landley.net>
   7  *
   8  * see http://www.opengroup.org/onlinepubs/009695399/utilities/patch.html
   9  * (But only does -u, because who still cares about "ed"?)
  10  *
  11  * TODO:
  12  * -b backup
  13  * -l treat all whitespace as a single space
  14  * -d chdir first
  15  * -D define wrap #ifdef and #ifndef around changes
  16  * -o outfile output here instead of in place
  17  * -r rejectfile write rejected hunks to this file
  18  * --dry-run (regression!)
  19  *
  20  * -f force (no questions asked)
  21  * -F fuzz (number, default 2)
  22  * [file] which file to patch
  23  */
  24 //config:config PATCH
  25 //config:       bool "patch (9.1 kb)"
  26 //config:       default y
  27 //config:       help
  28 //config:       Apply a unified diff formatted patch.
  29
  30 //applet:IF_PATCH(APPLET(patch, BB_DIR_USR_BIN, BB_SUID_DROP))
  31
  32 //kbuild:lib-$(CONFIG_PATCH) += patch.o
  33
  34 //usage:#define patch_trivial_usage
  35 //usage:       "[OPTIONS] [ORIGFILE [PATCHFILE]]"
  36 //usage:#define patch_full_usage "\n\n"
  37 //usage:        IF_LONG_OPTS(
  38 //usage:       "        -p,--strip N            Strip N leading components from file names"
  39 //usage:     "\n        -i,--input DIFF         Read DIFF instead of stdin"
  40 //usage:     "\n        -R,--reverse            Reverse patch"
  41 //usage:     "\n        -N,--forward            Ignore already applied patches"
  42 /*usage:     "\n        --dry-run               Don't actually change files" - TODO */
  43 //usage:     "\n        -E,--remove-empty-files Remove output files if they become empty"
  44 //usage:        )
  45 //usage:        IF_NOT_LONG_OPTS(
  46 //usage:       "        -p N    Strip N leading components from file names"
  47 //usage:     "\n        -i DIFF Read DIFF instead of stdin"
  48 //usage:     "\n        -R      Reverse patch"
  49 //usage:     "\n        -N      Ignore already applied patches"
  50 //usage:     "\n        -E      Remove output files if they become empty"
  51 //usage:        )
  52 /* -u "interpret as unified diff" is supported but not documented: this info is not useful for --help */
  53 /* -x "debug" is supported but does nothing */
  54 //usage:
  55 //usage:#define patch_example_usage
  56 //usage:       "$ patch -p1 < example.diff\n"
  57 //usage:       "$ patch -p0 -i example.diff"
  58
  59 #include "libbb.h"
  60
  61
  62 // libbb candidate?
  63
  64 struct double_list {
  65         struct double_list *next;
  66         struct double_list *prev;
  67         char *data;
  68 };
  69
  70 // Free all the elements of a linked list
  71 // Call freeit() on each element before freeing it.
  72 static void dlist_free(struct double_list *list, void (*freeit)(void *data))
  73 {
  74         while (list) {
  75                 void *pop = list;
  76                 list = list->next;
  77                 freeit(pop);
  78                 // Bail out also if list is circular.
  79                 if (list == pop) break;
  80         }
  81 }
  82
  83 // Add an entry before "list" element in (circular) doubly linked list
  84 static struct double_list *dlist_add(struct double_list **list, char *data)
  85 {
  86         struct double_list *llist;
  87         struct double_list *line = xmalloc(sizeof(*line));
  88
  89         line->data = data;
  90         llist = *list;
  91         if (llist) {
  92                 struct double_list *p;
  93                 line->next = llist;
  94                 p = line->prev = llist->prev;
  95                 // (list is circular, we assume p is never NULL)
  96                 p->next = line;
  97                 llist->prev = line;
  98         } else
  99                 *list = line->next = line->prev = line;
 100
 101         return line;
 102 }
 103
 104
 105 struct globals {
 106         char *infile;
 107         long prefix;
 108
 109         struct double_list *current_hunk;
 110
 111         long oldline, oldlen, newline, newlen;
 112         long linenum;
 113         int context, state, hunknum;
 114         int filein, fileout;
 115         char *tempname;
 116
 117         int exitval;
 118 };
 119 #define TT (*ptr_to_globals)
 120 #define INIT_TT() do { \
 121         SET_PTR_TO_GLOBALS(xzalloc(sizeof(TT))); \
 122 } while (0)
 123
 124
 125 #define FLAG_STR "Rup:i:NEx"
 126 /* FLAG_REVERSE must be == 1! Code uses this fact. */
 127 #define FLAG_REVERSE (1 << 0)
 128 #define FLAG_u       (1 << 1)
 129 #define FLAG_PATHLEN (1 << 2)
 130 #define FLAG_INPUT   (1 << 3)
 131 #define FLAG_IGNORE  (1 << 4)
 132 #define FLAG_RMEMPTY (1 << 5)
 133 /* Enable this bit and use -x for debug output: */
 134 #define FLAG_DEBUG   (0 << 6)
 135
 136 // Dispose of a line of input, either by writing it out or discarding it.
 137
 138 // state < 2: just free
 139 // state = 2: write whole line to stderr
 140 // state = 3: write whole line to fileout
 141 // state > 3: write line+1 to fileout when *line != state
 142
 143 #define PATCH_DEBUG (option_mask32 & FLAG_DEBUG)
 144
 145 static void do_line(void *data)
 146 {
 147         struct double_list *dlist = data;
 148
 149         if (TT.state>1 && *dlist->data != TT.state)
 150                 fdprintf(TT.state == 2 ? 2 : TT.fileout,
 151                         "%s\n", dlist->data+(TT.state>3 ? 1 : 0));
 152
 153         if (PATCH_DEBUG) fdprintf(2, "DO %d: %s\n", TT.state, dlist->data);
 154
 155         free(dlist->data);
 156         free(dlist);
 157 }
 158
 159 static void finish_oldfile(void)
 160 {
 161         if (TT.tempname) {
 162                 // Copy the rest of the data and replace the original with the copy.
 163                 char *temp;
 164
 165                 if (TT.filein != -1) {
 166                         bb_copyfd_eof(TT.filein, TT.fileout);
 167                         xclose(TT.filein);
 168                 }
 169                 xclose(TT.fileout);
 170
 171                 temp = xstrdup(TT.tempname);
 172                 temp[strlen(temp) - 6] = '\0';
 173                 rename(TT.tempname, temp);
 174                 free(temp);
 175
 176                 free(TT.tempname);
 177                 TT.tempname = NULL;
 178         }
 179         TT.fileout = TT.filein = -1;
 180 }
 181
 182 static void fail_hunk(void)
 183 {
 184         if (!TT.current_hunk) return;
 185
 186         fdprintf(2, "Hunk %d FAILED %ld/%ld.\n", TT.hunknum, TT.oldline, TT.newline);
 187         TT.exitval = 1;
 188
 189         // If we got to this point, we've seeked to the end.  Discard changes to
 190         // this file and advance to next file.
 191
 192         TT.state = 2;
 193         TT.current_hunk->prev->next = NULL;
 194         dlist_free(TT.current_hunk, do_line);
 195         TT.current_hunk = NULL;
 196
 197         // Abort the copy and delete the temporary file.
 198         close(TT.filein);
 199         close(TT.fileout);
 200         unlink(TT.tempname);
 201         free(TT.tempname);
 202         TT.tempname = NULL;
 203
 204         TT.state = 0;
 205 }
 206
 207 // Given a hunk of a unified diff, make the appropriate change to the file.
 208 // This does not use the location information, but instead treats a hunk
 209 // as a sort of regex.  Copies data from input to output until it finds
 210 // the change to be made, then outputs the changed data and returns.
 211 // (Finding EOF first is an error.)  This is a single pass operation, so
 212 // multiple hunks must occur in order in the file.
 213
 214 static int apply_one_hunk(void)
 215 {
 216         struct double_list *plist, *buf = NULL, *check;
 217         int matcheof = 0, reverse = option_mask32 & FLAG_REVERSE, backwarn = 0;
 218         /* Do we try "dummy" revert to check whether
 219          * to silently skip this hunk? Used to implement -N.
 220          */
 221         int dummy_revert = 0;
 222
 223         // Break doubly linked list so we can use singly linked traversal function.
 224         TT.current_hunk->prev->next = NULL;
 225
 226         // Match EOF if there aren't as many ending context lines as beginning
 227         for (plist = TT.current_hunk; plist; plist = plist->next) {
 228                 if (plist->data[0]==' ') matcheof++;
 229                 else matcheof = 0;
 230                 if (PATCH_DEBUG) fdprintf(2, "HUNK:%s\n", plist->data);
 231         }
 232         matcheof = !matcheof || matcheof < TT.context;
 233
 234         if (PATCH_DEBUG) fdprintf(2,"MATCHEOF=%c\n", matcheof ? 'Y' : 'N');
 235
 236         // Loop through input data searching for this hunk.  Match all context
 237         // lines and all lines to be removed until we've found the end of a
 238         // complete hunk.
 239         plist = TT.current_hunk;
 240         buf = NULL;
 241         if (reverse ? TT.oldlen : TT.newlen) for (;;) {
 242                 char *data = xmalloc_reads(TT.filein, NULL);
 243
 244                 TT.linenum++;
 245
 246                 // Figure out which line of hunk to compare with next.  (Skip lines
 247                 // of the hunk we'd be adding.)
 248                 while (plist && *plist->data == "+-"[reverse]) {
 249                         if (data && strcmp(data, plist->data+1) == 0) {
 250                                 if (!backwarn) {
 251                                         backwarn = TT.linenum;
 252                                         if (option_mask32 & FLAG_IGNORE) {
 253                                                 dummy_revert = 1;
 254                                                 reverse ^= 1;
 255                                                 continue;
 256                                         }
 257                                 }
 258                         }
 259                         plist = plist->next;
 260                 }
 261
 262                 // Is this EOF?
 263                 if (!data) {
 264                         if (PATCH_DEBUG) fdprintf(2, "INEOF\n");
 265
 266                         // Does this hunk need to match EOF?
 267                         if (!plist && matcheof) break;
 268
 269                         if (backwarn)
 270                                 fdprintf(2,"Possibly reversed hunk %d at %ld\n",
 271                                         TT.hunknum, TT.linenum);
 272
 273                         // File ended before we found a place for this hunk.
 274                         fail_hunk();
 275                         goto done;
 276                 }
 277
 278                 if (PATCH_DEBUG) fdprintf(2, "IN: %s\n", data);
 279                 check = dlist_add(&buf, data);
 280
 281                 // Compare this line with next expected line of hunk.
 282                 // todo: teach the strcmp() to ignore whitespace.
 283
 284                 // A match can fail because the next line doesn't match, or because
 285                 // we hit the end of a hunk that needed EOF, and this isn't EOF.
 286
 287                 // If match failed, flush first line of buffered data and
 288                 // recheck buffered data for a new match until we find one or run
 289                 // out of buffer.
 290
 291                 for (;;) {
 292                         while (plist && *plist->data == "+-"[reverse]) {
 293                                 if (strcmp(check->data, plist->data+1) == 0
 294                                  && !backwarn
 295                                 ) {
 296                                         backwarn = TT.linenum;
 297                                         if (option_mask32 & FLAG_IGNORE) {
 298                                                 dummy_revert = 1;
 299                                                 reverse ^= 1;
 300                                         }
 301                                 }
 302                                 plist = plist->next;
 303                         }
 304                         if (!plist || strcmp(check->data, plist->data+1)) {
 305                                 // Match failed.  Write out first line of buffered data and
 306                                 // recheck remaining buffered data for a new match.
 307
 308                                 if (PATCH_DEBUG)
 309                                         fdprintf(2, "NOT: %s\n", plist ? plist->data : "EOF");
 310
 311                                 TT.state = 3;
 312                                 check = buf;
 313                                 buf = buf->next;
 314                                 check->prev->next = buf;
 315                                 buf->prev = check->prev;
 316                                 do_line(check);
 317                                 plist = TT.current_hunk;
 318
 319                                 // If we've reached the end of the buffer without confirming a
 320                                 // match, read more lines.
 321                                 if (check == buf) {
 322                                         buf = NULL;
 323                                         break;
 324                                 }
 325                                 check = buf;
 326                         } else {
 327                                 if (PATCH_DEBUG)
 328                                         fdprintf(2, "MAYBE: %s\n", plist->data);
 329                                 // This line matches.  Advance plist, detect successful match.
 330                                 plist = plist->next;
 331                                 if (!plist && !matcheof) goto out;
 332                                 check = check->next;
 333                                 if (check == buf) break;
 334                         }
 335                 }
 336         }
 337 out:
 338         // We have a match.  Emit changed data.
 339         TT.state = "-+"[reverse ^ dummy_revert];
 340         dlist_free(TT.current_hunk, do_line);
 341         TT.current_hunk = NULL;
 342         TT.state = 1;
 343 done:
 344         if (buf) {
 345                 buf->prev->next = NULL;
 346                 dlist_free(buf, do_line);
 347         }
 348
 349         return TT.state;
 350 }
 351
 352 // Read a patch file and find hunks, opening/creating/deleting files.
 353 // Call apply_one_hunk() on each hunk.
 354
 355 // state 0: Not in a hunk, look for +++.
 356 // state 1: Found +++ file indicator, look for @@
 357 // state 2: In hunk: counting initial context lines
 358 // state 3: In hunk: getting body
 359 // Like GNU patch, we don't require a --- line before the +++, and
 360 // also allow the --- after the +++ line.
 361
 362 int patch_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 363 int patch_main(int argc UNUSED_PARAM, char **argv)
 364 {
 365         int opts;
 366         int reverse, state = 0;
 367         char *oldname = NULL, *newname = NULL;
 368         char *opt_p, *opt_i;
 369         long oldlen = oldlen; /* for compiler */
 370         long newlen = newlen; /* for compiler */
 371
 372         INIT_TT();
 373
 374         opts = getopt32(argv, FLAG_STR, &opt_p, &opt_i);
 375         argv += optind;
 376         reverse = opts & FLAG_REVERSE;
 377         TT.prefix = (opts & FLAG_PATHLEN) ? xatoi(opt_p) : 0; // can be negative!
 378         TT.filein = TT.fileout = -1;
 379         if (opts & FLAG_INPUT) {
 380                 xmove_fd(xopen_stdin(opt_i), STDIN_FILENO);
 381         } else {
 382                 if (argv[0] && argv[1]) {
 383                         xmove_fd(xopen_stdin(argv[1]), STDIN_FILENO);
 384                 }
 385         }
 386
 387         // Loop through the lines in the patch
 388         for(;;) {
 389                 char *patchline;
 390
 391                 patchline = xmalloc_fgetline(stdin);
 392                 if (!patchline) break;
 393
 394                 // Other versions of patch accept damaged patches,
 395                 // so we need to also.
 396                 if (!*patchline) {
 397                         free(patchline);
 398                         patchline = xstrdup(" ");
 399                 }
 400
 401                 // Are we assembling a hunk?
 402                 if (state >= 2) {
 403                         if (*patchline==' ' || *patchline=='+' || *patchline=='-') {
 404                                 dlist_add(&TT.current_hunk, patchline);
 405
 406                                 if (*patchline != '+') oldlen--;
 407                                 if (*patchline != '-') newlen--;
 408
 409                                 // Context line?
 410                                 if (*patchline==' ' && state==2) TT.context++;
 411                                 else state=3;
 412
 413                                 // If we've consumed all expected hunk lines, apply the hunk.
 414
 415                                 if (!oldlen && !newlen) state = apply_one_hunk();
 416                                 continue;
 417                         }
 418                         fail_hunk();
 419                         state = 0;
 420                         continue;
 421                 }
 422
 423                 // Open a new file?
 424                 if (is_prefixed_with(patchline, "--- ") || is_prefixed_with(patchline, "+++ ")) {
 425                         char *s, **name = reverse ? &newname : &oldname;
 426                         int i;
 427
 428                         if (*patchline == '+') {
 429                                 name = reverse ? &oldname : &newname;
 430                                 state = 1;
 431                         }
 432
 433                         finish_oldfile();
 434
 435                         if (!argv[0]) {
 436                                 free(*name);
 437                                 // Trim date from end of filename (if any).  We don't care.
 438                                 for (s = patchline+4; *s && *s!='\t'; s++)
 439                                         if (*s=='\\' && s[1]) s++;
 440                                 i = atoi(s);
 441                                 if (i>1900 && i<=1970)
 442                                         *name = xstrdup("/dev/null");
 443                                 else {
 444                                         *s = 0;
 445                                         *name = xstrdup(patchline+4);
 446                                 }
 447                         }
 448
 449                         // We defer actually opening the file because svn produces broken
 450                         // patches that don't signal they want to create a new file the
 451                         // way the patch man page says, so you have to read the first hunk
 452                         // and _guess_.
 453
 454                 // Start a new hunk?  Usually @@ -oldline,oldlen +newline,newlen @@
 455                 // but a missing ,value means the value is 1.
 456                 } else if (state == 1 && is_prefixed_with(patchline, "@@ -")) {
 457                         int i;
 458                         char *s = patchline+4;
 459
 460                         // Read oldline[,oldlen] +newline[,newlen]
 461
 462                         TT.oldlen = oldlen = TT.newlen = newlen = 1;
 463                         TT.oldline = strtol(s, &s, 10);
 464                         if (*s == ',') TT.oldlen = oldlen = strtol(s+1, &s, 10);
 465                         TT.newline = strtol(s+2, &s, 10);
 466                         if (*s == ',') TT.newlen = newlen = strtol(s+1, &s, 10);
 467
 468                         if (oldlen < 1 && newlen < 1)
 469                                 bb_error_msg_and_die("Really? %s", patchline);
 470
 471                         TT.context = 0;
 472                         state = 2;
 473
 474                         // If the --- line is missing or malformed, either oldname
 475                         // or (for -R) newname could be NULL -- but not both.  Like
 476                         // GNU patch, proceed based on the +++ line, and avoid SEGVs.
 477                         if (!oldname)
 478                                 oldname = xstrdup("MISSING_FILENAME");
 479                         if (!newname)
 480                                 newname = xstrdup("MISSING_FILENAME");
 481
 482                         // If this is the first hunk, open the file.
 483                         if (TT.filein == -1) {
 484                                 int oldsum, newsum, empty = 0;
 485                                 char *name;
 486
 487                                 oldsum = TT.oldline + oldlen;
 488                                 newsum = TT.newline + newlen;
 489
 490                                 name = reverse ? oldname : newname;
 491
 492                                 // We're deleting oldname if new file is /dev/null (before -p)
 493                                 // or if new hunk is empty (zero context) after patching
 494                                 if (strcmp(name, "/dev/null") == 0 || !(reverse ? oldsum : newsum)) {
 495                                         name = reverse ? newname : oldname;
 496                                         empty = 1;
 497                                 }
 498
 499                                 // Handle -p path truncation.
 500                                 for (i = 0, s = name; *s;) {
 501                                         if ((option_mask32 & FLAG_PATHLEN) && TT.prefix == i)
 502                                                 break;
 503                                         if (*s++ != '/')
 504                                                 continue;
 505                                         while (*s == '/')
 506                                                 s++;
 507                                         i++;
 508                                         name = s;
 509                                 }
 510                                 // If "patch FILE_TO_PATCH", completely ignore name from patch
 511                                 if (argv[0])
 512                                         name = argv[0];
 513
 514                                 if (empty) {
 515                                         // File is empty after the patches have been applied
 516                                         state = 0;
 517                                         if (option_mask32 & FLAG_RMEMPTY) {
 518                                                 // If flag -E or --remove-empty-files is set
 519                                                 printf("removing %s\n", name);
 520                                                 xunlink(name);
 521                                         } else {
 522                                                 printf("patching file %s\n", name);
 523                                                 xclose(xopen(name, O_WRONLY | O_TRUNC));
 524                                         }
 525                                 // If we've got a file to open, do so.
 526                                 } else if (!(option_mask32 & FLAG_PATHLEN) || i <= TT.prefix) {
 527                                         struct stat statbuf;
 528
 529                                         // If the old file was null, we're creating a new one.
 530                                         if (strcmp(oldname, "/dev/null") == 0 || !oldsum) {
 531                                                 printf("creating %s\n", name);
 532                                                 s = strrchr(name, '/');
 533                                                 if (s) {
 534                                                         *s = 0;
 535                                                         bb_make_directory(name, -1, FILEUTILS_RECUR);
 536                                                         *s = '/';
 537                                                 }
 538                                                 TT.filein = xopen(name, O_CREAT|O_EXCL|O_RDWR);
 539                                         } else {
 540                                                 printf("patching file %s\n", name);
 541                                                 TT.filein = xopen(name, O_RDONLY);
 542                                         }
 543
 544                                         TT.tempname = xasprintf("%sXXXXXX", name);
 545                                         TT.fileout = xmkstemp(TT.tempname);
 546                                         // Set permissions of output file
 547                                         fstat(TT.filein, &statbuf);
 548                                         fchmod(TT.fileout, statbuf.st_mode);
 549
 550                                         TT.linenum = 0;
 551                                         TT.hunknum = 0;
 552                                 }
 553                         }
 554
 555                         TT.hunknum++;
 556
 557                         continue;
 558                 }
 559
 560                 // If we didn't continue above, discard this line.
 561                 free(patchline);
 562         }
 563
 564         finish_oldfile();
 565
 566         if (ENABLE_FEATURE_CLEAN_UP) {
 567                 free(oldname);
 568                 free(newname);
 569         }
 570
 571         return TT.exitval;
 572 }