Merge branch 'cb/credential-doc-fixes'
[git] / builtin / init-db.c
1 /*
2  * GIT - The information manager from hell
3  *
4  * Copyright (C) Linus Torvalds, 2005
5  */
6 #include "cache.h"
7 #include "config.h"
8 #include "refs.h"
9 #include "builtin.h"
10 #include "exec-cmd.h"
11 #include "parse-options.h"
12
13 #ifndef DEFAULT_GIT_TEMPLATE_DIR
14 #define DEFAULT_GIT_TEMPLATE_DIR "/usr/share/git-core/templates"
15 #endif
16
17 #ifdef NO_TRUSTABLE_FILEMODE
18 #define TEST_FILEMODE 0
19 #else
20 #define TEST_FILEMODE 1
21 #endif
22
23 #define GIT_DEFAULT_HASH_ENVIRONMENT "GIT_DEFAULT_HASH"
24
25 static int init_is_bare_repository = 0;
26 static int init_shared_repository = -1;
27 static const char *init_db_template_dir;
28
29 static void copy_templates_1(struct strbuf *path, struct strbuf *template_path,
30                              DIR *dir)
31 {
32         size_t path_baselen = path->len;
33         size_t template_baselen = template_path->len;
34         struct dirent *de;
35
36         /* Note: if ".git/hooks" file exists in the repository being
37          * re-initialized, /etc/core-git/templates/hooks/update would
38          * cause "git init" to fail here.  I think this is sane but
39          * it means that the set of templates we ship by default, along
40          * with the way the namespace under .git/ is organized, should
41          * be really carefully chosen.
42          */
43         safe_create_dir(path->buf, 1);
44         while ((de = readdir(dir)) != NULL) {
45                 struct stat st_git, st_template;
46                 int exists = 0;
47
48                 strbuf_setlen(path, path_baselen);
49                 strbuf_setlen(template_path, template_baselen);
50
51                 if (de->d_name[0] == '.')
52                         continue;
53                 strbuf_addstr(path, de->d_name);
54                 strbuf_addstr(template_path, de->d_name);
55                 if (lstat(path->buf, &st_git)) {
56                         if (errno != ENOENT)
57                                 die_errno(_("cannot stat '%s'"), path->buf);
58                 }
59                 else
60                         exists = 1;
61
62                 if (lstat(template_path->buf, &st_template))
63                         die_errno(_("cannot stat template '%s'"), template_path->buf);
64
65                 if (S_ISDIR(st_template.st_mode)) {
66                         DIR *subdir = opendir(template_path->buf);
67                         if (!subdir)
68                                 die_errno(_("cannot opendir '%s'"), template_path->buf);
69                         strbuf_addch(path, '/');
70                         strbuf_addch(template_path, '/');
71                         copy_templates_1(path, template_path, subdir);
72                         closedir(subdir);
73                 }
74                 else if (exists)
75                         continue;
76                 else if (S_ISLNK(st_template.st_mode)) {
77                         struct strbuf lnk = STRBUF_INIT;
78                         if (strbuf_readlink(&lnk, template_path->buf,
79                                             st_template.st_size) < 0)
80                                 die_errno(_("cannot readlink '%s'"), template_path->buf);
81                         if (symlink(lnk.buf, path->buf))
82                                 die_errno(_("cannot symlink '%s' '%s'"),
83                                           lnk.buf, path->buf);
84                         strbuf_release(&lnk);
85                 }
86                 else if (S_ISREG(st_template.st_mode)) {
87                         if (copy_file(path->buf, template_path->buf, st_template.st_mode))
88                                 die_errno(_("cannot copy '%s' to '%s'"),
89                                           template_path->buf, path->buf);
90                 }
91                 else
92                         error(_("ignoring template %s"), template_path->buf);
93         }
94 }
95
96 static void copy_templates(const char *template_dir)
97 {
98         struct strbuf path = STRBUF_INIT;
99         struct strbuf template_path = STRBUF_INIT;
100         size_t template_len;
101         struct repository_format template_format = REPOSITORY_FORMAT_INIT;
102         struct strbuf err = STRBUF_INIT;
103         DIR *dir;
104         char *to_free = NULL;
105
106         if (!template_dir)
107                 template_dir = getenv(TEMPLATE_DIR_ENVIRONMENT);
108         if (!template_dir)
109                 template_dir = init_db_template_dir;
110         if (!template_dir)
111                 template_dir = to_free = system_path(DEFAULT_GIT_TEMPLATE_DIR);
112         if (!template_dir[0]) {
113                 free(to_free);
114                 return;
115         }
116
117         strbuf_addstr(&template_path, template_dir);
118         strbuf_complete(&template_path, '/');
119         template_len = template_path.len;
120
121         dir = opendir(template_path.buf);
122         if (!dir) {
123                 warning(_("templates not found in %s"), template_dir);
124                 goto free_return;
125         }
126
127         /* Make sure that template is from the correct vintage */
128         strbuf_addstr(&template_path, "config");
129         read_repository_format(&template_format, template_path.buf);
130         strbuf_setlen(&template_path, template_len);
131
132         /*
133          * No mention of version at all is OK, but anything else should be
134          * verified.
135          */
136         if (template_format.version >= 0 &&
137             verify_repository_format(&template_format, &err) < 0) {
138                 warning(_("not copying templates from '%s': %s"),
139                           template_dir, err.buf);
140                 strbuf_release(&err);
141                 goto close_free_return;
142         }
143
144         strbuf_addstr(&path, get_git_common_dir());
145         strbuf_complete(&path, '/');
146         copy_templates_1(&path, &template_path, dir);
147 close_free_return:
148         closedir(dir);
149 free_return:
150         free(to_free);
151         strbuf_release(&path);
152         strbuf_release(&template_path);
153         clear_repository_format(&template_format);
154 }
155
156 static int git_init_db_config(const char *k, const char *v, void *cb)
157 {
158         if (!strcmp(k, "init.templatedir"))
159                 return git_config_pathname(&init_db_template_dir, k, v);
160
161         if (starts_with(k, "core."))
162                 return platform_core_config(k, v, cb);
163
164         return 0;
165 }
166
167 /*
168  * If the git_dir is not directly inside the working tree, then git will not
169  * find it by default, and we need to set the worktree explicitly.
170  */
171 static int needs_work_tree_config(const char *git_dir, const char *work_tree)
172 {
173         if (!strcmp(work_tree, "/") && !strcmp(git_dir, "/.git"))
174                 return 0;
175         if (skip_prefix(git_dir, work_tree, &git_dir) &&
176             !strcmp(git_dir, "/.git"))
177                 return 0;
178         return 1;
179 }
180
181 void initialize_repository_version(int hash_algo)
182 {
183         char repo_version_string[10];
184         int repo_version = GIT_REPO_VERSION;
185
186 #ifndef ENABLE_SHA256
187         if (hash_algo != GIT_HASH_SHA1)
188                 die(_("The hash algorithm %s is not supported in this build."), hash_algos[hash_algo].name);
189 #endif
190
191         if (hash_algo != GIT_HASH_SHA1)
192                 repo_version = GIT_REPO_VERSION_READ;
193
194         /* This forces creation of new config file */
195         xsnprintf(repo_version_string, sizeof(repo_version_string),
196                   "%d", repo_version);
197         git_config_set("core.repositoryformatversion", repo_version_string);
198
199         if (hash_algo != GIT_HASH_SHA1)
200                 git_config_set("extensions.objectformat",
201                                hash_algos[hash_algo].name);
202 }
203
204 static int create_default_files(const char *template_path,
205                                 const char *original_git_dir,
206                                 const struct repository_format *fmt)
207 {
208         struct stat st1;
209         struct strbuf buf = STRBUF_INIT;
210         char *path;
211         char junk[2];
212         int reinit;
213         int filemode;
214         struct strbuf err = STRBUF_INIT;
215
216         /* Just look for `init.templatedir` */
217         init_db_template_dir = NULL; /* re-set in case it was set before */
218         git_config(git_init_db_config, NULL);
219
220         /*
221          * First copy the templates -- we might have the default
222          * config file there, in which case we would want to read
223          * from it after installing.
224          *
225          * Before reading that config, we also need to clear out any cached
226          * values (since we've just potentially changed what's available on
227          * disk).
228          */
229         copy_templates(template_path);
230         git_config_clear();
231         reset_shared_repository();
232         git_config(git_default_config, NULL);
233
234         /*
235          * We must make sure command-line options continue to override any
236          * values we might have just re-read from the config.
237          */
238         is_bare_repository_cfg = init_is_bare_repository;
239         if (init_shared_repository != -1)
240                 set_shared_repository(init_shared_repository);
241
242         /*
243          * We would have created the above under user's umask -- under
244          * shared-repository settings, we would need to fix them up.
245          */
246         if (get_shared_repository()) {
247                 adjust_shared_perm(get_git_dir());
248         }
249
250         /*
251          * We need to create a "refs" dir in any case so that older
252          * versions of git can tell that this is a repository.
253          */
254         safe_create_dir(git_path("refs"), 1);
255         adjust_shared_perm(git_path("refs"));
256
257         if (refs_init_db(&err))
258                 die("failed to set up refs db: %s", err.buf);
259
260         /*
261          * Create the default symlink from ".git/HEAD" to the "master"
262          * branch, if it does not exist yet.
263          */
264         path = git_path_buf(&buf, "HEAD");
265         reinit = (!access(path, R_OK)
266                   || readlink(path, junk, sizeof(junk)-1) != -1);
267         if (!reinit) {
268                 if (create_symref("HEAD", "refs/heads/master", NULL) < 0)
269                         exit(1);
270         }
271
272         initialize_repository_version(fmt->hash_algo);
273
274         /* Check filemode trustability */
275         path = git_path_buf(&buf, "config");
276         filemode = TEST_FILEMODE;
277         if (TEST_FILEMODE && !lstat(path, &st1)) {
278                 struct stat st2;
279                 filemode = (!chmod(path, st1.st_mode ^ S_IXUSR) &&
280                                 !lstat(path, &st2) &&
281                                 st1.st_mode != st2.st_mode &&
282                                 !chmod(path, st1.st_mode));
283                 if (filemode && !reinit && (st1.st_mode & S_IXUSR))
284                         filemode = 0;
285         }
286         git_config_set("core.filemode", filemode ? "true" : "false");
287
288         if (is_bare_repository())
289                 git_config_set("core.bare", "true");
290         else {
291                 const char *work_tree = get_git_work_tree();
292                 git_config_set("core.bare", "false");
293                 /* allow template config file to override the default */
294                 if (log_all_ref_updates == LOG_REFS_UNSET)
295                         git_config_set("core.logallrefupdates", "true");
296                 if (needs_work_tree_config(original_git_dir, work_tree))
297                         git_config_set("core.worktree", work_tree);
298         }
299
300         if (!reinit) {
301                 /* Check if symlink is supported in the work tree */
302                 path = git_path_buf(&buf, "tXXXXXX");
303                 if (!close(xmkstemp(path)) &&
304                     !unlink(path) &&
305                     !symlink("testing", path) &&
306                     !lstat(path, &st1) &&
307                     S_ISLNK(st1.st_mode))
308                         unlink(path); /* good */
309                 else
310                         git_config_set("core.symlinks", "false");
311
312                 /* Check if the filesystem is case-insensitive */
313                 path = git_path_buf(&buf, "CoNfIg");
314                 if (!access(path, F_OK))
315                         git_config_set("core.ignorecase", "true");
316                 probe_utf8_pathname_composition();
317         }
318
319         strbuf_release(&buf);
320         return reinit;
321 }
322
323 static void create_object_directory(void)
324 {
325         struct strbuf path = STRBUF_INIT;
326         size_t baselen;
327
328         strbuf_addstr(&path, get_object_directory());
329         baselen = path.len;
330
331         safe_create_dir(path.buf, 1);
332
333         strbuf_setlen(&path, baselen);
334         strbuf_addstr(&path, "/pack");
335         safe_create_dir(path.buf, 1);
336
337         strbuf_setlen(&path, baselen);
338         strbuf_addstr(&path, "/info");
339         safe_create_dir(path.buf, 1);
340
341         strbuf_release(&path);
342 }
343
344 static void separate_git_dir(const char *git_dir, const char *git_link)
345 {
346         struct stat st;
347
348         if (!stat(git_link, &st)) {
349                 const char *src;
350
351                 if (S_ISREG(st.st_mode))
352                         src = read_gitfile(git_link);
353                 else if (S_ISDIR(st.st_mode))
354                         src = git_link;
355                 else
356                         die(_("unable to handle file type %d"), (int)st.st_mode);
357
358                 if (rename(src, git_dir))
359                         die_errno(_("unable to move %s to %s"), src, git_dir);
360         }
361
362         write_file(git_link, "gitdir: %s", git_dir);
363 }
364
365 static void validate_hash_algorithm(struct repository_format *repo_fmt, int hash)
366 {
367         const char *env = getenv(GIT_DEFAULT_HASH_ENVIRONMENT);
368         /*
369          * If we already have an initialized repo, don't allow the user to
370          * specify a different algorithm, as that could cause corruption.
371          * Otherwise, if the user has specified one on the command line, use it.
372          */
373         if (repo_fmt->version >= 0 && hash != GIT_HASH_UNKNOWN && hash != repo_fmt->hash_algo)
374                 die(_("attempt to reinitialize repository with different hash"));
375         else if (hash != GIT_HASH_UNKNOWN)
376                 repo_fmt->hash_algo = hash;
377         else if (env) {
378                 int env_algo = hash_algo_by_name(env);
379                 if (env_algo == GIT_HASH_UNKNOWN)
380                         die(_("unknown hash algorithm '%s'"), env);
381                 repo_fmt->hash_algo = env_algo;
382         }
383 }
384
385 int init_db(const char *git_dir, const char *real_git_dir,
386             const char *template_dir, int hash, unsigned int flags)
387 {
388         int reinit;
389         int exist_ok = flags & INIT_DB_EXIST_OK;
390         char *original_git_dir = real_pathdup(git_dir, 1);
391         struct repository_format repo_fmt = REPOSITORY_FORMAT_INIT;
392
393         if (real_git_dir) {
394                 struct stat st;
395
396                 if (!exist_ok && !stat(git_dir, &st))
397                         die(_("%s already exists"), git_dir);
398
399                 if (!exist_ok && !stat(real_git_dir, &st))
400                         die(_("%s already exists"), real_git_dir);
401
402                 set_git_dir(real_git_dir, 1);
403                 git_dir = get_git_dir();
404                 separate_git_dir(git_dir, original_git_dir);
405         }
406         else {
407                 set_git_dir(git_dir, 1);
408                 git_dir = get_git_dir();
409         }
410         startup_info->have_repository = 1;
411
412         /* Just look for `core.hidedotfiles` */
413         git_config(git_init_db_config, NULL);
414
415         safe_create_dir(git_dir, 0);
416
417         init_is_bare_repository = is_bare_repository();
418
419         /* Check to see if the repository version is right.
420          * Note that a newly created repository does not have
421          * config file, so this will not fail.  What we are catching
422          * is an attempt to reinitialize new repository with an old tool.
423          */
424         check_repository_format(&repo_fmt);
425
426         validate_hash_algorithm(&repo_fmt, hash);
427
428         reinit = create_default_files(template_dir, original_git_dir, &repo_fmt);
429
430         create_object_directory();
431
432         if (get_shared_repository()) {
433                 char buf[10];
434                 /* We do not spell "group" and such, so that
435                  * the configuration can be read by older version
436                  * of git. Note, we use octal numbers for new share modes,
437                  * and compatibility values for PERM_GROUP and
438                  * PERM_EVERYBODY.
439                  */
440                 if (get_shared_repository() < 0)
441                         /* force to the mode value */
442                         xsnprintf(buf, sizeof(buf), "0%o", -get_shared_repository());
443                 else if (get_shared_repository() == PERM_GROUP)
444                         xsnprintf(buf, sizeof(buf), "%d", OLD_PERM_GROUP);
445                 else if (get_shared_repository() == PERM_EVERYBODY)
446                         xsnprintf(buf, sizeof(buf), "%d", OLD_PERM_EVERYBODY);
447                 else
448                         BUG("invalid value for shared_repository");
449                 git_config_set("core.sharedrepository", buf);
450                 git_config_set("receive.denyNonFastforwards", "true");
451         }
452
453         if (!(flags & INIT_DB_QUIET)) {
454                 int len = strlen(git_dir);
455
456                 if (reinit)
457                         printf(get_shared_repository()
458                                ? _("Reinitialized existing shared Git repository in %s%s\n")
459                                : _("Reinitialized existing Git repository in %s%s\n"),
460                                git_dir, len && git_dir[len-1] != '/' ? "/" : "");
461                 else
462                         printf(get_shared_repository()
463                                ? _("Initialized empty shared Git repository in %s%s\n")
464                                : _("Initialized empty Git repository in %s%s\n"),
465                                git_dir, len && git_dir[len-1] != '/' ? "/" : "");
466         }
467
468         free(original_git_dir);
469         return 0;
470 }
471
472 static int guess_repository_type(const char *git_dir)
473 {
474         const char *slash;
475         char *cwd;
476         int cwd_is_git_dir;
477
478         /*
479          * "GIT_DIR=. git init" is always bare.
480          * "GIT_DIR=`pwd` git init" too.
481          */
482         if (!strcmp(".", git_dir))
483                 return 1;
484         cwd = xgetcwd();
485         cwd_is_git_dir = !strcmp(git_dir, cwd);
486         free(cwd);
487         if (cwd_is_git_dir)
488                 return 1;
489         /*
490          * "GIT_DIR=.git or GIT_DIR=something/.git is usually not.
491          */
492         if (!strcmp(git_dir, ".git"))
493                 return 0;
494         slash = strrchr(git_dir, '/');
495         if (slash && !strcmp(slash, "/.git"))
496                 return 0;
497
498         /*
499          * Otherwise it is often bare.  At this point
500          * we are just guessing.
501          */
502         return 1;
503 }
504
505 static int shared_callback(const struct option *opt, const char *arg, int unset)
506 {
507         BUG_ON_OPT_NEG(unset);
508         *((int *) opt->value) = (arg) ? git_config_perm("arg", arg) : PERM_GROUP;
509         return 0;
510 }
511
512 static const char *const init_db_usage[] = {
513         N_("git init [-q | --quiet] [--bare] [--template=<template-directory>] [--shared[=<permissions>]] [<directory>]"),
514         NULL
515 };
516
517 /*
518  * If you want to, you can share the DB area with any number of branches.
519  * That has advantages: you can save space by sharing all the SHA1 objects.
520  * On the other hand, it might just make lookup slower and messier. You
521  * be the judge.  The default case is to have one DB per managed directory.
522  */
523 int cmd_init_db(int argc, const char **argv, const char *prefix)
524 {
525         const char *git_dir;
526         const char *real_git_dir = NULL;
527         const char *work_tree;
528         const char *template_dir = NULL;
529         unsigned int flags = 0;
530         const char *object_format = NULL;
531         int hash_algo = GIT_HASH_UNKNOWN;
532         const struct option init_db_options[] = {
533                 OPT_STRING(0, "template", &template_dir, N_("template-directory"),
534                                 N_("directory from which templates will be used")),
535                 OPT_SET_INT(0, "bare", &is_bare_repository_cfg,
536                                 N_("create a bare repository"), 1),
537                 { OPTION_CALLBACK, 0, "shared", &init_shared_repository,
538                         N_("permissions"),
539                         N_("specify that the git repository is to be shared amongst several users"),
540                         PARSE_OPT_OPTARG | PARSE_OPT_NONEG, shared_callback, 0},
541                 OPT_BIT('q', "quiet", &flags, N_("be quiet"), INIT_DB_QUIET),
542                 OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
543                            N_("separate git dir from working tree")),
544                 OPT_STRING(0, "object-format", &object_format, N_("hash"),
545                            N_("specify the hash algorithm to use")),
546                 OPT_END()
547         };
548
549         argc = parse_options(argc, argv, prefix, init_db_options, init_db_usage, 0);
550
551         if (real_git_dir && !is_absolute_path(real_git_dir))
552                 real_git_dir = real_pathdup(real_git_dir, 1);
553
554         if (template_dir && *template_dir && !is_absolute_path(template_dir))
555                 template_dir = absolute_pathdup(template_dir);
556
557         if (argc == 1) {
558                 int mkdir_tried = 0;
559         retry:
560                 if (chdir(argv[0]) < 0) {
561                         if (!mkdir_tried) {
562                                 int saved;
563                                 /*
564                                  * At this point we haven't read any configuration,
565                                  * and we know shared_repository should always be 0;
566                                  * but just in case we play safe.
567                                  */
568                                 saved = get_shared_repository();
569                                 set_shared_repository(0);
570                                 switch (safe_create_leading_directories_const(argv[0])) {
571                                 case SCLD_OK:
572                                 case SCLD_PERMS:
573                                         break;
574                                 case SCLD_EXISTS:
575                                         errno = EEXIST;
576                                         /* fallthru */
577                                 default:
578                                         die_errno(_("cannot mkdir %s"), argv[0]);
579                                         break;
580                                 }
581                                 set_shared_repository(saved);
582                                 if (mkdir(argv[0], 0777) < 0)
583                                         die_errno(_("cannot mkdir %s"), argv[0]);
584                                 mkdir_tried = 1;
585                                 goto retry;
586                         }
587                         die_errno(_("cannot chdir to %s"), argv[0]);
588                 }
589         } else if (0 < argc) {
590                 usage(init_db_usage[0]);
591         }
592         if (is_bare_repository_cfg == 1) {
593                 char *cwd = xgetcwd();
594                 setenv(GIT_DIR_ENVIRONMENT, cwd, argc > 0);
595                 free(cwd);
596         }
597
598         if (object_format) {
599                 hash_algo = hash_algo_by_name(object_format);
600                 if (hash_algo == GIT_HASH_UNKNOWN)
601                         die(_("unknown hash algorithm '%s'"), object_format);
602         }
603
604         if (init_shared_repository != -1)
605                 set_shared_repository(init_shared_repository);
606
607         /*
608          * GIT_WORK_TREE makes sense only in conjunction with GIT_DIR
609          * without --bare.  Catch the error early.
610          */
611         git_dir = xstrdup_or_null(getenv(GIT_DIR_ENVIRONMENT));
612         work_tree = xstrdup_or_null(getenv(GIT_WORK_TREE_ENVIRONMENT));
613         if ((!git_dir || is_bare_repository_cfg == 1) && work_tree)
614                 die(_("%s (or --work-tree=<directory>) not allowed without "
615                           "specifying %s (or --git-dir=<directory>)"),
616                     GIT_WORK_TREE_ENVIRONMENT,
617                     GIT_DIR_ENVIRONMENT);
618
619         /*
620          * Set up the default .git directory contents
621          */
622         if (!git_dir)
623                 git_dir = DEFAULT_GIT_DIR_ENVIRONMENT;
624
625         if (is_bare_repository_cfg < 0)
626                 is_bare_repository_cfg = guess_repository_type(git_dir);
627
628         if (!is_bare_repository_cfg) {
629                 const char *git_dir_parent = strrchr(git_dir, '/');
630                 if (git_dir_parent) {
631                         char *rel = xstrndup(git_dir, git_dir_parent - git_dir);
632                         git_work_tree_cfg = real_pathdup(rel, 1);
633                         free(rel);
634                 }
635                 if (!git_work_tree_cfg)
636                         git_work_tree_cfg = xgetcwd();
637                 if (work_tree)
638                         set_git_work_tree(work_tree);
639                 else
640                         set_git_work_tree(git_work_tree_cfg);
641                 if (access(get_git_work_tree(), X_OK))
642                         die_errno (_("Cannot access work tree '%s'"),
643                                    get_git_work_tree());
644         }
645         else {
646                 if (work_tree)
647                         set_git_work_tree(work_tree);
648         }
649
650         UNLEAK(real_git_dir);
651         UNLEAK(git_dir);
652         UNLEAK(work_tree);
653
654         flags |= INIT_DB_EXIST_OK;
655         return init_db(git_dir, real_git_dir, template_dir, hash_algo, flags);
656 }