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;
41 static int option_local, 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;
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_BOOLEAN(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_BOOLEAN('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, "branch",
88 "use <branch> 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_STRING(0, "separate-git-dir", &real_git_dir, "gitdir",
96 "separate git dir from working tree"),
97 OPT_STRING_LIST('c', "config", &option_config, "key=value",
98 "set config inside the new repository"),
102 static const char *argv_submodule[] = {
103 "submodule", "update", "--init", "--recursive", NULL
106 static char *get_repo_path(const char *repo, int *is_bundle)
108 static char *suffix[] = { "/.git", ".git", "" };
109 static char *bundle_suffix[] = { ".bundle", "" };
113 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
115 path = mkpath("%s%s", repo, suffix[i]);
118 if (S_ISDIR(st.st_mode)) {
120 return xstrdup(absolute_path(path));
121 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
122 /* Is it a "gitfile"? */
124 int len, fd = open(path, O_RDONLY);
127 len = read_in_full(fd, signature, 8);
129 if (len != 8 || strncmp(signature, "gitdir: ", 8))
131 path = read_gitfile(path);
134 return xstrdup(absolute_path(path));
139 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
141 path = mkpath("%s%s", repo, bundle_suffix[i]);
142 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
144 return xstrdup(absolute_path(path));
151 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
153 const char *end = repo + strlen(repo), *start;
157 * Strip trailing spaces, slashes and /.git
159 while (repo < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
161 if (end - repo > 5 && is_dir_sep(end[-5]) &&
162 !strncmp(end - 4, ".git", 4)) {
164 while (repo < end && is_dir_sep(end[-1]))
169 * Find last component, but be prepared that repo could have
170 * the form "remote.example.com:foo.git", i.e. no slash
171 * in the directory part.
174 while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
178 * Strip .{bundle,git}.
181 if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
184 if (end - start > 4 && !strncmp(end - 4, ".git", 4))
189 struct strbuf result = STRBUF_INIT;
190 strbuf_addf(&result, "%.*s.git", (int)(end - start), start);
191 dir = strbuf_detach(&result, NULL);
193 dir = xstrndup(start, end - start);
195 * Replace sequences of 'control' characters and whitespace
196 * with one ascii space, remove leading and trailing spaces.
200 int prev_space = 1 /* strip leading whitespace */;
201 for (end = dir; *end; ++end) {
203 if ((unsigned char)ch < '\x20')
214 if (out > dir && prev_space)
220 static void strip_trailing_slashes(char *dir)
222 char *end = dir + strlen(dir);
224 while (dir < end - 1 && is_dir_sep(end[-1]))
229 static int add_one_reference(struct string_list_item *item, void *cb_data)
232 struct strbuf alternate = STRBUF_INIT;
233 struct remote *remote;
234 struct transport *transport;
235 const struct ref *extra;
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 = xstrdup(mkpath("%s/.git", 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."),
247 strbuf_addf(&alternate, "%s/objects", ref_git);
248 add_to_alternates_file(alternate.buf);
249 strbuf_release(&alternate);
251 remote = remote_get(ref_git);
252 transport = transport_get(remote, ref_git);
253 for (extra = transport_get_remote_refs(transport); extra;
255 add_extra_ref(extra->name, extra->old_sha1, 0);
257 transport_disconnect(transport);
262 static void setup_reference(void)
264 for_each_string_list(&option_reference, add_one_reference, NULL);
267 static void copy_alternates(struct strbuf *src, struct strbuf *dst,
268 const char *src_repo)
271 * Read from the source objects/info/alternates file
272 * and copy the entries to corresponding file in the
273 * destination repository with add_to_alternates_file().
274 * Both src and dst have "$path/objects/info/alternates".
276 * Instead of copying bit-for-bit from the original,
277 * we need to append to existing one so that the already
278 * created entry via "clone -s" is not lost, and also
279 * to turn entries with paths relative to the original
280 * absolute, so that they can be used in the new repository.
282 FILE *in = fopen(src->buf, "r");
283 struct strbuf line = STRBUF_INIT;
285 while (strbuf_getline(&line, in, '\n') != EOF) {
286 char *abs_path, abs_buf[PATH_MAX];
287 if (!line.len || line.buf[0] == '#')
289 if (is_absolute_path(line.buf)) {
290 add_to_alternates_file(line.buf);
293 abs_path = mkpath("%s/objects/%s", src_repo, line.buf);
294 normalize_path_copy(abs_buf, abs_path);
295 add_to_alternates_file(abs_buf);
297 strbuf_release(&line);
301 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
302 const char *src_repo, int src_baselen)
306 int src_len, dest_len;
309 dir = opendir(src->buf);
311 die_errno(_("failed to open '%s'"), src->buf);
313 if (mkdir(dest->buf, 0777)) {
315 die_errno(_("failed to create directory '%s'"), dest->buf);
316 else if (stat(dest->buf, &buf))
317 die_errno(_("failed to stat '%s'"), dest->buf);
318 else if (!S_ISDIR(buf.st_mode))
319 die(_("%s exists and is not a directory"), dest->buf);
322 strbuf_addch(src, '/');
324 strbuf_addch(dest, '/');
325 dest_len = dest->len;
327 while ((de = readdir(dir)) != NULL) {
328 strbuf_setlen(src, src_len);
329 strbuf_addstr(src, de->d_name);
330 strbuf_setlen(dest, dest_len);
331 strbuf_addstr(dest, de->d_name);
332 if (stat(src->buf, &buf)) {
333 warning (_("failed to stat %s\n"), src->buf);
336 if (S_ISDIR(buf.st_mode)) {
337 if (de->d_name[0] != '.')
338 copy_or_link_directory(src, dest,
339 src_repo, src_baselen);
343 /* Files that cannot be copied bit-for-bit... */
344 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
345 copy_alternates(src, dest, src_repo);
349 if (unlink(dest->buf) && errno != ENOENT)
350 die_errno(_("failed to unlink '%s'"), dest->buf);
351 if (!option_no_hardlinks) {
352 if (!link(src->buf, dest->buf))
355 die_errno(_("failed to create link '%s'"), dest->buf);
356 option_no_hardlinks = 1;
358 if (copy_file_with_time(dest->buf, src->buf, 0666))
359 die_errno(_("failed to copy file to '%s'"), dest->buf);
364 static const struct ref *clone_local(const char *src_repo,
365 const char *dest_repo)
367 const struct ref *ret;
368 struct remote *remote;
369 struct transport *transport;
372 struct strbuf alt = STRBUF_INIT;
373 strbuf_addf(&alt, "%s/objects", src_repo);
374 add_to_alternates_file(alt.buf);
375 strbuf_release(&alt);
377 struct strbuf src = STRBUF_INIT;
378 struct strbuf dest = STRBUF_INIT;
379 strbuf_addf(&src, "%s/objects", src_repo);
380 strbuf_addf(&dest, "%s/objects", dest_repo);
381 copy_or_link_directory(&src, &dest, src_repo, src.len);
382 strbuf_release(&src);
383 strbuf_release(&dest);
386 remote = remote_get(src_repo);
387 transport = transport_get(remote, src_repo);
388 ret = transport_get_remote_refs(transport);
389 transport_disconnect(transport);
390 if (0 <= option_verbosity)
391 printf(_("done.\n"));
395 static const char *junk_work_tree;
396 static const char *junk_git_dir;
397 static pid_t junk_pid;
399 static void remove_junk(void)
401 struct strbuf sb = STRBUF_INIT;
402 if (getpid() != junk_pid)
405 strbuf_addstr(&sb, junk_git_dir);
406 remove_dir_recursively(&sb, 0);
409 if (junk_work_tree) {
410 strbuf_addstr(&sb, junk_work_tree);
411 remove_dir_recursively(&sb, 0);
416 static void remove_junk_on_signal(int signo)
423 static struct ref *wanted_peer_refs(const struct ref *refs,
424 struct refspec *refspec)
426 struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
427 struct ref *local_refs = head;
428 struct ref **tail = head ? &head->next : &local_refs;
430 get_fetch_map(refs, refspec, &tail, 0);
432 get_fetch_map(refs, tag_refspec, &tail, 0);
437 static void write_remote_refs(const struct ref *local_refs)
441 for (r = local_refs; r; r = r->next) {
444 add_extra_ref(r->peer_ref->name, r->old_sha1, 0);
447 pack_refs(PACK_REFS_ALL);
451 static int write_one_config(const char *key, const char *value, void *data)
453 return git_config_set_multivar(key, value ? value : "true", "^$", 0);
456 static void write_config(struct string_list *config)
460 for (i = 0; i < config->nr; i++) {
461 if (git_config_parse_parameter(config->items[i].string,
462 write_one_config, NULL) < 0)
463 die("unable to write parameters to config file");
467 int cmd_clone(int argc, const char **argv, const char *prefix)
469 int is_bundle = 0, is_local;
471 const char *repo_name, *repo, *work_tree, *git_dir;
474 const struct ref *refs, *remote_head;
475 const struct ref *remote_head_points_at;
476 const struct ref *our_head_points_at;
477 struct ref *mapped_refs;
478 struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
479 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
480 struct transport *transport = NULL;
481 char *src_ref_prefix = "refs/heads/";
484 struct refspec *refspec;
485 const char *fetch_pattern;
489 packet_trace_identity("clone");
490 argc = parse_options(argc, argv, prefix, builtin_clone_options,
491 builtin_clone_usage, 0);
494 usage_msg_opt(_("Too many arguments."),
495 builtin_clone_usage, builtin_clone_options);
498 usage_msg_opt(_("You must specify a repository to clone."),
499 builtin_clone_usage, builtin_clone_options);
506 die(_("--bare and --origin %s options are incompatible."),
508 option_no_checkout = 1;
512 option_origin = "origin";
516 path = get_repo_path(repo_name, &is_bundle);
518 repo = xstrdup(absolute_path(repo_name));
519 else if (!strchr(repo_name, ':'))
520 die(_("repository '%s' does not exist"), repo_name);
523 is_local = path && !is_bundle;
524 if (is_local && option_depth)
525 warning(_("--depth is ignored in local clones; use file:// instead."));
528 dir = xstrdup(argv[1]);
530 dir = guess_dir_name(repo_name, is_bundle, option_bare);
531 strip_trailing_slashes(dir);
533 dest_exists = !stat(dir, &buf);
534 if (dest_exists && !is_empty_dir(dir))
535 die(_("destination path '%s' already exists and is not "
536 "an empty directory."), dir);
538 strbuf_addf(&reflog_msg, "clone: from %s", repo);
543 work_tree = getenv("GIT_WORK_TREE");
544 if (work_tree && !stat(work_tree, &buf))
545 die(_("working tree '%s' already exists."), work_tree);
548 if (option_bare || work_tree)
549 git_dir = xstrdup(dir);
552 git_dir = xstrdup(mkpath("%s/.git", dir));
556 junk_work_tree = work_tree;
557 if (safe_create_leading_directories_const(work_tree) < 0)
558 die_errno(_("could not create leading directories of '%s'"),
560 if (!dest_exists && mkdir(work_tree, 0755))
561 die_errno(_("could not create work tree dir '%s'."),
563 set_git_work_tree(work_tree);
565 junk_git_dir = git_dir;
567 sigchain_push_common(remove_junk_on_signal);
569 setenv(CONFIG_ENVIRONMENT, mkpath("%s/config", git_dir), 1);
571 if (safe_create_leading_directories_const(git_dir) < 0)
572 die(_("could not create leading directories of '%s'"), git_dir);
574 set_git_dir_init(git_dir, real_git_dir, 0);
576 git_dir = real_git_dir;
578 if (0 <= option_verbosity) {
580 printf(_("Cloning into bare repository '%s'...\n"), dir);
582 printf(_("Cloning into '%s'...\n"), dir);
584 init_db(option_template, INIT_DB_QUIET);
585 write_config(&option_config);
588 * At this point, the config exists, so we do not need the
589 * environment variable. We actually need to unset it, too, to
590 * re-enable parsing of the global configs.
592 unsetenv(CONFIG_ENVIRONMENT);
594 git_config(git_default_config, NULL);
598 src_ref_prefix = "refs/";
599 strbuf_addstr(&branch_top, src_ref_prefix);
601 git_config_set("core.bare", "true");
603 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
606 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
608 if (option_mirror || !option_bare) {
609 /* Configure the remote */
610 strbuf_addf(&key, "remote.%s.fetch", option_origin);
611 git_config_set_multivar(key.buf, value.buf, "^$", 0);
615 strbuf_addf(&key, "remote.%s.mirror", option_origin);
616 git_config_set(key.buf, "true");
621 strbuf_addf(&key, "remote.%s.url", option_origin);
622 git_config_set(key.buf, repo);
625 if (option_reference.nr)
628 fetch_pattern = value.buf;
629 refspec = parse_fetch_refspec(1, &fetch_pattern);
631 strbuf_reset(&value);
634 refs = clone_local(path, git_dir);
635 mapped_refs = wanted_peer_refs(refs, refspec);
637 struct remote *remote = remote_get(option_origin);
638 transport = transport_get(remote, remote->url[0]);
640 if (!transport->get_refs_list || !transport->fetch)
641 die(_("Don't know how to clone %s"), transport->url);
643 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
646 transport_set_option(transport, TRANS_OPT_DEPTH,
649 transport_set_verbosity(transport, option_verbosity, option_progress);
651 if (option_upload_pack)
652 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
655 refs = transport_get_remote_refs(transport);
657 mapped_refs = wanted_peer_refs(refs, refspec);
658 transport_fetch_refs(transport, mapped_refs);
665 write_remote_refs(mapped_refs);
667 remote_head = find_ref_by_name(refs, "HEAD");
668 remote_head_points_at =
669 guess_remote_head(remote_head, mapped_refs, 0);
672 struct strbuf head = STRBUF_INIT;
673 strbuf_addstr(&head, src_ref_prefix);
674 strbuf_addstr(&head, option_branch);
676 find_ref_by_name(mapped_refs, head.buf);
677 strbuf_release(&head);
679 if (!our_head_points_at) {
680 warning(_("Remote branch %s not found in "
681 "upstream %s, using HEAD instead"),
682 option_branch, option_origin);
683 our_head_points_at = remote_head_points_at;
687 our_head_points_at = remote_head_points_at;
690 warning(_("You appear to have cloned an empty repository."));
691 our_head_points_at = NULL;
692 remote_head_points_at = NULL;
694 option_no_checkout = 1;
696 install_branch_config(0, "master", option_origin,
697 "refs/heads/master");
700 if (remote_head_points_at && !option_bare) {
701 struct strbuf head_ref = STRBUF_INIT;
702 strbuf_addstr(&head_ref, branch_top.buf);
703 strbuf_addstr(&head_ref, "HEAD");
704 create_symref(head_ref.buf,
705 remote_head_points_at->peer_ref->name,
709 if (our_head_points_at) {
710 /* Local default branch link */
711 create_symref("HEAD", our_head_points_at->name, NULL);
713 const char *head = skip_prefix(our_head_points_at->name,
715 update_ref(reflog_msg.buf, "HEAD",
716 our_head_points_at->old_sha1,
717 NULL, 0, DIE_ON_ERR);
718 install_branch_config(0, head, option_origin,
719 our_head_points_at->name);
721 } else if (remote_head) {
722 /* Source had detached HEAD pointing somewhere. */
724 update_ref(reflog_msg.buf, "HEAD",
725 remote_head->old_sha1,
726 NULL, REF_NODEREF, DIE_ON_ERR);
727 our_head_points_at = remote_head;
730 /* Nothing to checkout out */
731 if (!option_no_checkout)
732 warning(_("remote HEAD refers to nonexistent ref, "
733 "unable to checkout.\n"));
734 option_no_checkout = 1;
738 transport_unlock_pack(transport);
739 transport_disconnect(transport);
742 if (!option_no_checkout) {
743 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
744 struct unpack_trees_options opts;
749 /* We need to be in the new work tree for the checkout */
752 fd = hold_locked_index(lock_file, 1);
754 memset(&opts, 0, sizeof opts);
757 opts.fn = oneway_merge;
758 opts.verbose_update = (option_verbosity > 0);
759 opts.src_index = &the_index;
760 opts.dst_index = &the_index;
762 tree = parse_tree_indirect(our_head_points_at->old_sha1);
764 init_tree_desc(&t, tree->buffer, tree->size);
765 unpack_trees(1, &t, &opts);
767 if (write_cache(fd, active_cache, active_nr) ||
768 commit_locked_index(lock_file))
769 die(_("unable to write new index file"));
771 err |= run_hook(NULL, "post-checkout", sha1_to_hex(null_sha1),
772 sha1_to_hex(our_head_points_at->old_sha1), "1",
775 if (!err && option_recursive)
776 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
779 strbuf_release(&reflog_msg);
780 strbuf_release(&branch_top);
781 strbuf_release(&key);
782 strbuf_release(&value);