gitweb: use new Git::Repo API, and add optional caching
[git/gitweb-caching.git] / builtin-clone.c
blobc0e3086437ced05d1b81d4098e3a4c7c3031b0ee
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"
24 * Overall FIXMEs:
25 * - respect DB_ENVIRONMENT for .git/objects.
27 * Implementation notes:
28 * - dropping use-separate-remote and no-separate-remote compatibility
31 static const char * const builtin_clone_usage[] = {
32 "git clone [options] [--] <repo> [<dir>]",
33 NULL
36 static int option_quiet, option_no_checkout, option_bare, option_mirror;
37 static int option_local, option_no_hardlinks, option_shared;
38 static char *option_template, *option_reference, *option_depth;
39 static char *option_origin = NULL;
40 static char *option_upload_pack = "git-upload-pack";
42 static struct option builtin_clone_options[] = {
43 OPT__QUIET(&option_quiet),
44 OPT_BOOLEAN('n', "no-checkout", &option_no_checkout,
45 "don't create a checkout"),
46 OPT_BOOLEAN(0, "bare", &option_bare, "create a bare repository"),
47 OPT_BOOLEAN(0, "naked", &option_bare, "create a bare repository"),
48 OPT_BOOLEAN(0, "mirror", &option_mirror,
49 "create a mirror repository (implies bare)"),
50 OPT_BOOLEAN('l', "local", &option_local,
51 "to clone from a local repository"),
52 OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks,
53 "don't use local hardlinks, always copy"),
54 OPT_BOOLEAN('s', "shared", &option_shared,
55 "setup as shared repository"),
56 OPT_STRING(0, "template", &option_template, "path",
57 "path the template repository"),
58 OPT_STRING(0, "reference", &option_reference, "repo",
59 "reference repository"),
60 OPT_STRING('o', "origin", &option_origin, "branch",
61 "use <branch> instead or 'origin' to track upstream"),
62 OPT_STRING('u', "upload-pack", &option_upload_pack, "path",
63 "path to git-upload-pack on the remote"),
64 OPT_STRING(0, "depth", &option_depth, "depth",
65 "create a shallow clone of that depth"),
67 OPT_END()
70 static char *get_repo_path(const char *repo, int *is_bundle)
72 static char *suffix[] = { "/.git", ".git", "" };
73 static char *bundle_suffix[] = { ".bundle", "" };
74 struct stat st;
75 int i;
77 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
78 const char *path;
79 path = mkpath("%s%s", repo, suffix[i]);
80 if (!stat(path, &st) && S_ISDIR(st.st_mode)) {
81 *is_bundle = 0;
82 return xstrdup(make_nonrelative_path(path));
86 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
87 const char *path;
88 path = mkpath("%s%s", repo, bundle_suffix[i]);
89 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
90 *is_bundle = 1;
91 return xstrdup(make_nonrelative_path(path));
95 return NULL;
98 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
100 const char *end = repo + strlen(repo), *start;
103 * Strip trailing slashes and /.git
105 while (repo < end && is_dir_sep(end[-1]))
106 end--;
107 if (end - repo > 5 && is_dir_sep(end[-5]) &&
108 !strncmp(end - 4, ".git", 4)) {
109 end -= 5;
110 while (repo < end && is_dir_sep(end[-1]))
111 end--;
115 * Find last component, but be prepared that repo could have
116 * the form "remote.example.com:foo.git", i.e. no slash
117 * in the directory part.
119 start = end;
120 while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
121 start--;
124 * Strip .{bundle,git}.
126 if (is_bundle) {
127 if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
128 end -= 7;
129 } else {
130 if (end - start > 4 && !strncmp(end - 4, ".git", 4))
131 end -= 4;
134 if (is_bare) {
135 char *result = xmalloc(end - start + 5);
136 sprintf(result, "%.*s.git", (int)(end - start), start);
137 return result;
140 return xstrndup(start, end - start);
143 static int is_directory(const char *path)
145 struct stat buf;
147 return !stat(path, &buf) && S_ISDIR(buf.st_mode);
150 static void setup_reference(const char *repo)
152 const char *ref_git;
153 char *ref_git_copy;
155 struct remote *remote;
156 struct transport *transport;
157 const struct ref *extra;
159 ref_git = make_absolute_path(option_reference);
161 if (is_directory(mkpath("%s/.git/objects", ref_git)))
162 ref_git = mkpath("%s/.git", ref_git);
163 else if (!is_directory(mkpath("%s/objects", ref_git)))
164 die("reference repository '%s' is not a local directory.",
165 option_reference);
167 ref_git_copy = xstrdup(ref_git);
169 add_to_alternates_file(ref_git_copy);
171 remote = remote_get(ref_git_copy);
172 transport = transport_get(remote, ref_git_copy);
173 for (extra = transport_get_remote_refs(transport); extra;
174 extra = extra->next)
175 add_extra_ref(extra->name, extra->old_sha1, 0);
177 transport_disconnect(transport);
179 free(ref_git_copy);
182 static void copy_or_link_directory(char *src, char *dest)
184 struct dirent *de;
185 struct stat buf;
186 int src_len, dest_len;
187 DIR *dir;
189 dir = opendir(src);
190 if (!dir)
191 die("failed to open %s\n", src);
193 if (mkdir(dest, 0777)) {
194 if (errno != EEXIST)
195 die("failed to create directory %s\n", dest);
196 else if (stat(dest, &buf))
197 die("failed to stat %s\n", dest);
198 else if (!S_ISDIR(buf.st_mode))
199 die("%s exists and is not a directory\n", dest);
202 src_len = strlen(src);
203 src[src_len] = '/';
204 dest_len = strlen(dest);
205 dest[dest_len] = '/';
207 while ((de = readdir(dir)) != NULL) {
208 strcpy(src + src_len + 1, de->d_name);
209 strcpy(dest + dest_len + 1, de->d_name);
210 if (stat(src, &buf)) {
211 warning ("failed to stat %s\n", src);
212 continue;
214 if (S_ISDIR(buf.st_mode)) {
215 if (de->d_name[0] != '.')
216 copy_or_link_directory(src, dest);
217 continue;
220 if (unlink(dest) && errno != ENOENT)
221 die("failed to unlink %s\n", dest);
222 if (!option_no_hardlinks) {
223 if (!link(src, dest))
224 continue;
225 if (option_local)
226 die("failed to create link %s\n", dest);
227 option_no_hardlinks = 1;
229 if (copy_file(dest, src, 0666))
230 die("failed to copy file to %s\n", dest);
232 closedir(dir);
235 static const struct ref *clone_local(const char *src_repo,
236 const char *dest_repo)
238 const struct ref *ret;
239 char src[PATH_MAX];
240 char dest[PATH_MAX];
241 struct remote *remote;
242 struct transport *transport;
244 if (option_shared)
245 add_to_alternates_file(src_repo);
246 else {
247 snprintf(src, PATH_MAX, "%s/objects", src_repo);
248 snprintf(dest, PATH_MAX, "%s/objects", dest_repo);
249 copy_or_link_directory(src, dest);
252 remote = remote_get(src_repo);
253 transport = transport_get(remote, src_repo);
254 ret = transport_get_remote_refs(transport);
255 transport_disconnect(transport);
256 return ret;
259 static const char *junk_work_tree;
260 static const char *junk_git_dir;
261 pid_t junk_pid;
263 static void remove_junk(void)
265 struct strbuf sb;
266 if (getpid() != junk_pid)
267 return;
268 strbuf_init(&sb, 0);
269 if (junk_git_dir) {
270 strbuf_addstr(&sb, junk_git_dir);
271 remove_dir_recursively(&sb, 0);
272 strbuf_reset(&sb);
274 if (junk_work_tree) {
275 strbuf_addstr(&sb, junk_work_tree);
276 remove_dir_recursively(&sb, 0);
277 strbuf_reset(&sb);
281 static void remove_junk_on_signal(int signo)
283 remove_junk();
284 signal(SIGINT, SIG_DFL);
285 raise(signo);
288 static const struct ref *locate_head(const struct ref *refs,
289 const struct ref *mapped_refs,
290 const struct ref **remote_head_p)
292 const struct ref *remote_head = NULL;
293 const struct ref *remote_master = NULL;
294 const struct ref *r;
295 for (r = refs; r; r = r->next)
296 if (!strcmp(r->name, "HEAD"))
297 remote_head = r;
299 for (r = mapped_refs; r; r = r->next)
300 if (!strcmp(r->name, "refs/heads/master"))
301 remote_master = r;
303 if (remote_head_p)
304 *remote_head_p = remote_head;
306 /* If there's no HEAD value at all, never mind. */
307 if (!remote_head)
308 return NULL;
310 /* If refs/heads/master could be right, it is. */
311 if (remote_master && !hashcmp(remote_master->old_sha1,
312 remote_head->old_sha1))
313 return remote_master;
315 /* Look for another ref that points there */
316 for (r = mapped_refs; r; r = r->next)
317 if (r != remote_head &&
318 !hashcmp(r->old_sha1, remote_head->old_sha1))
319 return r;
321 /* Nothing is the same */
322 return NULL;
325 static struct ref *write_remote_refs(const struct ref *refs,
326 struct refspec *refspec, const char *reflog)
328 struct ref *local_refs = NULL;
329 struct ref **tail = &local_refs;
330 struct ref *r;
332 get_fetch_map(refs, refspec, &tail, 0);
333 if (!option_mirror)
334 get_fetch_map(refs, tag_refspec, &tail, 0);
336 for (r = local_refs; r; r = r->next)
337 add_extra_ref(r->peer_ref->name, r->old_sha1, 0);
339 pack_refs(PACK_REFS_ALL);
340 clear_extra_refs();
342 return local_refs;
345 int cmd_clone(int argc, const char **argv, const char *prefix)
347 int use_local_hardlinks = 1;
348 int use_separate_remote = 1;
349 int is_bundle = 0;
350 struct stat buf;
351 const char *repo_name, *repo, *work_tree, *git_dir;
352 char *path, *dir;
353 const struct ref *refs, *head_points_at, *remote_head, *mapped_refs;
354 char branch_top[256], key[256], value[256];
355 struct strbuf reflog_msg;
356 struct transport *transport = NULL;
357 char *src_ref_prefix = "refs/heads/";
359 struct refspec refspec;
361 junk_pid = getpid();
363 argc = parse_options(argc, argv, builtin_clone_options,
364 builtin_clone_usage, 0);
366 if (argc == 0)
367 die("You must specify a repository to clone.");
369 if (option_no_hardlinks)
370 use_local_hardlinks = 0;
372 if (option_mirror)
373 option_bare = 1;
375 if (option_bare) {
376 if (option_origin)
377 die("--bare and --origin %s options are incompatible.",
378 option_origin);
379 option_no_checkout = 1;
380 use_separate_remote = 0;
383 if (!option_origin)
384 option_origin = "origin";
386 repo_name = argv[0];
388 path = get_repo_path(repo_name, &is_bundle);
389 if (path)
390 repo = path;
391 else if (!strchr(repo_name, ':'))
392 repo = xstrdup(make_absolute_path(repo_name));
393 else
394 repo = repo_name;
396 if (argc == 2)
397 dir = xstrdup(argv[1]);
398 else
399 dir = guess_dir_name(repo_name, is_bundle, option_bare);
401 if (!stat(dir, &buf))
402 die("destination directory '%s' already exists.", dir);
404 strbuf_init(&reflog_msg, 0);
405 strbuf_addf(&reflog_msg, "clone: from %s", repo);
407 if (option_bare)
408 work_tree = NULL;
409 else {
410 work_tree = getenv("GIT_WORK_TREE");
411 if (work_tree && !stat(work_tree, &buf))
412 die("working tree '%s' already exists.", work_tree);
415 if (option_bare || work_tree)
416 git_dir = xstrdup(dir);
417 else {
418 work_tree = dir;
419 git_dir = xstrdup(mkpath("%s/.git", dir));
422 if (!option_bare) {
423 junk_work_tree = work_tree;
424 if (safe_create_leading_directories_const(work_tree) < 0)
425 die("could not create leading directories of '%s'",
426 work_tree);
427 if (mkdir(work_tree, 0755))
428 die("could not create work tree dir '%s'.", work_tree);
429 set_git_work_tree(work_tree);
431 junk_git_dir = git_dir;
432 atexit(remove_junk);
433 signal(SIGINT, remove_junk_on_signal);
435 setenv(CONFIG_ENVIRONMENT, xstrdup(mkpath("%s/config", git_dir)), 1);
437 if (safe_create_leading_directories_const(git_dir) < 0)
438 die("could not create leading directories of '%s'", git_dir);
439 set_git_dir(make_absolute_path(git_dir));
441 init_db(option_template, option_quiet ? INIT_DB_QUIET : 0);
444 * At this point, the config exists, so we do not need the
445 * environment variable. We actually need to unset it, too, to
446 * re-enable parsing of the global configs.
448 unsetenv(CONFIG_ENVIRONMENT);
450 if (option_reference)
451 setup_reference(git_dir);
453 git_config(git_default_config, NULL);
455 if (option_bare) {
456 if (option_mirror)
457 src_ref_prefix = "refs/";
458 strcpy(branch_top, src_ref_prefix);
460 git_config_set("core.bare", "true");
461 } else {
462 snprintf(branch_top, sizeof(branch_top),
463 "refs/remotes/%s/", option_origin);
466 if (option_mirror || !option_bare) {
467 /* Configure the remote */
468 if (option_mirror) {
469 snprintf(key, sizeof(key),
470 "remote.%s.mirror", option_origin);
471 git_config_set(key, "true");
474 snprintf(key, sizeof(key), "remote.%s.url", option_origin);
475 git_config_set(key, repo);
477 snprintf(key, sizeof(key), "remote.%s.fetch", option_origin);
478 snprintf(value, sizeof(value),
479 "+%s*:%s*", src_ref_prefix, branch_top);
480 git_config_set_multivar(key, value, "^$", 0);
483 refspec.force = 0;
484 refspec.pattern = 1;
485 refspec.src = src_ref_prefix;
486 refspec.dst = branch_top;
488 if (path && !is_bundle)
489 refs = clone_local(path, git_dir);
490 else {
491 struct remote *remote = remote_get(argv[0]);
492 transport = transport_get(remote, remote->url[0]);
494 if (!transport->get_refs_list || !transport->fetch)
495 die("Don't know how to clone %s", transport->url);
497 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
499 if (option_depth)
500 transport_set_option(transport, TRANS_OPT_DEPTH,
501 option_depth);
503 if (option_quiet)
504 transport->verbose = -1;
506 if (option_upload_pack)
507 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
508 option_upload_pack);
510 refs = transport_get_remote_refs(transport);
511 transport_fetch_refs(transport, refs);
514 clear_extra_refs();
516 mapped_refs = write_remote_refs(refs, &refspec, reflog_msg.buf);
518 head_points_at = locate_head(refs, mapped_refs, &remote_head);
520 if (head_points_at) {
521 /* Local default branch link */
522 create_symref("HEAD", head_points_at->name, NULL);
524 if (!option_bare) {
525 struct strbuf head_ref;
526 const char *head = head_points_at->name;
528 if (!prefixcmp(head, "refs/heads/"))
529 head += 11;
531 /* Set up the initial local branch */
533 /* Local branch initial value */
534 update_ref(reflog_msg.buf, "HEAD",
535 head_points_at->old_sha1,
536 NULL, 0, DIE_ON_ERR);
538 strbuf_init(&head_ref, 0);
539 strbuf_addstr(&head_ref, branch_top);
540 strbuf_addstr(&head_ref, "HEAD");
542 /* Remote branch link */
543 create_symref(head_ref.buf,
544 head_points_at->peer_ref->name,
545 reflog_msg.buf);
547 snprintf(key, sizeof(key), "branch.%s.remote", head);
548 git_config_set(key, option_origin);
549 snprintf(key, sizeof(key), "branch.%s.merge", head);
550 git_config_set(key, head_points_at->name);
552 } else if (remote_head) {
553 /* Source had detached HEAD pointing somewhere. */
554 if (!option_bare)
555 update_ref(reflog_msg.buf, "HEAD",
556 remote_head->old_sha1,
557 NULL, REF_NODEREF, DIE_ON_ERR);
558 } else {
559 /* Nothing to checkout out */
560 if (!option_no_checkout)
561 warning("remote HEAD refers to nonexistent ref, "
562 "unable to checkout.\n");
563 option_no_checkout = 1;
566 if (transport)
567 transport_unlock_pack(transport);
569 if (!option_no_checkout) {
570 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
571 struct unpack_trees_options opts;
572 struct tree *tree;
573 struct tree_desc t;
574 int fd;
576 /* We need to be in the new work tree for the checkout */
577 setup_work_tree();
579 fd = hold_locked_index(lock_file, 1);
581 memset(&opts, 0, sizeof opts);
582 opts.update = 1;
583 opts.merge = 1;
584 opts.fn = oneway_merge;
585 opts.verbose_update = !option_quiet;
586 opts.src_index = &the_index;
587 opts.dst_index = &the_index;
589 tree = parse_tree_indirect(remote_head->old_sha1);
590 parse_tree(tree);
591 init_tree_desc(&t, tree->buffer, tree->size);
592 unpack_trees(1, &t, &opts);
594 if (write_cache(fd, active_cache, active_nr) ||
595 commit_locked_index(lock_file))
596 die("unable to write new index file");
599 strbuf_release(&reflog_msg);
600 junk_pid = 0;
601 return 0;