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
8 * Clone a repository into a different directory that does not yet exist.
12 #include "parse-options.h"
13 #include "fetch-pack.h"
16 #include "tree-walk.h"
17 #include "unpack-trees.h"
18 #include "transport.h"
21 #include "pack-refs.h"
25 #include "run-command.h"
29 * - respect DB_ENVIRONMENT for .git/objects.
31 * Implementation notes:
32 * - dropping use-separate-remote and no-separate-remote compatibility
35 static const char * const builtin_clone_usage[] = {
36 "git clone [options] [--] <repo> [<dir>]",
40 static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
41 static int option_local = -1, option_no_hardlinks, option_shared, option_recursive;
42 static char *option_template, *option_depth;
43 static char *option_origin = NULL;
44 static char *option_branch = NULL;
45 static const char *real_git_dir;
46 static char *option_upload_pack = "git-upload-pack";
47 static int option_verbosity;
48 static int option_progress = -1;
49 static struct string_list option_config;
50 static struct string_list option_reference;
52 static int opt_parse_reference(const struct option *opt, const char *arg, int unset)
54 struct string_list *option_reference = opt->value;
57 string_list_append(option_reference, arg);
61 static struct option builtin_clone_options[] = {
62 OPT__VERBOSITY(&option_verbosity),
63 OPT_BOOL(0, "progress", &option_progress,
64 "force progress reporting"),
65 OPT_BOOLEAN('n', "no-checkout", &option_no_checkout,
66 "don't create a checkout"),
67 OPT_BOOLEAN(0, "bare", &option_bare, "create a bare repository"),
68 { OPTION_BOOLEAN, 0, "naked", &option_bare, NULL,
69 "create a bare repository",
70 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
71 OPT_BOOLEAN(0, "mirror", &option_mirror,
72 "create a mirror repository (implies bare)"),
73 OPT_BOOL('l', "local", &option_local,
74 "to clone from a local repository"),
75 OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks,
76 "don't use local hardlinks, always copy"),
77 OPT_BOOLEAN('s', "shared", &option_shared,
78 "setup as shared repository"),
79 OPT_BOOLEAN(0, "recursive", &option_recursive,
80 "initialize submodules in the clone"),
81 OPT_BOOLEAN(0, "recurse-submodules", &option_recursive,
82 "initialize submodules in the clone"),
83 OPT_STRING(0, "template", &option_template, "template-directory",
84 "directory from which templates will be used"),
85 OPT_CALLBACK(0 , "reference", &option_reference, "repo",
86 "reference repository", &opt_parse_reference),
87 OPT_STRING('o', "origin", &option_origin, "name",
88 "use <name> instead of 'origin' to track upstream"),
89 OPT_STRING('b', "branch", &option_branch, "branch",
90 "checkout <branch> instead of the remote's HEAD"),
91 OPT_STRING('u', "upload-pack", &option_upload_pack, "path",
92 "path to git-upload-pack on the remote"),
93 OPT_STRING(0, "depth", &option_depth, "depth",
94 "create a shallow clone of that depth"),
95 OPT_BOOL(0, "single-branch", &option_single_branch,
96 "clone only one branch, HEAD or --branch"),
97 OPT_STRING(0, "separate-git-dir", &real_git_dir, "gitdir",
98 "separate git dir from working tree"),
99 OPT_STRING_LIST('c', "config", &option_config, "key=value",
100 "set config inside the new repository"),
104 static const char *argv_submodule[] = {
105 "submodule", "update", "--init", "--recursive", NULL
108 static char *get_repo_path(const char *repo, int *is_bundle)
110 static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
111 static char *bundle_suffix[] = { ".bundle", "" };
115 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
117 path = mkpath("%s%s", repo, suffix[i]);
120 if (S_ISDIR(st.st_mode) && is_git_directory(path)) {
122 return xstrdup(absolute_path(path));
123 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
124 /* Is it a "gitfile"? */
126 int len, fd = open(path, O_RDONLY);
129 len = read_in_full(fd, signature, 8);
131 if (len != 8 || strncmp(signature, "gitdir: ", 8))
133 path = read_gitfile(path);
136 return xstrdup(absolute_path(path));
141 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
143 path = mkpath("%s%s", repo, bundle_suffix[i]);
144 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
146 return xstrdup(absolute_path(path));
153 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
155 const char *end = repo + strlen(repo), *start;
159 * Strip trailing spaces, slashes and /.git
161 while (repo < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
163 if (end - repo > 5 && is_dir_sep(end[-5]) &&
164 !strncmp(end - 4, ".git", 4)) {
166 while (repo < end && is_dir_sep(end[-1]))
171 * Find last component, but be prepared that repo could have
172 * the form "remote.example.com:foo.git", i.e. no slash
173 * in the directory part.
176 while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
180 * Strip .{bundle,git}.
183 if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
186 if (end - start > 4 && !strncmp(end - 4, ".git", 4))
191 struct strbuf result = STRBUF_INIT;
192 strbuf_addf(&result, "%.*s.git", (int)(end - start), start);
193 dir = strbuf_detach(&result, NULL);
195 dir = xstrndup(start, end - start);
197 * Replace sequences of 'control' characters and whitespace
198 * with one ascii space, remove leading and trailing spaces.
202 int prev_space = 1 /* strip leading whitespace */;
203 for (end = dir; *end; ++end) {
205 if ((unsigned char)ch < '\x20')
216 if (out > dir && prev_space)
222 static void strip_trailing_slashes(char *dir)
224 char *end = dir + strlen(dir);
226 while (dir < end - 1 && is_dir_sep(end[-1]))
231 static int add_one_reference(struct string_list_item *item, void *cb_data)
234 struct strbuf alternate = STRBUF_INIT;
236 /* Beware: real_path() and mkpath() return static buffer */
237 ref_git = xstrdup(real_path(item->string));
238 if (is_directory(mkpath("%s/.git/objects", ref_git))) {
239 char *ref_git_git = xstrdup(mkpath("%s/.git", ref_git));
241 ref_git = ref_git_git;
242 } else if (!is_directory(mkpath("%s/objects", ref_git)))
243 die(_("reference repository '%s' is not a local directory."),
246 strbuf_addf(&alternate, "%s/objects", ref_git);
247 add_to_alternates_file(alternate.buf);
248 strbuf_release(&alternate);
253 static void setup_reference(void)
255 for_each_string_list(&option_reference, add_one_reference, NULL);
258 static void copy_alternates(struct strbuf *src, struct strbuf *dst,
259 const char *src_repo)
262 * Read from the source objects/info/alternates file
263 * and copy the entries to corresponding file in the
264 * destination repository with add_to_alternates_file().
265 * Both src and dst have "$path/objects/info/alternates".
267 * Instead of copying bit-for-bit from the original,
268 * we need to append to existing one so that the already
269 * created entry via "clone -s" is not lost, and also
270 * to turn entries with paths relative to the original
271 * absolute, so that they can be used in the new repository.
273 FILE *in = fopen(src->buf, "r");
274 struct strbuf line = STRBUF_INIT;
276 while (strbuf_getline(&line, in, '\n') != EOF) {
277 char *abs_path, abs_buf[PATH_MAX];
278 if (!line.len || line.buf[0] == '#')
280 if (is_absolute_path(line.buf)) {
281 add_to_alternates_file(line.buf);
284 abs_path = mkpath("%s/objects/%s", src_repo, line.buf);
285 normalize_path_copy(abs_buf, abs_path);
286 add_to_alternates_file(abs_buf);
288 strbuf_release(&line);
292 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
293 const char *src_repo, int src_baselen)
297 int src_len, dest_len;
300 dir = opendir(src->buf);
302 die_errno(_("failed to open '%s'"), src->buf);
304 if (mkdir(dest->buf, 0777)) {
306 die_errno(_("failed to create directory '%s'"), dest->buf);
307 else if (stat(dest->buf, &buf))
308 die_errno(_("failed to stat '%s'"), dest->buf);
309 else if (!S_ISDIR(buf.st_mode))
310 die(_("%s exists and is not a directory"), dest->buf);
313 strbuf_addch(src, '/');
315 strbuf_addch(dest, '/');
316 dest_len = dest->len;
318 while ((de = readdir(dir)) != NULL) {
319 strbuf_setlen(src, src_len);
320 strbuf_addstr(src, de->d_name);
321 strbuf_setlen(dest, dest_len);
322 strbuf_addstr(dest, de->d_name);
323 if (stat(src->buf, &buf)) {
324 warning (_("failed to stat %s\n"), src->buf);
327 if (S_ISDIR(buf.st_mode)) {
328 if (de->d_name[0] != '.')
329 copy_or_link_directory(src, dest,
330 src_repo, src_baselen);
334 /* Files that cannot be copied bit-for-bit... */
335 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
336 copy_alternates(src, dest, src_repo);
340 if (unlink(dest->buf) && errno != ENOENT)
341 die_errno(_("failed to unlink '%s'"), dest->buf);
342 if (!option_no_hardlinks) {
343 if (!link(src->buf, dest->buf))
345 if (option_local > 0)
346 die_errno(_("failed to create link '%s'"), dest->buf);
347 option_no_hardlinks = 1;
349 if (copy_file_with_time(dest->buf, src->buf, 0666))
350 die_errno(_("failed to copy file to '%s'"), dest->buf);
355 static void clone_local(const char *src_repo, const char *dest_repo)
358 struct strbuf alt = STRBUF_INIT;
359 strbuf_addf(&alt, "%s/objects", src_repo);
360 add_to_alternates_file(alt.buf);
361 strbuf_release(&alt);
363 struct strbuf src = STRBUF_INIT;
364 struct strbuf dest = STRBUF_INIT;
365 strbuf_addf(&src, "%s/objects", src_repo);
366 strbuf_addf(&dest, "%s/objects", dest_repo);
367 copy_or_link_directory(&src, &dest, src_repo, src.len);
368 strbuf_release(&src);
369 strbuf_release(&dest);
372 if (0 <= option_verbosity)
373 printf(_("done.\n"));
376 static const char *junk_work_tree;
377 static const char *junk_git_dir;
378 static pid_t junk_pid;
380 static void remove_junk(void)
382 struct strbuf sb = STRBUF_INIT;
383 if (getpid() != junk_pid)
386 strbuf_addstr(&sb, junk_git_dir);
387 remove_dir_recursively(&sb, 0);
390 if (junk_work_tree) {
391 strbuf_addstr(&sb, junk_work_tree);
392 remove_dir_recursively(&sb, 0);
397 static void remove_junk_on_signal(int signo)
404 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
407 struct strbuf head = STRBUF_INIT;
408 strbuf_addstr(&head, "refs/heads/");
409 strbuf_addstr(&head, branch);
410 ref = find_ref_by_name(refs, head.buf);
411 strbuf_release(&head);
416 strbuf_addstr(&head, "refs/tags/");
417 strbuf_addstr(&head, branch);
418 ref = find_ref_by_name(refs, head.buf);
419 strbuf_release(&head);
424 static struct ref *wanted_peer_refs(const struct ref *refs,
425 struct refspec *refspec)
427 struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
428 struct ref *local_refs = head;
429 struct ref **tail = head ? &head->next : &local_refs;
431 if (option_single_branch) {
432 struct ref *remote_head = NULL;
435 remote_head = guess_remote_head(head, refs, 0);
439 remote_head = copy_ref(find_remote_branch(refs, option_branch));
442 if (!remote_head && option_branch)
443 warning(_("Could not find remote branch %s to clone."),
446 get_fetch_map(remote_head, refspec, &tail, 0);
448 /* if --branch=tag, pull the requested tag explicitly */
449 get_fetch_map(remote_head, tag_refspec, &tail, 0);
452 get_fetch_map(refs, refspec, &tail, 0);
454 if (!option_mirror && !option_single_branch)
455 get_fetch_map(refs, tag_refspec, &tail, 0);
460 static void write_remote_refs(const struct ref *local_refs)
464 for (r = local_refs; r; r = r->next) {
467 add_packed_ref(r->peer_ref->name, r->old_sha1);
470 pack_refs(PACK_REFS_ALL);
473 static void write_followtags(const struct ref *refs, const char *msg)
475 const struct ref *ref;
476 for (ref = refs; ref; ref = ref->next) {
477 if (prefixcmp(ref->name, "refs/tags/"))
479 if (!suffixcmp(ref->name, "^{}"))
481 if (!has_sha1_file(ref->old_sha1))
483 update_ref(msg, ref->name, ref->old_sha1,
484 NULL, 0, DIE_ON_ERR);
488 static void update_remote_refs(const struct ref *refs,
489 const struct ref *mapped_refs,
490 const struct ref *remote_head_points_at,
491 const char *branch_top,
495 write_remote_refs(mapped_refs);
496 if (option_single_branch)
497 write_followtags(refs, msg);
500 if (remote_head_points_at && !option_bare) {
501 struct strbuf head_ref = STRBUF_INIT;
502 strbuf_addstr(&head_ref, branch_top);
503 strbuf_addstr(&head_ref, "HEAD");
504 create_symref(head_ref.buf,
505 remote_head_points_at->peer_ref->name,
510 static void update_head(const struct ref *our, const struct ref *remote,
513 if (our && !prefixcmp(our->name, "refs/heads/")) {
514 /* Local default branch link */
515 create_symref("HEAD", our->name, NULL);
517 const char *head = skip_prefix(our->name, "refs/heads/");
518 update_ref(msg, "HEAD", our->old_sha1, NULL, 0, DIE_ON_ERR);
519 install_branch_config(0, head, option_origin, our->name);
522 struct commit *c = lookup_commit_reference(our->old_sha1);
523 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
524 update_ref(msg, "HEAD", c->object.sha1,
525 NULL, REF_NODEREF, DIE_ON_ERR);
528 * We know remote HEAD points to a non-branch, or
529 * HEAD points to a branch but we don't know which one.
530 * Detach HEAD in all these cases.
532 update_ref(msg, "HEAD", remote->old_sha1,
533 NULL, REF_NODEREF, DIE_ON_ERR);
537 static int checkout(void)
539 unsigned char sha1[20];
541 struct lock_file *lock_file;
542 struct unpack_trees_options opts;
547 if (option_no_checkout)
550 head = resolve_refdup("HEAD", sha1, 1, NULL);
552 warning(_("remote HEAD refers to nonexistent ref, "
553 "unable to checkout.\n"));
556 if (!strcmp(head, "HEAD")) {
557 if (advice_detached_head)
558 detach_advice(sha1_to_hex(sha1));
560 if (prefixcmp(head, "refs/heads/"))
561 die(_("HEAD not found below refs/heads!"));
565 /* We need to be in the new work tree for the checkout */
568 lock_file = xcalloc(1, sizeof(struct lock_file));
569 fd = hold_locked_index(lock_file, 1);
571 memset(&opts, 0, sizeof opts);
574 opts.fn = oneway_merge;
575 opts.verbose_update = (option_verbosity >= 0);
576 opts.src_index = &the_index;
577 opts.dst_index = &the_index;
579 tree = parse_tree_indirect(sha1);
581 init_tree_desc(&t, tree->buffer, tree->size);
582 unpack_trees(1, &t, &opts);
584 if (write_cache(fd, active_cache, active_nr) ||
585 commit_locked_index(lock_file))
586 die(_("unable to write new index file"));
588 err |= run_hook(NULL, "post-checkout", sha1_to_hex(null_sha1),
589 sha1_to_hex(sha1), "1", NULL);
591 if (!err && option_recursive)
592 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
597 static int write_one_config(const char *key, const char *value, void *data)
599 return git_config_set_multivar(key, value ? value : "true", "^$", 0);
602 static void write_config(struct string_list *config)
606 for (i = 0; i < config->nr; i++) {
607 if (git_config_parse_parameter(config->items[i].string,
608 write_one_config, NULL) < 0)
609 die("unable to write parameters to config file");
613 int cmd_clone(int argc, const char **argv, const char *prefix)
615 int is_bundle = 0, is_local;
617 const char *repo_name, *repo, *work_tree, *git_dir;
620 const struct ref *refs, *remote_head;
621 const struct ref *remote_head_points_at;
622 const struct ref *our_head_points_at;
623 struct ref *mapped_refs;
624 const struct ref *ref;
625 struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
626 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
627 struct transport *transport = NULL;
628 const char *src_ref_prefix = "refs/heads/";
629 struct remote *remote;
630 int err = 0, complete_refs_before_fetch = 1;
632 struct refspec *refspec;
633 const char *fetch_pattern;
637 packet_trace_identity("clone");
638 argc = parse_options(argc, argv, prefix, builtin_clone_options,
639 builtin_clone_usage, 0);
642 usage_msg_opt(_("Too many arguments."),
643 builtin_clone_usage, builtin_clone_options);
646 usage_msg_opt(_("You must specify a repository to clone."),
647 builtin_clone_usage, builtin_clone_options);
649 if (option_single_branch == -1)
650 option_single_branch = option_depth ? 1 : 0;
657 die(_("--bare and --origin %s options are incompatible."),
659 option_no_checkout = 1;
663 option_origin = "origin";
667 path = get_repo_path(repo_name, &is_bundle);
669 repo = xstrdup(absolute_path(repo_name));
670 else if (!strchr(repo_name, ':'))
671 die(_("repository '%s' does not exist"), repo_name);
674 is_local = option_local != 0 && path && !is_bundle;
675 if (is_local && option_depth)
676 warning(_("--depth is ignored in local clones; use file:// instead."));
679 dir = xstrdup(argv[1]);
681 dir = guess_dir_name(repo_name, is_bundle, option_bare);
682 strip_trailing_slashes(dir);
684 dest_exists = !stat(dir, &buf);
685 if (dest_exists && !is_empty_dir(dir))
686 die(_("destination path '%s' already exists and is not "
687 "an empty directory."), dir);
689 strbuf_addf(&reflog_msg, "clone: from %s", repo);
694 work_tree = getenv("GIT_WORK_TREE");
695 if (work_tree && !stat(work_tree, &buf))
696 die(_("working tree '%s' already exists."), work_tree);
699 if (option_bare || work_tree)
700 git_dir = xstrdup(dir);
703 git_dir = xstrdup(mkpath("%s/.git", dir));
707 junk_work_tree = work_tree;
708 if (safe_create_leading_directories_const(work_tree) < 0)
709 die_errno(_("could not create leading directories of '%s'"),
711 if (!dest_exists && mkdir(work_tree, 0777))
712 die_errno(_("could not create work tree dir '%s'."),
714 set_git_work_tree(work_tree);
716 junk_git_dir = git_dir;
718 sigchain_push_common(remove_junk_on_signal);
720 setenv(CONFIG_ENVIRONMENT, mkpath("%s/config", git_dir), 1);
722 if (safe_create_leading_directories_const(git_dir) < 0)
723 die(_("could not create leading directories of '%s'"), git_dir);
725 set_git_dir_init(git_dir, real_git_dir, 0);
727 git_dir = real_git_dir;
729 if (0 <= option_verbosity) {
731 printf(_("Cloning into bare repository '%s'...\n"), dir);
733 printf(_("Cloning into '%s'...\n"), dir);
735 init_db(option_template, INIT_DB_QUIET);
736 write_config(&option_config);
739 * At this point, the config exists, so we do not need the
740 * environment variable. We actually need to unset it, too, to
741 * re-enable parsing of the global configs.
743 unsetenv(CONFIG_ENVIRONMENT);
745 git_config(git_default_config, NULL);
749 src_ref_prefix = "refs/";
750 strbuf_addstr(&branch_top, src_ref_prefix);
752 git_config_set("core.bare", "true");
754 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
757 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
759 if (option_mirror || !option_bare) {
760 /* Configure the remote */
761 strbuf_addf(&key, "remote.%s.fetch", option_origin);
762 git_config_set_multivar(key.buf, value.buf, "^$", 0);
766 strbuf_addf(&key, "remote.%s.mirror", option_origin);
767 git_config_set(key.buf, "true");
772 strbuf_addf(&key, "remote.%s.url", option_origin);
773 git_config_set(key.buf, repo);
776 if (option_reference.nr)
779 fetch_pattern = value.buf;
780 refspec = parse_fetch_refspec(1, &fetch_pattern);
782 strbuf_reset(&value);
784 remote = remote_get(option_origin);
785 transport = transport_get(remote, remote->url[0]);
788 if (!transport->get_refs_list || !transport->fetch)
789 die(_("Don't know how to clone %s"), transport->url);
791 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
794 transport_set_option(transport, TRANS_OPT_DEPTH,
796 if (option_single_branch)
797 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
799 transport_set_verbosity(transport, option_verbosity, option_progress);
801 if (option_upload_pack)
802 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
806 refs = transport_get_remote_refs(transport);
809 mapped_refs = wanted_peer_refs(refs, refspec);
811 * transport_get_remote_refs() may return refs with null sha-1
812 * in mapped_refs (see struct transport->get_refs_list
813 * comment). In that case we need fetch it early because
814 * remote_head code below relies on it.
816 * for normal clones, transport_get_remote_refs() should
817 * return reliable ref set, we can delay cloning until after
820 for (ref = refs; ref; ref = ref->next)
821 if (is_null_sha1(ref->old_sha1)) {
822 complete_refs_before_fetch = 0;
826 if (!is_local && !complete_refs_before_fetch)
827 transport_fetch_refs(transport, mapped_refs);
829 remote_head = find_ref_by_name(refs, "HEAD");
830 remote_head_points_at =
831 guess_remote_head(remote_head, mapped_refs, 0);
835 find_remote_branch(mapped_refs, option_branch);
837 if (!our_head_points_at)
838 die(_("Remote branch %s not found in upstream %s"),
839 option_branch, option_origin);
842 our_head_points_at = remote_head_points_at;
845 warning(_("You appear to have cloned an empty repository."));
847 our_head_points_at = NULL;
848 remote_head_points_at = NULL;
850 option_no_checkout = 1;
852 install_branch_config(0, "master", option_origin,
853 "refs/heads/master");
857 clone_local(path, git_dir);
858 else if (refs && complete_refs_before_fetch)
859 transport_fetch_refs(transport, mapped_refs);
861 update_remote_refs(refs, mapped_refs, remote_head_points_at,
862 branch_top.buf, reflog_msg.buf);
864 update_head(our_head_points_at, remote_head, reflog_msg.buf);
866 transport_unlock_pack(transport);
867 transport_disconnect(transport);
871 strbuf_release(&reflog_msg);
872 strbuf_release(&branch_top);
873 strbuf_release(&key);
874 strbuf_release(&value);