Merge branch 'ab/submodule-add-f'
[git/jnareb-git.git] / builtin / clone.c
blobefb1e6faa539935de0e9dc590237185a1d222322
1 /*
2 * Builtin "git clone"
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.
9 */
11 #include "cache.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"
28 * Overall FIXMEs:
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>]",
37 NULL
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_reference, *option_depth;
43 static char *option_origin = NULL;
44 static char *option_branch = NULL;
45 static char *option_upload_pack = "git-upload-pack";
46 static int option_verbosity;
47 static int option_progress;
49 static struct option builtin_clone_options[] = {
50 OPT__VERBOSITY(&option_verbosity),
51 OPT_BOOLEAN(0, "progress", &option_progress,
52 "force progress reporting"),
53 OPT_BOOLEAN('n', "no-checkout", &option_no_checkout,
54 "don't create a checkout"),
55 OPT_BOOLEAN(0, "bare", &option_bare, "create a bare repository"),
56 { OPTION_BOOLEAN, 0, "naked", &option_bare, NULL,
57 "create a bare repository",
58 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
59 OPT_BOOLEAN(0, "mirror", &option_mirror,
60 "create a mirror repository (implies bare)"),
61 OPT_BOOLEAN('l', "local", &option_local,
62 "to clone from a local repository"),
63 OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks,
64 "don't use local hardlinks, always copy"),
65 OPT_BOOLEAN('s', "shared", &option_shared,
66 "setup as shared repository"),
67 OPT_BOOLEAN(0, "recursive", &option_recursive,
68 "initialize submodules in the clone"),
69 OPT_STRING(0, "template", &option_template, "path",
70 "path the template repository"),
71 OPT_STRING(0, "reference", &option_reference, "repo",
72 "reference repository"),
73 OPT_STRING('o', "origin", &option_origin, "branch",
74 "use <branch> instead of 'origin' to track upstream"),
75 OPT_STRING('b', "branch", &option_branch, "branch",
76 "checkout <branch> instead of the remote's HEAD"),
77 OPT_STRING('u', "upload-pack", &option_upload_pack, "path",
78 "path to git-upload-pack on the remote"),
79 OPT_STRING(0, "depth", &option_depth, "depth",
80 "create a shallow clone of that depth"),
82 OPT_END()
85 static const char *argv_submodule[] = {
86 "submodule", "update", "--init", "--recursive", NULL
89 static char *get_repo_path(const char *repo, int *is_bundle)
91 static char *suffix[] = { "/.git", ".git", "" };
92 static char *bundle_suffix[] = { ".bundle", "" };
93 struct stat st;
94 int i;
96 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
97 const char *path;
98 path = mkpath("%s%s", repo, suffix[i]);
99 if (is_directory(path)) {
100 *is_bundle = 0;
101 return xstrdup(make_nonrelative_path(path));
105 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
106 const char *path;
107 path = mkpath("%s%s", repo, bundle_suffix[i]);
108 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
109 *is_bundle = 1;
110 return xstrdup(make_nonrelative_path(path));
114 return NULL;
117 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
119 const char *end = repo + strlen(repo), *start;
120 char *dir;
123 * Strip trailing spaces, slashes and /.git
125 while (repo < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
126 end--;
127 if (end - repo > 5 && is_dir_sep(end[-5]) &&
128 !strncmp(end - 4, ".git", 4)) {
129 end -= 5;
130 while (repo < end && is_dir_sep(end[-1]))
131 end--;
135 * Find last component, but be prepared that repo could have
136 * the form "remote.example.com:foo.git", i.e. no slash
137 * in the directory part.
139 start = end;
140 while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
141 start--;
144 * Strip .{bundle,git}.
146 if (is_bundle) {
147 if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
148 end -= 7;
149 } else {
150 if (end - start > 4 && !strncmp(end - 4, ".git", 4))
151 end -= 4;
154 if (is_bare) {
155 struct strbuf result = STRBUF_INIT;
156 strbuf_addf(&result, "%.*s.git", (int)(end - start), start);
157 dir = strbuf_detach(&result, NULL);
158 } else
159 dir = xstrndup(start, end - start);
161 * Replace sequences of 'control' characters and whitespace
162 * with one ascii space, remove leading and trailing spaces.
164 if (*dir) {
165 char *out = dir;
166 int prev_space = 1 /* strip leading whitespace */;
167 for (end = dir; *end; ++end) {
168 char ch = *end;
169 if ((unsigned char)ch < '\x20')
170 ch = '\x20';
171 if (isspace(ch)) {
172 if (prev_space)
173 continue;
174 prev_space = 1;
175 } else
176 prev_space = 0;
177 *out++ = ch;
179 *out = '\0';
180 if (out > dir && prev_space)
181 out[-1] = '\0';
183 return dir;
186 static void strip_trailing_slashes(char *dir)
188 char *end = dir + strlen(dir);
190 while (dir < end - 1 && is_dir_sep(end[-1]))
191 end--;
192 *end = '\0';
195 static void setup_reference(const char *repo)
197 const char *ref_git;
198 char *ref_git_copy;
200 struct remote *remote;
201 struct transport *transport;
202 const struct ref *extra;
204 ref_git = make_absolute_path(option_reference);
206 if (is_directory(mkpath("%s/.git/objects", ref_git)))
207 ref_git = mkpath("%s/.git", ref_git);
208 else if (!is_directory(mkpath("%s/objects", ref_git)))
209 die("reference repository '%s' is not a local directory.",
210 option_reference);
212 ref_git_copy = xstrdup(ref_git);
214 add_to_alternates_file(ref_git_copy);
216 remote = remote_get(ref_git_copy);
217 transport = transport_get(remote, ref_git_copy);
218 for (extra = transport_get_remote_refs(transport); extra;
219 extra = extra->next)
220 add_extra_ref(extra->name, extra->old_sha1, 0);
222 transport_disconnect(transport);
224 free(ref_git_copy);
227 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest)
229 struct dirent *de;
230 struct stat buf;
231 int src_len, dest_len;
232 DIR *dir;
234 dir = opendir(src->buf);
235 if (!dir)
236 die_errno("failed to open '%s'", src->buf);
238 if (mkdir(dest->buf, 0777)) {
239 if (errno != EEXIST)
240 die_errno("failed to create directory '%s'", dest->buf);
241 else if (stat(dest->buf, &buf))
242 die_errno("failed to stat '%s'", dest->buf);
243 else if (!S_ISDIR(buf.st_mode))
244 die("%s exists and is not a directory", dest->buf);
247 strbuf_addch(src, '/');
248 src_len = src->len;
249 strbuf_addch(dest, '/');
250 dest_len = dest->len;
252 while ((de = readdir(dir)) != NULL) {
253 strbuf_setlen(src, src_len);
254 strbuf_addstr(src, de->d_name);
255 strbuf_setlen(dest, dest_len);
256 strbuf_addstr(dest, de->d_name);
257 if (stat(src->buf, &buf)) {
258 warning ("failed to stat %s\n", src->buf);
259 continue;
261 if (S_ISDIR(buf.st_mode)) {
262 if (de->d_name[0] != '.')
263 copy_or_link_directory(src, dest);
264 continue;
267 if (unlink(dest->buf) && errno != ENOENT)
268 die_errno("failed to unlink '%s'", dest->buf);
269 if (!option_no_hardlinks) {
270 if (!link(src->buf, dest->buf))
271 continue;
272 if (option_local)
273 die_errno("failed to create link '%s'", dest->buf);
274 option_no_hardlinks = 1;
276 if (copy_file_with_time(dest->buf, src->buf, 0666))
277 die_errno("failed to copy file to '%s'", dest->buf);
279 closedir(dir);
282 static const struct ref *clone_local(const char *src_repo,
283 const char *dest_repo)
285 const struct ref *ret;
286 struct strbuf src = STRBUF_INIT;
287 struct strbuf dest = STRBUF_INIT;
288 struct remote *remote;
289 struct transport *transport;
291 if (option_shared)
292 add_to_alternates_file(src_repo);
293 else {
294 strbuf_addf(&src, "%s/objects", src_repo);
295 strbuf_addf(&dest, "%s/objects", dest_repo);
296 copy_or_link_directory(&src, &dest);
297 strbuf_release(&src);
298 strbuf_release(&dest);
301 remote = remote_get(src_repo);
302 transport = transport_get(remote, src_repo);
303 ret = transport_get_remote_refs(transport);
304 transport_disconnect(transport);
305 if (0 <= option_verbosity)
306 printf("done.\n");
307 return ret;
310 static const char *junk_work_tree;
311 static const char *junk_git_dir;
312 static pid_t junk_pid;
314 static void remove_junk(void)
316 struct strbuf sb = STRBUF_INIT;
317 if (getpid() != junk_pid)
318 return;
319 if (junk_git_dir) {
320 strbuf_addstr(&sb, junk_git_dir);
321 remove_dir_recursively(&sb, 0);
322 strbuf_reset(&sb);
324 if (junk_work_tree) {
325 strbuf_addstr(&sb, junk_work_tree);
326 remove_dir_recursively(&sb, 0);
327 strbuf_reset(&sb);
331 static void remove_junk_on_signal(int signo)
333 remove_junk();
334 sigchain_pop(signo);
335 raise(signo);
338 static struct ref *wanted_peer_refs(const struct ref *refs,
339 struct refspec *refspec)
341 struct ref *local_refs = NULL;
342 struct ref **tail = &local_refs;
344 get_fetch_map(refs, refspec, &tail, 0);
345 if (!option_mirror)
346 get_fetch_map(refs, tag_refspec, &tail, 0);
348 return local_refs;
351 static void write_remote_refs(const struct ref *local_refs)
353 const struct ref *r;
355 for (r = local_refs; r; r = r->next)
356 add_extra_ref(r->peer_ref->name, r->old_sha1, 0);
358 pack_refs(PACK_REFS_ALL);
359 clear_extra_refs();
362 int cmd_clone(int argc, const char **argv, const char *prefix)
364 int is_bundle = 0;
365 struct stat buf;
366 const char *repo_name, *repo, *work_tree, *git_dir;
367 char *path, *dir;
368 int dest_exists;
369 const struct ref *refs, *remote_head;
370 const struct ref *remote_head_points_at;
371 const struct ref *our_head_points_at;
372 struct ref *mapped_refs;
373 struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
374 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
375 struct transport *transport = NULL;
376 char *src_ref_prefix = "refs/heads/";
377 int err = 0;
379 struct refspec *refspec;
380 const char *fetch_pattern;
382 junk_pid = getpid();
384 argc = parse_options(argc, argv, prefix, builtin_clone_options,
385 builtin_clone_usage, 0);
387 if (argc > 2)
388 usage_msg_opt("Too many arguments.",
389 builtin_clone_usage, builtin_clone_options);
391 if (argc == 0)
392 usage_msg_opt("You must specify a repository to clone.",
393 builtin_clone_usage, builtin_clone_options);
395 if (option_mirror)
396 option_bare = 1;
398 if (option_bare) {
399 if (option_origin)
400 die("--bare and --origin %s options are incompatible.",
401 option_origin);
402 option_no_checkout = 1;
405 if (!option_origin)
406 option_origin = "origin";
408 repo_name = argv[0];
410 path = get_repo_path(repo_name, &is_bundle);
411 if (path)
412 repo = xstrdup(make_nonrelative_path(repo_name));
413 else if (!strchr(repo_name, ':'))
414 repo = xstrdup(make_absolute_path(repo_name));
415 else
416 repo = repo_name;
418 if (argc == 2)
419 dir = xstrdup(argv[1]);
420 else
421 dir = guess_dir_name(repo_name, is_bundle, option_bare);
422 strip_trailing_slashes(dir);
424 dest_exists = !stat(dir, &buf);
425 if (dest_exists && !is_empty_dir(dir))
426 die("destination path '%s' already exists and is not "
427 "an empty directory.", dir);
429 strbuf_addf(&reflog_msg, "clone: from %s", repo);
431 if (option_bare)
432 work_tree = NULL;
433 else {
434 work_tree = getenv("GIT_WORK_TREE");
435 if (work_tree && !stat(work_tree, &buf))
436 die("working tree '%s' already exists.", work_tree);
439 if (option_bare || work_tree)
440 git_dir = xstrdup(dir);
441 else {
442 work_tree = dir;
443 git_dir = xstrdup(mkpath("%s/.git", dir));
446 if (!option_bare) {
447 junk_work_tree = work_tree;
448 if (safe_create_leading_directories_const(work_tree) < 0)
449 die_errno("could not create leading directories of '%s'",
450 work_tree);
451 if (!dest_exists && mkdir(work_tree, 0755))
452 die_errno("could not create work tree dir '%s'.",
453 work_tree);
454 set_git_work_tree(work_tree);
456 junk_git_dir = git_dir;
457 atexit(remove_junk);
458 sigchain_push_common(remove_junk_on_signal);
460 setenv(CONFIG_ENVIRONMENT, mkpath("%s/config", git_dir), 1);
462 if (safe_create_leading_directories_const(git_dir) < 0)
463 die("could not create leading directories of '%s'", git_dir);
464 set_git_dir(make_absolute_path(git_dir));
466 if (0 <= option_verbosity)
467 printf("Cloning into %s%s...\n",
468 option_bare ? "bare repository " : "", dir);
469 init_db(option_template, INIT_DB_QUIET);
472 * At this point, the config exists, so we do not need the
473 * environment variable. We actually need to unset it, too, to
474 * re-enable parsing of the global configs.
476 unsetenv(CONFIG_ENVIRONMENT);
478 git_config(git_default_config, NULL);
480 if (option_bare) {
481 if (option_mirror)
482 src_ref_prefix = "refs/";
483 strbuf_addstr(&branch_top, src_ref_prefix);
485 git_config_set("core.bare", "true");
486 } else {
487 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
490 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
492 if (option_mirror || !option_bare) {
493 /* Configure the remote */
494 strbuf_addf(&key, "remote.%s.fetch", option_origin);
495 git_config_set_multivar(key.buf, value.buf, "^$", 0);
496 strbuf_reset(&key);
498 if (option_mirror) {
499 strbuf_addf(&key, "remote.%s.mirror", option_origin);
500 git_config_set(key.buf, "true");
501 strbuf_reset(&key);
505 strbuf_addf(&key, "remote.%s.url", option_origin);
506 git_config_set(key.buf, repo);
507 strbuf_reset(&key);
509 if (option_reference)
510 setup_reference(git_dir);
512 fetch_pattern = value.buf;
513 refspec = parse_fetch_refspec(1, &fetch_pattern);
515 strbuf_reset(&value);
517 if (path && !is_bundle) {
518 refs = clone_local(path, git_dir);
519 mapped_refs = wanted_peer_refs(refs, refspec);
520 } else {
521 struct remote *remote = remote_get(option_origin);
522 transport = transport_get(remote, remote->url[0]);
524 if (!transport->get_refs_list || !transport->fetch)
525 die("Don't know how to clone %s", transport->url);
527 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
529 if (option_depth)
530 transport_set_option(transport, TRANS_OPT_DEPTH,
531 option_depth);
533 transport_set_verbosity(transport, option_verbosity, option_progress);
535 if (option_upload_pack)
536 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
537 option_upload_pack);
539 refs = transport_get_remote_refs(transport);
540 if (refs) {
541 mapped_refs = wanted_peer_refs(refs, refspec);
542 transport_fetch_refs(transport, mapped_refs);
546 if (refs) {
547 clear_extra_refs();
549 write_remote_refs(mapped_refs);
551 remote_head = find_ref_by_name(refs, "HEAD");
552 remote_head_points_at =
553 guess_remote_head(remote_head, mapped_refs, 0);
555 if (option_branch) {
556 struct strbuf head = STRBUF_INIT;
557 strbuf_addstr(&head, src_ref_prefix);
558 strbuf_addstr(&head, option_branch);
559 our_head_points_at =
560 find_ref_by_name(mapped_refs, head.buf);
561 strbuf_release(&head);
563 if (!our_head_points_at) {
564 warning("Remote branch %s not found in "
565 "upstream %s, using HEAD instead",
566 option_branch, option_origin);
567 our_head_points_at = remote_head_points_at;
570 else
571 our_head_points_at = remote_head_points_at;
573 else {
574 warning("You appear to have cloned an empty repository.");
575 our_head_points_at = NULL;
576 remote_head_points_at = NULL;
577 remote_head = NULL;
578 option_no_checkout = 1;
579 if (!option_bare)
580 install_branch_config(0, "master", option_origin,
581 "refs/heads/master");
584 if (remote_head_points_at && !option_bare) {
585 struct strbuf head_ref = STRBUF_INIT;
586 strbuf_addstr(&head_ref, branch_top.buf);
587 strbuf_addstr(&head_ref, "HEAD");
588 create_symref(head_ref.buf,
589 remote_head_points_at->peer_ref->name,
590 reflog_msg.buf);
593 if (our_head_points_at) {
594 /* Local default branch link */
595 create_symref("HEAD", our_head_points_at->name, NULL);
596 if (!option_bare) {
597 const char *head = skip_prefix(our_head_points_at->name,
598 "refs/heads/");
599 update_ref(reflog_msg.buf, "HEAD",
600 our_head_points_at->old_sha1,
601 NULL, 0, DIE_ON_ERR);
602 install_branch_config(0, head, option_origin,
603 our_head_points_at->name);
605 } else if (remote_head) {
606 /* Source had detached HEAD pointing somewhere. */
607 if (!option_bare) {
608 update_ref(reflog_msg.buf, "HEAD",
609 remote_head->old_sha1,
610 NULL, REF_NODEREF, DIE_ON_ERR);
611 our_head_points_at = remote_head;
613 } else {
614 /* Nothing to checkout out */
615 if (!option_no_checkout)
616 warning("remote HEAD refers to nonexistent ref, "
617 "unable to checkout.\n");
618 option_no_checkout = 1;
621 if (transport) {
622 transport_unlock_pack(transport);
623 transport_disconnect(transport);
626 if (!option_no_checkout) {
627 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
628 struct unpack_trees_options opts;
629 struct tree *tree;
630 struct tree_desc t;
631 int fd;
633 /* We need to be in the new work tree for the checkout */
634 setup_work_tree();
636 fd = hold_locked_index(lock_file, 1);
638 memset(&opts, 0, sizeof opts);
639 opts.update = 1;
640 opts.merge = 1;
641 opts.fn = oneway_merge;
642 opts.verbose_update = (option_verbosity > 0);
643 opts.src_index = &the_index;
644 opts.dst_index = &the_index;
646 tree = parse_tree_indirect(our_head_points_at->old_sha1);
647 parse_tree(tree);
648 init_tree_desc(&t, tree->buffer, tree->size);
649 unpack_trees(1, &t, &opts);
651 if (write_cache(fd, active_cache, active_nr) ||
652 commit_locked_index(lock_file))
653 die("unable to write new index file");
655 err |= run_hook(NULL, "post-checkout", sha1_to_hex(null_sha1),
656 sha1_to_hex(our_head_points_at->old_sha1), "1",
657 NULL);
659 if (!err && option_recursive)
660 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
663 strbuf_release(&reflog_msg);
664 strbuf_release(&branch_top);
665 strbuf_release(&key);
666 strbuf_release(&value);
667 junk_pid = 0;
668 return err;