2 * Copyright (C) the libgit2 contributors. All rights reserved.
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.
12 #include "git2/repository.h"
13 #include "git2/refs.h"
14 #include "git2/tree.h"
15 #include "git2/blob.h"
16 #include "git2/config.h"
17 #include "git2/diff.h"
18 #include "git2/submodule.h"
19 #include "git2/sys/index.h"
20 #include "git2/sys/filter.h"
21 #include "git2/merge.h"
24 #include "repository.h"
29 #include "diff_generate.h"
32 #include "diff_xdiff.h"
40 /* See docs/checkout-internals.md for more information */
43 CHECKOUT_ACTION__NONE
= 0,
44 CHECKOUT_ACTION__REMOVE
= 1,
45 CHECKOUT_ACTION__UPDATE_BLOB
= 2,
46 CHECKOUT_ACTION__UPDATE_SUBMODULE
= 4,
47 CHECKOUT_ACTION__CONFLICT
= 8,
48 CHECKOUT_ACTION__REMOVE_CONFLICT
= 16,
49 CHECKOUT_ACTION__UPDATE_CONFLICT
= 32,
50 CHECKOUT_ACTION__MAX
= 32,
51 CHECKOUT_ACTION__DEFER_REMOVE
= 64,
52 CHECKOUT_ACTION__REMOVE_AND_UPDATE
=
53 (CHECKOUT_ACTION__UPDATE_BLOB
| CHECKOUT_ACTION__REMOVE
),
60 git_checkout_options opts
;
61 bool opts_free_baseline
;
66 git_vector remove_conflicts
;
67 git_vector update_conflicts
;
68 git_vector
*update_reuc
;
69 git_vector
*update_names
;
73 unsigned int strategy
;
75 bool reload_submodules
;
77 size_t completed_steps
;
78 git_checkout_perfdata perfdata
;
79 git_strmap
*mkdir_map
;
80 git_attr_session attr_session
;
84 const git_index_entry
*ancestor
;
85 const git_index_entry
*ours
;
86 const git_index_entry
*theirs
;
93 } checkout_conflictdata
;
95 static int checkout_notify(
97 git_checkout_notify_t why
,
98 const git_diff_delta
*delta
,
99 const git_index_entry
*wditem
)
101 git_diff_file wdfile
;
102 const git_diff_file
*baseline
= NULL
, *target
= NULL
, *workdir
= NULL
;
103 const char *path
= NULL
;
105 if (!data
->opts
.notify_cb
||
106 (why
& data
->opts
.notify_flags
) == 0)
110 memset(&wdfile
, 0, sizeof(wdfile
));
112 git_oid_cpy(&wdfile
.id
, &wditem
->id
);
113 wdfile
.path
= wditem
->path
;
114 wdfile
.size
= wditem
->file_size
;
115 wdfile
.flags
= GIT_DIFF_FLAG_VALID_ID
;
116 wdfile
.mode
= wditem
->mode
;
124 switch (delta
->status
) {
125 case GIT_DELTA_UNMODIFIED
:
126 case GIT_DELTA_MODIFIED
:
127 case GIT_DELTA_TYPECHANGE
:
129 baseline
= &delta
->old_file
;
130 target
= &delta
->new_file
;
132 case GIT_DELTA_ADDED
:
133 case GIT_DELTA_IGNORED
:
134 case GIT_DELTA_UNTRACKED
:
135 case GIT_DELTA_UNREADABLE
:
136 target
= &delta
->new_file
;
138 case GIT_DELTA_DELETED
:
139 baseline
= &delta
->old_file
;
143 path
= delta
->old_file
.path
;
147 int error
= data
->opts
.notify_cb(
148 why
, path
, baseline
, target
, workdir
, data
->opts
.notify_payload
);
150 return giterr_set_after_callback_function(
151 error
, "git_checkout notification");
155 GIT_INLINE(bool) is_workdir_base_or_new(
156 const git_oid
*workdir_id
,
157 const git_diff_file
*baseitem
,
158 const git_diff_file
*newitem
)
160 return (git_oid__cmp(&baseitem
->id
, workdir_id
) == 0 ||
161 git_oid__cmp(&newitem
->id
, workdir_id
) == 0);
164 static bool checkout_is_workdir_modified(
166 const git_diff_file
*baseitem
,
167 const git_diff_file
*newitem
,
168 const git_index_entry
*wditem
)
171 const git_index_entry
*ie
;
173 /* handle "modified" submodule */
174 if (wditem
->mode
== GIT_FILEMODE_COMMIT
) {
176 unsigned int sm_status
= 0;
177 const git_oid
*sm_oid
= NULL
;
180 if (git_submodule_lookup(&sm
, data
->repo
, wditem
->path
) < 0) {
185 if (git_submodule_status(&sm_status
, data
->repo
, wditem
->path
, GIT_SUBMODULE_IGNORE_UNSPECIFIED
) < 0 ||
186 GIT_SUBMODULE_STATUS_IS_WD_DIRTY(sm_status
))
188 else if ((sm_oid
= git_submodule_wd_id(sm
)) == NULL
)
191 rval
= (git_oid__cmp(&baseitem
->id
, sm_oid
) != 0);
193 git_submodule_free(sm
);
197 /* Look at the cache to decide if the workdir is modified. If not,
198 * we can simply compare the oid in the cache to the baseitem instead
199 * of hashing the file. If so, we allow the checkout to proceed if the
200 * oid is identical (ie, the staged item is what we're trying to check
203 if ((ie
= git_index_get_bypath(data
->index
, wditem
->path
, 0)) != NULL
) {
204 if (git_index_time_eq(&wditem
->mtime
, &ie
->mtime
) &&
205 wditem
->file_size
== ie
->file_size
)
206 return !is_workdir_base_or_new(&ie
->id
, baseitem
, newitem
);
209 /* depending on where base is coming from, we may or may not know
210 * the actual size of the data, so we can't rely on this shortcut.
212 if (baseitem
->size
&& wditem
->file_size
!= baseitem
->size
)
215 /* if the workdir item is a directory, it cannot be a modified file */
216 if (S_ISDIR(wditem
->mode
))
219 if (git_diff__oid_for_entry(&oid
, data
->diff
, wditem
, wditem
->mode
, NULL
) < 0)
222 /* Allow the checkout if the workdir is not modified *or* if the checkout
223 * target's contents are already in the working directory.
225 return !is_workdir_base_or_new(&oid
, baseitem
, newitem
);
228 #define CHECKOUT_ACTION_IF(FLAG,YES,NO) \
229 ((data->strategy & GIT_CHECKOUT_##FLAG) ? CHECKOUT_ACTION__##YES : CHECKOUT_ACTION__##NO)
231 static int checkout_action_common(
234 const git_diff_delta
*delta
,
235 const git_index_entry
*wd
)
237 git_checkout_notify_t notify
= GIT_CHECKOUT_NOTIFY_NONE
;
239 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0)
240 *action
= (*action
& ~CHECKOUT_ACTION__REMOVE
);
242 if ((*action
& CHECKOUT_ACTION__UPDATE_BLOB
) != 0) {
243 if (S_ISGITLINK(delta
->new_file
.mode
))
244 *action
= (*action
& ~CHECKOUT_ACTION__UPDATE_BLOB
) |
245 CHECKOUT_ACTION__UPDATE_SUBMODULE
;
247 /* to "update" a symlink, we must remove the old one first */
248 if (delta
->new_file
.mode
== GIT_FILEMODE_LINK
&& wd
!= NULL
)
249 *action
|= CHECKOUT_ACTION__REMOVE
;
251 /* if the file is on disk and doesn't match our mode, force update */
253 GIT_PERMS_IS_EXEC(wd
->mode
) !=
254 GIT_PERMS_IS_EXEC(delta
->new_file
.mode
))
255 *action
|= CHECKOUT_ACTION__REMOVE
;
257 notify
= GIT_CHECKOUT_NOTIFY_UPDATED
;
260 if ((*action
& CHECKOUT_ACTION__CONFLICT
) != 0)
261 notify
= GIT_CHECKOUT_NOTIFY_CONFLICT
;
263 return checkout_notify(data
, notify
, delta
, wd
);
266 static int checkout_action_no_wd(
269 const git_diff_delta
*delta
)
273 *action
= CHECKOUT_ACTION__NONE
;
275 switch (delta
->status
) {
276 case GIT_DELTA_UNMODIFIED
: /* case 12 */
277 error
= checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, NULL
);
280 *action
= CHECKOUT_ACTION_IF(RECREATE_MISSING
, UPDATE_BLOB
, NONE
);
282 case GIT_DELTA_ADDED
: /* case 2 or 28 (and 5 but not really) */
283 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
285 case GIT_DELTA_MODIFIED
: /* case 13 (and 35 but not really) */
286 *action
= CHECKOUT_ACTION_IF(RECREATE_MISSING
, UPDATE_BLOB
, CONFLICT
);
288 case GIT_DELTA_TYPECHANGE
: /* case 21 (B->T) and 28 (T->B)*/
289 if (delta
->new_file
.mode
== GIT_FILEMODE_TREE
)
290 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
292 case GIT_DELTA_DELETED
: /* case 8 or 25 */
293 *action
= CHECKOUT_ACTION_IF(SAFE
, REMOVE
, NONE
);
295 default: /* impossible */
299 return checkout_action_common(action
, data
, delta
, NULL
);
302 static int checkout_target_fullpath(
303 git_buf
**out
, checkout_data
*data
, const char *path
)
305 git_buf_truncate(&data
->target_path
, data
->target_len
);
307 if (path
&& git_buf_puts(&data
->target_path
, path
) < 0)
310 *out
= &data
->target_path
;
315 static bool wd_item_is_removable(
316 checkout_data
*data
, const git_index_entry
*wd
)
320 if (wd
->mode
!= GIT_FILEMODE_TREE
)
323 if (checkout_target_fullpath(&full
, data
, wd
->path
) < 0)
326 return !full
|| !git_path_contains(full
, DOT_GIT
);
329 static int checkout_queue_remove(checkout_data
*data
, const char *path
)
331 char *copy
= git_pool_strdup(&data
->pool
, path
);
332 GITERR_CHECK_ALLOC(copy
);
333 return git_vector_insert(&data
->removes
, copy
);
336 /* note that this advances the iterator over the wd item */
337 static int checkout_action_wd_only(
339 git_iterator
*workdir
,
340 const git_index_entry
**wditem
,
341 git_vector
*pathspec
)
345 git_checkout_notify_t notify
= GIT_CHECKOUT_NOTIFY_NONE
;
346 const git_index_entry
*wd
= *wditem
;
348 if (!git_pathspec__match(
350 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
351 git_iterator_ignore_case(workdir
), NULL
, NULL
))
352 return git_iterator_advance(wditem
, workdir
);
354 /* check if item is tracked in the index but not in the checkout diff */
355 if (data
->index
!= NULL
) {
358 error
= git_index__find_pos(
359 &pos
, data
->index
, wd
->path
, 0, GIT_INDEX_STAGE_ANY
);
361 if (wd
->mode
!= GIT_FILEMODE_TREE
) {
362 if (!error
) { /* found by git_index__find_pos call */
363 notify
= GIT_CHECKOUT_NOTIFY_DIRTY
;
364 remove
= ((data
->strategy
& GIT_CHECKOUT_FORCE
) != 0);
365 } else if (error
!= GIT_ENOTFOUND
)
368 error
= 0; /* git_index__find_pos does not set error msg */
370 /* for tree entries, we have to see if there are any index
371 * entries that are contained inside that tree
373 const git_index_entry
*e
= git_index_get_byindex(data
->index
, pos
);
375 if (e
!= NULL
&& data
->diff
->pfxcomp(e
->path
, wd
->path
) == 0) {
376 notify
= GIT_CHECKOUT_NOTIFY_DIRTY
;
377 remove
= ((data
->strategy
& GIT_CHECKOUT_FORCE
) != 0);
382 if (notify
!= GIT_CHECKOUT_NOTIFY_NONE
) {
383 /* if we found something in the index, notify and advance */
384 if ((error
= checkout_notify(data
, notify
, NULL
, wd
)) != 0)
387 if (remove
&& wd_item_is_removable(data
, wd
))
388 error
= checkout_queue_remove(data
, wd
->path
);
391 error
= git_iterator_advance(wditem
, workdir
);
393 /* untracked or ignored - can't know which until we advance through */
394 bool over
= false, removable
= wd_item_is_removable(data
, wd
);
395 git_iterator_status_t untracked_state
;
397 /* copy the entry for issuing notification callback later */
398 git_index_entry saved_wd
= *wd
;
399 git_buf_sets(&data
->tmp
, wd
->path
);
400 saved_wd
.path
= data
->tmp
.ptr
;
402 error
= git_iterator_advance_over(
403 wditem
, &untracked_state
, workdir
);
404 if (error
== GIT_ITEROVER
)
409 if (untracked_state
== GIT_ITERATOR_STATUS_IGNORED
) {
410 notify
= GIT_CHECKOUT_NOTIFY_IGNORED
;
411 remove
= ((data
->strategy
& GIT_CHECKOUT_REMOVE_IGNORED
) != 0);
413 notify
= GIT_CHECKOUT_NOTIFY_UNTRACKED
;
414 remove
= ((data
->strategy
& GIT_CHECKOUT_REMOVE_UNTRACKED
) != 0);
417 if ((error
= checkout_notify(data
, notify
, NULL
, &saved_wd
)) != 0)
420 if (remove
&& removable
)
421 error
= checkout_queue_remove(data
, saved_wd
.path
);
423 if (!error
&& over
) /* restore ITEROVER if needed */
424 error
= GIT_ITEROVER
;
430 static bool submodule_is_config_only(
434 git_submodule
*sm
= NULL
;
435 unsigned int sm_loc
= 0;
438 if (git_submodule_lookup(&sm
, data
->repo
, path
) < 0)
441 if (git_submodule_location(&sm_loc
, sm
) < 0 ||
442 sm_loc
== GIT_SUBMODULE_STATUS_IN_CONFIG
)
445 git_submodule_free(sm
);
450 static bool checkout_is_empty_dir(checkout_data
*data
, const char *path
)
454 if (checkout_target_fullpath(&fullpath
, data
, path
) < 0)
457 return git_path_is_empty_dir(fullpath
->ptr
);
460 static int checkout_action_with_wd(
463 const git_diff_delta
*delta
,
464 git_iterator
*workdir
,
465 const git_index_entry
*wd
)
467 *action
= CHECKOUT_ACTION__NONE
;
469 switch (delta
->status
) {
470 case GIT_DELTA_UNMODIFIED
: /* case 14/15 or 33 */
471 if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
)) {
473 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, wd
) );
474 *action
= CHECKOUT_ACTION_IF(FORCE
, UPDATE_BLOB
, NONE
);
477 case GIT_DELTA_ADDED
: /* case 3, 4 or 6 */
478 if (git_iterator_current_is_ignored(workdir
))
479 *action
= CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED
, CONFLICT
, UPDATE_BLOB
);
481 *action
= CHECKOUT_ACTION_IF(FORCE
, UPDATE_BLOB
, CONFLICT
);
483 case GIT_DELTA_DELETED
: /* case 9 or 10 (or 26 but not really) */
484 if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
))
485 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE
, CONFLICT
);
487 *action
= CHECKOUT_ACTION_IF(SAFE
, REMOVE
, NONE
);
489 case GIT_DELTA_MODIFIED
: /* case 16, 17, 18 (or 36 but not really) */
490 if (wd
->mode
!= GIT_FILEMODE_COMMIT
&&
491 checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
))
492 *action
= CHECKOUT_ACTION_IF(FORCE
, UPDATE_BLOB
, CONFLICT
);
494 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
496 case GIT_DELTA_TYPECHANGE
: /* case 22, 23, 29, 30 */
497 if (delta
->old_file
.mode
== GIT_FILEMODE_TREE
) {
498 if (wd
->mode
== GIT_FILEMODE_TREE
)
499 /* either deleting items in old tree will delete the wd dir,
500 * or we'll get a conflict when we attempt blob update...
502 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
503 else if (wd
->mode
== GIT_FILEMODE_COMMIT
) {
504 /* workdir is possibly a "phantom" submodule - treat as a
505 * tree if the only submodule info came from the config
507 if (submodule_is_config_only(data
, wd
->path
))
508 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
510 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
512 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE
, CONFLICT
);
514 else if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
))
515 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
517 *action
= CHECKOUT_ACTION_IF(SAFE
, REMOVE_AND_UPDATE
, NONE
);
519 /* don't update if the typechange is to a tree */
520 if (delta
->new_file
.mode
== GIT_FILEMODE_TREE
)
521 *action
= (*action
& ~CHECKOUT_ACTION__UPDATE_BLOB
);
523 default: /* impossible */
527 return checkout_action_common(action
, data
, delta
, wd
);
530 static int checkout_action_with_wd_blocker(
533 const git_diff_delta
*delta
,
534 const git_index_entry
*wd
)
536 *action
= CHECKOUT_ACTION__NONE
;
538 switch (delta
->status
) {
539 case GIT_DELTA_UNMODIFIED
:
540 /* should show delta as dirty / deleted */
542 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, wd
) );
543 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, NONE
);
545 case GIT_DELTA_ADDED
:
546 case GIT_DELTA_MODIFIED
:
547 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
549 case GIT_DELTA_DELETED
:
550 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE
, CONFLICT
);
552 case GIT_DELTA_TYPECHANGE
:
553 /* not 100% certain about this... */
554 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
556 default: /* impossible */
560 return checkout_action_common(action
, data
, delta
, wd
);
563 static int checkout_action_with_wd_dir(
566 const git_diff_delta
*delta
,
567 git_iterator
*workdir
,
568 const git_index_entry
*wd
)
570 *action
= CHECKOUT_ACTION__NONE
;
572 switch (delta
->status
) {
573 case GIT_DELTA_UNMODIFIED
: /* case 19 or 24 (or 34 but not really) */
575 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, NULL
));
577 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_UNTRACKED
, NULL
, wd
));
578 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, NONE
);
580 case GIT_DELTA_ADDED
:/* case 4 (and 7 for dir) */
581 case GIT_DELTA_MODIFIED
: /* case 20 (or 37 but not really) */
582 if (delta
->old_file
.mode
== GIT_FILEMODE_COMMIT
)
583 /* expected submodule (and maybe found one) */;
584 else if (delta
->new_file
.mode
!= GIT_FILEMODE_TREE
)
585 *action
= git_iterator_current_is_ignored(workdir
) ?
586 CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED
, CONFLICT
, REMOVE_AND_UPDATE
) :
587 CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
589 case GIT_DELTA_DELETED
: /* case 11 (and 27 for dir) */
590 if (delta
->old_file
.mode
!= GIT_FILEMODE_TREE
)
592 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_UNTRACKED
, NULL
, wd
));
594 case GIT_DELTA_TYPECHANGE
: /* case 24 or 31 */
595 if (delta
->old_file
.mode
== GIT_FILEMODE_TREE
) {
596 /* For typechange from dir, remove dir and add blob, but it is
597 * not safe to remove dir if it contains modified files.
598 * However, safely removing child files will remove the parent
599 * directory if is it left empty, so we can defer removing the
600 * dir and it will succeed if no children are left.
602 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
604 else if (delta
->new_file
.mode
!= GIT_FILEMODE_TREE
)
605 /* For typechange to dir, dir is already created so no action */
606 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
608 default: /* impossible */
612 return checkout_action_common(action
, data
, delta
, wd
);
615 static int checkout_action_with_wd_dir_empty(
618 const git_diff_delta
*delta
)
620 int error
= checkout_action_no_wd(action
, data
, delta
);
622 /* We can always safely remove an empty directory. */
623 if (error
== 0 && *action
!= CHECKOUT_ACTION__NONE
)
624 *action
|= CHECKOUT_ACTION__REMOVE
;
629 static int checkout_action(
632 git_diff_delta
*delta
,
633 git_iterator
*workdir
,
634 const git_index_entry
**wditem
,
635 git_vector
*pathspec
)
638 int (*strcomp
)(const char *, const char *) = data
->diff
->strcomp
;
639 int (*pfxcomp
)(const char *str
, const char *pfx
) = data
->diff
->pfxcomp
;
640 int (*advance
)(const git_index_entry
**, git_iterator
*) = NULL
;
642 /* move workdir iterator to follow along with deltas */
645 const git_index_entry
*wd
= *wditem
;
648 return checkout_action_no_wd(action
, data
, delta
);
650 cmp
= strcomp(wd
->path
, delta
->old_file
.path
);
652 /* 1. wd before delta ("a/a" before "a/b")
653 * 2. wd prefixes delta & should expand ("a/" before "a/b")
654 * 3. wd prefixes delta & cannot expand ("a/b" before "a/b/c")
655 * 4. wd equals delta ("a/b" and "a/b")
656 * 5. wd after delta & delta prefixes wd ("a/b/c" after "a/b/" or "a/b")
657 * 6. wd after delta ("a/c" after "a/b")
661 cmp
= pfxcomp(delta
->old_file
.path
, wd
->path
);
664 if (wd
->mode
== GIT_FILEMODE_TREE
) {
665 /* case 2 - entry prefixed by workdir tree */
666 error
= git_iterator_advance_into(wditem
, workdir
);
667 if (error
< 0 && error
!= GIT_ITEROVER
)
672 /* case 3 maybe - wd contains non-dir where dir expected */
673 if (delta
->old_file
.path
[strlen(wd
->path
)] == '/') {
674 error
= checkout_action_with_wd_blocker(
675 action
, data
, delta
, wd
);
676 advance
= git_iterator_advance
;
681 /* case 1 - handle wd item (if it matches pathspec) */
682 error
= checkout_action_wd_only(data
, workdir
, wditem
, pathspec
);
683 if (error
&& error
!= GIT_ITEROVER
)
690 error
= checkout_action_with_wd(action
, data
, delta
, workdir
, wd
);
691 advance
= git_iterator_advance
;
695 cmp
= pfxcomp(wd
->path
, delta
->old_file
.path
);
697 if (cmp
== 0) { /* case 5 */
698 if (wd
->path
[strlen(delta
->old_file
.path
)] != '/')
699 return checkout_action_no_wd(action
, data
, delta
);
701 if (delta
->status
== GIT_DELTA_TYPECHANGE
) {
702 if (delta
->old_file
.mode
== GIT_FILEMODE_TREE
) {
703 error
= checkout_action_with_wd(action
, data
, delta
, workdir
, wd
);
704 advance
= git_iterator_advance_into
;
708 if (delta
->new_file
.mode
== GIT_FILEMODE_TREE
||
709 delta
->new_file
.mode
== GIT_FILEMODE_COMMIT
||
710 delta
->old_file
.mode
== GIT_FILEMODE_COMMIT
)
712 error
= checkout_action_with_wd(action
, data
, delta
, workdir
, wd
);
713 advance
= git_iterator_advance
;
718 return checkout_is_empty_dir(data
, wd
->path
) ?
719 checkout_action_with_wd_dir_empty(action
, data
, delta
) :
720 checkout_action_with_wd_dir(action
, data
, delta
, workdir
, wd
);
723 /* case 6 - wd is after delta */
724 return checkout_action_no_wd(action
, data
, delta
);
728 if (!error
&& advance
!= NULL
&&
729 (error
= advance(wditem
, workdir
)) < 0) {
731 if (error
== GIT_ITEROVER
)
738 static int checkout_remaining_wd_items(
740 git_iterator
*workdir
,
741 const git_index_entry
*wd
,
747 error
= checkout_action_wd_only(data
, workdir
, &wd
, spec
);
749 if (error
== GIT_ITEROVER
)
755 GIT_INLINE(int) checkout_idxentry_cmp(
756 const git_index_entry
*a
,
757 const git_index_entry
*b
)
766 return strcmp(a
->path
, b
->path
);
769 static int checkout_conflictdata_cmp(const void *a
, const void *b
)
771 const checkout_conflictdata
*ca
= a
;
772 const checkout_conflictdata
*cb
= b
;
775 if ((diff
= checkout_idxentry_cmp(ca
->ancestor
, cb
->ancestor
)) == 0 &&
776 (diff
= checkout_idxentry_cmp(ca
->ours
, cb
->theirs
)) == 0)
777 diff
= checkout_idxentry_cmp(ca
->theirs
, cb
->theirs
);
782 int checkout_conflictdata_empty(
783 const git_vector
*conflicts
, size_t idx
, void *payload
)
785 checkout_conflictdata
*conflict
;
789 if ((conflict
= git_vector_get(conflicts
, idx
)) == NULL
)
792 if (conflict
->ancestor
|| conflict
->ours
|| conflict
->theirs
)
799 GIT_INLINE(bool) conflict_pathspec_match(
801 git_iterator
*workdir
,
802 git_vector
*pathspec
,
803 const git_index_entry
*ancestor
,
804 const git_index_entry
*ours
,
805 const git_index_entry
*theirs
)
807 /* if the pathspec matches ours *or* theirs, proceed */
808 if (ours
&& git_pathspec__match(pathspec
, ours
->path
,
809 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
810 git_iterator_ignore_case(workdir
), NULL
, NULL
))
813 if (theirs
&& git_pathspec__match(pathspec
, theirs
->path
,
814 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
815 git_iterator_ignore_case(workdir
), NULL
, NULL
))
818 if (ancestor
&& git_pathspec__match(pathspec
, ancestor
->path
,
819 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
820 git_iterator_ignore_case(workdir
), NULL
, NULL
))
826 GIT_INLINE(int) checkout_conflict_detect_submodule(checkout_conflictdata
*conflict
)
828 conflict
->submodule
= ((conflict
->ancestor
&& S_ISGITLINK(conflict
->ancestor
->mode
)) ||
829 (conflict
->ours
&& S_ISGITLINK(conflict
->ours
->mode
)) ||
830 (conflict
->theirs
&& S_ISGITLINK(conflict
->theirs
->mode
)));
834 GIT_INLINE(int) checkout_conflict_detect_binary(git_repository
*repo
, checkout_conflictdata
*conflict
)
836 git_blob
*ancestor_blob
= NULL
, *our_blob
= NULL
, *their_blob
= NULL
;
839 if (conflict
->submodule
)
842 if (conflict
->ancestor
) {
843 if ((error
= git_blob_lookup(&ancestor_blob
, repo
, &conflict
->ancestor
->id
)) < 0)
846 conflict
->binary
= git_blob_is_binary(ancestor_blob
);
849 if (!conflict
->binary
&& conflict
->ours
) {
850 if ((error
= git_blob_lookup(&our_blob
, repo
, &conflict
->ours
->id
)) < 0)
853 conflict
->binary
= git_blob_is_binary(our_blob
);
856 if (!conflict
->binary
&& conflict
->theirs
) {
857 if ((error
= git_blob_lookup(&their_blob
, repo
, &conflict
->theirs
->id
)) < 0)
860 conflict
->binary
= git_blob_is_binary(their_blob
);
864 git_blob_free(ancestor_blob
);
865 git_blob_free(our_blob
);
866 git_blob_free(their_blob
);
871 static int checkout_conflict_append_update(
872 const git_index_entry
*ancestor
,
873 const git_index_entry
*ours
,
874 const git_index_entry
*theirs
,
877 checkout_data
*data
= payload
;
878 checkout_conflictdata
*conflict
;
881 conflict
= git__calloc(1, sizeof(checkout_conflictdata
));
882 GITERR_CHECK_ALLOC(conflict
);
884 conflict
->ancestor
= ancestor
;
885 conflict
->ours
= ours
;
886 conflict
->theirs
= theirs
;
888 if ((error
= checkout_conflict_detect_submodule(conflict
)) < 0 ||
889 (error
= checkout_conflict_detect_binary(data
->repo
, conflict
)) < 0)
895 if (git_vector_insert(&data
->update_conflicts
, conflict
))
901 static int checkout_conflicts_foreach(
904 git_iterator
*workdir
,
905 git_vector
*pathspec
,
906 int (*cb
)(const git_index_entry
*, const git_index_entry
*, const git_index_entry
*, void *),
909 git_index_conflict_iterator
*iterator
= NULL
;
910 const git_index_entry
*ancestor
, *ours
, *theirs
;
913 if ((error
= git_index_conflict_iterator_new(&iterator
, index
)) < 0)
916 /* Collect the conflicts */
917 while ((error
= git_index_conflict_next(&ancestor
, &ours
, &theirs
, iterator
)) == 0) {
918 if (!conflict_pathspec_match(data
, workdir
, pathspec
, ancestor
, ours
, theirs
))
921 if ((error
= cb(ancestor
, ours
, theirs
, payload
)) < 0)
925 if (error
== GIT_ITEROVER
)
929 git_index_conflict_iterator_free(iterator
);
934 static int checkout_conflicts_load(checkout_data
*data
, git_iterator
*workdir
, git_vector
*pathspec
)
938 /* Only write conficts from sources that have them: indexes. */
939 if ((index
= git_iterator_index(data
->target
)) == NULL
)
942 data
->update_conflicts
._cmp
= checkout_conflictdata_cmp
;
944 if (checkout_conflicts_foreach(data
, index
, workdir
, pathspec
, checkout_conflict_append_update
, data
) < 0)
947 /* Collect the REUC and NAME entries */
948 data
->update_reuc
= &index
->reuc
;
949 data
->update_names
= &index
->names
;
954 GIT_INLINE(int) checkout_conflicts_cmp_entry(
956 const git_index_entry
*entry
)
958 return strcmp((const char *)path
, entry
->path
);
961 static int checkout_conflicts_cmp_ancestor(const void *p
, const void *c
)
963 const char *path
= p
;
964 const checkout_conflictdata
*conflict
= c
;
966 if (!conflict
->ancestor
)
969 return checkout_conflicts_cmp_entry(path
, conflict
->ancestor
);
972 static checkout_conflictdata
*checkout_conflicts_search_ancestor(
978 if (git_vector_bsearch2(&pos
, &data
->update_conflicts
, checkout_conflicts_cmp_ancestor
, path
) < 0)
981 return git_vector_get(&data
->update_conflicts
, pos
);
984 static checkout_conflictdata
*checkout_conflicts_search_branch(
988 checkout_conflictdata
*conflict
;
991 git_vector_foreach(&data
->update_conflicts
, i
, conflict
) {
994 if (conflict
->ancestor
)
998 cmp
= checkout_conflicts_cmp_entry(path
, conflict
->ours
);
999 else if (conflict
->theirs
)
1000 cmp
= checkout_conflicts_cmp_entry(path
, conflict
->theirs
);
1009 static int checkout_conflicts_load_byname_entry(
1010 checkout_conflictdata
**ancestor_out
,
1011 checkout_conflictdata
**ours_out
,
1012 checkout_conflictdata
**theirs_out
,
1013 checkout_data
*data
,
1014 const git_index_name_entry
*name_entry
)
1016 checkout_conflictdata
*ancestor
, *ours
= NULL
, *theirs
= NULL
;
1019 *ancestor_out
= NULL
;
1023 if (!name_entry
->ancestor
) {
1024 giterr_set(GITERR_INDEX
, "a NAME entry exists without an ancestor");
1029 if (!name_entry
->ours
&& !name_entry
->theirs
) {
1030 giterr_set(GITERR_INDEX
, "a NAME entry exists without an ours or theirs");
1035 if ((ancestor
= checkout_conflicts_search_ancestor(data
,
1036 name_entry
->ancestor
)) == NULL
) {
1037 giterr_set(GITERR_INDEX
,
1038 "a NAME entry referenced ancestor entry '%s' which does not exist in the main index",
1039 name_entry
->ancestor
);
1044 if (name_entry
->ours
) {
1045 if (strcmp(name_entry
->ancestor
, name_entry
->ours
) == 0)
1047 else if ((ours
= checkout_conflicts_search_branch(data
, name_entry
->ours
)) == NULL
||
1048 ours
->ours
== NULL
) {
1049 giterr_set(GITERR_INDEX
,
1050 "a NAME entry referenced our entry '%s' which does not exist in the main index",
1057 if (name_entry
->theirs
) {
1058 if (strcmp(name_entry
->ancestor
, name_entry
->theirs
) == 0)
1060 else if (name_entry
->ours
&& strcmp(name_entry
->ours
, name_entry
->theirs
) == 0)
1062 else if ((theirs
= checkout_conflicts_search_branch(data
, name_entry
->theirs
)) == NULL
||
1063 theirs
->theirs
== NULL
) {
1064 giterr_set(GITERR_INDEX
,
1065 "a NAME entry referenced their entry '%s' which does not exist in the main index",
1066 name_entry
->theirs
);
1072 *ancestor_out
= ancestor
;
1074 *theirs_out
= theirs
;
1080 static int checkout_conflicts_coalesce_renames(
1081 checkout_data
*data
)
1084 const git_index_name_entry
*name_entry
;
1085 checkout_conflictdata
*ancestor_conflict
, *our_conflict
, *their_conflict
;
1089 if ((index
= git_iterator_index(data
->target
)) == NULL
)
1092 /* Juggle entries based on renames */
1093 names
= git_index_name_entrycount(index
);
1095 for (i
= 0; i
< names
; i
++) {
1096 name_entry
= git_index_name_get_byindex(index
, i
);
1098 if ((error
= checkout_conflicts_load_byname_entry(
1099 &ancestor_conflict
, &our_conflict
, &their_conflict
,
1100 data
, name_entry
)) < 0)
1103 if (our_conflict
&& our_conflict
!= ancestor_conflict
) {
1104 ancestor_conflict
->ours
= our_conflict
->ours
;
1105 our_conflict
->ours
= NULL
;
1107 if (our_conflict
->theirs
)
1108 our_conflict
->name_collision
= 1;
1110 if (our_conflict
->name_collision
)
1111 ancestor_conflict
->name_collision
= 1;
1114 if (their_conflict
&& their_conflict
!= ancestor_conflict
) {
1115 ancestor_conflict
->theirs
= their_conflict
->theirs
;
1116 their_conflict
->theirs
= NULL
;
1118 if (their_conflict
->ours
)
1119 their_conflict
->name_collision
= 1;
1121 if (their_conflict
->name_collision
)
1122 ancestor_conflict
->name_collision
= 1;
1125 if (our_conflict
&& our_conflict
!= ancestor_conflict
&&
1126 their_conflict
&& their_conflict
!= ancestor_conflict
)
1127 ancestor_conflict
->one_to_two
= 1;
1130 git_vector_remove_matching(
1131 &data
->update_conflicts
, checkout_conflictdata_empty
, NULL
);
1137 static int checkout_conflicts_mark_directoryfile(
1138 checkout_data
*data
)
1141 checkout_conflictdata
*conflict
;
1142 const git_index_entry
*entry
;
1145 int prefixed
, error
= 0;
1147 if ((index
= git_iterator_index(data
->target
)) == NULL
)
1150 len
= git_index_entrycount(index
);
1152 /* Find d/f conflicts */
1153 git_vector_foreach(&data
->update_conflicts
, i
, conflict
) {
1154 if ((conflict
->ours
&& conflict
->theirs
) ||
1155 (!conflict
->ours
&& !conflict
->theirs
))
1158 path
= conflict
->ours
?
1159 conflict
->ours
->path
: conflict
->theirs
->path
;
1161 if ((error
= git_index_find(&j
, index
, path
)) < 0) {
1162 if (error
== GIT_ENOTFOUND
)
1163 giterr_set(GITERR_INDEX
,
1164 "index inconsistency, could not find entry for expected conflict '%s'", path
);
1169 for (; j
< len
; j
++) {
1170 if ((entry
= git_index_get_byindex(index
, j
)) == NULL
) {
1171 giterr_set(GITERR_INDEX
,
1172 "index inconsistency, truncated index while loading expected conflict '%s'", path
);
1177 prefixed
= git_path_equal_or_prefixed(path
, entry
->path
, NULL
);
1179 if (prefixed
== GIT_PATH_EQUAL
)
1182 if (prefixed
== GIT_PATH_PREFIX
)
1183 conflict
->directoryfile
= 1;
1193 static int checkout_get_update_conflicts(
1194 checkout_data
*data
,
1195 git_iterator
*workdir
,
1196 git_vector
*pathspec
)
1200 if (data
->strategy
& GIT_CHECKOUT_SKIP_UNMERGED
)
1203 if ((error
= checkout_conflicts_load(data
, workdir
, pathspec
)) < 0 ||
1204 (error
= checkout_conflicts_coalesce_renames(data
)) < 0 ||
1205 (error
= checkout_conflicts_mark_directoryfile(data
)) < 0)
1212 static int checkout_conflict_append_remove(
1213 const git_index_entry
*ancestor
,
1214 const git_index_entry
*ours
,
1215 const git_index_entry
*theirs
,
1218 checkout_data
*data
= payload
;
1221 assert(ancestor
|| ours
|| theirs
);
1224 name
= git__strdup(ancestor
->path
);
1226 name
= git__strdup(ours
->path
);
1228 name
= git__strdup(theirs
->path
);
1232 GITERR_CHECK_ALLOC(name
);
1234 return git_vector_insert(&data
->remove_conflicts
, (char *)name
);
1237 static int checkout_get_remove_conflicts(
1238 checkout_data
*data
,
1239 git_iterator
*workdir
,
1240 git_vector
*pathspec
)
1242 if ((data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) != 0)
1245 return checkout_conflicts_foreach(data
, data
->index
, workdir
, pathspec
, checkout_conflict_append_remove
, data
);
1248 static int checkout_verify_paths(
1249 git_repository
*repo
,
1251 git_diff_delta
*delta
)
1253 unsigned int flags
= GIT_PATH_REJECT_WORKDIR_DEFAULTS
;
1255 if (action
& CHECKOUT_ACTION__REMOVE
) {
1256 if (!git_path_isvalid(repo
, delta
->old_file
.path
, flags
)) {
1257 giterr_set(GITERR_CHECKOUT
, "cannot remove invalid path '%s'", delta
->old_file
.path
);
1262 if (action
& ~CHECKOUT_ACTION__REMOVE
) {
1263 if (!git_path_isvalid(repo
, delta
->new_file
.path
, flags
)) {
1264 giterr_set(GITERR_CHECKOUT
, "cannot checkout to invalid path '%s'", delta
->new_file
.path
);
1272 static int checkout_get_actions(
1273 uint32_t **actions_ptr
,
1274 size_t **counts_ptr
,
1275 checkout_data
*data
,
1276 git_iterator
*workdir
)
1279 const git_index_entry
*wditem
;
1280 git_vector pathspec
= GIT_VECTOR_INIT
, *deltas
;
1282 git_diff_delta
*delta
;
1283 size_t i
, *counts
= NULL
;
1284 uint32_t *actions
= NULL
;
1286 git_pool_init(&pathpool
, 1);
1288 if (data
->opts
.paths
.count
> 0 &&
1289 git_pathspec__vinit(&pathspec
, &data
->opts
.paths
, &pathpool
) < 0)
1292 if ((error
= git_iterator_current(&wditem
, workdir
)) < 0 &&
1293 error
!= GIT_ITEROVER
)
1296 deltas
= &data
->diff
->deltas
;
1298 *counts_ptr
= counts
= git__calloc(CHECKOUT_ACTION__MAX
+1, sizeof(size_t));
1299 *actions_ptr
= actions
= git__calloc(
1300 deltas
->length
? deltas
->length
: 1, sizeof(uint32_t));
1301 if (!counts
|| !actions
) {
1306 git_vector_foreach(deltas
, i
, delta
) {
1307 if ((error
= checkout_action(&act
, data
, delta
, workdir
, &wditem
, &pathspec
)) == 0)
1308 error
= checkout_verify_paths(data
->repo
, act
, delta
);
1315 if (act
& CHECKOUT_ACTION__REMOVE
)
1316 counts
[CHECKOUT_ACTION__REMOVE
]++;
1317 if (act
& CHECKOUT_ACTION__UPDATE_BLOB
)
1318 counts
[CHECKOUT_ACTION__UPDATE_BLOB
]++;
1319 if (act
& CHECKOUT_ACTION__UPDATE_SUBMODULE
)
1320 counts
[CHECKOUT_ACTION__UPDATE_SUBMODULE
]++;
1321 if (act
& CHECKOUT_ACTION__CONFLICT
)
1322 counts
[CHECKOUT_ACTION__CONFLICT
]++;
1325 error
= checkout_remaining_wd_items(data
, workdir
, wditem
, &pathspec
);
1329 counts
[CHECKOUT_ACTION__REMOVE
] += data
->removes
.length
;
1331 if (counts
[CHECKOUT_ACTION__CONFLICT
] > 0 &&
1332 (data
->strategy
& GIT_CHECKOUT_ALLOW_CONFLICTS
) == 0)
1334 giterr_set(GITERR_CHECKOUT
, "%"PRIuZ
" %s checkout",
1335 counts
[CHECKOUT_ACTION__CONFLICT
],
1336 counts
[CHECKOUT_ACTION__CONFLICT
] == 1 ?
1337 "conflict prevents" : "conflicts prevent");
1338 error
= GIT_ECONFLICT
;
1343 if ((error
= checkout_get_remove_conflicts(data
, workdir
, &pathspec
)) < 0 ||
1344 (error
= checkout_get_update_conflicts(data
, workdir
, &pathspec
)) < 0)
1347 counts
[CHECKOUT_ACTION__REMOVE_CONFLICT
] = git_vector_length(&data
->remove_conflicts
);
1348 counts
[CHECKOUT_ACTION__UPDATE_CONFLICT
] = git_vector_length(&data
->update_conflicts
);
1350 git_pathspec__vfree(&pathspec
);
1351 git_pool_clear(&pathpool
);
1358 *actions_ptr
= NULL
;
1361 git_pathspec__vfree(&pathspec
);
1362 git_pool_clear(&pathpool
);
1367 static bool should_remove_existing(checkout_data
*data
)
1371 if (git_repository__cvar(&ignorecase
, data
->repo
, GIT_CVAR_IGNORECASE
) < 0) {
1375 return (ignorecase
&&
1376 (data
->strategy
& GIT_CHECKOUT_DONT_REMOVE_EXISTING
) == 0);
1379 #define MKDIR_NORMAL \
1380 GIT_MKDIR_PATH | GIT_MKDIR_VERIFY_DIR
1381 #define MKDIR_REMOVE_EXISTING \
1382 MKDIR_NORMAL | GIT_MKDIR_REMOVE_FILES | GIT_MKDIR_REMOVE_SYMLINKS
1384 static int checkout_mkdir(
1385 checkout_data
*data
,
1391 struct git_futils_mkdir_options mkdir_opts
= {0};
1394 mkdir_opts
.dir_map
= data
->mkdir_map
;
1395 mkdir_opts
.pool
= &data
->pool
;
1397 error
= git_futils_mkdir_relative(
1398 path
, base
, mode
, flags
, &mkdir_opts
);
1400 data
->perfdata
.mkdir_calls
+= mkdir_opts
.perfdata
.mkdir_calls
;
1401 data
->perfdata
.stat_calls
+= mkdir_opts
.perfdata
.stat_calls
;
1402 data
->perfdata
.chmod_calls
+= mkdir_opts
.perfdata
.chmod_calls
;
1407 static int mkpath2file(
1408 checkout_data
*data
, const char *path
, unsigned int mode
)
1411 bool remove_existing
= should_remove_existing(data
);
1412 unsigned int flags
=
1413 (remove_existing
? MKDIR_REMOVE_EXISTING
: MKDIR_NORMAL
) |
1414 GIT_MKDIR_SKIP_LAST
;
1417 if ((error
= checkout_mkdir(
1418 data
, path
, data
->opts
.target_directory
, mode
, flags
)) < 0)
1421 if (remove_existing
) {
1422 data
->perfdata
.stat_calls
++;
1424 if (p_lstat(path
, &st
) == 0) {
1426 /* Some file, symlink or folder already exists at this name.
1427 * We would have removed it in remove_the_old unless we're on
1428 * a case inensitive filesystem (or the user has asked us not
1429 * to). Remove the similarly named file to write the new.
1431 error
= git_futils_rmdir_r(path
, NULL
, GIT_RMDIR_REMOVE_FILES
);
1432 } else if (errno
!= ENOENT
) {
1433 giterr_set(GITERR_OS
, "failed to stat '%s'", path
);
1443 struct checkout_stream
{
1444 git_writestream base
;
1450 static int checkout_stream_write(
1451 git_writestream
*s
, const char *buffer
, size_t len
)
1453 struct checkout_stream
*stream
= (struct checkout_stream
*)s
;
1456 if ((ret
= p_write(stream
->fd
, buffer
, len
)) < 0)
1457 giterr_set(GITERR_OS
, "could not write to '%s'", stream
->path
);
1462 static int checkout_stream_close(git_writestream
*s
)
1464 struct checkout_stream
*stream
= (struct checkout_stream
*)s
;
1465 assert(stream
&& stream
->open
);
1468 return p_close(stream
->fd
);
1471 static void checkout_stream_free(git_writestream
*s
)
1476 static int blob_content_to_file(
1477 checkout_data
*data
,
1481 const char *hint_path
,
1482 mode_t entry_filemode
)
1484 int flags
= data
->opts
.file_open_flags
;
1485 mode_t file_mode
= data
->opts
.file_mode
?
1486 data
->opts
.file_mode
: entry_filemode
;
1487 git_filter_options filter_opts
= GIT_FILTER_OPTIONS_INIT
;
1488 struct checkout_stream writer
;
1490 git_filter_list
*fl
= NULL
;
1494 if (hint_path
== NULL
)
1497 if ((error
= mkpath2file(data
, path
, data
->opts
.dir_mode
)) < 0)
1501 flags
= O_CREAT
| O_TRUNC
| O_WRONLY
;
1502 if (!(mode
= file_mode
))
1503 mode
= GIT_FILEMODE_BLOB
;
1505 if ((fd
= p_open(path
, flags
, mode
)) < 0) {
1506 giterr_set(GITERR_OS
, "could not open '%s' for writing", path
);
1510 filter_opts
.attr_session
= &data
->attr_session
;
1511 filter_opts
.temp_buf
= &data
->tmp
;
1513 if (!data
->opts
.disable_filters
&&
1514 (error
= git_filter_list__load_ext(
1515 &fl
, data
->repo
, blob
, hint_path
,
1516 GIT_FILTER_TO_WORKTREE
, &filter_opts
))) {
1521 /* setup the writer */
1522 memset(&writer
, 0, sizeof(struct checkout_stream
));
1523 writer
.base
.write
= checkout_stream_write
;
1524 writer
.base
.close
= checkout_stream_close
;
1525 writer
.base
.free
= checkout_stream_free
;
1530 error
= git_filter_list_stream_blob(fl
, blob
, &writer
.base
);
1532 assert(writer
.open
== 0);
1534 git_filter_list_free(fl
);
1540 data
->perfdata
.stat_calls
++;
1542 if ((error
= p_stat(path
, st
)) < 0) {
1543 giterr_set(GITERR_OS
, "failed to stat '%s'", path
);
1547 st
->st_mode
= entry_filemode
;
1553 static int blob_content_to_link(
1554 checkout_data
*data
,
1559 git_buf linktarget
= GIT_BUF_INIT
;
1562 if ((error
= mkpath2file(data
, path
, data
->opts
.dir_mode
)) < 0)
1565 if ((error
= git_blob__getbuf(&linktarget
, blob
)) < 0)
1568 if (data
->can_symlink
) {
1569 if ((error
= p_symlink(git_buf_cstr(&linktarget
), path
)) < 0)
1570 giterr_set(GITERR_OS
, "could not create symlink %s", path
);
1572 error
= git_futils_fake_symlink(git_buf_cstr(&linktarget
), path
);
1576 data
->perfdata
.stat_calls
++;
1578 if ((error
= p_lstat(path
, st
)) < 0)
1579 giterr_set(GITERR_CHECKOUT
, "could not stat symlink %s", path
);
1581 st
->st_mode
= GIT_FILEMODE_LINK
;
1584 git_buf_free(&linktarget
);
1589 static int checkout_update_index(
1590 checkout_data
*data
,
1591 const git_diff_file
*file
,
1594 git_index_entry entry
;
1599 memset(&entry
, 0, sizeof(entry
));
1600 entry
.path
= (char *)file
->path
; /* cast to prevent warning */
1601 git_index_entry__init_from_stat(&entry
, st
, true);
1602 git_oid_cpy(&entry
.id
, &file
->id
);
1604 return git_index_add(data
->index
, &entry
);
1607 static int checkout_submodule_update_index(
1608 checkout_data
*data
,
1609 const git_diff_file
*file
)
1614 /* update the index unless prevented */
1615 if ((data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) != 0)
1618 if (checkout_target_fullpath(&fullpath
, data
, file
->path
) < 0)
1621 data
->perfdata
.stat_calls
++;
1622 if (p_stat(fullpath
->ptr
, &st
) < 0) {
1624 GITERR_CHECKOUT
, "could not stat submodule %s\n", file
->path
);
1625 return GIT_ENOTFOUND
;
1628 st
.st_mode
= GIT_FILEMODE_COMMIT
;
1630 return checkout_update_index(data
, file
, &st
);
1633 static int checkout_submodule(
1634 checkout_data
*data
,
1635 const git_diff_file
*file
)
1637 bool remove_existing
= should_remove_existing(data
);
1640 /* Until submodules are supported, UPDATE_ONLY means do nothing here */
1641 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0)
1644 if ((error
= checkout_mkdir(
1646 file
->path
, data
->opts
.target_directory
, data
->opts
.dir_mode
,
1647 remove_existing
? MKDIR_REMOVE_EXISTING
: MKDIR_NORMAL
)) < 0)
1650 if ((error
= git_submodule_lookup(NULL
, data
->repo
, file
->path
)) < 0) {
1651 /* I've observed repos with submodules in the tree that do not
1652 * have a .gitmodules - core Git just makes an empty directory
1654 if (error
== GIT_ENOTFOUND
) {
1656 return checkout_submodule_update_index(data
, file
);
1662 /* TODO: Support checkout_strategy options. Two circumstances:
1663 * 1 - submodule already checked out, but we need to move the HEAD
1664 * to the new OID, or
1665 * 2 - submodule not checked out and we should recursively check it out
1667 * Checkout will not execute a pull on the submodule, but a clone
1668 * command should probably be able to. Do we need a submodule callback?
1671 return checkout_submodule_update_index(data
, file
);
1674 static void report_progress(
1675 checkout_data
*data
,
1678 if (data
->opts
.progress_cb
)
1679 data
->opts
.progress_cb(
1680 path
, data
->completed_steps
, data
->total_steps
,
1681 data
->opts
.progress_payload
);
1684 static int checkout_safe_for_update_only(
1685 checkout_data
*data
, const char *path
, mode_t expected_mode
)
1689 data
->perfdata
.stat_calls
++;
1691 if (p_lstat(path
, &st
) < 0) {
1692 /* if doesn't exist, then no error and no update */
1693 if (errno
== ENOENT
|| errno
== ENOTDIR
)
1696 /* otherwise, stat error and no update */
1697 giterr_set(GITERR_OS
, "failed to stat '%s'", path
);
1701 /* only safe for update if this is the same type of file */
1702 if ((st
.st_mode
& ~0777) == (expected_mode
& ~0777))
1708 static int checkout_write_content(
1709 checkout_data
*data
,
1711 const char *full_path
,
1712 const char *hint_path
,
1719 if ((error
= git_blob_lookup(&blob
, data
->repo
, oid
)) < 0)
1723 error
= blob_content_to_link(data
, st
, blob
, full_path
);
1725 error
= blob_content_to_file(data
, st
, blob
, full_path
, hint_path
, mode
);
1727 git_blob_free(blob
);
1729 /* if we try to create the blob and an existing directory blocks it from
1730 * being written, then there must have been a typechange conflict in a
1731 * parent directory - suppress the error and try to continue.
1733 if ((data
->strategy
& GIT_CHECKOUT_ALLOW_CONFLICTS
) != 0 &&
1734 (error
== GIT_ENOTFOUND
|| error
== GIT_EEXISTS
))
1743 static int checkout_blob(
1744 checkout_data
*data
,
1745 const git_diff_file
*file
)
1751 if (checkout_target_fullpath(&fullpath
, data
, file
->path
) < 0)
1754 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0) {
1755 int rval
= checkout_safe_for_update_only(
1756 data
, fullpath
->ptr
, file
->mode
);
1762 error
= checkout_write_content(
1763 data
, &file
->id
, fullpath
->ptr
, NULL
, file
->mode
, &st
);
1765 /* update the index unless prevented */
1766 if (!error
&& (data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0)
1767 error
= checkout_update_index(data
, file
, &st
);
1769 /* update the submodule data if this was a new .gitmodules file */
1770 if (!error
&& strcmp(file
->path
, ".gitmodules") == 0)
1771 data
->reload_submodules
= true;
1776 static int checkout_remove_the_old(
1777 unsigned int *actions
,
1778 checkout_data
*data
)
1781 git_diff_delta
*delta
;
1785 uint32_t flg
= GIT_RMDIR_EMPTY_PARENTS
|
1786 GIT_RMDIR_REMOVE_FILES
| GIT_RMDIR_REMOVE_BLOCKERS
;
1788 if (data
->opts
.checkout_strategy
& GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES
)
1789 flg
|= GIT_RMDIR_SKIP_NONEMPTY
;
1791 if (checkout_target_fullpath(&fullpath
, data
, NULL
) < 0)
1794 git_vector_foreach(&data
->diff
->deltas
, i
, delta
) {
1795 if (actions
[i
] & CHECKOUT_ACTION__REMOVE
) {
1796 error
= git_futils_rmdir_r(
1797 delta
->old_file
.path
, fullpath
->ptr
, flg
);
1802 data
->completed_steps
++;
1803 report_progress(data
, delta
->old_file
.path
);
1805 if ((actions
[i
] & CHECKOUT_ACTION__UPDATE_BLOB
) == 0 &&
1806 (data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0 &&
1807 data
->index
!= NULL
)
1809 (void)git_index_remove(data
->index
, delta
->old_file
.path
, 0);
1814 git_vector_foreach(&data
->removes
, i
, str
) {
1815 error
= git_futils_rmdir_r(str
, fullpath
->ptr
, flg
);
1819 data
->completed_steps
++;
1820 report_progress(data
, str
);
1822 if ((data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0 &&
1823 data
->index
!= NULL
)
1825 if (str
[strlen(str
) - 1] == '/')
1826 (void)git_index_remove_directory(data
->index
, str
, 0);
1828 (void)git_index_remove(data
->index
, str
, 0);
1835 static int checkout_deferred_remove(git_repository
*repo
, const char *path
)
1838 int error
= git_futils_rmdir_r(
1839 path
, data
->opts
.target_directory
, GIT_RMDIR_EMPTY_PARENTS
);
1841 if (error
== GIT_ENOTFOUND
) {
1855 static int checkout_create_the_new(
1856 unsigned int *actions
,
1857 checkout_data
*data
)
1860 git_diff_delta
*delta
;
1863 git_vector_foreach(&data
->diff
->deltas
, i
, delta
) {
1864 if (actions
[i
] & CHECKOUT_ACTION__DEFER_REMOVE
) {
1865 /* this had a blocker directory that should only be removed iff
1866 * all of the contents of the directory were safely removed
1868 if ((error
= checkout_deferred_remove(
1869 data
->repo
, delta
->old_file
.path
)) < 0)
1873 if (actions
[i
] & CHECKOUT_ACTION__UPDATE_BLOB
) {
1874 error
= checkout_blob(data
, &delta
->new_file
);
1878 data
->completed_steps
++;
1879 report_progress(data
, delta
->new_file
.path
);
1886 static int checkout_create_submodules(
1887 unsigned int *actions
,
1888 checkout_data
*data
)
1891 git_diff_delta
*delta
;
1894 git_vector_foreach(&data
->diff
->deltas
, i
, delta
) {
1895 if (actions
[i
] & CHECKOUT_ACTION__DEFER_REMOVE
) {
1896 /* this has a blocker directory that should only be removed iff
1897 * all of the contents of the directory were safely removed
1899 if ((error
= checkout_deferred_remove(
1900 data
->repo
, delta
->old_file
.path
)) < 0)
1904 if (actions
[i
] & CHECKOUT_ACTION__UPDATE_SUBMODULE
) {
1905 int error
= checkout_submodule(data
, &delta
->new_file
);
1909 data
->completed_steps
++;
1910 report_progress(data
, delta
->new_file
.path
);
1917 static int checkout_lookup_head_tree(git_tree
**out
, git_repository
*repo
)
1920 git_reference
*ref
= NULL
;
1923 if (!(error
= git_repository_head(&ref
, repo
)) &&
1924 !(error
= git_reference_peel(&head
, ref
, GIT_OBJ_TREE
)))
1925 *out
= (git_tree
*)head
;
1927 git_reference_free(ref
);
1933 static int conflict_entry_name(
1935 const char *side_name
,
1936 const char *filename
)
1938 if (git_buf_puts(out
, side_name
) < 0 ||
1939 git_buf_putc(out
, ':') < 0 ||
1940 git_buf_puts(out
, filename
) < 0)
1946 static int checkout_path_suffixed(git_buf
*path
, const char *suffix
)
1949 int i
= 0, error
= 0;
1951 if ((error
= git_buf_putc(path
, '~')) < 0 || (error
= git_buf_puts(path
, suffix
)) < 0)
1954 path_len
= git_buf_len(path
);
1956 while (git_path_exists(git_buf_cstr(path
)) && i
< INT_MAX
) {
1957 git_buf_truncate(path
, path_len
);
1959 if ((error
= git_buf_putc(path
, '_')) < 0 ||
1960 (error
= git_buf_printf(path
, "%d", i
)) < 0)
1967 git_buf_truncate(path
, path_len
);
1969 giterr_set(GITERR_CHECKOUT
, "could not write '%s': working directory file exists", path
->ptr
);
1976 static int checkout_write_entry(
1977 checkout_data
*data
,
1978 checkout_conflictdata
*conflict
,
1979 const git_index_entry
*side
)
1981 const char *hint_path
= NULL
, *suffix
;
1986 assert (side
== conflict
->ours
|| side
== conflict
->theirs
);
1988 if (checkout_target_fullpath(&fullpath
, data
, side
->path
) < 0)
1991 if ((conflict
->name_collision
|| conflict
->directoryfile
) &&
1992 (data
->strategy
& GIT_CHECKOUT_USE_OURS
) == 0 &&
1993 (data
->strategy
& GIT_CHECKOUT_USE_THEIRS
) == 0) {
1995 if (side
== conflict
->ours
)
1996 suffix
= data
->opts
.our_label
? data
->opts
.our_label
:
1999 suffix
= data
->opts
.their_label
? data
->opts
.their_label
:
2002 if (checkout_path_suffixed(fullpath
, suffix
) < 0)
2005 hint_path
= side
->path
;
2008 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0 &&
2009 (error
= checkout_safe_for_update_only(data
, fullpath
->ptr
, side
->mode
)) <= 0)
2012 return checkout_write_content(data
,
2013 &side
->id
, fullpath
->ptr
, hint_path
, side
->mode
, &st
);
2016 static int checkout_write_entries(
2017 checkout_data
*data
,
2018 checkout_conflictdata
*conflict
)
2022 if ((error
= checkout_write_entry(data
, conflict
, conflict
->ours
)) >= 0)
2023 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2028 static int checkout_merge_path(
2030 checkout_data
*data
,
2031 checkout_conflictdata
*conflict
,
2032 git_merge_file_result
*result
)
2034 const char *our_label_raw
, *their_label_raw
, *suffix
;
2037 if ((error
= git_buf_joinpath(out
, git_repository_workdir(data
->repo
), result
->path
)) < 0)
2040 /* Most conflicts simply use the filename in the index */
2041 if (!conflict
->name_collision
)
2044 /* Rename 2->1 conflicts need the branch name appended */
2045 our_label_raw
= data
->opts
.our_label
? data
->opts
.our_label
: "ours";
2046 their_label_raw
= data
->opts
.their_label
? data
->opts
.their_label
: "theirs";
2047 suffix
= strcmp(result
->path
, conflict
->ours
->path
) == 0 ? our_label_raw
: their_label_raw
;
2049 if ((error
= checkout_path_suffixed(out
, suffix
)) < 0)
2055 static int checkout_write_merge(
2056 checkout_data
*data
,
2057 checkout_conflictdata
*conflict
)
2059 git_buf our_label
= GIT_BUF_INIT
, their_label
= GIT_BUF_INIT
,
2060 path_suffixed
= GIT_BUF_INIT
, path_workdir
= GIT_BUF_INIT
,
2061 in_data
= GIT_BUF_INIT
, out_data
= GIT_BUF_INIT
;
2062 git_merge_file_options opts
= GIT_MERGE_FILE_OPTIONS_INIT
;
2063 git_merge_file_result result
= {0};
2064 git_filebuf output
= GIT_FILEBUF_INIT
;
2065 git_filter_list
*fl
= NULL
;
2066 git_filter_options filter_opts
= GIT_FILTER_OPTIONS_INIT
;
2069 if (data
->opts
.checkout_strategy
& GIT_CHECKOUT_CONFLICT_STYLE_DIFF3
)
2070 opts
.flags
|= GIT_MERGE_FILE_STYLE_DIFF3
;
2072 opts
.ancestor_label
= data
->opts
.ancestor_label
?
2073 data
->opts
.ancestor_label
: "ancestor";
2074 opts
.our_label
= data
->opts
.our_label
?
2075 data
->opts
.our_label
: "ours";
2076 opts
.their_label
= data
->opts
.their_label
?
2077 data
->opts
.their_label
: "theirs";
2079 /* If all the paths are identical, decorate the diff3 file with the branch
2080 * names. Otherwise, append branch_name:path.
2082 if (conflict
->ours
&& conflict
->theirs
&&
2083 strcmp(conflict
->ours
->path
, conflict
->theirs
->path
) != 0) {
2085 if ((error
= conflict_entry_name(
2086 &our_label
, opts
.our_label
, conflict
->ours
->path
)) < 0 ||
2087 (error
= conflict_entry_name(
2088 &their_label
, opts
.their_label
, conflict
->theirs
->path
)) < 0)
2091 opts
.our_label
= git_buf_cstr(&our_label
);
2092 opts
.their_label
= git_buf_cstr(&their_label
);
2095 if ((error
= git_merge_file_from_index(&result
, data
->repo
,
2096 conflict
->ancestor
, conflict
->ours
, conflict
->theirs
, &opts
)) < 0)
2099 if (result
.path
== NULL
|| result
.mode
== 0) {
2100 giterr_set(GITERR_CHECKOUT
, "could not merge contents of file");
2101 error
= GIT_ECONFLICT
;
2105 if ((error
= checkout_merge_path(&path_workdir
, data
, conflict
, &result
)) < 0)
2108 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0 &&
2109 (error
= checkout_safe_for_update_only(data
, git_buf_cstr(&path_workdir
), result
.mode
)) <= 0)
2112 if (!data
->opts
.disable_filters
) {
2113 in_data
.ptr
= (char *)result
.ptr
;
2114 in_data
.size
= result
.len
;
2116 filter_opts
.attr_session
= &data
->attr_session
;
2117 filter_opts
.temp_buf
= &data
->tmp
;
2119 if ((error
= git_filter_list__load_ext(
2120 &fl
, data
->repo
, NULL
, git_buf_cstr(&path_workdir
),
2121 GIT_FILTER_TO_WORKTREE
, &filter_opts
)) < 0 ||
2122 (error
= git_filter_list_apply_to_data(&out_data
, fl
, &in_data
)) < 0)
2125 out_data
.ptr
= (char *)result
.ptr
;
2126 out_data
.size
= result
.len
;
2129 if ((error
= mkpath2file(data
, path_workdir
.ptr
, data
->opts
.dir_mode
)) < 0 ||
2130 (error
= git_filebuf_open(&output
, git_buf_cstr(&path_workdir
), GIT_FILEBUF_DO_NOT_BUFFER
, result
.mode
)) < 0 ||
2131 (error
= git_filebuf_write(&output
, out_data
.ptr
, out_data
.size
)) < 0 ||
2132 (error
= git_filebuf_commit(&output
)) < 0)
2136 git_filter_list_free(fl
);
2138 git_buf_free(&out_data
);
2139 git_buf_free(&our_label
);
2140 git_buf_free(&their_label
);
2142 git_merge_file_result_free(&result
);
2143 git_buf_free(&path_workdir
);
2144 git_buf_free(&path_suffixed
);
2149 static int checkout_conflict_add(
2150 checkout_data
*data
,
2151 const git_index_entry
*conflict
)
2153 int error
= git_index_remove(data
->index
, conflict
->path
, 0);
2155 if (error
== GIT_ENOTFOUND
)
2160 return git_index_add(data
->index
, conflict
);
2163 static int checkout_conflict_update_index(
2164 checkout_data
*data
,
2165 checkout_conflictdata
*conflict
)
2169 if (conflict
->ancestor
)
2170 error
= checkout_conflict_add(data
, conflict
->ancestor
);
2172 if (!error
&& conflict
->ours
)
2173 error
= checkout_conflict_add(data
, conflict
->ours
);
2175 if (!error
&& conflict
->theirs
)
2176 error
= checkout_conflict_add(data
, conflict
->theirs
);
2181 static int checkout_create_conflicts(checkout_data
*data
)
2183 checkout_conflictdata
*conflict
;
2187 git_vector_foreach(&data
->update_conflicts
, i
, conflict
) {
2189 /* Both deleted: nothing to do */
2190 if (conflict
->ours
== NULL
&& conflict
->theirs
== NULL
)
2193 else if ((data
->strategy
& GIT_CHECKOUT_USE_OURS
) &&
2195 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2196 else if ((data
->strategy
& GIT_CHECKOUT_USE_THEIRS
) &&
2198 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2200 /* Ignore the other side of name collisions. */
2201 else if ((data
->strategy
& GIT_CHECKOUT_USE_OURS
) &&
2202 !conflict
->ours
&& conflict
->name_collision
)
2204 else if ((data
->strategy
& GIT_CHECKOUT_USE_THEIRS
) &&
2205 !conflict
->theirs
&& conflict
->name_collision
)
2208 /* For modify/delete, name collisions and d/f conflicts, write
2209 * the file (potentially with the name mangled.
2211 else if (conflict
->ours
!= NULL
&& conflict
->theirs
== NULL
)
2212 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2213 else if (conflict
->ours
== NULL
&& conflict
->theirs
!= NULL
)
2214 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2216 /* Add/add conflicts and rename 1->2 conflicts, write the
2217 * ours/theirs sides (potentially name mangled).
2219 else if (conflict
->one_to_two
)
2220 error
= checkout_write_entries(data
, conflict
);
2222 /* If all sides are links, write the ours side */
2223 else if (S_ISLNK(conflict
->ours
->mode
) &&
2224 S_ISLNK(conflict
->theirs
->mode
))
2225 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2226 /* Link/file conflicts, write the file side */
2227 else if (S_ISLNK(conflict
->ours
->mode
))
2228 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2229 else if (S_ISLNK(conflict
->theirs
->mode
))
2230 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2232 /* If any side is a gitlink, do nothing. */
2233 else if (conflict
->submodule
)
2236 /* If any side is binary, write the ours side */
2237 else if (conflict
->binary
)
2238 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2241 error
= checkout_write_merge(data
, conflict
);
2243 /* Update the index extensions (REUC and NAME) if we're checking
2244 * out a different index. (Otherwise just leave them there.)
2246 if (!error
&& (data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0)
2247 error
= checkout_conflict_update_index(data
, conflict
);
2252 data
->completed_steps
++;
2253 report_progress(data
,
2254 conflict
->ours
? conflict
->ours
->path
:
2255 (conflict
->theirs
? conflict
->theirs
->path
: conflict
->ancestor
->path
));
2261 static int checkout_remove_conflicts(checkout_data
*data
)
2263 const char *conflict
;
2266 git_vector_foreach(&data
->remove_conflicts
, i
, conflict
) {
2267 if (git_index_conflict_remove(data
->index
, conflict
) < 0)
2270 data
->completed_steps
++;
2276 static int checkout_extensions_update_index(checkout_data
*data
)
2278 const git_index_reuc_entry
*reuc_entry
;
2279 const git_index_name_entry
*name_entry
;
2283 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0)
2286 if (data
->update_reuc
) {
2287 git_vector_foreach(data
->update_reuc
, i
, reuc_entry
) {
2288 if ((error
= git_index_reuc_add(data
->index
, reuc_entry
->path
,
2289 reuc_entry
->mode
[0], &reuc_entry
->oid
[0],
2290 reuc_entry
->mode
[1], &reuc_entry
->oid
[1],
2291 reuc_entry
->mode
[2], &reuc_entry
->oid
[2])) < 0)
2296 if (data
->update_names
) {
2297 git_vector_foreach(data
->update_names
, i
, name_entry
) {
2298 if ((error
= git_index_name_add(data
->index
, name_entry
->ancestor
,
2299 name_entry
->ours
, name_entry
->theirs
)) < 0)
2308 static void checkout_data_clear(checkout_data
*data
)
2310 if (data
->opts_free_baseline
) {
2311 git_tree_free(data
->opts
.baseline
);
2312 data
->opts
.baseline
= NULL
;
2315 git_vector_free(&data
->removes
);
2316 git_pool_clear(&data
->pool
);
2318 git_vector_free_deep(&data
->remove_conflicts
);
2319 git_vector_free_deep(&data
->update_conflicts
);
2321 git__free(data
->pfx
);
2324 git_strmap_free(data
->mkdir_map
);
2326 git_buf_free(&data
->target_path
);
2327 git_buf_free(&data
->tmp
);
2329 git_index_free(data
->index
);
2332 git_strmap_free(data
->mkdir_map
);
2334 git_attr_session__free(&data
->attr_session
);
2337 static int checkout_data_init(
2338 checkout_data
*data
,
2339 git_iterator
*target
,
2340 const git_checkout_options
*proposed
)
2343 git_repository
*repo
= git_iterator_owner(target
);
2345 memset(data
, 0, sizeof(*data
));
2348 giterr_set(GITERR_CHECKOUT
, "cannot checkout nothing");
2352 if ((!proposed
|| !proposed
->target_directory
) &&
2353 (error
= git_repository__ensure_not_bare(repo
, "checkout")) < 0)
2357 data
->target
= target
;
2359 GITERR_CHECK_VERSION(
2360 proposed
, GIT_CHECKOUT_OPTIONS_VERSION
, "git_checkout_options");
2363 GIT_INIT_STRUCTURE(&data
->opts
, GIT_CHECKOUT_OPTIONS_VERSION
);
2365 memmove(&data
->opts
, proposed
, sizeof(git_checkout_options
));
2367 if (!data
->opts
.target_directory
)
2368 data
->opts
.target_directory
= git_repository_workdir(repo
);
2369 else if (!git_path_isdir(data
->opts
.target_directory
) &&
2370 (error
= checkout_mkdir(data
,
2371 data
->opts
.target_directory
, NULL
,
2372 GIT_DIR_MODE
, GIT_MKDIR_VERIFY_DIR
)) < 0)
2375 /* refresh config and index content unless NO_REFRESH is given */
2376 if ((data
->opts
.checkout_strategy
& GIT_CHECKOUT_NO_REFRESH
) == 0) {
2379 if ((error
= git_repository_config__weakptr(&cfg
, repo
)) < 0)
2382 /* Get the repository index and reload it (unless we're checking
2383 * out the index; then it has the changes we're trying to check
2384 * out and those should not be overwritten.)
2386 if ((error
= git_repository_index(&data
->index
, data
->repo
)) < 0)
2389 if (data
->index
!= git_iterator_index(target
)) {
2390 if ((error
= git_index_read(data
->index
, true)) < 0)
2393 /* cannot checkout if unresolved conflicts exist */
2394 if ((data
->opts
.checkout_strategy
& GIT_CHECKOUT_FORCE
) == 0 &&
2395 git_index_has_conflicts(data
->index
)) {
2396 error
= GIT_ECONFLICT
;
2397 giterr_set(GITERR_CHECKOUT
,
2398 "unresolved conflicts exist in the index");
2402 /* clean conflict data in the current index */
2403 git_index_name_clear(data
->index
);
2404 git_index_reuc_clear(data
->index
);
2408 /* if you are forcing, allow all safe updates, plus recreate missing */
2409 if ((data
->opts
.checkout_strategy
& GIT_CHECKOUT_FORCE
) != 0)
2410 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_SAFE
|
2411 GIT_CHECKOUT_RECREATE_MISSING
;
2413 /* if the repository does not actually have an index file, then this
2414 * is an initial checkout (perhaps from clone), so we allow safe updates
2416 if (!data
->index
->on_disk
&&
2417 (data
->opts
.checkout_strategy
& GIT_CHECKOUT_SAFE
) != 0)
2418 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_RECREATE_MISSING
;
2420 data
->strategy
= data
->opts
.checkout_strategy
;
2422 /* opts->disable_filters is false by default */
2424 if (!data
->opts
.dir_mode
)
2425 data
->opts
.dir_mode
= GIT_DIR_MODE
;
2427 if (!data
->opts
.file_open_flags
)
2428 data
->opts
.file_open_flags
= O_CREAT
| O_TRUNC
| O_WRONLY
;
2430 data
->pfx
= git_pathspec_prefix(&data
->opts
.paths
);
2432 if ((error
= git_repository__cvar(
2433 &data
->can_symlink
, repo
, GIT_CVAR_SYMLINKS
)) < 0)
2436 if (!data
->opts
.baseline
&& !data
->opts
.baseline_index
) {
2437 data
->opts_free_baseline
= true;
2440 /* if we don't have an index, this is an initial checkout and
2441 * should be against an empty baseline
2443 if (data
->index
->on_disk
)
2444 error
= checkout_lookup_head_tree(&data
->opts
.baseline
, repo
);
2446 if (error
== GIT_EUNBORNBRANCH
) {
2455 if ((data
->opts
.checkout_strategy
&
2456 (GIT_CHECKOUT_CONFLICT_STYLE_MERGE
| GIT_CHECKOUT_CONFLICT_STYLE_DIFF3
)) == 0) {
2457 git_config_entry
*conflict_style
= NULL
;
2458 git_config
*cfg
= NULL
;
2460 if ((error
= git_repository_config__weakptr(&cfg
, repo
)) < 0 ||
2461 (error
= git_config_get_entry(&conflict_style
, cfg
, "merge.conflictstyle")) < 0 ||
2462 error
== GIT_ENOTFOUND
)
2466 else if (strcmp(conflict_style
->value
, "merge") == 0)
2467 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_CONFLICT_STYLE_MERGE
;
2468 else if (strcmp(conflict_style
->value
, "diff3") == 0)
2469 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_CONFLICT_STYLE_DIFF3
;
2471 giterr_set(GITERR_CHECKOUT
, "unknown style '%s' given for 'merge.conflictstyle'",
2472 conflict_style
->value
);
2474 git_config_entry_free(conflict_style
);
2477 git_config_entry_free(conflict_style
);
2480 git_pool_init(&data
->pool
, 1);
2482 if ((error
= git_vector_init(&data
->removes
, 0, git__strcmp_cb
)) < 0 ||
2483 (error
= git_vector_init(&data
->remove_conflicts
, 0, NULL
)) < 0 ||
2484 (error
= git_vector_init(&data
->update_conflicts
, 0, NULL
)) < 0 ||
2485 (error
= git_buf_puts(&data
->target_path
, data
->opts
.target_directory
)) < 0 ||
2486 (error
= git_path_to_dir(&data
->target_path
)) < 0 ||
2487 (error
= git_strmap_alloc(&data
->mkdir_map
)) < 0)
2490 data
->target_len
= git_buf_len(&data
->target_path
);
2492 git_attr_session__init(&data
->attr_session
, data
->repo
);
2496 checkout_data_clear(data
);
2501 #define CHECKOUT_INDEX_DONT_WRITE_MASK \
2502 (GIT_CHECKOUT_DONT_UPDATE_INDEX | GIT_CHECKOUT_DONT_WRITE_INDEX)
2504 int git_checkout_iterator(
2505 git_iterator
*target
,
2507 const git_checkout_options
*opts
)
2510 git_iterator
*baseline
= NULL
, *workdir
= NULL
;
2511 git_iterator_options baseline_opts
= GIT_ITERATOR_OPTIONS_INIT
,
2512 workdir_opts
= GIT_ITERATOR_OPTIONS_INIT
;
2513 checkout_data data
= {0};
2514 git_diff_options diff_opts
= GIT_DIFF_OPTIONS_INIT
;
2515 uint32_t *actions
= NULL
;
2516 size_t *counts
= NULL
;
2518 /* initialize structures and options */
2519 error
= checkout_data_init(&data
, target
, opts
);
2524 GIT_DIFF_INCLUDE_UNMODIFIED
|
2525 GIT_DIFF_INCLUDE_UNREADABLE
|
2526 GIT_DIFF_INCLUDE_UNTRACKED
|
2527 GIT_DIFF_RECURSE_UNTRACKED_DIRS
| /* needed to match baseline */
2528 GIT_DIFF_INCLUDE_IGNORED
|
2529 GIT_DIFF_INCLUDE_TYPECHANGE
|
2530 GIT_DIFF_INCLUDE_TYPECHANGE_TREES
|
2531 GIT_DIFF_SKIP_BINARY_CHECK
|
2532 GIT_DIFF_INCLUDE_CASECHANGE
;
2533 if (data
.opts
.checkout_strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
)
2534 diff_opts
.flags
|= GIT_DIFF_DISABLE_PATHSPEC_MATCH
;
2535 if (data
.opts
.paths
.count
> 0)
2536 diff_opts
.pathspec
= data
.opts
.paths
;
2538 /* set up iterators */
2540 workdir_opts
.flags
= git_iterator_ignore_case(target
) ?
2541 GIT_ITERATOR_IGNORE_CASE
: GIT_ITERATOR_DONT_IGNORE_CASE
;
2542 workdir_opts
.flags
|= GIT_ITERATOR_DONT_AUTOEXPAND
;
2543 workdir_opts
.start
= data
.pfx
;
2544 workdir_opts
.end
= data
.pfx
;
2546 if ((error
= git_iterator_reset_range(target
, data
.pfx
, data
.pfx
)) < 0 ||
2547 (error
= git_iterator_for_workdir_ext(
2548 &workdir
, data
.repo
, data
.opts
.target_directory
, index
, NULL
,
2549 &workdir_opts
)) < 0)
2552 baseline_opts
.flags
= git_iterator_ignore_case(target
) ?
2553 GIT_ITERATOR_IGNORE_CASE
: GIT_ITERATOR_DONT_IGNORE_CASE
;
2554 baseline_opts
.start
= data
.pfx
;
2555 baseline_opts
.end
= data
.pfx
;
2556 if (opts
&& (opts
->checkout_strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
)) {
2557 baseline_opts
.pathlist
.count
= opts
->paths
.count
;
2558 baseline_opts
.pathlist
.strings
= opts
->paths
.strings
;
2561 if (data
.opts
.baseline_index
) {
2562 if ((error
= git_iterator_for_index(
2563 &baseline
, git_index_owner(data
.opts
.baseline_index
),
2564 data
.opts
.baseline_index
, &baseline_opts
)) < 0)
2567 if ((error
= git_iterator_for_tree(
2568 &baseline
, data
.opts
.baseline
, &baseline_opts
)) < 0)
2572 /* Should not have case insensitivity mismatch */
2573 assert(git_iterator_ignore_case(workdir
) == git_iterator_ignore_case(baseline
));
2575 /* Generate baseline-to-target diff which will include an entry for
2576 * every possible update that might need to be made.
2578 if ((error
= git_diff__from_iterators(
2579 &data
.diff
, data
.repo
, baseline
, target
, &diff_opts
)) < 0)
2582 /* Loop through diff (and working directory iterator) building a list of
2583 * actions to be taken, plus look for conflicts and send notifications,
2584 * then loop through conflicts.
2586 if ((error
= checkout_get_actions(&actions
, &counts
, &data
, workdir
)) != 0)
2589 data
.total_steps
= counts
[CHECKOUT_ACTION__REMOVE
] +
2590 counts
[CHECKOUT_ACTION__REMOVE_CONFLICT
] +
2591 counts
[CHECKOUT_ACTION__UPDATE_BLOB
] +
2592 counts
[CHECKOUT_ACTION__UPDATE_SUBMODULE
] +
2593 counts
[CHECKOUT_ACTION__UPDATE_CONFLICT
];
2595 report_progress(&data
, NULL
); /* establish 0 baseline */
2597 /* To deal with some order dependencies, perform remaining checkout
2598 * in three passes: removes, then update blobs, then update submodules.
2600 if (counts
[CHECKOUT_ACTION__REMOVE
] > 0 &&
2601 (error
= checkout_remove_the_old(actions
, &data
)) < 0)
2604 if (counts
[CHECKOUT_ACTION__REMOVE_CONFLICT
] > 0 &&
2605 (error
= checkout_remove_conflicts(&data
)) < 0)
2608 if (counts
[CHECKOUT_ACTION__UPDATE_BLOB
] > 0 &&
2609 (error
= checkout_create_the_new(actions
, &data
)) < 0)
2612 if (counts
[CHECKOUT_ACTION__UPDATE_SUBMODULE
] > 0 &&
2613 (error
= checkout_create_submodules(actions
, &data
)) < 0)
2616 if (counts
[CHECKOUT_ACTION__UPDATE_CONFLICT
] > 0 &&
2617 (error
= checkout_create_conflicts(&data
)) < 0)
2620 if (data
.index
!= git_iterator_index(target
) &&
2621 (error
= checkout_extensions_update_index(&data
)) < 0)
2624 assert(data
.completed_steps
== data
.total_steps
);
2626 if (data
.opts
.perfdata_cb
)
2627 data
.opts
.perfdata_cb(&data
.perfdata
, data
.opts
.perfdata_payload
);
2630 if (!error
&& data
.index
!= NULL
&&
2631 (data
.strategy
& CHECKOUT_INDEX_DONT_WRITE_MASK
) == 0)
2632 error
= git_index_write(data
.index
);
2634 git_diff_free(data
.diff
);
2635 git_iterator_free(workdir
);
2636 git_iterator_free(baseline
);
2639 checkout_data_clear(&data
);
2644 int git_checkout_index(
2645 git_repository
*repo
,
2647 const git_checkout_options
*opts
)
2649 int error
, owned
= 0;
2650 git_iterator
*index_i
;
2652 if (!index
&& !repo
) {
2653 giterr_set(GITERR_CHECKOUT
,
2654 "must provide either repository or index to checkout");
2658 if (index
&& repo
&&
2659 git_index_owner(index
) &&
2660 git_index_owner(index
) != repo
) {
2661 giterr_set(GITERR_CHECKOUT
,
2662 "index to checkout does not match repository");
2664 } else if(index
&& repo
&& !git_index_owner(index
)) {
2665 GIT_REFCOUNT_OWN(index
, repo
);
2670 repo
= git_index_owner(index
);
2672 if (!index
&& (error
= git_repository_index__weakptr(&index
, repo
)) < 0)
2674 GIT_REFCOUNT_INC(index
);
2676 if (!(error
= git_iterator_for_index(&index_i
, repo
, index
, NULL
)))
2677 error
= git_checkout_iterator(index_i
, index
, opts
);
2680 GIT_REFCOUNT_OWN(index
, NULL
);
2682 git_iterator_free(index_i
);
2683 git_index_free(index
);
2688 int git_checkout_tree(
2689 git_repository
*repo
,
2690 const git_object
*treeish
,
2691 const git_checkout_options
*opts
)
2695 git_tree
*tree
= NULL
;
2696 git_iterator
*tree_i
= NULL
;
2697 git_iterator_options iter_opts
= GIT_ITERATOR_OPTIONS_INIT
;
2699 if (!treeish
&& !repo
) {
2700 giterr_set(GITERR_CHECKOUT
,
2701 "must provide either repository or tree to checkout");
2704 if (treeish
&& repo
&& git_object_owner(treeish
) != repo
) {
2705 giterr_set(GITERR_CHECKOUT
,
2706 "object to checkout does not match repository");
2711 repo
= git_object_owner(treeish
);
2714 if (git_object_peel((git_object
**)&tree
, treeish
, GIT_OBJ_TREE
) < 0) {
2716 GITERR_CHECKOUT
, "provided object cannot be peeled to a tree");
2721 if ((error
= checkout_lookup_head_tree(&tree
, repo
)) < 0) {
2722 if (error
!= GIT_EUNBORNBRANCH
)
2725 "HEAD could not be peeled to a tree and no treeish given");
2730 if ((error
= git_repository_index(&index
, repo
)) < 0)
2733 if (opts
&& (opts
->checkout_strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
)) {
2734 iter_opts
.pathlist
.count
= opts
->paths
.count
;
2735 iter_opts
.pathlist
.strings
= opts
->paths
.strings
;
2738 if (!(error
= git_iterator_for_tree(&tree_i
, tree
, &iter_opts
)))
2739 error
= git_checkout_iterator(tree_i
, index
, opts
);
2741 git_iterator_free(tree_i
);
2742 git_index_free(index
);
2743 git_tree_free(tree
);
2748 int git_checkout_head(
2749 git_repository
*repo
,
2750 const git_checkout_options
*opts
)
2753 return git_checkout_tree(repo
, NULL
, opts
);
2756 int git_checkout_init_options(git_checkout_options
*opts
, unsigned int version
)
2758 GIT_INIT_STRUCTURE_FROM_TEMPLATE(
2759 opts
, version
, git_checkout_options
, GIT_CHECKOUT_OPTIONS_INIT
);