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_reference
, *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
;
50 static struct option builtin_clone_options
[] = {
51 OPT__VERBOSITY(&option_verbosity
),
52 OPT_BOOLEAN(0, "progress", &option_progress
,
53 "force progress reporting"),
54 OPT_BOOLEAN('n', "no-checkout", &option_no_checkout
,
55 "don't create a checkout"),
56 OPT_BOOLEAN(0, "bare", &option_bare
, "create a bare repository"),
57 { OPTION_BOOLEAN
, 0, "naked", &option_bare
, NULL
,
58 "create a bare repository",
59 PARSE_OPT_NOARG
| PARSE_OPT_HIDDEN
},
60 OPT_BOOLEAN(0, "mirror", &option_mirror
,
61 "create a mirror repository (implies bare)"),
62 OPT_BOOLEAN('l', "local", &option_local
,
63 "to clone from a local repository"),
64 OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks
,
65 "don't use local hardlinks, always copy"),
66 OPT_BOOLEAN('s', "shared", &option_shared
,
67 "setup as shared repository"),
68 OPT_BOOLEAN(0, "recursive", &option_recursive
,
69 "initialize submodules in the clone"),
70 OPT_BOOLEAN(0, "recurse-submodules", &option_recursive
,
71 "initialize submodules in the clone"),
72 OPT_STRING(0, "template", &option_template
, "template-directory",
73 "directory from which templates will be used"),
74 OPT_STRING(0, "reference", &option_reference
, "repo",
75 "reference repository"),
76 OPT_STRING('o', "origin", &option_origin
, "branch",
77 "use <branch> instead of 'origin' to track upstream"),
78 OPT_STRING('b', "branch", &option_branch
, "branch",
79 "checkout <branch> instead of the remote's HEAD"),
80 OPT_STRING('u', "upload-pack", &option_upload_pack
, "path",
81 "path to git-upload-pack on the remote"),
82 OPT_STRING(0, "depth", &option_depth
, "depth",
83 "create a shallow clone of that depth"),
84 OPT_STRING('L', "separate-git-dir", &real_git_dir
, "gitdir",
85 "separate git dir from working tree"),
90 static const char *argv_submodule
[] = {
91 "submodule", "update", "--init", "--recursive", NULL
94 static char *get_repo_path(const char *repo
, int *is_bundle
)
96 static char *suffix
[] = { "/.git", ".git", "" };
97 static char *bundle_suffix
[] = { ".bundle", "" };
101 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
103 path
= mkpath("%s%s", repo
, suffix
[i
]);
104 if (is_directory(path
)) {
106 return xstrdup(absolute_path(path
));
110 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
112 path
= mkpath("%s%s", repo
, bundle_suffix
[i
]);
113 if (!stat(path
, &st
) && S_ISREG(st
.st_mode
)) {
115 return xstrdup(absolute_path(path
));
122 static char *guess_dir_name(const char *repo
, int is_bundle
, int is_bare
)
124 const char *end
= repo
+ strlen(repo
), *start
;
128 * Strip trailing spaces, slashes and /.git
130 while (repo
< end
&& (is_dir_sep(end
[-1]) || isspace(end
[-1])))
132 if (end
- repo
> 5 && is_dir_sep(end
[-5]) &&
133 !strncmp(end
- 4, ".git", 4)) {
135 while (repo
< end
&& is_dir_sep(end
[-1]))
140 * Find last component, but be prepared that repo could have
141 * the form "remote.example.com:foo.git", i.e. no slash
142 * in the directory part.
145 while (repo
< start
&& !is_dir_sep(start
[-1]) && start
[-1] != ':')
149 * Strip .{bundle,git}.
152 if (end
- start
> 7 && !strncmp(end
- 7, ".bundle", 7))
155 if (end
- start
> 4 && !strncmp(end
- 4, ".git", 4))
160 struct strbuf result
= STRBUF_INIT
;
161 strbuf_addf(&result
, "%.*s.git", (int)(end
- start
), start
);
162 dir
= strbuf_detach(&result
, NULL
);
164 dir
= xstrndup(start
, end
- start
);
166 * Replace sequences of 'control' characters and whitespace
167 * with one ascii space, remove leading and trailing spaces.
171 int prev_space
= 1 /* strip leading whitespace */;
172 for (end
= dir
; *end
; ++end
) {
174 if ((unsigned char)ch
< '\x20')
185 if (out
> dir
&& prev_space
)
191 static void strip_trailing_slashes(char *dir
)
193 char *end
= dir
+ strlen(dir
);
195 while (dir
< end
- 1 && is_dir_sep(end
[-1]))
200 static void setup_reference(const char *repo
)
205 struct remote
*remote
;
206 struct transport
*transport
;
207 const struct ref
*extra
;
209 ref_git
= real_path(option_reference
);
211 if (is_directory(mkpath("%s/.git/objects", ref_git
)))
212 ref_git
= mkpath("%s/.git", ref_git
);
213 else if (!is_directory(mkpath("%s/objects", ref_git
)))
214 die("reference repository '%s' is not a local directory.",
217 ref_git_copy
= xstrdup(ref_git
);
219 add_to_alternates_file(ref_git_copy
);
221 remote
= remote_get(ref_git_copy
);
222 transport
= transport_get(remote
, ref_git_copy
);
223 for (extra
= transport_get_remote_refs(transport
); extra
;
225 add_extra_ref(extra
->name
, extra
->old_sha1
, 0);
227 transport_disconnect(transport
);
232 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
)
236 int src_len
, dest_len
;
239 dir
= opendir(src
->buf
);
241 die_errno("failed to open '%s'", src
->buf
);
243 if (mkdir(dest
->buf
, 0777)) {
245 die_errno("failed to create directory '%s'", dest
->buf
);
246 else if (stat(dest
->buf
, &buf
))
247 die_errno("failed to stat '%s'", dest
->buf
);
248 else if (!S_ISDIR(buf
.st_mode
))
249 die("%s exists and is not a directory", dest
->buf
);
252 strbuf_addch(src
, '/');
254 strbuf_addch(dest
, '/');
255 dest_len
= dest
->len
;
257 while ((de
= readdir(dir
)) != NULL
) {
258 strbuf_setlen(src
, src_len
);
259 strbuf_addstr(src
, de
->d_name
);
260 strbuf_setlen(dest
, dest_len
);
261 strbuf_addstr(dest
, de
->d_name
);
262 if (stat(src
->buf
, &buf
)) {
263 warning ("failed to stat %s\n", src
->buf
);
266 if (S_ISDIR(buf
.st_mode
)) {
267 if (de
->d_name
[0] != '.')
268 copy_or_link_directory(src
, dest
);
272 if (unlink(dest
->buf
) && errno
!= ENOENT
)
273 die_errno("failed to unlink '%s'", dest
->buf
);
274 if (!option_no_hardlinks
) {
275 if (!link(src
->buf
, dest
->buf
))
278 die_errno("failed to create link '%s'", dest
->buf
);
279 option_no_hardlinks
= 1;
281 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
282 die_errno("failed to copy file to '%s'", dest
->buf
);
287 static const struct ref
*clone_local(const char *src_repo
,
288 const char *dest_repo
)
290 const struct ref
*ret
;
291 struct strbuf src
= STRBUF_INIT
;
292 struct strbuf dest
= STRBUF_INIT
;
293 struct remote
*remote
;
294 struct transport
*transport
;
297 add_to_alternates_file(src_repo
);
299 strbuf_addf(&src
, "%s/objects", src_repo
);
300 strbuf_addf(&dest
, "%s/objects", dest_repo
);
301 copy_or_link_directory(&src
, &dest
);
302 strbuf_release(&src
);
303 strbuf_release(&dest
);
306 remote
= remote_get(src_repo
);
307 transport
= transport_get(remote
, src_repo
);
308 ret
= transport_get_remote_refs(transport
);
309 transport_disconnect(transport
);
310 if (0 <= option_verbosity
)
315 static const char *junk_work_tree
;
316 static const char *junk_git_dir
;
317 static pid_t junk_pid
;
319 static void remove_junk(void)
321 struct strbuf sb
= STRBUF_INIT
;
322 if (getpid() != junk_pid
)
325 strbuf_addstr(&sb
, junk_git_dir
);
326 remove_dir_recursively(&sb
, 0);
329 if (junk_work_tree
) {
330 strbuf_addstr(&sb
, junk_work_tree
);
331 remove_dir_recursively(&sb
, 0);
336 static void remove_junk_on_signal(int signo
)
343 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
344 struct refspec
*refspec
)
346 struct ref
*local_refs
= NULL
;
347 struct ref
**tail
= &local_refs
;
349 get_fetch_map(refs
, refspec
, &tail
, 0);
351 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
356 static void write_remote_refs(const struct ref
*local_refs
)
360 for (r
= local_refs
; r
; r
= r
->next
)
361 add_extra_ref(r
->peer_ref
->name
, r
->old_sha1
, 0);
363 pack_refs(PACK_REFS_ALL
);
367 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
369 int is_bundle
= 0, is_local
;
371 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
374 const struct ref
*refs
, *remote_head
;
375 const struct ref
*remote_head_points_at
;
376 const struct ref
*our_head_points_at
;
377 struct ref
*mapped_refs
;
378 struct strbuf key
= STRBUF_INIT
, value
= STRBUF_INIT
;
379 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
380 struct transport
*transport
= NULL
;
381 char *src_ref_prefix
= "refs/heads/";
384 struct refspec
*refspec
;
385 const char *fetch_pattern
;
389 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
390 builtin_clone_usage
, 0);
393 usage_msg_opt("Too many arguments.",
394 builtin_clone_usage
, builtin_clone_options
);
397 usage_msg_opt("You must specify a repository to clone.",
398 builtin_clone_usage
, builtin_clone_options
);
405 die("--bare and --origin %s options are incompatible.",
407 option_no_checkout
= 1;
411 option_origin
= "origin";
415 path
= get_repo_path(repo_name
, &is_bundle
);
417 repo
= xstrdup(absolute_path(repo_name
));
418 else if (!strchr(repo_name
, ':'))
419 die("repository '%s' does not exist", repo_name
);
422 is_local
= path
&& !is_bundle
;
423 if (is_local
&& option_depth
)
424 warning("--depth is ignored in local clones; use file:// instead.");
427 dir
= xstrdup(argv
[1]);
429 dir
= guess_dir_name(repo_name
, is_bundle
, option_bare
);
430 strip_trailing_slashes(dir
);
432 dest_exists
= !stat(dir
, &buf
);
433 if (dest_exists
&& !is_empty_dir(dir
))
434 die("destination path '%s' already exists and is not "
435 "an empty directory.", dir
);
437 strbuf_addf(&reflog_msg
, "clone: from %s", repo
);
442 work_tree
= getenv("GIT_WORK_TREE");
443 if (work_tree
&& !stat(work_tree
, &buf
))
444 die("working tree '%s' already exists.", work_tree
);
447 if (option_bare
|| work_tree
)
448 git_dir
= xstrdup(dir
);
451 git_dir
= xstrdup(mkpath("%s/.git", dir
));
455 junk_work_tree
= work_tree
;
456 if (safe_create_leading_directories_const(work_tree
) < 0)
457 die_errno("could not create leading directories of '%s'",
459 if (!dest_exists
&& mkdir(work_tree
, 0755))
460 die_errno("could not create work tree dir '%s'.",
462 set_git_work_tree(work_tree
);
464 junk_git_dir
= git_dir
;
466 sigchain_push_common(remove_junk_on_signal
);
468 setenv(CONFIG_ENVIRONMENT
, mkpath("%s/config", git_dir
), 1);
470 if (safe_create_leading_directories_const(git_dir
) < 0)
471 die("could not create leading directories of '%s'", git_dir
);
473 set_git_dir_init(git_dir
, real_git_dir
, 0);
475 git_dir
= real_git_dir
;
477 if (0 <= option_verbosity
)
478 printf("Cloning into %s%s...\n",
479 option_bare
? "bare repository " : "", dir
);
480 init_db(option_template
, INIT_DB_QUIET
);
483 * At this point, the config exists, so we do not need the
484 * environment variable. We actually need to unset it, too, to
485 * re-enable parsing of the global configs.
487 unsetenv(CONFIG_ENVIRONMENT
);
489 git_config(git_default_config
, NULL
);
493 src_ref_prefix
= "refs/";
494 strbuf_addstr(&branch_top
, src_ref_prefix
);
496 git_config_set("core.bare", "true");
498 strbuf_addf(&branch_top
, "refs/remotes/%s/", option_origin
);
501 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
.buf
);
503 if (option_mirror
|| !option_bare
) {
504 /* Configure the remote */
505 strbuf_addf(&key
, "remote.%s.fetch", option_origin
);
506 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
510 strbuf_addf(&key
, "remote.%s.mirror", option_origin
);
511 git_config_set(key
.buf
, "true");
516 strbuf_addf(&key
, "remote.%s.url", option_origin
);
517 git_config_set(key
.buf
, repo
);
520 if (option_reference
)
521 setup_reference(git_dir
);
523 fetch_pattern
= value
.buf
;
524 refspec
= parse_fetch_refspec(1, &fetch_pattern
);
526 strbuf_reset(&value
);
529 refs
= clone_local(path
, git_dir
);
530 mapped_refs
= wanted_peer_refs(refs
, refspec
);
532 struct remote
*remote
= remote_get(option_origin
);
533 transport
= transport_get(remote
, remote
->url
[0]);
535 if (!transport
->get_refs_list
|| !transport
->fetch
)
536 die("Don't know how to clone %s", transport
->url
);
538 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
541 transport_set_option(transport
, TRANS_OPT_DEPTH
,
544 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
546 if (option_upload_pack
)
547 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
550 refs
= transport_get_remote_refs(transport
);
552 mapped_refs
= wanted_peer_refs(refs
, refspec
);
553 transport_fetch_refs(transport
, mapped_refs
);
560 write_remote_refs(mapped_refs
);
562 remote_head
= find_ref_by_name(refs
, "HEAD");
563 remote_head_points_at
=
564 guess_remote_head(remote_head
, mapped_refs
, 0);
567 struct strbuf head
= STRBUF_INIT
;
568 strbuf_addstr(&head
, src_ref_prefix
);
569 strbuf_addstr(&head
, option_branch
);
571 find_ref_by_name(mapped_refs
, head
.buf
);
572 strbuf_release(&head
);
574 if (!our_head_points_at
) {
575 warning("Remote branch %s not found in "
576 "upstream %s, using HEAD instead",
577 option_branch
, option_origin
);
578 our_head_points_at
= remote_head_points_at
;
582 our_head_points_at
= remote_head_points_at
;
585 warning("You appear to have cloned an empty repository.");
586 our_head_points_at
= NULL
;
587 remote_head_points_at
= NULL
;
589 option_no_checkout
= 1;
591 install_branch_config(0, "master", option_origin
,
592 "refs/heads/master");
595 if (remote_head_points_at
&& !option_bare
) {
596 struct strbuf head_ref
= STRBUF_INIT
;
597 strbuf_addstr(&head_ref
, branch_top
.buf
);
598 strbuf_addstr(&head_ref
, "HEAD");
599 create_symref(head_ref
.buf
,
600 remote_head_points_at
->peer_ref
->name
,
604 if (our_head_points_at
) {
605 /* Local default branch link */
606 create_symref("HEAD", our_head_points_at
->name
, NULL
);
608 const char *head
= skip_prefix(our_head_points_at
->name
,
610 update_ref(reflog_msg
.buf
, "HEAD",
611 our_head_points_at
->old_sha1
,
612 NULL
, 0, DIE_ON_ERR
);
613 install_branch_config(0, head
, option_origin
,
614 our_head_points_at
->name
);
616 } else if (remote_head
) {
617 /* Source had detached HEAD pointing somewhere. */
619 update_ref(reflog_msg
.buf
, "HEAD",
620 remote_head
->old_sha1
,
621 NULL
, REF_NODEREF
, DIE_ON_ERR
);
622 our_head_points_at
= remote_head
;
625 /* Nothing to checkout out */
626 if (!option_no_checkout
)
627 warning("remote HEAD refers to nonexistent ref, "
628 "unable to checkout.\n");
629 option_no_checkout
= 1;
633 transport_unlock_pack(transport
);
634 transport_disconnect(transport
);
637 if (!option_no_checkout
) {
638 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
639 struct unpack_trees_options opts
;
644 /* We need to be in the new work tree for the checkout */
647 fd
= hold_locked_index(lock_file
, 1);
649 memset(&opts
, 0, sizeof opts
);
652 opts
.fn
= oneway_merge
;
653 opts
.verbose_update
= (option_verbosity
> 0);
654 opts
.src_index
= &the_index
;
655 opts
.dst_index
= &the_index
;
657 tree
= parse_tree_indirect(our_head_points_at
->old_sha1
);
659 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
660 unpack_trees(1, &t
, &opts
);
662 if (write_cache(fd
, active_cache
, active_nr
) ||
663 commit_locked_index(lock_file
))
664 die("unable to write new index file");
666 err
|= run_hook(NULL
, "post-checkout", sha1_to_hex(null_sha1
),
667 sha1_to_hex(our_head_points_at
->old_sha1
), "1",
670 if (!err
&& option_recursive
)
671 err
= run_command_v_opt(argv_submodule
, RUN_GIT_CMD
);
674 strbuf_release(&reflog_msg
);
675 strbuf_release(&branch_top
);
676 strbuf_release(&key
);
677 strbuf_release(&value
);