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