Merge branch 'mg/maint-submodule-normalize-path' into maint
[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  */
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  */
32 static const char * const builtin_clone_usage[] = {
33         "git clone [options] [--] <repo> [<dir>]",
34         NULL
35 };
36
37 static int option_quiet, option_no_checkout, option_bare, option_mirror;
38 static int option_local, option_no_hardlinks, option_shared;
39 static char *option_template, *option_reference, *option_depth;
40 static char *option_origin = NULL;
41 static char *option_upload_pack = "git-upload-pack";
42 static int option_verbose;
43
44 static 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
73 static 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
101 static 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
146 static 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
155 static 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
187 static 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
242 static 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
268 static const char *junk_work_tree;
269 static const char *junk_git_dir;
270 pid_t junk_pid;
271
272 static 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
289 static void remove_junk_on_signal(int signo)
290 {
291         remove_junk();
292         sigchain_pop(signo);
293         raise(signo);
294 }
295
296 static 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
333 static 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
353 static 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
366 int cmd_clone(int argc, const char **argv, const char *prefix)
367 {
368         int use_local_hardlinks = 1;
369         int use_separate_remote = 1;
370         int is_bundle = 0;
371         struct stat buf;
372         const char *repo_name, *repo, *work_tree, *git_dir;
373         char *path, *dir;
374         int dest_exists;
375         const struct ref *refs, *head_points_at, *remote_head, *mapped_refs;
376         struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
377         struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
378         struct transport *transport = NULL;
379         char *src_ref_prefix = "refs/heads/";
380
381         struct refspec refspec;
382
383         junk_pid = getpid();
384
385         argc = parse_options(argc, argv, builtin_clone_options,
386                              builtin_clone_usage, 0);
387
388         if (argc == 0)
389                 die("You must specify a repository to clone.");
390
391         if (option_no_hardlinks)
392                 use_local_hardlinks = 0;
393
394         if (option_mirror)
395                 option_bare = 1;
396
397         if (option_bare) {
398                 if (option_origin)
399                         die("--bare and --origin %s options are incompatible.",
400                             option_origin);
401                 option_no_checkout = 1;
402                 use_separate_remote = 0;
403         }
404
405         if (!option_origin)
406                 option_origin = "origin";
407
408         repo_name = argv[0];
409
410         path = get_repo_path(repo_name, &is_bundle);
411         if (path)
412                 repo = xstrdup(make_nonrelative_path(repo_name));
413         else if (!strchr(repo_name, ':'))
414                 repo = xstrdup(make_absolute_path(repo_name));
415         else
416                 repo = repo_name;
417
418         if (argc == 2)
419                 dir = xstrdup(argv[1]);
420         else
421                 dir = guess_dir_name(repo_name, is_bundle, option_bare);
422         strip_trailing_slashes(dir);
423
424         dest_exists = !stat(dir, &buf);
425         if (dest_exists && !is_empty_dir(dir))
426                 die("destination path '%s' already exists and is not "
427                         "an empty directory.", dir);
428
429         strbuf_addf(&reflog_msg, "clone: from %s", repo);
430
431         if (option_bare)
432                 work_tree = NULL;
433         else {
434                 work_tree = getenv("GIT_WORK_TREE");
435                 if (work_tree && !stat(work_tree, &buf))
436                         die("working tree '%s' already exists.", work_tree);
437         }
438
439         if (option_bare || work_tree)
440                 git_dir = xstrdup(dir);
441         else {
442                 work_tree = dir;
443                 git_dir = xstrdup(mkpath("%s/.git", dir));
444         }
445
446         if (!option_bare) {
447                 junk_work_tree = work_tree;
448                 if (safe_create_leading_directories_const(work_tree) < 0)
449                         die("could not create leading directories of '%s': %s",
450                                         work_tree, strerror(errno));
451                 if (!dest_exists && mkdir(work_tree, 0755))
452                         die("could not create work tree dir '%s': %s.",
453                                         work_tree, strerror(errno));
454                 set_git_work_tree(work_tree);
455         }
456         junk_git_dir = git_dir;
457         atexit(remove_junk);
458         sigchain_push_common(remove_junk_on_signal);
459
460         setenv(CONFIG_ENVIRONMENT, xstrdup(mkpath("%s/config", git_dir)), 1);
461
462         if (safe_create_leading_directories_const(git_dir) < 0)
463                 die("could not create leading directories of '%s'", git_dir);
464         set_git_dir(make_absolute_path(git_dir));
465
466         init_db(option_template, option_quiet ? INIT_DB_QUIET : 0);
467
468         /*
469          * At this point, the config exists, so we do not need the
470          * environment variable.  We actually need to unset it, too, to
471          * re-enable parsing of the global configs.
472          */
473         unsetenv(CONFIG_ENVIRONMENT);
474
475         if (option_reference)
476                 setup_reference(git_dir);
477
478         git_config(git_default_config, NULL);
479
480         if (option_bare) {
481                 if (option_mirror)
482                         src_ref_prefix = "refs/";
483                 strbuf_addstr(&branch_top, src_ref_prefix);
484
485                 git_config_set("core.bare", "true");
486         } else {
487                 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
488         }
489
490         if (option_mirror || !option_bare) {
491                 /* Configure the remote */
492                 if (option_mirror) {
493                         strbuf_addf(&key, "remote.%s.mirror", option_origin);
494                         git_config_set(key.buf, "true");
495                         strbuf_reset(&key);
496                 }
497
498                 strbuf_addf(&key, "remote.%s.url", option_origin);
499                 git_config_set(key.buf, repo);
500                         strbuf_reset(&key);
501
502                 strbuf_addf(&key, "remote.%s.fetch", option_origin);
503                 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
504                 git_config_set_multivar(key.buf, value.buf, "^$", 0);
505                 strbuf_reset(&key);
506                 strbuf_reset(&value);
507         }
508
509         refspec.force = 0;
510         refspec.pattern = 1;
511         refspec.src = src_ref_prefix;
512         refspec.dst = branch_top.buf;
513
514         if (path && !is_bundle)
515                 refs = clone_local(path, git_dir);
516         else {
517                 struct remote *remote = remote_get(argv[0]);
518                 transport = transport_get(remote, remote->url[0]);
519
520                 if (!transport->get_refs_list || !transport->fetch)
521                         die("Don't know how to clone %s", transport->url);
522
523                 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
524
525                 if (option_depth)
526                         transport_set_option(transport, TRANS_OPT_DEPTH,
527                                              option_depth);
528
529                 if (option_quiet)
530                         transport->verbose = -1;
531                 else if (option_verbose)
532                         transport->progress = 1;
533
534                 if (option_upload_pack)
535                         transport_set_option(transport, TRANS_OPT_UPLOADPACK,
536                                              option_upload_pack);
537
538                 refs = transport_get_remote_refs(transport);
539                 if(refs)
540                         transport_fetch_refs(transport, refs);
541         }
542
543         if (refs) {
544                 clear_extra_refs();
545
546                 mapped_refs = write_remote_refs(refs, &refspec, reflog_msg.buf);
547
548                 head_points_at = locate_head(refs, mapped_refs, &remote_head);
549         }
550         else {
551                 warning("You appear to have cloned an empty repository.");
552                 head_points_at = NULL;
553                 remote_head = NULL;
554                 option_no_checkout = 1;
555                 if (!option_bare)
556                         install_branch_config("master", option_origin,
557                                               "refs/heads/master");
558         }
559
560         if (head_points_at) {
561                 /* Local default branch link */
562                 create_symref("HEAD", head_points_at->name, NULL);
563
564                 if (!option_bare) {
565                         struct strbuf head_ref = STRBUF_INIT;
566                         const char *head = head_points_at->name;
567
568                         if (!prefixcmp(head, "refs/heads/"))
569                                 head += 11;
570
571                         /* Set up the initial local branch */
572
573                         /* Local branch initial value */
574                         update_ref(reflog_msg.buf, "HEAD",
575                                    head_points_at->old_sha1,
576                                    NULL, 0, DIE_ON_ERR);
577
578                         strbuf_addstr(&head_ref, branch_top.buf);
579                         strbuf_addstr(&head_ref, "HEAD");
580
581                         /* Remote branch link */
582                         create_symref(head_ref.buf,
583                                       head_points_at->peer_ref->name,
584                                       reflog_msg.buf);
585
586                         install_branch_config(head, option_origin,
587                                               head_points_at->name);
588                 }
589         } else if (remote_head) {
590                 /* Source had detached HEAD pointing somewhere. */
591                 if (!option_bare)
592                         update_ref(reflog_msg.buf, "HEAD",
593                                    remote_head->old_sha1,
594                                    NULL, REF_NODEREF, DIE_ON_ERR);
595         } else {
596                 /* Nothing to checkout out */
597                 if (!option_no_checkout)
598                         warning("remote HEAD refers to nonexistent ref, "
599                                 "unable to checkout.\n");
600                 option_no_checkout = 1;
601         }
602
603         if (transport)
604                 transport_unlock_pack(transport);
605
606         if (!option_no_checkout) {
607                 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
608                 struct unpack_trees_options opts;
609                 struct tree *tree;
610                 struct tree_desc t;
611                 int fd;
612
613                 /* We need to be in the new work tree for the checkout */
614                 setup_work_tree();
615
616                 fd = hold_locked_index(lock_file, 1);
617
618                 memset(&opts, 0, sizeof opts);
619                 opts.update = 1;
620                 opts.merge = 1;
621                 opts.fn = oneway_merge;
622                 opts.verbose_update = !option_quiet;
623                 opts.src_index = &the_index;
624                 opts.dst_index = &the_index;
625
626                 tree = parse_tree_indirect(remote_head->old_sha1);
627                 parse_tree(tree);
628                 init_tree_desc(&t, tree->buffer, tree->size);
629                 unpack_trees(1, &t, &opts);
630
631                 if (write_cache(fd, active_cache, active_nr) ||
632                     commit_locked_index(lock_file))
633                         die("unable to write new index file");
634         }
635
636         strbuf_release(&reflog_msg);
637         strbuf_release(&branch_top);
638         strbuf_release(&key);
639         strbuf_release(&value);
640         junk_pid = 0;
641         return 0;
642 }