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