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_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 OPT_BOOLEAN(0, "naked", &option_bare
, "create a bare repository"),
55 OPT_BOOLEAN(0, "mirror", &option_mirror
,
56 "create a mirror repository (implies bare)"),
57 OPT_BOOLEAN('l', "local", &option_local
,
58 "to clone from a local repository"),
59 OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks
,
60 "don't use local hardlinks, always copy"),
61 OPT_BOOLEAN('s', "shared", &option_shared
,
62 "setup as shared repository"),
63 OPT_BOOLEAN(0, "recursive", &option_recursive
,
64 "setup as shared repository"),
65 OPT_STRING(0, "template", &option_template
, "path",
66 "path the template repository"),
67 OPT_STRING(0, "reference", &option_reference
, "repo",
68 "reference repository"),
69 OPT_STRING('o', "origin", &option_origin
, "branch",
70 "use <branch> instead of 'origin' to track upstream"),
71 OPT_STRING('b', "branch", &option_branch
, "branch",
72 "checkout <branch> instead of the remote's HEAD"),
73 OPT_STRING('u', "upload-pack", &option_upload_pack
, "path",
74 "path to git-upload-pack on the remote"),
75 OPT_STRING(0, "depth", &option_depth
, "depth",
76 "create a shallow clone of that depth"),
81 static const char *argv_submodule
[] = {
82 "submodule", "update", "--init", "--recursive", NULL
85 static char *get_repo_path(const char *repo
, int *is_bundle
)
87 static char *suffix
[] = { "/.git", ".git", "" };
88 static char *bundle_suffix
[] = { ".bundle", "" };
92 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
94 path
= mkpath("%s%s", repo
, suffix
[i
]);
95 if (is_directory(path
)) {
97 return xstrdup(make_nonrelative_path(path
));
101 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
103 path
= mkpath("%s%s", repo
, bundle_suffix
[i
]);
104 if (!stat(path
, &st
) && S_ISREG(st
.st_mode
)) {
106 return xstrdup(make_nonrelative_path(path
));
113 static char *guess_dir_name(const char *repo
, int is_bundle
, int is_bare
)
115 const char *end
= repo
+ strlen(repo
), *start
;
119 * Strip trailing spaces, slashes and /.git
121 while (repo
< end
&& (is_dir_sep(end
[-1]) || isspace(end
[-1])))
123 if (end
- repo
> 5 && is_dir_sep(end
[-5]) &&
124 !strncmp(end
- 4, ".git", 4)) {
126 while (repo
< end
&& is_dir_sep(end
[-1]))
131 * Find last component, but be prepared that repo could have
132 * the form "remote.example.com:foo.git", i.e. no slash
133 * in the directory part.
136 while (repo
< start
&& !is_dir_sep(start
[-1]) && start
[-1] != ':')
140 * Strip .{bundle,git}.
143 if (end
- start
> 7 && !strncmp(end
- 7, ".bundle", 7))
146 if (end
- start
> 4 && !strncmp(end
- 4, ".git", 4))
151 struct strbuf result
= STRBUF_INIT
;
152 strbuf_addf(&result
, "%.*s.git", (int)(end
- start
), start
);
153 dir
= strbuf_detach(&result
, NULL
);
155 dir
= xstrndup(start
, end
- start
);
157 * Replace sequences of 'control' characters and whitespace
158 * with one ascii space, remove leading and trailing spaces.
162 int prev_space
= 1 /* strip leading whitespace */;
163 for (end
= dir
; *end
; ++end
) {
165 if ((unsigned char)ch
< '\x20')
176 if (out
> dir
&& prev_space
)
182 static void strip_trailing_slashes(char *dir
)
184 char *end
= dir
+ strlen(dir
);
186 while (dir
< end
- 1 && is_dir_sep(end
[-1]))
191 static void setup_reference(const char *repo
)
196 struct remote
*remote
;
197 struct transport
*transport
;
198 const struct ref
*extra
;
200 ref_git
= make_absolute_path(option_reference
);
202 if (is_directory(mkpath("%s/.git/objects", ref_git
)))
203 ref_git
= mkpath("%s/.git", ref_git
);
204 else if (!is_directory(mkpath("%s/objects", ref_git
)))
205 die("reference repository '%s' is not a local directory.",
208 ref_git_copy
= xstrdup(ref_git
);
210 add_to_alternates_file(ref_git_copy
);
212 remote
= remote_get(ref_git_copy
);
213 transport
= transport_get(remote
, ref_git_copy
);
214 for (extra
= transport_get_remote_refs(transport
); extra
;
216 add_extra_ref(extra
->name
, extra
->old_sha1
, 0);
218 transport_disconnect(transport
);
223 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
)
227 int src_len
, dest_len
;
230 dir
= opendir(src
->buf
);
232 die_errno("failed to open '%s'", src
->buf
);
234 if (mkdir(dest
->buf
, 0777)) {
236 die_errno("failed to create directory '%s'", dest
->buf
);
237 else if (stat(dest
->buf
, &buf
))
238 die_errno("failed to stat '%s'", dest
->buf
);
239 else if (!S_ISDIR(buf
.st_mode
))
240 die("%s exists and is not a directory", dest
->buf
);
243 strbuf_addch(src
, '/');
245 strbuf_addch(dest
, '/');
246 dest_len
= dest
->len
;
248 while ((de
= readdir(dir
)) != NULL
) {
249 strbuf_setlen(src
, src_len
);
250 strbuf_addstr(src
, de
->d_name
);
251 strbuf_setlen(dest
, dest_len
);
252 strbuf_addstr(dest
, de
->d_name
);
253 if (stat(src
->buf
, &buf
)) {
254 warning ("failed to stat %s\n", src
->buf
);
257 if (S_ISDIR(buf
.st_mode
)) {
258 if (de
->d_name
[0] != '.')
259 copy_or_link_directory(src
, dest
);
263 if (unlink(dest
->buf
) && errno
!= ENOENT
)
264 die_errno("failed to unlink '%s'", dest
->buf
);
265 if (!option_no_hardlinks
) {
266 if (!link(src
->buf
, dest
->buf
))
269 die_errno("failed to create link '%s'", dest
->buf
);
270 option_no_hardlinks
= 1;
272 if (copy_file(dest
->buf
, src
->buf
, 0666))
273 die_errno("failed to copy file to '%s'", dest
->buf
);
278 static const struct ref
*clone_local(const char *src_repo
,
279 const char *dest_repo
)
281 const struct ref
*ret
;
282 struct strbuf src
= STRBUF_INIT
;
283 struct strbuf dest
= STRBUF_INIT
;
284 struct remote
*remote
;
285 struct transport
*transport
;
288 add_to_alternates_file(src_repo
);
290 strbuf_addf(&src
, "%s/objects", src_repo
);
291 strbuf_addf(&dest
, "%s/objects", dest_repo
);
292 copy_or_link_directory(&src
, &dest
);
293 strbuf_release(&src
);
294 strbuf_release(&dest
);
297 remote
= remote_get(src_repo
);
298 transport
= transport_get(remote
, src_repo
);
299 ret
= transport_get_remote_refs(transport
);
300 transport_disconnect(transport
);
304 static const char *junk_work_tree
;
305 static const char *junk_git_dir
;
306 static pid_t junk_pid
;
308 static void remove_junk(void)
310 struct strbuf sb
= STRBUF_INIT
;
311 if (getpid() != junk_pid
)
314 strbuf_addstr(&sb
, junk_git_dir
);
315 remove_dir_recursively(&sb
, 0);
318 if (junk_work_tree
) {
319 strbuf_addstr(&sb
, junk_work_tree
);
320 remove_dir_recursively(&sb
, 0);
325 static void remove_junk_on_signal(int signo
)
332 static struct ref
*write_remote_refs(const struct ref
*refs
,
333 struct refspec
*refspec
, const char *reflog
)
335 struct ref
*local_refs
= NULL
;
336 struct ref
**tail
= &local_refs
;
339 get_fetch_map(refs
, refspec
, &tail
, 0);
341 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
343 for (r
= local_refs
; r
; r
= r
->next
)
344 add_extra_ref(r
->peer_ref
->name
, r
->old_sha1
, 0);
346 pack_refs(PACK_REFS_ALL
);
352 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
356 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
359 const struct ref
*refs
, *remote_head
, *mapped_refs
;
360 const struct ref
*remote_head_points_at
;
361 const struct ref
*our_head_points_at
;
362 struct strbuf key
= STRBUF_INIT
, value
= STRBUF_INIT
;
363 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
364 struct transport
*transport
= NULL
;
365 char *src_ref_prefix
= "refs/heads/";
368 struct refspec
*refspec
;
369 const char *fetch_pattern
;
373 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
374 builtin_clone_usage
, 0);
377 die("You must specify a repository to clone.");
384 die("--bare and --origin %s options are incompatible.",
386 option_no_checkout
= 1;
390 option_origin
= "origin";
394 path
= get_repo_path(repo_name
, &is_bundle
);
396 repo
= xstrdup(make_nonrelative_path(repo_name
));
397 else if (!strchr(repo_name
, ':'))
398 repo
= xstrdup(make_absolute_path(repo_name
));
403 dir
= xstrdup(argv
[1]);
405 dir
= guess_dir_name(repo_name
, is_bundle
, option_bare
);
406 strip_trailing_slashes(dir
);
408 dest_exists
= !stat(dir
, &buf
);
409 if (dest_exists
&& !is_empty_dir(dir
))
410 die("destination path '%s' already exists and is not "
411 "an empty directory.", dir
);
413 strbuf_addf(&reflog_msg
, "clone: from %s", repo
);
418 work_tree
= getenv("GIT_WORK_TREE");
419 if (work_tree
&& !stat(work_tree
, &buf
))
420 die("working tree '%s' already exists.", work_tree
);
423 if (option_bare
|| work_tree
)
424 git_dir
= xstrdup(dir
);
427 git_dir
= xstrdup(mkpath("%s/.git", dir
));
431 junk_work_tree
= work_tree
;
432 if (safe_create_leading_directories_const(work_tree
) < 0)
433 die_errno("could not create leading directories of '%s'",
435 if (!dest_exists
&& mkdir(work_tree
, 0755))
436 die_errno("could not create work tree dir '%s'.",
438 set_git_work_tree(work_tree
);
440 junk_git_dir
= git_dir
;
442 sigchain_push_common(remove_junk_on_signal
);
444 setenv(CONFIG_ENVIRONMENT
, mkpath("%s/config", git_dir
), 1);
446 if (safe_create_leading_directories_const(git_dir
) < 0)
447 die("could not create leading directories of '%s'", git_dir
);
448 set_git_dir(make_absolute_path(git_dir
));
450 init_db(option_template
, option_quiet
? INIT_DB_QUIET
: 0);
453 * At this point, the config exists, so we do not need the
454 * environment variable. We actually need to unset it, too, to
455 * re-enable parsing of the global configs.
457 unsetenv(CONFIG_ENVIRONMENT
);
459 if (option_reference
)
460 setup_reference(git_dir
);
462 git_config(git_default_config
, NULL
);
466 src_ref_prefix
= "refs/";
467 strbuf_addstr(&branch_top
, src_ref_prefix
);
469 git_config_set("core.bare", "true");
471 strbuf_addf(&branch_top
, "refs/remotes/%s/", option_origin
);
474 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
.buf
);
476 if (option_mirror
|| !option_bare
) {
477 /* Configure the remote */
478 strbuf_addf(&key
, "remote.%s.fetch", option_origin
);
479 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
483 strbuf_addf(&key
, "remote.%s.mirror", option_origin
);
484 git_config_set(key
.buf
, "true");
488 strbuf_addf(&key
, "remote.%s.url", option_origin
);
489 git_config_set(key
.buf
, repo
);
493 fetch_pattern
= value
.buf
;
494 refspec
= parse_fetch_refspec(1, &fetch_pattern
);
496 strbuf_reset(&value
);
498 if (path
&& !is_bundle
)
499 refs
= clone_local(path
, git_dir
);
501 struct remote
*remote
= remote_get(argv
[0]);
502 transport
= transport_get(remote
, remote
->url
[0]);
504 if (!transport
->get_refs_list
|| !transport
->fetch
)
505 die("Don't know how to clone %s", transport
->url
);
507 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
510 transport_set_option(transport
, TRANS_OPT_DEPTH
,
514 transport
->verbose
= -1;
515 else if (option_verbose
)
516 transport
->progress
= 1;
518 if (option_upload_pack
)
519 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
522 refs
= transport_get_remote_refs(transport
);
524 transport_fetch_refs(transport
, refs
);
530 mapped_refs
= write_remote_refs(refs
, refspec
, reflog_msg
.buf
);
532 remote_head
= find_ref_by_name(refs
, "HEAD");
533 remote_head_points_at
=
534 guess_remote_head(remote_head
, mapped_refs
, 0);
537 struct strbuf head
= STRBUF_INIT
;
538 strbuf_addstr(&head
, src_ref_prefix
);
539 strbuf_addstr(&head
, option_branch
);
541 find_ref_by_name(mapped_refs
, head
.buf
);
542 strbuf_release(&head
);
544 if (!our_head_points_at
) {
545 warning("Remote branch %s not found in "
546 "upstream %s, using HEAD instead",
547 option_branch
, option_origin
);
548 our_head_points_at
= remote_head_points_at
;
552 our_head_points_at
= remote_head_points_at
;
555 warning("You appear to have cloned an empty repository.");
556 our_head_points_at
= NULL
;
557 remote_head_points_at
= NULL
;
559 option_no_checkout
= 1;
561 install_branch_config(0, "master", option_origin
,
562 "refs/heads/master");
565 if (remote_head_points_at
&& !option_bare
) {
566 struct strbuf head_ref
= STRBUF_INIT
;
567 strbuf_addstr(&head_ref
, branch_top
.buf
);
568 strbuf_addstr(&head_ref
, "HEAD");
569 create_symref(head_ref
.buf
,
570 remote_head_points_at
->peer_ref
->name
,
574 if (our_head_points_at
) {
575 /* Local default branch link */
576 create_symref("HEAD", our_head_points_at
->name
, NULL
);
578 const char *head
= skip_prefix(our_head_points_at
->name
,
580 update_ref(reflog_msg
.buf
, "HEAD",
581 our_head_points_at
->old_sha1
,
582 NULL
, 0, DIE_ON_ERR
);
583 install_branch_config(0, head
, option_origin
,
584 our_head_points_at
->name
);
586 } else if (remote_head
) {
587 /* Source had detached HEAD pointing somewhere. */
589 update_ref(reflog_msg
.buf
, "HEAD",
590 remote_head
->old_sha1
,
591 NULL
, REF_NODEREF
, DIE_ON_ERR
);
592 our_head_points_at
= remote_head
;
595 /* Nothing to checkout out */
596 if (!option_no_checkout
)
597 warning("remote HEAD refers to nonexistent ref, "
598 "unable to checkout.\n");
599 option_no_checkout
= 1;
603 transport_unlock_pack(transport
);
605 if (!option_no_checkout
) {
606 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
607 struct unpack_trees_options opts
;
612 /* We need to be in the new work tree for the checkout */
615 fd
= hold_locked_index(lock_file
, 1);
617 memset(&opts
, 0, sizeof opts
);
620 opts
.fn
= oneway_merge
;
621 opts
.verbose_update
= !option_quiet
;
622 opts
.src_index
= &the_index
;
623 opts
.dst_index
= &the_index
;
625 tree
= parse_tree_indirect(our_head_points_at
->old_sha1
);
627 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
628 unpack_trees(1, &t
, &opts
);
630 if (write_cache(fd
, active_cache
, active_nr
) ||
631 commit_locked_index(lock_file
))
632 die("unable to write new index file");
634 err
|= run_hook(NULL
, "post-checkout", sha1_to_hex(null_sha1
),
635 sha1_to_hex(remote_head
->old_sha1
), "1", NULL
);
637 if (!err
&& option_recursive
)
638 err
= run_command_v_opt(argv_submodule
, RUN_GIT_CMD
);
641 strbuf_release(&reflog_msg
);
642 strbuf_release(&branch_top
);
643 strbuf_release(&key
);
644 strbuf_release(&value
);