1 /*
2 * Copyright (C) the libgit2 contributors. All rights reserved.
3 *
4 * This file is part of libgit2, distributed under the GNU GPL v2 with
5 * a Linking Exception. For full terms see the included COPYING file.
6 */
7
8 #include "checkout.h"
9
10 #include "git2/repository.h"
11 #include "git2/refs.h"
12 #include "git2/tree.h"
13 #include "git2/blob.h"
14 #include "git2/config.h"
15 #include "git2/diff.h"
16 #include "git2/submodule.h"
17 #include "git2/sys/index.h"
18 #include "git2/sys/filter.h"
19 #include "git2/merge.h"
20
21 #include "refs.h"
22 #include "repository.h"
23 #include "index.h"
24 #include "filter.h"
25 #include "blob.h"
26 #include "diff.h"
27 #include "diff_generate.h"
28 #include "pathspec.h"
29 #include "buf_text.h"
30 #include "diff_xdiff.h"
31 #include "path.h"
32 #include "attr.h"
33 #include "pool.h"
34 #include "strmap.h"
35
36 /* See docs/checkout-internals.md for more information */
37
38 enum {
39 CHECKOUT_ACTION__NONE = 0,
40 CHECKOUT_ACTION__REMOVE = 1,
41 CHECKOUT_ACTION__UPDATE_BLOB = 2,
42 CHECKOUT_ACTION__UPDATE_SUBMODULE = 4,
43 CHECKOUT_ACTION__CONFLICT = 8,
44 CHECKOUT_ACTION__REMOVE_CONFLICT = 16,
45 CHECKOUT_ACTION__UPDATE_CONFLICT = 32,
46 CHECKOUT_ACTION__MAX = 32,
47 CHECKOUT_ACTION__REMOVE_AND_UPDATE =
48 (CHECKOUT_ACTION__UPDATE_BLOB | CHECKOUT_ACTION__REMOVE),
49 };
50
51 typedef struct {
52 git_repository *repo;
53 git_iterator *target;
54 git_diff *diff;
55 git_checkout_options opts;
56 bool opts_free_baseline;
57 char *pfx;
58 git_index *index;
59 git_pool pool;
60 git_vector removes;
61 git_vector remove_conflicts;
62 git_vector update_conflicts;
63 git_vector *update_reuc;
64 git_vector *update_names;
65 git_buf target_path;
66 size_t target_len;
67 git_buf tmp;
68 unsigned int strategy;
69 int can_symlink;
70 int respect_filemode;
71 bool reload_submodules;
72 size_t total_steps;
73 size_t completed_steps;
74 git_checkout_perfdata perfdata;
75 git_strmap *mkdir_map;
76 git_attr_session attr_session;
77 } checkout_data;
78
79 typedef struct {
80 const git_index_entry *ancestor;
81 const git_index_entry *ours;
82 const git_index_entry *theirs;
83
84 int name_collision:1,
85 directoryfile:1,
86 one_to_two:1,
87 binary:1,
88 submodule:1;
89 } checkout_conflictdata;
90
checkout_notify(checkout_data * data,git_checkout_notify_t why,const git_diff_delta * delta,const git_index_entry * wditem)91 static int checkout_notify(
92 checkout_data *data,
93 git_checkout_notify_t why,
94 const git_diff_delta *delta,
95 const git_index_entry *wditem)
96 {
97 git_diff_file wdfile;
98 const git_diff_file *baseline = NULL, *target = NULL, *workdir = NULL;
99 const char *path = NULL;
100
101 if (!data->opts.notify_cb ||
102 (why & data->opts.notify_flags) == 0)
103 return 0;
104
105 if (wditem) {
106 memset(&wdfile, 0, sizeof(wdfile));
107
108 git_oid_cpy(&wdfile.id, &wditem->id);
109 wdfile.path = wditem->path;
110 wdfile.size = wditem->file_size;
111 wdfile.flags = GIT_DIFF_FLAG_VALID_ID;
112 wdfile.mode = wditem->mode;
113
114 workdir = &wdfile;
115
116 path = wditem->path;
117 }
118
119 if (delta) {
120 switch (delta->status) {
121 case GIT_DELTA_UNMODIFIED:
122 case GIT_DELTA_MODIFIED:
123 case GIT_DELTA_TYPECHANGE:
124 default:
125 baseline = &delta->old_file;
126 target = &delta->new_file;
127 break;
128 case GIT_DELTA_ADDED:
129 case GIT_DELTA_IGNORED:
130 case GIT_DELTA_UNTRACKED:
131 case GIT_DELTA_UNREADABLE:
132 target = &delta->new_file;
133 break;
134 case GIT_DELTA_DELETED:
135 baseline = &delta->old_file;
136 break;
137 }
138
139 path = delta->old_file.path;
140 }
141
142 {
143 int error = data->opts.notify_cb(
144 why, path, baseline, target, workdir, data->opts.notify_payload);
145
146 return git_error_set_after_callback_function(
147 error, "git_checkout notification");
148 }
149 }
150
is_workdir_base_or_new(const git_oid * workdir_id,const git_diff_file * baseitem,const git_diff_file * newitem)151 GIT_INLINE(bool) is_workdir_base_or_new(
152 const git_oid *workdir_id,
153 const git_diff_file *baseitem,
154 const git_diff_file *newitem)
155 {
156 return (git_oid__cmp(&baseitem->id, workdir_id) == 0 ||
157 git_oid__cmp(&newitem->id, workdir_id) == 0);
158 }
159
is_filemode_changed(git_filemode_t a,git_filemode_t b,int respect_filemode)160 GIT_INLINE(bool) is_filemode_changed(git_filemode_t a, git_filemode_t b, int respect_filemode)
161 {
162 /* If core.filemode = false, ignore links in the repository and executable bit changes */
163 if (!respect_filemode) {
164 if (a == S_IFLNK)
165 a = GIT_FILEMODE_BLOB;
166 if (b == S_IFLNK)
167 b = GIT_FILEMODE_BLOB;
168
169 a &= ~0111;
170 b &= ~0111;
171 }
172
173 return (a != b);
174 }
175
checkout_is_workdir_modified(checkout_data * data,const git_diff_file * baseitem,const git_diff_file * newitem,const git_index_entry * wditem)176 static bool checkout_is_workdir_modified(
177 checkout_data *data,
178 const git_diff_file *baseitem,
179 const git_diff_file *newitem,
180 const git_index_entry *wditem)
181 {
182 git_oid oid;
183 const git_index_entry *ie;
184
185 /* handle "modified" submodule */
186 if (wditem->mode == GIT_FILEMODE_COMMIT) {
187 git_submodule *sm;
188 unsigned int sm_status = 0;
189 const git_oid *sm_oid = NULL;
190 bool rval = false;
191
192 if (git_submodule_lookup(&sm, data->repo, wditem->path) < 0) {
193 git_error_clear();
194 return true;
195 }
196
197 if (git_submodule_status(&sm_status, data->repo, wditem->path, GIT_SUBMODULE_IGNORE_UNSPECIFIED) < 0 ||
198 GIT_SUBMODULE_STATUS_IS_WD_DIRTY(sm_status))
199 rval = true;
200 else if ((sm_oid = git_submodule_wd_id(sm)) == NULL)
201 rval = false;
202 else
203 rval = (git_oid__cmp(&baseitem->id, sm_oid) != 0);
204
205 git_submodule_free(sm);
206 return rval;
207 }
208
209 /*
210 * Look at the cache to decide if the workdir is modified: if the
211 * cache contents match the workdir contents, then we do not need
212 * to examine the working directory directly, instead we can
213 * examine the cache to see if _it_ has been modified. This allows
214 * us to avoid touching the disk.
215 */
216 ie = git_index_get_bypath(data->index, wditem->path, 0);
217
218 if (ie != NULL &&
219 !git_index_entry_newer_than_index(ie, data->index) &&
220 git_index_time_eq(&wditem->mtime, &ie->mtime) &&
221 wditem->file_size == ie->file_size &&
222 !is_filemode_changed(wditem->mode, ie->mode, data->respect_filemode)) {
223
224 /* The workdir is modified iff the index entry is modified */
225 return !is_workdir_base_or_new(&ie->id, baseitem, newitem) ||
226 is_filemode_changed(baseitem->mode, ie->mode, data->respect_filemode);
227 }
228
229 /* depending on where base is coming from, we may or may not know
230 * the actual size of the data, so we can't rely on this shortcut.
231 */
232 if (baseitem->size && wditem->file_size != baseitem->size)
233 return true;
234
235 /* if the workdir item is a directory, it cannot be a modified file */
236 if (S_ISDIR(wditem->mode))
237 return false;
238
239 if (is_filemode_changed(baseitem->mode, wditem->mode, data->respect_filemode))
240 return true;
241
242 if (git_diff__oid_for_entry(&oid, data->diff, wditem, wditem->mode, NULL) < 0)
243 return false;
244
245 /* Allow the checkout if the workdir is not modified *or* if the checkout
246 * target's contents are already in the working directory.
247 */
248 return !is_workdir_base_or_new(&oid, baseitem, newitem);
249 }
250
251 #define CHECKOUT_ACTION_IF(FLAG,YES,NO) \
252 ((data->strategy & GIT_CHECKOUT_##FLAG) ? CHECKOUT_ACTION__##YES : CHECKOUT_ACTION__##NO)
253
checkout_action_common(int * action,checkout_data * data,const git_diff_delta * delta,const git_index_entry * wd)254 static int checkout_action_common(
255 int *action,
256 checkout_data *data,
257 const git_diff_delta *delta,
258 const git_index_entry *wd)
259 {
260 git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;
261
262 if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
263 *action = (*action & ~CHECKOUT_ACTION__REMOVE);
264
265 if ((*action & CHECKOUT_ACTION__UPDATE_BLOB) != 0) {
266 if (S_ISGITLINK(delta->new_file.mode))
267 *action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB) |
268 CHECKOUT_ACTION__UPDATE_SUBMODULE;
269
270 /* to "update" a symlink, we must remove the old one first */
271 if (delta->new_file.mode == GIT_FILEMODE_LINK && wd != NULL)
272 *action |= CHECKOUT_ACTION__REMOVE;
273
274 /* if the file is on disk and doesn't match our mode, force update */
275 if (wd &&
276 GIT_PERMS_IS_EXEC(wd->mode) != GIT_PERMS_IS_EXEC(delta->new_file.mode))
277 *action |= CHECKOUT_ACTION__REMOVE;
278
279 notify = GIT_CHECKOUT_NOTIFY_UPDATED;
280 }
281
282 if ((*action & CHECKOUT_ACTION__CONFLICT) != 0)
283 notify = GIT_CHECKOUT_NOTIFY_CONFLICT;
284
285 return checkout_notify(data, notify, delta, wd);
286 }
287
checkout_action_no_wd(int * action,checkout_data * data,const git_diff_delta * delta)288 static int checkout_action_no_wd(
289 int *action,
290 checkout_data *data,
291 const git_diff_delta *delta)
292 {
293 int error = 0;
294
295 *action = CHECKOUT_ACTION__NONE;
296
297 switch (delta->status) {
298 case GIT_DELTA_UNMODIFIED: /* case 12 */
299 error = checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL);
300 if (error)
301 return error;
302 *action = CHECKOUT_ACTION_IF(RECREATE_MISSING, UPDATE_BLOB, NONE);
303 break;
304 case GIT_DELTA_ADDED: /* case 2 or 28 (and 5 but not really) */
305 *action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
306 break;
307 case GIT_DELTA_MODIFIED: /* case 13 (and 35 but not really) */
308 *action = CHECKOUT_ACTION_IF(RECREATE_MISSING, UPDATE_BLOB, CONFLICT);
309 break;
310 case GIT_DELTA_TYPECHANGE: /* case 21 (B->T) and 28 (T->B)*/
311 if (delta->new_file.mode == GIT_FILEMODE_TREE)
312 *action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
313 break;
314 case GIT_DELTA_DELETED: /* case 8 or 25 */
315 *action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
316 break;
317 default: /* impossible */
318 break;
319 }
320
321 return checkout_action_common(action, data, delta, NULL);
322 }
323
checkout_target_fullpath(git_buf ** out,checkout_data * data,const char * path)324 static int checkout_target_fullpath(
325 git_buf **out, checkout_data *data, const char *path)
326 {
327 git_buf_truncate(&data->target_path, data->target_len);
328
329 if (path && git_buf_puts(&data->target_path, path) < 0)
330 return -1;
331
332 *out = &data->target_path;
333
334 return 0;
335 }
336
wd_item_is_removable(checkout_data * data,const git_index_entry * wd)337 static bool wd_item_is_removable(
338 checkout_data *data, const git_index_entry *wd)
339 {
340 git_buf *full;
341
342 if (wd->mode != GIT_FILEMODE_TREE)
343 return true;
344
345 if (checkout_target_fullpath(&full, data, wd->path) < 0)
346 return false;
347
348 return !full || !git_path_contains(full, DOT_GIT);
349 }
350
checkout_queue_remove(checkout_data * data,const char * path)351 static int checkout_queue_remove(checkout_data *data, const char *path)
352 {
353 char *copy = git_pool_strdup(&data->pool, path);
354 GIT_ERROR_CHECK_ALLOC(copy);
355 return git_vector_insert(&data->removes, copy);
356 }
357
358 /* note that this advances the iterator over the wd item */
checkout_action_wd_only(checkout_data * data,git_iterator * workdir,const git_index_entry ** wditem,git_vector * pathspec)359 static int checkout_action_wd_only(
360 checkout_data *data,
361 git_iterator *workdir,
362 const git_index_entry **wditem,
363 git_vector *pathspec)
364 {
365 int error = 0;
366 bool remove = false;
367 git_checkout_notify_t notify = GIT_CHECKOUT_NOTIFY_NONE;
368 const git_index_entry *wd = *wditem;
369
370 if (!git_pathspec__match(
371 pathspec, wd->path,
372 (data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
373 git_iterator_ignore_case(workdir), NULL, NULL)) {
374
375 if (wd->mode == GIT_FILEMODE_TREE)
376 return git_iterator_advance_into(wditem, workdir);
377 else
378 return git_iterator_advance(wditem, workdir);
379 }
380
381 /* check if item is tracked in the index but not in the checkout diff */
382 if (data->index != NULL) {
383 size_t pos;
384
385 error = git_index__find_pos(
386 &pos, data->index, wd->path, 0, GIT_INDEX_STAGE_ANY);
387
388 if (wd->mode != GIT_FILEMODE_TREE) {
389 if (!error) { /* found by git_index__find_pos call */
390 notify = GIT_CHECKOUT_NOTIFY_DIRTY;
391 remove = ((data->strategy & GIT_CHECKOUT_FORCE) != 0);
392 } else if (error != GIT_ENOTFOUND)
393 return error;
394 else
395 error = 0; /* git_index__find_pos does not set error msg */
396 } else {
397 /* for tree entries, we have to see if there are any index
398 * entries that are contained inside that tree
399 */
400 const git_index_entry *e = git_index_get_byindex(data->index, pos);
401
402 if (e != NULL && data->diff->pfxcomp(e->path, wd->path) == 0)
403 return git_iterator_advance_into(wditem, workdir);
404 }
405 }
406
407 if (notify != GIT_CHECKOUT_NOTIFY_NONE) {
408 /* if we found something in the index, notify and advance */
409 if ((error = checkout_notify(data, notify, NULL, wd)) != 0)
410 return error;
411
412 if (remove && wd_item_is_removable(data, wd))
413 error = checkout_queue_remove(data, wd->path);
414
415 if (!error)
416 error = git_iterator_advance(wditem, workdir);
417 } else {
418 /* untracked or ignored - can't know which until we advance through */
419 bool over = false, removable = wd_item_is_removable(data, wd);
420 git_iterator_status_t untracked_state;
421
422 /* copy the entry for issuing notification callback later */
423 git_index_entry saved_wd = *wd;
424 git_buf_sets(&data->tmp, wd->path);
425 saved_wd.path = data->tmp.ptr;
426
427 error = git_iterator_advance_over(
428 wditem, &untracked_state, workdir);
429 if (error == GIT_ITEROVER)
430 over = true;
431 else if (error < 0)
432 return error;
433
434 if (untracked_state == GIT_ITERATOR_STATUS_IGNORED) {
435 notify = GIT_CHECKOUT_NOTIFY_IGNORED;
436 remove = ((data->strategy & GIT_CHECKOUT_REMOVE_IGNORED) != 0);
437 } else {
438 notify = GIT_CHECKOUT_NOTIFY_UNTRACKED;
439 remove = ((data->strategy & GIT_CHECKOUT_REMOVE_UNTRACKED) != 0);
440 }
441
442 if ((error = checkout_notify(data, notify, NULL, &saved_wd)) != 0)
443 return error;
444
445 if (remove && removable)
446 error = checkout_queue_remove(data, saved_wd.path);
447
448 if (!error && over) /* restore ITEROVER if needed */
449 error = GIT_ITEROVER;
450 }
451
452 return error;
453 }
454
submodule_is_config_only(checkout_data * data,const char * path)455 static bool submodule_is_config_only(
456 checkout_data *data,
457 const char *path)
458 {
459 git_submodule *sm = NULL;
460 unsigned int sm_loc = 0;
461 bool rval = false;
462
463 if (git_submodule_lookup(&sm, data->repo, path) < 0)
464 return true;
465
466 if (git_submodule_location(&sm_loc, sm) < 0 ||
467 sm_loc == GIT_SUBMODULE_STATUS_IN_CONFIG)
468 rval = true;
469
470 git_submodule_free(sm);
471
472 return rval;
473 }
474
checkout_is_empty_dir(checkout_data * data,const char * path)475 static bool checkout_is_empty_dir(checkout_data *data, const char *path)
476 {
477 git_buf *fullpath;
478
479 if (checkout_target_fullpath(&fullpath, data, path) < 0)
480 return false;
481
482 return git_path_is_empty_dir(fullpath->ptr);
483 }
484
checkout_action_with_wd(int * action,checkout_data * data,const git_diff_delta * delta,git_iterator * workdir,const git_index_entry * wd)485 static int checkout_action_with_wd(
486 int *action,
487 checkout_data *data,
488 const git_diff_delta *delta,
489 git_iterator *workdir,
490 const git_index_entry *wd)
491 {
492 *action = CHECKOUT_ACTION__NONE;
493
494 switch (delta->status) {
495 case GIT_DELTA_UNMODIFIED: /* case 14/15 or 33 */
496 if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd)) {
497 GIT_ERROR_CHECK_ERROR(
498 checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
499 *action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, NONE);
500 }
501 break;
502 case GIT_DELTA_ADDED: /* case 3, 4 or 6 */
503 if (git_iterator_current_is_ignored(workdir))
504 *action = CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED, CONFLICT, UPDATE_BLOB);
505 else
506 *action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, CONFLICT);
507 break;
508 case GIT_DELTA_DELETED: /* case 9 or 10 (or 26 but not really) */
509 if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
510 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
511 else
512 *action = CHECKOUT_ACTION_IF(SAFE, REMOVE, NONE);
513 break;
514 case GIT_DELTA_MODIFIED: /* case 16, 17, 18 (or 36 but not really) */
515 if (wd->mode != GIT_FILEMODE_COMMIT &&
516 checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
517 *action = CHECKOUT_ACTION_IF(FORCE, UPDATE_BLOB, CONFLICT);
518 else
519 *action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
520 break;
521 case GIT_DELTA_TYPECHANGE: /* case 22, 23, 29, 30 */
522 if (delta->old_file.mode == GIT_FILEMODE_TREE) {
523 if (wd->mode == GIT_FILEMODE_TREE)
524 /* either deleting items in old tree will delete the wd dir,
525 * or we'll get a conflict when we attempt blob update...
526 */
527 *action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
528 else if (wd->mode == GIT_FILEMODE_COMMIT) {
529 /* workdir is possibly a "phantom" submodule - treat as a
530 * tree if the only submodule info came from the config
531 */
532 if (submodule_is_config_only(data, wd->path))
533 *action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
534 else
535 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
536 } else
537 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
538 }
539 else if (checkout_is_workdir_modified(data, &delta->old_file, &delta->new_file, wd))
540 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
541 else
542 *action = CHECKOUT_ACTION_IF(SAFE, REMOVE_AND_UPDATE, NONE);
543
544 /* don't update if the typechange is to a tree */
545 if (delta->new_file.mode == GIT_FILEMODE_TREE)
546 *action = (*action & ~CHECKOUT_ACTION__UPDATE_BLOB);
547 break;
548 default: /* impossible */
549 break;
550 }
551
552 return checkout_action_common(action, data, delta, wd);
553 }
554
checkout_action_with_wd_blocker(int * action,checkout_data * data,const git_diff_delta * delta,const git_index_entry * wd)555 static int checkout_action_with_wd_blocker(
556 int *action,
557 checkout_data *data,
558 const git_diff_delta *delta,
559 const git_index_entry *wd)
560 {
561 *action = CHECKOUT_ACTION__NONE;
562
563 switch (delta->status) {
564 case GIT_DELTA_UNMODIFIED:
565 /* should show delta as dirty / deleted */
566 GIT_ERROR_CHECK_ERROR(
567 checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, wd) );
568 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
569 break;
570 case GIT_DELTA_ADDED:
571 case GIT_DELTA_MODIFIED:
572 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
573 break;
574 case GIT_DELTA_DELETED:
575 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE, CONFLICT);
576 break;
577 case GIT_DELTA_TYPECHANGE:
578 /* not 100% certain about this... */
579 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
580 break;
581 default: /* impossible */
582 break;
583 }
584
585 return checkout_action_common(action, data, delta, wd);
586 }
587
checkout_action_with_wd_dir(int * action,checkout_data * data,const git_diff_delta * delta,git_iterator * workdir,const git_index_entry * wd)588 static int checkout_action_with_wd_dir(
589 int *action,
590 checkout_data *data,
591 const git_diff_delta *delta,
592 git_iterator *workdir,
593 const git_index_entry *wd)
594 {
595 *action = CHECKOUT_ACTION__NONE;
596
597 switch (delta->status) {
598 case GIT_DELTA_UNMODIFIED: /* case 19 or 24 (or 34 but not really) */
599 GIT_ERROR_CHECK_ERROR(
600 checkout_notify(data, GIT_CHECKOUT_NOTIFY_DIRTY, delta, NULL));
601 GIT_ERROR_CHECK_ERROR(
602 checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
603 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, NONE);
604 break;
605 case GIT_DELTA_ADDED:/* case 4 (and 7 for dir) */
606 case GIT_DELTA_MODIFIED: /* case 20 (or 37 but not really) */
607 if (delta->old_file.mode == GIT_FILEMODE_COMMIT)
608 /* expected submodule (and maybe found one) */;
609 else if (delta->new_file.mode != GIT_FILEMODE_TREE)
610 *action = git_iterator_current_is_ignored(workdir) ?
611 CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED, CONFLICT, REMOVE_AND_UPDATE) :
612 CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
613 break;
614 case GIT_DELTA_DELETED: /* case 11 (and 27 for dir) */
615 if (delta->old_file.mode != GIT_FILEMODE_TREE)
616 GIT_ERROR_CHECK_ERROR(
617 checkout_notify(data, GIT_CHECKOUT_NOTIFY_UNTRACKED, NULL, wd));
618 break;
619 case GIT_DELTA_TYPECHANGE: /* case 24 or 31 */
620 if (delta->old_file.mode == GIT_FILEMODE_TREE) {
621 /* For typechange from dir, remove dir and add blob, but it is
622 * not safe to remove dir if it contains modified files.
623 * However, safely removing child files will remove the parent
624 * directory if is it left empty, so we can defer removing the
625 * dir and it will succeed if no children are left.
626 */
627 *action = CHECKOUT_ACTION_IF(SAFE, UPDATE_BLOB, NONE);
628 }
629 else if (delta->new_file.mode != GIT_FILEMODE_TREE)
630 /* For typechange to dir, dir is already created so no action */
631 *action = CHECKOUT_ACTION_IF(FORCE, REMOVE_AND_UPDATE, CONFLICT);
632 break;
633 default: /* impossible */
634 break;
635 }
636
637 return checkout_action_common(action, data, delta, wd);
638 }
639
checkout_action_with_wd_dir_empty(int * action,checkout_data * data,const git_diff_delta * delta)640 static int checkout_action_with_wd_dir_empty(
641 int *action,
642 checkout_data *data,
643 const git_diff_delta *delta)
644 {
645 int error = checkout_action_no_wd(action, data, delta);
646
647 /* We can always safely remove an empty directory. */
648 if (error == 0 && *action != CHECKOUT_ACTION__NONE)
649 *action |= CHECKOUT_ACTION__REMOVE;
650
651 return error;
652 }
653
checkout_action(int * action,checkout_data * data,git_diff_delta * delta,git_iterator * workdir,const git_index_entry ** wditem,git_vector * pathspec)654 static int checkout_action(
655 int *action,
656 checkout_data *data,
657 git_diff_delta *delta,
658 git_iterator *workdir,
659 const git_index_entry **wditem,
660 git_vector *pathspec)
661 {
662 int cmp = -1, error;
663 int (*strcomp)(const char *, const char *) = data->diff->strcomp;
664 int (*pfxcomp)(const char *str, const char *pfx) = data->diff->pfxcomp;
665 int (*advance)(const git_index_entry **, git_iterator *) = NULL;
666
667 /* move workdir iterator to follow along with deltas */
668
669 while (1) {
670 const git_index_entry *wd = *wditem;
671
672 if (!wd)
673 return checkout_action_no_wd(action, data, delta);
674
675 cmp = strcomp(wd->path, delta->old_file.path);
676
677 /* 1. wd before delta ("a/a" before "a/b")
678 * 2. wd prefixes delta & should expand ("a/" before "a/b")
679 * 3. wd prefixes delta & cannot expand ("a/b" before "a/b/c")
680 * 4. wd equals delta ("a/b" and "a/b")
681 * 5. wd after delta & delta prefixes wd ("a/b/c" after "a/b/" or "a/b")
682 * 6. wd after delta ("a/c" after "a/b")
683 */
684
685 if (cmp < 0) {
686 cmp = pfxcomp(delta->old_file.path, wd->path);
687
688 if (cmp == 0) {
689 if (wd->mode == GIT_FILEMODE_TREE) {
690 /* case 2 - entry prefixed by workdir tree */
691 error = git_iterator_advance_into(wditem, workdir);
692 if (error < 0 && error != GIT_ITEROVER)
693 goto done;
694 continue;
695 }
696
697 /* case 3 maybe - wd contains non-dir where dir expected */
698 if (delta->old_file.path[strlen(wd->path)] == '/') {
699 error = checkout_action_with_wd_blocker(
700 action, data, delta, wd);
701 advance = git_iterator_advance;
702 goto done;
703 }
704 }
705
706 /* case 1 - handle wd item (if it matches pathspec) */
707 error = checkout_action_wd_only(data, workdir, wditem, pathspec);
708 if (error && error != GIT_ITEROVER)
709 goto done;
710 continue;
711 }
712
713 if (cmp == 0) {
714 /* case 4 */
715 error = checkout_action_with_wd(action, data, delta, workdir, wd);
716 advance = git_iterator_advance;
717 goto done;
718 }
719
720 cmp = pfxcomp(wd->path, delta->old_file.path);
721
722 if (cmp == 0) { /* case 5 */
723 if (wd->path[strlen(delta->old_file.path)] != '/')
724 return checkout_action_no_wd(action, data, delta);
725
726 if (delta->status == GIT_DELTA_TYPECHANGE) {
727 if (delta->old_file.mode == GIT_FILEMODE_TREE) {
728 error = checkout_action_with_wd(action, data, delta, workdir, wd);
729 advance = git_iterator_advance_into;
730 goto done;
731 }
732
733 if (delta->new_file.mode == GIT_FILEMODE_TREE ||
734 delta->new_file.mode == GIT_FILEMODE_COMMIT ||
735 delta->old_file.mode == GIT_FILEMODE_COMMIT)
736 {
737 error = checkout_action_with_wd(action, data, delta, workdir, wd);
738 advance = git_iterator_advance;
739 goto done;
740 }
741 }
742
743 return checkout_is_empty_dir(data, wd->path) ?
744 checkout_action_with_wd_dir_empty(action, data, delta) :
745 checkout_action_with_wd_dir(action, data, delta, workdir, wd);
746 }
747
748 /* case 6 - wd is after delta */
749 return checkout_action_no_wd(action, data, delta);
750 }
751
752 done:
753 if (!error && advance != NULL &&
754 (error = advance(wditem, workdir)) < 0) {
755 *wditem = NULL;
756 if (error == GIT_ITEROVER)
757 error = 0;
758 }
759
760 return error;
761 }
762
checkout_remaining_wd_items(checkout_data * data,git_iterator * workdir,const git_index_entry * wd,git_vector * spec)763 static int checkout_remaining_wd_items(
764 checkout_data *data,
765 git_iterator *workdir,
766 const git_index_entry *wd,
767 git_vector *spec)
768 {
769 int error = 0;
770
771 while (wd && !error)
772 error = checkout_action_wd_only(data, workdir, &wd, spec);
773
774 if (error == GIT_ITEROVER)
775 error = 0;
776
777 return error;
778 }
779
checkout_idxentry_cmp(const git_index_entry * a,const git_index_entry * b)780 GIT_INLINE(int) checkout_idxentry_cmp(
781 const git_index_entry *a,
782 const git_index_entry *b)
783 {
784 if (!a && !b)
785 return 0;
786 else if (!a && b)
787 return -1;
788 else if(a && !b)
789 return 1;
790 else
791 return strcmp(a->path, b->path);
792 }
793
checkout_conflictdata_cmp(const void * a,const void * b)794 static int checkout_conflictdata_cmp(const void *a, const void *b)
795 {
796 const checkout_conflictdata *ca = a;
797 const checkout_conflictdata *cb = b;
798 int diff;
799
800 if ((diff = checkout_idxentry_cmp(ca->ancestor, cb->ancestor)) == 0 &&
801 (diff = checkout_idxentry_cmp(ca->ours, cb->theirs)) == 0)
802 diff = checkout_idxentry_cmp(ca->theirs, cb->theirs);
803
804 return diff;
805 }
806
checkout_conflictdata_empty(const git_vector * conflicts,size_t idx,void * payload)807 static int checkout_conflictdata_empty(
808 const git_vector *conflicts, size_t idx, void *payload)
809 {
810 checkout_conflictdata *conflict;
811
812 GIT_UNUSED(payload);
813
814 if ((conflict = git_vector_get(conflicts, idx)) == NULL)
815 return -1;
816
817 if (conflict->ancestor || conflict->ours || conflict->theirs)
818 return 0;
819
820 git__free(conflict);
821 return 1;
822 }
823
conflict_pathspec_match(checkout_data * data,git_iterator * workdir,git_vector * pathspec,const git_index_entry * ancestor,const git_index_entry * ours,const git_index_entry * theirs)824 GIT_INLINE(bool) conflict_pathspec_match(
825 checkout_data *data,
826 git_iterator *workdir,
827 git_vector *pathspec,
828 const git_index_entry *ancestor,
829 const git_index_entry *ours,
830 const git_index_entry *theirs)
831 {
832 /* if the pathspec matches ours *or* theirs, proceed */
833 if (ours && git_pathspec__match(pathspec, ours->path,
834 (data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
835 git_iterator_ignore_case(workdir), NULL, NULL))
836 return true;
837
838 if (theirs && git_pathspec__match(pathspec, theirs->path,
839 (data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
840 git_iterator_ignore_case(workdir), NULL, NULL))
841 return true;
842
843 if (ancestor && git_pathspec__match(pathspec, ancestor->path,
844 (data->strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH) != 0,
845 git_iterator_ignore_case(workdir), NULL, NULL))
846 return true;
847
848 return false;
849 }
850
checkout_conflict_detect_submodule(checkout_conflictdata * conflict)851 GIT_INLINE(int) checkout_conflict_detect_submodule(checkout_conflictdata *conflict)
852 {
853 conflict->submodule = ((conflict->ancestor && S_ISGITLINK(conflict->ancestor->mode)) ||
854 (conflict->ours && S_ISGITLINK(conflict->ours->mode)) ||
855 (conflict->theirs && S_ISGITLINK(conflict->theirs->mode)));
856 return 0;
857 }
858
checkout_conflict_detect_binary(git_repository * repo,checkout_conflictdata * conflict)859 GIT_INLINE(int) checkout_conflict_detect_binary(git_repository *repo, checkout_conflictdata *conflict)
860 {
861 git_blob *ancestor_blob = NULL, *our_blob = NULL, *their_blob = NULL;
862 int error = 0;
863
864 if (conflict->submodule)
865 return 0;
866
867 if (conflict->ancestor) {
868 if ((error = git_blob_lookup(&ancestor_blob, repo, &conflict->ancestor->id)) < 0)
869 goto done;
870
871 conflict->binary = git_blob_is_binary(ancestor_blob);
872 }
873
874 if (!conflict->binary && conflict->ours) {
875 if ((error = git_blob_lookup(&our_blob, repo, &conflict->ours->id)) < 0)
876 goto done;
877
878 conflict->binary = git_blob_is_binary(our_blob);
879 }
880
881 if (!conflict->binary && conflict->theirs) {
882 if ((error = git_blob_lookup(&their_blob, repo, &conflict->theirs->id)) < 0)
883 goto done;
884
885 conflict->binary = git_blob_is_binary(their_blob);
886 }
887
888 done:
889 git_blob_free(ancestor_blob);
890 git_blob_free(our_blob);
891 git_blob_free(their_blob);
892
893 return error;
894 }
895
checkout_conflict_append_update(const git_index_entry * ancestor,const git_index_entry * ours,const git_index_entry * theirs,void * payload)896 static int checkout_conflict_append_update(
897 const git_index_entry *ancestor,
898 const git_index_entry *ours,
899 const git_index_entry *theirs,
900 void *payload)
901 {
902 checkout_data *data = payload;
903 checkout_conflictdata *conflict;
904 int error;
905
906 conflict = git__calloc(1, sizeof(checkout_conflictdata));
907 GIT_ERROR_CHECK_ALLOC(conflict);
908
909 conflict->ancestor = ancestor;
910 conflict->ours = ours;
911 conflict->theirs = theirs;
912
913 if ((error = checkout_conflict_detect_submodule(conflict)) < 0 ||
914 (error = checkout_conflict_detect_binary(data->repo, conflict)) < 0)
915 {
916 git__free(conflict);
917 return error;
918 }
919
920 if (git_vector_insert(&data->update_conflicts, conflict))
921 return -1;
922
923 return 0;
924 }
925
checkout_conflicts_foreach(checkout_data * data,git_index * index,git_iterator * workdir,git_vector * pathspec,int (* cb)(const git_index_entry *,const git_index_entry *,const git_index_entry *,void *),void * payload)926 static int checkout_conflicts_foreach(
927 checkout_data *data,
928 git_index *index,
929 git_iterator *workdir,
930 git_vector *pathspec,
931 int (*cb)(const git_index_entry *, const git_index_entry *, const git_index_entry *, void *),
932 void *payload)
933 {
934 git_index_conflict_iterator *iterator = NULL;
935 const git_index_entry *ancestor, *ours, *theirs;
936 int error = 0;
937
938 if ((error = git_index_conflict_iterator_new(&iterator, index)) < 0)
939 goto done;
940
941 /* Collect the conflicts */
942 while ((error = git_index_conflict_next(&ancestor, &ours, &theirs, iterator)) == 0) {
943 if (!conflict_pathspec_match(data, workdir, pathspec, ancestor, ours, theirs))
944 continue;
945
946 if ((error = cb(ancestor, ours, theirs, payload)) < 0)
947 goto done;
948 }
949
950 if (error == GIT_ITEROVER)
951 error = 0;
952
953 done:
954 git_index_conflict_iterator_free(iterator);
955
956 return error;
957 }
958
checkout_conflicts_load(checkout_data * data,git_iterator * workdir,git_vector * pathspec)959 static int checkout_conflicts_load(checkout_data *data, git_iterator *workdir, git_vector *pathspec)
960 {
961 git_index *index;
962
963 /* Only write conficts from sources that have them: indexes. */
964 if ((index = git_iterator_index(data->target)) == NULL)
965 return 0;
966
967 data->update_conflicts._cmp = checkout_conflictdata_cmp;
968
969 if (checkout_conflicts_foreach(data, index, workdir, pathspec, checkout_conflict_append_update, data) < 0)
970 return -1;
971
972 /* Collect the REUC and NAME entries */
973 data->update_reuc = &index->reuc;
974 data->update_names = &index->names;
975
976 return 0;
977 }
978
checkout_conflicts_cmp_entry(const char * path,const git_index_entry * entry)979 GIT_INLINE(int) checkout_conflicts_cmp_entry(
980 const char *path,
981 const git_index_entry *entry)
982 {
983 return strcmp((const char *)path, entry->path);
984 }
985
checkout_conflicts_cmp_ancestor(const void * p,const void * c)986 static int checkout_conflicts_cmp_ancestor(const void *p, const void *c)
987 {
988 const char *path = p;
989 const checkout_conflictdata *conflict = c;
990
991 if (!conflict->ancestor)
992 return 1;
993
994 return checkout_conflicts_cmp_entry(path, conflict->ancestor);
995 }
996
checkout_conflicts_search_ancestor(checkout_data * data,const char * path)997 static checkout_conflictdata *checkout_conflicts_search_ancestor(
998 checkout_data *data,
999 const char *path)
1000 {
1001 size_t pos;
1002
1003 if (git_vector_bsearch2(&pos, &data->update_conflicts, checkout_conflicts_cmp_ancestor, path) < 0)
1004 return NULL;
1005
1006 return git_vector_get(&data->update_conflicts, pos);
1007 }
1008
checkout_conflicts_search_branch(checkout_data * data,const char * path)1009 static checkout_conflictdata *checkout_conflicts_search_branch(
1010 checkout_data *data,
1011 const char *path)
1012 {
1013 checkout_conflictdata *conflict;
1014 size_t i;
1015
1016 git_vector_foreach(&data->update_conflicts, i, conflict) {
1017 int cmp = -1;
1018
1019 if (conflict->ancestor)
1020 break;
1021
1022 if (conflict->ours)
1023 cmp = checkout_conflicts_cmp_entry(path, conflict->ours);
1024 else if (conflict->theirs)
1025 cmp = checkout_conflicts_cmp_entry(path, conflict->theirs);
1026
1027 if (cmp == 0)
1028 return conflict;
1029 }
1030
1031 return NULL;
1032 }
1033
checkout_conflicts_load_byname_entry(checkout_conflictdata ** ancestor_out,checkout_conflictdata ** ours_out,checkout_conflictdata ** theirs_out,checkout_data * data,const git_index_name_entry * name_entry)1034 static int checkout_conflicts_load_byname_entry(
1035 checkout_conflictdata **ancestor_out,
1036 checkout_conflictdata **ours_out,
1037 checkout_conflictdata **theirs_out,
1038 checkout_data *data,
1039 const git_index_name_entry *name_entry)
1040 {
1041 checkout_conflictdata *ancestor, *ours = NULL, *theirs = NULL;
1042 int error = 0;
1043
1044 *ancestor_out = NULL;
1045 *ours_out = NULL;
1046 *theirs_out = NULL;
1047
1048 if (!name_entry->ancestor) {
1049 git_error_set(GIT_ERROR_INDEX, "a NAME entry exists without an ancestor");
1050 error = -1;
1051 goto done;
1052 }
1053
1054 if (!name_entry->ours && !name_entry->theirs) {
1055 git_error_set(GIT_ERROR_INDEX, "a NAME entry exists without an ours or theirs");
1056 error = -1;
1057 goto done;
1058 }
1059
1060 if ((ancestor = checkout_conflicts_search_ancestor(data,
1061 name_entry->ancestor)) == NULL) {
1062 git_error_set(GIT_ERROR_INDEX,
1063 "a NAME entry referenced ancestor entry '%s' which does not exist in the main index",
1064 name_entry->ancestor);
1065 error = -1;
1066 goto done;
1067 }
1068
1069 if (name_entry->ours) {
1070 if (strcmp(name_entry->ancestor, name_entry->ours) == 0)
1071 ours = ancestor;
1072 else if ((ours = checkout_conflicts_search_branch(data, name_entry->ours)) == NULL ||
1073 ours->ours == NULL) {
1074 git_error_set(GIT_ERROR_INDEX,
1075 "a NAME entry referenced our entry '%s' which does not exist in the main index",
1076 name_entry->ours);
1077 error = -1;
1078 goto done;
1079 }
1080 }
1081
1082 if (name_entry->theirs) {
1083 if (strcmp(name_entry->ancestor, name_entry->theirs) == 0)
1084 theirs = ancestor;
1085 else if (name_entry->ours && strcmp(name_entry->ours, name_entry->theirs) == 0)
1086 theirs = ours;
1087 else if ((theirs = checkout_conflicts_search_branch(data, name_entry->theirs)) == NULL ||
1088 theirs->theirs == NULL) {
1089 git_error_set(GIT_ERROR_INDEX,
1090 "a NAME entry referenced their entry '%s' which does not exist in the main index",
1091 name_entry->theirs);
1092 error = -1;
1093 goto done;
1094 }
1095 }
1096
1097 *ancestor_out = ancestor;
1098 *ours_out = ours;
1099 *theirs_out = theirs;
1100
1101 done:
1102 return error;
1103 }
1104
checkout_conflicts_coalesce_renames(checkout_data * data)1105 static int checkout_conflicts_coalesce_renames(
1106 checkout_data *data)
1107 {
1108 git_index *index;
1109 const git_index_name_entry *name_entry;
1110 checkout_conflictdata *ancestor_conflict, *our_conflict, *their_conflict;
1111 size_t i, names;
1112 int error = 0;
1113
1114 if ((index = git_iterator_index(data->target)) == NULL)
1115 return 0;
1116
1117 /* Juggle entries based on renames */
1118 names = git_index_name_entrycount(index);
1119
1120 for (i = 0; i < names; i++) {
1121 name_entry = git_index_name_get_byindex(index, i);
1122
1123 if ((error = checkout_conflicts_load_byname_entry(
1124 &ancestor_conflict, &our_conflict, &their_conflict,
1125 data, name_entry)) < 0)
1126 goto done;
1127
1128 if (our_conflict && our_conflict != ancestor_conflict) {
1129 ancestor_conflict->ours = our_conflict->ours;
1130 our_conflict->ours = NULL;
1131
1132 if (our_conflict->theirs)
1133 our_conflict->name_collision = 1;
1134
1135 if (our_conflict->name_collision)
1136 ancestor_conflict->name_collision = 1;
1137 }
1138
1139 if (their_conflict && their_conflict != ancestor_conflict) {
1140 ancestor_conflict->theirs = their_conflict->theirs;
1141 their_conflict->theirs = NULL;
1142
1143 if (their_conflict->ours)
1144 their_conflict->name_collision = 1;
1145
1146 if (their_conflict->name_collision)
1147 ancestor_conflict->name_collision = 1;
1148 }
1149
1150 if (our_conflict && our_conflict != ancestor_conflict &&
1151 their_conflict && their_conflict != ancestor_conflict)
1152 ancestor_conflict->one_to_two = 1;
1153 }
1154
1155 git_vector_remove_matching(
1156 &data->update_conflicts, checkout_conflictdata_empty, NULL);
1157
1158 done:
1159 return error;
1160 }
1161
checkout_conflicts_mark_directoryfile(checkout_data * data)1162 static int checkout_conflicts_mark_directoryfile(
1163 checkout_data *data)
1164 {
1165 git_index *index;
1166 checkout_conflictdata *conflict;
1167 const git_index_entry *entry;
1168 size_t i, j, len;
1169 const char *path;
1170 int prefixed, error = 0;
1171
1172 if ((index = git_iterator_index(data->target)) == NULL)
1173 return 0;
1174
1175 len = git_index_entrycount(index);
1176
1177 /* Find d/f conflicts */
1178 git_vector_foreach(&data->update_conflicts, i, conflict) {
1179 if ((conflict->ours && conflict->theirs) ||
1180 (!conflict->ours && !conflict->theirs))
1181 continue;
1182
1183 path = conflict->ours ?
1184 conflict->ours->path : conflict->theirs->path;
1185
1186 if ((error = git_index_find(&j, index, path)) < 0) {
1187 if (error == GIT_ENOTFOUND)
1188 git_error_set(GIT_ERROR_INDEX,
1189 "index inconsistency, could not find entry for expected conflict '%s'", path);
1190
1191 goto done;
1192 }
1193
1194 for (; j < len; j++) {
1195 if ((entry = git_index_get_byindex(index, j)) == NULL) {
1196 git_error_set(GIT_ERROR_INDEX,
1197 "index inconsistency, truncated index while loading expected conflict '%s'", path);
1198 error = -1;
1199 goto done;
1200 }
1201
1202 prefixed = git_path_equal_or_prefixed(path, entry->path, NULL);
1203
1204 if (prefixed == GIT_PATH_EQUAL)
1205 continue;
1206
1207 if (prefixed == GIT_PATH_PREFIX)
1208 conflict->directoryfile = 1;
1209
1210 break;
1211 }
1212 }
1213
1214 done:
1215 return error;
1216 }
1217
checkout_get_update_conflicts(checkout_data * data,git_iterator * workdir,git_vector * pathspec)1218 static int checkout_get_update_conflicts(
1219 checkout_data *data,
1220 git_iterator *workdir,
1221 git_vector *pathspec)
1222 {
1223 int error = 0;
1224
1225 if (data->strategy & GIT_CHECKOUT_SKIP_UNMERGED)
1226 return 0;
1227
1228 if ((error = checkout_conflicts_load(data, workdir, pathspec)) < 0 ||
1229 (error = checkout_conflicts_coalesce_renames(data)) < 0 ||
1230 (error = checkout_conflicts_mark_directoryfile(data)) < 0)
1231 goto done;
1232
1233 done:
1234 return error;
1235 }
1236
checkout_conflict_append_remove(const git_index_entry * ancestor,const git_index_entry * ours,const git_index_entry * theirs,void * payload)1237 static int checkout_conflict_append_remove(
1238 const git_index_entry *ancestor,
1239 const git_index_entry *ours,
1240 const git_index_entry *theirs,
1241 void *payload)
1242 {
1243 checkout_data *data = payload;
1244 const char *name;
1245
1246 GIT_ASSERT_ARG(ancestor || ours || theirs);
1247
1248 if (ancestor)
1249 name = git__strdup(ancestor->path);
1250 else if (ours)
1251 name = git__strdup(ours->path);
1252 else if (theirs)
1253 name = git__strdup(theirs->path);
1254 else
1255 abort();
1256
1257 GIT_ERROR_CHECK_ALLOC(name);
1258
1259 return git_vector_insert(&data->remove_conflicts, (char *)name);
1260 }
1261
checkout_get_remove_conflicts(checkout_data * data,git_iterator * workdir,git_vector * pathspec)1262 static int checkout_get_remove_conflicts(
1263 checkout_data *data,
1264 git_iterator *workdir,
1265 git_vector *pathspec)
1266 {
1267 if ((data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) != 0)
1268 return 0;
1269
1270 return checkout_conflicts_foreach(data, data->index, workdir, pathspec, checkout_conflict_append_remove, data);
1271 }
1272
checkout_verify_paths(git_repository * repo,int action,git_diff_delta * delta)1273 static int checkout_verify_paths(
1274 git_repository *repo,
1275 int action,
1276 git_diff_delta *delta)
1277 {
1278 unsigned int flags = GIT_PATH_REJECT_WORKDIR_DEFAULTS;
1279
1280 if (action & CHECKOUT_ACTION__REMOVE) {
1281 if (!git_path_isvalid(repo, delta->old_file.path, delta->old_file.mode, flags)) {
1282 git_error_set(GIT_ERROR_CHECKOUT, "cannot remove invalid path '%s'", delta->old_file.path);
1283 return -1;
1284 }
1285 }
1286
1287 if (action & ~CHECKOUT_ACTION__REMOVE) {
1288 if (!git_path_isvalid(repo, delta->new_file.path, delta->new_file.mode, flags)) {
1289 git_error_set(GIT_ERROR_CHECKOUT, "cannot checkout to invalid path '%s'", delta->new_file.path);
1290 return -1;
1291 }
1292 }
1293
1294 return 0;
1295 }
1296
checkout_get_actions(uint32_t ** actions_ptr,size_t ** counts_ptr,checkout_data * data,git_iterator * workdir)1297 static int checkout_get_actions(
1298 uint32_t **actions_ptr,
1299 size_t **counts_ptr,
1300 checkout_data *data,
1301 git_iterator *workdir)
1302 {
1303 int error = 0, act;
1304 const git_index_entry *wditem;
1305 git_vector pathspec = GIT_VECTOR_INIT, *deltas;
1306 git_pool pathpool;
1307 git_diff_delta *delta;
1308 size_t i, *counts = NULL;
1309 uint32_t *actions = NULL;
1310
1311 if (git_pool_init(&pathpool, 1) < 0)
1312 return -1;
1313
1314 if (data->opts.paths.count > 0 &&
1315 git_pathspec__vinit(&pathspec, &data->opts.paths, &pathpool) < 0)
1316 return -1;
1317
1318 if ((error = git_iterator_current(&wditem, workdir)) < 0 &&
1319 error != GIT_ITEROVER)
1320 goto fail;
1321
1322 deltas = &data->diff->deltas;
1323
1324 *counts_ptr = counts = git__calloc(CHECKOUT_ACTION__MAX+1, sizeof(size_t));
1325 *actions_ptr = actions = git__calloc(
1326 deltas->length ? deltas->length : 1, sizeof(uint32_t));
1327 if (!counts || !actions) {
1328 error = -1;
1329 goto fail;
1330 }
1331
1332 git_vector_foreach(deltas, i, delta) {
1333 if ((error = checkout_action(&act, data, delta, workdir, &wditem, &pathspec)) == 0)
1334 error = checkout_verify_paths(data->repo, act, delta);
1335
1336 if (error != 0)
1337 goto fail;
1338
1339 actions[i] = act;
1340
1341 if (act & CHECKOUT_ACTION__REMOVE)
1342 counts[CHECKOUT_ACTION__REMOVE]++;
1343 if (act & CHECKOUT_ACTION__UPDATE_BLOB)
1344 counts[CHECKOUT_ACTION__UPDATE_BLOB]++;
1345 if (act & CHECKOUT_ACTION__UPDATE_SUBMODULE)
1346 counts[CHECKOUT_ACTION__UPDATE_SUBMODULE]++;
1347 if (act & CHECKOUT_ACTION__CONFLICT)
1348 counts[CHECKOUT_ACTION__CONFLICT]++;
1349 }
1350
1351 error = checkout_remaining_wd_items(data, workdir, wditem, &pathspec);
1352 if (error)
1353 goto fail;
1354
1355 counts[CHECKOUT_ACTION__REMOVE] += data->removes.length;
1356
1357 if (counts[CHECKOUT_ACTION__CONFLICT] > 0 &&
1358 (data->strategy & GIT_CHECKOUT_ALLOW_CONFLICTS) == 0) {
1359 git_error_set(GIT_ERROR_CHECKOUT, "%"PRIuZ" %s checkout",
1360 counts[CHECKOUT_ACTION__CONFLICT],
1361 counts[CHECKOUT_ACTION__CONFLICT] == 1 ?
1362 "conflict prevents" : "conflicts prevent");
1363 error = GIT_ECONFLICT;
1364 goto fail;
1365 }
1366
1367
1368 if ((error = checkout_get_remove_conflicts(data, workdir, &pathspec)) < 0 ||
1369 (error = checkout_get_update_conflicts(data, workdir, &pathspec)) < 0)
1370 goto fail;
1371
1372 counts[CHECKOUT_ACTION__REMOVE_CONFLICT] = git_vector_length(&data->remove_conflicts);
1373 counts[CHECKOUT_ACTION__UPDATE_CONFLICT] = git_vector_length(&data->update_conflicts);
1374
1375 git_pathspec__vfree(&pathspec);
1376 git_pool_clear(&pathpool);
1377
1378 return 0;
1379
1380 fail:
1381 *counts_ptr = NULL;
1382 git__free(counts);
1383 *actions_ptr = NULL;
1384 git__free(actions);
1385
1386 git_pathspec__vfree(&pathspec);
1387 git_pool_clear(&pathpool);
1388
1389 return error;
1390 }
1391
should_remove_existing(checkout_data * data)1392 static bool should_remove_existing(checkout_data *data)
1393 {
1394 int ignorecase;
1395
1396 if (git_repository__configmap_lookup(&ignorecase, data->repo, GIT_CONFIGMAP_IGNORECASE) < 0) {
1397 ignorecase = 0;
1398 }
1399
1400 return (ignorecase &&
1401 (data->strategy & GIT_CHECKOUT_DONT_REMOVE_EXISTING) == 0);
1402 }
1403
1404 #define MKDIR_NORMAL \
1405 GIT_MKDIR_PATH | GIT_MKDIR_VERIFY_DIR
1406 #define MKDIR_REMOVE_EXISTING \
1407 MKDIR_NORMAL | GIT_MKDIR_REMOVE_FILES | GIT_MKDIR_REMOVE_SYMLINKS
1408
checkout_mkdir(checkout_data * data,const char * path,const char * base,mode_t mode,unsigned int flags)1409 static int checkout_mkdir(
1410 checkout_data *data,
1411 const char *path,
1412 const char *base,
1413 mode_t mode,
1414 unsigned int flags)
1415 {
1416 struct git_futils_mkdir_options mkdir_opts = {0};
1417 int error;
1418
1419 mkdir_opts.dir_map = data->mkdir_map;
1420 mkdir_opts.pool = &data->pool;
1421
1422 error = git_futils_mkdir_relative(
1423 path, base, mode, flags, &mkdir_opts);
1424
1425 data->perfdata.mkdir_calls += mkdir_opts.perfdata.mkdir_calls;
1426 data->perfdata.stat_calls += mkdir_opts.perfdata.stat_calls;
1427 data->perfdata.chmod_calls += mkdir_opts.perfdata.chmod_calls;
1428
1429 return error;
1430 }
1431
mkpath2file(checkout_data * data,const char * path,unsigned int mode)1432 static int mkpath2file(
1433 checkout_data *data, const char *path, unsigned int mode)
1434 {
1435 struct stat st;
1436 bool remove_existing = should_remove_existing(data);
1437 unsigned int flags =
1438 (remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL) |
1439 GIT_MKDIR_SKIP_LAST;
1440 int error;
1441
1442 if ((error = checkout_mkdir(
1443 data, path, data->opts.target_directory, mode, flags)) < 0)
1444 return error;
1445
1446 if (remove_existing) {
1447 data->perfdata.stat_calls++;
1448
1449 if (p_lstat(path, &st) == 0) {
1450
1451 /* Some file, symlink or folder already exists at this name.
1452 * We would have removed it in remove_the_old unless we're on
1453 * a case inensitive filesystem (or the user has asked us not
1454 * to). Remove the similarly named file to write the new.
1455 */
1456 error = git_futils_rmdir_r(path, NULL, GIT_RMDIR_REMOVE_FILES);
1457 } else if (errno != ENOENT) {
1458 git_error_set(GIT_ERROR_OS, "failed to stat '%s'", path);
1459 return GIT_EEXISTS;
1460 } else {
1461 git_error_clear();
1462 }
1463 }
1464
1465 return error;
1466 }
1467
1468 struct checkout_stream {
1469 git_writestream base;
1470 const char *path;
1471 int fd;
1472 int open;
1473 };
1474
checkout_stream_write(git_writestream * s,const char * buffer,size_t len)1475 static int checkout_stream_write(
1476 git_writestream *s, const char *buffer, size_t len)
1477 {
1478 struct checkout_stream *stream = (struct checkout_stream *)s;
1479 int ret;
1480
1481 if ((ret = p_write(stream->fd, buffer, len)) < 0)
1482 git_error_set(GIT_ERROR_OS, "could not write to '%s'", stream->path);
1483
1484 return ret;
1485 }
1486
checkout_stream_close(git_writestream * s)1487 static int checkout_stream_close(git_writestream *s)
1488 {
1489 struct checkout_stream *stream = (struct checkout_stream *)s;
1490
1491 GIT_ASSERT_ARG(stream);
1492 GIT_ASSERT_ARG(stream->open);
1493
1494 stream->open = 0;
1495 return p_close(stream->fd);
1496 }
1497
checkout_stream_free(git_writestream * s)1498 static void checkout_stream_free(git_writestream *s)
1499 {
1500 GIT_UNUSED(s);
1501 }
1502
blob_content_to_file(checkout_data * data,struct stat * st,git_blob * blob,const char * path,const char * hint_path,mode_t entry_filemode)1503 static int blob_content_to_file(
1504 checkout_data *data,
1505 struct stat *st,
1506 git_blob *blob,
1507 const char *path,
1508 const char *hint_path,
1509 mode_t entry_filemode)
1510 {
1511 int flags = data->opts.file_open_flags;
1512 mode_t file_mode = data->opts.file_mode ?
1513 data->opts.file_mode : entry_filemode;
1514 git_filter_options filter_opts = GIT_FILTER_OPTIONS_INIT;
1515 struct checkout_stream writer;
1516 mode_t mode;
1517 git_filter_list *fl = NULL;
1518 int fd;
1519 int error = 0;
1520
1521 if (hint_path == NULL)
1522 hint_path = path;
1523
1524 if ((error = mkpath2file(data, path, data->opts.dir_mode)) < 0)
1525 return error;
1526
1527 if (flags <= 0)
1528 flags = O_CREAT | O_TRUNC | O_WRONLY;
1529 if (!(mode = file_mode))
1530 mode = GIT_FILEMODE_BLOB;
1531
1532 if ((fd = p_open(path, flags, mode)) < 0) {
1533 git_error_set(GIT_ERROR_OS, "could not open '%s' for writing", path);
1534 return fd;
1535 }
1536
1537 filter_opts.attr_session = &data->attr_session;
1538 filter_opts.temp_buf = &data->tmp;
1539
1540 if (!data->opts.disable_filters &&
1541 (error = git_filter_list__load_ext(
1542 &fl, data->repo, blob, hint_path,
1543 GIT_FILTER_TO_WORKTREE, &filter_opts))) {
1544 p_close(fd);
1545 return error;
1546 }
1547
1548 /* setup the writer */
1549 memset(&writer, 0, sizeof(struct checkout_stream));
1550 writer.base.write = checkout_stream_write;
1551 writer.base.close = checkout_stream_close;
1552 writer.base.free = checkout_stream_free;
1553 writer.path = path;
1554 writer.fd = fd;
1555 writer.open = 1;
1556
1557 error = git_filter_list_stream_blob(fl, blob, &writer.base);
1558
1559 GIT_ASSERT(writer.open == 0);
1560
1561 git_filter_list_free(fl);
1562
1563 if (error < 0)
1564 return error;
1565
1566 if (st) {
1567 data->perfdata.stat_calls++;
1568
1569 if ((error = p_stat(path, st)) < 0) {
1570 git_error_set(GIT_ERROR_OS, "failed to stat '%s'", path);
1571 return error;
1572 }
1573
1574 st->st_mode = entry_filemode;
1575 }
1576
1577 return 0;
1578 }
1579
blob_content_to_link(checkout_data * data,struct stat * st,git_blob * blob,const char * path)1580 static int blob_content_to_link(
1581 checkout_data *data,
1582 struct stat *st,
1583 git_blob *blob,
1584 const char *path)
1585 {
1586 git_buf linktarget = GIT_BUF_INIT;
1587 int error;
1588
1589 if ((error = mkpath2file(data, path, data->opts.dir_mode)) < 0)
1590 return error;
1591
1592 if ((error = git_blob__getbuf(&linktarget, blob)) < 0)
1593 return error;
1594
1595 if (data->can_symlink) {
1596 if ((error = p_symlink(git_buf_cstr(&linktarget), path)) < 0)
1597 git_error_set(GIT_ERROR_OS, "could not create symlink %s", path);
1598 } else {
1599 error = git_futils_fake_symlink(git_buf_cstr(&linktarget), path);
1600 }
1601
1602 if (!error) {
1603 data->perfdata.stat_calls++;
1604
1605 if ((error = p_lstat(path, st)) < 0)
1606 git_error_set(GIT_ERROR_CHECKOUT, "could not stat symlink %s", path);
1607
1608 st->st_mode = GIT_FILEMODE_LINK;
1609 }
1610
1611 git_buf_dispose(&linktarget);
1612
1613 return error;
1614 }
1615
checkout_update_index(checkout_data * data,const git_diff_file * file,struct stat * st)1616 static int checkout_update_index(
1617 checkout_data *data,
1618 const git_diff_file *file,
1619 struct stat *st)
1620 {
1621 git_index_entry entry;
1622
1623 if (!data->index)
1624 return 0;
1625
1626 memset(&entry, 0, sizeof(entry));
1627 entry.path = (char *)file->path; /* cast to prevent warning */
1628 git_index_entry__init_from_stat(&entry, st, true);
1629 git_oid_cpy(&entry.id, &file->id);
1630
1631 return git_index_add(data->index, &entry);
1632 }
1633
checkout_submodule_update_index(checkout_data * data,const git_diff_file * file)1634 static int checkout_submodule_update_index(
1635 checkout_data *data,
1636 const git_diff_file *file)
1637 {
1638 git_buf *fullpath;
1639 struct stat st;
1640
1641 /* update the index unless prevented */
1642 if ((data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) != 0)
1643 return 0;
1644
1645 if (checkout_target_fullpath(&fullpath, data, file->path) < 0)
1646 return -1;
1647
1648 data->perfdata.stat_calls++;
1649 if (p_stat(fullpath->ptr, &st) < 0) {
1650 git_error_set(
1651 GIT_ERROR_CHECKOUT, "could not stat submodule %s\n", file->path);
1652 return GIT_ENOTFOUND;
1653 }
1654
1655 st.st_mode = GIT_FILEMODE_COMMIT;
1656
1657 return checkout_update_index(data, file, &st);
1658 }
1659
checkout_submodule(checkout_data * data,const git_diff_file * file)1660 static int checkout_submodule(
1661 checkout_data *data,
1662 const git_diff_file *file)
1663 {
1664 bool remove_existing = should_remove_existing(data);
1665 int error = 0;
1666
1667 /* Until submodules are supported, UPDATE_ONLY means do nothing here */
1668 if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
1669 return 0;
1670
1671 if ((error = checkout_mkdir(
1672 data,
1673 file->path, data->opts.target_directory, data->opts.dir_mode,
1674 remove_existing ? MKDIR_REMOVE_EXISTING : MKDIR_NORMAL)) < 0)
1675 return error;
1676
1677 if ((error = git_submodule_lookup(NULL, data->repo, file->path)) < 0) {
1678 /* I've observed repos with submodules in the tree that do not
1679 * have a .gitmodules - core Git just makes an empty directory
1680 */
1681 if (error == GIT_ENOTFOUND) {
1682 git_error_clear();
1683 return checkout_submodule_update_index(data, file);
1684 }
1685
1686 return error;
1687 }
1688
1689 /* TODO: Support checkout_strategy options. Two circumstances:
1690 * 1 - submodule already checked out, but we need to move the HEAD
1691 * to the new OID, or
1692 * 2 - submodule not checked out and we should recursively check it out
1693 *
1694 * Checkout will not execute a pull on the submodule, but a clone
1695 * command should probably be able to. Do we need a submodule callback?
1696 */
1697
1698 return checkout_submodule_update_index(data, file);
1699 }
1700
report_progress(checkout_data * data,const char * path)1701 static void report_progress(
1702 checkout_data *data,
1703 const char *path)
1704 {
1705 if (data->opts.progress_cb)
1706 data->opts.progress_cb(
1707 path, data->completed_steps, data->total_steps,
1708 data->opts.progress_payload);
1709 }
1710
checkout_safe_for_update_only(checkout_data * data,const char * path,mode_t expected_mode)1711 static int checkout_safe_for_update_only(
1712 checkout_data *data, const char *path, mode_t expected_mode)
1713 {
1714 struct stat st;
1715
1716 data->perfdata.stat_calls++;
1717
1718 if (p_lstat(path, &st) < 0) {
1719 /* if doesn't exist, then no error and no update */
1720 if (errno == ENOENT || errno == ENOTDIR)
1721 return 0;
1722
1723 /* otherwise, stat error and no update */
1724 git_error_set(GIT_ERROR_OS, "failed to stat '%s'", path);
1725 return -1;
1726 }
1727
1728 /* only safe for update if this is the same type of file */
1729 if ((st.st_mode & ~0777) == (expected_mode & ~0777))
1730 return 1;
1731
1732 return 0;
1733 }
1734
checkout_write_content(checkout_data * data,const git_oid * oid,const char * full_path,const char * hint_path,unsigned int mode,struct stat * st)1735 static int checkout_write_content(
1736 checkout_data *data,
1737 const git_oid *oid,
1738 const char *full_path,
1739 const char *hint_path,
1740 unsigned int mode,
1741 struct stat *st)
1742 {
1743 int error = 0;
1744 git_blob *blob;
1745
1746 if ((error = git_blob_lookup(&blob, data->repo, oid)) < 0)
1747 return error;
1748
1749 if (S_ISLNK(mode))
1750 error = blob_content_to_link(data, st, blob, full_path);
1751 else
1752 error = blob_content_to_file(data, st, blob, full_path, hint_path, mode);
1753
1754 git_blob_free(blob);
1755
1756 /* if we try to create the blob and an existing directory blocks it from
1757 * being written, then there must have been a typechange conflict in a
1758 * parent directory - suppress the error and try to continue.
1759 */
1760 if ((data->strategy & GIT_CHECKOUT_ALLOW_CONFLICTS) != 0 &&
1761 (error == GIT_ENOTFOUND || error == GIT_EEXISTS))
1762 {
1763 git_error_clear();
1764 error = 0;
1765 }
1766
1767 return error;
1768 }
1769
checkout_blob(checkout_data * data,const git_diff_file * file)1770 static int checkout_blob(
1771 checkout_data *data,
1772 const git_diff_file *file)
1773 {
1774 git_buf *fullpath;
1775 struct stat st;
1776 int error = 0;
1777
1778 if (checkout_target_fullpath(&fullpath, data, file->path) < 0)
1779 return -1;
1780
1781 if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0) {
1782 int rval = checkout_safe_for_update_only(
1783 data, fullpath->ptr, file->mode);
1784
1785 if (rval <= 0)
1786 return rval;
1787 }
1788
1789 error = checkout_write_content(
1790 data, &file->id, fullpath->ptr, NULL, file->mode, &st);
1791
1792 /* update the index unless prevented */
1793 if (!error && (data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0)
1794 error = checkout_update_index(data, file, &st);
1795
1796 /* update the submodule data if this was a new .gitmodules file */
1797 if (!error && strcmp(file->path, ".gitmodules") == 0)
1798 data->reload_submodules = true;
1799
1800 return error;
1801 }
1802
checkout_remove_the_old(unsigned int * actions,checkout_data * data)1803 static int checkout_remove_the_old(
1804 unsigned int *actions,
1805 checkout_data *data)
1806 {
1807 int error = 0;
1808 git_diff_delta *delta;
1809 const char *str;
1810 size_t i;
1811 git_buf *fullpath;
1812 uint32_t flg = GIT_RMDIR_EMPTY_PARENTS |
1813 GIT_RMDIR_REMOVE_FILES | GIT_RMDIR_REMOVE_BLOCKERS;
1814
1815 if (data->opts.checkout_strategy & GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES)
1816 flg |= GIT_RMDIR_SKIP_NONEMPTY;
1817
1818 if (checkout_target_fullpath(&fullpath, data, NULL) < 0)
1819 return -1;
1820
1821 git_vector_foreach(&data->diff->deltas, i, delta) {
1822 if (actions[i] & CHECKOUT_ACTION__REMOVE) {
1823 error = git_futils_rmdir_r(
1824 delta->old_file.path, fullpath->ptr, flg);
1825
1826 if (error < 0)
1827 return error;
1828
1829 data->completed_steps++;
1830 report_progress(data, delta->old_file.path);
1831
1832 if ((actions[i] & CHECKOUT_ACTION__UPDATE_BLOB) == 0 &&
1833 (data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0 &&
1834 data->index != NULL)
1835 {
1836 (void)git_index_remove(data->index, delta->old_file.path, 0);
1837 }
1838 }
1839 }
1840
1841 git_vector_foreach(&data->removes, i, str) {
1842 error = git_futils_rmdir_r(str, fullpath->ptr, flg);
1843 if (error < 0)
1844 return error;
1845
1846 data->completed_steps++;
1847 report_progress(data, str);
1848
1849 if ((data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0 &&
1850 data->index != NULL)
1851 {
1852 if (str[strlen(str) - 1] == '/')
1853 (void)git_index_remove_directory(data->index, str, 0);
1854 else
1855 (void)git_index_remove(data->index, str, 0);
1856 }
1857 }
1858
1859 return 0;
1860 }
1861
checkout_create_the_new(unsigned int * actions,checkout_data * data)1862 static int checkout_create_the_new(
1863 unsigned int *actions,
1864 checkout_data *data)
1865 {
1866 int error = 0;
1867 git_diff_delta *delta;
1868 size_t i;
1869
1870 git_vector_foreach(&data->diff->deltas, i, delta) {
1871 if (actions[i] & CHECKOUT_ACTION__UPDATE_BLOB && !S_ISLNK(delta->new_file.mode)) {
1872 if ((error = checkout_blob(data, &delta->new_file)) < 0)
1873 return error;
1874 data->completed_steps++;
1875 report_progress(data, delta->new_file.path);
1876 }
1877 }
1878
1879 git_vector_foreach(&data->diff->deltas, i, delta) {
1880 if (actions[i] & CHECKOUT_ACTION__UPDATE_BLOB && S_ISLNK(delta->new_file.mode)) {
1881 if ((error = checkout_blob(data, &delta->new_file)) < 0)
1882 return error;
1883 data->completed_steps++;
1884 report_progress(data, delta->new_file.path);
1885 }
1886 }
1887
1888 return 0;
1889 }
1890
checkout_create_submodules(unsigned int * actions,checkout_data * data)1891 static int checkout_create_submodules(
1892 unsigned int *actions,
1893 checkout_data *data)
1894 {
1895 git_diff_delta *delta;
1896 size_t i;
1897
1898 git_vector_foreach(&data->diff->deltas, i, delta) {
1899 if (actions[i] & CHECKOUT_ACTION__UPDATE_SUBMODULE) {
1900 int error = checkout_submodule(data, &delta->new_file);
1901 if (error < 0)
1902 return error;
1903
1904 data->completed_steps++;
1905 report_progress(data, delta->new_file.path);
1906 }
1907 }
1908
1909 return 0;
1910 }
1911
checkout_lookup_head_tree(git_tree ** out,git_repository * repo)1912 static int checkout_lookup_head_tree(git_tree **out, git_repository *repo)
1913 {
1914 int error = 0;
1915 git_reference *ref = NULL;
1916 git_object *head;
1917
1918 if (!(error = git_repository_head(&ref, repo)) &&
1919 !(error = git_reference_peel(&head, ref, GIT_OBJECT_TREE)))
1920 *out = (git_tree *)head;
1921
1922 git_reference_free(ref);
1923
1924 return error;
1925 }
1926
1927
conflict_entry_name(git_buf * out,const char * side_name,const char * filename)1928 static int conflict_entry_name(
1929 git_buf *out,
1930 const char *side_name,
1931 const char *filename)
1932 {
1933 if (git_buf_puts(out, side_name) < 0 ||
1934 git_buf_putc(out, ':') < 0 ||
1935 git_buf_puts(out, filename) < 0)
1936 return -1;
1937
1938 return 0;
1939 }
1940
checkout_path_suffixed(git_buf * path,const char * suffix)1941 static int checkout_path_suffixed(git_buf *path, const char *suffix)
1942 {
1943 size_t path_len;
1944 int i = 0, error = 0;
1945
1946 if ((error = git_buf_putc(path, '~')) < 0 || (error = git_buf_puts(path, suffix)) < 0)
1947 return -1;
1948
1949 path_len = git_buf_len(path);
1950
1951 while (git_path_exists(git_buf_cstr(path)) && i < INT_MAX) {
1952 git_buf_truncate(path, path_len);
1953
1954 if ((error = git_buf_putc(path, '_')) < 0 ||
1955 (error = git_buf_printf(path, "%d", i)) < 0)
1956 return error;
1957
1958 i++;
1959 }
1960
1961 if (i == INT_MAX) {
1962 git_buf_truncate(path, path_len);
1963
1964 git_error_set(GIT_ERROR_CHECKOUT, "could not write '%s': working directory file exists", path->ptr);
1965 return GIT_EEXISTS;
1966 }
1967
1968 return 0;
1969 }
1970
checkout_write_entry(checkout_data * data,checkout_conflictdata * conflict,const git_index_entry * side)1971 static int checkout_write_entry(
1972 checkout_data *data,
1973 checkout_conflictdata *conflict,
1974 const git_index_entry *side)
1975 {
1976 const char *hint_path = NULL, *suffix;
1977 git_buf *fullpath;
1978 struct stat st;
1979 int error;
1980
1981 GIT_ASSERT(side == conflict->ours || side == conflict->theirs);
1982
1983 if (checkout_target_fullpath(&fullpath, data, side->path) < 0)
1984 return -1;
1985
1986 if ((conflict->name_collision || conflict->directoryfile) &&
1987 (data->strategy & GIT_CHECKOUT_USE_OURS) == 0 &&
1988 (data->strategy & GIT_CHECKOUT_USE_THEIRS) == 0) {
1989
1990 if (side == conflict->ours)
1991 suffix = data->opts.our_label ? data->opts.our_label :
1992 "ours";
1993 else
1994 suffix = data->opts.their_label ? data->opts.their_label :
1995 "theirs";
1996
1997 if (checkout_path_suffixed(fullpath, suffix) < 0)
1998 return -1;
1999
2000 hint_path = side->path;
2001 }
2002
2003 if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0 &&
2004 (error = checkout_safe_for_update_only(data, fullpath->ptr, side->mode)) <= 0)
2005 return error;
2006
2007 if (!S_ISGITLINK(side->mode))
2008 return checkout_write_content(data,
2009 &side->id, fullpath->ptr, hint_path, side->mode, &st);
2010
2011 return 0;
2012 }
2013
checkout_write_entries(checkout_data * data,checkout_conflictdata * conflict)2014 static int checkout_write_entries(
2015 checkout_data *data,
2016 checkout_conflictdata *conflict)
2017 {
2018 int error = 0;
2019
2020 if ((error = checkout_write_entry(data, conflict, conflict->ours)) >= 0)
2021 error = checkout_write_entry(data, conflict, conflict->theirs);
2022
2023 return error;
2024 }
2025
checkout_merge_path(git_buf * out,checkout_data * data,checkout_conflictdata * conflict,git_merge_file_result * result)2026 static int checkout_merge_path(
2027 git_buf *out,
2028 checkout_data *data,
2029 checkout_conflictdata *conflict,
2030 git_merge_file_result *result)
2031 {
2032 const char *our_label_raw, *their_label_raw, *suffix;
2033 int error = 0;
2034
2035 if ((error = git_buf_joinpath(out, git_repository_workdir(data->repo), result->path)) < 0)
2036 return error;
2037
2038 /* Most conflicts simply use the filename in the index */
2039 if (!conflict->name_collision)
2040 return 0;
2041
2042 /* Rename 2->1 conflicts need the branch name appended */
2043 our_label_raw = data->opts.our_label ? data->opts.our_label : "ours";
2044 their_label_raw = data->opts.their_label ? data->opts.their_label : "theirs";
2045 suffix = strcmp(result->path, conflict->ours->path) == 0 ? our_label_raw : their_label_raw;
2046
2047 if ((error = checkout_path_suffixed(out, suffix)) < 0)
2048 return error;
2049
2050 return 0;
2051 }
2052
checkout_write_merge(checkout_data * data,checkout_conflictdata * conflict)2053 static int checkout_write_merge(
2054 checkout_data *data,
2055 checkout_conflictdata *conflict)
2056 {
2057 git_buf our_label = GIT_BUF_INIT, their_label = GIT_BUF_INIT,
2058 path_suffixed = GIT_BUF_INIT, path_workdir = GIT_BUF_INIT,
2059 in_data = GIT_BUF_INIT, out_data = GIT_BUF_INIT;
2060 git_merge_file_options opts = GIT_MERGE_FILE_OPTIONS_INIT;
2061 git_merge_file_result result = {0};
2062 git_filebuf output = GIT_FILEBUF_INIT;
2063 git_filter_list *fl = NULL;
2064 git_filter_options filter_opts = GIT_FILTER_OPTIONS_INIT;
2065 int error = 0;
2066
2067 if (data->opts.checkout_strategy & GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)
2068 opts.flags |= GIT_MERGE_FILE_STYLE_DIFF3;
2069
2070 opts.ancestor_label = data->opts.ancestor_label ?
2071 data->opts.ancestor_label : "ancestor";
2072 opts.our_label = data->opts.our_label ?
2073 data->opts.our_label : "ours";
2074 opts.their_label = data->opts.their_label ?
2075 data->opts.their_label : "theirs";
2076
2077 /* If all the paths are identical, decorate the diff3 file with the branch
2078 * names. Otherwise, append branch_name:path.
2079 */
2080 if (conflict->ours && conflict->theirs &&
2081 strcmp(conflict->ours->path, conflict->theirs->path) != 0) {
2082
2083 if ((error = conflict_entry_name(
2084 &our_label, opts.our_label, conflict->ours->path)) < 0 ||
2085 (error = conflict_entry_name(
2086 &their_label, opts.their_label, conflict->theirs->path)) < 0)
2087 goto done;
2088
2089 opts.our_label = git_buf_cstr(&our_label);
2090 opts.their_label = git_buf_cstr(&their_label);
2091 }
2092
2093 if ((error = git_merge_file_from_index(&result, data->repo,
2094 conflict->ancestor, conflict->ours, conflict->theirs, &opts)) < 0)
2095 goto done;
2096
2097 if (result.path == NULL || result.mode == 0) {
2098 git_error_set(GIT_ERROR_CHECKOUT, "could not merge contents of file");
2099 error = GIT_ECONFLICT;
2100 goto done;
2101 }
2102
2103 if ((error = checkout_merge_path(&path_workdir, data, conflict, &result)) < 0)
2104 goto done;
2105
2106 if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0 &&
2107 (error = checkout_safe_for_update_only(data, git_buf_cstr(&path_workdir), result.mode)) <= 0)
2108 goto done;
2109
2110 if (!data->opts.disable_filters) {
2111 in_data.ptr = (char *)result.ptr;
2112 in_data.size = result.len;
2113
2114 filter_opts.attr_session = &data->attr_session;
2115 filter_opts.temp_buf = &data->tmp;
2116
2117 if ((error = git_filter_list__load_ext(
2118 &fl, data->repo, NULL, git_buf_cstr(&path_workdir),
2119 GIT_FILTER_TO_WORKTREE, &filter_opts)) < 0 ||
2120 (error = git_filter_list_apply_to_data(&out_data, fl, &in_data)) < 0)
2121 goto done;
2122 } else {
2123 out_data.ptr = (char *)result.ptr;
2124 out_data.size = result.len;
2125 }
2126
2127 if ((error = mkpath2file(data, path_workdir.ptr, data->opts.dir_mode)) < 0 ||
2128 (error = git_filebuf_open(&output, git_buf_cstr(&path_workdir), GIT_FILEBUF_DO_NOT_BUFFER, result.mode)) < 0 ||
2129 (error = git_filebuf_write(&output, out_data.ptr, out_data.size)) < 0 ||
2130 (error = git_filebuf_commit(&output)) < 0)
2131 goto done;
2132
2133 done:
2134 git_filter_list_free(fl);
2135
2136 git_buf_dispose(&out_data);
2137 git_buf_dispose(&our_label);
2138 git_buf_dispose(&their_label);
2139
2140 git_merge_file_result_free(&result);
2141 git_buf_dispose(&path_workdir);
2142 git_buf_dispose(&path_suffixed);
2143
2144 return error;
2145 }
2146
checkout_conflict_add(checkout_data * data,const git_index_entry * conflict)2147 static int checkout_conflict_add(
2148 checkout_data *data,
2149 const git_index_entry *conflict)
2150 {
2151 int error = git_index_remove(data->index, conflict->path, 0);
2152
2153 if (error == GIT_ENOTFOUND)
2154 git_error_clear();
2155 else if (error < 0)
2156 return error;
2157
2158 return git_index_add(data->index, conflict);
2159 }
2160
checkout_conflict_update_index(checkout_data * data,checkout_conflictdata * conflict)2161 static int checkout_conflict_update_index(
2162 checkout_data *data,
2163 checkout_conflictdata *conflict)
2164 {
2165 int error = 0;
2166
2167 if (conflict->ancestor)
2168 error = checkout_conflict_add(data, conflict->ancestor);
2169
2170 if (!error && conflict->ours)
2171 error = checkout_conflict_add(data, conflict->ours);
2172
2173 if (!error && conflict->theirs)
2174 error = checkout_conflict_add(data, conflict->theirs);
2175
2176 return error;
2177 }
2178
checkout_create_conflicts(checkout_data * data)2179 static int checkout_create_conflicts(checkout_data *data)
2180 {
2181 checkout_conflictdata *conflict;
2182 size_t i;
2183 int error = 0;
2184
2185 git_vector_foreach(&data->update_conflicts, i, conflict) {
2186
2187 /* Both deleted: nothing to do */
2188 if (conflict->ours == NULL && conflict->theirs == NULL)
2189 error = 0;
2190
2191 else if ((data->strategy & GIT_CHECKOUT_USE_OURS) &&
2192 conflict->ours)
2193 error = checkout_write_entry(data, conflict, conflict->ours);
2194 else if ((data->strategy & GIT_CHECKOUT_USE_THEIRS) &&
2195 conflict->theirs)
2196 error = checkout_write_entry(data, conflict, conflict->theirs);
2197
2198 /* Ignore the other side of name collisions. */
2199 else if ((data->strategy & GIT_CHECKOUT_USE_OURS) &&
2200 !conflict->ours && conflict->name_collision)
2201 error = 0;
2202 else if ((data->strategy & GIT_CHECKOUT_USE_THEIRS) &&
2203 !conflict->theirs && conflict->name_collision)
2204 error = 0;
2205
2206 /* For modify/delete, name collisions and d/f conflicts, write
2207 * the file (potentially with the name mangled.
2208 */
2209 else if (conflict->ours != NULL && conflict->theirs == NULL)
2210 error = checkout_write_entry(data, conflict, conflict->ours);
2211 else if (conflict->ours == NULL && conflict->theirs != NULL)
2212 error = checkout_write_entry(data, conflict, conflict->theirs);
2213
2214 /* Add/add conflicts and rename 1->2 conflicts, write the
2215 * ours/theirs sides (potentially name mangled).
2216 */
2217 else if (conflict->one_to_two)
2218 error = checkout_write_entries(data, conflict);
2219
2220 /* If all sides are links, write the ours side */
2221 else if (S_ISLNK(conflict->ours->mode) &&
2222 S_ISLNK(conflict->theirs->mode))
2223 error = checkout_write_entry(data, conflict, conflict->ours);
2224 /* Link/file conflicts, write the file side */
2225 else if (S_ISLNK(conflict->ours->mode))
2226 error = checkout_write_entry(data, conflict, conflict->theirs);
2227 else if (S_ISLNK(conflict->theirs->mode))
2228 error = checkout_write_entry(data, conflict, conflict->ours);
2229
2230 /* If any side is a gitlink, do nothing. */
2231 else if (conflict->submodule)
2232 error = 0;
2233
2234 /* If any side is binary, write the ours side */
2235 else if (conflict->binary)
2236 error = checkout_write_entry(data, conflict, conflict->ours);
2237
2238 else if (!error)
2239 error = checkout_write_merge(data, conflict);
2240
2241 /* Update the index extensions (REUC and NAME) if we're checking
2242 * out a different index. (Otherwise just leave them there.)
2243 */
2244 if (!error && (data->strategy & GIT_CHECKOUT_DONT_UPDATE_INDEX) == 0)
2245 error = checkout_conflict_update_index(data, conflict);
2246
2247 if (error)
2248 break;
2249
2250 data->completed_steps++;
2251 report_progress(data,
2252 conflict->ours ? conflict->ours->path :
2253 (conflict->theirs ? conflict->theirs->path : conflict->ancestor->path));
2254 }
2255
2256 return error;
2257 }
2258
checkout_remove_conflicts(checkout_data * data)2259 static int checkout_remove_conflicts(checkout_data *data)
2260 {
2261 const char *conflict;
2262 size_t i;
2263
2264 git_vector_foreach(&data->remove_conflicts, i, conflict) {
2265 if (git_index_conflict_remove(data->index, conflict) < 0)
2266 return -1;
2267
2268 data->completed_steps++;
2269 }
2270
2271 return 0;
2272 }
2273
checkout_extensions_update_index(checkout_data * data)2274 static int checkout_extensions_update_index(checkout_data *data)
2275 {
2276 const git_index_reuc_entry *reuc_entry;
2277 const git_index_name_entry *name_entry;
2278 size_t i;
2279 int error = 0;
2280
2281 if ((data->strategy & GIT_CHECKOUT_UPDATE_ONLY) != 0)
2282 return 0;
2283
2284 if (data->update_reuc) {
2285 git_vector_foreach(data->update_reuc, i, reuc_entry) {
2286 if ((error = git_index_reuc_add(data->index, reuc_entry->path,
2287 reuc_entry->mode[0], &reuc_entry->oid[0],
2288 reuc_entry->mode[1], &reuc_entry->oid[1],
2289 reuc_entry->mode[2], &reuc_entry->oid[2])) < 0)
2290 goto done;
2291 }
2292 }
2293
2294 if (data->update_names) {
2295 git_vector_foreach(data->update_names, i, name_entry) {
2296 if ((error = git_index_name_add(data->index, name_entry->ancestor,
2297 name_entry->ours, name_entry->theirs)) < 0)
2298 goto done;
2299 }
2300 }
2301
2302 done:
2303 return error;
2304 }
2305
checkout_data_clear(checkout_data * data)2306 static void checkout_data_clear(checkout_data *data)
2307 {
2308 if (data->opts_free_baseline) {
2309 git_tree_free(data->opts.baseline);
2310 data->opts.baseline = NULL;
2311 }
2312
2313 git_vector_free(&data->removes);
2314 git_pool_clear(&data->pool);
2315
2316 git_vector_free_deep(&data->remove_conflicts);
2317 git_vector_free_deep(&data->update_conflicts);
2318
2319 git__free(data->pfx);
2320 data->pfx = NULL;
2321
2322 git_buf_dispose(&data->target_path);
2323 git_buf_dispose(&data->tmp);
2324
2325 git_index_free(data->index);
2326 data->index = NULL;
2327
2328 git_strmap_free(data->mkdir_map);
2329 data->mkdir_map = NULL;
2330
2331 git_attr_session__free(&data->attr_session);
2332 }
2333
checkout_data_init(checkout_data * data,git_iterator * target,const git_checkout_options * proposed)2334 static int checkout_data_init(
2335 checkout_data *data,
2336 git_iterator *target,
2337 const git_checkout_options *proposed)
2338 {
2339 int error = 0;
2340 git_repository *repo = git_iterator_owner(target);
2341
2342 memset(data, 0, sizeof(*data));
2343
2344 if (!repo) {
2345 git_error_set(GIT_ERROR_CHECKOUT, "cannot checkout nothing");
2346 return -1;
2347 }
2348
2349 if ((!proposed || !proposed->target_directory) &&
2350 (error = git_repository__ensure_not_bare(repo, "checkout")) < 0)
2351 return error;
2352
2353 data->repo = repo;
2354 data->target = target;
2355
2356 GIT_ERROR_CHECK_VERSION(
2357 proposed, GIT_CHECKOUT_OPTIONS_VERSION, "git_checkout_options");
2358
2359 if (!proposed)
2360 GIT_INIT_STRUCTURE(&data->opts, GIT_CHECKOUT_OPTIONS_VERSION);
2361 else
2362 memmove(&data->opts, proposed, sizeof(git_checkout_options));
2363
2364 if (!data->opts.target_directory)
2365 data->opts.target_directory = git_repository_workdir(repo);
2366 else if (!git_path_isdir(data->opts.target_directory) &&
2367 (error = checkout_mkdir(data,
2368 data->opts.target_directory, NULL,
2369 GIT_DIR_MODE, GIT_MKDIR_VERIFY_DIR)) < 0)
2370 goto cleanup;
2371
2372 if ((error = git_repository_index(&data->index, data->repo)) < 0)
2373 goto cleanup;
2374
2375 /* refresh config and index content unless NO_REFRESH is given */
2376 if ((data->opts.checkout_strategy & GIT_CHECKOUT_NO_REFRESH) == 0) {
2377 git_config *cfg;
2378
2379 if ((error = git_repository_config__weakptr(&cfg, repo)) < 0)
2380 goto cleanup;
2381
2382 /* Reload the repository index (unless we're checking out the
2383 * index; then it has the changes we're trying to check out
2384 * and those should not be overwritten.)
2385 */
2386 if (data->index != git_iterator_index(target)) {
2387 if (data->opts.checkout_strategy & GIT_CHECKOUT_FORCE) {
2388 /* When forcing, we can blindly re-read the index */
2389 if ((error = git_index_read(data->index, false)) < 0)
2390 goto cleanup;
2391 } else {
2392 /*
2393 * When not being forced, we need to check for unresolved
2394 * conflicts and unsaved changes in the index before
2395 * proceeding.
2396 */
2397 if (git_index_has_conflicts(data->index)) {
2398 error = GIT_ECONFLICT;
2399 git_error_set(GIT_ERROR_CHECKOUT,
2400 "unresolved conflicts exist in the index");
2401 goto cleanup;
2402 }
2403
2404 if ((error = git_index_read_safely(data->index)) < 0)
2405 goto cleanup;
2406 }
2407
2408 /* clean conflict data in the current index */
2409 git_index_name_clear(data->index);
2410 git_index_reuc_clear(data->index);
2411 }
2412 }
2413
2414 /* if you are forcing, allow all safe updates, plus recreate missing */
2415 if ((data->opts.checkout_strategy & GIT_CHECKOUT_FORCE) != 0)
2416 data->opts.checkout_strategy |= GIT_CHECKOUT_SAFE |
2417 GIT_CHECKOUT_RECREATE_MISSING;
2418
2419 /* if the repository does not actually have an index file, then this
2420 * is an initial checkout (perhaps from clone), so we allow safe updates
2421 */
2422 if (!data->index->on_disk &&
2423 (data->opts.checkout_strategy & GIT_CHECKOUT_SAFE) != 0)
2424 data->opts.checkout_strategy |= GIT_CHECKOUT_RECREATE_MISSING;
2425
2426 data->strategy = data->opts.checkout_strategy;
2427
2428 /* opts->disable_filters is false by default */
2429
2430 if (!data->opts.dir_mode)
2431 data->opts.dir_mode = GIT_DIR_MODE;
2432
2433 if (!data->opts.file_open_flags)
2434 data->opts.file_open_flags = O_CREAT | O_TRUNC | O_WRONLY;
2435
2436 data->pfx = git_pathspec_prefix(&data->opts.paths);
2437
2438 if ((error = git_repository__configmap_lookup(
2439 &data->can_symlink, repo, GIT_CONFIGMAP_SYMLINKS)) < 0)
2440 goto cleanup;
2441
2442 if ((error = git_repository__configmap_lookup(
2443 &data->respect_filemode, repo, GIT_CONFIGMAP_FILEMODE)) < 0)
2444 goto cleanup;
2445
2446 if (!data->opts.baseline && !data->opts.baseline_index) {
2447 data->opts_free_baseline = true;
2448 error = 0;
2449
2450 /* if we don't have an index, this is an initial checkout and
2451 * should be against an empty baseline
2452 */
2453 if (data->index->on_disk)
2454 error = checkout_lookup_head_tree(&data->opts.baseline, repo);
2455
2456 if (error == GIT_EUNBORNBRANCH) {
2457 error = 0;
2458 git_error_clear();
2459 }
2460
2461 if (error < 0)
2462 goto cleanup;
2463 }
2464
2465 if ((data->opts.checkout_strategy &
2466 (GIT_CHECKOUT_CONFLICT_STYLE_MERGE | GIT_CHECKOUT_CONFLICT_STYLE_DIFF3)) == 0) {
2467 git_config_entry *conflict_style = NULL;
2468 git_config *cfg = NULL;
2469
2470 if ((error = git_repository_config__weakptr(&cfg, repo)) < 0 ||
2471 (error = git_config_get_entry(&conflict_style, cfg, "merge.conflictstyle")) < 0 ||
2472 error == GIT_ENOTFOUND)
2473 ;
2474 else if (error)
2475 goto cleanup;
2476 else if (strcmp(conflict_style->value, "merge") == 0)
2477 data->opts.checkout_strategy |= GIT_CHECKOUT_CONFLICT_STYLE_MERGE;
2478 else if (strcmp(conflict_style->value, "diff3") == 0)
2479 data->opts.checkout_strategy |= GIT_CHECKOUT_CONFLICT_STYLE_DIFF3;
2480 else {
2481 git_error_set(GIT_ERROR_CHECKOUT, "unknown style '%s' given for 'merge.conflictstyle'",
2482 conflict_style->value);
2483 error = -1;
2484 git_config_entry_free(conflict_style);
2485 goto cleanup;
2486 }
2487 git_config_entry_free(conflict_style);
2488 }
2489
2490 if ((error = git_pool_init(&data->pool, 1)) < 0 ||
2491 (error = git_vector_init(&data->removes, 0, git__strcmp_cb)) < 0 ||
2492 (error = git_vector_init(&data->remove_conflicts, 0, NULL)) < 0 ||
2493 (error = git_vector_init(&data->update_conflicts, 0, NULL)) < 0 ||
2494 (error = git_buf_puts(&data->target_path, data->opts.target_directory)) < 0 ||
2495 (error = git_path_to_dir(&data->target_path)) < 0 ||
2496 (error = git_strmap_new(&data->mkdir_map)) < 0)
2497 goto cleanup;
2498
2499 data->target_len = git_buf_len(&data->target_path);
2500
2501 git_attr_session__init(&data->attr_session, data->repo);
2502
2503 cleanup:
2504 if (error < 0)
2505 checkout_data_clear(data);
2506
2507 return error;
2508 }
2509
2510 #define CHECKOUT_INDEX_DONT_WRITE_MASK \
2511 (GIT_CHECKOUT_DONT_UPDATE_INDEX | GIT_CHECKOUT_DONT_WRITE_INDEX)
2512
setup_pathspecs(git_iterator_options * iter_opts,const git_checkout_options * checkout_opts)2513 GIT_INLINE(void) setup_pathspecs(
2514 git_iterator_options *iter_opts,
2515 const git_checkout_options *checkout_opts)
2516 {
2517 if (checkout_opts &&
2518 (checkout_opts->checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)) {
2519 iter_opts->pathlist.count = checkout_opts->paths.count;
2520 iter_opts->pathlist.strings = checkout_opts->paths.strings;
2521 }
2522 }
2523
git_checkout_iterator(git_iterator * target,git_index * index,const git_checkout_options * opts)2524 int git_checkout_iterator(
2525 git_iterator *target,
2526 git_index *index,
2527 const git_checkout_options *opts)
2528 {
2529 int error = 0;
2530 git_iterator *baseline = NULL, *workdir = NULL;
2531 git_iterator_options baseline_opts = GIT_ITERATOR_OPTIONS_INIT,
2532 workdir_opts = GIT_ITERATOR_OPTIONS_INIT;
2533 checkout_data data = {0};
2534 git_diff_options diff_opts = GIT_DIFF_OPTIONS_INIT;
2535 uint32_t *actions = NULL;
2536 size_t *counts = NULL;
2537
2538 /* initialize structures and options */
2539 error = checkout_data_init(&data, target, opts);
2540 if (error < 0)
2541 return error;
2542
2543 diff_opts.flags =
2544 GIT_DIFF_INCLUDE_UNMODIFIED |
2545 GIT_DIFF_INCLUDE_UNREADABLE |
2546 GIT_DIFF_INCLUDE_UNTRACKED |
2547 GIT_DIFF_RECURSE_UNTRACKED_DIRS | /* needed to match baseline */
2548 GIT_DIFF_INCLUDE_IGNORED |
2549 GIT_DIFF_INCLUDE_TYPECHANGE |
2550 GIT_DIFF_INCLUDE_TYPECHANGE_TREES |
2551 GIT_DIFF_SKIP_BINARY_CHECK |
2552 GIT_DIFF_INCLUDE_CASECHANGE;
2553 if (data.opts.checkout_strategy & GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH)
2554 diff_opts.flags |= GIT_DIFF_DISABLE_PATHSPEC_MATCH;
2555 if (data.opts.paths.count > 0)
2556 diff_opts.pathspec = data.opts.paths;
2557
2558 /* set up iterators */
2559
2560 workdir_opts.flags = git_iterator_ignore_case(target) ?
2561 GIT_ITERATOR_IGNORE_CASE : GIT_ITERATOR_DONT_IGNORE_CASE;
2562 workdir_opts.flags |= GIT_ITERATOR_DONT_AUTOEXPAND;
2563 workdir_opts.start = data.pfx;
2564 workdir_opts.end = data.pfx;
2565
2566 setup_pathspecs(&workdir_opts, opts);
2567
2568 if ((error = git_iterator_reset_range(target, data.pfx, data.pfx)) < 0 ||
2569 (error = git_iterator_for_workdir_ext(
2570 &workdir, data.repo, data.opts.target_directory, index, NULL,
2571 &workdir_opts)) < 0)
2572 goto cleanup;
2573
2574 baseline_opts.flags = git_iterator_ignore_case(target) ?
2575 GIT_ITERATOR_IGNORE_CASE : GIT_ITERATOR_DONT_IGNORE_CASE;
2576 baseline_opts.start = data.pfx;
2577 baseline_opts.end = data.pfx;
2578
2579 setup_pathspecs(&baseline_opts, opts);
2580
2581 if (data.opts.baseline_index) {
2582 if ((error = git_iterator_for_index(
2583 &baseline, git_index_owner(data.opts.baseline_index),
2584 data.opts.baseline_index, &baseline_opts)) < 0)
2585 goto cleanup;
2586 } else {
2587 if ((error = git_iterator_for_tree(
2588 &baseline, data.opts.baseline, &baseline_opts)) < 0)
2589 goto cleanup;
2590 }
2591
2592 /* Should not have case insensitivity mismatch */
2593 GIT_ASSERT(git_iterator_ignore_case(workdir) == git_iterator_ignore_case(baseline));
2594
2595 /* Generate baseline-to-target diff which will include an entry for
2596 * every possible update that might need to be made.
2597 */
2598 if ((error = git_diff__from_iterators(
2599 &data.diff, data.repo, baseline, target, &diff_opts)) < 0)
2600 goto cleanup;
2601
2602 /* Loop through diff (and working directory iterator) building a list of
2603 * actions to be taken, plus look for conflicts and send notifications,
2604 * then loop through conflicts.
2605 */
2606 if ((error = checkout_get_actions(&actions, &counts, &data, workdir)) != 0)
2607 goto cleanup;
2608
2609 data.total_steps = counts[CHECKOUT_ACTION__REMOVE] +
2610 counts[CHECKOUT_ACTION__REMOVE_CONFLICT] +
2611 counts[CHECKOUT_ACTION__UPDATE_BLOB] +
2612 counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] +
2613 counts[CHECKOUT_ACTION__UPDATE_CONFLICT];
2614
2615 report_progress(&data, NULL); /* establish 0 baseline */
2616
2617 /* To deal with some order dependencies, perform remaining checkout
2618 * in three passes: removes, then update blobs, then update submodules.
2619 */
2620 if (counts[CHECKOUT_ACTION__REMOVE] > 0 &&
2621 (error = checkout_remove_the_old(actions, &data)) < 0)
2622 goto cleanup;
2623
2624 if (counts[CHECKOUT_ACTION__REMOVE_CONFLICT] > 0 &&
2625 (error = checkout_remove_conflicts(&data)) < 0)
2626 goto cleanup;
2627
2628 if (counts[CHECKOUT_ACTION__UPDATE_BLOB] > 0 &&
2629 (error = checkout_create_the_new(actions, &data)) < 0)
2630 goto cleanup;
2631
2632 if (counts[CHECKOUT_ACTION__UPDATE_SUBMODULE] > 0 &&
2633 (error = checkout_create_submodules(actions, &data)) < 0)
2634 goto cleanup;
2635
2636 if (counts[CHECKOUT_ACTION__UPDATE_CONFLICT] > 0 &&
2637 (error = checkout_create_conflicts(&data)) < 0)
2638 goto cleanup;
2639
2640 if (data.index != git_iterator_index(target) &&
2641 (error = checkout_extensions_update_index(&data)) < 0)
2642 goto cleanup;
2643
2644 GIT_ASSERT(data.completed_steps == data.total_steps);
2645
2646 if (data.opts.perfdata_cb)
2647 data.opts.perfdata_cb(&data.perfdata, data.opts.perfdata_payload);
2648
2649 cleanup:
2650 if (!error && data.index != NULL &&
2651 (data.strategy & CHECKOUT_INDEX_DONT_WRITE_MASK) == 0)
2652 error = git_index_write(data.index);
2653
2654 git_diff_free(data.diff);
2655 git_iterator_free(workdir);
2656 git_iterator_free(baseline);
2657 git__free(actions);
2658 git__free(counts);
2659 checkout_data_clear(&data);
2660
2661 return error;
2662 }
2663
git_checkout_index(git_repository * repo,git_index * index,const git_checkout_options * opts)2664 int git_checkout_index(
2665 git_repository *repo,
2666 git_index *index,
2667 const git_checkout_options *opts)
2668 {
2669 git_iterator_options iter_opts = GIT_ITERATOR_OPTIONS_INIT;
2670 int error, owned = 0;
2671 git_iterator *index_i;
2672
2673 if (!index && !repo) {
2674 git_error_set(GIT_ERROR_CHECKOUT,
2675 "must provide either repository or index to checkout");
2676 return -1;
2677 }
2678
2679 if (index && repo &&
2680 git_index_owner(index) &&
2681 git_index_owner(index) != repo) {
2682 git_error_set(GIT_ERROR_CHECKOUT,
2683 "index to checkout does not match repository");
2684 return -1;
2685 } else if(index && repo && !git_index_owner(index)) {
2686 GIT_REFCOUNT_OWN(index, repo);
2687 owned = 1;
2688 }
2689
2690 if (!repo)
2691 repo = git_index_owner(index);
2692
2693 if (!index && (error = git_repository_index__weakptr(&index, repo)) < 0)
2694 return error;
2695 GIT_REFCOUNT_INC(index);
2696
2697 setup_pathspecs(&iter_opts, opts);
2698
2699 if (!(error = git_iterator_for_index(&index_i, repo, index, &iter_opts)))
2700 error = git_checkout_iterator(index_i, index, opts);
2701
2702 if (owned)
2703 GIT_REFCOUNT_OWN(index, NULL);
2704
2705 git_iterator_free(index_i);
2706 git_index_free(index);
2707
2708 return error;
2709 }
2710
git_checkout_tree(git_repository * repo,const git_object * treeish,const git_checkout_options * opts)2711 int git_checkout_tree(
2712 git_repository *repo,
2713 const git_object *treeish,
2714 const git_checkout_options *opts)
2715 {
2716 int error;
2717 git_index *index;
2718 git_tree *tree = NULL;
2719 git_iterator *tree_i = NULL;
2720 git_iterator_options iter_opts = GIT_ITERATOR_OPTIONS_INIT;
2721
2722 if (!treeish && !repo) {
2723 git_error_set(GIT_ERROR_CHECKOUT,
2724 "must provide either repository or tree to checkout");
2725 return -1;
2726 }
2727 if (treeish && repo && git_object_owner(treeish) != repo) {
2728 git_error_set(GIT_ERROR_CHECKOUT,
2729 "object to checkout does not match repository");
2730 return -1;
2731 }
2732
2733 if (!repo)
2734 repo = git_object_owner(treeish);
2735
2736 if (treeish) {
2737 if (git_object_peel((git_object **)&tree, treeish, GIT_OBJECT_TREE) < 0) {
2738 git_error_set(
2739 GIT_ERROR_CHECKOUT, "provided object cannot be peeled to a tree");
2740 return -1;
2741 }
2742 }
2743 else {
2744 if ((error = checkout_lookup_head_tree(&tree, repo)) < 0) {
2745 if (error != GIT_EUNBORNBRANCH)
2746 git_error_set(
2747 GIT_ERROR_CHECKOUT,
2748 "HEAD could not be peeled to a tree and no treeish given");
2749 return error;
2750 }
2751 }
2752
2753 if ((error = git_repository_index(&index, repo)) < 0)
2754 return error;
2755
2756 setup_pathspecs(&iter_opts, opts);
2757
2758 if (!(error = git_iterator_for_tree(&tree_i, tree, &iter_opts)))
2759 error = git_checkout_iterator(tree_i, index, opts);
2760
2761 git_iterator_free(tree_i);
2762 git_index_free(index);
2763 git_tree_free(tree);
2764
2765 return error;
2766 }
2767
git_checkout_head(git_repository * repo,const git_checkout_options * opts)2768 int git_checkout_head(
2769 git_repository *repo,
2770 const git_checkout_options *opts)
2771 {
2772 GIT_ASSERT_ARG(repo);
2773
2774 return git_checkout_tree(repo, NULL, opts);
2775 }
2776
git_checkout_options_init(git_checkout_options * opts,unsigned int version)2777 int git_checkout_options_init(git_checkout_options *opts, unsigned int version)
2778 {
2779 GIT_INIT_STRUCTURE_FROM_TEMPLATE(
2780 opts, version, git_checkout_options, GIT_CHECKOUT_OPTIONS_INIT);
2781 return 0;
2782 }
2783
2784 #ifndef GIT_DEPRECATE_HARD
git_checkout_init_options(git_checkout_options * opts,unsigned int version)2785 int git_checkout_init_options(git_checkout_options *opts, unsigned int version)
2786 {
2787 return git_checkout_options_init(opts, version);
2788 }
2789 #endif
2790