Merge branch 'jc/blame-reverse'
[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 "lockfile.h"
13 #include "parse-options.h"
14 #include "fetch-pack.h"
15 #include "refs.h"
16 #include "tree.h"
17 #include "tree-walk.h"
18 #include "unpack-trees.h"
19 #include "transport.h"
20 #include "strbuf.h"
21 #include "dir.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 int option_shallow_submodules;
44 static int deepen;
45 static char *option_template, *option_depth, *option_since;
46 static char *option_origin = NULL;
47 static char *option_branch = NULL;
48 static struct string_list option_not = STRING_LIST_INIT_NODUP;
49 static const char *real_git_dir;
50 static char *option_upload_pack = "git-upload-pack";
51 static int option_verbosity;
52 static int option_progress = -1;
53 static enum transport_family family;
54 static struct string_list option_config = STRING_LIST_INIT_NODUP;
55 static struct string_list option_required_reference = STRING_LIST_INIT_NODUP;
56 static struct string_list option_optional_reference = STRING_LIST_INIT_NODUP;
57 static int option_dissociate;
58 static int max_jobs = -1;
59
60 static struct option builtin_clone_options[] = {
61         OPT__VERBOSITY(&option_verbosity),
62         OPT_BOOL(0, "progress", &option_progress,
63                  N_("force progress reporting")),
64         OPT_BOOL('n', "no-checkout", &option_no_checkout,
65                  N_("don't create a checkout")),
66         OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
67         OPT_HIDDEN_BOOL(0, "naked", &option_bare,
68                         N_("create a bare repository")),
69         OPT_BOOL(0, "mirror", &option_mirror,
70                  N_("create a mirror repository (implies bare)")),
71         OPT_BOOL('l', "local", &option_local,
72                 N_("to clone from a local repository")),
73         OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
74                     N_("don't use local hardlinks, always copy")),
75         OPT_BOOL('s', "shared", &option_shared,
76                     N_("setup as shared repository")),
77         OPT_BOOL(0, "recursive", &option_recursive,
78                     N_("initialize submodules in the clone")),
79         OPT_BOOL(0, "recurse-submodules", &option_recursive,
80                     N_("initialize submodules in the clone")),
81         OPT_INTEGER('j', "jobs", &max_jobs,
82                     N_("number of submodules cloned in parallel")),
83         OPT_STRING(0, "template", &option_template, N_("template-directory"),
84                    N_("directory from which templates will be used")),
85         OPT_STRING_LIST(0, "reference", &option_required_reference, N_("repo"),
86                         N_("reference repository")),
87         OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference,
88                         N_("repo"), N_("reference repository")),
89         OPT_BOOL(0, "dissociate", &option_dissociate,
90                  N_("use --reference only while cloning")),
91         OPT_STRING('o', "origin", &option_origin, N_("name"),
92                    N_("use <name> instead of 'origin' to track upstream")),
93         OPT_STRING('b', "branch", &option_branch, N_("branch"),
94                    N_("checkout <branch> instead of the remote's HEAD")),
95         OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
96                    N_("path to git-upload-pack on the remote")),
97         OPT_STRING(0, "depth", &option_depth, N_("depth"),
98                     N_("create a shallow clone of that depth")),
99         OPT_STRING(0, "shallow-since", &option_since, N_("time"),
100                     N_("create a shallow clone since a specific time")),
101         OPT_STRING_LIST(0, "shallow-exclude", &option_not, N_("revision"),
102                         N_("deepen history of shallow clone by excluding rev")),
103         OPT_BOOL(0, "single-branch", &option_single_branch,
104                     N_("clone only one branch, HEAD or --branch")),
105         OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules,
106                     N_("any cloned submodules will be shallow")),
107         OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
108                    N_("separate git dir from working tree")),
109         OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
110                         N_("set config inside the new repository")),
111         OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
112                         TRANSPORT_FAMILY_IPV4),
113         OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
114                         TRANSPORT_FAMILY_IPV6),
115         OPT_END()
116 };
117
118 static const char *get_repo_path_1(struct strbuf *path, int *is_bundle)
119 {
120         static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
121         static char *bundle_suffix[] = { ".bundle", "" };
122         size_t baselen = path->len;
123         struct stat st;
124         int i;
125
126         for (i = 0; i < ARRAY_SIZE(suffix); i++) {
127                 strbuf_setlen(path, baselen);
128                 strbuf_addstr(path, suffix[i]);
129                 if (stat(path->buf, &st))
130                         continue;
131                 if (S_ISDIR(st.st_mode) && is_git_directory(path->buf)) {
132                         *is_bundle = 0;
133                         return path->buf;
134                 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
135                         /* Is it a "gitfile"? */
136                         char signature[8];
137                         const char *dst;
138                         int len, fd = open(path->buf, O_RDONLY);
139                         if (fd < 0)
140                                 continue;
141                         len = read_in_full(fd, signature, 8);
142                         close(fd);
143                         if (len != 8 || strncmp(signature, "gitdir: ", 8))
144                                 continue;
145                         dst = read_gitfile(path->buf);
146                         if (dst) {
147                                 *is_bundle = 0;
148                                 return dst;
149                         }
150                 }
151         }
152
153         for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
154                 strbuf_setlen(path, baselen);
155                 strbuf_addstr(path, bundle_suffix[i]);
156                 if (!stat(path->buf, &st) && S_ISREG(st.st_mode)) {
157                         *is_bundle = 1;
158                         return path->buf;
159                 }
160         }
161
162         return NULL;
163 }
164
165 static char *get_repo_path(const char *repo, int *is_bundle)
166 {
167         struct strbuf path = STRBUF_INIT;
168         const char *raw;
169         char *canon;
170
171         strbuf_addstr(&path, repo);
172         raw = get_repo_path_1(&path, is_bundle);
173         canon = raw ? xstrdup(absolute_path(raw)) : NULL;
174         strbuf_release(&path);
175         return canon;
176 }
177
178 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
179 {
180         const char *end = repo + strlen(repo), *start, *ptr;
181         size_t len;
182         char *dir;
183
184         /*
185          * Skip scheme.
186          */
187         start = strstr(repo, "://");
188         if (start == NULL)
189                 start = repo;
190         else
191                 start += 3;
192
193         /*
194          * Skip authentication data. The stripping does happen
195          * greedily, such that we strip up to the last '@' inside
196          * the host part.
197          */
198         for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
199                 if (*ptr == '@')
200                         start = ptr + 1;
201         }
202
203         /*
204          * Strip trailing spaces, slashes and /.git
205          */
206         while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
207                 end--;
208         if (end - start > 5 && is_dir_sep(end[-5]) &&
209             !strncmp(end - 4, ".git", 4)) {
210                 end -= 5;
211                 while (start < end && is_dir_sep(end[-1]))
212                         end--;
213         }
214
215         /*
216          * Strip trailing port number if we've got only a
217          * hostname (that is, there is no dir separator but a
218          * colon). This check is required such that we do not
219          * strip URI's like '/foo/bar:2222.git', which should
220          * result in a dir '2222' being guessed due to backwards
221          * compatibility.
222          */
223         if (memchr(start, '/', end - start) == NULL
224             && memchr(start, ':', end - start) != NULL) {
225                 ptr = end;
226                 while (start < ptr && isdigit(ptr[-1]) && ptr[-1] != ':')
227                         ptr--;
228                 if (start < ptr && ptr[-1] == ':')
229                         end = ptr - 1;
230         }
231
232         /*
233          * Find last component. To remain backwards compatible we
234          * also regard colons as path separators, such that
235          * cloning a repository 'foo:bar.git' would result in a
236          * directory 'bar' being guessed.
237          */
238         ptr = end;
239         while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
240                 ptr--;
241         start = ptr;
242
243         /*
244          * Strip .{bundle,git}.
245          */
246         len = end - start;
247         strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
248
249         if (!len || (len == 1 && *start == '/'))
250                 die(_("No directory name could be guessed.\n"
251                       "Please specify a directory on the command line"));
252
253         if (is_bare)
254                 dir = xstrfmt("%.*s.git", (int)len, start);
255         else
256                 dir = xstrndup(start, len);
257         /*
258          * Replace sequences of 'control' characters and whitespace
259          * with one ascii space, remove leading and trailing spaces.
260          */
261         if (*dir) {
262                 char *out = dir;
263                 int prev_space = 1 /* strip leading whitespace */;
264                 for (end = dir; *end; ++end) {
265                         char ch = *end;
266                         if ((unsigned char)ch < '\x20')
267                                 ch = '\x20';
268                         if (isspace(ch)) {
269                                 if (prev_space)
270                                         continue;
271                                 prev_space = 1;
272                         } else
273                                 prev_space = 0;
274                         *out++ = ch;
275                 }
276                 *out = '\0';
277                 if (out > dir && prev_space)
278                         out[-1] = '\0';
279         }
280         return dir;
281 }
282
283 static void strip_trailing_slashes(char *dir)
284 {
285         char *end = dir + strlen(dir);
286
287         while (dir < end - 1 && is_dir_sep(end[-1]))
288                 end--;
289         *end = '\0';
290 }
291
292 static int add_one_reference(struct string_list_item *item, void *cb_data)
293 {
294         struct strbuf err = STRBUF_INIT;
295         int *required = cb_data;
296         char *ref_git = compute_alternate_path(item->string, &err);
297
298         if (!ref_git) {
299                 if (*required)
300                         die("%s", err.buf);
301                 else
302                         fprintf(stderr,
303                                 _("info: Could not add alternate for '%s': %s\n"),
304                                 item->string, err.buf);
305         } else {
306                 struct strbuf sb = STRBUF_INIT;
307                 strbuf_addf(&sb, "%s/objects", ref_git);
308                 add_to_alternates_file(sb.buf);
309                 strbuf_release(&sb);
310         }
311
312         strbuf_release(&err);
313         free(ref_git);
314         return 0;
315 }
316
317 static void setup_reference(void)
318 {
319         int required = 1;
320         for_each_string_list(&option_required_reference,
321                              add_one_reference, &required);
322         required = 0;
323         for_each_string_list(&option_optional_reference,
324                              add_one_reference, &required);
325 }
326
327 static void copy_alternates(struct strbuf *src, struct strbuf *dst,
328                             const char *src_repo)
329 {
330         /*
331          * Read from the source objects/info/alternates file
332          * and copy the entries to corresponding file in the
333          * destination repository with add_to_alternates_file().
334          * Both src and dst have "$path/objects/info/alternates".
335          *
336          * Instead of copying bit-for-bit from the original,
337          * we need to append to existing one so that the already
338          * created entry via "clone -s" is not lost, and also
339          * to turn entries with paths relative to the original
340          * absolute, so that they can be used in the new repository.
341          */
342         FILE *in = fopen(src->buf, "r");
343         struct strbuf line = STRBUF_INIT;
344
345         while (strbuf_getline(&line, in) != EOF) {
346                 char *abs_path;
347                 if (!line.len || line.buf[0] == '#')
348                         continue;
349                 if (is_absolute_path(line.buf)) {
350                         add_to_alternates_file(line.buf);
351                         continue;
352                 }
353                 abs_path = mkpathdup("%s/objects/%s", src_repo, line.buf);
354                 normalize_path_copy(abs_path, abs_path);
355                 add_to_alternates_file(abs_path);
356                 free(abs_path);
357         }
358         strbuf_release(&line);
359         fclose(in);
360 }
361
362 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
363                                    const char *src_repo, int src_baselen)
364 {
365         struct dirent *de;
366         struct stat buf;
367         int src_len, dest_len;
368         DIR *dir;
369
370         dir = opendir(src->buf);
371         if (!dir)
372                 die_errno(_("failed to open '%s'"), src->buf);
373
374         if (mkdir(dest->buf, 0777)) {
375                 if (errno != EEXIST)
376                         die_errno(_("failed to create directory '%s'"), dest->buf);
377                 else if (stat(dest->buf, &buf))
378                         die_errno(_("failed to stat '%s'"), dest->buf);
379                 else if (!S_ISDIR(buf.st_mode))
380                         die(_("%s exists and is not a directory"), dest->buf);
381         }
382
383         strbuf_addch(src, '/');
384         src_len = src->len;
385         strbuf_addch(dest, '/');
386         dest_len = dest->len;
387
388         while ((de = readdir(dir)) != NULL) {
389                 strbuf_setlen(src, src_len);
390                 strbuf_addstr(src, de->d_name);
391                 strbuf_setlen(dest, dest_len);
392                 strbuf_addstr(dest, de->d_name);
393                 if (stat(src->buf, &buf)) {
394                         warning (_("failed to stat %s\n"), src->buf);
395                         continue;
396                 }
397                 if (S_ISDIR(buf.st_mode)) {
398                         if (de->d_name[0] != '.')
399                                 copy_or_link_directory(src, dest,
400                                                        src_repo, src_baselen);
401                         continue;
402                 }
403
404                 /* Files that cannot be copied bit-for-bit... */
405                 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
406                         copy_alternates(src, dest, src_repo);
407                         continue;
408                 }
409
410                 if (unlink(dest->buf) && errno != ENOENT)
411                         die_errno(_("failed to unlink '%s'"), dest->buf);
412                 if (!option_no_hardlinks) {
413                         if (!link(src->buf, dest->buf))
414                                 continue;
415                         if (option_local > 0)
416                                 die_errno(_("failed to create link '%s'"), dest->buf);
417                         option_no_hardlinks = 1;
418                 }
419                 if (copy_file_with_time(dest->buf, src->buf, 0666))
420                         die_errno(_("failed to copy file to '%s'"), dest->buf);
421         }
422         closedir(dir);
423 }
424
425 static void clone_local(const char *src_repo, const char *dest_repo)
426 {
427         if (option_shared) {
428                 struct strbuf alt = STRBUF_INIT;
429                 strbuf_addf(&alt, "%s/objects", src_repo);
430                 add_to_alternates_file(alt.buf);
431                 strbuf_release(&alt);
432         } else {
433                 struct strbuf src = STRBUF_INIT;
434                 struct strbuf dest = STRBUF_INIT;
435                 get_common_dir(&src, src_repo);
436                 get_common_dir(&dest, dest_repo);
437                 strbuf_addstr(&src, "/objects");
438                 strbuf_addstr(&dest, "/objects");
439                 copy_or_link_directory(&src, &dest, src_repo, src.len);
440                 strbuf_release(&src);
441                 strbuf_release(&dest);
442         }
443
444         if (0 <= option_verbosity)
445                 fprintf(stderr, _("done.\n"));
446 }
447
448 static const char *junk_work_tree;
449 static const char *junk_git_dir;
450 static enum {
451         JUNK_LEAVE_NONE,
452         JUNK_LEAVE_REPO,
453         JUNK_LEAVE_ALL
454 } junk_mode = JUNK_LEAVE_NONE;
455
456 static const char junk_leave_repo_msg[] =
457 N_("Clone succeeded, but checkout failed.\n"
458    "You can inspect what was checked out with 'git status'\n"
459    "and retry the checkout with 'git checkout -f HEAD'\n");
460
461 static void remove_junk(void)
462 {
463         struct strbuf sb = STRBUF_INIT;
464
465         switch (junk_mode) {
466         case JUNK_LEAVE_REPO:
467                 warning("%s", _(junk_leave_repo_msg));
468                 /* fall-through */
469         case JUNK_LEAVE_ALL:
470                 return;
471         default:
472                 /* proceed to removal */
473                 break;
474         }
475
476         if (junk_git_dir) {
477                 strbuf_addstr(&sb, junk_git_dir);
478                 remove_dir_recursively(&sb, 0);
479                 strbuf_reset(&sb);
480         }
481         if (junk_work_tree) {
482                 strbuf_addstr(&sb, junk_work_tree);
483                 remove_dir_recursively(&sb, 0);
484                 strbuf_reset(&sb);
485         }
486 }
487
488 static void remove_junk_on_signal(int signo)
489 {
490         remove_junk();
491         sigchain_pop(signo);
492         raise(signo);
493 }
494
495 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
496 {
497         struct ref *ref;
498         struct strbuf head = STRBUF_INIT;
499         strbuf_addstr(&head, "refs/heads/");
500         strbuf_addstr(&head, branch);
501         ref = find_ref_by_name(refs, head.buf);
502         strbuf_release(&head);
503
504         if (ref)
505                 return ref;
506
507         strbuf_addstr(&head, "refs/tags/");
508         strbuf_addstr(&head, branch);
509         ref = find_ref_by_name(refs, head.buf);
510         strbuf_release(&head);
511
512         return ref;
513 }
514
515 static struct ref *wanted_peer_refs(const struct ref *refs,
516                 struct refspec *refspec)
517 {
518         struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
519         struct ref *local_refs = head;
520         struct ref **tail = head ? &head->next : &local_refs;
521
522         if (option_single_branch) {
523                 struct ref *remote_head = NULL;
524
525                 if (!option_branch)
526                         remote_head = guess_remote_head(head, refs, 0);
527                 else {
528                         local_refs = NULL;
529                         tail = &local_refs;
530                         remote_head = copy_ref(find_remote_branch(refs, option_branch));
531                 }
532
533                 if (!remote_head && option_branch)
534                         warning(_("Could not find remote branch %s to clone."),
535                                 option_branch);
536                 else {
537                         get_fetch_map(remote_head, refspec, &tail, 0);
538
539                         /* if --branch=tag, pull the requested tag explicitly */
540                         get_fetch_map(remote_head, tag_refspec, &tail, 0);
541                 }
542         } else
543                 get_fetch_map(refs, refspec, &tail, 0);
544
545         if (!option_mirror && !option_single_branch)
546                 get_fetch_map(refs, tag_refspec, &tail, 0);
547
548         return local_refs;
549 }
550
551 static void write_remote_refs(const struct ref *local_refs)
552 {
553         const struct ref *r;
554
555         struct ref_transaction *t;
556         struct strbuf err = STRBUF_INIT;
557
558         t = ref_transaction_begin(&err);
559         if (!t)
560                 die("%s", err.buf);
561
562         for (r = local_refs; r; r = r->next) {
563                 if (!r->peer_ref)
564                         continue;
565                 if (ref_transaction_create(t, r->peer_ref->name, r->old_oid.hash,
566                                            0, NULL, &err))
567                         die("%s", err.buf);
568         }
569
570         if (initial_ref_transaction_commit(t, &err))
571                 die("%s", err.buf);
572
573         strbuf_release(&err);
574         ref_transaction_free(t);
575 }
576
577 static void write_followtags(const struct ref *refs, const char *msg)
578 {
579         const struct ref *ref;
580         for (ref = refs; ref; ref = ref->next) {
581                 if (!starts_with(ref->name, "refs/tags/"))
582                         continue;
583                 if (ends_with(ref->name, "^{}"))
584                         continue;
585                 if (!has_object_file(&ref->old_oid))
586                         continue;
587                 update_ref(msg, ref->name, ref->old_oid.hash,
588                            NULL, 0, UPDATE_REFS_DIE_ON_ERR);
589         }
590 }
591
592 static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
593 {
594         struct ref **rm = cb_data;
595         struct ref *ref = *rm;
596
597         /*
598          * Skip anything missing a peer_ref, which we are not
599          * actually going to write a ref for.
600          */
601         while (ref && !ref->peer_ref)
602                 ref = ref->next;
603         /* Returning -1 notes "end of list" to the caller. */
604         if (!ref)
605                 return -1;
606
607         hashcpy(sha1, ref->old_oid.hash);
608         *rm = ref->next;
609         return 0;
610 }
611
612 static void update_remote_refs(const struct ref *refs,
613                                const struct ref *mapped_refs,
614                                const struct ref *remote_head_points_at,
615                                const char *branch_top,
616                                const char *msg,
617                                struct transport *transport,
618                                int check_connectivity)
619 {
620         const struct ref *rm = mapped_refs;
621
622         if (check_connectivity) {
623                 struct check_connected_options opt = CHECK_CONNECTED_INIT;
624
625                 opt.transport = transport;
626                 opt.progress = transport->progress;
627
628                 if (check_connected(iterate_ref_map, &rm, &opt))
629                         die(_("remote did not send all necessary objects"));
630         }
631
632         if (refs) {
633                 write_remote_refs(mapped_refs);
634                 if (option_single_branch)
635                         write_followtags(refs, msg);
636         }
637
638         if (remote_head_points_at && !option_bare) {
639                 struct strbuf head_ref = STRBUF_INIT;
640                 strbuf_addstr(&head_ref, branch_top);
641                 strbuf_addstr(&head_ref, "HEAD");
642                 if (create_symref(head_ref.buf,
643                                   remote_head_points_at->peer_ref->name,
644                                   msg) < 0)
645                         die(_("unable to update %s"), head_ref.buf);
646                 strbuf_release(&head_ref);
647         }
648 }
649
650 static void update_head(const struct ref *our, const struct ref *remote,
651                         const char *msg)
652 {
653         const char *head;
654         if (our && skip_prefix(our->name, "refs/heads/", &head)) {
655                 /* Local default branch link */
656                 if (create_symref("HEAD", our->name, NULL) < 0)
657                         die(_("unable to update HEAD"));
658                 if (!option_bare) {
659                         update_ref(msg, "HEAD", our->old_oid.hash, NULL, 0,
660                                    UPDATE_REFS_DIE_ON_ERR);
661                         install_branch_config(0, head, option_origin, our->name);
662                 }
663         } else if (our) {
664                 struct commit *c = lookup_commit_reference(our->old_oid.hash);
665                 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
666                 update_ref(msg, "HEAD", c->object.oid.hash,
667                            NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
668         } else if (remote) {
669                 /*
670                  * We know remote HEAD points to a non-branch, or
671                  * HEAD points to a branch but we don't know which one.
672                  * Detach HEAD in all these cases.
673                  */
674                 update_ref(msg, "HEAD", remote->old_oid.hash,
675                            NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
676         }
677 }
678
679 static int checkout(int submodule_progress)
680 {
681         unsigned char sha1[20];
682         char *head;
683         struct lock_file *lock_file;
684         struct unpack_trees_options opts;
685         struct tree *tree;
686         struct tree_desc t;
687         int err = 0;
688
689         if (option_no_checkout)
690                 return 0;
691
692         head = resolve_refdup("HEAD", RESOLVE_REF_READING, sha1, NULL);
693         if (!head) {
694                 warning(_("remote HEAD refers to nonexistent ref, "
695                           "unable to checkout.\n"));
696                 return 0;
697         }
698         if (!strcmp(head, "HEAD")) {
699                 if (advice_detached_head)
700                         detach_advice(sha1_to_hex(sha1));
701         } else {
702                 if (!starts_with(head, "refs/heads/"))
703                         die(_("HEAD not found below refs/heads!"));
704         }
705         free(head);
706
707         /* We need to be in the new work tree for the checkout */
708         setup_work_tree();
709
710         lock_file = xcalloc(1, sizeof(struct lock_file));
711         hold_locked_index(lock_file, 1);
712
713         memset(&opts, 0, sizeof opts);
714         opts.update = 1;
715         opts.merge = 1;
716         opts.fn = oneway_merge;
717         opts.verbose_update = (option_verbosity >= 0);
718         opts.src_index = &the_index;
719         opts.dst_index = &the_index;
720
721         tree = parse_tree_indirect(sha1);
722         parse_tree(tree);
723         init_tree_desc(&t, tree->buffer, tree->size);
724         if (unpack_trees(1, &t, &opts) < 0)
725                 die(_("unable to checkout working tree"));
726
727         if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
728                 die(_("unable to write new index file"));
729
730         err |= run_hook_le(NULL, "post-checkout", sha1_to_hex(null_sha1),
731                            sha1_to_hex(sha1), "1", NULL);
732
733         if (!err && option_recursive) {
734                 struct argv_array args = ARGV_ARRAY_INIT;
735                 argv_array_pushl(&args, "submodule", "update", "--init", "--recursive", NULL);
736
737                 if (option_shallow_submodules == 1)
738                         argv_array_push(&args, "--depth=1");
739
740                 if (max_jobs != -1)
741                         argv_array_pushf(&args, "--jobs=%d", max_jobs);
742
743                 if (submodule_progress)
744                         argv_array_push(&args, "--progress");
745
746                 err = run_command_v_opt(args.argv, RUN_GIT_CMD);
747                 argv_array_clear(&args);
748         }
749
750         return err;
751 }
752
753 static int write_one_config(const char *key, const char *value, void *data)
754 {
755         return git_config_set_multivar_gently(key, value ? value : "true", "^$", 0);
756 }
757
758 static void write_config(struct string_list *config)
759 {
760         int i;
761
762         for (i = 0; i < config->nr; i++) {
763                 if (git_config_parse_parameter(config->items[i].string,
764                                                write_one_config, NULL) < 0)
765                         die(_("unable to write parameters to config file"));
766         }
767 }
768
769 static void write_refspec_config(const char *src_ref_prefix,
770                 const struct ref *our_head_points_at,
771                 const struct ref *remote_head_points_at,
772                 struct strbuf *branch_top)
773 {
774         struct strbuf key = STRBUF_INIT;
775         struct strbuf value = STRBUF_INIT;
776
777         if (option_mirror || !option_bare) {
778                 if (option_single_branch && !option_mirror) {
779                         if (option_branch) {
780                                 if (starts_with(our_head_points_at->name, "refs/tags/"))
781                                         strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
782                                                 our_head_points_at->name);
783                                 else
784                                         strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
785                                                 branch_top->buf, option_branch);
786                         } else if (remote_head_points_at) {
787                                 const char *head = remote_head_points_at->name;
788                                 if (!skip_prefix(head, "refs/heads/", &head))
789                                         die("BUG: remote HEAD points at non-head?");
790
791                                 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
792                                                 branch_top->buf, head);
793                         }
794                         /*
795                          * otherwise, the next "git fetch" will
796                          * simply fetch from HEAD without updating
797                          * any remote-tracking branch, which is what
798                          * we want.
799                          */
800                 } else {
801                         strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
802                 }
803                 /* Configure the remote */
804                 if (value.len) {
805                         strbuf_addf(&key, "remote.%s.fetch", option_origin);
806                         git_config_set_multivar(key.buf, value.buf, "^$", 0);
807                         strbuf_reset(&key);
808
809                         if (option_mirror) {
810                                 strbuf_addf(&key, "remote.%s.mirror", option_origin);
811                                 git_config_set(key.buf, "true");
812                                 strbuf_reset(&key);
813                         }
814                 }
815         }
816
817         strbuf_release(&key);
818         strbuf_release(&value);
819 }
820
821 static void dissociate_from_references(void)
822 {
823         static const char* argv[] = { "repack", "-a", "-d", NULL };
824         char *alternates = git_pathdup("objects/info/alternates");
825
826         if (!access(alternates, F_OK)) {
827                 if (run_command_v_opt(argv, RUN_GIT_CMD|RUN_COMMAND_NO_STDIN))
828                         die(_("cannot repack to clean up"));
829                 if (unlink(alternates) && errno != ENOENT)
830                         die_errno(_("cannot unlink temporary alternates file"));
831         }
832         free(alternates);
833 }
834
835 int cmd_clone(int argc, const char **argv, const char *prefix)
836 {
837         int is_bundle = 0, is_local;
838         struct stat buf;
839         const char *repo_name, *repo, *work_tree, *git_dir;
840         char *path, *dir;
841         int dest_exists;
842         const struct ref *refs, *remote_head;
843         const struct ref *remote_head_points_at;
844         const struct ref *our_head_points_at;
845         struct ref *mapped_refs;
846         const struct ref *ref;
847         struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
848         struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
849         struct transport *transport = NULL;
850         const char *src_ref_prefix = "refs/heads/";
851         struct remote *remote;
852         int err = 0, complete_refs_before_fetch = 1;
853         int submodule_progress;
854
855         struct refspec *refspec;
856         const char *fetch_pattern;
857
858         packet_trace_identity("clone");
859         argc = parse_options(argc, argv, prefix, builtin_clone_options,
860                              builtin_clone_usage, 0);
861
862         if (argc > 2)
863                 usage_msg_opt(_("Too many arguments."),
864                         builtin_clone_usage, builtin_clone_options);
865
866         if (argc == 0)
867                 usage_msg_opt(_("You must specify a repository to clone."),
868                         builtin_clone_usage, builtin_clone_options);
869
870         if (option_depth || option_since || option_not.nr)
871                 deepen = 1;
872         if (option_single_branch == -1)
873                 option_single_branch = deepen ? 1 : 0;
874
875         if (option_mirror)
876                 option_bare = 1;
877
878         if (option_bare) {
879                 if (option_origin)
880                         die(_("--bare and --origin %s options are incompatible."),
881                             option_origin);
882                 if (real_git_dir)
883                         die(_("--bare and --separate-git-dir are incompatible."));
884                 option_no_checkout = 1;
885         }
886
887         if (!option_origin)
888                 option_origin = "origin";
889
890         repo_name = argv[0];
891
892         path = get_repo_path(repo_name, &is_bundle);
893         if (path)
894                 repo = xstrdup(absolute_path(repo_name));
895         else if (!strchr(repo_name, ':'))
896                 die(_("repository '%s' does not exist"), repo_name);
897         else
898                 repo = repo_name;
899
900         /* no need to be strict, transport_set_option() will validate it again */
901         if (option_depth && atoi(option_depth) < 1)
902                 die(_("depth %s is not a positive number"), option_depth);
903
904         if (argc == 2)
905                 dir = xstrdup(argv[1]);
906         else
907                 dir = guess_dir_name(repo_name, is_bundle, option_bare);
908         strip_trailing_slashes(dir);
909
910         dest_exists = !stat(dir, &buf);
911         if (dest_exists && !is_empty_dir(dir))
912                 die(_("destination path '%s' already exists and is not "
913                         "an empty directory."), dir);
914
915         strbuf_addf(&reflog_msg, "clone: from %s", repo);
916
917         if (option_bare)
918                 work_tree = NULL;
919         else {
920                 work_tree = getenv("GIT_WORK_TREE");
921                 if (work_tree && !stat(work_tree, &buf))
922                         die(_("working tree '%s' already exists."), work_tree);
923         }
924
925         if (option_bare || work_tree)
926                 git_dir = xstrdup(dir);
927         else {
928                 work_tree = dir;
929                 git_dir = mkpathdup("%s/.git", dir);
930         }
931
932         atexit(remove_junk);
933         sigchain_push_common(remove_junk_on_signal);
934
935         if (!option_bare) {
936                 if (safe_create_leading_directories_const(work_tree) < 0)
937                         die_errno(_("could not create leading directories of '%s'"),
938                                   work_tree);
939                 if (!dest_exists && mkdir(work_tree, 0777))
940                         die_errno(_("could not create work tree dir '%s'"),
941                                   work_tree);
942                 junk_work_tree = work_tree;
943                 set_git_work_tree(work_tree);
944         }
945
946         junk_git_dir = real_git_dir ? real_git_dir : git_dir;
947         if (safe_create_leading_directories_const(git_dir) < 0)
948                 die(_("could not create leading directories of '%s'"), git_dir);
949
950         if (0 <= option_verbosity) {
951                 if (option_bare)
952                         fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
953                 else
954                         fprintf(stderr, _("Cloning into '%s'...\n"), dir);
955         }
956
957         if (option_recursive) {
958                 if (option_required_reference.nr &&
959                     option_optional_reference.nr)
960                         die(_("clone --recursive is not compatible with "
961                               "both --reference and --reference-if-able"));
962                 else if (option_required_reference.nr) {
963                         string_list_append(&option_config,
964                                 "submodule.alternateLocation=superproject");
965                         string_list_append(&option_config,
966                                 "submodule.alternateErrorStrategy=die");
967                 } else if (option_optional_reference.nr) {
968                         string_list_append(&option_config,
969                                 "submodule.alternateLocation=superproject");
970                         string_list_append(&option_config,
971                                 "submodule.alternateErrorStrategy=info");
972                 }
973         }
974
975         init_db(git_dir, real_git_dir, option_template, INIT_DB_QUIET);
976
977         if (real_git_dir)
978                 git_dir = real_git_dir;
979
980         write_config(&option_config);
981
982         git_config(git_default_config, NULL);
983
984         if (option_bare) {
985                 if (option_mirror)
986                         src_ref_prefix = "refs/";
987                 strbuf_addstr(&branch_top, src_ref_prefix);
988
989                 git_config_set("core.bare", "true");
990         } else {
991                 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
992         }
993
994         strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
995         strbuf_addf(&key, "remote.%s.url", option_origin);
996         git_config_set(key.buf, repo);
997         strbuf_reset(&key);
998
999         if (option_required_reference.nr || option_optional_reference.nr)
1000                 setup_reference();
1001
1002         fetch_pattern = value.buf;
1003         refspec = parse_fetch_refspec(1, &fetch_pattern);
1004
1005         strbuf_reset(&value);
1006
1007         remote = remote_get(option_origin);
1008         transport = transport_get(remote, remote->url[0]);
1009         transport_set_verbosity(transport, option_verbosity, option_progress);
1010         transport->family = family;
1011
1012         path = get_repo_path(remote->url[0], &is_bundle);
1013         is_local = option_local != 0 && path && !is_bundle;
1014         if (is_local) {
1015                 if (option_depth)
1016                         warning(_("--depth is ignored in local clones; use file:// instead."));
1017                 if (option_since)
1018                         warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1019                 if (option_not.nr)
1020                         warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1021                 if (!access(mkpath("%s/shallow", path), F_OK)) {
1022                         if (option_local > 0)
1023                                 warning(_("source repository is shallow, ignoring --local"));
1024                         is_local = 0;
1025                 }
1026         }
1027         if (option_local > 0 && !is_local)
1028                 warning(_("--local is ignored"));
1029         transport->cloning = 1;
1030
1031         if (!transport->get_refs_list || (!is_local && !transport->fetch))
1032                 die(_("Don't know how to clone %s"), transport->url);
1033
1034         transport_set_option(transport, TRANS_OPT_KEEP, "yes");
1035
1036         if (option_depth)
1037                 transport_set_option(transport, TRANS_OPT_DEPTH,
1038                                      option_depth);
1039         if (option_since)
1040                 transport_set_option(transport, TRANS_OPT_DEEPEN_SINCE,
1041                                      option_since);
1042         if (option_not.nr)
1043                 transport_set_option(transport, TRANS_OPT_DEEPEN_NOT,
1044                                      (const char *)&option_not);
1045         if (option_single_branch)
1046                 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1047
1048         if (option_upload_pack)
1049                 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
1050                                      option_upload_pack);
1051
1052         if (transport->smart_options && !deepen)
1053                 transport->smart_options->check_self_contained_and_connected = 1;
1054
1055         refs = transport_get_remote_refs(transport);
1056
1057         if (refs) {
1058                 mapped_refs = wanted_peer_refs(refs, refspec);
1059                 /*
1060                  * transport_get_remote_refs() may return refs with null sha-1
1061                  * in mapped_refs (see struct transport->get_refs_list
1062                  * comment). In that case we need fetch it early because
1063                  * remote_head code below relies on it.
1064                  *
1065                  * for normal clones, transport_get_remote_refs() should
1066                  * return reliable ref set, we can delay cloning until after
1067                  * remote HEAD check.
1068                  */
1069                 for (ref = refs; ref; ref = ref->next)
1070                         if (is_null_oid(&ref->old_oid)) {
1071                                 complete_refs_before_fetch = 0;
1072                                 break;
1073                         }
1074
1075                 if (!is_local && !complete_refs_before_fetch)
1076                         transport_fetch_refs(transport, mapped_refs);
1077
1078                 remote_head = find_ref_by_name(refs, "HEAD");
1079                 remote_head_points_at =
1080                         guess_remote_head(remote_head, mapped_refs, 0);
1081
1082                 if (option_branch) {
1083                         our_head_points_at =
1084                                 find_remote_branch(mapped_refs, option_branch);
1085
1086                         if (!our_head_points_at)
1087                                 die(_("Remote branch %s not found in upstream %s"),
1088                                     option_branch, option_origin);
1089                 }
1090                 else
1091                         our_head_points_at = remote_head_points_at;
1092         }
1093         else {
1094                 if (option_branch)
1095                         die(_("Remote branch %s not found in upstream %s"),
1096                                         option_branch, option_origin);
1097
1098                 warning(_("You appear to have cloned an empty repository."));
1099                 mapped_refs = NULL;
1100                 our_head_points_at = NULL;
1101                 remote_head_points_at = NULL;
1102                 remote_head = NULL;
1103                 option_no_checkout = 1;
1104                 if (!option_bare)
1105                         install_branch_config(0, "master", option_origin,
1106                                               "refs/heads/master");
1107         }
1108
1109         write_refspec_config(src_ref_prefix, our_head_points_at,
1110                         remote_head_points_at, &branch_top);
1111
1112         if (is_local)
1113                 clone_local(path, git_dir);
1114         else if (refs && complete_refs_before_fetch)
1115                 transport_fetch_refs(transport, mapped_refs);
1116
1117         update_remote_refs(refs, mapped_refs, remote_head_points_at,
1118                            branch_top.buf, reflog_msg.buf, transport, !is_local);
1119
1120         update_head(our_head_points_at, remote_head, reflog_msg.buf);
1121
1122         /*
1123          * We want to show progress for recursive submodule clones iff
1124          * we did so for the main clone. But only the transport knows
1125          * the final decision for this flag, so we need to rescue the value
1126          * before we free the transport.
1127          */
1128         submodule_progress = transport->progress;
1129
1130         transport_unlock_pack(transport);
1131         transport_disconnect(transport);
1132
1133         if (option_dissociate) {
1134                 close_all_packs();
1135                 dissociate_from_references();
1136         }
1137
1138         junk_mode = JUNK_LEAVE_REPO;
1139         err = checkout(submodule_progress);
1140
1141         strbuf_release(&reflog_msg);
1142         strbuf_release(&branch_top);
1143         strbuf_release(&key);
1144         strbuf_release(&value);
1145         junk_mode = JUNK_LEAVE_ALL;
1146
1147         free(refspec);
1148         return err;
1149 }