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 */
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"
27 /*
28 * Overall FIXMEs:
29 * - respect DB_ENVIRONMENT for .git/objects.
30 *
31 * Implementation notes:
32 * - dropping use-separate-remote and no-separate-remote compatibility
33 *
34 */
35 static const char * const builtin_clone_usage[] = {
36 "git clone [options] [--] <repo> [<dir>]",
37 NULL
38 };
40 static int option_quiet, 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_verbose;
48 static struct option builtin_clone_options[] = {
49 OPT__QUIET(&option_quiet),
50 OPT__VERBOSE(&option_verbose),
51 OPT_BOOLEAN('n', "no-checkout", &option_no_checkout,
52 "don't create a checkout"),
53 OPT_BOOLEAN(0, "bare", &option_bare, "create a bare repository"),
54 { OPTION_BOOLEAN, 0, "naked", &option_bare, NULL,
55 "create a bare repository",
56 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
57 OPT_BOOLEAN(0, "mirror", &option_mirror,
58 "create a mirror repository (implies bare)"),
59 OPT_BOOLEAN('l', "local", &option_local,
60 "to clone from a local repository"),
61 OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks,
62 "don't use local hardlinks, always copy"),
63 OPT_BOOLEAN('s', "shared", &option_shared,
64 "setup as shared repository"),
65 OPT_BOOLEAN(0, "recursive", &option_recursive,
66 "initialize submodules in the clone"),
67 OPT_STRING(0, "template", &option_template, "path",
68 "path the template repository"),
69 OPT_STRING(0, "reference", &option_reference, "repo",
70 "reference repository"),
71 OPT_STRING('o', "origin", &option_origin, "branch",
72 "use <branch> instead of 'origin' to track upstream"),
73 OPT_STRING('b', "branch", &option_branch, "branch",
74 "checkout <branch> instead of the remote's HEAD"),
75 OPT_STRING('u', "upload-pack", &option_upload_pack, "path",
76 "path to git-upload-pack on the remote"),
77 OPT_STRING(0, "depth", &option_depth, "depth",
78 "create a shallow clone of that depth"),
80 OPT_END()
81 };
83 static const char *argv_submodule[] = {
84 "submodule", "update", "--init", "--recursive", NULL
85 };
87 static char *get_repo_path(const char *repo, int *is_bundle)
88 {
89 static char *suffix[] = { "/.git", ".git", "" };
90 static char *bundle_suffix[] = { ".bundle", "" };
91 struct stat st;
92 int i;
94 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
95 const char *path;
96 path = mkpath("%s%s", repo, suffix[i]);
97 if (is_directory(path)) {
98 *is_bundle = 0;
99 return xstrdup(make_nonrelative_path(path));
100 }
101 }
103 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
104 const char *path;
105 path = mkpath("%s%s", repo, bundle_suffix[i]);
106 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
107 *is_bundle = 1;
108 return xstrdup(make_nonrelative_path(path));
109 }
110 }
112 return NULL;
113 }
115 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
116 {
117 const char *end = repo + strlen(repo), *start;
118 char *dir;
120 /*
121 * Strip trailing spaces, slashes and /.git
122 */
123 while (repo < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
124 end--;
125 if (end - repo > 5 && is_dir_sep(end[-5]) &&
126 !strncmp(end - 4, ".git", 4)) {
127 end -= 5;
128 while (repo < end && is_dir_sep(end[-1]))
129 end--;
130 }
132 /*
133 * Find last component, but be prepared that repo could have
134 * the form "remote.example.com:foo.git", i.e. no slash
135 * in the directory part.
136 */
137 start = end;
138 while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
139 start--;
141 /*
142 * Strip .{bundle,git}.
143 */
144 if (is_bundle) {
145 if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
146 end -= 7;
147 } else {
148 if (end - start > 4 && !strncmp(end - 4, ".git", 4))
149 end -= 4;
150 }
152 if (is_bare) {
153 struct strbuf result = STRBUF_INIT;
154 strbuf_addf(&result, "%.*s.git", (int)(end - start), start);
155 dir = strbuf_detach(&result, NULL);
156 } else
157 dir = xstrndup(start, end - start);
158 /*
159 * Replace sequences of 'control' characters and whitespace
160 * with one ascii space, remove leading and trailing spaces.
161 */
162 if (*dir) {
163 char *out = dir;
164 int prev_space = 1 /* strip leading whitespace */;
165 for (end = dir; *end; ++end) {
166 char ch = *end;
167 if ((unsigned char)ch < '\x20')
168 ch = '\x20';
169 if (isspace(ch)) {
170 if (prev_space)
171 continue;
172 prev_space = 1;
173 } else
174 prev_space = 0;
175 *out++ = ch;
176 }
177 *out = '\0';
178 if (out > dir && prev_space)
179 out[-1] = '\0';
180 }
181 return dir;
182 }
184 static void strip_trailing_slashes(char *dir)
185 {
186 char *end = dir + strlen(dir);
188 while (dir < end - 1 && is_dir_sep(end[-1]))
189 end--;
190 *end = '\0';
191 }
193 static void setup_reference(const char *repo)
194 {
195 const char *ref_git;
196 char *ref_git_copy;
198 struct remote *remote;
199 struct transport *transport;
200 const struct ref *extra;
202 ref_git = make_absolute_path(option_reference);
204 if (is_directory(mkpath("%s/.git/objects", ref_git)))
205 ref_git = mkpath("%s/.git", ref_git);
206 else if (!is_directory(mkpath("%s/objects", ref_git)))
207 die("reference repository '%s' is not a local directory.",
208 option_reference);
210 ref_git_copy = xstrdup(ref_git);
212 add_to_alternates_file(ref_git_copy);
214 remote = remote_get(ref_git_copy);
215 transport = transport_get(remote, ref_git_copy);
216 for (extra = transport_get_remote_refs(transport); extra;
217 extra = extra->next)
218 add_extra_ref(extra->name, extra->old_sha1, 0);
220 transport_disconnect(transport);
222 free(ref_git_copy);
223 }
225 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest)
226 {
227 struct dirent *de;
228 struct stat buf;
229 int src_len, dest_len;
230 DIR *dir;
232 dir = opendir(src->buf);
233 if (!dir)
234 die_errno("failed to open '%s'", src->buf);
236 if (mkdir(dest->buf, 0777)) {
237 if (errno != EEXIST)
238 die_errno("failed to create directory '%s'", dest->buf);
239 else if (stat(dest->buf, &buf))
240 die_errno("failed to stat '%s'", dest->buf);
241 else if (!S_ISDIR(buf.st_mode))
242 die("%s exists and is not a directory", dest->buf);
243 }
245 strbuf_addch(src, '/');
246 src_len = src->len;
247 strbuf_addch(dest, '/');
248 dest_len = dest->len;
250 while ((de = readdir(dir)) != NULL) {
251 strbuf_setlen(src, src_len);
252 strbuf_addstr(src, de->d_name);
253 strbuf_setlen(dest, dest_len);
254 strbuf_addstr(dest, de->d_name);
255 if (stat(src->buf, &buf)) {
256 warning ("failed to stat %s\n", src->buf);
257 continue;
258 }
259 if (S_ISDIR(buf.st_mode)) {
260 if (de->d_name[0] != '.')
261 copy_or_link_directory(src, dest);
262 continue;
263 }
265 if (unlink(dest->buf) && errno != ENOENT)
266 die_errno("failed to unlink '%s'", dest->buf);
267 if (!option_no_hardlinks) {
268 if (!link(src->buf, dest->buf))
269 continue;
270 if (option_local)
271 die_errno("failed to create link '%s'", dest->buf);
272 option_no_hardlinks = 1;
273 }
274 if (copy_file_with_time(dest->buf, src->buf, 0666))
275 die_errno("failed to copy file to '%s'", dest->buf);
276 }
277 closedir(dir);
278 }
280 static const struct ref *clone_local(const char *src_repo,
281 const char *dest_repo)
282 {
283 const struct ref *ret;
284 struct strbuf src = STRBUF_INIT;
285 struct strbuf dest = STRBUF_INIT;
286 struct remote *remote;
287 struct transport *transport;
289 if (option_shared)
290 add_to_alternates_file(src_repo);
291 else {
292 strbuf_addf(&src, "%s/objects", src_repo);
293 strbuf_addf(&dest, "%s/objects", dest_repo);
294 copy_or_link_directory(&src, &dest);
295 strbuf_release(&src);
296 strbuf_release(&dest);
297 }
299 remote = remote_get(src_repo);
300 transport = transport_get(remote, src_repo);
301 ret = transport_get_remote_refs(transport);
302 transport_disconnect(transport);
303 return ret;
304 }
306 static const char *junk_work_tree;
307 static const char *junk_git_dir;
308 static pid_t junk_pid;
310 static void remove_junk(void)
311 {
312 struct strbuf sb = STRBUF_INIT;
313 if (getpid() != junk_pid)
314 return;
315 if (junk_git_dir) {
316 strbuf_addstr(&sb, junk_git_dir);
317 remove_dir_recursively(&sb, 0);
318 strbuf_reset(&sb);
319 }
320 if (junk_work_tree) {
321 strbuf_addstr(&sb, junk_work_tree);
322 remove_dir_recursively(&sb, 0);
323 strbuf_reset(&sb);
324 }
325 }
327 static void remove_junk_on_signal(int signo)
328 {
329 remove_junk();
330 sigchain_pop(signo);
331 raise(signo);
332 }
334 static struct ref *wanted_peer_refs(const struct ref *refs,
335 struct refspec *refspec)
336 {
337 struct ref *local_refs = NULL;
338 struct ref **tail = &local_refs;
340 get_fetch_map(refs, refspec, &tail, 0);
341 if (!option_mirror)
342 get_fetch_map(refs, tag_refspec, &tail, 0);
344 return local_refs;
345 }
347 static void write_remote_refs(const struct ref *local_refs)
348 {
349 const struct ref *r;
351 for (r = local_refs; r; r = r->next)
352 add_extra_ref(r->peer_ref->name, r->old_sha1, 0);
354 pack_refs(PACK_REFS_ALL);
355 clear_extra_refs();
356 }
358 int cmd_clone(int argc, const char **argv, const char *prefix)
359 {
360 int is_bundle = 0;
361 struct stat buf;
362 const char *repo_name, *repo, *work_tree, *git_dir;
363 char *path, *dir;
364 int dest_exists;
365 const struct ref *refs, *remote_head, *mapped_refs;
366 const struct ref *remote_head_points_at;
367 const struct ref *our_head_points_at;
368 struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
369 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
370 struct transport *transport = NULL;
371 char *src_ref_prefix = "refs/heads/";
372 int err = 0;
374 struct refspec *refspec;
375 const char *fetch_pattern;
377 junk_pid = getpid();
379 argc = parse_options(argc, argv, prefix, builtin_clone_options,
380 builtin_clone_usage, 0);
382 if (argc == 0)
383 die("You must specify a repository to clone.");
385 if (option_mirror)
386 option_bare = 1;
388 if (option_bare) {
389 if (option_origin)
390 die("--bare and --origin %s options are incompatible.",
391 option_origin);
392 option_no_checkout = 1;
393 }
395 if (!option_origin)
396 option_origin = "origin";
398 repo_name = argv[0];
400 path = get_repo_path(repo_name, &is_bundle);
401 if (path)
402 repo = xstrdup(make_nonrelative_path(repo_name));
403 else if (!strchr(repo_name, ':'))
404 repo = xstrdup(make_absolute_path(repo_name));
405 else
406 repo = repo_name;
408 if (argc == 2)
409 dir = xstrdup(argv[1]);
410 else
411 dir = guess_dir_name(repo_name, is_bundle, option_bare);
412 strip_trailing_slashes(dir);
414 dest_exists = !stat(dir, &buf);
415 if (dest_exists && !is_empty_dir(dir))
416 die("destination path '%s' already exists and is not "
417 "an empty directory.", dir);
419 strbuf_addf(&reflog_msg, "clone: from %s", repo);
421 if (option_bare)
422 work_tree = NULL;
423 else {
424 work_tree = getenv("GIT_WORK_TREE");
425 if (work_tree && !stat(work_tree, &buf))
426 die("working tree '%s' already exists.", work_tree);
427 }
429 if (option_bare || work_tree)
430 git_dir = xstrdup(dir);
431 else {
432 work_tree = dir;
433 git_dir = xstrdup(mkpath("%s/.git", dir));
434 }
436 if (!option_bare) {
437 junk_work_tree = work_tree;
438 if (safe_create_leading_directories_const(work_tree) < 0)
439 die_errno("could not create leading directories of '%s'",
440 work_tree);
441 if (!dest_exists && mkdir(work_tree, 0755))
442 die_errno("could not create work tree dir '%s'.",
443 work_tree);
444 set_git_work_tree(work_tree);
445 }
446 junk_git_dir = git_dir;
447 atexit(remove_junk);
448 sigchain_push_common(remove_junk_on_signal);
450 setenv(CONFIG_ENVIRONMENT, mkpath("%s/config", git_dir), 1);
452 if (safe_create_leading_directories_const(git_dir) < 0)
453 die("could not create leading directories of '%s'", git_dir);
454 set_git_dir(make_absolute_path(git_dir));
456 init_db(option_template, option_quiet ? INIT_DB_QUIET : 0);
458 /*
459 * At this point, the config exists, so we do not need the
460 * environment variable. We actually need to unset it, too, to
461 * re-enable parsing of the global configs.
462 */
463 unsetenv(CONFIG_ENVIRONMENT);
465 if (option_reference)
466 setup_reference(git_dir);
468 git_config(git_default_config, NULL);
470 if (option_bare) {
471 if (option_mirror)
472 src_ref_prefix = "refs/";
473 strbuf_addstr(&branch_top, src_ref_prefix);
475 git_config_set("core.bare", "true");
476 } else {
477 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
478 }
480 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
482 if (option_mirror || !option_bare) {
483 /* Configure the remote */
484 strbuf_addf(&key, "remote.%s.fetch", option_origin);
485 git_config_set_multivar(key.buf, value.buf, "^$", 0);
486 strbuf_reset(&key);
488 if (option_mirror) {
489 strbuf_addf(&key, "remote.%s.mirror", option_origin);
490 git_config_set(key.buf, "true");
491 strbuf_reset(&key);
492 }
494 strbuf_addf(&key, "remote.%s.url", option_origin);
495 git_config_set(key.buf, repo);
496 strbuf_reset(&key);
497 }
499 fetch_pattern = value.buf;
500 refspec = parse_fetch_refspec(1, &fetch_pattern);
502 strbuf_reset(&value);
504 if (path && !is_bundle) {
505 refs = clone_local(path, git_dir);
506 mapped_refs = wanted_peer_refs(refs, refspec);
507 } else {
508 struct remote *remote = remote_get(argv[0]);
509 transport = transport_get(remote, remote->url[0]);
511 if (!transport->get_refs_list || !transport->fetch)
512 die("Don't know how to clone %s", transport->url);
514 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
516 if (option_depth)
517 transport_set_option(transport, TRANS_OPT_DEPTH,
518 option_depth);
520 if (option_quiet)
521 transport->verbose = -1;
522 else if (option_verbose)
523 transport->progress = 1;
525 if (option_upload_pack)
526 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
527 option_upload_pack);
529 refs = transport_get_remote_refs(transport);
530 if (refs) {
531 mapped_refs = wanted_peer_refs(refs, refspec);
532 transport_fetch_refs(transport, mapped_refs);
533 }
534 }
536 if (refs) {
537 clear_extra_refs();
539 write_remote_refs(mapped_refs);
541 remote_head = find_ref_by_name(refs, "HEAD");
542 remote_head_points_at =
543 guess_remote_head(remote_head, mapped_refs, 0);
545 if (option_branch) {
546 struct strbuf head = STRBUF_INIT;
547 strbuf_addstr(&head, src_ref_prefix);
548 strbuf_addstr(&head, option_branch);
549 our_head_points_at =
550 find_ref_by_name(mapped_refs, head.buf);
551 strbuf_release(&head);
553 if (!our_head_points_at) {
554 warning("Remote branch %s not found in "
555 "upstream %s, using HEAD instead",
556 option_branch, option_origin);
557 our_head_points_at = remote_head_points_at;
558 }
559 }
560 else
561 our_head_points_at = remote_head_points_at;
562 }
563 else {
564 warning("You appear to have cloned an empty repository.");
565 our_head_points_at = NULL;
566 remote_head_points_at = NULL;
567 remote_head = NULL;
568 option_no_checkout = 1;
569 if (!option_bare)
570 install_branch_config(0, "master", option_origin,
571 "refs/heads/master");
572 }
574 if (remote_head_points_at && !option_bare) {
575 struct strbuf head_ref = STRBUF_INIT;
576 strbuf_addstr(&head_ref, branch_top.buf);
577 strbuf_addstr(&head_ref, "HEAD");
578 create_symref(head_ref.buf,
579 remote_head_points_at->peer_ref->name,
580 reflog_msg.buf);
581 }
583 if (our_head_points_at) {
584 /* Local default branch link */
585 create_symref("HEAD", our_head_points_at->name, NULL);
586 if (!option_bare) {
587 const char *head = skip_prefix(our_head_points_at->name,
588 "refs/heads/");
589 update_ref(reflog_msg.buf, "HEAD",
590 our_head_points_at->old_sha1,
591 NULL, 0, DIE_ON_ERR);
592 install_branch_config(0, head, option_origin,
593 our_head_points_at->name);
594 }
595 } else if (remote_head) {
596 /* Source had detached HEAD pointing somewhere. */
597 if (!option_bare) {
598 update_ref(reflog_msg.buf, "HEAD",
599 remote_head->old_sha1,
600 NULL, REF_NODEREF, DIE_ON_ERR);
601 our_head_points_at = remote_head;
602 }
603 } else {
604 /* Nothing to checkout out */
605 if (!option_no_checkout)
606 warning("remote HEAD refers to nonexistent ref, "
607 "unable to checkout.\n");
608 option_no_checkout = 1;
609 }
611 if (transport) {
612 transport_unlock_pack(transport);
613 transport_disconnect(transport);
614 }
616 if (!option_no_checkout) {
617 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
618 struct unpack_trees_options opts;
619 struct tree *tree;
620 struct tree_desc t;
621 int fd;
623 /* We need to be in the new work tree for the checkout */
624 setup_work_tree();
626 fd = hold_locked_index(lock_file, 1);
628 memset(&opts, 0, sizeof opts);
629 opts.update = 1;
630 opts.merge = 1;
631 opts.fn = oneway_merge;
632 opts.verbose_update = !option_quiet;
633 opts.src_index = &the_index;
634 opts.dst_index = &the_index;
636 tree = parse_tree_indirect(our_head_points_at->old_sha1);
637 parse_tree(tree);
638 init_tree_desc(&t, tree->buffer, tree->size);
639 unpack_trees(1, &t, &opts);
641 if (write_cache(fd, active_cache, active_nr) ||
642 commit_locked_index(lock_file))
643 die("unable to write new index file");
645 err |= run_hook(NULL, "post-checkout", sha1_to_hex(null_sha1),
646 sha1_to_hex(our_head_points_at->old_sha1), "1",
647 NULL);
649 if (!err && option_recursive)
650 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
651 }
653 strbuf_release(&reflog_msg);
654 strbuf_release(&branch_top);
655 strbuf_release(&key);
656 strbuf_release(&value);
657 junk_pid = 0;
658 return err;
659 }