test prerequisites: enumerate with commas
[alt-git.git] / builtin / fast-export.c
blob92b4624a4b93ff50c661e44242d508aed31877eb
1 /*
2 * "git fast-export" builtin command
4 * Copyright (C) 2007 Johannes E. Schindelin
5 */
6 #include "builtin.h"
7 #include "cache.h"
8 #include "commit.h"
9 #include "object.h"
10 #include "tag.h"
11 #include "diff.h"
12 #include "diffcore.h"
13 #include "log-tree.h"
14 #include "revision.h"
15 #include "decorate.h"
16 #include "string-list.h"
17 #include "utf8.h"
18 #include "parse-options.h"
19 #include "quote.h"
20 #include "remote.h"
22 static const char *fast_export_usage[] = {
23 N_("git fast-export [rev-list-opts]"),
24 NULL
27 static int progress;
28 static enum { ABORT, VERBATIM, WARN, WARN_STRIP, STRIP } signed_tag_mode = ABORT;
29 static enum { ERROR, DROP, REWRITE } tag_of_filtered_mode = ERROR;
30 static int fake_missing_tagger;
31 static int use_done_feature;
32 static int no_data;
33 static int full_tree;
34 static struct string_list extra_refs = STRING_LIST_INIT_NODUP;
35 static struct refspec *refspecs;
36 static int refspecs_nr;
38 static int parse_opt_signed_tag_mode(const struct option *opt,
39 const char *arg, int unset)
41 if (unset || !strcmp(arg, "abort"))
42 signed_tag_mode = ABORT;
43 else if (!strcmp(arg, "verbatim") || !strcmp(arg, "ignore"))
44 signed_tag_mode = VERBATIM;
45 else if (!strcmp(arg, "warn"))
46 signed_tag_mode = WARN;
47 else if (!strcmp(arg, "warn-strip"))
48 signed_tag_mode = WARN_STRIP;
49 else if (!strcmp(arg, "strip"))
50 signed_tag_mode = STRIP;
51 else
52 return error("Unknown signed-tags mode: %s", arg);
53 return 0;
56 static int parse_opt_tag_of_filtered_mode(const struct option *opt,
57 const char *arg, int unset)
59 if (unset || !strcmp(arg, "abort"))
60 tag_of_filtered_mode = ERROR;
61 else if (!strcmp(arg, "drop"))
62 tag_of_filtered_mode = DROP;
63 else if (!strcmp(arg, "rewrite"))
64 tag_of_filtered_mode = REWRITE;
65 else
66 return error("Unknown tag-of-filtered mode: %s", arg);
67 return 0;
70 static struct decoration idnums;
71 static uint32_t last_idnum;
73 static int has_unshown_parent(struct commit *commit)
75 struct commit_list *parent;
77 for (parent = commit->parents; parent; parent = parent->next)
78 if (!(parent->item->object.flags & SHOWN) &&
79 !(parent->item->object.flags & UNINTERESTING))
80 return 1;
81 return 0;
84 /* Since intptr_t is C99, we do not use it here */
85 static inline uint32_t *mark_to_ptr(uint32_t mark)
87 return ((uint32_t *)NULL) + mark;
90 static inline uint32_t ptr_to_mark(void * mark)
92 return (uint32_t *)mark - (uint32_t *)NULL;
95 static inline void mark_object(struct object *object, uint32_t mark)
97 add_decoration(&idnums, object, mark_to_ptr(mark));
100 static inline void mark_next_object(struct object *object)
102 mark_object(object, ++last_idnum);
105 static int get_object_mark(struct object *object)
107 void *decoration = lookup_decoration(&idnums, object);
108 if (!decoration)
109 return 0;
110 return ptr_to_mark(decoration);
113 static void show_progress(void)
115 static int counter = 0;
116 if (!progress)
117 return;
118 if ((++counter % progress) == 0)
119 printf("progress %d objects\n", counter);
122 static void export_blob(const unsigned char *sha1)
124 unsigned long size;
125 enum object_type type;
126 char *buf;
127 struct object *object;
128 int eaten;
130 if (no_data)
131 return;
133 if (is_null_sha1(sha1))
134 return;
136 object = lookup_object(sha1);
137 if (object && object->flags & SHOWN)
138 return;
140 buf = read_sha1_file(sha1, &type, &size);
141 if (!buf)
142 die ("Could not read blob %s", sha1_to_hex(sha1));
143 if (check_sha1_signature(sha1, buf, size, typename(type)) < 0)
144 die("sha1 mismatch in blob %s", sha1_to_hex(sha1));
145 object = parse_object_buffer(sha1, type, size, buf, &eaten);
146 if (!object)
147 die("Could not read blob %s", sha1_to_hex(sha1));
149 mark_next_object(object);
151 printf("blob\nmark :%"PRIu32"\ndata %lu\n", last_idnum, size);
152 if (size && fwrite(buf, size, 1, stdout) != 1)
153 die_errno ("Could not write blob '%s'", sha1_to_hex(sha1));
154 printf("\n");
156 show_progress();
158 object->flags |= SHOWN;
159 if (!eaten)
160 free(buf);
163 static int depth_first(const void *a_, const void *b_)
165 const struct diff_filepair *a = *((const struct diff_filepair **)a_);
166 const struct diff_filepair *b = *((const struct diff_filepair **)b_);
167 const char *name_a, *name_b;
168 int len_a, len_b, len;
169 int cmp;
171 name_a = a->one ? a->one->path : a->two->path;
172 name_b = b->one ? b->one->path : b->two->path;
174 len_a = strlen(name_a);
175 len_b = strlen(name_b);
176 len = (len_a < len_b) ? len_a : len_b;
178 /* strcmp will sort 'd' before 'd/e', we want 'd/e' before 'd' */
179 cmp = memcmp(name_a, name_b, len);
180 if (cmp)
181 return cmp;
182 cmp = len_b - len_a;
183 if (cmp)
184 return cmp;
186 * Move 'R'ename entries last so that all references of the file
187 * appear in the output before it is renamed (e.g., when a file
188 * was copied and renamed in the same commit).
190 return (a->status == 'R') - (b->status == 'R');
193 static void print_path(const char *path)
195 int need_quote = quote_c_style(path, NULL, NULL, 0);
196 if (need_quote)
197 quote_c_style(path, NULL, stdout, 0);
198 else if (strchr(path, ' '))
199 printf("\"%s\"", path);
200 else
201 printf("%s", path);
204 static void show_filemodify(struct diff_queue_struct *q,
205 struct diff_options *options, void *data)
207 int i;
210 * Handle files below a directory first, in case they are all deleted
211 * and the directory changes to a file or symlink.
213 qsort(q->queue, q->nr, sizeof(q->queue[0]), depth_first);
215 for (i = 0; i < q->nr; i++) {
216 struct diff_filespec *ospec = q->queue[i]->one;
217 struct diff_filespec *spec = q->queue[i]->two;
219 switch (q->queue[i]->status) {
220 case DIFF_STATUS_DELETED:
221 printf("D ");
222 print_path(spec->path);
223 putchar('\n');
224 break;
226 case DIFF_STATUS_COPIED:
227 case DIFF_STATUS_RENAMED:
228 printf("%c ", q->queue[i]->status);
229 print_path(ospec->path);
230 putchar(' ');
231 print_path(spec->path);
232 putchar('\n');
234 if (!hashcmp(ospec->sha1, spec->sha1) &&
235 ospec->mode == spec->mode)
236 break;
237 /* fallthrough */
239 case DIFF_STATUS_TYPE_CHANGED:
240 case DIFF_STATUS_MODIFIED:
241 case DIFF_STATUS_ADDED:
243 * Links refer to objects in another repositories;
244 * output the SHA-1 verbatim.
246 if (no_data || S_ISGITLINK(spec->mode))
247 printf("M %06o %s ", spec->mode,
248 sha1_to_hex(spec->sha1));
249 else {
250 struct object *object = lookup_object(spec->sha1);
251 printf("M %06o :%d ", spec->mode,
252 get_object_mark(object));
254 print_path(spec->path);
255 putchar('\n');
256 break;
258 default:
259 die("Unexpected comparison status '%c' for %s, %s",
260 q->queue[i]->status,
261 ospec->path ? ospec->path : "none",
262 spec->path ? spec->path : "none");
267 static const char *find_encoding(const char *begin, const char *end)
269 const char *needle = "\nencoding ";
270 char *bol, *eol;
272 bol = memmem(begin, end ? end - begin : strlen(begin),
273 needle, strlen(needle));
274 if (!bol)
275 return git_commit_encoding;
276 bol += strlen(needle);
277 eol = strchrnul(bol, '\n');
278 *eol = '\0';
279 return bol;
282 static void handle_commit(struct commit *commit, struct rev_info *rev)
284 int saved_output_format = rev->diffopt.output_format;
285 const char *commit_buffer;
286 const char *author, *author_end, *committer, *committer_end;
287 const char *encoding, *message;
288 char *reencoded = NULL;
289 struct commit_list *p;
290 int i;
292 rev->diffopt.output_format = DIFF_FORMAT_CALLBACK;
294 parse_commit_or_die(commit);
295 commit_buffer = get_commit_buffer(commit, NULL);
296 author = strstr(commit_buffer, "\nauthor ");
297 if (!author)
298 die ("Could not find author in commit %s",
299 sha1_to_hex(commit->object.sha1));
300 author++;
301 author_end = strchrnul(author, '\n');
302 committer = strstr(author_end, "\ncommitter ");
303 if (!committer)
304 die ("Could not find committer in commit %s",
305 sha1_to_hex(commit->object.sha1));
306 committer++;
307 committer_end = strchrnul(committer, '\n');
308 message = strstr(committer_end, "\n\n");
309 encoding = find_encoding(committer_end, message);
310 if (message)
311 message += 2;
313 if (commit->parents &&
314 get_object_mark(&commit->parents->item->object) != 0 &&
315 !full_tree) {
316 parse_commit_or_die(commit->parents->item);
317 diff_tree_sha1(commit->parents->item->tree->object.sha1,
318 commit->tree->object.sha1, "", &rev->diffopt);
320 else
321 diff_root_tree_sha1(commit->tree->object.sha1,
322 "", &rev->diffopt);
324 /* Export the referenced blobs, and remember the marks. */
325 for (i = 0; i < diff_queued_diff.nr; i++)
326 if (!S_ISGITLINK(diff_queued_diff.queue[i]->two->mode))
327 export_blob(diff_queued_diff.queue[i]->two->sha1);
329 mark_next_object(&commit->object);
330 if (!is_encoding_utf8(encoding))
331 reencoded = reencode_string(message, "UTF-8", encoding);
332 if (!commit->parents)
333 printf("reset %s\n", (const char*)commit->util);
334 printf("commit %s\nmark :%"PRIu32"\n%.*s\n%.*s\ndata %u\n%s",
335 (const char *)commit->util, last_idnum,
336 (int)(author_end - author), author,
337 (int)(committer_end - committer), committer,
338 (unsigned)(reencoded
339 ? strlen(reencoded) : message
340 ? strlen(message) : 0),
341 reencoded ? reencoded : message ? message : "");
342 free(reencoded);
343 unuse_commit_buffer(commit, commit_buffer);
345 for (i = 0, p = commit->parents; p; p = p->next) {
346 int mark = get_object_mark(&p->item->object);
347 if (!mark)
348 continue;
349 if (i == 0)
350 printf("from :%d\n", mark);
351 else
352 printf("merge :%d\n", mark);
353 i++;
356 if (full_tree)
357 printf("deleteall\n");
358 log_tree_diff_flush(rev);
359 rev->diffopt.output_format = saved_output_format;
361 printf("\n");
363 show_progress();
366 static void handle_tail(struct object_array *commits, struct rev_info *revs)
368 struct commit *commit;
369 while (commits->nr) {
370 commit = (struct commit *)commits->objects[commits->nr - 1].item;
371 if (has_unshown_parent(commit))
372 return;
373 handle_commit(commit, revs);
374 commits->nr--;
378 static void handle_tag(const char *name, struct tag *tag)
380 unsigned long size;
381 enum object_type type;
382 char *buf;
383 const char *tagger, *tagger_end, *message;
384 size_t message_size = 0;
385 struct object *tagged;
386 int tagged_mark;
387 struct commit *p;
389 /* Trees have no identifier in fast-export output, thus we have no way
390 * to output tags of trees, tags of tags of trees, etc. Simply omit
391 * such tags.
393 tagged = tag->tagged;
394 while (tagged->type == OBJ_TAG) {
395 tagged = ((struct tag *)tagged)->tagged;
397 if (tagged->type == OBJ_TREE) {
398 warning("Omitting tag %s,\nsince tags of trees (or tags of tags of trees, etc.) are not supported.",
399 sha1_to_hex(tag->object.sha1));
400 return;
403 buf = read_sha1_file(tag->object.sha1, &type, &size);
404 if (!buf)
405 die ("Could not read tag %s", sha1_to_hex(tag->object.sha1));
406 message = memmem(buf, size, "\n\n", 2);
407 if (message) {
408 message += 2;
409 message_size = strlen(message);
411 tagger = memmem(buf, message ? message - buf : size, "\ntagger ", 8);
412 if (!tagger) {
413 if (fake_missing_tagger)
414 tagger = "tagger Unspecified Tagger "
415 "<unspecified-tagger> 0 +0000";
416 else
417 tagger = "";
418 tagger_end = tagger + strlen(tagger);
419 } else {
420 tagger++;
421 tagger_end = strchrnul(tagger, '\n');
424 /* handle signed tags */
425 if (message) {
426 const char *signature = strstr(message,
427 "\n-----BEGIN PGP SIGNATURE-----\n");
428 if (signature)
429 switch(signed_tag_mode) {
430 case ABORT:
431 die ("Encountered signed tag %s; use "
432 "--signed-tags=<mode> to handle it.",
433 sha1_to_hex(tag->object.sha1));
434 case WARN:
435 warning ("Exporting signed tag %s",
436 sha1_to_hex(tag->object.sha1));
437 /* fallthru */
438 case VERBATIM:
439 break;
440 case WARN_STRIP:
441 warning ("Stripping signature from tag %s",
442 sha1_to_hex(tag->object.sha1));
443 /* fallthru */
444 case STRIP:
445 message_size = signature + 1 - message;
446 break;
450 /* handle tag->tagged having been filtered out due to paths specified */
451 tagged = tag->tagged;
452 tagged_mark = get_object_mark(tagged);
453 if (!tagged_mark) {
454 switch(tag_of_filtered_mode) {
455 case ABORT:
456 die ("Tag %s tags unexported object; use "
457 "--tag-of-filtered-object=<mode> to handle it.",
458 sha1_to_hex(tag->object.sha1));
459 case DROP:
460 /* Ignore this tag altogether */
461 return;
462 case REWRITE:
463 if (tagged->type != OBJ_COMMIT) {
464 die ("Tag %s tags unexported %s!",
465 sha1_to_hex(tag->object.sha1),
466 typename(tagged->type));
468 p = (struct commit *)tagged;
469 for (;;) {
470 if (p->parents && p->parents->next)
471 break;
472 if (p->object.flags & UNINTERESTING)
473 break;
474 if (!(p->object.flags & TREESAME))
475 break;
476 if (!p->parents)
477 die ("Can't find replacement commit for tag %s\n",
478 sha1_to_hex(tag->object.sha1));
479 p = p->parents->item;
481 tagged_mark = get_object_mark(&p->object);
485 if (starts_with(name, "refs/tags/"))
486 name += 10;
487 printf("tag %s\nfrom :%d\n%.*s%sdata %d\n%.*s\n",
488 name, tagged_mark,
489 (int)(tagger_end - tagger), tagger,
490 tagger == tagger_end ? "" : "\n",
491 (int)message_size, (int)message_size, message ? message : "");
494 static struct commit *get_commit(struct rev_cmdline_entry *e, char *full_name)
496 switch (e->item->type) {
497 case OBJ_COMMIT:
498 return (struct commit *)e->item;
499 case OBJ_TAG: {
500 struct tag *tag = (struct tag *)e->item;
502 /* handle nested tags */
503 while (tag && tag->object.type == OBJ_TAG) {
504 parse_object(tag->object.sha1);
505 string_list_append(&extra_refs, full_name)->util = tag;
506 tag = (struct tag *)tag->tagged;
508 if (!tag)
509 die("Tag %s points nowhere?", e->name);
510 return (struct commit *)tag;
511 break;
513 default:
514 return NULL;
518 static void get_tags_and_duplicates(struct rev_cmdline_info *info)
520 int i;
522 for (i = 0; i < info->nr; i++) {
523 struct rev_cmdline_entry *e = info->rev + i;
524 unsigned char sha1[20];
525 struct commit *commit;
526 char *full_name;
528 if (e->flags & UNINTERESTING)
529 continue;
531 if (dwim_ref(e->name, strlen(e->name), sha1, &full_name) != 1)
532 continue;
534 if (refspecs) {
535 char *private;
536 private = apply_refspecs(refspecs, refspecs_nr, full_name);
537 if (private) {
538 free(full_name);
539 full_name = private;
543 commit = get_commit(e, full_name);
544 if (!commit) {
545 warning("%s: Unexpected object of type %s, skipping.",
546 e->name,
547 typename(e->item->type));
548 continue;
551 switch(commit->object.type) {
552 case OBJ_COMMIT:
553 break;
554 case OBJ_BLOB:
555 export_blob(commit->object.sha1);
556 continue;
557 default: /* OBJ_TAG (nested tags) is already handled */
558 warning("Tag points to object of unexpected type %s, skipping.",
559 typename(commit->object.type));
560 continue;
564 * This ref will not be updated through a commit, lets make
565 * sure it gets properly updated eventually.
567 if (commit->util || commit->object.flags & SHOWN)
568 string_list_append(&extra_refs, full_name)->util = commit;
569 if (!commit->util)
570 commit->util = full_name;
574 static void handle_tags_and_duplicates(void)
576 struct commit *commit;
577 int i;
579 for (i = extra_refs.nr - 1; i >= 0; i--) {
580 const char *name = extra_refs.items[i].string;
581 struct object *object = extra_refs.items[i].util;
582 switch (object->type) {
583 case OBJ_TAG:
584 handle_tag(name, (struct tag *)object);
585 break;
586 case OBJ_COMMIT:
587 /* create refs pointing to already seen commits */
588 commit = (struct commit *)object;
589 printf("reset %s\nfrom :%d\n\n", name,
590 get_object_mark(&commit->object));
591 show_progress();
592 break;
597 static void export_marks(char *file)
599 unsigned int i;
600 uint32_t mark;
601 struct object_decoration *deco = idnums.hash;
602 FILE *f;
603 int e = 0;
605 f = fopen(file, "w");
606 if (!f)
607 die_errno("Unable to open marks file %s for writing.", file);
609 for (i = 0; i < idnums.size; i++) {
610 if (deco->base && deco->base->type == 1) {
611 mark = ptr_to_mark(deco->decoration);
612 if (fprintf(f, ":%"PRIu32" %s\n", mark,
613 sha1_to_hex(deco->base->sha1)) < 0) {
614 e = 1;
615 break;
618 deco++;
621 e |= ferror(f);
622 e |= fclose(f);
623 if (e)
624 error("Unable to write marks file %s.", file);
627 static void import_marks(char *input_file)
629 char line[512];
630 FILE *f = fopen(input_file, "r");
631 if (!f)
632 die_errno("cannot read '%s'", input_file);
634 while (fgets(line, sizeof(line), f)) {
635 uint32_t mark;
636 char *line_end, *mark_end;
637 unsigned char sha1[20];
638 struct object *object;
639 struct commit *commit;
640 enum object_type type;
642 line_end = strchr(line, '\n');
643 if (line[0] != ':' || !line_end)
644 die("corrupt mark line: %s", line);
645 *line_end = '\0';
647 mark = strtoumax(line + 1, &mark_end, 10);
648 if (!mark || mark_end == line + 1
649 || *mark_end != ' ' || get_sha1_hex(mark_end + 1, sha1))
650 die("corrupt mark line: %s", line);
652 if (last_idnum < mark)
653 last_idnum = mark;
655 type = sha1_object_info(sha1, NULL);
656 if (type < 0)
657 die("object not found: %s", sha1_to_hex(sha1));
659 if (type != OBJ_COMMIT)
660 /* only commits */
661 continue;
663 commit = lookup_commit(sha1);
664 if (!commit)
665 die("not a commit? can't happen: %s", sha1_to_hex(sha1));
667 object = &commit->object;
669 if (object->flags & SHOWN)
670 error("Object %s already has a mark", sha1_to_hex(sha1));
672 mark_object(object, mark);
674 object->flags |= SHOWN;
676 fclose(f);
679 static void handle_deletes(void)
681 int i;
682 for (i = 0; i < refspecs_nr; i++) {
683 struct refspec *refspec = &refspecs[i];
684 if (*refspec->src)
685 continue;
687 printf("reset %s\nfrom %s\n\n",
688 refspec->dst, sha1_to_hex(null_sha1));
692 int cmd_fast_export(int argc, const char **argv, const char *prefix)
694 struct rev_info revs;
695 struct object_array commits = OBJECT_ARRAY_INIT;
696 struct commit *commit;
697 char *export_filename = NULL, *import_filename = NULL;
698 uint32_t lastimportid;
699 struct string_list refspecs_list = STRING_LIST_INIT_NODUP;
700 struct option options[] = {
701 OPT_INTEGER(0, "progress", &progress,
702 N_("show progress after <n> objects")),
703 OPT_CALLBACK(0, "signed-tags", &signed_tag_mode, N_("mode"),
704 N_("select handling of signed tags"),
705 parse_opt_signed_tag_mode),
706 OPT_CALLBACK(0, "tag-of-filtered-object", &tag_of_filtered_mode, N_("mode"),
707 N_("select handling of tags that tag filtered objects"),
708 parse_opt_tag_of_filtered_mode),
709 OPT_STRING(0, "export-marks", &export_filename, N_("file"),
710 N_("Dump marks to this file")),
711 OPT_STRING(0, "import-marks", &import_filename, N_("file"),
712 N_("Import marks from this file")),
713 OPT_BOOL(0, "fake-missing-tagger", &fake_missing_tagger,
714 N_("Fake a tagger when tags lack one")),
715 OPT_BOOL(0, "full-tree", &full_tree,
716 N_("Output full tree for each commit")),
717 OPT_BOOL(0, "use-done-feature", &use_done_feature,
718 N_("Use the done feature to terminate the stream")),
719 OPT_BOOL(0, "no-data", &no_data, N_("Skip output of blob data")),
720 OPT_STRING_LIST(0, "refspec", &refspecs_list, N_("refspec"),
721 N_("Apply refspec to exported refs")),
722 OPT_END()
725 if (argc == 1)
726 usage_with_options (fast_export_usage, options);
728 /* we handle encodings */
729 git_config(git_default_config, NULL);
731 init_revisions(&revs, prefix);
732 revs.topo_order = 1;
733 revs.show_source = 1;
734 revs.rewrite_parents = 1;
735 argc = parse_options(argc, argv, prefix, options, fast_export_usage,
736 PARSE_OPT_KEEP_ARGV0 | PARSE_OPT_KEEP_UNKNOWN);
737 argc = setup_revisions(argc, argv, &revs, NULL);
738 if (argc > 1)
739 usage_with_options (fast_export_usage, options);
741 if (refspecs_list.nr) {
742 const char **refspecs_str;
743 int i;
745 refspecs_str = xmalloc(sizeof(*refspecs_str) * refspecs_list.nr);
746 for (i = 0; i < refspecs_list.nr; i++)
747 refspecs_str[i] = refspecs_list.items[i].string;
749 refspecs_nr = refspecs_list.nr;
750 refspecs = parse_fetch_refspec(refspecs_nr, refspecs_str);
752 string_list_clear(&refspecs_list, 1);
753 free(refspecs_str);
756 if (use_done_feature)
757 printf("feature done\n");
759 if (import_filename)
760 import_marks(import_filename);
761 lastimportid = last_idnum;
763 if (import_filename && revs.prune_data.nr)
764 full_tree = 1;
766 get_tags_and_duplicates(&revs.cmdline);
768 if (prepare_revision_walk(&revs))
769 die("revision walk setup failed");
770 revs.diffopt.format_callback = show_filemodify;
771 DIFF_OPT_SET(&revs.diffopt, RECURSIVE);
772 while ((commit = get_revision(&revs))) {
773 if (has_unshown_parent(commit)) {
774 add_object_array(&commit->object, NULL, &commits);
776 else {
777 handle_commit(commit, &revs);
778 handle_tail(&commits, &revs);
782 handle_tags_and_duplicates();
783 handle_deletes();
785 if (export_filename && lastimportid != last_idnum)
786 export_marks(export_filename);
788 if (use_done_feature)
789 printf("done\n");
791 free_refspec(refspecs_nr, refspecs);
793 return 0;