Merge branch 'jk/rm-removed-paths'
[git] / builtin / clone.c
1 /*
2  * Builtin "git clone"
3  *
4  * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
5  *               2008 Daniel Barkalow <barkalow@iabervon.org>
6  * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
7  *
8  * Clone a repository into a different directory that does not yet exist.
9  */
10
11 #include "builtin.h"
12 #include "parse-options.h"
13 #include "fetch-pack.h"
14 #include "refs.h"
15 #include "tree.h"
16 #include "tree-walk.h"
17 #include "unpack-trees.h"
18 #include "transport.h"
19 #include "strbuf.h"
20 #include "dir.h"
21 #include "pack-refs.h"
22 #include "sigchain.h"
23 #include "branch.h"
24 #include "remote.h"
25 #include "run-command.h"
26 #include "connected.h"
27
28 /*
29  * Overall FIXMEs:
30  *  - respect DB_ENVIRONMENT for .git/objects.
31  *
32  * Implementation notes:
33  *  - dropping use-separate-remote and no-separate-remote compatibility
34  *
35  */
36 static const char * const builtin_clone_usage[] = {
37         N_("git clone [options] [--] <repo> [<dir>]"),
38         NULL
39 };
40
41 static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
42 static int option_local = -1, option_no_hardlinks, option_shared, option_recursive;
43 static char *option_template, *option_depth;
44 static char *option_origin = NULL;
45 static char *option_branch = NULL;
46 static const char *real_git_dir;
47 static char *option_upload_pack = "git-upload-pack";
48 static int option_verbosity;
49 static int option_progress = -1;
50 static struct string_list option_config;
51 static struct string_list option_reference;
52
53 static int opt_parse_reference(const struct option *opt, const char *arg, int unset)
54 {
55         struct string_list *option_reference = opt->value;
56         if (!arg)
57                 return -1;
58         string_list_append(option_reference, arg);
59         return 0;
60 }
61
62 static struct option builtin_clone_options[] = {
63         OPT__VERBOSITY(&option_verbosity),
64         OPT_BOOL(0, "progress", &option_progress,
65                  N_("force progress reporting")),
66         OPT_BOOLEAN('n', "no-checkout", &option_no_checkout,
67                     N_("don't create a checkout")),
68         OPT_BOOLEAN(0, "bare", &option_bare, N_("create a bare repository")),
69         { OPTION_BOOLEAN, 0, "naked", &option_bare, NULL,
70                 N_("create a bare repository"),
71                 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
72         OPT_BOOLEAN(0, "mirror", &option_mirror,
73                     N_("create a mirror repository (implies bare)")),
74         OPT_BOOL('l', "local", &option_local,
75                 N_("to clone from a local repository")),
76         OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks,
77                     N_("don't use local hardlinks, always copy")),
78         OPT_BOOLEAN('s', "shared", &option_shared,
79                     N_("setup as shared repository")),
80         OPT_BOOLEAN(0, "recursive", &option_recursive,
81                     N_("initialize submodules in the clone")),
82         OPT_BOOLEAN(0, "recurse-submodules", &option_recursive,
83                     N_("initialize submodules in the clone")),
84         OPT_STRING(0, "template", &option_template, N_("template-directory"),
85                    N_("directory from which templates will be used")),
86         OPT_CALLBACK(0 , "reference", &option_reference, N_("repo"),
87                      N_("reference repository"), &opt_parse_reference),
88         OPT_STRING('o', "origin", &option_origin, N_("name"),
89                    N_("use <name> instead of 'origin' to track upstream")),
90         OPT_STRING('b', "branch", &option_branch, N_("branch"),
91                    N_("checkout <branch> instead of the remote's HEAD")),
92         OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
93                    N_("path to git-upload-pack on the remote")),
94         OPT_STRING(0, "depth", &option_depth, N_("depth"),
95                     N_("create a shallow clone of that depth")),
96         OPT_BOOL(0, "single-branch", &option_single_branch,
97                     N_("clone only one branch, HEAD or --branch")),
98         OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
99                    N_("separate git dir from working tree")),
100         OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
101                         N_("set config inside the new repository")),
102         OPT_END()
103 };
104
105 static const char *argv_submodule[] = {
106         "submodule", "update", "--init", "--recursive", NULL
107 };
108
109 static char *get_repo_path(const char *repo, int *is_bundle)
110 {
111         static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
112         static char *bundle_suffix[] = { ".bundle", "" };
113         struct stat st;
114         int i;
115
116         for (i = 0; i < ARRAY_SIZE(suffix); i++) {
117                 const char *path;
118                 path = mkpath("%s%s", repo, suffix[i]);
119                 if (stat(path, &st))
120                         continue;
121                 if (S_ISDIR(st.st_mode) && is_git_directory(path)) {
122                         *is_bundle = 0;
123                         return xstrdup(absolute_path(path));
124                 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
125                         /* Is it a "gitfile"? */
126                         char signature[8];
127                         int len, fd = open(path, O_RDONLY);
128                         if (fd < 0)
129                                 continue;
130                         len = read_in_full(fd, signature, 8);
131                         close(fd);
132                         if (len != 8 || strncmp(signature, "gitdir: ", 8))
133                                 continue;
134                         path = read_gitfile(path);
135                         if (path) {
136                                 *is_bundle = 0;
137                                 return xstrdup(absolute_path(path));
138                         }
139                 }
140         }
141
142         for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
143                 const char *path;
144                 path = mkpath("%s%s", repo, bundle_suffix[i]);
145                 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
146                         *is_bundle = 1;
147                         return xstrdup(absolute_path(path));
148                 }
149         }
150
151         return NULL;
152 }
153
154 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
155 {
156         const char *end = repo + strlen(repo), *start;
157         char *dir;
158
159         /*
160          * Strip trailing spaces, slashes and /.git
161          */
162         while (repo < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
163                 end--;
164         if (end - repo > 5 && is_dir_sep(end[-5]) &&
165             !strncmp(end - 4, ".git", 4)) {
166                 end -= 5;
167                 while (repo < end && is_dir_sep(end[-1]))
168                         end--;
169         }
170
171         /*
172          * Find last component, but be prepared that repo could have
173          * the form  "remote.example.com:foo.git", i.e. no slash
174          * in the directory part.
175          */
176         start = end;
177         while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
178                 start--;
179
180         /*
181          * Strip .{bundle,git}.
182          */
183         if (is_bundle) {
184                 if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
185                         end -= 7;
186         } else {
187                 if (end - start > 4 && !strncmp(end - 4, ".git", 4))
188                         end -= 4;
189         }
190
191         if (is_bare) {
192                 struct strbuf result = STRBUF_INIT;
193                 strbuf_addf(&result, "%.*s.git", (int)(end - start), start);
194                 dir = strbuf_detach(&result, NULL);
195         } else
196                 dir = xstrndup(start, end - start);
197         /*
198          * Replace sequences of 'control' characters and whitespace
199          * with one ascii space, remove leading and trailing spaces.
200          */
201         if (*dir) {
202                 char *out = dir;
203                 int prev_space = 1 /* strip leading whitespace */;
204                 for (end = dir; *end; ++end) {
205                         char ch = *end;
206                         if ((unsigned char)ch < '\x20')
207                                 ch = '\x20';
208                         if (isspace(ch)) {
209                                 if (prev_space)
210                                         continue;
211                                 prev_space = 1;
212                         } else
213                                 prev_space = 0;
214                         *out++ = ch;
215                 }
216                 *out = '\0';
217                 if (out > dir && prev_space)
218                         out[-1] = '\0';
219         }
220         return dir;
221 }
222
223 static void strip_trailing_slashes(char *dir)
224 {
225         char *end = dir + strlen(dir);
226
227         while (dir < end - 1 && is_dir_sep(end[-1]))
228                 end--;
229         *end = '\0';
230 }
231
232 static int add_one_reference(struct string_list_item *item, void *cb_data)
233 {
234         char *ref_git;
235         struct strbuf alternate = STRBUF_INIT;
236
237         /* Beware: real_path() and mkpath() return static buffer */
238         ref_git = xstrdup(real_path(item->string));
239         if (is_directory(mkpath("%s/.git/objects", ref_git))) {
240                 char *ref_git_git = mkpathdup("%s/.git", ref_git);
241                 free(ref_git);
242                 ref_git = ref_git_git;
243         } else if (!is_directory(mkpath("%s/objects", ref_git)))
244                 die(_("reference repository '%s' is not a local directory."),
245                     item->string);
246
247         strbuf_addf(&alternate, "%s/objects", ref_git);
248         add_to_alternates_file(alternate.buf);
249         strbuf_release(&alternate);
250         free(ref_git);
251         return 0;
252 }
253
254 static void setup_reference(void)
255 {
256         for_each_string_list(&option_reference, add_one_reference, NULL);
257 }
258
259 static void copy_alternates(struct strbuf *src, struct strbuf *dst,
260                             const char *src_repo)
261 {
262         /*
263          * Read from the source objects/info/alternates file
264          * and copy the entries to corresponding file in the
265          * destination repository with add_to_alternates_file().
266          * Both src and dst have "$path/objects/info/alternates".
267          *
268          * Instead of copying bit-for-bit from the original,
269          * we need to append to existing one so that the already
270          * created entry via "clone -s" is not lost, and also
271          * to turn entries with paths relative to the original
272          * absolute, so that they can be used in the new repository.
273          */
274         FILE *in = fopen(src->buf, "r");
275         struct strbuf line = STRBUF_INIT;
276
277         while (strbuf_getline(&line, in, '\n') != EOF) {
278                 char *abs_path, abs_buf[PATH_MAX];
279                 if (!line.len || line.buf[0] == '#')
280                         continue;
281                 if (is_absolute_path(line.buf)) {
282                         add_to_alternates_file(line.buf);
283                         continue;
284                 }
285                 abs_path = mkpath("%s/objects/%s", src_repo, line.buf);
286                 normalize_path_copy(abs_buf, abs_path);
287                 add_to_alternates_file(abs_buf);
288         }
289         strbuf_release(&line);
290         fclose(in);
291 }
292
293 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
294                                    const char *src_repo, int src_baselen)
295 {
296         struct dirent *de;
297         struct stat buf;
298         int src_len, dest_len;
299         DIR *dir;
300
301         dir = opendir(src->buf);
302         if (!dir)
303                 die_errno(_("failed to open '%s'"), src->buf);
304
305         if (mkdir(dest->buf, 0777)) {
306                 if (errno != EEXIST)
307                         die_errno(_("failed to create directory '%s'"), dest->buf);
308                 else if (stat(dest->buf, &buf))
309                         die_errno(_("failed to stat '%s'"), dest->buf);
310                 else if (!S_ISDIR(buf.st_mode))
311                         die(_("%s exists and is not a directory"), dest->buf);
312         }
313
314         strbuf_addch(src, '/');
315         src_len = src->len;
316         strbuf_addch(dest, '/');
317         dest_len = dest->len;
318
319         while ((de = readdir(dir)) != NULL) {
320                 strbuf_setlen(src, src_len);
321                 strbuf_addstr(src, de->d_name);
322                 strbuf_setlen(dest, dest_len);
323                 strbuf_addstr(dest, de->d_name);
324                 if (stat(src->buf, &buf)) {
325                         warning (_("failed to stat %s\n"), src->buf);
326                         continue;
327                 }
328                 if (S_ISDIR(buf.st_mode)) {
329                         if (de->d_name[0] != '.')
330                                 copy_or_link_directory(src, dest,
331                                                        src_repo, src_baselen);
332                         continue;
333                 }
334
335                 /* Files that cannot be copied bit-for-bit... */
336                 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
337                         copy_alternates(src, dest, src_repo);
338                         continue;
339                 }
340
341                 if (unlink(dest->buf) && errno != ENOENT)
342                         die_errno(_("failed to unlink '%s'"), dest->buf);
343                 if (!option_no_hardlinks) {
344                         if (!link(src->buf, dest->buf))
345                                 continue;
346                         if (option_local > 0)
347                                 die_errno(_("failed to create link '%s'"), dest->buf);
348                         option_no_hardlinks = 1;
349                 }
350                 if (copy_file_with_time(dest->buf, src->buf, 0666))
351                         die_errno(_("failed to copy file to '%s'"), dest->buf);
352         }
353         closedir(dir);
354 }
355
356 static void clone_local(const char *src_repo, const char *dest_repo)
357 {
358         if (option_shared) {
359                 struct strbuf alt = STRBUF_INIT;
360                 strbuf_addf(&alt, "%s/objects", src_repo);
361                 add_to_alternates_file(alt.buf);
362                 strbuf_release(&alt);
363         } else {
364                 struct strbuf src = STRBUF_INIT;
365                 struct strbuf dest = STRBUF_INIT;
366                 strbuf_addf(&src, "%s/objects", src_repo);
367                 strbuf_addf(&dest, "%s/objects", dest_repo);
368                 copy_or_link_directory(&src, &dest, src_repo, src.len);
369                 strbuf_release(&src);
370                 strbuf_release(&dest);
371         }
372
373         if (0 <= option_verbosity)
374                 printf(_("done.\n"));
375 }
376
377 static const char *junk_work_tree;
378 static const char *junk_git_dir;
379 static pid_t junk_pid;
380 enum {
381         JUNK_LEAVE_NONE,
382         JUNK_LEAVE_REPO,
383         JUNK_LEAVE_ALL
384 } junk_mode = JUNK_LEAVE_NONE;
385
386 static const char junk_leave_repo_msg[] =
387 N_("Clone succeeded, but checkout failed.\n"
388    "You can inspect what was checked out with 'git status'\n"
389    "and retry the checkout with 'git checkout -f HEAD'\n");
390
391 static void remove_junk(void)
392 {
393         struct strbuf sb = STRBUF_INIT;
394
395         switch (junk_mode) {
396         case JUNK_LEAVE_REPO:
397                 warning("%s", _(junk_leave_repo_msg));
398                 /* fall-through */
399         case JUNK_LEAVE_ALL:
400                 return;
401         default:
402                 /* proceed to removal */
403                 break;
404         }
405
406         if (getpid() != junk_pid)
407                 return;
408         if (junk_git_dir) {
409                 strbuf_addstr(&sb, junk_git_dir);
410                 remove_dir_recursively(&sb, 0);
411                 strbuf_reset(&sb);
412         }
413         if (junk_work_tree) {
414                 strbuf_addstr(&sb, junk_work_tree);
415                 remove_dir_recursively(&sb, 0);
416                 strbuf_reset(&sb);
417         }
418 }
419
420 static void remove_junk_on_signal(int signo)
421 {
422         remove_junk();
423         sigchain_pop(signo);
424         raise(signo);
425 }
426
427 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
428 {
429         struct ref *ref;
430         struct strbuf head = STRBUF_INIT;
431         strbuf_addstr(&head, "refs/heads/");
432         strbuf_addstr(&head, branch);
433         ref = find_ref_by_name(refs, head.buf);
434         strbuf_release(&head);
435
436         if (ref)
437                 return ref;
438
439         strbuf_addstr(&head, "refs/tags/");
440         strbuf_addstr(&head, branch);
441         ref = find_ref_by_name(refs, head.buf);
442         strbuf_release(&head);
443
444         return ref;
445 }
446
447 static struct ref *wanted_peer_refs(const struct ref *refs,
448                 struct refspec *refspec)
449 {
450         struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
451         struct ref *local_refs = head;
452         struct ref **tail = head ? &head->next : &local_refs;
453
454         if (option_single_branch) {
455                 struct ref *remote_head = NULL;
456
457                 if (!option_branch)
458                         remote_head = guess_remote_head(head, refs, 0);
459                 else {
460                         local_refs = NULL;
461                         tail = &local_refs;
462                         remote_head = copy_ref(find_remote_branch(refs, option_branch));
463                 }
464
465                 if (!remote_head && option_branch)
466                         warning(_("Could not find remote branch %s to clone."),
467                                 option_branch);
468                 else {
469                         get_fetch_map(remote_head, refspec, &tail, 0);
470
471                         /* if --branch=tag, pull the requested tag explicitly */
472                         get_fetch_map(remote_head, tag_refspec, &tail, 0);
473                 }
474         } else
475                 get_fetch_map(refs, refspec, &tail, 0);
476
477         if (!option_mirror && !option_single_branch)
478                 get_fetch_map(refs, tag_refspec, &tail, 0);
479
480         return local_refs;
481 }
482
483 static void write_remote_refs(const struct ref *local_refs)
484 {
485         const struct ref *r;
486
487         for (r = local_refs; r; r = r->next) {
488                 if (!r->peer_ref)
489                         continue;
490                 add_packed_ref(r->peer_ref->name, r->old_sha1);
491         }
492
493         pack_refs(PACK_REFS_ALL);
494 }
495
496 static void write_followtags(const struct ref *refs, const char *msg)
497 {
498         const struct ref *ref;
499         for (ref = refs; ref; ref = ref->next) {
500                 if (prefixcmp(ref->name, "refs/tags/"))
501                         continue;
502                 if (!suffixcmp(ref->name, "^{}"))
503                         continue;
504                 if (!has_sha1_file(ref->old_sha1))
505                         continue;
506                 update_ref(msg, ref->name, ref->old_sha1,
507                            NULL, 0, DIE_ON_ERR);
508         }
509 }
510
511 static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
512 {
513         struct ref **rm = cb_data;
514         struct ref *ref = *rm;
515
516         /*
517          * Skip anything missing a peer_ref, which we are not
518          * actually going to write a ref for.
519          */
520         while (ref && !ref->peer_ref)
521                 ref = ref->next;
522         /* Returning -1 notes "end of list" to the caller. */
523         if (!ref)
524                 return -1;
525
526         hashcpy(sha1, ref->old_sha1);
527         *rm = ref->next;
528         return 0;
529 }
530
531 static void update_remote_refs(const struct ref *refs,
532                                const struct ref *mapped_refs,
533                                const struct ref *remote_head_points_at,
534                                const char *branch_top,
535                                const char *msg)
536 {
537         const struct ref *rm = mapped_refs;
538
539         if (check_everything_connected(iterate_ref_map, 0, &rm))
540                 die(_("remote did not send all necessary objects"));
541
542         if (refs) {
543                 write_remote_refs(mapped_refs);
544                 if (option_single_branch)
545                         write_followtags(refs, msg);
546         }
547
548         if (remote_head_points_at && !option_bare) {
549                 struct strbuf head_ref = STRBUF_INIT;
550                 strbuf_addstr(&head_ref, branch_top);
551                 strbuf_addstr(&head_ref, "HEAD");
552                 create_symref(head_ref.buf,
553                               remote_head_points_at->peer_ref->name,
554                               msg);
555         }
556 }
557
558 static void update_head(const struct ref *our, const struct ref *remote,
559                         const char *msg)
560 {
561         if (our && !prefixcmp(our->name, "refs/heads/")) {
562                 /* Local default branch link */
563                 create_symref("HEAD", our->name, NULL);
564                 if (!option_bare) {
565                         const char *head = skip_prefix(our->name, "refs/heads/");
566                         update_ref(msg, "HEAD", our->old_sha1, NULL, 0, DIE_ON_ERR);
567                         install_branch_config(0, head, option_origin, our->name);
568                 }
569         } else if (our) {
570                 struct commit *c = lookup_commit_reference(our->old_sha1);
571                 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
572                 update_ref(msg, "HEAD", c->object.sha1,
573                            NULL, REF_NODEREF, DIE_ON_ERR);
574         } else if (remote) {
575                 /*
576                  * We know remote HEAD points to a non-branch, or
577                  * HEAD points to a branch but we don't know which one.
578                  * Detach HEAD in all these cases.
579                  */
580                 update_ref(msg, "HEAD", remote->old_sha1,
581                            NULL, REF_NODEREF, DIE_ON_ERR);
582         }
583 }
584
585 static int checkout(void)
586 {
587         unsigned char sha1[20];
588         char *head;
589         struct lock_file *lock_file;
590         struct unpack_trees_options opts;
591         struct tree *tree;
592         struct tree_desc t;
593         int err = 0, fd;
594
595         if (option_no_checkout)
596                 return 0;
597
598         head = resolve_refdup("HEAD", sha1, 1, NULL);
599         if (!head) {
600                 warning(_("remote HEAD refers to nonexistent ref, "
601                           "unable to checkout.\n"));
602                 return 0;
603         }
604         if (!strcmp(head, "HEAD")) {
605                 if (advice_detached_head)
606                         detach_advice(sha1_to_hex(sha1));
607         } else {
608                 if (prefixcmp(head, "refs/heads/"))
609                         die(_("HEAD not found below refs/heads!"));
610         }
611         free(head);
612
613         /* We need to be in the new work tree for the checkout */
614         setup_work_tree();
615
616         lock_file = xcalloc(1, sizeof(struct lock_file));
617         fd = hold_locked_index(lock_file, 1);
618
619         memset(&opts, 0, sizeof opts);
620         opts.update = 1;
621         opts.merge = 1;
622         opts.fn = oneway_merge;
623         opts.verbose_update = (option_verbosity >= 0);
624         opts.src_index = &the_index;
625         opts.dst_index = &the_index;
626
627         tree = parse_tree_indirect(sha1);
628         parse_tree(tree);
629         init_tree_desc(&t, tree->buffer, tree->size);
630         if (unpack_trees(1, &t, &opts) < 0)
631                 die(_("unable to checkout working tree"));
632
633         if (write_cache(fd, active_cache, active_nr) ||
634             commit_locked_index(lock_file))
635                 die(_("unable to write new index file"));
636
637         err |= run_hook(NULL, "post-checkout", sha1_to_hex(null_sha1),
638                         sha1_to_hex(sha1), "1", NULL);
639
640         if (!err && option_recursive)
641                 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
642
643         return err;
644 }
645
646 static int write_one_config(const char *key, const char *value, void *data)
647 {
648         return git_config_set_multivar(key, value ? value : "true", "^$", 0);
649 }
650
651 static void write_config(struct string_list *config)
652 {
653         int i;
654
655         for (i = 0; i < config->nr; i++) {
656                 if (git_config_parse_parameter(config->items[i].string,
657                                                write_one_config, NULL) < 0)
658                         die("unable to write parameters to config file");
659         }
660 }
661
662 static void write_refspec_config(const char* src_ref_prefix,
663                 const struct ref* our_head_points_at,
664                 const struct ref* remote_head_points_at, struct strbuf* branch_top)
665 {
666         struct strbuf key = STRBUF_INIT;
667         struct strbuf value = STRBUF_INIT;
668
669         if (option_mirror || !option_bare) {
670                 if (option_single_branch && !option_mirror) {
671                         if (option_branch) {
672                                 if (strstr(our_head_points_at->name, "refs/tags/"))
673                                         strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
674                                                 our_head_points_at->name);
675                                 else
676                                         strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
677                                                 branch_top->buf, option_branch);
678                         } else if (remote_head_points_at) {
679                                 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
680                                                 branch_top->buf,
681                                                 skip_prefix(remote_head_points_at->name, "refs/heads/"));
682                         }
683                         /*
684                          * otherwise, the next "git fetch" will
685                          * simply fetch from HEAD without updating
686                          * any remote tracking branch, which is what
687                          * we want.
688                          */
689                 } else {
690                         strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
691                 }
692                 /* Configure the remote */
693                 if (value.len) {
694                         strbuf_addf(&key, "remote.%s.fetch", option_origin);
695                         git_config_set_multivar(key.buf, value.buf, "^$", 0);
696                         strbuf_reset(&key);
697
698                         if (option_mirror) {
699                                 strbuf_addf(&key, "remote.%s.mirror", option_origin);
700                                 git_config_set(key.buf, "true");
701                                 strbuf_reset(&key);
702                         }
703                 }
704         }
705
706         strbuf_release(&key);
707         strbuf_release(&value);
708 }
709
710 int cmd_clone(int argc, const char **argv, const char *prefix)
711 {
712         int is_bundle = 0, is_local;
713         struct stat buf;
714         const char *repo_name, *repo, *work_tree, *git_dir;
715         char *path, *dir;
716         int dest_exists;
717         const struct ref *refs, *remote_head;
718         const struct ref *remote_head_points_at;
719         const struct ref *our_head_points_at;
720         struct ref *mapped_refs;
721         const struct ref *ref;
722         struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
723         struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
724         struct transport *transport = NULL;
725         const char *src_ref_prefix = "refs/heads/";
726         struct remote *remote;
727         int err = 0, complete_refs_before_fetch = 1;
728
729         struct refspec *refspec;
730         const char *fetch_pattern;
731
732         junk_pid = getpid();
733
734         packet_trace_identity("clone");
735         argc = parse_options(argc, argv, prefix, builtin_clone_options,
736                              builtin_clone_usage, 0);
737
738         if (argc > 2)
739                 usage_msg_opt(_("Too many arguments."),
740                         builtin_clone_usage, builtin_clone_options);
741
742         if (argc == 0)
743                 usage_msg_opt(_("You must specify a repository to clone."),
744                         builtin_clone_usage, builtin_clone_options);
745
746         if (option_single_branch == -1)
747                 option_single_branch = option_depth ? 1 : 0;
748
749         if (option_mirror)
750                 option_bare = 1;
751
752         if (option_bare) {
753                 if (option_origin)
754                         die(_("--bare and --origin %s options are incompatible."),
755                             option_origin);
756                 if (real_git_dir)
757                         die(_("--bare and --separate-git-dir are incompatible."));
758                 option_no_checkout = 1;
759         }
760
761         if (!option_origin)
762                 option_origin = "origin";
763
764         repo_name = argv[0];
765
766         path = get_repo_path(repo_name, &is_bundle);
767         if (path)
768                 repo = xstrdup(absolute_path(repo_name));
769         else if (!strchr(repo_name, ':'))
770                 die(_("repository '%s' does not exist"), repo_name);
771         else
772                 repo = repo_name;
773         is_local = option_local != 0 && path && !is_bundle;
774         if (is_local && option_depth)
775                 warning(_("--depth is ignored in local clones; use file:// instead."));
776
777         if (argc == 2)
778                 dir = xstrdup(argv[1]);
779         else
780                 dir = guess_dir_name(repo_name, is_bundle, option_bare);
781         strip_trailing_slashes(dir);
782
783         dest_exists = !stat(dir, &buf);
784         if (dest_exists && !is_empty_dir(dir))
785                 die(_("destination path '%s' already exists and is not "
786                         "an empty directory."), dir);
787
788         strbuf_addf(&reflog_msg, "clone: from %s", repo);
789
790         if (option_bare)
791                 work_tree = NULL;
792         else {
793                 work_tree = getenv("GIT_WORK_TREE");
794                 if (work_tree && !stat(work_tree, &buf))
795                         die(_("working tree '%s' already exists."), work_tree);
796         }
797
798         if (option_bare || work_tree)
799                 git_dir = xstrdup(dir);
800         else {
801                 work_tree = dir;
802                 git_dir = mkpathdup("%s/.git", dir);
803         }
804
805         if (!option_bare) {
806                 junk_work_tree = work_tree;
807                 if (safe_create_leading_directories_const(work_tree) < 0)
808                         die_errno(_("could not create leading directories of '%s'"),
809                                   work_tree);
810                 if (!dest_exists && mkdir(work_tree, 0777))
811                         die_errno(_("could not create work tree dir '%s'."),
812                                   work_tree);
813                 set_git_work_tree(work_tree);
814         }
815         junk_git_dir = git_dir;
816         atexit(remove_junk);
817         sigchain_push_common(remove_junk_on_signal);
818
819         if (safe_create_leading_directories_const(git_dir) < 0)
820                 die(_("could not create leading directories of '%s'"), git_dir);
821
822         set_git_dir_init(git_dir, real_git_dir, 0);
823         if (real_git_dir) {
824                 git_dir = real_git_dir;
825                 junk_git_dir = real_git_dir;
826         }
827
828         if (0 <= option_verbosity) {
829                 if (option_bare)
830                         printf(_("Cloning into bare repository '%s'...\n"), dir);
831                 else
832                         printf(_("Cloning into '%s'...\n"), dir);
833         }
834         init_db(option_template, INIT_DB_QUIET);
835         write_config(&option_config);
836
837         git_config(git_default_config, NULL);
838
839         if (option_bare) {
840                 if (option_mirror)
841                         src_ref_prefix = "refs/";
842                 strbuf_addstr(&branch_top, src_ref_prefix);
843
844                 git_config_set("core.bare", "true");
845         } else {
846                 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
847         }
848
849         strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
850         strbuf_addf(&key, "remote.%s.url", option_origin);
851         git_config_set(key.buf, repo);
852         strbuf_reset(&key);
853
854         if (option_reference.nr)
855                 setup_reference();
856
857         fetch_pattern = value.buf;
858         refspec = parse_fetch_refspec(1, &fetch_pattern);
859
860         strbuf_reset(&value);
861
862         remote = remote_get(option_origin);
863         transport = transport_get(remote, remote->url[0]);
864
865         if (!is_local) {
866                 if (!transport->get_refs_list || !transport->fetch)
867                         die(_("Don't know how to clone %s"), transport->url);
868
869                 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
870
871                 if (option_depth)
872                         transport_set_option(transport, TRANS_OPT_DEPTH,
873                                              option_depth);
874                 if (option_single_branch)
875                         transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
876
877                 transport_set_verbosity(transport, option_verbosity, option_progress);
878
879                 if (option_upload_pack)
880                         transport_set_option(transport, TRANS_OPT_UPLOADPACK,
881                                              option_upload_pack);
882         }
883
884         refs = transport_get_remote_refs(transport);
885
886         if (refs) {
887                 mapped_refs = wanted_peer_refs(refs, refspec);
888                 /*
889                  * transport_get_remote_refs() may return refs with null sha-1
890                  * in mapped_refs (see struct transport->get_refs_list
891                  * comment). In that case we need fetch it early because
892                  * remote_head code below relies on it.
893                  *
894                  * for normal clones, transport_get_remote_refs() should
895                  * return reliable ref set, we can delay cloning until after
896                  * remote HEAD check.
897                  */
898                 for (ref = refs; ref; ref = ref->next)
899                         if (is_null_sha1(ref->old_sha1)) {
900                                 complete_refs_before_fetch = 0;
901                                 break;
902                         }
903
904                 if (!is_local && !complete_refs_before_fetch)
905                         transport_fetch_refs(transport, mapped_refs);
906
907                 remote_head = find_ref_by_name(refs, "HEAD");
908                 remote_head_points_at =
909                         guess_remote_head(remote_head, mapped_refs, 0);
910
911                 if (option_branch) {
912                         our_head_points_at =
913                                 find_remote_branch(mapped_refs, option_branch);
914
915                         if (!our_head_points_at)
916                                 die(_("Remote branch %s not found in upstream %s"),
917                                     option_branch, option_origin);
918                 }
919                 else
920                         our_head_points_at = remote_head_points_at;
921         }
922         else {
923                 warning(_("You appear to have cloned an empty repository."));
924                 mapped_refs = NULL;
925                 our_head_points_at = NULL;
926                 remote_head_points_at = NULL;
927                 remote_head = NULL;
928                 option_no_checkout = 1;
929                 if (!option_bare)
930                         install_branch_config(0, "master", option_origin,
931                                               "refs/heads/master");
932         }
933
934         write_refspec_config(src_ref_prefix, our_head_points_at,
935                         remote_head_points_at, &branch_top);
936
937         if (is_local)
938                 clone_local(path, git_dir);
939         else if (refs && complete_refs_before_fetch)
940                 transport_fetch_refs(transport, mapped_refs);
941
942         update_remote_refs(refs, mapped_refs, remote_head_points_at,
943                            branch_top.buf, reflog_msg.buf);
944
945         update_head(our_head_points_at, remote_head, reflog_msg.buf);
946
947         transport_unlock_pack(transport);
948         transport_disconnect(transport);
949
950         junk_mode = JUNK_LEAVE_REPO;
951         err = checkout();
952
953         strbuf_release(&reflog_msg);
954         strbuf_release(&branch_top);
955         strbuf_release(&key);
956         strbuf_release(&value);
957         junk_mode = JUNK_LEAVE_ALL;
958         return err;
959 }