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 (git_diff__oid_for_entry(&oid
, data
->diff
, wditem
, wditem
->mode
, NULL
) < 0)
218 /* Allow the checkout if the workdir is not modified *or* if the checkout
219 * target's contents are already in the working directory.
221 return !is_workdir_base_or_new(&oid
, baseitem
, newitem
);
224 #define CHECKOUT_ACTION_IF(FLAG,YES,NO) \
225 ((data->strategy & GIT_CHECKOUT_##FLAG) ? CHECKOUT_ACTION__##YES : CHECKOUT_ACTION__##NO)
227 static int checkout_action_common(
230 const git_diff_delta
*delta
,
231 const git_index_entry
*wd
)
233 git_checkout_notify_t notify
= GIT_CHECKOUT_NOTIFY_NONE
;
235 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0)
236 *action
= (*action
& ~CHECKOUT_ACTION__REMOVE
);
238 if ((*action
& CHECKOUT_ACTION__UPDATE_BLOB
) != 0) {
239 if (S_ISGITLINK(delta
->new_file
.mode
))
240 *action
= (*action
& ~CHECKOUT_ACTION__UPDATE_BLOB
) |
241 CHECKOUT_ACTION__UPDATE_SUBMODULE
;
243 /* to "update" a symlink, we must remove the old one first */
244 if (delta
->new_file
.mode
== GIT_FILEMODE_LINK
&& wd
!= NULL
)
245 *action
|= CHECKOUT_ACTION__REMOVE
;
247 /* if the file is on disk and doesn't match our mode, force update */
249 GIT_PERMS_IS_EXEC(wd
->mode
) !=
250 GIT_PERMS_IS_EXEC(delta
->new_file
.mode
))
251 *action
|= CHECKOUT_ACTION__REMOVE
;
253 notify
= GIT_CHECKOUT_NOTIFY_UPDATED
;
256 if ((*action
& CHECKOUT_ACTION__CONFLICT
) != 0)
257 notify
= GIT_CHECKOUT_NOTIFY_CONFLICT
;
259 return checkout_notify(data
, notify
, delta
, wd
);
262 static int checkout_action_no_wd(
265 const git_diff_delta
*delta
)
269 *action
= CHECKOUT_ACTION__NONE
;
271 switch (delta
->status
) {
272 case GIT_DELTA_UNMODIFIED
: /* case 12 */
273 error
= checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, NULL
);
276 *action
= CHECKOUT_ACTION_IF(RECREATE_MISSING
, UPDATE_BLOB
, NONE
);
278 case GIT_DELTA_ADDED
: /* case 2 or 28 (and 5 but not really) */
279 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
281 case GIT_DELTA_MODIFIED
: /* case 13 (and 35 but not really) */
282 *action
= CHECKOUT_ACTION_IF(RECREATE_MISSING
, UPDATE_BLOB
, CONFLICT
);
284 case GIT_DELTA_TYPECHANGE
: /* case 21 (B->T) and 28 (T->B)*/
285 if (delta
->new_file
.mode
== GIT_FILEMODE_TREE
)
286 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
288 case GIT_DELTA_DELETED
: /* case 8 or 25 */
289 *action
= CHECKOUT_ACTION_IF(SAFE
, REMOVE
, NONE
);
291 default: /* impossible */
295 return checkout_action_common(action
, data
, delta
, NULL
);
298 static int checkout_target_fullpath(
299 git_buf
**out
, checkout_data
*data
, const char *path
)
301 git_buf_truncate(&data
->target_path
, data
->target_len
);
303 if (path
&& git_buf_puts(&data
->target_path
, path
) < 0)
306 *out
= &data
->target_path
;
311 static bool wd_item_is_removable(
312 checkout_data
*data
, const git_index_entry
*wd
)
316 if (wd
->mode
!= GIT_FILEMODE_TREE
)
319 if (checkout_target_fullpath(&full
, data
, wd
->path
) < 0)
322 return !full
|| !git_path_contains(full
, DOT_GIT
);
325 static int checkout_queue_remove(checkout_data
*data
, const char *path
)
327 char *copy
= git_pool_strdup(&data
->pool
, path
);
328 GITERR_CHECK_ALLOC(copy
);
329 return git_vector_insert(&data
->removes
, copy
);
332 /* note that this advances the iterator over the wd item */
333 static int checkout_action_wd_only(
335 git_iterator
*workdir
,
336 const git_index_entry
**wditem
,
337 git_vector
*pathspec
)
341 git_checkout_notify_t notify
= GIT_CHECKOUT_NOTIFY_NONE
;
342 const git_index_entry
*wd
= *wditem
;
344 if (!git_pathspec__match(
346 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
347 git_iterator_ignore_case(workdir
), NULL
, NULL
))
348 return git_iterator_advance(wditem
, workdir
);
350 /* check if item is tracked in the index but not in the checkout diff */
351 if (data
->index
!= NULL
) {
354 error
= git_index__find_pos(
355 &pos
, data
->index
, wd
->path
, 0, GIT_INDEX_STAGE_ANY
);
357 if (wd
->mode
!= GIT_FILEMODE_TREE
) {
358 if (!error
) { /* found by git_index__find_pos call */
359 notify
= GIT_CHECKOUT_NOTIFY_DIRTY
;
360 remove
= ((data
->strategy
& GIT_CHECKOUT_FORCE
) != 0);
361 } else if (error
!= GIT_ENOTFOUND
)
364 error
= 0; /* git_index__find_pos does not set error msg */
366 /* for tree entries, we have to see if there are any index
367 * entries that are contained inside that tree
369 const git_index_entry
*e
= git_index_get_byindex(data
->index
, pos
);
371 if (e
!= NULL
&& data
->diff
->pfxcomp(e
->path
, wd
->path
) == 0) {
372 notify
= GIT_CHECKOUT_NOTIFY_DIRTY
;
373 remove
= ((data
->strategy
& GIT_CHECKOUT_FORCE
) != 0);
378 if (notify
!= GIT_CHECKOUT_NOTIFY_NONE
) {
379 /* if we found something in the index, notify and advance */
380 if ((error
= checkout_notify(data
, notify
, NULL
, wd
)) != 0)
383 if (remove
&& wd_item_is_removable(data
, wd
))
384 error
= checkout_queue_remove(data
, wd
->path
);
387 error
= git_iterator_advance(wditem
, workdir
);
389 /* untracked or ignored - can't know which until we advance through */
390 bool over
= false, removable
= wd_item_is_removable(data
, wd
);
391 git_iterator_status_t untracked_state
;
393 /* copy the entry for issuing notification callback later */
394 git_index_entry saved_wd
= *wd
;
395 git_buf_sets(&data
->tmp
, wd
->path
);
396 saved_wd
.path
= data
->tmp
.ptr
;
398 error
= git_iterator_advance_over(
399 wditem
, &untracked_state
, workdir
);
400 if (error
== GIT_ITEROVER
)
405 if (untracked_state
== GIT_ITERATOR_STATUS_IGNORED
) {
406 notify
= GIT_CHECKOUT_NOTIFY_IGNORED
;
407 remove
= ((data
->strategy
& GIT_CHECKOUT_REMOVE_IGNORED
) != 0);
409 notify
= GIT_CHECKOUT_NOTIFY_UNTRACKED
;
410 remove
= ((data
->strategy
& GIT_CHECKOUT_REMOVE_UNTRACKED
) != 0);
413 if ((error
= checkout_notify(data
, notify
, NULL
, &saved_wd
)) != 0)
416 if (remove
&& removable
)
417 error
= checkout_queue_remove(data
, saved_wd
.path
);
419 if (!error
&& over
) /* restore ITEROVER if needed */
420 error
= GIT_ITEROVER
;
426 static bool submodule_is_config_only(
430 git_submodule
*sm
= NULL
;
431 unsigned int sm_loc
= 0;
434 if (git_submodule_lookup(&sm
, data
->repo
, path
) < 0)
437 if (git_submodule_location(&sm_loc
, sm
) < 0 ||
438 sm_loc
== GIT_SUBMODULE_STATUS_IN_CONFIG
)
441 git_submodule_free(sm
);
446 static bool checkout_is_empty_dir(checkout_data
*data
, const char *path
)
450 if (checkout_target_fullpath(&fullpath
, data
, path
) < 0)
453 return git_path_is_empty_dir(fullpath
->ptr
);
456 static int checkout_action_with_wd(
459 const git_diff_delta
*delta
,
460 git_iterator
*workdir
,
461 const git_index_entry
*wd
)
463 *action
= CHECKOUT_ACTION__NONE
;
465 switch (delta
->status
) {
466 case GIT_DELTA_UNMODIFIED
: /* case 14/15 or 33 */
467 if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
)) {
469 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, wd
) );
470 *action
= CHECKOUT_ACTION_IF(FORCE
, UPDATE_BLOB
, NONE
);
473 case GIT_DELTA_ADDED
: /* case 3, 4 or 6 */
474 if (git_iterator_current_is_ignored(workdir
))
475 *action
= CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED
, CONFLICT
, UPDATE_BLOB
);
477 *action
= CHECKOUT_ACTION_IF(FORCE
, UPDATE_BLOB
, CONFLICT
);
479 case GIT_DELTA_DELETED
: /* case 9 or 10 (or 26 but not really) */
480 if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
))
481 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE
, CONFLICT
);
483 *action
= CHECKOUT_ACTION_IF(SAFE
, REMOVE
, NONE
);
485 case GIT_DELTA_MODIFIED
: /* case 16, 17, 18 (or 36 but not really) */
486 if (wd
->mode
!= GIT_FILEMODE_COMMIT
&&
487 checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
))
488 *action
= CHECKOUT_ACTION_IF(FORCE
, UPDATE_BLOB
, CONFLICT
);
490 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
492 case GIT_DELTA_TYPECHANGE
: /* case 22, 23, 29, 30 */
493 if (delta
->old_file
.mode
== GIT_FILEMODE_TREE
) {
494 if (wd
->mode
== GIT_FILEMODE_TREE
)
495 /* either deleting items in old tree will delete the wd dir,
496 * or we'll get a conflict when we attempt blob update...
498 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
499 else if (wd
->mode
== GIT_FILEMODE_COMMIT
) {
500 /* workdir is possibly a "phantom" submodule - treat as a
501 * tree if the only submodule info came from the config
503 if (submodule_is_config_only(data
, wd
->path
))
504 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
506 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
508 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE
, CONFLICT
);
510 else if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
))
511 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
513 *action
= CHECKOUT_ACTION_IF(SAFE
, REMOVE_AND_UPDATE
, NONE
);
515 /* don't update if the typechange is to a tree */
516 if (delta
->new_file
.mode
== GIT_FILEMODE_TREE
)
517 *action
= (*action
& ~CHECKOUT_ACTION__UPDATE_BLOB
);
519 default: /* impossible */
523 return checkout_action_common(action
, data
, delta
, wd
);
526 static int checkout_action_with_wd_blocker(
529 const git_diff_delta
*delta
,
530 const git_index_entry
*wd
)
532 *action
= CHECKOUT_ACTION__NONE
;
534 switch (delta
->status
) {
535 case GIT_DELTA_UNMODIFIED
:
536 /* should show delta as dirty / deleted */
538 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, wd
) );
539 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, NONE
);
541 case GIT_DELTA_ADDED
:
542 case GIT_DELTA_MODIFIED
:
543 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
545 case GIT_DELTA_DELETED
:
546 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE
, CONFLICT
);
548 case GIT_DELTA_TYPECHANGE
:
549 /* not 100% certain about this... */
550 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
552 default: /* impossible */
556 return checkout_action_common(action
, data
, delta
, wd
);
559 static int checkout_action_with_wd_dir(
562 const git_diff_delta
*delta
,
563 git_iterator
*workdir
,
564 const git_index_entry
*wd
)
566 *action
= CHECKOUT_ACTION__NONE
;
568 switch (delta
->status
) {
569 case GIT_DELTA_UNMODIFIED
: /* case 19 or 24 (or 34 but not really) */
571 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, NULL
));
573 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_UNTRACKED
, NULL
, wd
));
574 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, NONE
);
576 case GIT_DELTA_ADDED
:/* case 4 (and 7 for dir) */
577 case GIT_DELTA_MODIFIED
: /* case 20 (or 37 but not really) */
578 if (delta
->old_file
.mode
== GIT_FILEMODE_COMMIT
)
579 /* expected submodule (and maybe found one) */;
580 else if (delta
->new_file
.mode
!= GIT_FILEMODE_TREE
)
581 *action
= git_iterator_current_is_ignored(workdir
) ?
582 CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED
, CONFLICT
, REMOVE_AND_UPDATE
) :
583 CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
585 case GIT_DELTA_DELETED
: /* case 11 (and 27 for dir) */
586 if (delta
->old_file
.mode
!= GIT_FILEMODE_TREE
)
588 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_UNTRACKED
, NULL
, wd
));
590 case GIT_DELTA_TYPECHANGE
: /* case 24 or 31 */
591 if (delta
->old_file
.mode
== GIT_FILEMODE_TREE
) {
592 /* For typechange from dir, remove dir and add blob, but it is
593 * not safe to remove dir if it contains modified files.
594 * However, safely removing child files will remove the parent
595 * directory if is it left empty, so we can defer removing the
596 * dir and it will succeed if no children are left.
598 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
600 else if (delta
->new_file
.mode
!= GIT_FILEMODE_TREE
)
601 /* For typechange to dir, dir is already created so no action */
602 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
604 default: /* impossible */
608 return checkout_action_common(action
, data
, delta
, wd
);
611 static int checkout_action_with_wd_dir_empty(
614 const git_diff_delta
*delta
)
616 int error
= checkout_action_no_wd(action
, data
, delta
);
618 /* We can always safely remove an empty directory. */
619 if (error
== 0 && *action
!= CHECKOUT_ACTION__NONE
)
620 *action
|= CHECKOUT_ACTION__REMOVE
;
625 static int checkout_action(
628 git_diff_delta
*delta
,
629 git_iterator
*workdir
,
630 const git_index_entry
**wditem
,
631 git_vector
*pathspec
)
634 int (*strcomp
)(const char *, const char *) = data
->diff
->strcomp
;
635 int (*pfxcomp
)(const char *str
, const char *pfx
) = data
->diff
->pfxcomp
;
636 int (*advance
)(const git_index_entry
**, git_iterator
*) = NULL
;
638 /* move workdir iterator to follow along with deltas */
641 const git_index_entry
*wd
= *wditem
;
644 return checkout_action_no_wd(action
, data
, delta
);
646 cmp
= strcomp(wd
->path
, delta
->old_file
.path
);
648 /* 1. wd before delta ("a/a" before "a/b")
649 * 2. wd prefixes delta & should expand ("a/" before "a/b")
650 * 3. wd prefixes delta & cannot expand ("a/b" before "a/b/c")
651 * 4. wd equals delta ("a/b" and "a/b")
652 * 5. wd after delta & delta prefixes wd ("a/b/c" after "a/b/" or "a/b")
653 * 6. wd after delta ("a/c" after "a/b")
657 cmp
= pfxcomp(delta
->old_file
.path
, wd
->path
);
660 if (wd
->mode
== GIT_FILEMODE_TREE
) {
661 /* case 2 - entry prefixed by workdir tree */
662 error
= git_iterator_advance_into(wditem
, workdir
);
663 if (error
< 0 && error
!= GIT_ITEROVER
)
668 /* case 3 maybe - wd contains non-dir where dir expected */
669 if (delta
->old_file
.path
[strlen(wd
->path
)] == '/') {
670 error
= checkout_action_with_wd_blocker(
671 action
, data
, delta
, wd
);
672 advance
= git_iterator_advance
;
677 /* case 1 - handle wd item (if it matches pathspec) */
678 error
= checkout_action_wd_only(data
, workdir
, wditem
, pathspec
);
679 if (error
&& error
!= GIT_ITEROVER
)
686 error
= checkout_action_with_wd(action
, data
, delta
, workdir
, wd
);
687 advance
= git_iterator_advance
;
691 cmp
= pfxcomp(wd
->path
, delta
->old_file
.path
);
693 if (cmp
== 0) { /* case 5 */
694 if (wd
->path
[strlen(delta
->old_file
.path
)] != '/')
695 return checkout_action_no_wd(action
, data
, delta
);
697 if (delta
->status
== GIT_DELTA_TYPECHANGE
) {
698 if (delta
->old_file
.mode
== GIT_FILEMODE_TREE
) {
699 error
= checkout_action_with_wd(action
, data
, delta
, workdir
, wd
);
700 advance
= git_iterator_advance_into
;
704 if (delta
->new_file
.mode
== GIT_FILEMODE_TREE
||
705 delta
->new_file
.mode
== GIT_FILEMODE_COMMIT
||
706 delta
->old_file
.mode
== GIT_FILEMODE_COMMIT
)
708 error
= checkout_action_with_wd(action
, data
, delta
, workdir
, wd
);
709 advance
= git_iterator_advance
;
714 return checkout_is_empty_dir(data
, wd
->path
) ?
715 checkout_action_with_wd_dir_empty(action
, data
, delta
) :
716 checkout_action_with_wd_dir(action
, data
, delta
, workdir
, wd
);
719 /* case 6 - wd is after delta */
720 return checkout_action_no_wd(action
, data
, delta
);
724 if (!error
&& advance
!= NULL
&&
725 (error
= advance(wditem
, workdir
)) < 0) {
727 if (error
== GIT_ITEROVER
)
734 static int checkout_remaining_wd_items(
736 git_iterator
*workdir
,
737 const git_index_entry
*wd
,
743 error
= checkout_action_wd_only(data
, workdir
, &wd
, spec
);
745 if (error
== GIT_ITEROVER
)
751 GIT_INLINE(int) checkout_idxentry_cmp(
752 const git_index_entry
*a
,
753 const git_index_entry
*b
)
762 return strcmp(a
->path
, b
->path
);
765 static int checkout_conflictdata_cmp(const void *a
, const void *b
)
767 const checkout_conflictdata
*ca
= a
;
768 const checkout_conflictdata
*cb
= b
;
771 if ((diff
= checkout_idxentry_cmp(ca
->ancestor
, cb
->ancestor
)) == 0 &&
772 (diff
= checkout_idxentry_cmp(ca
->ours
, cb
->theirs
)) == 0)
773 diff
= checkout_idxentry_cmp(ca
->theirs
, cb
->theirs
);
778 int checkout_conflictdata_empty(
779 const git_vector
*conflicts
, size_t idx
, void *payload
)
781 checkout_conflictdata
*conflict
;
785 if ((conflict
= git_vector_get(conflicts
, idx
)) == NULL
)
788 if (conflict
->ancestor
|| conflict
->ours
|| conflict
->theirs
)
795 GIT_INLINE(bool) conflict_pathspec_match(
797 git_iterator
*workdir
,
798 git_vector
*pathspec
,
799 const git_index_entry
*ancestor
,
800 const git_index_entry
*ours
,
801 const git_index_entry
*theirs
)
803 /* if the pathspec matches ours *or* theirs, proceed */
804 if (ours
&& git_pathspec__match(pathspec
, ours
->path
,
805 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
806 git_iterator_ignore_case(workdir
), NULL
, NULL
))
809 if (theirs
&& git_pathspec__match(pathspec
, theirs
->path
,
810 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
811 git_iterator_ignore_case(workdir
), NULL
, NULL
))
814 if (ancestor
&& git_pathspec__match(pathspec
, ancestor
->path
,
815 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
816 git_iterator_ignore_case(workdir
), NULL
, NULL
))
822 GIT_INLINE(int) checkout_conflict_detect_submodule(checkout_conflictdata
*conflict
)
824 conflict
->submodule
= ((conflict
->ancestor
&& S_ISGITLINK(conflict
->ancestor
->mode
)) ||
825 (conflict
->ours
&& S_ISGITLINK(conflict
->ours
->mode
)) ||
826 (conflict
->theirs
&& S_ISGITLINK(conflict
->theirs
->mode
)));
830 GIT_INLINE(int) checkout_conflict_detect_binary(git_repository
*repo
, checkout_conflictdata
*conflict
)
832 git_blob
*ancestor_blob
= NULL
, *our_blob
= NULL
, *their_blob
= NULL
;
835 if (conflict
->submodule
)
838 if (conflict
->ancestor
) {
839 if ((error
= git_blob_lookup(&ancestor_blob
, repo
, &conflict
->ancestor
->id
)) < 0)
842 conflict
->binary
= git_blob_is_binary(ancestor_blob
);
845 if (!conflict
->binary
&& conflict
->ours
) {
846 if ((error
= git_blob_lookup(&our_blob
, repo
, &conflict
->ours
->id
)) < 0)
849 conflict
->binary
= git_blob_is_binary(our_blob
);
852 if (!conflict
->binary
&& conflict
->theirs
) {
853 if ((error
= git_blob_lookup(&their_blob
, repo
, &conflict
->theirs
->id
)) < 0)
856 conflict
->binary
= git_blob_is_binary(their_blob
);
860 git_blob_free(ancestor_blob
);
861 git_blob_free(our_blob
);
862 git_blob_free(their_blob
);
867 static int checkout_conflict_append_update(
868 const git_index_entry
*ancestor
,
869 const git_index_entry
*ours
,
870 const git_index_entry
*theirs
,
873 checkout_data
*data
= payload
;
874 checkout_conflictdata
*conflict
;
877 conflict
= git__calloc(1, sizeof(checkout_conflictdata
));
878 GITERR_CHECK_ALLOC(conflict
);
880 conflict
->ancestor
= ancestor
;
881 conflict
->ours
= ours
;
882 conflict
->theirs
= theirs
;
884 if ((error
= checkout_conflict_detect_submodule(conflict
)) < 0 ||
885 (error
= checkout_conflict_detect_binary(data
->repo
, conflict
)) < 0)
891 if (git_vector_insert(&data
->update_conflicts
, conflict
))
897 static int checkout_conflicts_foreach(
900 git_iterator
*workdir
,
901 git_vector
*pathspec
,
902 int (*cb
)(const git_index_entry
*, const git_index_entry
*, const git_index_entry
*, void *),
905 git_index_conflict_iterator
*iterator
= NULL
;
906 const git_index_entry
*ancestor
, *ours
, *theirs
;
909 if ((error
= git_index_conflict_iterator_new(&iterator
, index
)) < 0)
912 /* Collect the conflicts */
913 while ((error
= git_index_conflict_next(&ancestor
, &ours
, &theirs
, iterator
)) == 0) {
914 if (!conflict_pathspec_match(data
, workdir
, pathspec
, ancestor
, ours
, theirs
))
917 if ((error
= cb(ancestor
, ours
, theirs
, payload
)) < 0)
921 if (error
== GIT_ITEROVER
)
925 git_index_conflict_iterator_free(iterator
);
930 static int checkout_conflicts_load(checkout_data
*data
, git_iterator
*workdir
, git_vector
*pathspec
)
934 /* Only write conficts from sources that have them: indexes. */
935 if ((index
= git_iterator_index(data
->target
)) == NULL
)
938 data
->update_conflicts
._cmp
= checkout_conflictdata_cmp
;
940 if (checkout_conflicts_foreach(data
, index
, workdir
, pathspec
, checkout_conflict_append_update
, data
) < 0)
943 /* Collect the REUC and NAME entries */
944 data
->update_reuc
= &index
->reuc
;
945 data
->update_names
= &index
->names
;
950 GIT_INLINE(int) checkout_conflicts_cmp_entry(
952 const git_index_entry
*entry
)
954 return strcmp((const char *)path
, entry
->path
);
957 static int checkout_conflicts_cmp_ancestor(const void *p
, const void *c
)
959 const char *path
= p
;
960 const checkout_conflictdata
*conflict
= c
;
962 if (!conflict
->ancestor
)
965 return checkout_conflicts_cmp_entry(path
, conflict
->ancestor
);
968 static checkout_conflictdata
*checkout_conflicts_search_ancestor(
974 if (git_vector_bsearch2(&pos
, &data
->update_conflicts
, checkout_conflicts_cmp_ancestor
, path
) < 0)
977 return git_vector_get(&data
->update_conflicts
, pos
);
980 static checkout_conflictdata
*checkout_conflicts_search_branch(
984 checkout_conflictdata
*conflict
;
987 git_vector_foreach(&data
->update_conflicts
, i
, conflict
) {
990 if (conflict
->ancestor
)
994 cmp
= checkout_conflicts_cmp_entry(path
, conflict
->ours
);
995 else if (conflict
->theirs
)
996 cmp
= checkout_conflicts_cmp_entry(path
, conflict
->theirs
);
1005 static int checkout_conflicts_load_byname_entry(
1006 checkout_conflictdata
**ancestor_out
,
1007 checkout_conflictdata
**ours_out
,
1008 checkout_conflictdata
**theirs_out
,
1009 checkout_data
*data
,
1010 const git_index_name_entry
*name_entry
)
1012 checkout_conflictdata
*ancestor
, *ours
= NULL
, *theirs
= NULL
;
1015 *ancestor_out
= NULL
;
1019 if (!name_entry
->ancestor
) {
1020 giterr_set(GITERR_INDEX
, "A NAME entry exists without an ancestor");
1025 if (!name_entry
->ours
&& !name_entry
->theirs
) {
1026 giterr_set(GITERR_INDEX
, "A NAME entry exists without an ours or theirs");
1031 if ((ancestor
= checkout_conflicts_search_ancestor(data
,
1032 name_entry
->ancestor
)) == NULL
) {
1033 giterr_set(GITERR_INDEX
,
1034 "A NAME entry referenced ancestor entry '%s' which does not exist in the main index",
1035 name_entry
->ancestor
);
1040 if (name_entry
->ours
) {
1041 if (strcmp(name_entry
->ancestor
, name_entry
->ours
) == 0)
1043 else if ((ours
= checkout_conflicts_search_branch(data
, name_entry
->ours
)) == NULL
||
1044 ours
->ours
== NULL
) {
1045 giterr_set(GITERR_INDEX
,
1046 "A NAME entry referenced our entry '%s' which does not exist in the main index",
1053 if (name_entry
->theirs
) {
1054 if (strcmp(name_entry
->ancestor
, name_entry
->theirs
) == 0)
1056 else if (name_entry
->ours
&& strcmp(name_entry
->ours
, name_entry
->theirs
) == 0)
1058 else if ((theirs
= checkout_conflicts_search_branch(data
, name_entry
->theirs
)) == NULL
||
1059 theirs
->theirs
== NULL
) {
1060 giterr_set(GITERR_INDEX
,
1061 "A NAME entry referenced their entry '%s' which does not exist in the main index",
1062 name_entry
->theirs
);
1068 *ancestor_out
= ancestor
;
1070 *theirs_out
= theirs
;
1076 static int checkout_conflicts_coalesce_renames(
1077 checkout_data
*data
)
1080 const git_index_name_entry
*name_entry
;
1081 checkout_conflictdata
*ancestor_conflict
, *our_conflict
, *their_conflict
;
1085 if ((index
= git_iterator_index(data
->target
)) == NULL
)
1088 /* Juggle entries based on renames */
1089 names
= git_index_name_entrycount(index
);
1091 for (i
= 0; i
< names
; i
++) {
1092 name_entry
= git_index_name_get_byindex(index
, i
);
1094 if ((error
= checkout_conflicts_load_byname_entry(
1095 &ancestor_conflict
, &our_conflict
, &their_conflict
,
1096 data
, name_entry
)) < 0)
1099 if (our_conflict
&& our_conflict
!= ancestor_conflict
) {
1100 ancestor_conflict
->ours
= our_conflict
->ours
;
1101 our_conflict
->ours
= NULL
;
1103 if (our_conflict
->theirs
)
1104 our_conflict
->name_collision
= 1;
1106 if (our_conflict
->name_collision
)
1107 ancestor_conflict
->name_collision
= 1;
1110 if (their_conflict
&& their_conflict
!= ancestor_conflict
) {
1111 ancestor_conflict
->theirs
= their_conflict
->theirs
;
1112 their_conflict
->theirs
= NULL
;
1114 if (their_conflict
->ours
)
1115 their_conflict
->name_collision
= 1;
1117 if (their_conflict
->name_collision
)
1118 ancestor_conflict
->name_collision
= 1;
1121 if (our_conflict
&& our_conflict
!= ancestor_conflict
&&
1122 their_conflict
&& their_conflict
!= ancestor_conflict
)
1123 ancestor_conflict
->one_to_two
= 1;
1126 git_vector_remove_matching(
1127 &data
->update_conflicts
, checkout_conflictdata_empty
, NULL
);
1133 static int checkout_conflicts_mark_directoryfile(
1134 checkout_data
*data
)
1137 checkout_conflictdata
*conflict
;
1138 const git_index_entry
*entry
;
1141 int prefixed
, error
= 0;
1143 if ((index
= git_iterator_index(data
->target
)) == NULL
)
1146 len
= git_index_entrycount(index
);
1148 /* Find d/f conflicts */
1149 git_vector_foreach(&data
->update_conflicts
, i
, conflict
) {
1150 if ((conflict
->ours
&& conflict
->theirs
) ||
1151 (!conflict
->ours
&& !conflict
->theirs
))
1154 path
= conflict
->ours
?
1155 conflict
->ours
->path
: conflict
->theirs
->path
;
1157 if ((error
= git_index_find(&j
, index
, path
)) < 0) {
1158 if (error
== GIT_ENOTFOUND
)
1159 giterr_set(GITERR_INDEX
,
1160 "Index inconsistency, could not find entry for expected conflict '%s'", path
);
1165 for (; j
< len
; j
++) {
1166 if ((entry
= git_index_get_byindex(index
, j
)) == NULL
) {
1167 giterr_set(GITERR_INDEX
,
1168 "Index inconsistency, truncated index while loading expected conflict '%s'", path
);
1173 prefixed
= git_path_equal_or_prefixed(path
, entry
->path
, NULL
);
1175 if (prefixed
== GIT_PATH_EQUAL
)
1178 if (prefixed
== GIT_PATH_PREFIX
)
1179 conflict
->directoryfile
= 1;
1189 static int checkout_get_update_conflicts(
1190 checkout_data
*data
,
1191 git_iterator
*workdir
,
1192 git_vector
*pathspec
)
1196 if (data
->strategy
& GIT_CHECKOUT_SKIP_UNMERGED
)
1199 if ((error
= checkout_conflicts_load(data
, workdir
, pathspec
)) < 0 ||
1200 (error
= checkout_conflicts_coalesce_renames(data
)) < 0 ||
1201 (error
= checkout_conflicts_mark_directoryfile(data
)) < 0)
1208 static int checkout_conflict_append_remove(
1209 const git_index_entry
*ancestor
,
1210 const git_index_entry
*ours
,
1211 const git_index_entry
*theirs
,
1214 checkout_data
*data
= payload
;
1217 assert(ancestor
|| ours
|| theirs
);
1220 name
= git__strdup(ancestor
->path
);
1222 name
= git__strdup(ours
->path
);
1224 name
= git__strdup(theirs
->path
);
1228 GITERR_CHECK_ALLOC(name
);
1230 return git_vector_insert(&data
->remove_conflicts
, (char *)name
);
1233 static int checkout_get_remove_conflicts(
1234 checkout_data
*data
,
1235 git_iterator
*workdir
,
1236 git_vector
*pathspec
)
1238 if ((data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) != 0)
1241 return checkout_conflicts_foreach(data
, data
->index
, workdir
, pathspec
, checkout_conflict_append_remove
, data
);
1244 static int checkout_verify_paths(
1245 git_repository
*repo
,
1247 git_diff_delta
*delta
)
1249 unsigned int flags
= GIT_PATH_REJECT_WORKDIR_DEFAULTS
;
1251 if (action
& CHECKOUT_ACTION__REMOVE
) {
1252 if (!git_path_isvalid(repo
, delta
->old_file
.path
, flags
)) {
1253 giterr_set(GITERR_CHECKOUT
, "Cannot remove invalid path '%s'", delta
->old_file
.path
);
1258 if (action
& ~CHECKOUT_ACTION__REMOVE
) {
1259 if (!git_path_isvalid(repo
, delta
->new_file
.path
, flags
)) {
1260 giterr_set(GITERR_CHECKOUT
, "Cannot checkout to invalid path '%s'", delta
->new_file
.path
);
1268 static int checkout_get_actions(
1269 uint32_t **actions_ptr
,
1270 size_t **counts_ptr
,
1271 checkout_data
*data
,
1272 git_iterator
*workdir
)
1275 const git_index_entry
*wditem
;
1276 git_vector pathspec
= GIT_VECTOR_INIT
, *deltas
;
1278 git_diff_delta
*delta
;
1279 size_t i
, *counts
= NULL
;
1280 uint32_t *actions
= NULL
;
1282 git_pool_init(&pathpool
, 1);
1284 if (data
->opts
.paths
.count
> 0 &&
1285 git_pathspec__vinit(&pathspec
, &data
->opts
.paths
, &pathpool
) < 0)
1288 if ((error
= git_iterator_current(&wditem
, workdir
)) < 0 &&
1289 error
!= GIT_ITEROVER
)
1292 deltas
= &data
->diff
->deltas
;
1294 *counts_ptr
= counts
= git__calloc(CHECKOUT_ACTION__MAX
+1, sizeof(size_t));
1295 *actions_ptr
= actions
= git__calloc(
1296 deltas
->length
? deltas
->length
: 1, sizeof(uint32_t));
1297 if (!counts
|| !actions
) {
1302 git_vector_foreach(deltas
, i
, delta
) {
1303 if ((error
= checkout_action(&act
, data
, delta
, workdir
, &wditem
, &pathspec
)) == 0)
1304 error
= checkout_verify_paths(data
->repo
, act
, delta
);
1311 if (act
& CHECKOUT_ACTION__REMOVE
)
1312 counts
[CHECKOUT_ACTION__REMOVE
]++;
1313 if (act
& CHECKOUT_ACTION__UPDATE_BLOB
)
1314 counts
[CHECKOUT_ACTION__UPDATE_BLOB
]++;
1315 if (act
& CHECKOUT_ACTION__UPDATE_SUBMODULE
)
1316 counts
[CHECKOUT_ACTION__UPDATE_SUBMODULE
]++;
1317 if (act
& CHECKOUT_ACTION__CONFLICT
)
1318 counts
[CHECKOUT_ACTION__CONFLICT
]++;
1321 error
= checkout_remaining_wd_items(data
, workdir
, wditem
, &pathspec
);
1325 counts
[CHECKOUT_ACTION__REMOVE
] += data
->removes
.length
;
1327 if (counts
[CHECKOUT_ACTION__CONFLICT
] > 0 &&
1328 (data
->strategy
& GIT_CHECKOUT_ALLOW_CONFLICTS
) == 0)
1330 giterr_set(GITERR_CHECKOUT
, "%"PRIuZ
" %s checkout",
1331 counts
[CHECKOUT_ACTION__CONFLICT
],
1332 counts
[CHECKOUT_ACTION__CONFLICT
] == 1 ?
1333 "conflict prevents" : "conflicts prevent");
1334 error
= GIT_ECONFLICT
;
1339 if ((error
= checkout_get_remove_conflicts(data
, workdir
, &pathspec
)) < 0 ||
1340 (error
= checkout_get_update_conflicts(data
, workdir
, &pathspec
)) < 0)
1343 counts
[CHECKOUT_ACTION__REMOVE_CONFLICT
] = git_vector_length(&data
->remove_conflicts
);
1344 counts
[CHECKOUT_ACTION__UPDATE_CONFLICT
] = git_vector_length(&data
->update_conflicts
);
1346 git_pathspec__vfree(&pathspec
);
1347 git_pool_clear(&pathpool
);
1354 *actions_ptr
= NULL
;
1357 git_pathspec__vfree(&pathspec
);
1358 git_pool_clear(&pathpool
);
1363 static bool should_remove_existing(checkout_data
*data
)
1367 if (git_repository__cvar(&ignorecase
, data
->repo
, GIT_CVAR_IGNORECASE
) < 0) {
1371 return (ignorecase
&&
1372 (data
->strategy
& GIT_CHECKOUT_DONT_REMOVE_EXISTING
) == 0);
1375 #define MKDIR_NORMAL \
1376 GIT_MKDIR_PATH | GIT_MKDIR_VERIFY_DIR
1377 #define MKDIR_REMOVE_EXISTING \
1378 MKDIR_NORMAL | GIT_MKDIR_REMOVE_FILES | GIT_MKDIR_REMOVE_SYMLINKS
1380 static int checkout_mkdir(
1381 checkout_data
*data
,
1387 struct git_futils_mkdir_options mkdir_opts
= {0};
1390 mkdir_opts
.dir_map
= data
->mkdir_map
;
1391 mkdir_opts
.pool
= &data
->pool
;
1393 error
= git_futils_mkdir_relative(
1394 path
, base
, mode
, flags
, &mkdir_opts
);
1396 data
->perfdata
.mkdir_calls
+= mkdir_opts
.perfdata
.mkdir_calls
;
1397 data
->perfdata
.stat_calls
+= mkdir_opts
.perfdata
.stat_calls
;
1398 data
->perfdata
.chmod_calls
+= mkdir_opts
.perfdata
.chmod_calls
;
1403 static int mkpath2file(
1404 checkout_data
*data
, const char *path
, unsigned int mode
)
1407 bool remove_existing
= should_remove_existing(data
);
1408 unsigned int flags
=
1409 (remove_existing
? MKDIR_REMOVE_EXISTING
: MKDIR_NORMAL
) |
1410 GIT_MKDIR_SKIP_LAST
;
1413 if ((error
= checkout_mkdir(
1414 data
, path
, data
->opts
.target_directory
, mode
, flags
)) < 0)
1417 if (remove_existing
) {
1418 data
->perfdata
.stat_calls
++;
1420 if (p_lstat(path
, &st
) == 0) {
1422 /* Some file, symlink or folder already exists at this name.
1423 * We would have removed it in remove_the_old unless we're on
1424 * a case inensitive filesystem (or the user has asked us not
1425 * to). Remove the similarly named file to write the new.
1427 error
= git_futils_rmdir_r(path
, NULL
, GIT_RMDIR_REMOVE_FILES
);
1428 } else if (errno
!= ENOENT
) {
1429 giterr_set(GITERR_OS
, "Failed to stat file '%s'", path
);
1439 struct checkout_stream
{
1440 git_writestream base
;
1446 static int checkout_stream_write(
1447 git_writestream
*s
, const char *buffer
, size_t len
)
1449 struct checkout_stream
*stream
= (struct checkout_stream
*)s
;
1452 if ((ret
= p_write(stream
->fd
, buffer
, len
)) < 0)
1453 giterr_set(GITERR_OS
, "Could not write to '%s'", stream
->path
);
1458 static int checkout_stream_close(git_writestream
*s
)
1460 struct checkout_stream
*stream
= (struct checkout_stream
*)s
;
1461 assert(stream
&& stream
->open
);
1464 return p_close(stream
->fd
);
1467 static void checkout_stream_free(git_writestream
*s
)
1472 static int blob_content_to_file(
1473 checkout_data
*data
,
1477 const char *hint_path
,
1478 mode_t entry_filemode
)
1480 int flags
= data
->opts
.file_open_flags
;
1481 mode_t file_mode
= data
->opts
.file_mode
?
1482 data
->opts
.file_mode
: entry_filemode
;
1483 git_filter_options filter_opts
= GIT_FILTER_OPTIONS_INIT
;
1484 struct checkout_stream writer
;
1486 git_filter_list
*fl
= NULL
;
1490 if (hint_path
== NULL
)
1493 if ((error
= mkpath2file(data
, path
, data
->opts
.dir_mode
)) < 0)
1497 flags
= O_CREAT
| O_TRUNC
| O_WRONLY
;
1498 if (!(mode
= file_mode
))
1499 mode
= GIT_FILEMODE_BLOB
;
1501 if ((fd
= p_open(path
, flags
, mode
)) < 0) {
1502 giterr_set(GITERR_OS
, "Could not open '%s' for writing", path
);
1506 filter_opts
.attr_session
= &data
->attr_session
;
1507 filter_opts
.temp_buf
= &data
->tmp
;
1509 if (!data
->opts
.disable_filters
&&
1510 (error
= git_filter_list__load_ext(
1511 &fl
, data
->repo
, blob
, hint_path
,
1512 GIT_FILTER_TO_WORKTREE
, &filter_opts
))) {
1517 /* setup the writer */
1518 memset(&writer
, 0, sizeof(struct checkout_stream
));
1519 writer
.base
.write
= checkout_stream_write
;
1520 writer
.base
.close
= checkout_stream_close
;
1521 writer
.base
.free
= checkout_stream_free
;
1526 error
= git_filter_list_stream_blob(fl
, blob
, &writer
.base
);
1528 assert(writer
.open
== 0);
1530 git_filter_list_free(fl
);
1536 data
->perfdata
.stat_calls
++;
1538 if ((error
= p_stat(path
, st
)) < 0) {
1539 giterr_set(GITERR_OS
, "Error statting '%s'", path
);
1543 st
->st_mode
= entry_filemode
;
1549 static int blob_content_to_link(
1550 checkout_data
*data
,
1555 git_buf linktarget
= GIT_BUF_INIT
;
1558 if ((error
= mkpath2file(data
, path
, data
->opts
.dir_mode
)) < 0)
1561 if ((error
= git_blob__getbuf(&linktarget
, blob
)) < 0)
1564 if (data
->can_symlink
) {
1565 if ((error
= p_symlink(git_buf_cstr(&linktarget
), path
)) < 0)
1566 giterr_set(GITERR_OS
, "Could not create symlink %s", path
);
1568 error
= git_futils_fake_symlink(git_buf_cstr(&linktarget
), path
);
1572 data
->perfdata
.stat_calls
++;
1574 if ((error
= p_lstat(path
, st
)) < 0)
1575 giterr_set(GITERR_CHECKOUT
, "Could not stat symlink %s", path
);
1577 st
->st_mode
= GIT_FILEMODE_LINK
;
1580 git_buf_free(&linktarget
);
1585 static int checkout_update_index(
1586 checkout_data
*data
,
1587 const git_diff_file
*file
,
1590 git_index_entry entry
;
1595 memset(&entry
, 0, sizeof(entry
));
1596 entry
.path
= (char *)file
->path
; /* cast to prevent warning */
1597 git_index_entry__init_from_stat(&entry
, st
, true);
1598 git_oid_cpy(&entry
.id
, &file
->id
);
1600 return git_index_add(data
->index
, &entry
);
1603 static int checkout_submodule_update_index(
1604 checkout_data
*data
,
1605 const git_diff_file
*file
)
1610 /* update the index unless prevented */
1611 if ((data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) != 0)
1614 if (checkout_target_fullpath(&fullpath
, data
, file
->path
) < 0)
1617 data
->perfdata
.stat_calls
++;
1618 if (p_stat(fullpath
->ptr
, &st
) < 0) {
1620 GITERR_CHECKOUT
, "Could not stat submodule %s\n", file
->path
);
1621 return GIT_ENOTFOUND
;
1624 st
.st_mode
= GIT_FILEMODE_COMMIT
;
1626 return checkout_update_index(data
, file
, &st
);
1629 static int checkout_submodule(
1630 checkout_data
*data
,
1631 const git_diff_file
*file
)
1633 bool remove_existing
= should_remove_existing(data
);
1636 /* Until submodules are supported, UPDATE_ONLY means do nothing here */
1637 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0)
1640 if ((error
= checkout_mkdir(
1642 file
->path
, data
->opts
.target_directory
, data
->opts
.dir_mode
,
1643 remove_existing
? MKDIR_REMOVE_EXISTING
: MKDIR_NORMAL
)) < 0)
1646 if ((error
= git_submodule_lookup(NULL
, data
->repo
, file
->path
)) < 0) {
1647 /* I've observed repos with submodules in the tree that do not
1648 * have a .gitmodules - core Git just makes an empty directory
1650 if (error
== GIT_ENOTFOUND
) {
1652 return checkout_submodule_update_index(data
, file
);
1658 /* TODO: Support checkout_strategy options. Two circumstances:
1659 * 1 - submodule already checked out, but we need to move the HEAD
1660 * to the new OID, or
1661 * 2 - submodule not checked out and we should recursively check it out
1663 * Checkout will not execute a pull on the submodule, but a clone
1664 * command should probably be able to. Do we need a submodule callback?
1667 return checkout_submodule_update_index(data
, file
);
1670 static void report_progress(
1671 checkout_data
*data
,
1674 if (data
->opts
.progress_cb
)
1675 data
->opts
.progress_cb(
1676 path
, data
->completed_steps
, data
->total_steps
,
1677 data
->opts
.progress_payload
);
1680 static int checkout_safe_for_update_only(
1681 checkout_data
*data
, const char *path
, mode_t expected_mode
)
1685 data
->perfdata
.stat_calls
++;
1687 if (p_lstat(path
, &st
) < 0) {
1688 /* if doesn't exist, then no error and no update */
1689 if (errno
== ENOENT
|| errno
== ENOTDIR
)
1692 /* otherwise, stat error and no update */
1693 giterr_set(GITERR_OS
, "Failed to stat file '%s'", path
);
1697 /* only safe for update if this is the same type of file */
1698 if ((st
.st_mode
& ~0777) == (expected_mode
& ~0777))
1704 static int checkout_write_content(
1705 checkout_data
*data
,
1707 const char *full_path
,
1708 const char *hint_path
,
1715 if ((error
= git_blob_lookup(&blob
, data
->repo
, oid
)) < 0)
1719 error
= blob_content_to_link(data
, st
, blob
, full_path
);
1721 error
= blob_content_to_file(data
, st
, blob
, full_path
, hint_path
, mode
);
1723 git_blob_free(blob
);
1725 /* if we try to create the blob and an existing directory blocks it from
1726 * being written, then there must have been a typechange conflict in a
1727 * parent directory - suppress the error and try to continue.
1729 if ((data
->strategy
& GIT_CHECKOUT_ALLOW_CONFLICTS
) != 0 &&
1730 (error
== GIT_ENOTFOUND
|| error
== GIT_EEXISTS
))
1739 static int checkout_blob(
1740 checkout_data
*data
,
1741 const git_diff_file
*file
)
1747 if (checkout_target_fullpath(&fullpath
, data
, file
->path
) < 0)
1750 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0) {
1751 int rval
= checkout_safe_for_update_only(
1752 data
, fullpath
->ptr
, file
->mode
);
1758 error
= checkout_write_content(
1759 data
, &file
->id
, fullpath
->ptr
, NULL
, file
->mode
, &st
);
1761 /* update the index unless prevented */
1762 if (!error
&& (data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0)
1763 error
= checkout_update_index(data
, file
, &st
);
1765 /* update the submodule data if this was a new .gitmodules file */
1766 if (!error
&& strcmp(file
->path
, ".gitmodules") == 0)
1767 data
->reload_submodules
= true;
1772 static int checkout_remove_the_old(
1773 unsigned int *actions
,
1774 checkout_data
*data
)
1777 git_diff_delta
*delta
;
1781 uint32_t flg
= GIT_RMDIR_EMPTY_PARENTS
|
1782 GIT_RMDIR_REMOVE_FILES
| GIT_RMDIR_REMOVE_BLOCKERS
;
1784 if (data
->opts
.checkout_strategy
& GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES
)
1785 flg
|= GIT_RMDIR_SKIP_NONEMPTY
;
1787 if (checkout_target_fullpath(&fullpath
, data
, NULL
) < 0)
1790 git_vector_foreach(&data
->diff
->deltas
, i
, delta
) {
1791 if (actions
[i
] & CHECKOUT_ACTION__REMOVE
) {
1792 error
= git_futils_rmdir_r(
1793 delta
->old_file
.path
, fullpath
->ptr
, flg
);
1798 data
->completed_steps
++;
1799 report_progress(data
, delta
->old_file
.path
);
1801 if ((actions
[i
] & CHECKOUT_ACTION__UPDATE_BLOB
) == 0 &&
1802 (data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0 &&
1803 data
->index
!= NULL
)
1805 (void)git_index_remove(data
->index
, delta
->old_file
.path
, 0);
1810 git_vector_foreach(&data
->removes
, i
, str
) {
1811 error
= git_futils_rmdir_r(str
, fullpath
->ptr
, flg
);
1815 data
->completed_steps
++;
1816 report_progress(data
, str
);
1818 if ((data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0 &&
1819 data
->index
!= NULL
)
1821 if (str
[strlen(str
) - 1] == '/')
1822 (void)git_index_remove_directory(data
->index
, str
, 0);
1824 (void)git_index_remove(data
->index
, str
, 0);
1831 static int checkout_deferred_remove(git_repository
*repo
, const char *path
)
1834 int error
= git_futils_rmdir_r(
1835 path
, data
->opts
.target_directory
, GIT_RMDIR_EMPTY_PARENTS
);
1837 if (error
== GIT_ENOTFOUND
) {
1851 static int checkout_create_the_new(
1852 unsigned int *actions
,
1853 checkout_data
*data
)
1856 git_diff_delta
*delta
;
1859 git_vector_foreach(&data
->diff
->deltas
, i
, delta
) {
1860 if (actions
[i
] & CHECKOUT_ACTION__DEFER_REMOVE
) {
1861 /* this had a blocker directory that should only be removed iff
1862 * all of the contents of the directory were safely removed
1864 if ((error
= checkout_deferred_remove(
1865 data
->repo
, delta
->old_file
.path
)) < 0)
1869 if (actions
[i
] & CHECKOUT_ACTION__UPDATE_BLOB
) {
1870 error
= checkout_blob(data
, &delta
->new_file
);
1874 data
->completed_steps
++;
1875 report_progress(data
, delta
->new_file
.path
);
1882 static int checkout_create_submodules(
1883 unsigned int *actions
,
1884 checkout_data
*data
)
1887 git_diff_delta
*delta
;
1890 git_vector_foreach(&data
->diff
->deltas
, i
, delta
) {
1891 if (actions
[i
] & CHECKOUT_ACTION__DEFER_REMOVE
) {
1892 /* this has a blocker directory that should only be removed iff
1893 * all of the contents of the directory were safely removed
1895 if ((error
= checkout_deferred_remove(
1896 data
->repo
, delta
->old_file
.path
)) < 0)
1900 if (actions
[i
] & CHECKOUT_ACTION__UPDATE_SUBMODULE
) {
1901 int error
= checkout_submodule(data
, &delta
->new_file
);
1905 data
->completed_steps
++;
1906 report_progress(data
, delta
->new_file
.path
);
1913 static int checkout_lookup_head_tree(git_tree
**out
, git_repository
*repo
)
1916 git_reference
*ref
= NULL
;
1919 if (!(error
= git_repository_head(&ref
, repo
)) &&
1920 !(error
= git_reference_peel(&head
, ref
, GIT_OBJ_TREE
)))
1921 *out
= (git_tree
*)head
;
1923 git_reference_free(ref
);
1929 static int conflict_entry_name(
1931 const char *side_name
,
1932 const char *filename
)
1934 if (git_buf_puts(out
, side_name
) < 0 ||
1935 git_buf_putc(out
, ':') < 0 ||
1936 git_buf_puts(out
, filename
) < 0)
1942 static int checkout_path_suffixed(git_buf
*path
, const char *suffix
)
1945 int i
= 0, error
= 0;
1947 if ((error
= git_buf_putc(path
, '~')) < 0 || (error
= git_buf_puts(path
, suffix
)) < 0)
1950 path_len
= git_buf_len(path
);
1952 while (git_path_exists(git_buf_cstr(path
)) && i
< INT_MAX
) {
1953 git_buf_truncate(path
, path_len
);
1955 if ((error
= git_buf_putc(path
, '_')) < 0 ||
1956 (error
= git_buf_printf(path
, "%d", i
)) < 0)
1963 git_buf_truncate(path
, path_len
);
1965 giterr_set(GITERR_CHECKOUT
, "Could not write '%s': working directory file exists", path
);
1972 static int checkout_write_entry(
1973 checkout_data
*data
,
1974 checkout_conflictdata
*conflict
,
1975 const git_index_entry
*side
)
1977 const char *hint_path
= NULL
, *suffix
;
1982 assert (side
== conflict
->ours
|| side
== conflict
->theirs
);
1984 if (checkout_target_fullpath(&fullpath
, data
, side
->path
) < 0)
1987 if ((conflict
->name_collision
|| conflict
->directoryfile
) &&
1988 (data
->strategy
& GIT_CHECKOUT_USE_OURS
) == 0 &&
1989 (data
->strategy
& GIT_CHECKOUT_USE_THEIRS
) == 0) {
1991 if (side
== conflict
->ours
)
1992 suffix
= data
->opts
.our_label
? data
->opts
.our_label
:
1995 suffix
= data
->opts
.their_label
? data
->opts
.their_label
:
1998 if (checkout_path_suffixed(fullpath
, suffix
) < 0)
2001 hint_path
= side
->path
;
2004 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0 &&
2005 (error
= checkout_safe_for_update_only(data
, fullpath
->ptr
, side
->mode
)) <= 0)
2008 return checkout_write_content(data
,
2009 &side
->id
, fullpath
->ptr
, hint_path
, side
->mode
, &st
);
2012 static int checkout_write_entries(
2013 checkout_data
*data
,
2014 checkout_conflictdata
*conflict
)
2018 if ((error
= checkout_write_entry(data
, conflict
, conflict
->ours
)) >= 0)
2019 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2024 static int checkout_merge_path(
2026 checkout_data
*data
,
2027 checkout_conflictdata
*conflict
,
2028 git_merge_file_result
*result
)
2030 const char *our_label_raw
, *their_label_raw
, *suffix
;
2033 if ((error
= git_buf_joinpath(out
, git_repository_workdir(data
->repo
), result
->path
)) < 0)
2036 /* Most conflicts simply use the filename in the index */
2037 if (!conflict
->name_collision
)
2040 /* Rename 2->1 conflicts need the branch name appended */
2041 our_label_raw
= data
->opts
.our_label
? data
->opts
.our_label
: "ours";
2042 their_label_raw
= data
->opts
.their_label
? data
->opts
.their_label
: "theirs";
2043 suffix
= strcmp(result
->path
, conflict
->ours
->path
) == 0 ? our_label_raw
: their_label_raw
;
2045 if ((error
= checkout_path_suffixed(out
, suffix
)) < 0)
2051 static int checkout_write_merge(
2052 checkout_data
*data
,
2053 checkout_conflictdata
*conflict
)
2055 git_buf our_label
= GIT_BUF_INIT
, their_label
= GIT_BUF_INIT
,
2056 path_suffixed
= GIT_BUF_INIT
, path_workdir
= GIT_BUF_INIT
,
2057 in_data
= GIT_BUF_INIT
, out_data
= GIT_BUF_INIT
;
2058 git_merge_file_options opts
= GIT_MERGE_FILE_OPTIONS_INIT
;
2059 git_merge_file_result result
= {0};
2060 git_filebuf output
= GIT_FILEBUF_INIT
;
2061 git_filter_list
*fl
= NULL
;
2062 git_filter_options filter_opts
= GIT_FILTER_OPTIONS_INIT
;
2065 if (data
->opts
.checkout_strategy
& GIT_CHECKOUT_CONFLICT_STYLE_DIFF3
)
2066 opts
.flags
|= GIT_MERGE_FILE_STYLE_DIFF3
;
2068 opts
.ancestor_label
= data
->opts
.ancestor_label
?
2069 data
->opts
.ancestor_label
: "ancestor";
2070 opts
.our_label
= data
->opts
.our_label
?
2071 data
->opts
.our_label
: "ours";
2072 opts
.their_label
= data
->opts
.their_label
?
2073 data
->opts
.their_label
: "theirs";
2075 /* If all the paths are identical, decorate the diff3 file with the branch
2076 * names. Otherwise, append branch_name:path.
2078 if (conflict
->ours
&& conflict
->theirs
&&
2079 strcmp(conflict
->ours
->path
, conflict
->theirs
->path
) != 0) {
2081 if ((error
= conflict_entry_name(
2082 &our_label
, opts
.our_label
, conflict
->ours
->path
)) < 0 ||
2083 (error
= conflict_entry_name(
2084 &their_label
, opts
.their_label
, conflict
->theirs
->path
)) < 0)
2087 opts
.our_label
= git_buf_cstr(&our_label
);
2088 opts
.their_label
= git_buf_cstr(&their_label
);
2091 if ((error
= git_merge_file_from_index(&result
, data
->repo
,
2092 conflict
->ancestor
, conflict
->ours
, conflict
->theirs
, &opts
)) < 0)
2095 if (result
.path
== NULL
|| result
.mode
== 0) {
2096 giterr_set(GITERR_CHECKOUT
, "Could not merge contents of file");
2097 error
= GIT_ECONFLICT
;
2101 if ((error
= checkout_merge_path(&path_workdir
, data
, conflict
, &result
)) < 0)
2104 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0 &&
2105 (error
= checkout_safe_for_update_only(data
, git_buf_cstr(&path_workdir
), result
.mode
)) <= 0)
2108 if (!data
->opts
.disable_filters
) {
2109 in_data
.ptr
= (char *)result
.ptr
;
2110 in_data
.size
= result
.len
;
2112 filter_opts
.attr_session
= &data
->attr_session
;
2113 filter_opts
.temp_buf
= &data
->tmp
;
2115 if ((error
= git_filter_list__load_ext(
2116 &fl
, data
->repo
, NULL
, git_buf_cstr(&path_workdir
),
2117 GIT_FILTER_TO_WORKTREE
, &filter_opts
)) < 0 ||
2118 (error
= git_filter_list_apply_to_data(&out_data
, fl
, &in_data
)) < 0)
2121 out_data
.ptr
= (char *)result
.ptr
;
2122 out_data
.size
= result
.len
;
2125 if ((error
= mkpath2file(data
, path_workdir
.ptr
, data
->opts
.dir_mode
)) < 0 ||
2126 (error
= git_filebuf_open(&output
, git_buf_cstr(&path_workdir
), GIT_FILEBUF_DO_NOT_BUFFER
, result
.mode
)) < 0 ||
2127 (error
= git_filebuf_write(&output
, out_data
.ptr
, out_data
.size
)) < 0 ||
2128 (error
= git_filebuf_commit(&output
)) < 0)
2132 git_filter_list_free(fl
);
2134 git_buf_free(&out_data
);
2135 git_buf_free(&our_label
);
2136 git_buf_free(&their_label
);
2138 git_merge_file_result_free(&result
);
2139 git_buf_free(&path_workdir
);
2140 git_buf_free(&path_suffixed
);
2145 static int checkout_conflict_add(
2146 checkout_data
*data
,
2147 const git_index_entry
*conflict
)
2149 int error
= git_index_remove(data
->index
, conflict
->path
, 0);
2151 if (error
== GIT_ENOTFOUND
)
2156 return git_index_add(data
->index
, conflict
);
2159 static int checkout_conflict_update_index(
2160 checkout_data
*data
,
2161 checkout_conflictdata
*conflict
)
2165 if (conflict
->ancestor
)
2166 error
= checkout_conflict_add(data
, conflict
->ancestor
);
2168 if (!error
&& conflict
->ours
)
2169 error
= checkout_conflict_add(data
, conflict
->ours
);
2171 if (!error
&& conflict
->theirs
)
2172 error
= checkout_conflict_add(data
, conflict
->theirs
);
2177 static int checkout_create_conflicts(checkout_data
*data
)
2179 checkout_conflictdata
*conflict
;
2183 git_vector_foreach(&data
->update_conflicts
, i
, conflict
) {
2185 /* Both deleted: nothing to do */
2186 if (conflict
->ours
== NULL
&& conflict
->theirs
== NULL
)
2189 else if ((data
->strategy
& GIT_CHECKOUT_USE_OURS
) &&
2191 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2192 else if ((data
->strategy
& GIT_CHECKOUT_USE_THEIRS
) &&
2194 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2196 /* Ignore the other side of name collisions. */
2197 else if ((data
->strategy
& GIT_CHECKOUT_USE_OURS
) &&
2198 !conflict
->ours
&& conflict
->name_collision
)
2200 else if ((data
->strategy
& GIT_CHECKOUT_USE_THEIRS
) &&
2201 !conflict
->theirs
&& conflict
->name_collision
)
2204 /* For modify/delete, name collisions and d/f conflicts, write
2205 * the file (potentially with the name mangled.
2207 else if (conflict
->ours
!= NULL
&& conflict
->theirs
== NULL
)
2208 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2209 else if (conflict
->ours
== NULL
&& conflict
->theirs
!= NULL
)
2210 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2212 /* Add/add conflicts and rename 1->2 conflicts, write the
2213 * ours/theirs sides (potentially name mangled).
2215 else if (conflict
->one_to_two
)
2216 error
= checkout_write_entries(data
, conflict
);
2218 /* If all sides are links, write the ours side */
2219 else if (S_ISLNK(conflict
->ours
->mode
) &&
2220 S_ISLNK(conflict
->theirs
->mode
))
2221 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2222 /* Link/file conflicts, write the file side */
2223 else if (S_ISLNK(conflict
->ours
->mode
))
2224 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2225 else if (S_ISLNK(conflict
->theirs
->mode
))
2226 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2228 /* If any side is a gitlink, do nothing. */
2229 else if (conflict
->submodule
)
2232 /* If any side is binary, write the ours side */
2233 else if (conflict
->binary
)
2234 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2237 error
= checkout_write_merge(data
, conflict
);
2239 /* Update the index extensions (REUC and NAME) if we're checking
2240 * out a different index. (Otherwise just leave them there.)
2242 if (!error
&& (data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0)
2243 error
= checkout_conflict_update_index(data
, conflict
);
2248 data
->completed_steps
++;
2249 report_progress(data
,
2250 conflict
->ours
? conflict
->ours
->path
:
2251 (conflict
->theirs
? conflict
->theirs
->path
: conflict
->ancestor
->path
));
2257 static int checkout_remove_conflicts(checkout_data
*data
)
2259 const char *conflict
;
2262 git_vector_foreach(&data
->remove_conflicts
, i
, conflict
) {
2263 if (git_index_conflict_remove(data
->index
, conflict
) < 0)
2266 data
->completed_steps
++;
2272 static int checkout_extensions_update_index(checkout_data
*data
)
2274 const git_index_reuc_entry
*reuc_entry
;
2275 const git_index_name_entry
*name_entry
;
2279 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0)
2282 if (data
->update_reuc
) {
2283 git_vector_foreach(data
->update_reuc
, i
, reuc_entry
) {
2284 if ((error
= git_index_reuc_add(data
->index
, reuc_entry
->path
,
2285 reuc_entry
->mode
[0], &reuc_entry
->oid
[0],
2286 reuc_entry
->mode
[1], &reuc_entry
->oid
[1],
2287 reuc_entry
->mode
[2], &reuc_entry
->oid
[2])) < 0)
2292 if (data
->update_names
) {
2293 git_vector_foreach(data
->update_names
, i
, name_entry
) {
2294 if ((error
= git_index_name_add(data
->index
, name_entry
->ancestor
,
2295 name_entry
->ours
, name_entry
->theirs
)) < 0)
2304 static void checkout_data_clear(checkout_data
*data
)
2306 if (data
->opts_free_baseline
) {
2307 git_tree_free(data
->opts
.baseline
);
2308 data
->opts
.baseline
= NULL
;
2311 git_vector_free(&data
->removes
);
2312 git_pool_clear(&data
->pool
);
2314 git_vector_free_deep(&data
->remove_conflicts
);
2315 git_vector_free_deep(&data
->update_conflicts
);
2317 git__free(data
->pfx
);
2320 git_strmap_free(data
->mkdir_map
);
2322 git_buf_free(&data
->target_path
);
2323 git_buf_free(&data
->tmp
);
2325 git_index_free(data
->index
);
2328 git_strmap_free(data
->mkdir_map
);
2330 git_attr_session__free(&data
->attr_session
);
2333 static int checkout_data_init(
2334 checkout_data
*data
,
2335 git_iterator
*target
,
2336 const git_checkout_options
*proposed
)
2339 git_repository
*repo
= git_iterator_owner(target
);
2341 memset(data
, 0, sizeof(*data
));
2344 giterr_set(GITERR_CHECKOUT
, "Cannot checkout nothing");
2348 if ((!proposed
|| !proposed
->target_directory
) &&
2349 (error
= git_repository__ensure_not_bare(repo
, "checkout")) < 0)
2353 data
->target
= target
;
2355 GITERR_CHECK_VERSION(
2356 proposed
, GIT_CHECKOUT_OPTIONS_VERSION
, "git_checkout_options");
2359 GIT_INIT_STRUCTURE(&data
->opts
, GIT_CHECKOUT_OPTIONS_VERSION
);
2361 memmove(&data
->opts
, proposed
, sizeof(git_checkout_options
));
2363 if (!data
->opts
.target_directory
)
2364 data
->opts
.target_directory
= git_repository_workdir(repo
);
2365 else if (!git_path_isdir(data
->opts
.target_directory
) &&
2366 (error
= checkout_mkdir(data
,
2367 data
->opts
.target_directory
, NULL
,
2368 GIT_DIR_MODE
, GIT_MKDIR_VERIFY_DIR
)) < 0)
2371 /* refresh config and index content unless NO_REFRESH is given */
2372 if ((data
->opts
.checkout_strategy
& GIT_CHECKOUT_NO_REFRESH
) == 0) {
2375 if ((error
= git_repository_config__weakptr(&cfg
, repo
)) < 0)
2378 /* Get the repository index and reload it (unless we're checking
2379 * out the index; then it has the changes we're trying to check
2380 * out and those should not be overwritten.)
2382 if ((error
= git_repository_index(&data
->index
, data
->repo
)) < 0)
2385 if (data
->index
!= git_iterator_index(target
)) {
2386 if ((error
= git_index_read(data
->index
, true)) < 0)
2389 /* cannot checkout if unresolved conflicts exist */
2390 if ((data
->opts
.checkout_strategy
& GIT_CHECKOUT_FORCE
) == 0 &&
2391 git_index_has_conflicts(data
->index
)) {
2392 error
= GIT_ECONFLICT
;
2393 giterr_set(GITERR_CHECKOUT
,
2394 "unresolved conflicts exist in the index");
2398 /* clean conflict data in the current index */
2399 git_index_name_clear(data
->index
);
2400 git_index_reuc_clear(data
->index
);
2404 /* if you are forcing, allow all safe updates, plus recreate missing */
2405 if ((data
->opts
.checkout_strategy
& GIT_CHECKOUT_FORCE
) != 0)
2406 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_SAFE
|
2407 GIT_CHECKOUT_RECREATE_MISSING
;
2409 /* if the repository does not actually have an index file, then this
2410 * is an initial checkout (perhaps from clone), so we allow safe updates
2412 if (!data
->index
->on_disk
&&
2413 (data
->opts
.checkout_strategy
& GIT_CHECKOUT_SAFE
) != 0)
2414 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_RECREATE_MISSING
;
2416 data
->strategy
= data
->opts
.checkout_strategy
;
2418 /* opts->disable_filters is false by default */
2420 if (!data
->opts
.dir_mode
)
2421 data
->opts
.dir_mode
= GIT_DIR_MODE
;
2423 if (!data
->opts
.file_open_flags
)
2424 data
->opts
.file_open_flags
= O_CREAT
| O_TRUNC
| O_WRONLY
;
2426 data
->pfx
= git_pathspec_prefix(&data
->opts
.paths
);
2428 if ((error
= git_repository__cvar(
2429 &data
->can_symlink
, repo
, GIT_CVAR_SYMLINKS
)) < 0)
2432 if (!data
->opts
.baseline
&& !data
->opts
.baseline_index
) {
2433 data
->opts_free_baseline
= true;
2436 /* if we don't have an index, this is an initial checkout and
2437 * should be against an empty baseline
2439 if (data
->index
->on_disk
)
2440 error
= checkout_lookup_head_tree(&data
->opts
.baseline
, repo
);
2442 if (error
== GIT_EUNBORNBRANCH
) {
2451 if ((data
->opts
.checkout_strategy
&
2452 (GIT_CHECKOUT_CONFLICT_STYLE_MERGE
| GIT_CHECKOUT_CONFLICT_STYLE_DIFF3
)) == 0) {
2453 git_config_entry
*conflict_style
= NULL
;
2454 git_config
*cfg
= NULL
;
2456 if ((error
= git_repository_config__weakptr(&cfg
, repo
)) < 0 ||
2457 (error
= git_config_get_entry(&conflict_style
, cfg
, "merge.conflictstyle")) < 0 ||
2458 error
== GIT_ENOTFOUND
)
2462 else if (strcmp(conflict_style
->value
, "merge") == 0)
2463 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_CONFLICT_STYLE_MERGE
;
2464 else if (strcmp(conflict_style
->value
, "diff3") == 0)
2465 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_CONFLICT_STYLE_DIFF3
;
2467 giterr_set(GITERR_CHECKOUT
, "unknown style '%s' given for 'merge.conflictstyle'",
2470 git_config_entry_free(conflict_style
);
2473 git_config_entry_free(conflict_style
);
2476 git_pool_init(&data
->pool
, 1);
2478 if ((error
= git_vector_init(&data
->removes
, 0, git__strcmp_cb
)) < 0 ||
2479 (error
= git_vector_init(&data
->remove_conflicts
, 0, NULL
)) < 0 ||
2480 (error
= git_vector_init(&data
->update_conflicts
, 0, NULL
)) < 0 ||
2481 (error
= git_buf_puts(&data
->target_path
, data
->opts
.target_directory
)) < 0 ||
2482 (error
= git_path_to_dir(&data
->target_path
)) < 0 ||
2483 (error
= git_strmap_alloc(&data
->mkdir_map
)) < 0)
2486 data
->target_len
= git_buf_len(&data
->target_path
);
2488 git_attr_session__init(&data
->attr_session
, data
->repo
);
2492 checkout_data_clear(data
);
2497 #define CHECKOUT_INDEX_DONT_WRITE_MASK \
2498 (GIT_CHECKOUT_DONT_UPDATE_INDEX | GIT_CHECKOUT_DONT_WRITE_INDEX)
2500 int git_checkout_iterator(
2501 git_iterator
*target
,
2503 const git_checkout_options
*opts
)
2506 git_iterator
*baseline
= NULL
, *workdir
= NULL
;
2507 git_iterator_options baseline_opts
= GIT_ITERATOR_OPTIONS_INIT
,
2508 workdir_opts
= GIT_ITERATOR_OPTIONS_INIT
;
2509 checkout_data data
= {0};
2510 git_diff_options diff_opts
= GIT_DIFF_OPTIONS_INIT
;
2511 uint32_t *actions
= NULL
;
2512 size_t *counts
= NULL
;
2514 /* initialize structures and options */
2515 error
= checkout_data_init(&data
, target
, opts
);
2520 GIT_DIFF_INCLUDE_UNMODIFIED
|
2521 GIT_DIFF_INCLUDE_UNREADABLE
|
2522 GIT_DIFF_INCLUDE_UNTRACKED
|
2523 GIT_DIFF_RECURSE_UNTRACKED_DIRS
| /* needed to match baseline */
2524 GIT_DIFF_INCLUDE_IGNORED
|
2525 GIT_DIFF_INCLUDE_TYPECHANGE
|
2526 GIT_DIFF_INCLUDE_TYPECHANGE_TREES
|
2527 GIT_DIFF_SKIP_BINARY_CHECK
|
2528 GIT_DIFF_INCLUDE_CASECHANGE
;
2529 if (data
.opts
.checkout_strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
)
2530 diff_opts
.flags
|= GIT_DIFF_DISABLE_PATHSPEC_MATCH
;
2531 if (data
.opts
.paths
.count
> 0)
2532 diff_opts
.pathspec
= data
.opts
.paths
;
2534 /* set up iterators */
2536 workdir_opts
.flags
= git_iterator_ignore_case(target
) ?
2537 GIT_ITERATOR_IGNORE_CASE
: GIT_ITERATOR_DONT_IGNORE_CASE
;
2538 workdir_opts
.flags
|= GIT_ITERATOR_DONT_AUTOEXPAND
;
2539 workdir_opts
.start
= data
.pfx
;
2540 workdir_opts
.end
= data
.pfx
;
2542 if ((error
= git_iterator_reset_range(target
, data
.pfx
, data
.pfx
)) < 0 ||
2543 (error
= git_iterator_for_workdir_ext(
2544 &workdir
, data
.repo
, data
.opts
.target_directory
, index
, NULL
,
2545 &workdir_opts
)) < 0)
2548 baseline_opts
.flags
= git_iterator_ignore_case(target
) ?
2549 GIT_ITERATOR_IGNORE_CASE
: GIT_ITERATOR_DONT_IGNORE_CASE
;
2550 baseline_opts
.start
= data
.pfx
;
2551 baseline_opts
.end
= data
.pfx
;
2553 if (data
.opts
.baseline_index
) {
2554 if ((error
= git_iterator_for_index(
2555 &baseline
, git_index_owner(data
.opts
.baseline_index
),
2556 data
.opts
.baseline_index
, &baseline_opts
)) < 0)
2559 if ((error
= git_iterator_for_tree(
2560 &baseline
, data
.opts
.baseline
, &baseline_opts
)) < 0)
2564 /* Should not have case insensitivity mismatch */
2565 assert(git_iterator_ignore_case(workdir
) == git_iterator_ignore_case(baseline
));
2567 /* Generate baseline-to-target diff which will include an entry for
2568 * every possible update that might need to be made.
2570 if ((error
= git_diff__from_iterators(
2571 &data
.diff
, data
.repo
, baseline
, target
, &diff_opts
)) < 0)
2574 /* Loop through diff (and working directory iterator) building a list of
2575 * actions to be taken, plus look for conflicts and send notifications,
2576 * then loop through conflicts.
2578 if ((error
= checkout_get_actions(&actions
, &counts
, &data
, workdir
)) != 0)
2581 data
.total_steps
= counts
[CHECKOUT_ACTION__REMOVE
] +
2582 counts
[CHECKOUT_ACTION__REMOVE_CONFLICT
] +
2583 counts
[CHECKOUT_ACTION__UPDATE_BLOB
] +
2584 counts
[CHECKOUT_ACTION__UPDATE_SUBMODULE
] +
2585 counts
[CHECKOUT_ACTION__UPDATE_CONFLICT
];
2587 report_progress(&data
, NULL
); /* establish 0 baseline */
2589 /* To deal with some order dependencies, perform remaining checkout
2590 * in three passes: removes, then update blobs, then update submodules.
2592 if (counts
[CHECKOUT_ACTION__REMOVE
] > 0 &&
2593 (error
= checkout_remove_the_old(actions
, &data
)) < 0)
2596 if (counts
[CHECKOUT_ACTION__REMOVE_CONFLICT
] > 0 &&
2597 (error
= checkout_remove_conflicts(&data
)) < 0)
2600 if (counts
[CHECKOUT_ACTION__UPDATE_BLOB
] > 0 &&
2601 (error
= checkout_create_the_new(actions
, &data
)) < 0)
2604 if (counts
[CHECKOUT_ACTION__UPDATE_SUBMODULE
] > 0 &&
2605 (error
= checkout_create_submodules(actions
, &data
)) < 0)
2608 if (counts
[CHECKOUT_ACTION__UPDATE_CONFLICT
] > 0 &&
2609 (error
= checkout_create_conflicts(&data
)) < 0)
2612 if (data
.index
!= git_iterator_index(target
) &&
2613 (error
= checkout_extensions_update_index(&data
)) < 0)
2616 assert(data
.completed_steps
== data
.total_steps
);
2618 if (data
.opts
.perfdata_cb
)
2619 data
.opts
.perfdata_cb(&data
.perfdata
, data
.opts
.perfdata_payload
);
2622 if (!error
&& data
.index
!= NULL
&&
2623 (data
.strategy
& CHECKOUT_INDEX_DONT_WRITE_MASK
) == 0)
2624 error
= git_index_write(data
.index
);
2626 git_diff_free(data
.diff
);
2627 git_iterator_free(workdir
);
2628 git_iterator_free(baseline
);
2631 checkout_data_clear(&data
);
2636 int git_checkout_index(
2637 git_repository
*repo
,
2639 const git_checkout_options
*opts
)
2641 int error
, owned
= 0;
2642 git_iterator
*index_i
;
2644 if (!index
&& !repo
) {
2645 giterr_set(GITERR_CHECKOUT
,
2646 "Must provide either repository or index to checkout");
2650 if (index
&& repo
&&
2651 git_index_owner(index
) &&
2652 git_index_owner(index
) != repo
) {
2653 giterr_set(GITERR_CHECKOUT
,
2654 "Index to checkout does not match repository");
2656 } else if(index
&& repo
&& !git_index_owner(index
)) {
2657 GIT_REFCOUNT_OWN(index
, repo
);
2662 repo
= git_index_owner(index
);
2664 if (!index
&& (error
= git_repository_index__weakptr(&index
, repo
)) < 0)
2666 GIT_REFCOUNT_INC(index
);
2668 if (!(error
= git_iterator_for_index(&index_i
, repo
, index
, NULL
)))
2669 error
= git_checkout_iterator(index_i
, index
, opts
);
2672 GIT_REFCOUNT_OWN(index
, NULL
);
2674 git_iterator_free(index_i
);
2675 git_index_free(index
);
2680 int git_checkout_tree(
2681 git_repository
*repo
,
2682 const git_object
*treeish
,
2683 const git_checkout_options
*opts
)
2687 git_tree
*tree
= NULL
;
2688 git_iterator
*tree_i
= NULL
;
2689 git_iterator_options iter_opts
= GIT_ITERATOR_OPTIONS_INIT
;
2691 if (!treeish
&& !repo
) {
2692 giterr_set(GITERR_CHECKOUT
,
2693 "Must provide either repository or tree to checkout");
2696 if (treeish
&& repo
&& git_object_owner(treeish
) != repo
) {
2697 giterr_set(GITERR_CHECKOUT
,
2698 "Object to checkout does not match repository");
2703 repo
= git_object_owner(treeish
);
2706 if (git_object_peel((git_object
**)&tree
, treeish
, GIT_OBJ_TREE
) < 0) {
2708 GITERR_CHECKOUT
, "Provided object cannot be peeled to a tree");
2713 if ((error
= checkout_lookup_head_tree(&tree
, repo
)) < 0) {
2714 if (error
!= GIT_EUNBORNBRANCH
)
2717 "HEAD could not be peeled to a tree and no treeish given");
2722 if ((error
= git_repository_index(&index
, repo
)) < 0)
2725 if (opts
&& (opts
->checkout_strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
)) {
2726 iter_opts
.pathlist
.count
= opts
->paths
.count
;
2727 iter_opts
.pathlist
.strings
= opts
->paths
.strings
;
2730 if (!(error
= git_iterator_for_tree(&tree_i
, tree
, &iter_opts
)))
2731 error
= git_checkout_iterator(tree_i
, index
, opts
);
2733 git_iterator_free(tree_i
);
2734 git_index_free(index
);
2735 git_tree_free(tree
);
2740 int git_checkout_head(
2741 git_repository
*repo
,
2742 const git_checkout_options
*opts
)
2745 return git_checkout_tree(repo
, NULL
, opts
);
2748 int git_checkout_init_options(git_checkout_options
*opts
, unsigned int version
)
2750 GIT_INIT_STRUCTURE_FROM_TEMPLATE(
2751 opts
, version
, git_checkout_options
, GIT_CHECKOUT_OPTIONS_INIT
);