config.txt: move remotes.* to a separate file
[git] / path.c
1 /*
2  * Utilities for paths and pathnames
3  */
4 #include "cache.h"
5 #include "repository.h"
6 #include "strbuf.h"
7 #include "string-list.h"
8 #include "dir.h"
9 #include "worktree.h"
10 #include "submodule-config.h"
11 #include "path.h"
12 #include "packfile.h"
13 #include "object-store.h"
14
15 static int get_st_mode_bits(const char *path, int *mode)
16 {
17         struct stat st;
18         if (lstat(path, &st) < 0)
19                 return -1;
20         *mode = st.st_mode;
21         return 0;
22 }
23
24 static char bad_path[] = "/bad-path/";
25
26 static struct strbuf *get_pathname(void)
27 {
28         static struct strbuf pathname_array[4] = {
29                 STRBUF_INIT, STRBUF_INIT, STRBUF_INIT, STRBUF_INIT
30         };
31         static int index;
32         struct strbuf *sb = &pathname_array[index];
33         index = (index + 1) % ARRAY_SIZE(pathname_array);
34         strbuf_reset(sb);
35         return sb;
36 }
37
38 static const char *cleanup_path(const char *path)
39 {
40         /* Clean it up */
41         if (skip_prefix(path, "./", &path)) {
42                 while (*path == '/')
43                         path++;
44         }
45         return path;
46 }
47
48 static void strbuf_cleanup_path(struct strbuf *sb)
49 {
50         const char *path = cleanup_path(sb->buf);
51         if (path > sb->buf)
52                 strbuf_remove(sb, 0, path - sb->buf);
53 }
54
55 char *mksnpath(char *buf, size_t n, const char *fmt, ...)
56 {
57         va_list args;
58         unsigned len;
59
60         va_start(args, fmt);
61         len = vsnprintf(buf, n, fmt, args);
62         va_end(args);
63         if (len >= n) {
64                 strlcpy(buf, bad_path, n);
65                 return buf;
66         }
67         return (char *)cleanup_path(buf);
68 }
69
70 static int dir_prefix(const char *buf, const char *dir)
71 {
72         int len = strlen(dir);
73         return !strncmp(buf, dir, len) &&
74                 (is_dir_sep(buf[len]) || buf[len] == '\0');
75 }
76
77 /* $buf =~ m|$dir/+$file| but without regex */
78 static int is_dir_file(const char *buf, const char *dir, const char *file)
79 {
80         int len = strlen(dir);
81         if (strncmp(buf, dir, len) || !is_dir_sep(buf[len]))
82                 return 0;
83         while (is_dir_sep(buf[len]))
84                 len++;
85         return !strcmp(buf + len, file);
86 }
87
88 static void replace_dir(struct strbuf *buf, int len, const char *newdir)
89 {
90         int newlen = strlen(newdir);
91         int need_sep = (buf->buf[len] && !is_dir_sep(buf->buf[len])) &&
92                 !is_dir_sep(newdir[newlen - 1]);
93         if (need_sep)
94                 len--;   /* keep one char, to be replaced with '/'  */
95         strbuf_splice(buf, 0, len, newdir, newlen);
96         if (need_sep)
97                 buf->buf[newlen] = '/';
98 }
99
100 struct common_dir {
101         /* Not considered garbage for report_linked_checkout_garbage */
102         unsigned ignore_garbage:1;
103         unsigned is_dir:1;
104         /* Not common even though its parent is */
105         unsigned exclude:1;
106         const char *dirname;
107 };
108
109 static struct common_dir common_list[] = {
110         { 0, 1, 0, "branches" },
111         { 0, 1, 0, "hooks" },
112         { 0, 1, 0, "info" },
113         { 0, 0, 1, "info/sparse-checkout" },
114         { 1, 1, 0, "logs" },
115         { 1, 1, 1, "logs/HEAD" },
116         { 0, 1, 1, "logs/refs/bisect" },
117         { 0, 1, 0, "lost-found" },
118         { 0, 1, 0, "objects" },
119         { 0, 1, 0, "refs" },
120         { 0, 1, 1, "refs/bisect" },
121         { 0, 1, 0, "remotes" },
122         { 0, 1, 0, "worktrees" },
123         { 0, 1, 0, "rr-cache" },
124         { 0, 1, 0, "svn" },
125         { 0, 0, 0, "config" },
126         { 1, 0, 0, "gc.pid" },
127         { 0, 0, 0, "packed-refs" },
128         { 0, 0, 0, "shallow" },
129         { 0, 0, 0, NULL }
130 };
131
132 /*
133  * A compressed trie.  A trie node consists of zero or more characters that
134  * are common to all elements with this prefix, optionally followed by some
135  * children.  If value is not NULL, the trie node is a terminal node.
136  *
137  * For example, consider the following set of strings:
138  * abc
139  * def
140  * definite
141  * definition
142  *
143  * The trie would look like:
144  * root: len = 0, children a and d non-NULL, value = NULL.
145  *    a: len = 2, contents = bc, value = (data for "abc")
146  *    d: len = 2, contents = ef, children i non-NULL, value = (data for "def")
147  *       i: len = 3, contents = nit, children e and i non-NULL, value = NULL
148  *           e: len = 0, children all NULL, value = (data for "definite")
149  *           i: len = 2, contents = on, children all NULL,
150  *              value = (data for "definition")
151  */
152 struct trie {
153         struct trie *children[256];
154         int len;
155         char *contents;
156         void *value;
157 };
158
159 static struct trie *make_trie_node(const char *key, void *value)
160 {
161         struct trie *new_node = xcalloc(1, sizeof(*new_node));
162         new_node->len = strlen(key);
163         if (new_node->len) {
164                 new_node->contents = xmalloc(new_node->len);
165                 memcpy(new_node->contents, key, new_node->len);
166         }
167         new_node->value = value;
168         return new_node;
169 }
170
171 /*
172  * Add a key/value pair to a trie.  The key is assumed to be \0-terminated.
173  * If there was an existing value for this key, return it.
174  */
175 static void *add_to_trie(struct trie *root, const char *key, void *value)
176 {
177         struct trie *child;
178         void *old;
179         int i;
180
181         if (!*key) {
182                 /* we have reached the end of the key */
183                 old = root->value;
184                 root->value = value;
185                 return old;
186         }
187
188         for (i = 0; i < root->len; i++) {
189                 if (root->contents[i] == key[i])
190                         continue;
191
192                 /*
193                  * Split this node: child will contain this node's
194                  * existing children.
195                  */
196                 child = xmalloc(sizeof(*child));
197                 memcpy(child->children, root->children, sizeof(root->children));
198
199                 child->len = root->len - i - 1;
200                 if (child->len) {
201                         child->contents = xstrndup(root->contents + i + 1,
202                                                    child->len);
203                 }
204                 child->value = root->value;
205                 root->value = NULL;
206                 root->len = i;
207
208                 memset(root->children, 0, sizeof(root->children));
209                 root->children[(unsigned char)root->contents[i]] = child;
210
211                 /* This is the newly-added child. */
212                 root->children[(unsigned char)key[i]] =
213                         make_trie_node(key + i + 1, value);
214                 return NULL;
215         }
216
217         /* We have matched the entire compressed section */
218         if (key[i]) {
219                 child = root->children[(unsigned char)key[root->len]];
220                 if (child) {
221                         return add_to_trie(child, key + root->len + 1, value);
222                 } else {
223                         child = make_trie_node(key + root->len + 1, value);
224                         root->children[(unsigned char)key[root->len]] = child;
225                         return NULL;
226                 }
227         }
228
229         old = root->value;
230         root->value = value;
231         return old;
232 }
233
234 typedef int (*match_fn)(const char *unmatched, void *data, void *baton);
235
236 /*
237  * Search a trie for some key.  Find the longest /-or-\0-terminated
238  * prefix of the key for which the trie contains a value.  Call fn
239  * with the unmatched portion of the key and the found value, and
240  * return its return value.  If there is no such prefix, return -1.
241  *
242  * The key is partially normalized: consecutive slashes are skipped.
243  *
244  * For example, consider the trie containing only [refs,
245  * refs/worktree] (both with values).
246  *
247  * | key             | unmatched  | val from node | return value |
248  * |-----------------|------------|---------------|--------------|
249  * | a               | not called | n/a           | -1           |
250  * | refs            | \0         | refs          | as per fn    |
251  * | refs/           | /          | refs          | as per fn    |
252  * | refs/w          | /w         | refs          | as per fn    |
253  * | refs/worktree   | \0         | refs/worktree | as per fn    |
254  * | refs/worktree/  | /          | refs/worktree | as per fn    |
255  * | refs/worktree/a | /a         | refs/worktree | as per fn    |
256  * |-----------------|------------|---------------|--------------|
257  *
258  */
259 static int trie_find(struct trie *root, const char *key, match_fn fn,
260                      void *baton)
261 {
262         int i;
263         int result;
264         struct trie *child;
265
266         if (!*key) {
267                 /* we have reached the end of the key */
268                 if (root->value && !root->len)
269                         return fn(key, root->value, baton);
270                 else
271                         return -1;
272         }
273
274         for (i = 0; i < root->len; i++) {
275                 /* Partial path normalization: skip consecutive slashes. */
276                 if (key[i] == '/' && key[i+1] == '/') {
277                         key++;
278                         continue;
279                 }
280                 if (root->contents[i] != key[i])
281                         return -1;
282         }
283
284         /* Matched the entire compressed section */
285         key += i;
286         if (!*key)
287                 /* End of key */
288                 return fn(key, root->value, baton);
289
290         /* Partial path normalization: skip consecutive slashes */
291         while (key[0] == '/' && key[1] == '/')
292                 key++;
293
294         child = root->children[(unsigned char)*key];
295         if (child)
296                 result = trie_find(child, key + 1, fn, baton);
297         else
298                 result = -1;
299
300         if (result >= 0 || (*key != '/' && *key != 0))
301                 return result;
302         if (root->value)
303                 return fn(key, root->value, baton);
304         else
305                 return -1;
306 }
307
308 static struct trie common_trie;
309 static int common_trie_done_setup;
310
311 static void init_common_trie(void)
312 {
313         struct common_dir *p;
314
315         if (common_trie_done_setup)
316                 return;
317
318         for (p = common_list; p->dirname; p++)
319                 add_to_trie(&common_trie, p->dirname, p);
320
321         common_trie_done_setup = 1;
322 }
323
324 /*
325  * Helper function for update_common_dir: returns 1 if the dir
326  * prefix is common.
327  */
328 static int check_common(const char *unmatched, void *value, void *baton)
329 {
330         struct common_dir *dir = value;
331
332         if (!dir)
333                 return 0;
334
335         if (dir->is_dir && (unmatched[0] == 0 || unmatched[0] == '/'))
336                 return !dir->exclude;
337
338         if (!dir->is_dir && unmatched[0] == 0)
339                 return !dir->exclude;
340
341         return 0;
342 }
343
344 static void update_common_dir(struct strbuf *buf, int git_dir_len,
345                               const char *common_dir)
346 {
347         char *base = buf->buf + git_dir_len;
348         init_common_trie();
349         if (trie_find(&common_trie, base, check_common, NULL) > 0)
350                 replace_dir(buf, git_dir_len, common_dir);
351 }
352
353 void report_linked_checkout_garbage(void)
354 {
355         struct strbuf sb = STRBUF_INIT;
356         const struct common_dir *p;
357         int len;
358
359         if (!the_repository->different_commondir)
360                 return;
361         strbuf_addf(&sb, "%s/", get_git_dir());
362         len = sb.len;
363         for (p = common_list; p->dirname; p++) {
364                 const char *path = p->dirname;
365                 if (p->ignore_garbage)
366                         continue;
367                 strbuf_setlen(&sb, len);
368                 strbuf_addstr(&sb, path);
369                 if (file_exists(sb.buf))
370                         report_garbage(PACKDIR_FILE_GARBAGE, sb.buf);
371         }
372         strbuf_release(&sb);
373 }
374
375 static void adjust_git_path(const struct repository *repo,
376                             struct strbuf *buf, int git_dir_len)
377 {
378         const char *base = buf->buf + git_dir_len;
379         if (is_dir_file(base, "info", "grafts"))
380                 strbuf_splice(buf, 0, buf->len,
381                               repo->graft_file, strlen(repo->graft_file));
382         else if (!strcmp(base, "index"))
383                 strbuf_splice(buf, 0, buf->len,
384                               repo->index_file, strlen(repo->index_file));
385         else if (dir_prefix(base, "objects"))
386                 replace_dir(buf, git_dir_len + 7, repo->objects->objectdir);
387         else if (git_hooks_path && dir_prefix(base, "hooks"))
388                 replace_dir(buf, git_dir_len + 5, git_hooks_path);
389         else if (repo->different_commondir)
390                 update_common_dir(buf, git_dir_len, repo->commondir);
391 }
392
393 static void strbuf_worktree_gitdir(struct strbuf *buf,
394                                    const struct repository *repo,
395                                    const struct worktree *wt)
396 {
397         if (!wt)
398                 strbuf_addstr(buf, repo->gitdir);
399         else if (!wt->id)
400                 strbuf_addstr(buf, repo->commondir);
401         else
402                 strbuf_git_common_path(buf, repo, "worktrees/%s", wt->id);
403 }
404
405 static void do_git_path(const struct repository *repo,
406                         const struct worktree *wt, struct strbuf *buf,
407                         const char *fmt, va_list args)
408 {
409         int gitdir_len;
410         strbuf_worktree_gitdir(buf, repo, wt);
411         if (buf->len && !is_dir_sep(buf->buf[buf->len - 1]))
412                 strbuf_addch(buf, '/');
413         gitdir_len = buf->len;
414         strbuf_vaddf(buf, fmt, args);
415         if (!wt)
416                 adjust_git_path(repo, buf, gitdir_len);
417         strbuf_cleanup_path(buf);
418 }
419
420 char *repo_git_path(const struct repository *repo,
421                     const char *fmt, ...)
422 {
423         struct strbuf path = STRBUF_INIT;
424         va_list args;
425         va_start(args, fmt);
426         do_git_path(repo, NULL, &path, fmt, args);
427         va_end(args);
428         return strbuf_detach(&path, NULL);
429 }
430
431 void strbuf_repo_git_path(struct strbuf *sb,
432                           const struct repository *repo,
433                           const char *fmt, ...)
434 {
435         va_list args;
436         va_start(args, fmt);
437         do_git_path(repo, NULL, sb, fmt, args);
438         va_end(args);
439 }
440
441 char *git_path_buf(struct strbuf *buf, const char *fmt, ...)
442 {
443         va_list args;
444         strbuf_reset(buf);
445         va_start(args, fmt);
446         do_git_path(the_repository, NULL, buf, fmt, args);
447         va_end(args);
448         return buf->buf;
449 }
450
451 void strbuf_git_path(struct strbuf *sb, const char *fmt, ...)
452 {
453         va_list args;
454         va_start(args, fmt);
455         do_git_path(the_repository, NULL, sb, fmt, args);
456         va_end(args);
457 }
458
459 const char *git_path(const char *fmt, ...)
460 {
461         struct strbuf *pathname = get_pathname();
462         va_list args;
463         va_start(args, fmt);
464         do_git_path(the_repository, NULL, pathname, fmt, args);
465         va_end(args);
466         return pathname->buf;
467 }
468
469 char *git_pathdup(const char *fmt, ...)
470 {
471         struct strbuf path = STRBUF_INIT;
472         va_list args;
473         va_start(args, fmt);
474         do_git_path(the_repository, NULL, &path, fmt, args);
475         va_end(args);
476         return strbuf_detach(&path, NULL);
477 }
478
479 char *mkpathdup(const char *fmt, ...)
480 {
481         struct strbuf sb = STRBUF_INIT;
482         va_list args;
483         va_start(args, fmt);
484         strbuf_vaddf(&sb, fmt, args);
485         va_end(args);
486         strbuf_cleanup_path(&sb);
487         return strbuf_detach(&sb, NULL);
488 }
489
490 const char *mkpath(const char *fmt, ...)
491 {
492         va_list args;
493         struct strbuf *pathname = get_pathname();
494         va_start(args, fmt);
495         strbuf_vaddf(pathname, fmt, args);
496         va_end(args);
497         return cleanup_path(pathname->buf);
498 }
499
500 const char *worktree_git_path(const struct worktree *wt, const char *fmt, ...)
501 {
502         struct strbuf *pathname = get_pathname();
503         va_list args;
504         va_start(args, fmt);
505         do_git_path(the_repository, wt, pathname, fmt, args);
506         va_end(args);
507         return pathname->buf;
508 }
509
510 static void do_worktree_path(const struct repository *repo,
511                              struct strbuf *buf,
512                              const char *fmt, va_list args)
513 {
514         strbuf_addstr(buf, repo->worktree);
515         if(buf->len && !is_dir_sep(buf->buf[buf->len - 1]))
516                 strbuf_addch(buf, '/');
517
518         strbuf_vaddf(buf, fmt, args);
519         strbuf_cleanup_path(buf);
520 }
521
522 char *repo_worktree_path(const struct repository *repo, const char *fmt, ...)
523 {
524         struct strbuf path = STRBUF_INIT;
525         va_list args;
526
527         if (!repo->worktree)
528                 return NULL;
529
530         va_start(args, fmt);
531         do_worktree_path(repo, &path, fmt, args);
532         va_end(args);
533
534         return strbuf_detach(&path, NULL);
535 }
536
537 void strbuf_repo_worktree_path(struct strbuf *sb,
538                                const struct repository *repo,
539                                const char *fmt, ...)
540 {
541         va_list args;
542
543         if (!repo->worktree)
544                 return;
545
546         va_start(args, fmt);
547         do_worktree_path(repo, sb, fmt, args);
548         va_end(args);
549 }
550
551 /* Returns 0 on success, negative on failure. */
552 static int do_submodule_path(struct strbuf *buf, const char *path,
553                              const char *fmt, va_list args)
554 {
555         struct strbuf git_submodule_common_dir = STRBUF_INIT;
556         struct strbuf git_submodule_dir = STRBUF_INIT;
557         int ret;
558
559         ret = submodule_to_gitdir(&git_submodule_dir, path);
560         if (ret)
561                 goto cleanup;
562
563         strbuf_complete(&git_submodule_dir, '/');
564         strbuf_addbuf(buf, &git_submodule_dir);
565         strbuf_vaddf(buf, fmt, args);
566
567         if (get_common_dir_noenv(&git_submodule_common_dir, git_submodule_dir.buf))
568                 update_common_dir(buf, git_submodule_dir.len, git_submodule_common_dir.buf);
569
570         strbuf_cleanup_path(buf);
571
572 cleanup:
573         strbuf_release(&git_submodule_dir);
574         strbuf_release(&git_submodule_common_dir);
575         return ret;
576 }
577
578 char *git_pathdup_submodule(const char *path, const char *fmt, ...)
579 {
580         int err;
581         va_list args;
582         struct strbuf buf = STRBUF_INIT;
583         va_start(args, fmt);
584         err = do_submodule_path(&buf, path, fmt, args);
585         va_end(args);
586         if (err) {
587                 strbuf_release(&buf);
588                 return NULL;
589         }
590         return strbuf_detach(&buf, NULL);
591 }
592
593 int strbuf_git_path_submodule(struct strbuf *buf, const char *path,
594                               const char *fmt, ...)
595 {
596         int err;
597         va_list args;
598         va_start(args, fmt);
599         err = do_submodule_path(buf, path, fmt, args);
600         va_end(args);
601
602         return err;
603 }
604
605 static void do_git_common_path(const struct repository *repo,
606                                struct strbuf *buf,
607                                const char *fmt,
608                                va_list args)
609 {
610         strbuf_addstr(buf, repo->commondir);
611         if (buf->len && !is_dir_sep(buf->buf[buf->len - 1]))
612                 strbuf_addch(buf, '/');
613         strbuf_vaddf(buf, fmt, args);
614         strbuf_cleanup_path(buf);
615 }
616
617 const char *git_common_path(const char *fmt, ...)
618 {
619         struct strbuf *pathname = get_pathname();
620         va_list args;
621         va_start(args, fmt);
622         do_git_common_path(the_repository, pathname, fmt, args);
623         va_end(args);
624         return pathname->buf;
625 }
626
627 void strbuf_git_common_path(struct strbuf *sb,
628                             const struct repository *repo,
629                             const char *fmt, ...)
630 {
631         va_list args;
632         va_start(args, fmt);
633         do_git_common_path(repo, sb, fmt, args);
634         va_end(args);
635 }
636
637 int validate_headref(const char *path)
638 {
639         struct stat st;
640         char buffer[256];
641         const char *refname;
642         struct object_id oid;
643         int fd;
644         ssize_t len;
645
646         if (lstat(path, &st) < 0)
647                 return -1;
648
649         /* Make sure it is a "refs/.." symlink */
650         if (S_ISLNK(st.st_mode)) {
651                 len = readlink(path, buffer, sizeof(buffer)-1);
652                 if (len >= 5 && !memcmp("refs/", buffer, 5))
653                         return 0;
654                 return -1;
655         }
656
657         /*
658          * Anything else, just open it and try to see if it is a symbolic ref.
659          */
660         fd = open(path, O_RDONLY);
661         if (fd < 0)
662                 return -1;
663         len = read_in_full(fd, buffer, sizeof(buffer)-1);
664         close(fd);
665
666         if (len < 0)
667                 return -1;
668         buffer[len] = '\0';
669
670         /*
671          * Is it a symbolic ref?
672          */
673         if (skip_prefix(buffer, "ref:", &refname)) {
674                 while (isspace(*refname))
675                         refname++;
676                 if (starts_with(refname, "refs/"))
677                         return 0;
678         }
679
680         /*
681          * Is this a detached HEAD?
682          */
683         if (!get_oid_hex(buffer, &oid))
684                 return 0;
685
686         return -1;
687 }
688
689 static struct passwd *getpw_str(const char *username, size_t len)
690 {
691         struct passwd *pw;
692         char *username_z = xmemdupz(username, len);
693         pw = getpwnam(username_z);
694         free(username_z);
695         return pw;
696 }
697
698 /*
699  * Return a string with ~ and ~user expanded via getpw*.  If buf != NULL,
700  * then it is a newly allocated string. Returns NULL on getpw failure or
701  * if path is NULL.
702  *
703  * If real_home is true, real_path($HOME) is used in the expansion.
704  */
705 char *expand_user_path(const char *path, int real_home)
706 {
707         struct strbuf user_path = STRBUF_INIT;
708         const char *to_copy = path;
709
710         if (path == NULL)
711                 goto return_null;
712         if (path[0] == '~') {
713                 const char *first_slash = strchrnul(path, '/');
714                 const char *username = path + 1;
715                 size_t username_len = first_slash - username;
716                 if (username_len == 0) {
717                         const char *home = getenv("HOME");
718                         if (!home)
719                                 goto return_null;
720                         if (real_home)
721                                 strbuf_add_real_path(&user_path, home);
722                         else
723                                 strbuf_addstr(&user_path, home);
724 #ifdef GIT_WINDOWS_NATIVE
725                         convert_slashes(user_path.buf);
726 #endif
727                 } else {
728                         struct passwd *pw = getpw_str(username, username_len);
729                         if (!pw)
730                                 goto return_null;
731                         strbuf_addstr(&user_path, pw->pw_dir);
732                 }
733                 to_copy = first_slash;
734         }
735         strbuf_addstr(&user_path, to_copy);
736         return strbuf_detach(&user_path, NULL);
737 return_null:
738         strbuf_release(&user_path);
739         return NULL;
740 }
741
742 /*
743  * First, one directory to try is determined by the following algorithm.
744  *
745  * (0) If "strict" is given, the path is used as given and no DWIM is
746  *     done. Otherwise:
747  * (1) "~/path" to mean path under the running user's home directory;
748  * (2) "~user/path" to mean path under named user's home directory;
749  * (3) "relative/path" to mean cwd relative directory; or
750  * (4) "/absolute/path" to mean absolute directory.
751  *
752  * Unless "strict" is given, we check "%s/.git", "%s", "%s.git/.git", "%s.git"
753  * in this order. We select the first one that is a valid git repository, and
754  * chdir() to it. If none match, or we fail to chdir, we return NULL.
755  *
756  * If all goes well, we return the directory we used to chdir() (but
757  * before ~user is expanded), avoiding getcwd() resolving symbolic
758  * links.  User relative paths are also returned as they are given,
759  * except DWIM suffixing.
760  */
761 const char *enter_repo(const char *path, int strict)
762 {
763         static struct strbuf validated_path = STRBUF_INIT;
764         static struct strbuf used_path = STRBUF_INIT;
765
766         if (!path)
767                 return NULL;
768
769         if (!strict) {
770                 static const char *suffix[] = {
771                         "/.git", "", ".git/.git", ".git", NULL,
772                 };
773                 const char *gitfile;
774                 int len = strlen(path);
775                 int i;
776                 while ((1 < len) && (path[len-1] == '/'))
777                         len--;
778
779                 /*
780                  * We can handle arbitrary-sized buffers, but this remains as a
781                  * sanity check on untrusted input.
782                  */
783                 if (PATH_MAX <= len)
784                         return NULL;
785
786                 strbuf_reset(&used_path);
787                 strbuf_reset(&validated_path);
788                 strbuf_add(&used_path, path, len);
789                 strbuf_add(&validated_path, path, len);
790
791                 if (used_path.buf[0] == '~') {
792                         char *newpath = expand_user_path(used_path.buf, 0);
793                         if (!newpath)
794                                 return NULL;
795                         strbuf_attach(&used_path, newpath, strlen(newpath),
796                                       strlen(newpath));
797                 }
798                 for (i = 0; suffix[i]; i++) {
799                         struct stat st;
800                         size_t baselen = used_path.len;
801                         strbuf_addstr(&used_path, suffix[i]);
802                         if (!stat(used_path.buf, &st) &&
803                             (S_ISREG(st.st_mode) ||
804                             (S_ISDIR(st.st_mode) && is_git_directory(used_path.buf)))) {
805                                 strbuf_addstr(&validated_path, suffix[i]);
806                                 break;
807                         }
808                         strbuf_setlen(&used_path, baselen);
809                 }
810                 if (!suffix[i])
811                         return NULL;
812                 gitfile = read_gitfile(used_path.buf);
813                 if (gitfile) {
814                         strbuf_reset(&used_path);
815                         strbuf_addstr(&used_path, gitfile);
816                 }
817                 if (chdir(used_path.buf))
818                         return NULL;
819                 path = validated_path.buf;
820         }
821         else {
822                 const char *gitfile = read_gitfile(path);
823                 if (gitfile)
824                         path = gitfile;
825                 if (chdir(path))
826                         return NULL;
827         }
828
829         if (is_git_directory(".")) {
830                 set_git_dir(".");
831                 check_repository_format();
832                 return path;
833         }
834
835         return NULL;
836 }
837
838 static int calc_shared_perm(int mode)
839 {
840         int tweak;
841
842         if (get_shared_repository() < 0)
843                 tweak = -get_shared_repository();
844         else
845                 tweak = get_shared_repository();
846
847         if (!(mode & S_IWUSR))
848                 tweak &= ~0222;
849         if (mode & S_IXUSR)
850                 /* Copy read bits to execute bits */
851                 tweak |= (tweak & 0444) >> 2;
852         if (get_shared_repository() < 0)
853                 mode = (mode & ~0777) | tweak;
854         else
855                 mode |= tweak;
856
857         return mode;
858 }
859
860
861 int adjust_shared_perm(const char *path)
862 {
863         int old_mode, new_mode;
864
865         if (!get_shared_repository())
866                 return 0;
867         if (get_st_mode_bits(path, &old_mode) < 0)
868                 return -1;
869
870         new_mode = calc_shared_perm(old_mode);
871         if (S_ISDIR(old_mode)) {
872                 /* Copy read bits to execute bits */
873                 new_mode |= (new_mode & 0444) >> 2;
874                 new_mode |= FORCE_DIR_SET_GID;
875         }
876
877         if (((old_mode ^ new_mode) & ~S_IFMT) &&
878                         chmod(path, (new_mode & ~S_IFMT)) < 0)
879                 return -2;
880         return 0;
881 }
882
883 void safe_create_dir(const char *dir, int share)
884 {
885         if (mkdir(dir, 0777) < 0) {
886                 if (errno != EEXIST) {
887                         perror(dir);
888                         exit(1);
889                 }
890         }
891         else if (share && adjust_shared_perm(dir))
892                 die(_("Could not make %s writable by group"), dir);
893 }
894
895 static int have_same_root(const char *path1, const char *path2)
896 {
897         int is_abs1, is_abs2;
898
899         is_abs1 = is_absolute_path(path1);
900         is_abs2 = is_absolute_path(path2);
901         return (is_abs1 && is_abs2 && tolower(path1[0]) == tolower(path2[0])) ||
902                (!is_abs1 && !is_abs2);
903 }
904
905 /*
906  * Give path as relative to prefix.
907  *
908  * The strbuf may or may not be used, so do not assume it contains the
909  * returned path.
910  */
911 const char *relative_path(const char *in, const char *prefix,
912                           struct strbuf *sb)
913 {
914         int in_len = in ? strlen(in) : 0;
915         int prefix_len = prefix ? strlen(prefix) : 0;
916         int in_off = 0;
917         int prefix_off = 0;
918         int i = 0, j = 0;
919
920         if (!in_len)
921                 return "./";
922         else if (!prefix_len)
923                 return in;
924
925         if (have_same_root(in, prefix))
926                 /* bypass dos_drive, for "c:" is identical to "C:" */
927                 i = j = has_dos_drive_prefix(in);
928         else {
929                 return in;
930         }
931
932         while (i < prefix_len && j < in_len && prefix[i] == in[j]) {
933                 if (is_dir_sep(prefix[i])) {
934                         while (is_dir_sep(prefix[i]))
935                                 i++;
936                         while (is_dir_sep(in[j]))
937                                 j++;
938                         prefix_off = i;
939                         in_off = j;
940                 } else {
941                         i++;
942                         j++;
943                 }
944         }
945
946         if (
947             /* "prefix" seems like prefix of "in" */
948             i >= prefix_len &&
949             /*
950              * but "/foo" is not a prefix of "/foobar"
951              * (i.e. prefix not end with '/')
952              */
953             prefix_off < prefix_len) {
954                 if (j >= in_len) {
955                         /* in="/a/b", prefix="/a/b" */
956                         in_off = in_len;
957                 } else if (is_dir_sep(in[j])) {
958                         /* in="/a/b/c", prefix="/a/b" */
959                         while (is_dir_sep(in[j]))
960                                 j++;
961                         in_off = j;
962                 } else {
963                         /* in="/a/bbb/c", prefix="/a/b" */
964                         i = prefix_off;
965                 }
966         } else if (
967                    /* "in" is short than "prefix" */
968                    j >= in_len &&
969                    /* "in" not end with '/' */
970                    in_off < in_len) {
971                 if (is_dir_sep(prefix[i])) {
972                         /* in="/a/b", prefix="/a/b/c/" */
973                         while (is_dir_sep(prefix[i]))
974                                 i++;
975                         in_off = in_len;
976                 }
977         }
978         in += in_off;
979         in_len -= in_off;
980
981         if (i >= prefix_len) {
982                 if (!in_len)
983                         return "./";
984                 else
985                         return in;
986         }
987
988         strbuf_reset(sb);
989         strbuf_grow(sb, in_len);
990
991         while (i < prefix_len) {
992                 if (is_dir_sep(prefix[i])) {
993                         strbuf_addstr(sb, "../");
994                         while (is_dir_sep(prefix[i]))
995                                 i++;
996                         continue;
997                 }
998                 i++;
999         }
1000         if (!is_dir_sep(prefix[prefix_len - 1]))
1001                 strbuf_addstr(sb, "../");
1002
1003         strbuf_addstr(sb, in);
1004
1005         return sb->buf;
1006 }
1007
1008 /*
1009  * A simpler implementation of relative_path
1010  *
1011  * Get relative path by removing "prefix" from "in". This function
1012  * first appears in v1.5.6-1-g044bbbc, and makes git_dir shorter
1013  * to increase performance when traversing the path to work_tree.
1014  */
1015 const char *remove_leading_path(const char *in, const char *prefix)
1016 {
1017         static struct strbuf buf = STRBUF_INIT;
1018         int i = 0, j = 0;
1019
1020         if (!prefix || !prefix[0])
1021                 return in;
1022         while (prefix[i]) {
1023                 if (is_dir_sep(prefix[i])) {
1024                         if (!is_dir_sep(in[j]))
1025                                 return in;
1026                         while (is_dir_sep(prefix[i]))
1027                                 i++;
1028                         while (is_dir_sep(in[j]))
1029                                 j++;
1030                         continue;
1031                 } else if (in[j] != prefix[i]) {
1032                         return in;
1033                 }
1034                 i++;
1035                 j++;
1036         }
1037         if (
1038             /* "/foo" is a prefix of "/foo" */
1039             in[j] &&
1040             /* "/foo" is not a prefix of "/foobar" */
1041             !is_dir_sep(prefix[i-1]) && !is_dir_sep(in[j])
1042            )
1043                 return in;
1044         while (is_dir_sep(in[j]))
1045                 j++;
1046
1047         strbuf_reset(&buf);
1048         if (!in[j])
1049                 strbuf_addstr(&buf, ".");
1050         else
1051                 strbuf_addstr(&buf, in + j);
1052         return buf.buf;
1053 }
1054
1055 /*
1056  * It is okay if dst == src, but they should not overlap otherwise.
1057  *
1058  * Performs the following normalizations on src, storing the result in dst:
1059  * - Ensures that components are separated by '/' (Windows only)
1060  * - Squashes sequences of '/' except "//server/share" on Windows
1061  * - Removes "." components.
1062  * - Removes ".." components, and the components the precede them.
1063  * Returns failure (non-zero) if a ".." component appears as first path
1064  * component anytime during the normalization. Otherwise, returns success (0).
1065  *
1066  * Note that this function is purely textual.  It does not follow symlinks,
1067  * verify the existence of the path, or make any system calls.
1068  *
1069  * prefix_len != NULL is for a specific case of prefix_pathspec():
1070  * assume that src == dst and src[0..prefix_len-1] is already
1071  * normalized, any time "../" eats up to the prefix_len part,
1072  * prefix_len is reduced. In the end prefix_len is the remaining
1073  * prefix that has not been overridden by user pathspec.
1074  *
1075  * NEEDSWORK: This function doesn't perform normalization w.r.t. trailing '/'.
1076  * For everything but the root folder itself, the normalized path should not
1077  * end with a '/', then the callers need to be fixed up accordingly.
1078  *
1079  */
1080 int normalize_path_copy_len(char *dst, const char *src, int *prefix_len)
1081 {
1082         char *dst0;
1083         const char *end;
1084
1085         /*
1086          * Copy initial part of absolute path: "/", "C:/", "//server/share/".
1087          */
1088         end = src + offset_1st_component(src);
1089         while (src < end) {
1090                 char c = *src++;
1091                 if (is_dir_sep(c))
1092                         c = '/';
1093                 *dst++ = c;
1094         }
1095         dst0 = dst;
1096
1097         while (is_dir_sep(*src))
1098                 src++;
1099
1100         for (;;) {
1101                 char c = *src;
1102
1103                 /*
1104                  * A path component that begins with . could be
1105                  * special:
1106                  * (1) "." and ends   -- ignore and terminate.
1107                  * (2) "./"           -- ignore them, eat slash and continue.
1108                  * (3) ".." and ends  -- strip one and terminate.
1109                  * (4) "../"          -- strip one, eat slash and continue.
1110                  */
1111                 if (c == '.') {
1112                         if (!src[1]) {
1113                                 /* (1) */
1114                                 src++;
1115                         } else if (is_dir_sep(src[1])) {
1116                                 /* (2) */
1117                                 src += 2;
1118                                 while (is_dir_sep(*src))
1119                                         src++;
1120                                 continue;
1121                         } else if (src[1] == '.') {
1122                                 if (!src[2]) {
1123                                         /* (3) */
1124                                         src += 2;
1125                                         goto up_one;
1126                                 } else if (is_dir_sep(src[2])) {
1127                                         /* (4) */
1128                                         src += 3;
1129                                         while (is_dir_sep(*src))
1130                                                 src++;
1131                                         goto up_one;
1132                                 }
1133                         }
1134                 }
1135
1136                 /* copy up to the next '/', and eat all '/' */
1137                 while ((c = *src++) != '\0' && !is_dir_sep(c))
1138                         *dst++ = c;
1139                 if (is_dir_sep(c)) {
1140                         *dst++ = '/';
1141                         while (is_dir_sep(c))
1142                                 c = *src++;
1143                         src--;
1144                 } else if (!c)
1145                         break;
1146                 continue;
1147
1148         up_one:
1149                 /*
1150                  * dst0..dst is prefix portion, and dst[-1] is '/';
1151                  * go up one level.
1152                  */
1153                 dst--;  /* go to trailing '/' */
1154                 if (dst <= dst0)
1155                         return -1;
1156                 /* Windows: dst[-1] cannot be backslash anymore */
1157                 while (dst0 < dst && dst[-1] != '/')
1158                         dst--;
1159                 if (prefix_len && *prefix_len > dst - dst0)
1160                         *prefix_len = dst - dst0;
1161         }
1162         *dst = '\0';
1163         return 0;
1164 }
1165
1166 int normalize_path_copy(char *dst, const char *src)
1167 {
1168         return normalize_path_copy_len(dst, src, NULL);
1169 }
1170
1171 /*
1172  * path = Canonical absolute path
1173  * prefixes = string_list containing normalized, absolute paths without
1174  * trailing slashes (except for the root directory, which is denoted by "/").
1175  *
1176  * Determines, for each path in prefixes, whether the "prefix"
1177  * is an ancestor directory of path.  Returns the length of the longest
1178  * ancestor directory, excluding any trailing slashes, or -1 if no prefix
1179  * is an ancestor.  (Note that this means 0 is returned if prefixes is
1180  * ["/"].) "/foo" is not considered an ancestor of "/foobar".  Directories
1181  * are not considered to be their own ancestors.  path must be in a
1182  * canonical form: empty components, or "." or ".." components are not
1183  * allowed.
1184  */
1185 int longest_ancestor_length(const char *path, struct string_list *prefixes)
1186 {
1187         int i, max_len = -1;
1188
1189         if (!strcmp(path, "/"))
1190                 return -1;
1191
1192         for (i = 0; i < prefixes->nr; i++) {
1193                 const char *ceil = prefixes->items[i].string;
1194                 int len = strlen(ceil);
1195
1196                 if (len == 1 && ceil[0] == '/')
1197                         len = 0; /* root matches anything, with length 0 */
1198                 else if (!strncmp(path, ceil, len) && path[len] == '/')
1199                         ; /* match of length len */
1200                 else
1201                         continue; /* no match */
1202
1203                 if (len > max_len)
1204                         max_len = len;
1205         }
1206
1207         return max_len;
1208 }
1209
1210 /* strip arbitrary amount of directory separators at end of path */
1211 static inline int chomp_trailing_dir_sep(const char *path, int len)
1212 {
1213         while (len && is_dir_sep(path[len - 1]))
1214                 len--;
1215         return len;
1216 }
1217
1218 /*
1219  * If path ends with suffix (complete path components), returns the
1220  * part before suffix (sans trailing directory separators).
1221  * Otherwise returns NULL.
1222  */
1223 char *strip_path_suffix(const char *path, const char *suffix)
1224 {
1225         int path_len = strlen(path), suffix_len = strlen(suffix);
1226
1227         while (suffix_len) {
1228                 if (!path_len)
1229                         return NULL;
1230
1231                 if (is_dir_sep(path[path_len - 1])) {
1232                         if (!is_dir_sep(suffix[suffix_len - 1]))
1233                                 return NULL;
1234                         path_len = chomp_trailing_dir_sep(path, path_len);
1235                         suffix_len = chomp_trailing_dir_sep(suffix, suffix_len);
1236                 }
1237                 else if (path[--path_len] != suffix[--suffix_len])
1238                         return NULL;
1239         }
1240
1241         if (path_len && !is_dir_sep(path[path_len - 1]))
1242                 return NULL;
1243         return xstrndup(path, chomp_trailing_dir_sep(path, path_len));
1244 }
1245
1246 int daemon_avoid_alias(const char *p)
1247 {
1248         int sl, ndot;
1249
1250         /*
1251          * This resurrects the belts and suspenders paranoia check by HPA
1252          * done in <435560F7.4080006@zytor.com> thread, now enter_repo()
1253          * does not do getcwd() based path canonicalization.
1254          *
1255          * sl becomes true immediately after seeing '/' and continues to
1256          * be true as long as dots continue after that without intervening
1257          * non-dot character.
1258          */
1259         if (!p || (*p != '/' && *p != '~'))
1260                 return -1;
1261         sl = 1; ndot = 0;
1262         p++;
1263
1264         while (1) {
1265                 char ch = *p++;
1266                 if (sl) {
1267                         if (ch == '.')
1268                                 ndot++;
1269                         else if (ch == '/') {
1270                                 if (ndot < 3)
1271                                         /* reject //, /./ and /../ */
1272                                         return -1;
1273                                 ndot = 0;
1274                         }
1275                         else if (ch == 0) {
1276                                 if (0 < ndot && ndot < 3)
1277                                         /* reject /.$ and /..$ */
1278                                         return -1;
1279                                 return 0;
1280                         }
1281                         else
1282                                 sl = ndot = 0;
1283                 }
1284                 else if (ch == 0)
1285                         return 0;
1286                 else if (ch == '/') {
1287                         sl = 1;
1288                         ndot = 0;
1289                 }
1290         }
1291 }
1292
1293 static int only_spaces_and_periods(const char *path, size_t len, size_t skip)
1294 {
1295         if (len < skip)
1296                 return 0;
1297         len -= skip;
1298         path += skip;
1299         while (len-- > 0) {
1300                 char c = *(path++);
1301                 if (c != ' ' && c != '.')
1302                         return 0;
1303         }
1304         return 1;
1305 }
1306
1307 int is_ntfs_dotgit(const char *name)
1308 {
1309         size_t len;
1310
1311         for (len = 0; ; len++)
1312                 if (!name[len] || name[len] == '\\' || is_dir_sep(name[len])) {
1313                         if (only_spaces_and_periods(name, len, 4) &&
1314                                         !strncasecmp(name, ".git", 4))
1315                                 return 1;
1316                         if (only_spaces_and_periods(name, len, 5) &&
1317                                         !strncasecmp(name, "git~1", 5))
1318                                 return 1;
1319                         if (name[len] != '\\')
1320                                 return 0;
1321                         name += len + 1;
1322                         len = -1;
1323                 }
1324 }
1325
1326 static int is_ntfs_dot_generic(const char *name,
1327                                const char *dotgit_name,
1328                                size_t len,
1329                                const char *dotgit_ntfs_shortname_prefix)
1330 {
1331         int saw_tilde;
1332         size_t i;
1333
1334         if ((name[0] == '.' && !strncasecmp(name + 1, dotgit_name, len))) {
1335                 i = len + 1;
1336 only_spaces_and_periods:
1337                 for (;;) {
1338                         char c = name[i++];
1339                         if (!c)
1340                                 return 1;
1341                         if (c != ' ' && c != '.')
1342                                 return 0;
1343                 }
1344         }
1345
1346         /*
1347          * Is it a regular NTFS short name, i.e. shortened to 6 characters,
1348          * followed by ~1, ... ~4?
1349          */
1350         if (!strncasecmp(name, dotgit_name, 6) && name[6] == '~' &&
1351             name[7] >= '1' && name[7] <= '4') {
1352                 i = 8;
1353                 goto only_spaces_and_periods;
1354         }
1355
1356         /*
1357          * Is it a fall-back NTFS short name (for details, see
1358          * https://en.wikipedia.org/wiki/8.3_filename?
1359          */
1360         for (i = 0, saw_tilde = 0; i < 8; i++)
1361                 if (name[i] == '\0')
1362                         return 0;
1363                 else if (saw_tilde) {
1364                         if (name[i] < '0' || name[i] > '9')
1365                                 return 0;
1366                 } else if (name[i] == '~') {
1367                         if (name[++i] < '1' || name[i] > '9')
1368                                 return 0;
1369                         saw_tilde = 1;
1370                 } else if (i >= 6)
1371                         return 0;
1372                 else if (name[i] < 0) {
1373                         /*
1374                          * We know our needles contain only ASCII, so we clamp
1375                          * here to make the results of tolower() sane.
1376                          */
1377                         return 0;
1378                 } else if (tolower(name[i]) != dotgit_ntfs_shortname_prefix[i])
1379                         return 0;
1380
1381         goto only_spaces_and_periods;
1382 }
1383
1384 /*
1385  * Inline helper to make sure compiler resolves strlen() on literals at
1386  * compile time.
1387  */
1388 static inline int is_ntfs_dot_str(const char *name, const char *dotgit_name,
1389                                   const char *dotgit_ntfs_shortname_prefix)
1390 {
1391         return is_ntfs_dot_generic(name, dotgit_name, strlen(dotgit_name),
1392                                    dotgit_ntfs_shortname_prefix);
1393 }
1394
1395 int is_ntfs_dotgitmodules(const char *name)
1396 {
1397         return is_ntfs_dot_str(name, "gitmodules", "gi7eba");
1398 }
1399
1400 int is_ntfs_dotgitignore(const char *name)
1401 {
1402         return is_ntfs_dot_str(name, "gitignore", "gi250a");
1403 }
1404
1405 int is_ntfs_dotgitattributes(const char *name)
1406 {
1407         return is_ntfs_dot_str(name, "gitattributes", "gi7d29");
1408 }
1409
1410 int looks_like_command_line_option(const char *str)
1411 {
1412         return str && str[0] == '-';
1413 }
1414
1415 char *xdg_config_home(const char *filename)
1416 {
1417         const char *home, *config_home;
1418
1419         assert(filename);
1420         config_home = getenv("XDG_CONFIG_HOME");
1421         if (config_home && *config_home)
1422                 return mkpathdup("%s/git/%s", config_home, filename);
1423
1424         home = getenv("HOME");
1425         if (home)
1426                 return mkpathdup("%s/.config/git/%s", home, filename);
1427         return NULL;
1428 }
1429
1430 char *xdg_cache_home(const char *filename)
1431 {
1432         const char *home, *cache_home;
1433
1434         assert(filename);
1435         cache_home = getenv("XDG_CACHE_HOME");
1436         if (cache_home && *cache_home)
1437                 return mkpathdup("%s/git/%s", cache_home, filename);
1438
1439         home = getenv("HOME");
1440         if (home)
1441                 return mkpathdup("%s/.cache/git/%s", home, filename);
1442         return NULL;
1443 }
1444
1445 REPO_GIT_PATH_FUNC(cherry_pick_head, "CHERRY_PICK_HEAD")
1446 REPO_GIT_PATH_FUNC(revert_head, "REVERT_HEAD")
1447 REPO_GIT_PATH_FUNC(squash_msg, "SQUASH_MSG")
1448 REPO_GIT_PATH_FUNC(merge_msg, "MERGE_MSG")
1449 REPO_GIT_PATH_FUNC(merge_rr, "MERGE_RR")
1450 REPO_GIT_PATH_FUNC(merge_mode, "MERGE_MODE")
1451 REPO_GIT_PATH_FUNC(merge_head, "MERGE_HEAD")
1452 REPO_GIT_PATH_FUNC(fetch_head, "FETCH_HEAD")
1453 REPO_GIT_PATH_FUNC(shallow, "shallow")