Code

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