View Javadoc
1   /*
2    * Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.com>,
3    * Copyright (C) 2010-2012, Matthias Sohn <matthias.sohn@sap.com>
4    * Copyright (C) 2012, Research In Motion Limited
5    * Copyright (C) 2017, Obeo (mathieu.cartaud@obeo.fr)
6    * Copyright (C) 2018, Thomas Wolf <thomas.wolf@paranor.ch> and others
7    *
8    * This program and the accompanying materials are made available under the
9    * terms of the Eclipse Distribution License v. 1.0 which is available at
10   * https://www.eclipse.org/org/documents/edl-v10.php.
11   *
12   * SPDX-License-Identifier: BSD-3-Clause
13   */
14  package org.eclipse.jgit.merge;
15  
16  import static java.nio.charset.StandardCharsets.UTF_8;
17  import static java.time.Instant.EPOCH;
18  import static org.eclipse.jgit.diff.DiffAlgorithm.SupportedAlgorithm.HISTOGRAM;
19  import static org.eclipse.jgit.lib.ConfigConstants.CONFIG_DIFF_SECTION;
20  import static org.eclipse.jgit.lib.ConfigConstants.CONFIG_KEY_ALGORITHM;
21  import static org.eclipse.jgit.lib.Constants.OBJ_BLOB;
22  
23  import java.io.BufferedOutputStream;
24  import java.io.File;
25  import java.io.FileNotFoundException;
26  import java.io.FileOutputStream;
27  import java.io.IOException;
28  import java.io.InputStream;
29  import java.io.OutputStream;
30  import java.time.Instant;
31  import java.util.ArrayList;
32  import java.util.Arrays;
33  import java.util.Collections;
34  import java.util.HashMap;
35  import java.util.Iterator;
36  import java.util.LinkedList;
37  import java.util.List;
38  import java.util.Map;
39  
40  import org.eclipse.jgit.attributes.Attributes;
41  import org.eclipse.jgit.diff.DiffAlgorithm;
42  import org.eclipse.jgit.diff.DiffAlgorithm.SupportedAlgorithm;
43  import org.eclipse.jgit.diff.RawText;
44  import org.eclipse.jgit.diff.RawTextComparator;
45  import org.eclipse.jgit.diff.Sequence;
46  import org.eclipse.jgit.dircache.DirCache;
47  import org.eclipse.jgit.dircache.DirCacheBuildIterator;
48  import org.eclipse.jgit.dircache.DirCacheBuilder;
49  import org.eclipse.jgit.dircache.DirCacheCheckout;
50  import org.eclipse.jgit.dircache.DirCacheCheckout.CheckoutMetadata;
51  import org.eclipse.jgit.dircache.DirCacheEntry;
52  import org.eclipse.jgit.errors.BinaryBlobException;
53  import org.eclipse.jgit.errors.CorruptObjectException;
54  import org.eclipse.jgit.errors.IncorrectObjectTypeException;
55  import org.eclipse.jgit.errors.IndexWriteException;
56  import org.eclipse.jgit.errors.MissingObjectException;
57  import org.eclipse.jgit.errors.NoWorkTreeException;
58  import org.eclipse.jgit.lib.Config;
59  import org.eclipse.jgit.lib.ConfigConstants;
60  import org.eclipse.jgit.lib.Constants;
61  import org.eclipse.jgit.lib.CoreConfig.EolStreamType;
62  import org.eclipse.jgit.lib.FileMode;
63  import org.eclipse.jgit.lib.ObjectId;
64  import org.eclipse.jgit.lib.ObjectInserter;
65  import org.eclipse.jgit.lib.ObjectLoader;
66  import org.eclipse.jgit.lib.Repository;
67  import org.eclipse.jgit.revwalk.RevTree;
68  import org.eclipse.jgit.storage.pack.PackConfig;
69  import org.eclipse.jgit.submodule.SubmoduleConflict;
70  import org.eclipse.jgit.treewalk.AbstractTreeIterator;
71  import org.eclipse.jgit.treewalk.CanonicalTreeParser;
72  import org.eclipse.jgit.treewalk.NameConflictTreeWalk;
73  import org.eclipse.jgit.treewalk.TreeWalk;
74  import org.eclipse.jgit.treewalk.TreeWalk.OperationType;
75  import org.eclipse.jgit.treewalk.WorkingTreeIterator;
76  import org.eclipse.jgit.treewalk.WorkingTreeOptions;
77  import org.eclipse.jgit.treewalk.filter.TreeFilter;
78  import org.eclipse.jgit.util.FS;
79  import org.eclipse.jgit.util.LfsFactory;
80  import org.eclipse.jgit.util.LfsFactory.LfsInputStream;
81  import org.eclipse.jgit.util.TemporaryBuffer;
82  import org.eclipse.jgit.util.io.EolStreamTypeUtil;
83  
84  /**
85   * A three-way merger performing a content-merge if necessary
86   */
87  public class ResolveMerger extends ThreeWayMerger {
88  	/**
89  	 * If the merge fails (means: not stopped because of unresolved conflicts)
90  	 * this enum is used to explain why it failed
91  	 */
92  	public enum MergeFailureReason {
93  		/** the merge failed because of a dirty index */
94  		DIRTY_INDEX,
95  		/** the merge failed because of a dirty workingtree */
96  		DIRTY_WORKTREE,
97  		/** the merge failed because of a file could not be deleted */
98  		COULD_NOT_DELETE
99  	}
100 
101 	/**
102 	 * The tree walk which we'll iterate over to merge entries.
103 	 *
104 	 * @since 3.4
105 	 */
106 	protected NameConflictTreeWalk tw;
107 
108 	/**
109 	 * string versions of a list of commit SHA1s
110 	 *
111 	 * @since 3.0
112 	 */
113 	protected String[] commitNames;
114 
115 	/**
116 	 * Index of the base tree within the {@link #tw tree walk}.
117 	 *
118 	 * @since 3.4
119 	 */
120 	protected static final int T_BASE = 0;
121 
122 	/**
123 	 * Index of our tree in withthe {@link #tw tree walk}.
124 	 *
125 	 * @since 3.4
126 	 */
127 	protected static final int T_OURS = 1;
128 
129 	/**
130 	 * Index of their tree within the {@link #tw tree walk}.
131 	 *
132 	 * @since 3.4
133 	 */
134 	protected static final int T_THEIRS = 2;
135 
136 	/**
137 	 * Index of the index tree within the {@link #tw tree walk}.
138 	 *
139 	 * @since 3.4
140 	 */
141 	protected static final int T_INDEX = 3;
142 
143 	/**
144 	 * Index of the working directory tree within the {@link #tw tree walk}.
145 	 *
146 	 * @since 3.4
147 	 */
148 	protected static final int T_FILE = 4;
149 
150 	/**
151 	 * Builder to update the cache during this merge.
152 	 *
153 	 * @since 3.4
154 	 */
155 	protected DirCacheBuilder builder;
156 
157 	/**
158 	 * merge result as tree
159 	 *
160 	 * @since 3.0
161 	 */
162 	protected ObjectId resultTree;
163 
164 	/**
165 	 * Paths that could not be merged by this merger because of an unsolvable
166 	 * conflict.
167 	 *
168 	 * @since 3.4
169 	 */
170 	protected List<String> unmergedPaths = new ArrayList<>();
171 
172 	/**
173 	 * Files modified during this merge operation.
174 	 *
175 	 * @since 3.4
176 	 */
177 	protected List<String> modifiedFiles = new LinkedList<>();
178 
179 	/**
180 	 * If the merger has nothing to do for a file but check it out at the end of
181 	 * the operation, it can be added here.
182 	 *
183 	 * @since 3.4
184 	 */
185 	protected Map<String, DirCacheEntry> toBeCheckedOut = new HashMap<>();
186 
187 	/**
188 	 * Paths in this list will be deleted from the local copy at the end of the
189 	 * operation.
190 	 *
191 	 * @since 3.4
192 	 */
193 	protected List<String> toBeDeleted = new ArrayList<>();
194 
195 	/**
196 	 * Low-level textual merge results. Will be passed on to the callers in case
197 	 * of conflicts.
198 	 *
199 	 * @since 3.4
200 	 */
201 	protected Map<String, MergeResult<? extends Sequence>> mergeResults = new HashMap<>();
202 
203 	/**
204 	 * Paths for which the merge failed altogether.
205 	 *
206 	 * @since 3.4
207 	 */
208 	protected Map<String, MergeFailureReason> failingPaths = new HashMap<>();
209 
210 	/**
211 	 * Updated as we merge entries of the tree walk. Tells us whether we should
212 	 * recurse into the entry if it is a subtree.
213 	 *
214 	 * @since 3.4
215 	 */
216 	protected boolean enterSubtree;
217 
218 	/**
219 	 * Set to true if this merge should work in-memory. The repos dircache and
220 	 * workingtree are not touched by this method. Eventually needed files are
221 	 * created as temporary files and a new empty, in-memory dircache will be
222 	 * used instead the repo's one. Often used for bare repos where the repo
223 	 * doesn't even have a workingtree and dircache.
224 	 * @since 3.0
225 	 */
226 	protected boolean inCore;
227 
228 	/**
229 	 * Set to true if this merger should use the default dircache of the
230 	 * repository and should handle locking and unlocking of the dircache. If
231 	 * this merger should work in-core or if an explicit dircache was specified
232 	 * during construction then this field is set to false.
233 	 * @since 3.0
234 	 */
235 	protected boolean implicitDirCache;
236 
237 	/**
238 	 * Directory cache
239 	 * @since 3.0
240 	 */
241 	protected DirCache dircache;
242 
243 	/**
244 	 * The iterator to access the working tree. If set to <code>null</code> this
245 	 * merger will not touch the working tree.
246 	 * @since 3.0
247 	 */
248 	protected WorkingTreeIterator workingTreeIterator;
249 
250 	/**
251 	 * our merge algorithm
252 	 * @since 3.0
253 	 */
254 	protected MergeAlgorithm mergeAlgorithm;
255 
256 	/**
257 	 * The {@link WorkingTreeOptions} are needed to determine line endings for
258 	 * merged files.
259 	 *
260 	 * @since 4.11
261 	 */
262 	protected WorkingTreeOptions workingTreeOptions;
263 
264 	/**
265 	 * The size limit (bytes) which controls a file to be stored in {@code Heap}
266 	 * or {@code LocalFile} during the merge.
267 	 */
268 	private int inCoreLimit;
269 
270 	/**
271 	 * Keeps {@link CheckoutMetadata} for {@link #checkout()} and
272 	 * {@link #cleanUp()}.
273 	 */
274 	private Map<String, CheckoutMetadata> checkoutMetadata;
275 
276 	private static MergeAlgorithm getMergeAlgorithm(Config config) {
277 		SupportedAlgorithm diffAlg = config.getEnum(
278 				CONFIG_DIFF_SECTION, null, CONFIG_KEY_ALGORITHM,
279 				HISTOGRAM);
280 		return new MergeAlgorithm(DiffAlgorithm.getAlgorithm(diffAlg));
281 	}
282 
283 	private static int getInCoreLimit(Config config) {
284 		return config.getInt(
285 				ConfigConstants.CONFIG_MERGE_SECTION, ConfigConstants.CONFIG_KEY_IN_CORE_LIMIT, 10 << 20);
286 	}
287 
288 	private static String[] defaultCommitNames() {
289 		return new String[] { "BASE", "OURS", "THEIRS" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
290 	}
291 
292 	private static final Attributess">Attributes NO_ATTRIBUTES = new Attributes();
293 
294 	/**
295 	 * Constructor for ResolveMerger.
296 	 *
297 	 * @param local
298 	 *            the {@link org.eclipse.jgit.lib.Repository}.
299 	 * @param inCore
300 	 *            a boolean.
301 	 */
302 	protected ResolveMerger(Repository local, boolean inCore) {
303 		super(local);
304 		Config config = local.getConfig();
305 		mergeAlgorithm = getMergeAlgorithm(config);
306 		inCoreLimit = getInCoreLimit(config);
307 		commitNames = defaultCommitNames();
308 		this.inCore = inCore;
309 
310 		if (inCore) {
311 			implicitDirCache = false;
312 			dircache = DirCache.newInCore();
313 		} else {
314 			implicitDirCache = true;
315 			workingTreeOptions = local.getConfig().get(WorkingTreeOptions.KEY);
316 		}
317 	}
318 
319 	/**
320 	 * Constructor for ResolveMerger.
321 	 *
322 	 * @param local
323 	 *            the {@link org.eclipse.jgit.lib.Repository}.
324 	 */
325 	protected ResolveMerger(Repository local) {
326 		this(local, false);
327 	}
328 
329 	/**
330 	 * Constructor for ResolveMerger.
331 	 *
332 	 * @param inserter
333 	 *            an {@link org.eclipse.jgit.lib.ObjectInserter} object.
334 	 * @param config
335 	 *            the repository configuration
336 	 * @since 4.8
337 	 */
338 	protected ResolveMerger(ObjectInserter inserter, Config config) {
339 		super(inserter);
340 		mergeAlgorithm = getMergeAlgorithm(config);
341 		commitNames = defaultCommitNames();
342 		inCore = true;
343 		implicitDirCache = false;
344 		dircache = DirCache.newInCore();
345 	}
346 
347 	/** {@inheritDoc} */
348 	@Override
349 	protected boolean mergeImpl() throws IOException {
350 		if (implicitDirCache) {
351 			dircache = nonNullRepo().lockDirCache();
352 		}
353 		if (!inCore) {
354 			checkoutMetadata = new HashMap<>();
355 		}
356 		try {
357 			return mergeTrees(mergeBase(), sourceTrees[0], sourceTrees[1],
358 					false);
359 		} finally {
360 			checkoutMetadata = null;
361 			if (implicitDirCache) {
362 				dircache.unlock();
363 			}
364 		}
365 	}
366 
367 	private void checkout() throws NoWorkTreeException, IOException {
368 		// Iterate in reverse so that "folder/file" is deleted before
369 		// "folder". Otherwise this could result in a failing path because
370 		// of a non-empty directory, for which delete() would fail.
371 		for (int i = toBeDeleted.size() - 1; i >= 0; i--) {
372 			String fileName = toBeDeleted.get(i);
373 			File f = new File(nonNullRepo().getWorkTree(), fileName);
374 			if (!f.delete())
375 				if (!f.isDirectory())
376 					failingPaths.put(fileName,
377 							MergeFailureReason.COULD_NOT_DELETE);
378 			modifiedFiles.add(fileName);
379 		}
380 		for (Map.Entry<String, DirCacheEntry> entry : toBeCheckedOut
381 				.entrySet()) {
382 			DirCacheEntry cacheEntry = entry.getValue();
383 			if (cacheEntry.getFileMode() == FileMode.GITLINK) {
384 				new File(nonNullRepo().getWorkTree(), entry.getKey()).mkdirs();
385 			} else {
386 				DirCacheCheckout.checkoutEntry(db, cacheEntry, reader, false,
387 						checkoutMetadata.get(entry.getKey()));
388 				modifiedFiles.add(entry.getKey());
389 			}
390 		}
391 	}
392 
393 	/**
394 	 * Reverts the worktree after an unsuccessful merge. We know that for all
395 	 * modified files the old content was in the old index and the index
396 	 * contained only stage 0. In case if inCore operation just clear the
397 	 * history of modified files.
398 	 *
399 	 * @throws java.io.IOException
400 	 * @throws org.eclipse.jgit.errors.CorruptObjectException
401 	 * @throws org.eclipse.jgit.errors.NoWorkTreeException
402 	 * @since 3.4
403 	 */
404 	protected void cleanUp() throws NoWorkTreeException,
405 			CorruptObjectException,
406 			IOException {
407 		if (inCore) {
408 			modifiedFiles.clear();
409 			return;
410 		}
411 
412 		DirCache dc = nonNullRepo().readDirCache();
413 		Iterator<String> mpathsIt=modifiedFiles.iterator();
414 		while(mpathsIt.hasNext()) {
415 			String mpath = mpathsIt.next();
416 			DirCacheEntry entry = dc.getEntry(mpath);
417 			if (entry != null) {
418 				DirCacheCheckout.checkoutEntry(db, entry, reader, false,
419 						checkoutMetadata.get(mpath));
420 			}
421 			mpathsIt.remove();
422 		}
423 	}
424 
425 	/**
426 	 * adds a new path with the specified stage to the index builder
427 	 *
428 	 * @param path
429 	 * @param p
430 	 * @param stage
431 	 * @param lastMod
432 	 * @param len
433 	 * @return the entry which was added to the index
434 	 */
435 	private DirCacheEntry add(byte[] path, CanonicalTreeParser p, int stage,
436 			Instant lastMod, long len) {
437 		if (p != null && !p.getEntryFileMode().equals(FileMode.TREE)) {
438 			DirCacheEntry e = new DirCacheEntry(path, stage);
439 			e.setFileMode(p.getEntryFileMode());
440 			e.setObjectId(p.getEntryObjectId());
441 			e.setLastModified(lastMod);
442 			e.setLength(len);
443 			builder.add(e);
444 			return e;
445 		}
446 		return null;
447 	}
448 
449 	/**
450 	 * adds a entry to the index builder which is a copy of the specified
451 	 * DirCacheEntry
452 	 *
453 	 * @param e
454 	 *            the entry which should be copied
455 	 *
456 	 * @return the entry which was added to the index
457 	 */
458 	private DirCacheEntry/../../../org/eclipse/jgit/dircache/DirCacheEntry.html#DirCacheEntry">DirCacheEntry keep(DirCacheEntry e) {
459 		DirCacheEntry newEntry = new DirCacheEntry(e.getRawPath(),
460 				e.getStage());
461 		newEntry.setFileMode(e.getFileMode());
462 		newEntry.setObjectId(e.getObjectId());
463 		newEntry.setLastModified(e.getLastModifiedInstant());
464 		newEntry.setLength(e.getLength());
465 		builder.add(newEntry);
466 		return newEntry;
467 	}
468 
469 	/**
470 	 * Remembers the {@link CheckoutMetadata} for the given path; it may be
471 	 * needed in {@link #checkout()} or in {@link #cleanUp()}.
472 	 *
473 	 * @param path
474 	 *            of the current node
475 	 * @param attributes
476 	 *            for the current node
477 	 * @throws IOException
478 	 *             if the smudge filter cannot be determined
479 	 * @since 5.1
480 	 */
481 	protected void addCheckoutMetadata(String path, Attributes attributes)
482 			throws IOException {
483 		if (checkoutMetadata != null) {
484 			EolStreamType eol = EolStreamTypeUtil.detectStreamType(
485 					OperationType.CHECKOUT_OP, workingTreeOptions, attributes);
486 			CheckoutMetadata data = new CheckoutMetadata(eol,
487 					tw.getFilterCommand(Constants.ATTR_FILTER_TYPE_SMUDGE));
488 			checkoutMetadata.put(path, data);
489 		}
490 	}
491 
492 	/**
493 	 * Adds a {@link DirCacheEntry} for direct checkout and remembers its
494 	 * {@link CheckoutMetadata}.
495 	 *
496 	 * @param path
497 	 *            of the entry
498 	 * @param entry
499 	 *            to add
500 	 * @param attributes
501 	 *            for the current entry
502 	 * @throws IOException
503 	 *             if the {@link CheckoutMetadata} cannot be determined
504 	 * @since 5.1
505 	 */
506 	protected void addToCheckout(String path, DirCacheEntry entry,
507 			Attributes attributes) throws IOException {
508 		toBeCheckedOut.put(path, entry);
509 		addCheckoutMetadata(path, attributes);
510 	}
511 
512 	/**
513 	 * Remember a path for deletion, and remember its {@link CheckoutMetadata}
514 	 * in case it has to be restored in {@link #cleanUp()}.
515 	 *
516 	 * @param path
517 	 *            of the entry
518 	 * @param isFile
519 	 *            whether it is a file
520 	 * @param attributes
521 	 *            for the entry
522 	 * @throws IOException
523 	 *             if the {@link CheckoutMetadata} cannot be determined
524 	 * @since 5.1
525 	 */
526 	protected void addDeletion(String path, boolean isFile,
527 			Attributes attributes) throws IOException {
528 		toBeDeleted.add(path);
529 		if (isFile) {
530 			addCheckoutMetadata(path, attributes);
531 		}
532 	}
533 
534 	/**
535 	 * Processes one path and tries to merge taking git attributes in account.
536 	 * This method will do all trivial (not content) merges and will also detect
537 	 * if a merge will fail. The merge will fail when one of the following is
538 	 * true
539 	 * <ul>
540 	 * <li>the index entry does not match the entry in ours. When merging one
541 	 * branch into the current HEAD, ours will point to HEAD and theirs will
542 	 * point to the other branch. It is assumed that the index matches the HEAD
543 	 * because it will only not match HEAD if it was populated before the merge
544 	 * operation. But the merge commit should not accidentally contain
545 	 * modifications done before the merge. Check the <a href=
546 	 * "http://www.kernel.org/pub/software/scm/git/docs/git-read-tree.html#_3_way_merge"
547 	 * >git read-tree</a> documentation for further explanations.</li>
548 	 * <li>A conflict was detected and the working-tree file is dirty. When a
549 	 * conflict is detected the content-merge algorithm will try to write a
550 	 * merged version into the working-tree. If the file is dirty we would
551 	 * override unsaved data.</li>
552 	 * </ul>
553 	 *
554 	 * @param base
555 	 *            the common base for ours and theirs
556 	 * @param ours
557 	 *            the ours side of the merge. When merging a branch into the
558 	 *            HEAD ours will point to HEAD
559 	 * @param theirs
560 	 *            the theirs side of the merge. When merging a branch into the
561 	 *            current HEAD theirs will point to the branch which is merged
562 	 *            into HEAD.
563 	 * @param index
564 	 *            the index entry
565 	 * @param work
566 	 *            the file in the working tree
567 	 * @param ignoreConflicts
568 	 *            see
569 	 *            {@link org.eclipse.jgit.merge.ResolveMerger#mergeTrees(AbstractTreeIterator, RevTree, RevTree, boolean)}
570 	 * @param attributes
571 	 *            the attributes defined for this entry
572 	 * @return <code>false</code> if the merge will fail because the index entry
573 	 *         didn't match ours or the working-dir file was dirty and a
574 	 *         conflict occurred
575 	 * @throws org.eclipse.jgit.errors.MissingObjectException
576 	 * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
577 	 * @throws org.eclipse.jgit.errors.CorruptObjectException
578 	 * @throws java.io.IOException
579 	 * @since 4.9
580 	 */
581 	protected boolean processEntry(CanonicalTreeParser base,
582 			CanonicalTreeParser ours, CanonicalTreeParser theirs,
583 			DirCacheBuildIterator index, WorkingTreeIterator work,
584 			boolean ignoreConflicts, Attributes attributes)
585 			throws MissingObjectException, IncorrectObjectTypeException,
586 			CorruptObjectException, IOException {
587 		enterSubtree = true;
588 		final int modeO = tw.getRawMode(T_OURS);
589 		final int modeT = tw.getRawMode(T_THEIRS);
590 		final int modeB = tw.getRawMode(T_BASE);
591 		boolean gitLinkMerging = isGitLink(modeO) || isGitLink(modeT)
592 				|| isGitLink(modeB);
593 		if (modeO == 0 && modeT == 0 && modeB == 0)
594 			// File is either untracked or new, staged but uncommitted
595 			return true;
596 
597 		if (isIndexDirty())
598 			return false;
599 
600 		DirCacheEntry ourDce = null;
601 
602 		if (index == null || index.getDirCacheEntry() == null) {
603 			// create a fake DCE, but only if ours is valid. ours is kept only
604 			// in case it is valid, so a null ourDce is ok in all other cases.
605 			if (nonTree(modeO)) {
606 				ourDce = new DirCacheEntry(tw.getRawPath());
607 				ourDce.setObjectId(tw.getObjectId(T_OURS));
608 				ourDce.setFileMode(tw.getFileMode(T_OURS));
609 			}
610 		} else {
611 			ourDce = index.getDirCacheEntry();
612 		}
613 
614 		if (nonTree(modeO) && nonTree(modeT) && tw.idEqual(T_OURS, T_THEIRS)) {
615 			// OURS and THEIRS have equal content. Check the file mode
616 			if (modeO == modeT) {
617 				// content and mode of OURS and THEIRS are equal: it doesn't
618 				// matter which one we choose. OURS is chosen. Since the index
619 				// is clean (the index matches already OURS) we can keep the existing one
620 				keep(ourDce);
621 				// no checkout needed!
622 				return true;
623 			}
624 			// same content but different mode on OURS and THEIRS.
625 			// Try to merge the mode and report an error if this is
626 			// not possible.
627 			int newMode = mergeFileModes(modeB, modeO, modeT);
628 			if (newMode != FileMode.MISSING.getBits()) {
629 				if (newMode == modeO) {
630 					// ours version is preferred
631 					keep(ourDce);
632 				} else {
633 					// the preferred version THEIRS has a different mode
634 					// than ours. Check it out!
635 					if (isWorktreeDirty(work, ourDce)) {
636 						return false;
637 					}
638 					// we know about length and lastMod only after we have
639 					// written the new content.
640 					// This will happen later. Set these values to 0 for know.
641 					DirCacheEntry e = add(tw.getRawPath(), theirs,
642 							DirCacheEntry.STAGE_0, EPOCH, 0);
643 					addToCheckout(tw.getPathString(), e, attributes);
644 				}
645 				return true;
646 			}
647 			// FileModes are not mergeable. We found a conflict on modes.
648 			// For conflicting entries we don't know lastModified and
649 			// length.
650 			add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
651 			add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
652 			add(tw.getRawPath(), theirs, DirCacheEntry.STAGE_3, EPOCH, 0);
653 			unmergedPaths.add(tw.getPathString());
654 			mergeResults.put(tw.getPathString(),
655 					new MergeResult<>(Collections.<RawText> emptyList()));
656 			return true;
657 		}
658 
659 		if (modeB == modeT && tw.idEqual(T_BASE, T_THEIRS)) {
660 			// THEIRS was not changed compared to BASE. All changes must be in
661 			// OURS. OURS is chosen. We can keep the existing entry.
662 			if (ourDce != null)
663 				keep(ourDce);
664 			// no checkout needed!
665 			return true;
666 		}
667 
668 		if (modeB == modeO && tw.idEqual(T_BASE, T_OURS)) {
669 			// OURS was not changed compared to BASE. All changes must be in
670 			// THEIRS. THEIRS is chosen.
671 
672 			// Check worktree before checking out THEIRS
673 			if (isWorktreeDirty(work, ourDce))
674 				return false;
675 			if (nonTree(modeT)) {
676 				// we know about length and lastMod only after we have written
677 				// the new content.
678 				// This will happen later. Set these values to 0 for know.
679 				DirCacheEntry e = add(tw.getRawPath(), theirs,
680 						DirCacheEntry.STAGE_0, EPOCH, 0);
681 				if (e != null) {
682 					addToCheckout(tw.getPathString(), e, attributes);
683 				}
684 				return true;
685 			}
686 			// we want THEIRS ... but THEIRS contains a folder or the
687 			// deletion of the path. Delete what's in the working tree,
688 			// which we know to be clean.
689 			if (tw.getTreeCount() > T_FILE && tw.getRawMode(T_FILE) == 0) {
690 				// Not present in working tree, so nothing to delete
691 				return true;
692 			}
693 			if (modeT != 0 && modeT == modeB) {
694 				// Base, ours, and theirs all contain a folder: don't delete
695 				return true;
696 			}
697 			addDeletion(tw.getPathString(), nonTree(modeO), attributes);
698 			return true;
699 		}
700 
701 		if (tw.isSubtree()) {
702 			// file/folder conflicts: here I want to detect only file/folder
703 			// conflict between ours and theirs. file/folder conflicts between
704 			// base/index/workingTree and something else are not relevant or
705 			// detected later
706 			if (nonTree(modeO) && !nonTree(modeT)) {
707 				if (nonTree(modeB))
708 					add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
709 				add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
710 				unmergedPaths.add(tw.getPathString());
711 				enterSubtree = false;
712 				return true;
713 			}
714 			if (nonTree(modeT) && !nonTree(modeO)) {
715 				if (nonTree(modeB))
716 					add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
717 				add(tw.getRawPath(), theirs, DirCacheEntry.STAGE_3, EPOCH, 0);
718 				unmergedPaths.add(tw.getPathString());
719 				enterSubtree = false;
720 				return true;
721 			}
722 
723 			// ours and theirs are both folders or both files (and treewalk
724 			// tells us we are in a subtree because of index or working-dir).
725 			// If they are both folders no content-merge is required - we can
726 			// return here.
727 			if (!nonTree(modeO))
728 				return true;
729 
730 			// ours and theirs are both files, just fall out of the if block
731 			// and do the content merge
732 		}
733 
734 		if (nonTree(modeO) && nonTree(modeT)) {
735 			// Check worktree before modifying files
736 			boolean worktreeDirty = isWorktreeDirty(work, ourDce);
737 			if (!attributes.canBeContentMerged() && worktreeDirty) {
738 				return false;
739 			}
740 
741 			if (gitLinkMerging && ignoreConflicts) {
742 				// Always select 'ours' in case of GITLINK merge failures so
743 				// a caller can use virtual commit.
744 				add(tw.getRawPath(), ours, DirCacheEntry.STAGE_0, EPOCH, 0);
745 				return true;
746 			} else if (gitLinkMerging) {
747 				add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
748 				add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
749 				add(tw.getRawPath(), theirs, DirCacheEntry.STAGE_3, EPOCH, 0);
750 				MergeResult<SubmoduleConflict> result = createGitLinksMergeResult(
751 						base, ours, theirs);
752 				result.setContainsConflicts(true);
753 				mergeResults.put(tw.getPathString(), result);
754 				unmergedPaths.add(tw.getPathString());
755 				return true;
756 			} else if (!attributes.canBeContentMerged()) {
757 				add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
758 				add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
759 				add(tw.getRawPath(), theirs, DirCacheEntry.STAGE_3, EPOCH, 0);
760 
761 				// attribute merge issues are conflicts but not failures
762 				unmergedPaths.add(tw.getPathString());
763 				return true;
764 			}
765 
766 			// Check worktree before modifying files
767 			if (worktreeDirty) {
768 				return false;
769 			}
770 
771 			MergeResult<RawText> result = contentMerge(base, ours, theirs,
772 					attributes);
773 			if (ignoreConflicts) {
774 				result.setContainsConflicts(false);
775 			}
776 			updateIndex(base, ours, theirs, result, attributes);
777 			String currentPath = tw.getPathString();
778 			if (result.containsConflicts() && !ignoreConflicts) {
779 				unmergedPaths.add(currentPath);
780 			}
781 			modifiedFiles.add(currentPath);
782 			addCheckoutMetadata(currentPath, attributes);
783 		} else if (modeO != modeT) {
784 			// OURS or THEIRS has been deleted
785 			if (((modeO != 0 && !tw.idEqual(T_BASE, T_OURS)) || (modeT != 0 && !tw
786 					.idEqual(T_BASE, T_THEIRS)))) {
787 				if (gitLinkMerging && ignoreConflicts) {
788 					add(tw.getRawPath(), ours, DirCacheEntry.STAGE_0, EPOCH, 0);
789 				} else if (gitLinkMerging) {
790 					add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
791 					add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
792 					add(tw.getRawPath(), theirs, DirCacheEntry.STAGE_3, EPOCH, 0);
793 					MergeResult<SubmoduleConflict> result = createGitLinksMergeResult(
794 							base, ours, theirs);
795 					result.setContainsConflicts(true);
796 					mergeResults.put(tw.getPathString(), result);
797 					unmergedPaths.add(tw.getPathString());
798 				} else {
799 					MergeResult<RawText> result = contentMerge(base, ours,
800 							theirs, attributes);
801 
802 					if (ignoreConflicts) {
803 						// In case a conflict is detected the working tree file
804 						// is again filled with new content (containing conflict
805 						// markers). But also stage 0 of the index is filled
806 						// with that content.
807 						result.setContainsConflicts(false);
808 						updateIndex(base, ours, theirs, result, attributes);
809 					} else {
810 						add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH,
811 								0);
812 						add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH,
813 								0);
814 						DirCacheEntry e = add(tw.getRawPath(), theirs,
815 								DirCacheEntry.STAGE_3, EPOCH, 0);
816 
817 						// OURS was deleted checkout THEIRS
818 						if (modeO == 0) {
819 							// Check worktree before checking out THEIRS
820 							if (isWorktreeDirty(work, ourDce)) {
821 								return false;
822 							}
823 							if (nonTree(modeT)) {
824 								if (e != null) {
825 									addToCheckout(tw.getPathString(), e,
826 											attributes);
827 								}
828 							}
829 						}
830 
831 						unmergedPaths.add(tw.getPathString());
832 
833 						// generate a MergeResult for the deleted file
834 						mergeResults.put(tw.getPathString(), result);
835 					}
836 				}
837 			}
838 		}
839 		return true;
840 	}
841 
842 	private static MergeResult<SubmoduleConflict> createGitLinksMergeResult(
843 			CanonicalTreeParser base, CanonicalTreeParser ours,
844 			CanonicalTreeParser theirs) {
845 		return new MergeResult<>(Arrays.asList(
846 				new SubmoduleConflict(
847 						base == null ? null : base.getEntryObjectId()),
848 				new SubmoduleConflict(
849 						ours == null ? null : ours.getEntryObjectId()),
850 				new SubmoduleConflict(
851 						theirs == null ? null : theirs.getEntryObjectId())));
852 	}
853 
854 	/**
855 	 * Does the content merge. The three texts base, ours and theirs are
856 	 * specified with {@link CanonicalTreeParser}. If any of the parsers is
857 	 * specified as <code>null</code> then an empty text will be used instead.
858 	 *
859 	 * @param base
860 	 * @param ours
861 	 * @param theirs
862 	 * @param attributes
863 	 *
864 	 * @return the result of the content merge
865 	 * @throws IOException
866 	 */
867 	private MergeResult<RawText> contentMerge(CanonicalTreeParser base,
868 			CanonicalTreeParser ours, CanonicalTreeParser theirs,
869 			Attributes attributes)
870 			throws IOException {
871 		RawText baseText;
872 		RawText ourText;
873 		RawText theirsText;
874 
875 		try {
876 			baseText = base == null ? RawText.EMPTY_TEXT : getRawText(
877 							base.getEntryObjectId(), attributes);
878 			ourText = ours == null ? RawText.EMPTY_TEXT : getRawText(
879 							ours.getEntryObjectId(), attributes);
880 			theirsText = theirs == null ? RawText.EMPTY_TEXT : getRawText(
881 							theirs.getEntryObjectId(), attributes);
882 		} catch (BinaryBlobException e) {
883 			MergeResult<RawText> r = new MergeResult<>(Collections.<RawText>emptyList());
884 			r.setContainsConflicts(true);
885 			return r;
886 		}
887 		return (mergeAlgorithm.merge(RawTextComparator.DEFAULT, baseText,
888 				ourText, theirsText));
889 	}
890 
891 	private boolean isIndexDirty() {
892 		if (inCore)
893 			return false;
894 
895 		final int modeI = tw.getRawMode(T_INDEX);
896 		final int modeO = tw.getRawMode(T_OURS);
897 
898 		// Index entry has to match ours to be considered clean
899 		final boolean isDirty = nonTree(modeI)
900 				&& !(modeO == modeI && tw.idEqual(T_INDEX, T_OURS));
901 		if (isDirty)
902 			failingPaths
903 					.put(tw.getPathString(), MergeFailureReason.DIRTY_INDEX);
904 		return isDirty;
905 	}
906 
907 	private boolean isWorktreeDirty(WorkingTreeIterator work,
908 			DirCacheEntry ourDce) throws IOException {
909 		if (work == null)
910 			return false;
911 
912 		final int modeF = tw.getRawMode(T_FILE);
913 		final int modeO = tw.getRawMode(T_OURS);
914 
915 		// Worktree entry has to match ours to be considered clean
916 		boolean isDirty;
917 		if (ourDce != null)
918 			isDirty = work.isModified(ourDce, true, reader);
919 		else {
920 			isDirty = work.isModeDifferent(modeO);
921 			if (!isDirty && nonTree(modeF))
922 				isDirty = !tw.idEqual(T_FILE, T_OURS);
923 		}
924 
925 		// Ignore existing empty directories
926 		if (isDirty && modeF == FileMode.TYPE_TREE
927 				&& modeO == FileMode.TYPE_MISSING)
928 			isDirty = false;
929 		if (isDirty)
930 			failingPaths.put(tw.getPathString(),
931 					MergeFailureReason.DIRTY_WORKTREE);
932 		return isDirty;
933 	}
934 
935 	/**
936 	 * Updates the index after a content merge has happened. If no conflict has
937 	 * occurred this includes persisting the merged content to the object
938 	 * database. In case of conflicts this method takes care to write the
939 	 * correct stages to the index.
940 	 *
941 	 * @param base
942 	 * @param ours
943 	 * @param theirs
944 	 * @param result
945 	 * @param attributes
946 	 * @throws FileNotFoundException
947 	 * @throws IOException
948 	 */
949 	private void updateIndex(CanonicalTreeParser base,
950 			CanonicalTreeParser ours, CanonicalTreeParser theirs,
951 			MergeResult<RawText> result, Attributes attributes)
952 			throws FileNotFoundException,
953 			IOException {
954 		TemporaryBuffer rawMerged = null;
955 		try {
956 			rawMerged = doMerge(result);
957 			File mergedFile = inCore ? null
958 					: writeMergedFile(rawMerged, attributes);
959 			if (result.containsConflicts()) {
960 				// A conflict occurred, the file will contain conflict markers
961 				// the index will be populated with the three stages and the
962 				// workdir (if used) contains the halfway merged content.
963 				add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
964 				add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
965 				add(tw.getRawPath(), theirs, DirCacheEntry.STAGE_3, EPOCH, 0);
966 				mergeResults.put(tw.getPathString(), result);
967 				return;
968 			}
969 
970 			// No conflict occurred, the file will contain fully merged content.
971 			// The index will be populated with the new merged version.
972 			DirCacheEntry dce = new DirCacheEntry(tw.getPathString());
973 
974 			// Set the mode for the new content. Fall back to REGULAR_FILE if
975 			// we can't merge modes of OURS and THEIRS.
976 			int newMode = mergeFileModes(tw.getRawMode(0), tw.getRawMode(1),
977 					tw.getRawMode(2));
978 			dce.setFileMode(newMode == FileMode.MISSING.getBits()
979 					? FileMode.REGULAR_FILE : FileMode.fromBits(newMode));
980 			if (mergedFile != null) {
981 				dce.setLastModified(
982 						nonNullRepo().getFS().lastModifiedInstant(mergedFile));
983 				dce.setLength((int) mergedFile.length());
984 			}
985 			dce.setObjectId(insertMergeResult(rawMerged, attributes));
986 			builder.add(dce);
987 		} finally {
988 			if (rawMerged != null) {
989 				rawMerged.destroy();
990 			}
991 		}
992 	}
993 
994 	/**
995 	 * Writes merged file content to the working tree.
996 	 *
997 	 * @param rawMerged
998 	 *            the raw merged content
999 	 * @param attributes
1000 	 *            the files .gitattributes entries
1001 	 * @return the working tree file to which the merged content was written.
1002 	 * @throws FileNotFoundException
1003 	 * @throws IOException
1004 	 */
1005 	private File writeMergedFile(TemporaryBuffer rawMerged,
1006 			Attributes attributes)
1007 			throws FileNotFoundException, IOException {
1008 		File workTree = nonNullRepo().getWorkTree();
1009 		FS fs = nonNullRepo().getFS();
1010 		File of = new File(workTree, tw.getPathString());
1011 		File parentFolder = of.getParentFile();
1012 		if (!fs.exists(parentFolder)) {
1013 			parentFolder.mkdirs();
1014 		}
1015 		EolStreamType streamType = EolStreamTypeUtil.detectStreamType(
1016 				OperationType.CHECKOUT_OP, workingTreeOptions,
1017 				attributes);
1018 		try (OutputStream os = EolStreamTypeUtil.wrapOutputStream(
1019 				new BufferedOutputStream(new FileOutputStream(of)),
1020 				streamType)) {
1021 			rawMerged.writeTo(os, null);
1022 		}
1023 		return of;
1024 	}
1025 
1026 	private TemporaryBuffer doMerge(MergeResult<RawText> result)
1027 			throws IOException {
1028 		TemporaryBuffer.LocalFile buf = new TemporaryBuffer.LocalFile(
1029 				db != null ? nonNullRepo().getDirectory() : null, inCoreLimit);
1030 		boolean success = false;
1031 		try {
1032 			new MergeFormatter().formatMerge(buf, result,
1033 					Arrays.asList(commitNames), UTF_8);
1034 			buf.close();
1035 			success = true;
1036 		} finally {
1037 			if (!success) {
1038 				buf.destroy();
1039 			}
1040 		}
1041 		return buf;
1042 	}
1043 
1044 	private ObjectId insertMergeResult(TemporaryBuffer buf,
1045 			Attributes attributes) throws IOException {
1046 		InputStream in = buf.openInputStream();
1047 		try (LfsInputStream is = LfsFactory.getInstance().applyCleanFilter(
1048 				getRepository(), in,
1049 				buf.length(), attributes.get(Constants.ATTR_MERGE))) {
1050 			return getObjectInserter().insert(OBJ_BLOB, is.getLength(), is);
1051 		}
1052 	}
1053 
1054 	/**
1055 	 * Try to merge filemodes. If only ours or theirs have changed the mode
1056 	 * (compared to base) we choose that one. If ours and theirs have equal
1057 	 * modes return that one. If also that is not the case the modes are not
1058 	 * mergeable. Return {@link FileMode#MISSING} int that case.
1059 	 *
1060 	 * @param modeB
1061 	 *            filemode found in BASE
1062 	 * @param modeO
1063 	 *            filemode found in OURS
1064 	 * @param modeT
1065 	 *            filemode found in THEIRS
1066 	 *
1067 	 * @return the merged filemode or {@link FileMode#MISSING} in case of a
1068 	 *         conflict
1069 	 */
1070 	private int mergeFileModes(int modeB, int modeO, int modeT) {
1071 		if (modeO == modeT)
1072 			return modeO;
1073 		if (modeB == modeO)
1074 			// Base equal to Ours -> chooses Theirs if that is not missing
1075 			return (modeT == FileMode.MISSING.getBits()) ? modeO : modeT;
1076 		if (modeB == modeT)
1077 			// Base equal to Theirs -> chooses Ours if that is not missing
1078 			return (modeO == FileMode.MISSING.getBits()) ? modeT : modeO;
1079 		return FileMode.MISSING.getBits();
1080 	}
1081 
1082 	private RawText getRawText(ObjectId id,
1083 			Attributes attributes)
1084 			throws IOException, BinaryBlobException {
1085 		if (id.equals(ObjectId.zeroId()))
1086 			return new RawText(new byte[] {});
1087 
1088 		ObjectLoader loader = LfsFactory.getInstance().applySmudgeFilter(
1089 				getRepository(), reader.open(id, OBJ_BLOB),
1090 				attributes.get(Constants.ATTR_MERGE));
1091 		int threshold = PackConfig.DEFAULT_BIG_FILE_THRESHOLD;
1092 		return RawText.load(loader, threshold);
1093 	}
1094 
1095 	private static boolean nonTree(int mode) {
1096 		return mode != 0 && !FileMode.TREE.equals(mode);
1097 	}
1098 
1099 	private static boolean isGitLink(int mode) {
1100 		return FileMode.GITLINK.equals(mode);
1101 	}
1102 
1103 	/** {@inheritDoc} */
1104 	@Override
1105 	public ObjectId getResultTreeId() {
1106 		return (resultTree == null) ? null : resultTree.toObjectId();
1107 	}
1108 
1109 	/**
1110 	 * Set the names of the commits as they would appear in conflict markers
1111 	 *
1112 	 * @param commitNames
1113 	 *            the names of the commits as they would appear in conflict
1114 	 *            markers
1115 	 */
1116 	public void setCommitNames(String[] commitNames) {
1117 		this.commitNames = commitNames;
1118 	}
1119 
1120 	/**
1121 	 * Get the names of the commits as they would appear in conflict markers.
1122 	 *
1123 	 * @return the names of the commits as they would appear in conflict
1124 	 *         markers.
1125 	 */
1126 	public String[] getCommitNames() {
1127 		return commitNames;
1128 	}
1129 
1130 	/**
1131 	 * Get the paths with conflicts. This is a subset of the files listed by
1132 	 * {@link #getModifiedFiles()}
1133 	 *
1134 	 * @return the paths with conflicts. This is a subset of the files listed by
1135 	 *         {@link #getModifiedFiles()}
1136 	 */
1137 	public List<String> getUnmergedPaths() {
1138 		return unmergedPaths;
1139 	}
1140 
1141 	/**
1142 	 * Get the paths of files which have been modified by this merge.
1143 	 *
1144 	 * @return the paths of files which have been modified by this merge. A file
1145 	 *         will be modified if a content-merge works on this path or if the
1146 	 *         merge algorithm decides to take the theirs-version. This is a
1147 	 *         superset of the files listed by {@link #getUnmergedPaths()}.
1148 	 */
1149 	public List<String> getModifiedFiles() {
1150 		return modifiedFiles;
1151 	}
1152 
1153 	/**
1154 	 * Get a map which maps the paths of files which have to be checked out
1155 	 * because the merge created new fully-merged content for this file into the
1156 	 * index.
1157 	 *
1158 	 * @return a map which maps the paths of files which have to be checked out
1159 	 *         because the merge created new fully-merged content for this file
1160 	 *         into the index. This means: the merge wrote a new stage 0 entry
1161 	 *         for this path.
1162 	 */
1163 	public Map<String, DirCacheEntry> getToBeCheckedOut() {
1164 		return toBeCheckedOut;
1165 	}
1166 
1167 	/**
1168 	 * Get the mergeResults
1169 	 *
1170 	 * @return the mergeResults
1171 	 */
1172 	public Map<String, MergeResult<? extends Sequence>> getMergeResults() {
1173 		return mergeResults;
1174 	}
1175 
1176 	/**
1177 	 * Get list of paths causing this merge to fail (not stopped because of a
1178 	 * conflict).
1179 	 *
1180 	 * @return lists paths causing this merge to fail (not stopped because of a
1181 	 *         conflict). <code>null</code> is returned if this merge didn't
1182 	 *         fail.
1183 	 */
1184 	public Map<String, MergeFailureReason> getFailingPaths() {
1185 		return failingPaths.isEmpty() ? null : failingPaths;
1186 	}
1187 
1188 	/**
1189 	 * Returns whether this merge failed (i.e. not stopped because of a
1190 	 * conflict)
1191 	 *
1192 	 * @return <code>true</code> if a failure occurred, <code>false</code>
1193 	 *         otherwise
1194 	 */
1195 	public boolean failed() {
1196 		return !failingPaths.isEmpty();
1197 	}
1198 
1199 	/**
1200 	 * Sets the DirCache which shall be used by this merger. If the DirCache is
1201 	 * not set explicitly and if this merger doesn't work in-core, this merger
1202 	 * will implicitly get and lock a default DirCache. If the DirCache is
1203 	 * explicitly set the caller is responsible to lock it in advance. Finally
1204 	 * the merger will call {@link org.eclipse.jgit.dircache.DirCache#commit()}
1205 	 * which requires that the DirCache is locked. If the {@link #mergeImpl()}
1206 	 * returns without throwing an exception the lock will be released. In case
1207 	 * of exceptions the caller is responsible to release the lock.
1208 	 *
1209 	 * @param dc
1210 	 *            the DirCache to set
1211 	 */
1212 	public void setDirCache(DirCache dc) {
1213 		this.dircache = dc;
1214 		implicitDirCache = false;
1215 	}
1216 
1217 	/**
1218 	 * Sets the WorkingTreeIterator to be used by this merger. If no
1219 	 * WorkingTreeIterator is set this merger will ignore the working tree and
1220 	 * fail if a content merge is necessary.
1221 	 * <p>
1222 	 * TODO: enhance WorkingTreeIterator to support write operations. Then this
1223 	 * merger will be able to merge with a different working tree abstraction.
1224 	 *
1225 	 * @param workingTreeIterator
1226 	 *            the workingTreeIt to set
1227 	 */
1228 	public void setWorkingTreeIterator(WorkingTreeIterator workingTreeIterator) {
1229 		this.workingTreeIterator = workingTreeIterator;
1230 	}
1231 
1232 
1233 	/**
1234 	 * The resolve conflict way of three way merging
1235 	 *
1236 	 * @param baseTree
1237 	 *            a {@link org.eclipse.jgit.treewalk.AbstractTreeIterator}
1238 	 *            object.
1239 	 * @param headTree
1240 	 *            a {@link org.eclipse.jgit.revwalk.RevTree} object.
1241 	 * @param mergeTree
1242 	 *            a {@link org.eclipse.jgit.revwalk.RevTree} object.
1243 	 * @param ignoreConflicts
1244 	 *            Controls what to do in case a content-merge is done and a
1245 	 *            conflict is detected. The default setting for this should be
1246 	 *            <code>false</code>. In this case the working tree file is
1247 	 *            filled with new content (containing conflict markers) and the
1248 	 *            index is filled with multiple stages containing BASE, OURS and
1249 	 *            THEIRS content. Having such non-0 stages is the sign to git
1250 	 *            tools that there are still conflicts for that path.
1251 	 *            <p>
1252 	 *            If <code>true</code> is specified the behavior is different.
1253 	 *            In case a conflict is detected the working tree file is again
1254 	 *            filled with new content (containing conflict markers). But
1255 	 *            also stage 0 of the index is filled with that content. No
1256 	 *            other stages are filled. Means: there is no conflict on that
1257 	 *            path but the new content (including conflict markers) is
1258 	 *            stored as successful merge result. This is needed in the
1259 	 *            context of {@link org.eclipse.jgit.merge.RecursiveMerger}
1260 	 *            where when determining merge bases we don't want to deal with
1261 	 *            content-merge conflicts.
1262 	 * @return whether the trees merged cleanly
1263 	 * @throws java.io.IOException
1264 	 * @since 3.5
1265 	 */
1266 	protected boolean mergeTrees(AbstractTreeIterator baseTree,
1267 			RevTree headTree, RevTree mergeTree, boolean ignoreConflicts)
1268 			throws IOException {
1269 
1270 		builder = dircache.builder();
1271 		DirCacheBuildIterator buildIt = new DirCacheBuildIterator(builder);
1272 
1273 		tw = new NameConflictTreeWalk(db, reader);
1274 		tw.addTree(baseTree);
1275 		tw.addTree(headTree);
1276 		tw.addTree(mergeTree);
1277 		int dciPos = tw.addTree(buildIt);
1278 		if (workingTreeIterator != null) {
1279 			tw.addTree(workingTreeIterator);
1280 			workingTreeIterator.setDirCacheIterator(tw, dciPos);
1281 		} else {
1282 			tw.setFilter(TreeFilter.ANY_DIFF);
1283 		}
1284 
1285 		if (!mergeTreeWalk(tw, ignoreConflicts)) {
1286 			return false;
1287 		}
1288 
1289 		if (!inCore) {
1290 			// No problem found. The only thing left to be done is to
1291 			// checkout all files from "theirs" which have been selected to
1292 			// go into the new index.
1293 			checkout();
1294 
1295 			// All content-merges are successfully done. If we can now write the
1296 			// new index we are on quite safe ground. Even if the checkout of
1297 			// files coming from "theirs" fails the user can work around such
1298 			// failures by checking out the index again.
1299 			if (!builder.commit()) {
1300 				cleanUp();
1301 				throw new IndexWriteException();
1302 			}
1303 			builder = null;
1304 
1305 		} else {
1306 			builder.finish();
1307 			builder = null;
1308 		}
1309 
1310 		if (getUnmergedPaths().isEmpty() && !failed()) {
1311 			resultTree = dircache.writeTree(getObjectInserter());
1312 			return true;
1313 		}
1314 		resultTree = null;
1315 		return false;
1316 	}
1317 
1318 	/**
1319 	 * Process the given TreeWalk's entries.
1320 	 *
1321 	 * @param treeWalk
1322 	 *            The walk to iterate over.
1323 	 * @param ignoreConflicts
1324 	 *            see
1325 	 *            {@link org.eclipse.jgit.merge.ResolveMerger#mergeTrees(AbstractTreeIterator, RevTree, RevTree, boolean)}
1326 	 * @return Whether the trees merged cleanly.
1327 	 * @throws java.io.IOException
1328 	 * @since 3.5
1329 	 */
1330 	protected boolean mergeTreeWalk(TreeWalk treeWalk, boolean ignoreConflicts)
1331 			throws IOException {
1332 		boolean hasWorkingTreeIterator = tw.getTreeCount() > T_FILE;
1333 		boolean hasAttributeNodeProvider = treeWalk
1334 				.getAttributesNodeProvider() != null;
1335 		while (treeWalk.next()) {
1336 			if (!processEntry(
1337 					treeWalk.getTree(T_BASE, CanonicalTreeParser.class),
1338 					treeWalk.getTree(T_OURS, CanonicalTreeParser.class),
1339 					treeWalk.getTree(T_THEIRS, CanonicalTreeParser.class),
1340 					treeWalk.getTree(T_INDEX, DirCacheBuildIterator.class),
1341 					hasWorkingTreeIterator ? treeWalk.getTree(T_FILE,
1342 							WorkingTreeIterator.class) : null,
1343 					ignoreConflicts, hasAttributeNodeProvider
1344 							? treeWalk.getAttributes()
1345 							: NO_ATTRIBUTES)) {
1346 				cleanUp();
1347 				return false;
1348 			}
1349 			if (treeWalk.isSubtree() && enterSubtree)
1350 				treeWalk.enterSubtree();
1351 		}
1352 		return true;
1353 	}
1354 }