user-manual.txt: add missing section label
[git/git.git] / entry.c
CommitLineData
12dccc16 1#include "cache.h"
8e440259 2#include "blob.h"
cbd53a21 3#include "object-store.h"
8ca12c0d 4#include "dir.h"
dd8e9121 5#include "streaming.h"
6d14eac3 6#include "submodule.h"
52f1d62e 7#include "progress.h"
883e248b 8#include "fsmonitor.h"
12dccc16 9
81a9aa60
KB
10static void create_directories(const char *path, int path_len,
11 const struct checkout *state)
12dccc16 12{
3733e694 13 char *buf = xmallocz(path_len);
81a9aa60
KB
14 int len = 0;
15
16 while (len < path_len) {
17 do {
18 buf[len] = path[len];
19 len++;
20 } while (len < path_len && path[len] != '/');
21 if (len >= path_len)
22 break;
12dccc16 23 buf[len] = 0;
fa2e71c9 24
bad4a54f
KB
25 /*
26 * For 'checkout-index --prefix=<dir>', <dir> is
27 * allowed to be a symlink to an existing directory,
28 * and we set 'state->base_dir_len' below, such that
29 * we test the path components of the prefix with the
30 * stat() function instead of the lstat() function.
31 */
57199892 32 if (has_dirs_only_path(buf, len, state->base_dir_len))
fa2e71c9
JH
33 continue; /* ok, it is already a directory. */
34
35 /*
bad4a54f
KB
36 * If this mkdir() would fail, it could be that there
37 * is already a symlink or something else exists
38 * there, therefore we then try to unlink it and try
39 * one more time to create the directory.
fa2e71c9 40 */
f312de01 41 if (mkdir(buf, 0777)) {
fa2e71c9 42 if (errno == EEXIST && state->force &&
691f1a28 43 !unlink_or_warn(buf) && !mkdir(buf, 0777))
fa2e71c9 44 continue;
0721c314 45 die_errno("cannot create directory at '%s'", buf);
12dccc16
LT
46 }
47 }
48 free(buf);
49}
50
2f29e0c6 51static void remove_subtree(struct strbuf *path)
12dccc16 52{
2f29e0c6 53 DIR *dir = opendir(path->buf);
12dccc16 54 struct dirent *de;
2f29e0c6 55 int origlen = path->len;
a6080a0a 56
12dccc16 57 if (!dir)
2f29e0c6 58 die_errno("cannot opendir '%s'", path->buf);
12dccc16
LT
59 while ((de = readdir(dir)) != NULL) {
60 struct stat st;
2f29e0c6 61
8ca12c0d 62 if (is_dot_or_dotdot(de->d_name))
12dccc16 63 continue;
2f29e0c6
MH
64
65 strbuf_addch(path, '/');
66 strbuf_addstr(path, de->d_name);
67 if (lstat(path->buf, &st))
68 die_errno("cannot lstat '%s'", path->buf);
12dccc16 69 if (S_ISDIR(st.st_mode))
2f29e0c6
MH
70 remove_subtree(path);
71 else if (unlink(path->buf))
72 die_errno("cannot unlink '%s'", path->buf);
73 strbuf_setlen(path, origlen);
12dccc16
LT
74 }
75 closedir(dir);
2f29e0c6
MH
76 if (rmdir(path->buf))
77 die_errno("cannot rmdir '%s'", path->buf);
12dccc16
LT
78}
79
d48a72f3 80static int create_file(const char *path, unsigned int mode)
12dccc16 81{
12dccc16 82 mode = (mode & 0100) ? 0777 : 0666;
781411ed 83 return open(path, O_WRONLY | O_CREAT | O_EXCL, mode);
12dccc16
LT
84}
85
9c5e6c80 86static void *read_blob_entry(const struct cache_entry *ce, unsigned long *size)
f0807e62
LT
87{
88 enum object_type type;
b4f5aca4 89 void *blob_data = read_object_file(&ce->oid, &type, size);
f0807e62 90
d8f71807 91 if (blob_data) {
f0807e62 92 if (type == OBJ_BLOB)
d8f71807
BW
93 return blob_data;
94 free(blob_data);
f0807e62
LT
95 }
96 return NULL;
97}
98
9c5e6c80 99static int open_output_fd(char *path, const struct cache_entry *ce, int to_tempfile)
fd5db55d
JH
100{
101 int symlink = (ce->ce_mode & S_IFMT) != S_IFREG;
102 if (to_tempfile) {
330c8e26
JK
103 xsnprintf(path, TEMPORARY_FILENAME_LENGTH, "%s",
104 symlink ? ".merge_link_XXXXXX" : ".merge_file_XXXXXX");
fd5db55d
JH
105 return mkstemp(path);
106 } else {
107 return create_file(path, !symlink ? ce->ce_mode : 0666);
108 }
109}
110
111static int fstat_output(int fd, const struct checkout *state, struct stat *st)
112{
113 /* use fstat() only when path == ce->name */
114 if (fstat_is_reliable() &&
115 state->refresh_cache && !state->base_dir_len) {
116 fstat(fd, st);
117 return 1;
118 }
119 return 0;
120}
121
9c5e6c80 122static int streaming_write_entry(const struct cache_entry *ce, char *path,
b6691092 123 struct stream_filter *filter,
dd8e9121
JH
124 const struct checkout *state, int to_tempfile,
125 int *fstat_done, struct stat *statbuf)
126{
d9c31e14 127 int result = 0;
47a02ff2 128 int fd;
dd8e9121
JH
129
130 fd = open_output_fd(path, ce, to_tempfile);
d9c31e14
JK
131 if (fd < 0)
132 return -1;
133
7eda0e4f 134 result |= stream_blob_to_fd(fd, &ce->oid, filter, 1);
d9c31e14
JK
135 *fstat_done = fstat_output(fd, state, statbuf);
136 result |= close(fd);
137
138 if (result)
dd8e9121
JH
139 unlink(path);
140 return result;
141}
142
2841e8f8
LS
143void enable_delayed_checkout(struct checkout *state)
144{
145 if (!state->delayed_checkout) {
146 state->delayed_checkout = xmalloc(sizeof(*state->delayed_checkout));
147 state->delayed_checkout->state = CE_CAN_DELAY;
148 string_list_init(&state->delayed_checkout->filters, 0);
149 string_list_init(&state->delayed_checkout->paths, 0);
150 }
151}
152
153static int remove_available_paths(struct string_list_item *item, void *cb_data)
154{
155 struct string_list *available_paths = cb_data;
156 struct string_list_item *available;
157
158 available = string_list_lookup(available_paths, item->string);
159 if (available)
160 available->util = (void *)item->string;
161 return !available;
162}
163
0f086e6d 164int finish_delayed_checkout(struct checkout *state, int *nr_checkouts)
2841e8f8
LS
165{
166 int errs = 0;
52f1d62e
LS
167 unsigned delayed_object_count;
168 off_t filtered_bytes = 0;
2841e8f8 169 struct string_list_item *filter, *path;
52f1d62e 170 struct progress *progress;
2841e8f8
LS
171 struct delayed_checkout *dco = state->delayed_checkout;
172
173 if (!state->delayed_checkout)
174 return errs;
175
176 dco->state = CE_RETRY;
52f1d62e 177 delayed_object_count = dco->paths.nr;
7fbbd3ec 178 progress = start_delayed_progress(_("Filtering content"), delayed_object_count);
2841e8f8
LS
179 while (dco->filters.nr > 0) {
180 for_each_string_list_item(filter, &dco->filters) {
181 struct string_list available_paths = STRING_LIST_INIT_NODUP;
52f1d62e 182 display_progress(progress, delayed_object_count - dco->paths.nr);
2841e8f8
LS
183
184 if (!async_query_available_blobs(filter->string, &available_paths)) {
185 /* Filter reported an error */
186 errs = 1;
187 filter->string = "";
188 continue;
189 }
190 if (available_paths.nr <= 0) {
191 /*
192 * Filter responded with no entries. That means
193 * the filter is done and we can remove the
194 * filter from the list (see
195 * "string_list_remove_empty_items" call below).
196 */
197 filter->string = "";
198 continue;
199 }
200
201 /*
202 * In dco->paths we store a list of all delayed paths.
203 * The filter just send us a list of available paths.
204 * Remove them from the list.
205 */
206 filter_string_list(&dco->paths, 0,
207 &remove_available_paths, &available_paths);
208
209 for_each_string_list_item(path, &available_paths) {
210 struct cache_entry* ce;
211
212 if (!path->util) {
213 error("external filter '%s' signaled that '%s' "
214 "is now available although it has not been "
215 "delayed earlier",
216 filter->string, path->string);
217 errs |= 1;
218
219 /*
220 * Do not ask the filter for available blobs,
221 * again, as the filter is likely buggy.
222 */
223 filter->string = "";
224 continue;
225 }
226 ce = index_file_exists(state->istate, path->string,
227 strlen(path->string), 0);
52f1d62e 228 if (ce) {
0f086e6d 229 errs |= checkout_entry(ce, state, NULL, nr_checkouts);
52f1d62e
LS
230 filtered_bytes += ce->ce_stat_data.sd_size;
231 display_throughput(progress, filtered_bytes);
232 } else
233 errs = 1;
2841e8f8
LS
234 }
235 }
236 string_list_remove_empty_items(&dco->filters, 0);
237 }
52f1d62e 238 stop_progress(&progress);
2841e8f8
LS
239 string_list_clear(&dco->filters, 0);
240
241 /* At this point we should not have any delayed paths anymore. */
242 errs |= dco->paths.nr;
243 for_each_string_list_item(path, &dco->paths) {
244 error("'%s' was not filtered properly", path->string);
245 }
246 string_list_clear(&dco->paths, 0);
247
248 free(dco);
249 state->delayed_checkout = NULL;
250
251 return errs;
252}
253
9c5e6c80
NTND
254static int write_entry(struct cache_entry *ce,
255 char *path, const struct checkout *state, int to_tempfile)
12dccc16 256{
4857c761 257 unsigned int ce_mode_s_ifmt = ce->ce_mode & S_IFMT;
c602d3a9 258 struct delayed_checkout *dco = state->delayed_checkout;
e4c72923 259 int fd, ret, fstat_done = 0;
d8f71807 260 char *new_blob;
4857c761
KB
261 struct strbuf buf = STRBUF_INIT;
262 unsigned long size;
564bde9a
JK
263 ssize_t wrote;
264 size_t newsize = 0;
e4c72923 265 struct stat st;
6d14eac3 266 const struct submodule *sub;
4857c761 267
b6691092 268 if (ce_mode_s_ifmt == S_IFREG) {
74cfc0ee 269 struct stream_filter *filter = get_stream_filter(state->istate, ce->name,
1a750441 270 &ce->oid);
b6691092
JH
271 if (filter &&
272 !streaming_write_entry(ce, path, filter,
273 state, to_tempfile,
274 &fstat_done, &st))
275 goto finish;
276 }
dd8e9121 277
4857c761 278 switch (ce_mode_s_ifmt) {
4857c761 279 case S_IFLNK:
d8f71807
BW
280 new_blob = read_blob_entry(ce, &size);
281 if (!new_blob)
d43e9073 282 return error("unable to read sha1 file of %s (%s)",
7cbbf9d6 283 path, oid_to_hex(&ce->oid));
1a9d7e9b 284
7cbbf9d6
JK
285 /*
286 * We can't make a real symlink; write out a regular file entry
287 * with the symlink destination as its contents.
288 */
289 if (!has_symlinks || to_tempfile)
290 goto write_file_entry;
291
d8f71807
BW
292 ret = symlink(new_blob, path);
293 free(new_blob);
7cbbf9d6
JK
294 if (ret)
295 return error_errno("unable to create symlink %s", path);
296 break;
297
298 case S_IFREG:
c602d3a9
JK
299 /*
300 * We do not send the blob in case of a retry, so do not
301 * bother reading it at all.
302 */
7cbbf9d6 303 if (dco && dco->state == CE_RETRY) {
d8f71807 304 new_blob = NULL;
c602d3a9
JK
305 size = 0;
306 } else {
d8f71807
BW
307 new_blob = read_blob_entry(ce, &size);
308 if (!new_blob)
c602d3a9
JK
309 return error("unable to read sha1 file of %s (%s)",
310 path, oid_to_hex(&ce->oid));
4857c761
KB
311 }
312
1a9d7e9b
JH
313 /*
314 * Convert from git internal format to working tree format
315 */
7cbbf9d6 316 if (dco && dco->state != CE_NO_DELAY) {
74cfc0ee 317 ret = async_convert_to_working_tree(state->istate, ce->name, new_blob,
7cbbf9d6
JK
318 size, &buf, dco);
319 if (ret && string_list_has_string(&dco->paths, ce->name)) {
d8f71807 320 free(new_blob);
7cbbf9d6 321 goto delayed;
2841e8f8 322 }
7cbbf9d6 323 } else
74cfc0ee 324 ret = convert_to_working_tree(state->istate, ce->name, new_blob, size, &buf);
7cbbf9d6
JK
325
326 if (ret) {
d8f71807
BW
327 free(new_blob);
328 new_blob = strbuf_detach(&buf, &newsize);
7cbbf9d6 329 size = newsize;
1a9d7e9b 330 }
7cbbf9d6
JK
331 /*
332 * No "else" here as errors from convert are OK at this
333 * point. If the error would have been fatal (e.g.
334 * filter is required), then we would have died already.
335 */
1a9d7e9b 336
7cbbf9d6 337 write_file_entry:
fd5db55d 338 fd = open_output_fd(path, ce, to_tempfile);
12dccc16 339 if (fd < 0) {
d8f71807 340 free(new_blob);
e1ebb3c2 341 return error_errno("unable to create file %s", path);
12dccc16 342 }
6c510bee 343
d8f71807 344 wrote = write_in_full(fd, new_blob, size);
fd5db55d
JH
345 if (!to_tempfile)
346 fstat_done = fstat_output(fd, state, &st);
12dccc16 347 close(fd);
d8f71807 348 free(new_blob);
564bde9a 349 if (wrote < 0)
d43e9073 350 return error("unable to write file %s", path);
12dccc16 351 break;
7cbbf9d6 352
302b9282 353 case S_IFGITLINK:
f0807e62 354 if (to_tempfile)
42063f95 355 return error("cannot create temporary submodule %s", path);
f0807e62 356 if (mkdir(path, 0777) < 0)
42063f95 357 return error("cannot create submodule directory %s", path);
6d14eac3
SB
358 sub = submodule_from_ce(ce);
359 if (sub)
360 return submodule_move_head(ce->name,
cd279e2e
SB
361 NULL, oid_to_hex(&ce->oid),
362 state->force ? SUBMODULE_MOVE_HEAD_FORCE : 0);
f0807e62 363 break;
7cbbf9d6 364
12dccc16 365 default:
d43e9073 366 return error("unknown file mode for %s in index", path);
12dccc16
LT
367 }
368
dd8e9121 369finish:
6ee67f26 370 if (state->refresh_cache) {
d4a2024a 371 assert(state->istate);
e4c72923 372 if (!fstat_done)
11179eb3
LS
373 if (lstat(ce->name, &st) < 0)
374 return error_errno("unable to stat just-written file %s",
375 ce->name);
d4c0a3ac 376 fill_stat_cache_info(state->istate, ce, &st);
078a58e8 377 ce->ce_flags |= CE_UPDATE_IN_BASE;
883e248b 378 mark_fsmonitor_invalid(state->istate, ce);
d4a2024a 379 state->istate->cache_changed |= CE_ENTRY_CHANGED;
12dccc16 380 }
03b95333 381delayed:
12dccc16
LT
382 return 0;
383}
384
b6986d8a
LT
385/*
386 * This is like 'lstat()', except it refuses to follow symlinks
da02ca50 387 * in the path, after skipping "skiplen".
b6986d8a 388 */
61b97df7 389static int check_path(const char *path, int len, struct stat *st, int skiplen)
b6986d8a 390{
da02ca50
JH
391 const char *slash = path + len;
392
393 while (path < slash && *slash != '/')
394 slash--;
395 if (!has_dirs_only_path(path, slash - path, skiplen)) {
b6986d8a
LT
396 errno = ENOENT;
397 return -1;
398 }
399 return lstat(path, st);
400}
401
b878579a
NTND
402static void mark_colliding_entries(const struct checkout *state,
403 struct cache_entry *ce, struct stat *st)
404{
405 int i, trust_ino = check_stat;
406
e66ceca9 407#if defined(GIT_WINDOWS_NATIVE) || defined(__CYGWIN__)
b878579a
NTND
408 trust_ino = 0;
409#endif
410
411 ce->ce_flags |= CE_MATCHED;
412
413 for (i = 0; i < state->istate->cache_nr; i++) {
414 struct cache_entry *dup = state->istate->cache[i];
415
416 if (dup == ce)
417 break;
418
419 if (dup->ce_flags & (CE_MATCHED | CE_VALID | CE_SKIP_WORKTREE))
420 continue;
421
e66ceca9 422 if ((trust_ino && !match_stat_data(&dup->ce_stat_data, st)) ||
b878579a
NTND
423 (!trust_ino && !fspathcmp(ce->name, dup->name))) {
424 dup->ce_flags |= CE_MATCHED;
425 break;
426 }
427 }
428}
429
af2a651d
JH
430/*
431 * Write the contents from ce out to the working tree.
432 *
433 * When topath[] is not NULL, instead of writing to the working tree
434 * file named by ce, a temporary file is created by this function and
435 * its name is returned in topath[], which must be able to hold at
436 * least TEMPORARY_FILENAME_LENGTH bytes long.
437 */
0f086e6d
NTND
438int checkout_entry(struct cache_entry *ce, const struct checkout *state,
439 char *topath, int *nr_checkouts)
12dccc16 440{
f63272a3 441 static struct strbuf path = STRBUF_INIT;
de84f99c 442 struct stat st;
12dccc16 443
536ec183
TG
444 if (ce->ce_flags & CE_WT_REMOVE) {
445 if (topath)
446 /*
447 * No content and thus no path to create, so we have
448 * no pathname to return.
449 */
450 BUG("Can't remove entry to a path");
451 unlink_entry(ce);
452 return 0;
453 }
454
de84f99c
SP
455 if (topath)
456 return write_entry(ce, topath, state, 1);
457
f63272a3
MH
458 strbuf_reset(&path);
459 strbuf_add(&path, state->base_dir, state->base_dir_len);
460 strbuf_add(&path, ce->name, ce_namelen(ce));
12dccc16 461
f63272a3 462 if (!check_path(path.buf, path.len, &st, state->base_dir_len)) {
6d14eac3 463 const struct submodule *sub;
74cfc0ee
NTND
464 unsigned changed = ie_match_stat(state->istate, ce, &st,
465 CE_MATCH_IGNORE_VALID | CE_MATCH_IGNORE_SKIP_WORKTREE);
6d14eac3
SB
466 /*
467 * Needs to be checked before !changed returns early,
468 * as the possibly empty directory was not changed
469 */
470 sub = submodule_from_ce(ce);
471 if (sub) {
472 int err;
473 if (!is_submodule_populated_gently(ce->name, &err)) {
474 struct stat sb;
475 if (lstat(ce->name, &sb))
476 die(_("could not stat file '%s'"), ce->name);
477 if (!(st.st_mode & S_IFDIR))
478 unlink_or_warn(ce->name);
479
480 return submodule_move_head(ce->name,
cd279e2e 481 NULL, oid_to_hex(&ce->oid), 0);
6d14eac3
SB
482 } else
483 return submodule_move_head(ce->name,
484 "HEAD", oid_to_hex(&ce->oid),
cd279e2e 485 state->force ? SUBMODULE_MOVE_HEAD_FORCE : 0);
6d14eac3
SB
486 }
487
12dccc16
LT
488 if (!changed)
489 return 0;
490 if (!state->force) {
491 if (!state->quiet)
f63272a3
MH
492 fprintf(stderr,
493 "%s already exists, no checkout\n",
494 path.buf);
4b12dae6 495 return -1;
12dccc16
LT
496 }
497
b878579a
NTND
498 if (state->clone)
499 mark_colliding_entries(state, ce, &st);
500
12dccc16
LT
501 /*
502 * We unlink the old file, to get the new one with the
503 * right permissions (including umask, which is nasty
504 * to emulate by hand - much easier to let the system
505 * just do the right thing)
506 */
d48a72f3 507 if (S_ISDIR(st.st_mode)) {
f0807e62 508 /* If it is a gitlink, leave it alone! */
7a51ed66 509 if (S_ISGITLINK(ce->ce_mode))
f0807e62 510 return 0;
d48a72f3 511 if (!state->force)
f63272a3 512 return error("%s is a directory", path.buf);
2f29e0c6 513 remove_subtree(&path);
f63272a3 514 } else if (unlink(path.buf))
e1ebb3c2 515 return error_errno("unable to unlink old '%s'", path.buf);
de84f99c 516 } else if (state->not_new)
12dccc16 517 return 0;
f63272a3
MH
518
519 create_directories(path.buf, path.len, state);
0f086e6d
NTND
520 if (nr_checkouts)
521 (*nr_checkouts)++;
f63272a3 522 return write_entry(ce, path.buf, state, 0);
12dccc16 523}
b702dd12
TG
524
525void unlink_entry(const struct cache_entry *ce)
526{
527 const struct submodule *sub = submodule_from_ce(ce);
528 if (sub) {
529 /* state.force is set at the caller. */
530 submodule_move_head(ce->name, "HEAD", NULL,
531 SUBMODULE_MOVE_HEAD_FORCE);
532 }
533 if (!check_leading_path(ce->name, ce_namelen(ce)))
534 return;
535 if (remove_or_warn(ce->ce_mode, ce->name))
536 return;
537 schedule_dir_for_removal(ce->name, ce_namelen(ce));
538}