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