make "git unpack-file" a built-in
[git] / rerere.c
1 #include "cache.h"
2 #include "string-list.h"
3 #include "rerere.h"
4 #include "xdiff-interface.h"
5 #include "dir.h"
6 #include "resolve-undo.h"
7 #include "ll-merge.h"
8 #include "attr.h"
9
10 /* if rerere_enabled == -1, fall back to detection of .git/rr-cache */
11 static int rerere_enabled = -1;
12
13 /* automatically update cleanly resolved paths to the index */
14 static int rerere_autoupdate;
15
16 static char *merge_rr_path;
17
18 const char *rerere_path(const char *hex, const char *file)
19 {
20         return git_path("rr-cache/%s/%s", hex, file);
21 }
22
23 int has_rerere_resolution(const char *hex)
24 {
25         struct stat st;
26         return !stat(rerere_path(hex, "postimage"), &st);
27 }
28
29 static void read_rr(struct string_list *rr)
30 {
31         unsigned char sha1[20];
32         char buf[PATH_MAX];
33         FILE *in = fopen(merge_rr_path, "r");
34         if (!in)
35                 return;
36         while (fread(buf, 40, 1, in) == 1) {
37                 int i;
38                 char *name;
39                 if (get_sha1_hex(buf, sha1))
40                         die("corrupt MERGE_RR");
41                 buf[40] = '\0';
42                 name = xstrdup(buf);
43                 if (fgetc(in) != '\t')
44                         die("corrupt MERGE_RR");
45                 for (i = 0; i < sizeof(buf) && (buf[i] = fgetc(in)); i++)
46                         ; /* do nothing */
47                 if (i == sizeof(buf))
48                         die("filename too long");
49                 string_list_insert(buf, rr)->util = name;
50         }
51         fclose(in);
52 }
53
54 static struct lock_file write_lock;
55
56 static int write_rr(struct string_list *rr, int out_fd)
57 {
58         int i;
59         for (i = 0; i < rr->nr; i++) {
60                 const char *path;
61                 int length;
62                 if (!rr->items[i].util)
63                         continue;
64                 path = rr->items[i].string;
65                 length = strlen(path) + 1;
66                 if (write_in_full(out_fd, rr->items[i].util, 40) != 40 ||
67                     write_str_in_full(out_fd, "\t") != 1 ||
68                     write_in_full(out_fd, path, length) != length)
69                         die("unable to write rerere record");
70         }
71         if (commit_lock_file(&write_lock) != 0)
72                 die("unable to write rerere record");
73         return 0;
74 }
75
76 static void ferr_write(const void *p, size_t count, FILE *fp, int *err)
77 {
78         if (!count || *err)
79                 return;
80         if (fwrite(p, count, 1, fp) != 1)
81                 *err = errno;
82 }
83
84 static inline void ferr_puts(const char *s, FILE *fp, int *err)
85 {
86         ferr_write(s, strlen(s), fp, err);
87 }
88
89 struct rerere_io {
90         int (*getline)(struct strbuf *, struct rerere_io *);
91         FILE *output;
92         int wrerror;
93         /* some more stuff */
94 };
95
96 static void rerere_io_putstr(const char *str, struct rerere_io *io)
97 {
98         if (io->output)
99                 ferr_puts(str, io->output, &io->wrerror);
100 }
101
102 static void rerere_io_putconflict(int ch, int size, struct rerere_io *io)
103 {
104         char buf[64];
105
106         while (size) {
107                 if (size < sizeof(buf) - 2) {
108                         memset(buf, ch, size);
109                         buf[size] = '\n';
110                         buf[size + 1] = '\0';
111                         size = 0;
112                 } else {
113                         int sz = sizeof(buf) - 1;
114                         if (size <= sz)
115                                 sz -= (sz - size) + 1;
116                         memset(buf, ch, sz);
117                         buf[sz] = '\0';
118                         size -= sz;
119                 }
120                 rerere_io_putstr(buf, io);
121         }
122 }
123
124 static void rerere_io_putmem(const char *mem, size_t sz, struct rerere_io *io)
125 {
126         if (io->output)
127                 ferr_write(mem, sz, io->output, &io->wrerror);
128 }
129
130 struct rerere_io_file {
131         struct rerere_io io;
132         FILE *input;
133 };
134
135 static int rerere_file_getline(struct strbuf *sb, struct rerere_io *io_)
136 {
137         struct rerere_io_file *io = (struct rerere_io_file *)io_;
138         return strbuf_getwholeline(sb, io->input, '\n');
139 }
140
141 static int is_cmarker(char *buf, int marker_char, int marker_size, int want_sp)
142 {
143         while (marker_size--)
144                 if (*buf++ != marker_char)
145                         return 0;
146         if (want_sp && *buf != ' ')
147                 return 0;
148         return isspace(*buf);
149 }
150
151 static int handle_path(unsigned char *sha1, struct rerere_io *io, int marker_size)
152 {
153         git_SHA_CTX ctx;
154         int hunk_no = 0;
155         enum {
156                 RR_CONTEXT = 0, RR_SIDE_1, RR_SIDE_2, RR_ORIGINAL,
157         } hunk = RR_CONTEXT;
158         struct strbuf one = STRBUF_INIT, two = STRBUF_INIT;
159         struct strbuf buf = STRBUF_INIT;
160
161         if (sha1)
162                 git_SHA1_Init(&ctx);
163
164         while (!io->getline(&buf, io)) {
165                 if (is_cmarker(buf.buf, '<', marker_size, 1)) {
166                         if (hunk != RR_CONTEXT)
167                                 goto bad;
168                         hunk = RR_SIDE_1;
169                 } else if (is_cmarker(buf.buf, '|', marker_size, 0)) {
170                         if (hunk != RR_SIDE_1)
171                                 goto bad;
172                         hunk = RR_ORIGINAL;
173                 } else if (is_cmarker(buf.buf, '=', marker_size, 0)) {
174                         if (hunk != RR_SIDE_1 && hunk != RR_ORIGINAL)
175                                 goto bad;
176                         hunk = RR_SIDE_2;
177                 } else if (is_cmarker(buf.buf, '>', marker_size, 1)) {
178                         if (hunk != RR_SIDE_2)
179                                 goto bad;
180                         if (strbuf_cmp(&one, &two) > 0)
181                                 strbuf_swap(&one, &two);
182                         hunk_no++;
183                         hunk = RR_CONTEXT;
184                         rerere_io_putconflict('<', marker_size, io);
185                         rerere_io_putmem(one.buf, one.len, io);
186                         rerere_io_putconflict('=', marker_size, io);
187                         rerere_io_putmem(two.buf, two.len, io);
188                         rerere_io_putconflict('>', marker_size, io);
189                         if (sha1) {
190                                 git_SHA1_Update(&ctx, one.buf ? one.buf : "",
191                                             one.len + 1);
192                                 git_SHA1_Update(&ctx, two.buf ? two.buf : "",
193                                             two.len + 1);
194                         }
195                         strbuf_reset(&one);
196                         strbuf_reset(&two);
197                 } else if (hunk == RR_SIDE_1)
198                         strbuf_addstr(&one, buf.buf);
199                 else if (hunk == RR_ORIGINAL)
200                         ; /* discard */
201                 else if (hunk == RR_SIDE_2)
202                         strbuf_addstr(&two, buf.buf);
203                 else
204                         rerere_io_putstr(buf.buf, io);
205                 continue;
206         bad:
207                 hunk = 99; /* force error exit */
208                 break;
209         }
210         strbuf_release(&one);
211         strbuf_release(&two);
212         strbuf_release(&buf);
213
214         if (sha1)
215                 git_SHA1_Final(sha1, &ctx);
216         if (hunk != RR_CONTEXT)
217                 return -1;
218         return hunk_no;
219 }
220
221 static int handle_file(const char *path, unsigned char *sha1, const char *output)
222 {
223         int hunk_no = 0;
224         struct rerere_io_file io;
225         int marker_size = ll_merge_marker_size(path);
226
227         memset(&io, 0, sizeof(io));
228         io.io.getline = rerere_file_getline;
229         io.input = fopen(path, "r");
230         io.io.wrerror = 0;
231         if (!io.input)
232                 return error("Could not open %s", path);
233
234         if (output) {
235                 io.io.output = fopen(output, "w");
236                 if (!io.io.output) {
237                         fclose(io.input);
238                         return error("Could not write %s", output);
239                 }
240         }
241
242         hunk_no = handle_path(sha1, (struct rerere_io *)&io, marker_size);
243
244         fclose(io.input);
245         if (io.io.wrerror)
246                 error("There were errors while writing %s (%s)",
247                       path, strerror(io.io.wrerror));
248         if (io.io.output && fclose(io.io.output))
249                 io.io.wrerror = error("Failed to flush %s: %s",
250                                       path, strerror(errno));
251
252         if (hunk_no < 0) {
253                 if (output)
254                         unlink_or_warn(output);
255                 return error("Could not parse conflict hunks in %s", path);
256         }
257         if (io.io.wrerror)
258                 return -1;
259         return hunk_no;
260 }
261
262 struct rerere_io_mem {
263         struct rerere_io io;
264         struct strbuf input;
265 };
266
267 static int rerere_mem_getline(struct strbuf *sb, struct rerere_io *io_)
268 {
269         struct rerere_io_mem *io = (struct rerere_io_mem *)io_;
270         char *ep;
271         size_t len;
272
273         strbuf_release(sb);
274         if (!io->input.len)
275                 return -1;
276         ep = strchrnul(io->input.buf, '\n');
277         if (*ep == '\n')
278                 ep++;
279         len = ep - io->input.buf;
280         strbuf_add(sb, io->input.buf, len);
281         strbuf_remove(&io->input, 0, len);
282         return 0;
283 }
284
285 static int handle_cache(const char *path, unsigned char *sha1, const char *output)
286 {
287         mmfile_t mmfile[3];
288         mmbuffer_t result = {NULL, 0};
289         struct cache_entry *ce;
290         int pos, len, i, hunk_no;
291         struct rerere_io_mem io;
292         int marker_size = ll_merge_marker_size(path);
293
294         /*
295          * Reproduce the conflicted merge in-core
296          */
297         len = strlen(path);
298         pos = cache_name_pos(path, len);
299         if (0 <= pos)
300                 return -1;
301         pos = -pos - 1;
302
303         for (i = 0; i < 3; i++) {
304                 enum object_type type;
305                 unsigned long size;
306
307                 mmfile[i].size = 0;
308                 mmfile[i].ptr = NULL;
309                 if (active_nr <= pos)
310                         break;
311                 ce = active_cache[pos++];
312                 if (ce_namelen(ce) != len || memcmp(ce->name, path, len)
313                     || ce_stage(ce) != i + 1)
314                         break;
315                 mmfile[i].ptr = read_sha1_file(ce->sha1, &type, &size);
316                 mmfile[i].size = size;
317         }
318         for (i = 0; i < 3; i++) {
319                 if (!mmfile[i].ptr && !mmfile[i].size)
320                         mmfile[i].ptr = xstrdup("");
321         }
322         ll_merge(&result, path, &mmfile[0],
323                  &mmfile[1], "ours",
324                  &mmfile[2], "theirs", 0);
325         for (i = 0; i < 3; i++)
326                 free(mmfile[i].ptr);
327
328         memset(&io, 0, sizeof(&io));
329         io.io.getline = rerere_mem_getline;
330         if (output)
331                 io.io.output = fopen(output, "w");
332         else
333                 io.io.output = NULL;
334         strbuf_init(&io.input, 0);
335         strbuf_attach(&io.input, result.ptr, result.size, result.size);
336
337         hunk_no = handle_path(sha1, (struct rerere_io *)&io, marker_size);
338         strbuf_release(&io.input);
339         if (io.io.output)
340                 fclose(io.io.output);
341         return hunk_no;
342 }
343
344 static int find_conflict(struct string_list *conflict)
345 {
346         int i;
347         if (read_cache() < 0)
348                 return error("Could not read index");
349         for (i = 0; i+1 < active_nr; i++) {
350                 struct cache_entry *e2 = active_cache[i];
351                 struct cache_entry *e3 = active_cache[i+1];
352                 if (ce_stage(e2) == 2 &&
353                     ce_stage(e3) == 3 &&
354                     ce_same_name(e2, e3) &&
355                     S_ISREG(e2->ce_mode) &&
356                     S_ISREG(e3->ce_mode)) {
357                         string_list_insert((const char *)e2->name, conflict);
358                         i++; /* skip over both #2 and #3 */
359                 }
360         }
361         return 0;
362 }
363
364 static int merge(const char *name, const char *path)
365 {
366         int ret;
367         mmfile_t cur, base, other;
368         mmbuffer_t result = {NULL, 0};
369
370         if (handle_file(path, NULL, rerere_path(name, "thisimage")) < 0)
371                 return 1;
372
373         if (read_mmfile(&cur, rerere_path(name, "thisimage")) ||
374                         read_mmfile(&base, rerere_path(name, "preimage")) ||
375                         read_mmfile(&other, rerere_path(name, "postimage")))
376                 return 1;
377         ret = ll_merge(&result, path, &base, &cur, "", &other, "", 0);
378         if (!ret) {
379                 FILE *f = fopen(path, "w");
380                 if (!f)
381                         return error("Could not open %s: %s", path,
382                                      strerror(errno));
383                 if (fwrite(result.ptr, result.size, 1, f) != 1)
384                         error("Could not write %s: %s", path, strerror(errno));
385                 if (fclose(f))
386                         return error("Writing %s failed: %s", path,
387                                      strerror(errno));
388         }
389
390         free(cur.ptr);
391         free(base.ptr);
392         free(other.ptr);
393         free(result.ptr);
394
395         return ret;
396 }
397
398 static struct lock_file index_lock;
399
400 static int update_paths(struct string_list *update)
401 {
402         int i;
403         int fd = hold_locked_index(&index_lock, 0);
404         int status = 0;
405
406         if (fd < 0)
407                 return -1;
408
409         for (i = 0; i < update->nr; i++) {
410                 struct string_list_item *item = &update->items[i];
411                 if (add_file_to_cache(item->string, ADD_CACHE_IGNORE_ERRORS))
412                         status = -1;
413         }
414
415         if (!status && active_cache_changed) {
416                 if (write_cache(fd, active_cache, active_nr) ||
417                     commit_locked_index(&index_lock))
418                         die("Unable to write new index file");
419         } else if (fd >= 0)
420                 rollback_lock_file(&index_lock);
421         return status;
422 }
423
424 static int do_plain_rerere(struct string_list *rr, int fd)
425 {
426         struct string_list conflict = { NULL, 0, 0, 1 };
427         struct string_list update = { NULL, 0, 0, 1 };
428         int i;
429
430         find_conflict(&conflict);
431
432         /*
433          * MERGE_RR records paths with conflicts immediately after merge
434          * failed.  Some of the conflicted paths might have been hand resolved
435          * in the working tree since then, but the initial run would catch all
436          * and register their preimages.
437          */
438
439         for (i = 0; i < conflict.nr; i++) {
440                 const char *path = conflict.items[i].string;
441                 if (!string_list_has_string(rr, path)) {
442                         unsigned char sha1[20];
443                         char *hex;
444                         int ret;
445                         ret = handle_file(path, sha1, NULL);
446                         if (ret < 1)
447                                 continue;
448                         hex = xstrdup(sha1_to_hex(sha1));
449                         string_list_insert(path, rr)->util = hex;
450                         if (mkdir(git_path("rr-cache/%s", hex), 0755))
451                                 continue;
452                         handle_file(path, NULL, rerere_path(hex, "preimage"));
453                         fprintf(stderr, "Recorded preimage for '%s'\n", path);
454                 }
455         }
456
457         /*
458          * Now some of the paths that had conflicts earlier might have been
459          * hand resolved.  Others may be similar to a conflict already that
460          * was resolved before.
461          */
462
463         for (i = 0; i < rr->nr; i++) {
464                 int ret;
465                 const char *path = rr->items[i].string;
466                 const char *name = (const char *)rr->items[i].util;
467
468                 if (has_rerere_resolution(name)) {
469                         if (!merge(name, path)) {
470                                 if (rerere_autoupdate)
471                                         string_list_insert(path, &update);
472                                 fprintf(stderr,
473                                         "%s '%s' using previous resolution.\n",
474                                         rerere_autoupdate
475                                         ? "Staged" : "Resolved",
476                                         path);
477                                 goto mark_resolved;
478                         }
479                 }
480
481                 /* Let's see if we have resolved it. */
482                 ret = handle_file(path, NULL, NULL);
483                 if (ret)
484                         continue;
485
486                 fprintf(stderr, "Recorded resolution for '%s'.\n", path);
487                 copy_file(rerere_path(name, "postimage"), path, 0666);
488         mark_resolved:
489                 rr->items[i].util = NULL;
490         }
491
492         if (update.nr)
493                 update_paths(&update);
494
495         return write_rr(rr, fd);
496 }
497
498 static int git_rerere_config(const char *var, const char *value, void *cb)
499 {
500         if (!strcmp(var, "rerere.enabled"))
501                 rerere_enabled = git_config_bool(var, value);
502         else if (!strcmp(var, "rerere.autoupdate"))
503                 rerere_autoupdate = git_config_bool(var, value);
504         else
505                 return git_default_config(var, value, cb);
506         return 0;
507 }
508
509 static int is_rerere_enabled(void)
510 {
511         const char *rr_cache;
512         int rr_cache_exists;
513
514         if (!rerere_enabled)
515                 return 0;
516
517         rr_cache = git_path("rr-cache");
518         rr_cache_exists = is_directory(rr_cache);
519         if (rerere_enabled < 0)
520                 return rr_cache_exists;
521
522         if (!rr_cache_exists &&
523             (mkdir(rr_cache, 0777) || adjust_shared_perm(rr_cache)))
524                 die("Could not create directory %s", rr_cache);
525         return 1;
526 }
527
528 int setup_rerere(struct string_list *merge_rr, int flags)
529 {
530         int fd;
531
532         git_config(git_rerere_config, NULL);
533         if (!is_rerere_enabled())
534                 return -1;
535
536         if (flags & (RERERE_AUTOUPDATE|RERERE_NOAUTOUPDATE))
537                 rerere_autoupdate = !!(flags & RERERE_AUTOUPDATE);
538         merge_rr_path = git_pathdup("MERGE_RR");
539         fd = hold_lock_file_for_update(&write_lock, merge_rr_path,
540                                        LOCK_DIE_ON_ERROR);
541         read_rr(merge_rr);
542         return fd;
543 }
544
545 int rerere(int flags)
546 {
547         struct string_list merge_rr = { NULL, 0, 0, 1 };
548         int fd;
549
550         fd = setup_rerere(&merge_rr, flags);
551         if (fd < 0)
552                 return 0;
553         return do_plain_rerere(&merge_rr, fd);
554 }
555
556 static int rerere_forget_one_path(const char *path, struct string_list *rr)
557 {
558         const char *filename;
559         char *hex;
560         unsigned char sha1[20];
561         int ret;
562
563         ret = handle_cache(path, sha1, NULL);
564         if (ret < 1)
565                 return error("Could not parse conflict hunks in '%s'", path);
566         hex = xstrdup(sha1_to_hex(sha1));
567         filename = rerere_path(hex, "postimage");
568         if (unlink(filename))
569                 return (errno == ENOENT
570                         ? error("no remembered resolution for %s", path)
571                         : error("cannot unlink %s: %s", filename, strerror(errno)));
572
573         handle_cache(path, sha1, rerere_path(hex, "preimage"));
574         fprintf(stderr, "Updated preimage for '%s'\n", path);
575
576
577         string_list_insert(path, rr)->util = hex;
578         fprintf(stderr, "Forgot resolution for %s\n", path);
579         return 0;
580 }
581
582 int rerere_forget(const char **pathspec)
583 {
584         int i, fd;
585         struct string_list conflict = { NULL, 0, 0, 1 };
586         struct string_list merge_rr = { NULL, 0, 0, 1 };
587
588         if (read_cache() < 0)
589                 return error("Could not read index");
590
591         fd = setup_rerere(&merge_rr, RERERE_NOAUTOUPDATE);
592
593         unmerge_cache(pathspec);
594         find_conflict(&conflict);
595         for (i = 0; i < conflict.nr; i++) {
596                 struct string_list_item *it = &conflict.items[i];
597                 if (!match_pathspec(pathspec, it->string, strlen(it->string),
598                                     0, NULL))
599                         continue;
600                 rerere_forget_one_path(it->string, &merge_rr);
601         }
602         return write_rr(&merge_rr, fd);
603 }