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