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"
23 #include "repository.h"
30 #include "merge_file.h"
38 /* See docs/checkout-internals.md for more information */
41 CHECKOUT_ACTION__NONE
= 0,
42 CHECKOUT_ACTION__REMOVE
= 1,
43 CHECKOUT_ACTION__UPDATE_BLOB
= 2,
44 CHECKOUT_ACTION__UPDATE_SUBMODULE
= 4,
45 CHECKOUT_ACTION__CONFLICT
= 8,
46 CHECKOUT_ACTION__REMOVE_CONFLICT
= 16,
47 CHECKOUT_ACTION__UPDATE_CONFLICT
= 32,
48 CHECKOUT_ACTION__MAX
= 32,
49 CHECKOUT_ACTION__DEFER_REMOVE
= 64,
50 CHECKOUT_ACTION__REMOVE_AND_UPDATE
=
51 (CHECKOUT_ACTION__UPDATE_BLOB
| CHECKOUT_ACTION__REMOVE
),
58 git_checkout_options opts
;
59 bool opts_free_baseline
;
64 git_vector remove_conflicts
;
65 git_vector update_conflicts
;
66 git_vector
*update_reuc
;
67 git_vector
*update_names
;
71 unsigned int strategy
;
73 bool reload_submodules
;
75 size_t completed_steps
;
76 git_checkout_perfdata perfdata
;
77 git_strmap
*mkdir_map
;
78 git_attr_session attr_session
;
82 const git_index_entry
*ancestor
;
83 const git_index_entry
*ours
;
84 const git_index_entry
*theirs
;
91 } checkout_conflictdata
;
93 static int checkout_notify(
95 git_checkout_notify_t why
,
96 const git_diff_delta
*delta
,
97 const git_index_entry
*wditem
)
100 const git_diff_file
*baseline
= NULL
, *target
= NULL
, *workdir
= NULL
;
101 const char *path
= NULL
;
103 if (!data
->opts
.notify_cb
||
104 (why
& data
->opts
.notify_flags
) == 0)
108 memset(&wdfile
, 0, sizeof(wdfile
));
110 git_oid_cpy(&wdfile
.id
, &wditem
->id
);
111 wdfile
.path
= wditem
->path
;
112 wdfile
.size
= wditem
->file_size
;
113 wdfile
.flags
= GIT_DIFF_FLAG_VALID_ID
;
114 wdfile
.mode
= wditem
->mode
;
122 switch (delta
->status
) {
123 case GIT_DELTA_UNMODIFIED
:
124 case GIT_DELTA_MODIFIED
:
125 case GIT_DELTA_TYPECHANGE
:
127 baseline
= &delta
->old_file
;
128 target
= &delta
->new_file
;
130 case GIT_DELTA_ADDED
:
131 case GIT_DELTA_IGNORED
:
132 case GIT_DELTA_UNTRACKED
:
133 case GIT_DELTA_UNREADABLE
:
134 target
= &delta
->new_file
;
136 case GIT_DELTA_DELETED
:
137 baseline
= &delta
->old_file
;
141 path
= delta
->old_file
.path
;
145 int error
= data
->opts
.notify_cb(
146 why
, path
, baseline
, target
, workdir
, data
->opts
.notify_payload
);
148 return giterr_set_after_callback_function(
149 error
, "git_checkout notification");
153 GIT_INLINE(bool) is_workdir_base_or_new(
154 const git_oid
*workdir_id
,
155 const git_diff_file
*baseitem
,
156 const git_diff_file
*newitem
)
158 return (git_oid__cmp(&baseitem
->id
, workdir_id
) == 0 ||
159 git_oid__cmp(&newitem
->id
, workdir_id
) == 0);
162 static bool checkout_is_workdir_modified(
164 const git_diff_file
*baseitem
,
165 const git_diff_file
*newitem
,
166 const git_index_entry
*wditem
)
169 const git_index_entry
*ie
;
171 /* handle "modified" submodule */
172 if (wditem
->mode
== GIT_FILEMODE_COMMIT
) {
174 unsigned int sm_status
= 0;
175 const git_oid
*sm_oid
= NULL
;
178 if (git_submodule_lookup(&sm
, data
->repo
, wditem
->path
) < 0) {
183 if (git_submodule_status(&sm_status
, data
->repo
, wditem
->path
, GIT_SUBMODULE_IGNORE_FALLBACK
) < 0 ||
184 GIT_SUBMODULE_STATUS_IS_WD_DIRTY(sm_status
))
186 else if ((sm_oid
= git_submodule_wd_id(sm
)) == NULL
)
189 rval
= (git_oid__cmp(&baseitem
->id
, sm_oid
) != 0);
191 git_submodule_free(sm
);
195 /* Look at the cache to decide if the workdir is modified. If not,
196 * we can simply compare the oid in the cache to the baseitem instead
197 * of hashing the file. If so, we allow the checkout to proceed if the
198 * oid is identical (ie, the staged item is what we're trying to check
201 if ((ie
= git_index_get_bypath(data
->index
, wditem
->path
, 0)) != NULL
) {
202 if (wditem
->mtime
.seconds
== ie
->mtime
.seconds
&&
203 wditem
->mtime
.nanoseconds
== ie
->mtime
.nanoseconds
&&
204 wditem
->file_size
== ie
->file_size
)
205 return !is_workdir_base_or_new(&ie
->id
, baseitem
, newitem
);
208 /* depending on where base is coming from, we may or may not know
209 * the actual size of the data, so we can't rely on this shortcut.
211 if (baseitem
->size
&& wditem
->file_size
!= baseitem
->size
)
214 if (git_diff__oid_for_entry(&oid
, data
->diff
, wditem
, wditem
->mode
, NULL
) < 0)
217 /* Allow the checkout if the workdir is not modified *or* if the checkout
218 * target's contents are already in the working directory.
220 return !is_workdir_base_or_new(&oid
, baseitem
, newitem
);
223 #define CHECKOUT_ACTION_IF(FLAG,YES,NO) \
224 ((data->strategy & GIT_CHECKOUT_##FLAG) ? CHECKOUT_ACTION__##YES : CHECKOUT_ACTION__##NO)
226 static int checkout_action_common(
229 const git_diff_delta
*delta
,
230 const git_index_entry
*wd
)
232 git_checkout_notify_t notify
= GIT_CHECKOUT_NOTIFY_NONE
;
234 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0)
235 *action
= (*action
& ~CHECKOUT_ACTION__REMOVE
);
237 if ((*action
& CHECKOUT_ACTION__UPDATE_BLOB
) != 0) {
238 if (S_ISGITLINK(delta
->new_file
.mode
))
239 *action
= (*action
& ~CHECKOUT_ACTION__UPDATE_BLOB
) |
240 CHECKOUT_ACTION__UPDATE_SUBMODULE
;
242 /* to "update" a symlink, we must remove the old one first */
243 if (delta
->new_file
.mode
== GIT_FILEMODE_LINK
&& wd
!= NULL
)
244 *action
|= CHECKOUT_ACTION__REMOVE
;
246 notify
= GIT_CHECKOUT_NOTIFY_UPDATED
;
249 if ((*action
& CHECKOUT_ACTION__CONFLICT
) != 0)
250 notify
= GIT_CHECKOUT_NOTIFY_CONFLICT
;
252 return checkout_notify(data
, notify
, delta
, wd
);
255 static int checkout_action_no_wd(
258 const git_diff_delta
*delta
)
262 *action
= CHECKOUT_ACTION__NONE
;
264 switch (delta
->status
) {
265 case GIT_DELTA_UNMODIFIED
: /* case 12 */
266 error
= checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, NULL
);
269 *action
= CHECKOUT_ACTION_IF(RECREATE_MISSING
, UPDATE_BLOB
, NONE
);
271 case GIT_DELTA_ADDED
: /* case 2 or 28 (and 5 but not really) */
272 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
274 case GIT_DELTA_MODIFIED
: /* case 13 (and 35 but not really) */
275 *action
= CHECKOUT_ACTION_IF(RECREATE_MISSING
, UPDATE_BLOB
, CONFLICT
);
277 case GIT_DELTA_TYPECHANGE
: /* case 21 (B->T) and 28 (T->B)*/
278 if (delta
->new_file
.mode
== GIT_FILEMODE_TREE
)
279 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
281 case GIT_DELTA_DELETED
: /* case 8 or 25 */
282 *action
= CHECKOUT_ACTION_IF(SAFE
, REMOVE
, NONE
);
284 default: /* impossible */
288 return checkout_action_common(action
, data
, delta
, NULL
);
291 static bool wd_item_is_removable(git_iterator
*iter
, const git_index_entry
*wd
)
293 git_buf
*full
= NULL
;
295 if (wd
->mode
!= GIT_FILEMODE_TREE
)
297 if (git_iterator_current_workdir_path(&full
, iter
) < 0)
299 return !full
|| !git_path_contains(full
, DOT_GIT
);
302 static int checkout_queue_remove(checkout_data
*data
, const char *path
)
304 char *copy
= git_pool_strdup(&data
->pool
, path
);
305 GITERR_CHECK_ALLOC(copy
);
306 return git_vector_insert(&data
->removes
, copy
);
309 /* note that this advances the iterator over the wd item */
310 static int checkout_action_wd_only(
312 git_iterator
*workdir
,
313 const git_index_entry
**wditem
,
314 git_vector
*pathspec
)
318 git_checkout_notify_t notify
= GIT_CHECKOUT_NOTIFY_NONE
;
319 const git_index_entry
*wd
= *wditem
;
321 if (!git_pathspec__match(
323 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
324 git_iterator_ignore_case(workdir
), NULL
, NULL
))
325 return git_iterator_advance(wditem
, workdir
);
327 /* check if item is tracked in the index but not in the checkout diff */
328 if (data
->index
!= NULL
) {
331 error
= git_index__find_pos(
332 &pos
, data
->index
, wd
->path
, 0, GIT_INDEX_STAGE_ANY
);
334 if (wd
->mode
!= GIT_FILEMODE_TREE
) {
335 if (!error
) { /* found by git_index__find_pos call */
336 notify
= GIT_CHECKOUT_NOTIFY_DIRTY
;
337 remove
= ((data
->strategy
& GIT_CHECKOUT_FORCE
) != 0);
338 } else if (error
!= GIT_ENOTFOUND
)
341 error
= 0; /* git_index__find_pos does not set error msg */
343 /* for tree entries, we have to see if there are any index
344 * entries that are contained inside that tree
346 const git_index_entry
*e
= git_index_get_byindex(data
->index
, pos
);
348 if (e
!= NULL
&& data
->diff
->pfxcomp(e
->path
, wd
->path
) == 0) {
349 notify
= GIT_CHECKOUT_NOTIFY_DIRTY
;
350 remove
= ((data
->strategy
& GIT_CHECKOUT_FORCE
) != 0);
355 if (notify
!= GIT_CHECKOUT_NOTIFY_NONE
) {
356 /* if we found something in the index, notify and advance */
357 if ((error
= checkout_notify(data
, notify
, NULL
, wd
)) != 0)
360 if (remove
&& wd_item_is_removable(workdir
, wd
))
361 error
= checkout_queue_remove(data
, wd
->path
);
364 error
= git_iterator_advance(wditem
, workdir
);
366 /* untracked or ignored - can't know which until we advance through */
367 bool over
= false, removable
= wd_item_is_removable(workdir
, wd
);
368 git_iterator_status_t untracked_state
;
370 /* copy the entry for issuing notification callback later */
371 git_index_entry saved_wd
= *wd
;
372 git_buf_sets(&data
->tmp
, wd
->path
);
373 saved_wd
.path
= data
->tmp
.ptr
;
375 error
= git_iterator_advance_over_with_status(
376 wditem
, &untracked_state
, workdir
);
377 if (error
== GIT_ITEROVER
)
382 if (untracked_state
== GIT_ITERATOR_STATUS_IGNORED
) {
383 notify
= GIT_CHECKOUT_NOTIFY_IGNORED
;
384 remove
= ((data
->strategy
& GIT_CHECKOUT_REMOVE_IGNORED
) != 0);
386 notify
= GIT_CHECKOUT_NOTIFY_UNTRACKED
;
387 remove
= ((data
->strategy
& GIT_CHECKOUT_REMOVE_UNTRACKED
) != 0);
390 if ((error
= checkout_notify(data
, notify
, NULL
, &saved_wd
)) != 0)
393 if (remove
&& removable
)
394 error
= checkout_queue_remove(data
, saved_wd
.path
);
396 if (!error
&& over
) /* restore ITEROVER if needed */
397 error
= GIT_ITEROVER
;
403 static bool submodule_is_config_only(
407 git_submodule
*sm
= NULL
;
408 unsigned int sm_loc
= 0;
411 if (git_submodule_lookup(&sm
, data
->repo
, path
) < 0)
414 if (git_submodule_location(&sm_loc
, sm
) < 0 ||
415 sm_loc
== GIT_SUBMODULE_STATUS_IN_CONFIG
)
418 git_submodule_free(sm
);
423 static bool checkout_is_empty_dir(checkout_data
*data
, const char *path
)
425 git_buf_truncate(&data
->path
, data
->workdir_len
);
426 if (git_buf_puts(&data
->path
, path
) < 0)
428 return git_path_is_empty_dir(data
->path
.ptr
);
431 static int checkout_action_with_wd(
434 const git_diff_delta
*delta
,
435 git_iterator
*workdir
,
436 const git_index_entry
*wd
)
438 *action
= CHECKOUT_ACTION__NONE
;
440 switch (delta
->status
) {
441 case GIT_DELTA_UNMODIFIED
: /* case 14/15 or 33 */
442 if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
)) {
444 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, wd
) );
445 *action
= CHECKOUT_ACTION_IF(FORCE
, UPDATE_BLOB
, NONE
);
448 case GIT_DELTA_ADDED
: /* case 3, 4 or 6 */
449 if (git_iterator_current_is_ignored(workdir
))
450 *action
= CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED
, CONFLICT
, UPDATE_BLOB
);
452 *action
= CHECKOUT_ACTION_IF(FORCE
, UPDATE_BLOB
, CONFLICT
);
454 case GIT_DELTA_DELETED
: /* case 9 or 10 (or 26 but not really) */
455 if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
))
456 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE
, CONFLICT
);
458 *action
= CHECKOUT_ACTION_IF(SAFE
, REMOVE
, NONE
);
460 case GIT_DELTA_MODIFIED
: /* case 16, 17, 18 (or 36 but not really) */
461 if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
))
462 *action
= CHECKOUT_ACTION_IF(FORCE
, UPDATE_BLOB
, CONFLICT
);
464 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
466 case GIT_DELTA_TYPECHANGE
: /* case 22, 23, 29, 30 */
467 if (delta
->old_file
.mode
== GIT_FILEMODE_TREE
) {
468 if (wd
->mode
== GIT_FILEMODE_TREE
)
469 /* either deleting items in old tree will delete the wd dir,
470 * or we'll get a conflict when we attempt blob update...
472 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
473 else if (wd
->mode
== GIT_FILEMODE_COMMIT
) {
474 /* workdir is possibly a "phantom" submodule - treat as a
475 * tree if the only submodule info came from the config
477 if (submodule_is_config_only(data
, wd
->path
))
478 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
480 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
482 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE
, CONFLICT
);
484 else if (checkout_is_workdir_modified(data
, &delta
->old_file
, &delta
->new_file
, wd
))
485 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
487 *action
= CHECKOUT_ACTION_IF(SAFE
, REMOVE_AND_UPDATE
, NONE
);
489 /* don't update if the typechange is to a tree */
490 if (delta
->new_file
.mode
== GIT_FILEMODE_TREE
)
491 *action
= (*action
& ~CHECKOUT_ACTION__UPDATE_BLOB
);
493 default: /* impossible */
497 return checkout_action_common(action
, data
, delta
, wd
);
500 static int checkout_action_with_wd_blocker(
503 const git_diff_delta
*delta
,
504 const git_index_entry
*wd
)
506 *action
= CHECKOUT_ACTION__NONE
;
508 switch (delta
->status
) {
509 case GIT_DELTA_UNMODIFIED
:
510 /* should show delta as dirty / deleted */
512 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, wd
) );
513 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, NONE
);
515 case GIT_DELTA_ADDED
:
516 case GIT_DELTA_MODIFIED
:
517 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
519 case GIT_DELTA_DELETED
:
520 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE
, CONFLICT
);
522 case GIT_DELTA_TYPECHANGE
:
523 /* not 100% certain about this... */
524 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
526 default: /* impossible */
530 return checkout_action_common(action
, data
, delta
, wd
);
533 static int checkout_action_with_wd_dir(
536 const git_diff_delta
*delta
,
537 git_iterator
*workdir
,
538 const git_index_entry
*wd
)
540 *action
= CHECKOUT_ACTION__NONE
;
542 switch (delta
->status
) {
543 case GIT_DELTA_UNMODIFIED
: /* case 19 or 24 (or 34 but not really) */
545 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_DIRTY
, delta
, NULL
));
547 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_UNTRACKED
, NULL
, wd
));
548 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, NONE
);
550 case GIT_DELTA_ADDED
:/* case 4 (and 7 for dir) */
551 case GIT_DELTA_MODIFIED
: /* case 20 (or 37 but not really) */
552 if (delta
->old_file
.mode
== GIT_FILEMODE_COMMIT
)
553 /* expected submodule (and maybe found one) */;
554 else if (delta
->new_file
.mode
!= GIT_FILEMODE_TREE
)
555 *action
= git_iterator_current_is_ignored(workdir
) ?
556 CHECKOUT_ACTION_IF(DONT_OVERWRITE_IGNORED
, CONFLICT
, REMOVE_AND_UPDATE
) :
557 CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
559 case GIT_DELTA_DELETED
: /* case 11 (and 27 for dir) */
560 if (delta
->old_file
.mode
!= GIT_FILEMODE_TREE
)
562 checkout_notify(data
, GIT_CHECKOUT_NOTIFY_UNTRACKED
, NULL
, wd
));
564 case GIT_DELTA_TYPECHANGE
: /* case 24 or 31 */
565 if (delta
->old_file
.mode
== GIT_FILEMODE_TREE
) {
566 /* For typechange from dir, remove dir and add blob, but it is
567 * not safe to remove dir if it contains modified files.
568 * However, safely removing child files will remove the parent
569 * directory if is it left empty, so we can defer removing the
570 * dir and it will succeed if no children are left.
572 *action
= CHECKOUT_ACTION_IF(SAFE
, UPDATE_BLOB
, NONE
);
574 else if (delta
->new_file
.mode
!= GIT_FILEMODE_TREE
)
575 /* For typechange to dir, dir is already created so no action */
576 *action
= CHECKOUT_ACTION_IF(FORCE
, REMOVE_AND_UPDATE
, CONFLICT
);
578 default: /* impossible */
582 return checkout_action_common(action
, data
, delta
, wd
);
585 static int checkout_action_with_wd_dir_empty(
588 const git_diff_delta
*delta
)
590 int error
= checkout_action_no_wd(action
, data
, delta
);
592 /* We can always safely remove an empty directory. */
593 if (error
== 0 && *action
!= CHECKOUT_ACTION__NONE
)
594 *action
|= CHECKOUT_ACTION__REMOVE
;
599 static int checkout_action(
602 git_diff_delta
*delta
,
603 git_iterator
*workdir
,
604 const git_index_entry
**wditem
,
605 git_vector
*pathspec
)
608 int (*strcomp
)(const char *, const char *) = data
->diff
->strcomp
;
609 int (*pfxcomp
)(const char *str
, const char *pfx
) = data
->diff
->pfxcomp
;
610 int (*advance
)(const git_index_entry
**, git_iterator
*) = NULL
;
612 /* move workdir iterator to follow along with deltas */
615 const git_index_entry
*wd
= *wditem
;
618 return checkout_action_no_wd(action
, data
, delta
);
620 cmp
= strcomp(wd
->path
, delta
->old_file
.path
);
622 /* 1. wd before delta ("a/a" before "a/b")
623 * 2. wd prefixes delta & should expand ("a/" before "a/b")
624 * 3. wd prefixes delta & cannot expand ("a/b" before "a/b/c")
625 * 4. wd equals delta ("a/b" and "a/b")
626 * 5. wd after delta & delta prefixes wd ("a/b/c" after "a/b/" or "a/b")
627 * 6. wd after delta ("a/c" after "a/b")
631 cmp
= pfxcomp(delta
->old_file
.path
, wd
->path
);
634 if (wd
->mode
== GIT_FILEMODE_TREE
) {
635 /* case 2 - entry prefixed by workdir tree */
636 error
= git_iterator_advance_into_or_over(wditem
, workdir
);
637 if (error
< 0 && error
!= GIT_ITEROVER
)
642 /* case 3 maybe - wd contains non-dir where dir expected */
643 if (delta
->old_file
.path
[strlen(wd
->path
)] == '/') {
644 error
= checkout_action_with_wd_blocker(
645 action
, data
, delta
, wd
);
646 advance
= git_iterator_advance
;
651 /* case 1 - handle wd item (if it matches pathspec) */
652 error
= checkout_action_wd_only(data
, workdir
, wditem
, pathspec
);
653 if (error
&& error
!= GIT_ITEROVER
)
660 error
= checkout_action_with_wd(action
, data
, delta
, workdir
, wd
);
661 advance
= git_iterator_advance
;
665 cmp
= pfxcomp(wd
->path
, delta
->old_file
.path
);
667 if (cmp
== 0) { /* case 5 */
668 if (wd
->path
[strlen(delta
->old_file
.path
)] != '/')
669 return checkout_action_no_wd(action
, data
, delta
);
671 if (delta
->status
== GIT_DELTA_TYPECHANGE
) {
672 if (delta
->old_file
.mode
== GIT_FILEMODE_TREE
) {
673 error
= checkout_action_with_wd(action
, data
, delta
, workdir
, wd
);
674 advance
= git_iterator_advance_into
;
678 if (delta
->new_file
.mode
== GIT_FILEMODE_TREE
||
679 delta
->new_file
.mode
== GIT_FILEMODE_COMMIT
||
680 delta
->old_file
.mode
== GIT_FILEMODE_COMMIT
)
682 error
= checkout_action_with_wd(action
, data
, delta
, workdir
, wd
);
683 advance
= git_iterator_advance
;
688 return checkout_is_empty_dir(data
, wd
->path
) ?
689 checkout_action_with_wd_dir_empty(action
, data
, delta
) :
690 checkout_action_with_wd_dir(action
, data
, delta
, workdir
, wd
);
693 /* case 6 - wd is after delta */
694 return checkout_action_no_wd(action
, data
, delta
);
698 if (!error
&& advance
!= NULL
&&
699 (error
= advance(wditem
, workdir
)) < 0) {
701 if (error
== GIT_ITEROVER
)
708 static int checkout_remaining_wd_items(
710 git_iterator
*workdir
,
711 const git_index_entry
*wd
,
717 error
= checkout_action_wd_only(data
, workdir
, &wd
, spec
);
719 if (error
== GIT_ITEROVER
)
725 GIT_INLINE(int) checkout_idxentry_cmp(
726 const git_index_entry
*a
,
727 const git_index_entry
*b
)
736 return strcmp(a
->path
, b
->path
);
739 static int checkout_conflictdata_cmp(const void *a
, const void *b
)
741 const checkout_conflictdata
*ca
= a
;
742 const checkout_conflictdata
*cb
= b
;
745 if ((diff
= checkout_idxentry_cmp(ca
->ancestor
, cb
->ancestor
)) == 0 &&
746 (diff
= checkout_idxentry_cmp(ca
->ours
, cb
->theirs
)) == 0)
747 diff
= checkout_idxentry_cmp(ca
->theirs
, cb
->theirs
);
752 int checkout_conflictdata_empty(
753 const git_vector
*conflicts
, size_t idx
, void *payload
)
755 checkout_conflictdata
*conflict
;
759 if ((conflict
= git_vector_get(conflicts
, idx
)) == NULL
)
762 if (conflict
->ancestor
|| conflict
->ours
|| conflict
->theirs
)
769 GIT_INLINE(bool) conflict_pathspec_match(
771 git_iterator
*workdir
,
772 git_vector
*pathspec
,
773 const git_index_entry
*ancestor
,
774 const git_index_entry
*ours
,
775 const git_index_entry
*theirs
)
777 /* if the pathspec matches ours *or* theirs, proceed */
778 if (ours
&& git_pathspec__match(pathspec
, ours
->path
,
779 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
780 git_iterator_ignore_case(workdir
), NULL
, NULL
))
783 if (theirs
&& git_pathspec__match(pathspec
, theirs
->path
,
784 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
785 git_iterator_ignore_case(workdir
), NULL
, NULL
))
788 if (ancestor
&& git_pathspec__match(pathspec
, ancestor
->path
,
789 (data
->strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
) != 0,
790 git_iterator_ignore_case(workdir
), NULL
, NULL
))
796 GIT_INLINE(int) checkout_conflict_detect_submodule(checkout_conflictdata
*conflict
)
798 conflict
->submodule
= ((conflict
->ancestor
&& S_ISGITLINK(conflict
->ancestor
->mode
)) ||
799 (conflict
->ours
&& S_ISGITLINK(conflict
->ours
->mode
)) ||
800 (conflict
->theirs
&& S_ISGITLINK(conflict
->theirs
->mode
)));
804 GIT_INLINE(int) checkout_conflict_detect_binary(git_repository
*repo
, checkout_conflictdata
*conflict
)
806 git_blob
*ancestor_blob
= NULL
, *our_blob
= NULL
, *their_blob
= NULL
;
809 if (conflict
->submodule
)
812 if (conflict
->ancestor
) {
813 if ((error
= git_blob_lookup(&ancestor_blob
, repo
, &conflict
->ancestor
->id
)) < 0)
816 conflict
->binary
= git_blob_is_binary(ancestor_blob
);
819 if (!conflict
->binary
&& conflict
->ours
) {
820 if ((error
= git_blob_lookup(&our_blob
, repo
, &conflict
->ours
->id
)) < 0)
823 conflict
->binary
= git_blob_is_binary(our_blob
);
826 if (!conflict
->binary
&& conflict
->theirs
) {
827 if ((error
= git_blob_lookup(&their_blob
, repo
, &conflict
->theirs
->id
)) < 0)
830 conflict
->binary
= git_blob_is_binary(their_blob
);
834 git_blob_free(ancestor_blob
);
835 git_blob_free(our_blob
);
836 git_blob_free(their_blob
);
841 static int checkout_conflict_append_update(
842 const git_index_entry
*ancestor
,
843 const git_index_entry
*ours
,
844 const git_index_entry
*theirs
,
847 checkout_data
*data
= payload
;
848 checkout_conflictdata
*conflict
;
851 conflict
= git__calloc(1, sizeof(checkout_conflictdata
));
852 GITERR_CHECK_ALLOC(conflict
);
854 conflict
->ancestor
= ancestor
;
855 conflict
->ours
= ours
;
856 conflict
->theirs
= theirs
;
858 if ((error
= checkout_conflict_detect_submodule(conflict
)) < 0 ||
859 (error
= checkout_conflict_detect_binary(data
->repo
, conflict
)) < 0)
865 if (git_vector_insert(&data
->update_conflicts
, conflict
))
871 static int checkout_conflicts_foreach(
874 git_iterator
*workdir
,
875 git_vector
*pathspec
,
876 int (*cb
)(const git_index_entry
*, const git_index_entry
*, const git_index_entry
*, void *),
879 git_index_conflict_iterator
*iterator
= NULL
;
880 const git_index_entry
*ancestor
, *ours
, *theirs
;
883 if ((error
= git_index_conflict_iterator_new(&iterator
, index
)) < 0)
886 /* Collect the conflicts */
887 while ((error
= git_index_conflict_next(&ancestor
, &ours
, &theirs
, iterator
)) == 0) {
888 if (!conflict_pathspec_match(data
, workdir
, pathspec
, ancestor
, ours
, theirs
))
891 if ((error
= cb(ancestor
, ours
, theirs
, payload
)) < 0)
895 if (error
== GIT_ITEROVER
)
899 git_index_conflict_iterator_free(iterator
);
904 static int checkout_conflicts_load(checkout_data
*data
, git_iterator
*workdir
, git_vector
*pathspec
)
908 /* Only write conficts from sources that have them: indexes. */
909 if ((index
= git_iterator_get_index(data
->target
)) == NULL
)
912 data
->update_conflicts
._cmp
= checkout_conflictdata_cmp
;
914 if (checkout_conflicts_foreach(data
, index
, workdir
, pathspec
, checkout_conflict_append_update
, data
) < 0)
917 /* Collect the REUC and NAME entries */
918 data
->update_reuc
= &index
->reuc
;
919 data
->update_names
= &index
->names
;
924 GIT_INLINE(int) checkout_conflicts_cmp_entry(
926 const git_index_entry
*entry
)
928 return strcmp((const char *)path
, entry
->path
);
931 static int checkout_conflicts_cmp_ancestor(const void *p
, const void *c
)
933 const char *path
= p
;
934 const checkout_conflictdata
*conflict
= c
;
936 if (!conflict
->ancestor
)
939 return checkout_conflicts_cmp_entry(path
, conflict
->ancestor
);
942 static checkout_conflictdata
*checkout_conflicts_search_ancestor(
948 if (git_vector_bsearch2(&pos
, &data
->update_conflicts
, checkout_conflicts_cmp_ancestor
, path
) < 0)
951 return git_vector_get(&data
->update_conflicts
, pos
);
954 static checkout_conflictdata
*checkout_conflicts_search_branch(
958 checkout_conflictdata
*conflict
;
961 git_vector_foreach(&data
->update_conflicts
, i
, conflict
) {
964 if (conflict
->ancestor
)
968 cmp
= checkout_conflicts_cmp_entry(path
, conflict
->ours
);
969 else if (conflict
->theirs
)
970 cmp
= checkout_conflicts_cmp_entry(path
, conflict
->theirs
);
979 static int checkout_conflicts_load_byname_entry(
980 checkout_conflictdata
**ancestor_out
,
981 checkout_conflictdata
**ours_out
,
982 checkout_conflictdata
**theirs_out
,
984 const git_index_name_entry
*name_entry
)
986 checkout_conflictdata
*ancestor
, *ours
= NULL
, *theirs
= NULL
;
989 *ancestor_out
= NULL
;
993 if (!name_entry
->ancestor
) {
994 giterr_set(GITERR_INDEX
, "A NAME entry exists without an ancestor");
999 if (!name_entry
->ours
&& !name_entry
->theirs
) {
1000 giterr_set(GITERR_INDEX
, "A NAME entry exists without an ours or theirs");
1005 if ((ancestor
= checkout_conflicts_search_ancestor(data
,
1006 name_entry
->ancestor
)) == NULL
) {
1007 giterr_set(GITERR_INDEX
,
1008 "A NAME entry referenced ancestor entry '%s' which does not exist in the main index",
1009 name_entry
->ancestor
);
1014 if (name_entry
->ours
) {
1015 if (strcmp(name_entry
->ancestor
, name_entry
->ours
) == 0)
1017 else if ((ours
= checkout_conflicts_search_branch(data
, name_entry
->ours
)) == NULL
||
1018 ours
->ours
== NULL
) {
1019 giterr_set(GITERR_INDEX
,
1020 "A NAME entry referenced our entry '%s' which does not exist in the main index",
1027 if (name_entry
->theirs
) {
1028 if (strcmp(name_entry
->ancestor
, name_entry
->theirs
) == 0)
1030 else if (name_entry
->ours
&& strcmp(name_entry
->ours
, name_entry
->theirs
) == 0)
1032 else if ((theirs
= checkout_conflicts_search_branch(data
, name_entry
->theirs
)) == NULL
||
1033 theirs
->theirs
== NULL
) {
1034 giterr_set(GITERR_INDEX
,
1035 "A NAME entry referenced their entry '%s' which does not exist in the main index",
1036 name_entry
->theirs
);
1042 *ancestor_out
= ancestor
;
1044 *theirs_out
= theirs
;
1050 static int checkout_conflicts_coalesce_renames(
1051 checkout_data
*data
)
1054 const git_index_name_entry
*name_entry
;
1055 checkout_conflictdata
*ancestor_conflict
, *our_conflict
, *their_conflict
;
1059 if ((index
= git_iterator_get_index(data
->target
)) == NULL
)
1062 /* Juggle entries based on renames */
1063 names
= git_index_name_entrycount(index
);
1065 for (i
= 0; i
< names
; i
++) {
1066 name_entry
= git_index_name_get_byindex(index
, i
);
1068 if ((error
= checkout_conflicts_load_byname_entry(
1069 &ancestor_conflict
, &our_conflict
, &their_conflict
,
1070 data
, name_entry
)) < 0)
1073 if (our_conflict
&& our_conflict
!= ancestor_conflict
) {
1074 ancestor_conflict
->ours
= our_conflict
->ours
;
1075 our_conflict
->ours
= NULL
;
1077 if (our_conflict
->theirs
)
1078 our_conflict
->name_collision
= 1;
1080 if (our_conflict
->name_collision
)
1081 ancestor_conflict
->name_collision
= 1;
1084 if (their_conflict
&& their_conflict
!= ancestor_conflict
) {
1085 ancestor_conflict
->theirs
= their_conflict
->theirs
;
1086 their_conflict
->theirs
= NULL
;
1088 if (their_conflict
->ours
)
1089 their_conflict
->name_collision
= 1;
1091 if (their_conflict
->name_collision
)
1092 ancestor_conflict
->name_collision
= 1;
1095 if (our_conflict
&& our_conflict
!= ancestor_conflict
&&
1096 their_conflict
&& their_conflict
!= ancestor_conflict
)
1097 ancestor_conflict
->one_to_two
= 1;
1100 git_vector_remove_matching(
1101 &data
->update_conflicts
, checkout_conflictdata_empty
, NULL
);
1107 static int checkout_conflicts_mark_directoryfile(
1108 checkout_data
*data
)
1111 checkout_conflictdata
*conflict
;
1112 const git_index_entry
*entry
;
1115 int prefixed
, error
= 0;
1117 if ((index
= git_iterator_get_index(data
->target
)) == NULL
)
1120 len
= git_index_entrycount(index
);
1122 /* Find d/f conflicts */
1123 git_vector_foreach(&data
->update_conflicts
, i
, conflict
) {
1124 if ((conflict
->ours
&& conflict
->theirs
) ||
1125 (!conflict
->ours
&& !conflict
->theirs
))
1128 path
= conflict
->ours
?
1129 conflict
->ours
->path
: conflict
->theirs
->path
;
1131 if ((error
= git_index_find(&j
, index
, path
)) < 0) {
1132 if (error
== GIT_ENOTFOUND
)
1133 giterr_set(GITERR_INDEX
,
1134 "Index inconsistency, could not find entry for expected conflict '%s'", path
);
1139 for (; j
< len
; j
++) {
1140 if ((entry
= git_index_get_byindex(index
, j
)) == NULL
) {
1141 giterr_set(GITERR_INDEX
,
1142 "Index inconsistency, truncated index while loading expected conflict '%s'", path
);
1147 prefixed
= git_path_equal_or_prefixed(path
, entry
->path
, NULL
);
1149 if (prefixed
== GIT_PATH_EQUAL
)
1152 if (prefixed
== GIT_PATH_PREFIX
)
1153 conflict
->directoryfile
= 1;
1163 static int checkout_get_update_conflicts(
1164 checkout_data
*data
,
1165 git_iterator
*workdir
,
1166 git_vector
*pathspec
)
1170 if (data
->strategy
& GIT_CHECKOUT_SKIP_UNMERGED
)
1173 if ((error
= checkout_conflicts_load(data
, workdir
, pathspec
)) < 0 ||
1174 (error
= checkout_conflicts_coalesce_renames(data
)) < 0 ||
1175 (error
= checkout_conflicts_mark_directoryfile(data
)) < 0)
1182 static int checkout_conflict_append_remove(
1183 const git_index_entry
*ancestor
,
1184 const git_index_entry
*ours
,
1185 const git_index_entry
*theirs
,
1188 checkout_data
*data
= payload
;
1191 assert(ancestor
|| ours
|| theirs
);
1194 name
= git__strdup(ancestor
->path
);
1196 name
= git__strdup(ours
->path
);
1198 name
= git__strdup(theirs
->path
);
1202 GITERR_CHECK_ALLOC(name
);
1204 return git_vector_insert(&data
->remove_conflicts
, (char *)name
);
1207 static int checkout_get_remove_conflicts(
1208 checkout_data
*data
,
1209 git_iterator
*workdir
,
1210 git_vector
*pathspec
)
1212 if ((data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) != 0)
1215 return checkout_conflicts_foreach(data
, data
->index
, workdir
, pathspec
, checkout_conflict_append_remove
, data
);
1218 static int checkout_verify_paths(
1219 git_repository
*repo
,
1221 git_diff_delta
*delta
)
1223 unsigned int flags
= GIT_PATH_REJECT_DEFAULTS
| GIT_PATH_REJECT_DOT_GIT
;
1225 if (action
& CHECKOUT_ACTION__REMOVE
) {
1226 if (!git_path_isvalid(repo
, delta
->old_file
.path
, flags
)) {
1227 giterr_set(GITERR_CHECKOUT
, "Cannot remove invalid path '%s'", delta
->old_file
.path
);
1232 if (action
& ~CHECKOUT_ACTION__REMOVE
) {
1233 if (!git_path_isvalid(repo
, delta
->new_file
.path
, flags
)) {
1234 giterr_set(GITERR_CHECKOUT
, "Cannot checkout to invalid path '%s'", delta
->new_file
.path
);
1242 static int checkout_get_actions(
1243 uint32_t **actions_ptr
,
1244 size_t **counts_ptr
,
1245 checkout_data
*data
,
1246 git_iterator
*workdir
)
1249 const git_index_entry
*wditem
;
1250 git_vector pathspec
= GIT_VECTOR_INIT
, *deltas
;
1251 git_pool pathpool
= GIT_POOL_INIT_STRINGPOOL
;
1252 git_diff_delta
*delta
;
1253 size_t i
, *counts
= NULL
;
1254 uint32_t *actions
= NULL
;
1256 if (data
->opts
.paths
.count
> 0 &&
1257 git_pathspec__vinit(&pathspec
, &data
->opts
.paths
, &pathpool
) < 0)
1260 if ((error
= git_iterator_current(&wditem
, workdir
)) < 0 &&
1261 error
!= GIT_ITEROVER
)
1264 deltas
= &data
->diff
->deltas
;
1266 *counts_ptr
= counts
= git__calloc(CHECKOUT_ACTION__MAX
+1, sizeof(size_t));
1267 *actions_ptr
= actions
= git__calloc(
1268 deltas
->length
? deltas
->length
: 1, sizeof(uint32_t));
1269 if (!counts
|| !actions
) {
1274 git_vector_foreach(deltas
, i
, delta
) {
1275 if ((error
= checkout_action(&act
, data
, delta
, workdir
, &wditem
, &pathspec
)) == 0)
1276 error
= checkout_verify_paths(data
->repo
, act
, delta
);
1283 if (act
& CHECKOUT_ACTION__REMOVE
)
1284 counts
[CHECKOUT_ACTION__REMOVE
]++;
1285 if (act
& CHECKOUT_ACTION__UPDATE_BLOB
)
1286 counts
[CHECKOUT_ACTION__UPDATE_BLOB
]++;
1287 if (act
& CHECKOUT_ACTION__UPDATE_SUBMODULE
)
1288 counts
[CHECKOUT_ACTION__UPDATE_SUBMODULE
]++;
1289 if (act
& CHECKOUT_ACTION__CONFLICT
)
1290 counts
[CHECKOUT_ACTION__CONFLICT
]++;
1293 error
= checkout_remaining_wd_items(data
, workdir
, wditem
, &pathspec
);
1297 counts
[CHECKOUT_ACTION__REMOVE
] += data
->removes
.length
;
1299 if (counts
[CHECKOUT_ACTION__CONFLICT
] > 0 &&
1300 (data
->strategy
& GIT_CHECKOUT_ALLOW_CONFLICTS
) == 0)
1302 giterr_set(GITERR_CHECKOUT
, "%d %s checkout",
1303 (int)counts
[CHECKOUT_ACTION__CONFLICT
],
1304 counts
[CHECKOUT_ACTION__CONFLICT
] == 1 ?
1305 "conflict prevents" : "conflicts prevent");
1306 error
= GIT_ECONFLICT
;
1311 if ((error
= checkout_get_remove_conflicts(data
, workdir
, &pathspec
)) < 0 ||
1312 (error
= checkout_get_update_conflicts(data
, workdir
, &pathspec
)) < 0)
1315 counts
[CHECKOUT_ACTION__REMOVE_CONFLICT
] = git_vector_length(&data
->remove_conflicts
);
1316 counts
[CHECKOUT_ACTION__UPDATE_CONFLICT
] = git_vector_length(&data
->update_conflicts
);
1318 git_pathspec__vfree(&pathspec
);
1319 git_pool_clear(&pathpool
);
1326 *actions_ptr
= NULL
;
1329 git_pathspec__vfree(&pathspec
);
1330 git_pool_clear(&pathpool
);
1335 static bool should_remove_existing(checkout_data
*data
)
1339 git_repository__cvar(&ignorecase
, data
->repo
, GIT_CVAR_IGNORECASE
);
1341 return (ignorecase
&&
1342 (data
->strategy
& GIT_CHECKOUT_DONT_REMOVE_EXISTING
) == 0);
1345 #define MKDIR_NORMAL \
1346 GIT_MKDIR_PATH | GIT_MKDIR_VERIFY_DIR
1347 #define MKDIR_REMOVE_EXISTING \
1348 MKDIR_NORMAL | GIT_MKDIR_REMOVE_FILES | GIT_MKDIR_REMOVE_SYMLINKS
1350 static int checkout_mkdir(
1351 checkout_data
*data
,
1357 struct git_futils_mkdir_options mkdir_opts
= {0};
1360 mkdir_opts
.dir_map
= data
->mkdir_map
;
1361 mkdir_opts
.pool
= &data
->pool
;
1363 error
= git_futils_mkdir_ext(
1364 path
, base
, mode
, flags
, &mkdir_opts
);
1366 data
->perfdata
.mkdir_calls
+= mkdir_opts
.perfdata
.mkdir_calls
;
1367 data
->perfdata
.stat_calls
+= mkdir_opts
.perfdata
.stat_calls
;
1368 data
->perfdata
.chmod_calls
+= mkdir_opts
.perfdata
.chmod_calls
;
1373 static int mkpath2file(
1374 checkout_data
*data
, const char *path
, unsigned int mode
)
1377 bool remove_existing
= should_remove_existing(data
);
1378 unsigned int flags
=
1379 (remove_existing
? MKDIR_REMOVE_EXISTING
: MKDIR_NORMAL
) |
1380 GIT_MKDIR_SKIP_LAST
;
1383 if ((error
= checkout_mkdir(
1384 data
, path
, data
->opts
.target_directory
, mode
, flags
)) < 0)
1387 if (remove_existing
) {
1388 data
->perfdata
.stat_calls
++;
1390 if (p_lstat(path
, &st
) == 0) {
1392 /* Some file, symlink or folder already exists at this name.
1393 * We would have removed it in remove_the_old unless we're on
1394 * a case inensitive filesystem (or the user has asked us not
1395 * to). Remove the similarly named file to write the new.
1397 error
= git_futils_rmdir_r(path
, NULL
, GIT_RMDIR_REMOVE_FILES
);
1398 } else if (errno
!= ENOENT
) {
1399 giterr_set(GITERR_OS
, "Failed to stat file '%s'", path
);
1409 struct checkout_stream
{
1410 git_writestream base
;
1416 static int checkout_stream_write(
1417 git_writestream
*s
, const char *buffer
, size_t len
)
1419 struct checkout_stream
*stream
= (struct checkout_stream
*)s
;
1422 if ((ret
= p_write(stream
->fd
, buffer
, len
)) < 0)
1423 giterr_set(GITERR_OS
, "Could not write to '%s'", stream
->path
);
1428 static int checkout_stream_close(git_writestream
*s
)
1430 struct checkout_stream
*stream
= (struct checkout_stream
*)s
;
1431 assert(stream
&& stream
->open
);
1434 return p_close(stream
->fd
);
1437 static void checkout_stream_free(git_writestream
*s
)
1442 static int blob_content_to_file(
1443 checkout_data
*data
,
1447 const char *hint_path
,
1448 mode_t entry_filemode
)
1450 int flags
= data
->opts
.file_open_flags
;
1451 mode_t file_mode
= data
->opts
.file_mode
?
1452 data
->opts
.file_mode
: entry_filemode
;
1453 git_filter_options filter_opts
= GIT_FILTER_OPTIONS_INIT
;
1454 struct checkout_stream writer
;
1456 git_filter_list
*fl
= NULL
;
1460 if (hint_path
== NULL
)
1463 if ((error
= mkpath2file(data
, path
, data
->opts
.dir_mode
)) < 0)
1467 flags
= O_CREAT
| O_TRUNC
| O_WRONLY
;
1468 if (!(mode
= file_mode
))
1469 mode
= GIT_FILEMODE_BLOB
;
1471 if ((fd
= p_open(path
, flags
, mode
)) < 0) {
1472 giterr_set(GITERR_OS
, "Could not open '%s' for writing", path
);
1476 filter_opts
.attr_session
= &data
->attr_session
;
1477 filter_opts
.temp_buf
= &data
->tmp
;
1479 if (!data
->opts
.disable_filters
&&
1480 (error
= git_filter_list__load_ext(
1481 &fl
, data
->repo
, blob
, hint_path
,
1482 GIT_FILTER_TO_WORKTREE
, &filter_opts
)))
1485 /* setup the writer */
1486 memset(&writer
, 0, sizeof(struct checkout_stream
));
1487 writer
.base
.write
= checkout_stream_write
;
1488 writer
.base
.close
= checkout_stream_close
;
1489 writer
.base
.free
= checkout_stream_free
;
1494 error
= git_filter_list_stream_blob(fl
, blob
, &writer
.base
);
1496 assert(writer
.open
== 0);
1498 git_filter_list_free(fl
);
1503 if (GIT_PERMS_IS_EXEC(mode
)) {
1504 data
->perfdata
.chmod_calls
++;
1506 if ((error
= p_chmod(path
, mode
)) < 0) {
1507 giterr_set(GITERR_OS
, "Failed to set permissions on '%s'", path
);
1513 data
->perfdata
.stat_calls
++;
1515 if ((error
= p_stat(path
, st
)) < 0) {
1516 giterr_set(GITERR_OS
, "Error statting '%s'", path
);
1520 st
->st_mode
= entry_filemode
;
1526 static int blob_content_to_link(
1527 checkout_data
*data
,
1532 git_buf linktarget
= GIT_BUF_INIT
;
1535 if ((error
= mkpath2file(data
, path
, data
->opts
.dir_mode
)) < 0)
1538 if ((error
= git_blob__getbuf(&linktarget
, blob
)) < 0)
1541 if (data
->can_symlink
) {
1542 if ((error
= p_symlink(git_buf_cstr(&linktarget
), path
)) < 0)
1543 giterr_set(GITERR_OS
, "Could not create symlink %s", path
);
1545 error
= git_futils_fake_symlink(git_buf_cstr(&linktarget
), path
);
1549 data
->perfdata
.stat_calls
++;
1551 if ((error
= p_lstat(path
, st
)) < 0)
1552 giterr_set(GITERR_CHECKOUT
, "Could not stat symlink %s", path
);
1554 st
->st_mode
= GIT_FILEMODE_LINK
;
1557 git_buf_free(&linktarget
);
1562 static int checkout_update_index(
1563 checkout_data
*data
,
1564 const git_diff_file
*file
,
1567 git_index_entry entry
;
1572 memset(&entry
, 0, sizeof(entry
));
1573 entry
.path
= (char *)file
->path
; /* cast to prevent warning */
1574 git_index_entry__init_from_stat(&entry
, st
, true);
1575 git_oid_cpy(&entry
.id
, &file
->id
);
1577 return git_index_add(data
->index
, &entry
);
1580 static int checkout_submodule_update_index(
1581 checkout_data
*data
,
1582 const git_diff_file
*file
)
1586 /* update the index unless prevented */
1587 if ((data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) != 0)
1590 git_buf_truncate(&data
->path
, data
->workdir_len
);
1591 if (git_buf_puts(&data
->path
, file
->path
) < 0)
1594 data
->perfdata
.stat_calls
++;
1595 if (p_stat(git_buf_cstr(&data
->path
), &st
) < 0) {
1597 GITERR_CHECKOUT
, "Could not stat submodule %s\n", file
->path
);
1598 return GIT_ENOTFOUND
;
1601 st
.st_mode
= GIT_FILEMODE_COMMIT
;
1603 return checkout_update_index(data
, file
, &st
);
1606 static int checkout_submodule(
1607 checkout_data
*data
,
1608 const git_diff_file
*file
)
1610 bool remove_existing
= should_remove_existing(data
);
1613 /* Until submodules are supported, UPDATE_ONLY means do nothing here */
1614 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0)
1617 if ((error
= checkout_mkdir(
1619 file
->path
, data
->opts
.target_directory
, data
->opts
.dir_mode
,
1620 remove_existing
? MKDIR_REMOVE_EXISTING
: MKDIR_NORMAL
)) < 0)
1623 if ((error
= git_submodule_lookup(NULL
, data
->repo
, file
->path
)) < 0) {
1624 /* I've observed repos with submodules in the tree that do not
1625 * have a .gitmodules - core Git just makes an empty directory
1627 if (error
== GIT_ENOTFOUND
) {
1629 return checkout_submodule_update_index(data
, file
);
1635 /* TODO: Support checkout_strategy options. Two circumstances:
1636 * 1 - submodule already checked out, but we need to move the HEAD
1637 * to the new OID, or
1638 * 2 - submodule not checked out and we should recursively check it out
1640 * Checkout will not execute a pull on the submodule, but a clone
1641 * command should probably be able to. Do we need a submodule callback?
1644 return checkout_submodule_update_index(data
, file
);
1647 static void report_progress(
1648 checkout_data
*data
,
1651 if (data
->opts
.progress_cb
)
1652 data
->opts
.progress_cb(
1653 path
, data
->completed_steps
, data
->total_steps
,
1654 data
->opts
.progress_payload
);
1657 static int checkout_safe_for_update_only(
1658 checkout_data
*data
, const char *path
, mode_t expected_mode
)
1662 data
->perfdata
.stat_calls
++;
1664 if (p_lstat(path
, &st
) < 0) {
1665 /* if doesn't exist, then no error and no update */
1666 if (errno
== ENOENT
|| errno
== ENOTDIR
)
1669 /* otherwise, stat error and no update */
1670 giterr_set(GITERR_OS
, "Failed to stat file '%s'", path
);
1674 /* only safe for update if this is the same type of file */
1675 if ((st
.st_mode
& ~0777) == (expected_mode
& ~0777))
1681 static int checkout_write_content(
1682 checkout_data
*data
,
1684 const char *full_path
,
1685 const char *hint_path
,
1692 if ((error
= git_blob_lookup(&blob
, data
->repo
, oid
)) < 0)
1696 error
= blob_content_to_link(data
, st
, blob
, full_path
);
1698 error
= blob_content_to_file(data
, st
, blob
, full_path
, hint_path
, mode
);
1700 git_blob_free(blob
);
1702 /* if we try to create the blob and an existing directory blocks it from
1703 * being written, then there must have been a typechange conflict in a
1704 * parent directory - suppress the error and try to continue.
1706 if ((data
->strategy
& GIT_CHECKOUT_ALLOW_CONFLICTS
) != 0 &&
1707 (error
== GIT_ENOTFOUND
|| error
== GIT_EEXISTS
))
1716 static int checkout_blob(
1717 checkout_data
*data
,
1718 const git_diff_file
*file
)
1723 git_buf_truncate(&data
->path
, data
->workdir_len
);
1724 if (git_buf_puts(&data
->path
, file
->path
) < 0)
1727 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0) {
1728 int rval
= checkout_safe_for_update_only(
1729 data
, git_buf_cstr(&data
->path
), file
->mode
);
1734 error
= checkout_write_content(
1735 data
, &file
->id
, git_buf_cstr(&data
->path
), NULL
, file
->mode
, &st
);
1737 /* update the index unless prevented */
1738 if (!error
&& (data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0)
1739 error
= checkout_update_index(data
, file
, &st
);
1741 /* update the submodule data if this was a new .gitmodules file */
1742 if (!error
&& strcmp(file
->path
, ".gitmodules") == 0)
1743 data
->reload_submodules
= true;
1748 static int checkout_remove_the_old(
1749 unsigned int *actions
,
1750 checkout_data
*data
)
1753 git_diff_delta
*delta
;
1756 const char *workdir
= git_buf_cstr(&data
->path
);
1757 uint32_t flg
= GIT_RMDIR_EMPTY_PARENTS
|
1758 GIT_RMDIR_REMOVE_FILES
| GIT_RMDIR_REMOVE_BLOCKERS
;
1760 if (data
->opts
.checkout_strategy
& GIT_CHECKOUT_SKIP_LOCKED_DIRECTORIES
)
1761 flg
|= GIT_RMDIR_SKIP_NONEMPTY
;
1763 git_buf_truncate(&data
->path
, data
->workdir_len
);
1765 git_vector_foreach(&data
->diff
->deltas
, i
, delta
) {
1766 if (actions
[i
] & CHECKOUT_ACTION__REMOVE
) {
1767 error
= git_futils_rmdir_r(delta
->old_file
.path
, workdir
, flg
);
1771 data
->completed_steps
++;
1772 report_progress(data
, delta
->old_file
.path
);
1774 if ((actions
[i
] & CHECKOUT_ACTION__UPDATE_BLOB
) == 0 &&
1775 (data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0 &&
1776 data
->index
!= NULL
)
1778 (void)git_index_remove(data
->index
, delta
->old_file
.path
, 0);
1783 git_vector_foreach(&data
->removes
, i
, str
) {
1784 error
= git_futils_rmdir_r(str
, workdir
, flg
);
1788 data
->completed_steps
++;
1789 report_progress(data
, str
);
1791 if ((data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0 &&
1792 data
->index
!= NULL
)
1794 if (str
[strlen(str
) - 1] == '/')
1795 (void)git_index_remove_directory(data
->index
, str
, 0);
1797 (void)git_index_remove(data
->index
, str
, 0);
1804 static int checkout_deferred_remove(git_repository
*repo
, const char *path
)
1807 int error
= git_futils_rmdir_r(
1808 path
, data
->opts
.target_directory
, GIT_RMDIR_EMPTY_PARENTS
);
1810 if (error
== GIT_ENOTFOUND
) {
1824 static int checkout_create_the_new(
1825 unsigned int *actions
,
1826 checkout_data
*data
)
1829 git_diff_delta
*delta
;
1832 git_vector_foreach(&data
->diff
->deltas
, i
, delta
) {
1833 if (actions
[i
] & CHECKOUT_ACTION__DEFER_REMOVE
) {
1834 /* this had a blocker directory that should only be removed iff
1835 * all of the contents of the directory were safely removed
1837 if ((error
= checkout_deferred_remove(
1838 data
->repo
, delta
->old_file
.path
)) < 0)
1842 if (actions
[i
] & CHECKOUT_ACTION__UPDATE_BLOB
) {
1843 error
= checkout_blob(data
, &delta
->new_file
);
1847 data
->completed_steps
++;
1848 report_progress(data
, delta
->new_file
.path
);
1855 static int checkout_create_submodules(
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 has 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_SUBMODULE
) {
1874 int error
= checkout_submodule(data
, &delta
->new_file
);
1878 data
->completed_steps
++;
1879 report_progress(data
, delta
->new_file
.path
);
1886 static int checkout_lookup_head_tree(git_tree
**out
, git_repository
*repo
)
1889 git_reference
*ref
= NULL
;
1892 if (!(error
= git_repository_head(&ref
, repo
)) &&
1893 !(error
= git_reference_peel(&head
, ref
, GIT_OBJ_TREE
)))
1894 *out
= (git_tree
*)head
;
1896 git_reference_free(ref
);
1902 static int conflict_entry_name(
1904 const char *side_name
,
1905 const char *filename
)
1907 if (git_buf_puts(out
, side_name
) < 0 ||
1908 git_buf_putc(out
, ':') < 0 ||
1909 git_buf_puts(out
, filename
) < 0)
1915 static int checkout_path_suffixed(git_buf
*path
, const char *suffix
)
1918 int i
= 0, error
= 0;
1920 if ((error
= git_buf_putc(path
, '~')) < 0 || (error
= git_buf_puts(path
, suffix
)) < 0)
1923 path_len
= git_buf_len(path
);
1925 while (git_path_exists(git_buf_cstr(path
)) && i
< INT_MAX
) {
1926 git_buf_truncate(path
, path_len
);
1928 if ((error
= git_buf_putc(path
, '_')) < 0 ||
1929 (error
= git_buf_printf(path
, "%d", i
)) < 0)
1936 git_buf_truncate(path
, path_len
);
1938 giterr_set(GITERR_CHECKOUT
, "Could not write '%s': working directory file exists", path
);
1945 static int checkout_write_entry(
1946 checkout_data
*data
,
1947 checkout_conflictdata
*conflict
,
1948 const git_index_entry
*side
)
1950 const char *hint_path
= NULL
, *suffix
;
1954 assert (side
== conflict
->ours
|| side
== conflict
->theirs
);
1956 git_buf_truncate(&data
->path
, data
->workdir_len
);
1957 if (git_buf_puts(&data
->path
, side
->path
) < 0)
1960 if ((conflict
->name_collision
|| conflict
->directoryfile
) &&
1961 (data
->strategy
& GIT_CHECKOUT_USE_OURS
) == 0 &&
1962 (data
->strategy
& GIT_CHECKOUT_USE_THEIRS
) == 0) {
1964 if (side
== conflict
->ours
)
1965 suffix
= data
->opts
.our_label
? data
->opts
.our_label
:
1968 suffix
= data
->opts
.their_label
? data
->opts
.their_label
:
1971 if (checkout_path_suffixed(&data
->path
, suffix
) < 0)
1974 hint_path
= side
->path
;
1977 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0 &&
1978 (error
= checkout_safe_for_update_only(data
, git_buf_cstr(&data
->path
), side
->mode
)) <= 0)
1981 return checkout_write_content(data
,
1982 &side
->id
, git_buf_cstr(&data
->path
), hint_path
, side
->mode
, &st
);
1985 static int checkout_write_entries(
1986 checkout_data
*data
,
1987 checkout_conflictdata
*conflict
)
1991 if ((error
= checkout_write_entry(data
, conflict
, conflict
->ours
)) >= 0)
1992 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
1997 static int checkout_merge_path(
1999 checkout_data
*data
,
2000 checkout_conflictdata
*conflict
,
2001 git_merge_file_result
*result
)
2003 const char *our_label_raw
, *their_label_raw
, *suffix
;
2006 if ((error
= git_buf_joinpath(out
, git_repository_workdir(data
->repo
), result
->path
)) < 0)
2009 /* Most conflicts simply use the filename in the index */
2010 if (!conflict
->name_collision
)
2013 /* Rename 2->1 conflicts need the branch name appended */
2014 our_label_raw
= data
->opts
.our_label
? data
->opts
.our_label
: "ours";
2015 their_label_raw
= data
->opts
.their_label
? data
->opts
.their_label
: "theirs";
2016 suffix
= strcmp(result
->path
, conflict
->ours
->path
) == 0 ? our_label_raw
: their_label_raw
;
2018 if ((error
= checkout_path_suffixed(out
, suffix
)) < 0)
2024 static int checkout_write_merge(
2025 checkout_data
*data
,
2026 checkout_conflictdata
*conflict
)
2028 git_buf our_label
= GIT_BUF_INIT
, their_label
= GIT_BUF_INIT
,
2029 path_suffixed
= GIT_BUF_INIT
, path_workdir
= GIT_BUF_INIT
,
2030 in_data
= GIT_BUF_INIT
, out_data
= GIT_BUF_INIT
;
2031 git_merge_file_options opts
= GIT_MERGE_FILE_OPTIONS_INIT
;
2032 git_merge_file_result result
= {0};
2033 git_filebuf output
= GIT_FILEBUF_INIT
;
2034 git_filter_list
*fl
= NULL
;
2035 git_filter_options filter_opts
= GIT_FILTER_OPTIONS_INIT
;
2038 if (data
->opts
.checkout_strategy
& GIT_CHECKOUT_CONFLICT_STYLE_DIFF3
)
2039 opts
.flags
|= GIT_MERGE_FILE_STYLE_DIFF3
;
2041 opts
.ancestor_label
= data
->opts
.ancestor_label
?
2042 data
->opts
.ancestor_label
: "ancestor";
2043 opts
.our_label
= data
->opts
.our_label
?
2044 data
->opts
.our_label
: "ours";
2045 opts
.their_label
= data
->opts
.their_label
?
2046 data
->opts
.their_label
: "theirs";
2048 /* If all the paths are identical, decorate the diff3 file with the branch
2049 * names. Otherwise, append branch_name:path.
2051 if (conflict
->ours
&& conflict
->theirs
&&
2052 strcmp(conflict
->ours
->path
, conflict
->theirs
->path
) != 0) {
2054 if ((error
= conflict_entry_name(
2055 &our_label
, opts
.our_label
, conflict
->ours
->path
)) < 0 ||
2056 (error
= conflict_entry_name(
2057 &their_label
, opts
.their_label
, conflict
->theirs
->path
)) < 0)
2060 opts
.our_label
= git_buf_cstr(&our_label
);
2061 opts
.their_label
= git_buf_cstr(&their_label
);
2064 if ((error
= git_merge_file_from_index(&result
, data
->repo
,
2065 conflict
->ancestor
, conflict
->ours
, conflict
->theirs
, &opts
)) < 0)
2068 if (result
.path
== NULL
|| result
.mode
== 0) {
2069 giterr_set(GITERR_CHECKOUT
, "Could not merge contents of file");
2070 error
= GIT_ECONFLICT
;
2074 if ((error
= checkout_merge_path(&path_workdir
, data
, conflict
, &result
)) < 0)
2077 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0 &&
2078 (error
= checkout_safe_for_update_only(data
, git_buf_cstr(&path_workdir
), result
.mode
)) <= 0)
2081 if (!data
->opts
.disable_filters
) {
2082 in_data
.ptr
= (char *)result
.ptr
;
2083 in_data
.size
= result
.len
;
2085 filter_opts
.attr_session
= &data
->attr_session
;
2086 filter_opts
.temp_buf
= &data
->tmp
;
2088 if ((error
= git_filter_list__load_ext(
2089 &fl
, data
->repo
, NULL
, git_buf_cstr(&path_workdir
),
2090 GIT_FILTER_TO_WORKTREE
, &filter_opts
)) < 0 ||
2091 (error
= git_filter_list_apply_to_data(&out_data
, fl
, &in_data
)) < 0)
2094 out_data
.ptr
= (char *)result
.ptr
;
2095 out_data
.size
= result
.len
;
2098 if ((error
= mkpath2file(data
, path_workdir
.ptr
, data
->opts
.dir_mode
)) < 0 ||
2099 (error
= git_filebuf_open(&output
, git_buf_cstr(&path_workdir
), GIT_FILEBUF_DO_NOT_BUFFER
, result
.mode
)) < 0 ||
2100 (error
= git_filebuf_write(&output
, out_data
.ptr
, out_data
.size
)) < 0 ||
2101 (error
= git_filebuf_commit(&output
)) < 0)
2105 git_filter_list_free(fl
);
2107 git_buf_free(&out_data
);
2108 git_buf_free(&our_label
);
2109 git_buf_free(&their_label
);
2111 git_merge_file_result_free(&result
);
2112 git_buf_free(&path_workdir
);
2113 git_buf_free(&path_suffixed
);
2118 static int checkout_conflict_add(
2119 checkout_data
*data
,
2120 const git_index_entry
*conflict
)
2122 int error
= git_index_remove(data
->index
, conflict
->path
, 0);
2124 if (error
== GIT_ENOTFOUND
)
2129 return git_index_add(data
->index
, conflict
);
2132 static int checkout_conflict_update_index(
2133 checkout_data
*data
,
2134 checkout_conflictdata
*conflict
)
2138 if (conflict
->ancestor
)
2139 error
= checkout_conflict_add(data
, conflict
->ancestor
);
2141 if (!error
&& conflict
->ours
)
2142 error
= checkout_conflict_add(data
, conflict
->ours
);
2144 if (!error
&& conflict
->theirs
)
2145 error
= checkout_conflict_add(data
, conflict
->theirs
);
2150 static int checkout_create_conflicts(checkout_data
*data
)
2152 checkout_conflictdata
*conflict
;
2156 git_vector_foreach(&data
->update_conflicts
, i
, conflict
) {
2158 /* Both deleted: nothing to do */
2159 if (conflict
->ours
== NULL
&& conflict
->theirs
== NULL
)
2162 else if ((data
->strategy
& GIT_CHECKOUT_USE_OURS
) &&
2164 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2165 else if ((data
->strategy
& GIT_CHECKOUT_USE_THEIRS
) &&
2167 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2169 /* Ignore the other side of name collisions. */
2170 else if ((data
->strategy
& GIT_CHECKOUT_USE_OURS
) &&
2171 !conflict
->ours
&& conflict
->name_collision
)
2173 else if ((data
->strategy
& GIT_CHECKOUT_USE_THEIRS
) &&
2174 !conflict
->theirs
&& conflict
->name_collision
)
2177 /* For modify/delete, name collisions and d/f conflicts, write
2178 * the file (potentially with the name mangled.
2180 else if (conflict
->ours
!= NULL
&& conflict
->theirs
== NULL
)
2181 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2182 else if (conflict
->ours
== NULL
&& conflict
->theirs
!= NULL
)
2183 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2185 /* Add/add conflicts and rename 1->2 conflicts, write the
2186 * ours/theirs sides (potentially name mangled).
2188 else if (conflict
->one_to_two
)
2189 error
= checkout_write_entries(data
, conflict
);
2191 /* If all sides are links, write the ours side */
2192 else if (S_ISLNK(conflict
->ours
->mode
) &&
2193 S_ISLNK(conflict
->theirs
->mode
))
2194 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2195 /* Link/file conflicts, write the file side */
2196 else if (S_ISLNK(conflict
->ours
->mode
))
2197 error
= checkout_write_entry(data
, conflict
, conflict
->theirs
);
2198 else if (S_ISLNK(conflict
->theirs
->mode
))
2199 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2201 /* If any side is a gitlink, do nothing. */
2202 else if (conflict
->submodule
)
2205 /* If any side is binary, write the ours side */
2206 else if (conflict
->binary
)
2207 error
= checkout_write_entry(data
, conflict
, conflict
->ours
);
2210 error
= checkout_write_merge(data
, conflict
);
2212 /* Update the index extensions (REUC and NAME) if we're checking
2213 * out a different index. (Otherwise just leave them there.)
2215 if (!error
&& (data
->strategy
& GIT_CHECKOUT_DONT_UPDATE_INDEX
) == 0)
2216 error
= checkout_conflict_update_index(data
, conflict
);
2221 data
->completed_steps
++;
2222 report_progress(data
,
2223 conflict
->ours
? conflict
->ours
->path
:
2224 (conflict
->theirs
? conflict
->theirs
->path
: conflict
->ancestor
->path
));
2230 static int checkout_remove_conflicts(checkout_data
*data
)
2232 const char *conflict
;
2235 git_vector_foreach(&data
->remove_conflicts
, i
, conflict
) {
2236 if (git_index_conflict_remove(data
->index
, conflict
) < 0)
2239 data
->completed_steps
++;
2245 static int checkout_extensions_update_index(checkout_data
*data
)
2247 const git_index_reuc_entry
*reuc_entry
;
2248 const git_index_name_entry
*name_entry
;
2252 if ((data
->strategy
& GIT_CHECKOUT_UPDATE_ONLY
) != 0)
2255 if (data
->update_reuc
) {
2256 git_vector_foreach(data
->update_reuc
, i
, reuc_entry
) {
2257 if ((error
= git_index_reuc_add(data
->index
, reuc_entry
->path
,
2258 reuc_entry
->mode
[0], &reuc_entry
->oid
[0],
2259 reuc_entry
->mode
[1], &reuc_entry
->oid
[1],
2260 reuc_entry
->mode
[2], &reuc_entry
->oid
[2])) < 0)
2265 if (data
->update_names
) {
2266 git_vector_foreach(data
->update_names
, i
, name_entry
) {
2267 if ((error
= git_index_name_add(data
->index
, name_entry
->ancestor
,
2268 name_entry
->ours
, name_entry
->theirs
)) < 0)
2277 static void checkout_data_clear(checkout_data
*data
)
2279 if (data
->opts_free_baseline
) {
2280 git_tree_free(data
->opts
.baseline
);
2281 data
->opts
.baseline
= NULL
;
2284 git_vector_free(&data
->removes
);
2285 git_pool_clear(&data
->pool
);
2287 git_vector_free_deep(&data
->remove_conflicts
);
2288 git_vector_free_deep(&data
->update_conflicts
);
2290 git__free(data
->pfx
);
2293 git_strmap_free(data
->mkdir_map
);
2295 git_buf_free(&data
->path
);
2296 git_buf_free(&data
->tmp
);
2298 git_index_free(data
->index
);
2301 git_strmap_free(data
->mkdir_map
);
2303 git_attr_session__free(&data
->attr_session
);
2306 static int checkout_data_init(
2307 checkout_data
*data
,
2308 git_iterator
*target
,
2309 const git_checkout_options
*proposed
)
2312 git_repository
*repo
= git_iterator_owner(target
);
2314 memset(data
, 0, sizeof(*data
));
2317 giterr_set(GITERR_CHECKOUT
, "Cannot checkout nothing");
2321 if ((!proposed
|| !proposed
->target_directory
) &&
2322 (error
= git_repository__ensure_not_bare(repo
, "checkout")) < 0)
2326 data
->target
= target
;
2328 GITERR_CHECK_VERSION(
2329 proposed
, GIT_CHECKOUT_OPTIONS_VERSION
, "git_checkout_options");
2332 GIT_INIT_STRUCTURE(&data
->opts
, GIT_CHECKOUT_OPTIONS_VERSION
);
2334 memmove(&data
->opts
, proposed
, sizeof(git_checkout_options
));
2336 if (!data
->opts
.target_directory
)
2337 data
->opts
.target_directory
= git_repository_workdir(repo
);
2338 else if (!git_path_isdir(data
->opts
.target_directory
) &&
2339 (error
= checkout_mkdir(data
,
2340 data
->opts
.target_directory
, NULL
,
2341 GIT_DIR_MODE
, GIT_MKDIR_VERIFY_DIR
)) < 0)
2344 /* refresh config and index content unless NO_REFRESH is given */
2345 if ((data
->opts
.checkout_strategy
& GIT_CHECKOUT_NO_REFRESH
) == 0) {
2348 if ((error
= git_repository_config__weakptr(&cfg
, repo
)) < 0)
2351 /* Get the repository index and reload it (unless we're checking
2352 * out the index; then it has the changes we're trying to check
2353 * out and those should not be overwritten.)
2355 if ((error
= git_repository_index(&data
->index
, data
->repo
)) < 0)
2358 if (data
->index
!= git_iterator_get_index(target
)) {
2359 if ((error
= git_index_read(data
->index
, true)) < 0)
2362 /* cannot checkout if unresolved conflicts exist */
2363 if ((data
->opts
.checkout_strategy
& GIT_CHECKOUT_FORCE
) == 0 &&
2364 git_index_has_conflicts(data
->index
)) {
2365 error
= GIT_ECONFLICT
;
2366 giterr_set(GITERR_CHECKOUT
,
2367 "unresolved conflicts exist in the index");
2371 /* clean conflict data in the current index */
2372 git_index_name_clear(data
->index
);
2373 git_index_reuc_clear(data
->index
);
2377 /* if you are forcing, allow all safe updates, plus recreate missing */
2378 if ((data
->opts
.checkout_strategy
& GIT_CHECKOUT_FORCE
) != 0)
2379 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_SAFE
|
2380 GIT_CHECKOUT_RECREATE_MISSING
;
2382 /* if the repository does not actually have an index file, then this
2383 * is an initial checkout (perhaps from clone), so we allow safe updates
2385 if (!data
->index
->on_disk
&&
2386 (data
->opts
.checkout_strategy
& GIT_CHECKOUT_SAFE
) != 0)
2387 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_RECREATE_MISSING
;
2389 data
->strategy
= data
->opts
.checkout_strategy
;
2391 /* opts->disable_filters is false by default */
2393 if (!data
->opts
.dir_mode
)
2394 data
->opts
.dir_mode
= GIT_DIR_MODE
;
2396 if (!data
->opts
.file_open_flags
)
2397 data
->opts
.file_open_flags
= O_CREAT
| O_TRUNC
| O_WRONLY
;
2399 data
->pfx
= git_pathspec_prefix(&data
->opts
.paths
);
2401 if ((error
= git_repository__cvar(
2402 &data
->can_symlink
, repo
, GIT_CVAR_SYMLINKS
)) < 0)
2405 if (!data
->opts
.baseline
&& !data
->opts
.baseline_index
) {
2406 data
->opts_free_baseline
= true;
2408 error
= checkout_lookup_head_tree(&data
->opts
.baseline
, repo
);
2410 if (error
== GIT_EUNBORNBRANCH
) {
2419 if ((data
->opts
.checkout_strategy
&
2420 (GIT_CHECKOUT_CONFLICT_STYLE_MERGE
| GIT_CHECKOUT_CONFLICT_STYLE_DIFF3
)) == 0) {
2421 git_config_entry
*conflict_style
= NULL
;
2422 git_config
*cfg
= NULL
;
2424 if ((error
= git_repository_config__weakptr(&cfg
, repo
)) < 0 ||
2425 (error
= git_config_get_entry(&conflict_style
, cfg
, "merge.conflictstyle")) < 0 ||
2426 error
== GIT_ENOTFOUND
)
2430 else if (strcmp(conflict_style
->value
, "merge") == 0)
2431 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_CONFLICT_STYLE_MERGE
;
2432 else if (strcmp(conflict_style
->value
, "diff3") == 0)
2433 data
->opts
.checkout_strategy
|= GIT_CHECKOUT_CONFLICT_STYLE_DIFF3
;
2435 giterr_set(GITERR_CHECKOUT
, "unknown style '%s' given for 'merge.conflictstyle'",
2438 git_config_entry_free(conflict_style
);
2441 git_config_entry_free(conflict_style
);
2444 if ((error
= git_vector_init(&data
->removes
, 0, git__strcmp_cb
)) < 0 ||
2445 (error
= git_vector_init(&data
->remove_conflicts
, 0, NULL
)) < 0 ||
2446 (error
= git_vector_init(&data
->update_conflicts
, 0, NULL
)) < 0 ||
2447 (error
= git_pool_init(&data
->pool
, 1, 0)) < 0 ||
2448 (error
= git_buf_puts(&data
->path
, data
->opts
.target_directory
)) < 0 ||
2449 (error
= git_path_to_dir(&data
->path
)) < 0 ||
2450 (error
= git_strmap_alloc(&data
->mkdir_map
)) < 0)
2453 data
->workdir_len
= git_buf_len(&data
->path
);
2455 git_attr_session__init(&data
->attr_session
, data
->repo
);
2459 checkout_data_clear(data
);
2464 #define CHECKOUT_INDEX_DONT_WRITE_MASK \
2465 (GIT_CHECKOUT_DONT_UPDATE_INDEX | GIT_CHECKOUT_DONT_WRITE_INDEX)
2467 int git_checkout_iterator(
2468 git_iterator
*target
,
2470 const git_checkout_options
*opts
)
2473 git_iterator
*baseline
= NULL
, *workdir
= NULL
;
2474 checkout_data data
= {0};
2475 git_diff_options diff_opts
= GIT_DIFF_OPTIONS_INIT
;
2476 uint32_t *actions
= NULL
;
2477 size_t *counts
= NULL
;
2478 git_iterator_flag_t iterflags
= 0;
2480 /* initialize structures and options */
2481 error
= checkout_data_init(&data
, target
, opts
);
2486 GIT_DIFF_INCLUDE_UNMODIFIED
|
2487 GIT_DIFF_INCLUDE_UNREADABLE
|
2488 GIT_DIFF_INCLUDE_UNTRACKED
|
2489 GIT_DIFF_RECURSE_UNTRACKED_DIRS
| /* needed to match baseline */
2490 GIT_DIFF_INCLUDE_IGNORED
|
2491 GIT_DIFF_INCLUDE_TYPECHANGE
|
2492 GIT_DIFF_INCLUDE_TYPECHANGE_TREES
|
2493 GIT_DIFF_SKIP_BINARY_CHECK
|
2494 GIT_DIFF_INCLUDE_CASECHANGE
;
2495 if (data
.opts
.checkout_strategy
& GIT_CHECKOUT_DISABLE_PATHSPEC_MATCH
)
2496 diff_opts
.flags
|= GIT_DIFF_DISABLE_PATHSPEC_MATCH
;
2497 if (data
.opts
.paths
.count
> 0)
2498 diff_opts
.pathspec
= data
.opts
.paths
;
2500 /* set up iterators */
2502 iterflags
= git_iterator_ignore_case(target
) ?
2503 GIT_ITERATOR_IGNORE_CASE
: GIT_ITERATOR_DONT_IGNORE_CASE
;
2505 if ((error
= git_iterator_reset(target
, data
.pfx
, data
.pfx
)) < 0 ||
2506 (error
= git_iterator_for_workdir_ext(
2507 &workdir
, data
.repo
, data
.opts
.target_directory
, index
, NULL
,
2508 iterflags
| GIT_ITERATOR_DONT_AUTOEXPAND
,
2509 data
.pfx
, data
.pfx
)) < 0)
2512 if (data
.opts
.baseline_index
) {
2513 if ((error
= git_iterator_for_index(
2514 &baseline
, data
.opts
.baseline_index
,
2515 iterflags
, data
.pfx
, data
.pfx
)) < 0)
2518 if ((error
= git_iterator_for_tree(
2519 &baseline
, data
.opts
.baseline
,
2520 iterflags
, data
.pfx
, data
.pfx
)) < 0)
2524 /* Should not have case insensitivity mismatch */
2525 assert(git_iterator_ignore_case(workdir
) == git_iterator_ignore_case(baseline
));
2527 /* Generate baseline-to-target diff which will include an entry for
2528 * every possible update that might need to be made.
2530 if ((error
= git_diff__from_iterators(
2531 &data
.diff
, data
.repo
, baseline
, target
, &diff_opts
)) < 0)
2534 /* Loop through diff (and working directory iterator) building a list of
2535 * actions to be taken, plus look for conflicts and send notifications,
2536 * then loop through conflicts.
2538 if ((error
= checkout_get_actions(&actions
, &counts
, &data
, workdir
)) != 0)
2541 data
.total_steps
= counts
[CHECKOUT_ACTION__REMOVE
] +
2542 counts
[CHECKOUT_ACTION__REMOVE_CONFLICT
] +
2543 counts
[CHECKOUT_ACTION__UPDATE_BLOB
] +
2544 counts
[CHECKOUT_ACTION__UPDATE_SUBMODULE
] +
2545 counts
[CHECKOUT_ACTION__UPDATE_CONFLICT
];
2547 report_progress(&data
, NULL
); /* establish 0 baseline */
2549 /* To deal with some order dependencies, perform remaining checkout
2550 * in three passes: removes, then update blobs, then update submodules.
2552 if (counts
[CHECKOUT_ACTION__REMOVE
] > 0 &&
2553 (error
= checkout_remove_the_old(actions
, &data
)) < 0)
2556 if (counts
[CHECKOUT_ACTION__REMOVE_CONFLICT
] > 0 &&
2557 (error
= checkout_remove_conflicts(&data
)) < 0)
2560 if (counts
[CHECKOUT_ACTION__UPDATE_BLOB
] > 0 &&
2561 (error
= checkout_create_the_new(actions
, &data
)) < 0)
2564 if (counts
[CHECKOUT_ACTION__UPDATE_SUBMODULE
] > 0 &&
2565 (error
= checkout_create_submodules(actions
, &data
)) < 0)
2568 if (counts
[CHECKOUT_ACTION__UPDATE_CONFLICT
] > 0 &&
2569 (error
= checkout_create_conflicts(&data
)) < 0)
2572 if (data
.index
!= git_iterator_get_index(target
) &&
2573 (error
= checkout_extensions_update_index(&data
)) < 0)
2576 assert(data
.completed_steps
== data
.total_steps
);
2578 if (data
.opts
.perfdata_cb
)
2579 data
.opts
.perfdata_cb(&data
.perfdata
, data
.opts
.perfdata_payload
);
2582 if (!error
&& data
.index
!= NULL
&&
2583 (data
.strategy
& CHECKOUT_INDEX_DONT_WRITE_MASK
) == 0)
2584 error
= git_index_write(data
.index
);
2586 git_diff_free(data
.diff
);
2587 git_iterator_free(workdir
);
2588 git_iterator_free(baseline
);
2591 checkout_data_clear(&data
);
2596 int git_checkout_index(
2597 git_repository
*repo
,
2599 const git_checkout_options
*opts
)
2601 int error
, owned
= 0;
2602 git_iterator
*index_i
;
2604 if (!index
&& !repo
) {
2605 giterr_set(GITERR_CHECKOUT
,
2606 "Must provide either repository or index to checkout");
2610 if (index
&& repo
&&
2611 git_index_owner(index
) &&
2612 git_index_owner(index
) != repo
) {
2613 giterr_set(GITERR_CHECKOUT
,
2614 "Index to checkout does not match repository");
2616 } else if(index
&& repo
&& !git_index_owner(index
)) {
2617 GIT_REFCOUNT_OWN(index
, repo
);
2622 repo
= git_index_owner(index
);
2624 if (!index
&& (error
= git_repository_index__weakptr(&index
, repo
)) < 0)
2626 GIT_REFCOUNT_INC(index
);
2628 if (!(error
= git_iterator_for_index(&index_i
, index
, 0, NULL
, NULL
)))
2629 error
= git_checkout_iterator(index_i
, index
, opts
);
2632 GIT_REFCOUNT_OWN(index
, NULL
);
2634 git_iterator_free(index_i
);
2635 git_index_free(index
);
2640 int git_checkout_tree(
2641 git_repository
*repo
,
2642 const git_object
*treeish
,
2643 const git_checkout_options
*opts
)
2647 git_tree
*tree
= NULL
;
2648 git_iterator
*tree_i
= NULL
;
2650 if (!treeish
&& !repo
) {
2651 giterr_set(GITERR_CHECKOUT
,
2652 "Must provide either repository or tree to checkout");
2655 if (treeish
&& repo
&& git_object_owner(treeish
) != repo
) {
2656 giterr_set(GITERR_CHECKOUT
,
2657 "Object to checkout does not match repository");
2662 repo
= git_object_owner(treeish
);
2665 if (git_object_peel((git_object
**)&tree
, treeish
, GIT_OBJ_TREE
) < 0) {
2667 GITERR_CHECKOUT
, "Provided object cannot be peeled to a tree");
2672 if ((error
= checkout_lookup_head_tree(&tree
, repo
)) < 0) {
2673 if (error
!= GIT_EUNBORNBRANCH
)
2676 "HEAD could not be peeled to a tree and no treeish given");
2681 if ((error
= git_repository_index(&index
, repo
)) < 0)
2684 if (!(error
= git_iterator_for_tree(&tree_i
, tree
, 0, NULL
, NULL
)))
2685 error
= git_checkout_iterator(tree_i
, index
, opts
);
2687 git_iterator_free(tree_i
);
2688 git_index_free(index
);
2689 git_tree_free(tree
);
2694 int git_checkout_head(
2695 git_repository
*repo
,
2696 const git_checkout_options
*opts
)
2699 return git_checkout_tree(repo
, NULL
, opts
);
2702 int git_checkout_init_options(git_checkout_options
*opts
, unsigned int version
)
2704 GIT_INIT_STRUCTURE_FROM_TEMPLATE(
2705 opts
, version
, git_checkout_options
, GIT_CHECKOUT_OPTIONS_INIT
);