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>
7    * and other copyright owners as documented in the project's IP log.
8    *
9    * This program and the accompanying materials are made available
10   * under the terms of the Eclipse Distribution License v1.0 which
11   * accompanies this distribution, is reproduced below, and is
12   * available at http://www.eclipse.org/org/documents/edl-v10.php
13   *
14   * All rights reserved.
15   *
16   * Redistribution and use in source and binary forms, with or
17   * without modification, are permitted provided that the following
18   * conditions are met:
19   *
20   * - Redistributions of source code must retain the above copyright
21   *   notice, this list of conditions and the following disclaimer.
22   *
23   * - Redistributions in binary form must reproduce the above
24   *   copyright notice, this list of conditions and the following
25   *   disclaimer in the documentation and/or other materials provided
26   *   with the distribution.
27   *
28   * - Neither the name of the Eclipse Foundation, Inc. nor the
29   *   names of its contributors may be used to endorse or promote
30   *   products derived from this software without specific prior
31   *   written permission.
32   *
33   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
34   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
35   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
38   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
40   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
41   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
42   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
43   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
44   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
45   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46   */
47  package org.eclipse.jgit.merge;
48  
49  import static java.nio.charset.StandardCharsets.UTF_8;
50  import static java.time.Instant.EPOCH;
51  import static org.eclipse.jgit.diff.DiffAlgorithm.SupportedAlgorithm.HISTOGRAM;
52  import static org.eclipse.jgit.lib.ConfigConstants.CONFIG_DIFF_SECTION;
53  import static org.eclipse.jgit.lib.ConfigConstants.CONFIG_KEY_ALGORITHM;
54  import static org.eclipse.jgit.lib.Constants.OBJ_BLOB;
55  
56  import java.io.BufferedOutputStream;
57  import java.io.File;
58  import java.io.FileNotFoundException;
59  import java.io.FileOutputStream;
60  import java.io.IOException;
61  import java.io.InputStream;
62  import java.io.OutputStream;
63  import java.time.Instant;
64  import java.util.ArrayList;
65  import java.util.Arrays;
66  import java.util.Collections;
67  import java.util.HashMap;
68  import java.util.Iterator;
69  import java.util.LinkedList;
70  import java.util.List;
71  import java.util.Map;
72  
73  import org.eclipse.jgit.attributes.Attributes;
74  import org.eclipse.jgit.diff.DiffAlgorithm;
75  import org.eclipse.jgit.diff.DiffAlgorithm.SupportedAlgorithm;
76  import org.eclipse.jgit.diff.RawText;
77  import org.eclipse.jgit.diff.RawTextComparator;
78  import org.eclipse.jgit.diff.Sequence;
79  import org.eclipse.jgit.dircache.DirCache;
80  import org.eclipse.jgit.dircache.DirCacheBuildIterator;
81  import org.eclipse.jgit.dircache.DirCacheBuilder;
82  import org.eclipse.jgit.dircache.DirCacheCheckout;
83  import org.eclipse.jgit.dircache.DirCacheCheckout.CheckoutMetadata;
84  import org.eclipse.jgit.dircache.DirCacheEntry;
85  import org.eclipse.jgit.errors.BinaryBlobException;
86  import org.eclipse.jgit.errors.CorruptObjectException;
87  import org.eclipse.jgit.errors.IncorrectObjectTypeException;
88  import org.eclipse.jgit.errors.IndexWriteException;
89  import org.eclipse.jgit.errors.MissingObjectException;
90  import org.eclipse.jgit.errors.NoWorkTreeException;
91  import org.eclipse.jgit.lib.Config;
92  import org.eclipse.jgit.lib.ConfigConstants;
93  import org.eclipse.jgit.lib.Constants;
94  import org.eclipse.jgit.lib.CoreConfig.EolStreamType;
95  import org.eclipse.jgit.lib.FileMode;
96  import org.eclipse.jgit.lib.ObjectId;
97  import org.eclipse.jgit.lib.ObjectInserter;
98  import org.eclipse.jgit.lib.ObjectLoader;
99  import org.eclipse.jgit.lib.Repository;
100 import org.eclipse.jgit.revwalk.RevTree;
101 import org.eclipse.jgit.storage.pack.PackConfig;
102 import org.eclipse.jgit.submodule.SubmoduleConflict;
103 import org.eclipse.jgit.treewalk.AbstractTreeIterator;
104 import org.eclipse.jgit.treewalk.CanonicalTreeParser;
105 import org.eclipse.jgit.treewalk.NameConflictTreeWalk;
106 import org.eclipse.jgit.treewalk.TreeWalk;
107 import org.eclipse.jgit.treewalk.TreeWalk.OperationType;
108 import org.eclipse.jgit.treewalk.WorkingTreeIterator;
109 import org.eclipse.jgit.treewalk.WorkingTreeOptions;
110 import org.eclipse.jgit.treewalk.filter.TreeFilter;
111 import org.eclipse.jgit.util.FS;
112 import org.eclipse.jgit.util.LfsFactory;
113 import org.eclipse.jgit.util.LfsFactory.LfsInputStream;
114 import org.eclipse.jgit.util.TemporaryBuffer;
115 import org.eclipse.jgit.util.io.EolStreamTypeUtil;
116 
117 /**
118  * A three-way merger performing a content-merge if necessary
119  */
120 public class ResolveMerger extends ThreeWayMerger {
121 	/**
122 	 * If the merge fails (means: not stopped because of unresolved conflicts)
123 	 * this enum is used to explain why it failed
124 	 */
125 	public enum MergeFailureReason {
126 		/** the merge failed because of a dirty index */
127 		DIRTY_INDEX,
128 		/** the merge failed because of a dirty workingtree */
129 		DIRTY_WORKTREE,
130 		/** the merge failed because of a file could not be deleted */
131 		COULD_NOT_DELETE
132 	}
133 
134 	/**
135 	 * The tree walk which we'll iterate over to merge entries.
136 	 *
137 	 * @since 3.4
138 	 */
139 	protected NameConflictTreeWalk tw;
140 
141 	/**
142 	 * string versions of a list of commit SHA1s
143 	 *
144 	 * @since 3.0
145 	 */
146 	protected String commitNames[];
147 
148 	/**
149 	 * Index of the base tree within the {@link #tw tree walk}.
150 	 *
151 	 * @since 3.4
152 	 */
153 	protected static final int T_BASE = 0;
154 
155 	/**
156 	 * Index of our tree in withthe {@link #tw tree walk}.
157 	 *
158 	 * @since 3.4
159 	 */
160 	protected static final int T_OURS = 1;
161 
162 	/**
163 	 * Index of their tree within the {@link #tw tree walk}.
164 	 *
165 	 * @since 3.4
166 	 */
167 	protected static final int T_THEIRS = 2;
168 
169 	/**
170 	 * Index of the index tree within the {@link #tw tree walk}.
171 	 *
172 	 * @since 3.4
173 	 */
174 	protected static final int T_INDEX = 3;
175 
176 	/**
177 	 * Index of the working directory tree within the {@link #tw tree walk}.
178 	 *
179 	 * @since 3.4
180 	 */
181 	protected static final int T_FILE = 4;
182 
183 	/**
184 	 * Builder to update the cache during this merge.
185 	 *
186 	 * @since 3.4
187 	 */
188 	protected DirCacheBuilder builder;
189 
190 	/**
191 	 * merge result as tree
192 	 *
193 	 * @since 3.0
194 	 */
195 	protected ObjectId resultTree;
196 
197 	/**
198 	 * Paths that could not be merged by this merger because of an unsolvable
199 	 * conflict.
200 	 *
201 	 * @since 3.4
202 	 */
203 	protected List<String> unmergedPaths = new ArrayList<>();
204 
205 	/**
206 	 * Files modified during this merge operation.
207 	 *
208 	 * @since 3.4
209 	 */
210 	protected List<String> modifiedFiles = new LinkedList<>();
211 
212 	/**
213 	 * If the merger has nothing to do for a file but check it out at the end of
214 	 * the operation, it can be added here.
215 	 *
216 	 * @since 3.4
217 	 */
218 	protected Map<String, DirCacheEntry> toBeCheckedOut = new HashMap<>();
219 
220 	/**
221 	 * Paths in this list will be deleted from the local copy at the end of the
222 	 * operation.
223 	 *
224 	 * @since 3.4
225 	 */
226 	protected List<String> toBeDeleted = new ArrayList<>();
227 
228 	/**
229 	 * Low-level textual merge results. Will be passed on to the callers in case
230 	 * of conflicts.
231 	 *
232 	 * @since 3.4
233 	 */
234 	protected Map<String, MergeResult<? extends Sequence>> mergeResults = new HashMap<>();
235 
236 	/**
237 	 * Paths for which the merge failed altogether.
238 	 *
239 	 * @since 3.4
240 	 */
241 	protected Map<String, MergeFailureReason> failingPaths = new HashMap<>();
242 
243 	/**
244 	 * Updated as we merge entries of the tree walk. Tells us whether we should
245 	 * recurse into the entry if it is a subtree.
246 	 *
247 	 * @since 3.4
248 	 */
249 	protected boolean enterSubtree;
250 
251 	/**
252 	 * Set to true if this merge should work in-memory. The repos dircache and
253 	 * workingtree are not touched by this method. Eventually needed files are
254 	 * created as temporary files and a new empty, in-memory dircache will be
255 	 * used instead the repo's one. Often used for bare repos where the repo
256 	 * doesn't even have a workingtree and dircache.
257 	 * @since 3.0
258 	 */
259 	protected boolean inCore;
260 
261 	/**
262 	 * Set to true if this merger should use the default dircache of the
263 	 * repository and should handle locking and unlocking of the dircache. If
264 	 * this merger should work in-core or if an explicit dircache was specified
265 	 * during construction then this field is set to false.
266 	 * @since 3.0
267 	 */
268 	protected boolean implicitDirCache;
269 
270 	/**
271 	 * Directory cache
272 	 * @since 3.0
273 	 */
274 	protected DirCache dircache;
275 
276 	/**
277 	 * The iterator to access the working tree. If set to <code>null</code> this
278 	 * merger will not touch the working tree.
279 	 * @since 3.0
280 	 */
281 	protected WorkingTreeIterator workingTreeIterator;
282 
283 	/**
284 	 * our merge algorithm
285 	 * @since 3.0
286 	 */
287 	protected MergeAlgorithm mergeAlgorithm;
288 
289 	/**
290 	 * The {@link WorkingTreeOptions} are needed to determine line endings for
291 	 * merged files.
292 	 *
293 	 * @since 4.11
294 	 */
295 	protected WorkingTreeOptions workingTreeOptions;
296 
297 	/**
298 	 * The size limit (bytes) which controls a file to be stored in {@code Heap}
299 	 * or {@code LocalFile} during the merge.
300 	 */
301 	private int inCoreLimit;
302 
303 	/**
304 	 * Keeps {@link CheckoutMetadata} for {@link #checkout()} and
305 	 * {@link #cleanUp()}.
306 	 */
307 	private Map<String, CheckoutMetadata> checkoutMetadata;
308 
309 	private static MergeAlgorithm getMergeAlgorithm(Config config) {
310 		SupportedAlgorithm diffAlg = config.getEnum(
311 				CONFIG_DIFF_SECTION, null, CONFIG_KEY_ALGORITHM,
312 				HISTOGRAM);
313 		return new MergeAlgorithm(DiffAlgorithm.getAlgorithm(diffAlg));
314 	}
315 
316 	private static int getInCoreLimit(Config config) {
317 		return config.getInt(
318 				ConfigConstants.CONFIG_MERGE_SECTION, ConfigConstants.CONFIG_KEY_IN_CORE_LIMIT, 10 << 20);
319 	}
320 
321 	private static String[] defaultCommitNames() {
322 		return new String[] { "BASE", "OURS", "THEIRS" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
323 	}
324 
325 	private static final Attributeshtml#Attributes">Attributes NO_ATTRIBUTES = new Attributes();
326 
327 	/**
328 	 * Constructor for ResolveMerger.
329 	 *
330 	 * @param local
331 	 *            the {@link org.eclipse.jgit.lib.Repository}.
332 	 * @param inCore
333 	 *            a boolean.
334 	 */
335 	protected ResolveMerger(Repository local, boolean inCore) {
336 		super(local);
337 		Config config = local.getConfig();
338 		mergeAlgorithm = getMergeAlgorithm(config);
339 		inCoreLimit = getInCoreLimit(config);
340 		commitNames = defaultCommitNames();
341 		this.inCore = inCore;
342 
343 		if (inCore) {
344 			implicitDirCache = false;
345 			dircache = DirCache.newInCore();
346 		} else {
347 			implicitDirCache = true;
348 			workingTreeOptions = local.getConfig().get(WorkingTreeOptions.KEY);
349 		}
350 	}
351 
352 	/**
353 	 * Constructor for ResolveMerger.
354 	 *
355 	 * @param local
356 	 *            the {@link org.eclipse.jgit.lib.Repository}.
357 	 */
358 	protected ResolveMerger(Repository local) {
359 		this(local, false);
360 	}
361 
362 	/**
363 	 * Constructor for ResolveMerger.
364 	 *
365 	 * @param inserter
366 	 *            an {@link org.eclipse.jgit.lib.ObjectInserter} object.
367 	 * @param config
368 	 *            the repository configuration
369 	 * @since 4.8
370 	 */
371 	protected ResolveMerger(ObjectInserter inserter, Config config) {
372 		super(inserter);
373 		mergeAlgorithm = getMergeAlgorithm(config);
374 		commitNames = defaultCommitNames();
375 		inCore = true;
376 		implicitDirCache = false;
377 		dircache = DirCache.newInCore();
378 	}
379 
380 	/** {@inheritDoc} */
381 	@Override
382 	protected boolean mergeImpl() throws IOException {
383 		if (implicitDirCache) {
384 			dircache = nonNullRepo().lockDirCache();
385 		}
386 		if (!inCore) {
387 			checkoutMetadata = new HashMap<>();
388 		}
389 		try {
390 			return mergeTrees(mergeBase(), sourceTrees[0], sourceTrees[1],
391 					false);
392 		} finally {
393 			checkoutMetadata = null;
394 			if (implicitDirCache) {
395 				dircache.unlock();
396 			}
397 		}
398 	}
399 
400 	private void checkout() throws NoWorkTreeException, IOException {
401 		// Iterate in reverse so that "folder/file" is deleted before
402 		// "folder". Otherwise this could result in a failing path because
403 		// of a non-empty directory, for which delete() would fail.
404 		for (int i = toBeDeleted.size() - 1; i >= 0; i--) {
405 			String fileName = toBeDeleted.get(i);
406 			File f = new File(nonNullRepo().getWorkTree(), fileName);
407 			if (!f.delete())
408 				if (!f.isDirectory())
409 					failingPaths.put(fileName,
410 							MergeFailureReason.COULD_NOT_DELETE);
411 			modifiedFiles.add(fileName);
412 		}
413 		for (Map.Entry<String, DirCacheEntry> entry : toBeCheckedOut
414 				.entrySet()) {
415 			DirCacheEntry cacheEntry = entry.getValue();
416 			if (cacheEntry.getFileMode() == FileMode.GITLINK) {
417 				new File(nonNullRepo().getWorkTree(), entry.getKey()).mkdirs();
418 			} else {
419 				DirCacheCheckout.checkoutEntry(db, cacheEntry, reader, false,
420 						checkoutMetadata.get(entry.getKey()));
421 				modifiedFiles.add(entry.getKey());
422 			}
423 		}
424 	}
425 
426 	/**
427 	 * Reverts the worktree after an unsuccessful merge. We know that for all
428 	 * modified files the old content was in the old index and the index
429 	 * contained only stage 0. In case if inCore operation just clear the
430 	 * history of modified files.
431 	 *
432 	 * @throws java.io.IOException
433 	 * @throws org.eclipse.jgit.errors.CorruptObjectException
434 	 * @throws org.eclipse.jgit.errors.NoWorkTreeException
435 	 * @since 3.4
436 	 */
437 	protected void cleanUp() throws NoWorkTreeException,
438 			CorruptObjectException,
439 			IOException {
440 		if (inCore) {
441 			modifiedFiles.clear();
442 			return;
443 		}
444 
445 		DirCache dc = nonNullRepo().readDirCache();
446 		Iterator<String> mpathsIt=modifiedFiles.iterator();
447 		while(mpathsIt.hasNext()) {
448 			String mpath = mpathsIt.next();
449 			DirCacheEntry entry = dc.getEntry(mpath);
450 			if (entry != null) {
451 				DirCacheCheckout.checkoutEntry(db, entry, reader, false,
452 						checkoutMetadata.get(mpath));
453 			}
454 			mpathsIt.remove();
455 		}
456 	}
457 
458 	/**
459 	 * adds a new path with the specified stage to the index builder
460 	 *
461 	 * @param path
462 	 * @param p
463 	 * @param stage
464 	 * @param lastMod
465 	 * @param len
466 	 * @return the entry which was added to the index
467 	 */
468 	private DirCacheEntry add(byte[] path, CanonicalTreeParser p, int stage,
469 			Instant lastMod, long len) {
470 		if (p != null && !p.getEntryFileMode().equals(FileMode.TREE)) {
471 			DirCacheEntry e = new DirCacheEntry(path, stage);
472 			e.setFileMode(p.getEntryFileMode());
473 			e.setObjectId(p.getEntryObjectId());
474 			e.setLastModified(lastMod);
475 			e.setLength(len);
476 			builder.add(e);
477 			return e;
478 		}
479 		return null;
480 	}
481 
482 	/**
483 	 * adds a entry to the index builder which is a copy of the specified
484 	 * DirCacheEntry
485 	 *
486 	 * @param e
487 	 *            the entry which should be copied
488 	 *
489 	 * @return the entry which was added to the index
490 	 */
491 	private DirCacheEntry/../../../org/eclipse/jgit/dircache/DirCacheEntry.html#DirCacheEntry">DirCacheEntry keep(DirCacheEntry e) {
492 		DirCacheEntry newEntry = new DirCacheEntry(e.getRawPath(),
493 				e.getStage());
494 		newEntry.setFileMode(e.getFileMode());
495 		newEntry.setObjectId(e.getObjectId());
496 		newEntry.setLastModified(e.getLastModifiedInstant());
497 		newEntry.setLength(e.getLength());
498 		builder.add(newEntry);
499 		return newEntry;
500 	}
501 
502 	/**
503 	 * Remembers the {@link CheckoutMetadata} for the given path; it may be
504 	 * needed in {@link #checkout()} or in {@link #cleanUp()}.
505 	 *
506 	 * @param path
507 	 *            of the current node
508 	 * @param attributes
509 	 *            for the current node
510 	 * @throws IOException
511 	 *             if the smudge filter cannot be determined
512 	 * @since 5.1
513 	 */
514 	protected void addCheckoutMetadata(String path, Attributes attributes)
515 			throws IOException {
516 		if (checkoutMetadata != null) {
517 			EolStreamType eol = EolStreamTypeUtil.detectStreamType(
518 					OperationType.CHECKOUT_OP, workingTreeOptions, attributes);
519 			CheckoutMetadata data = new CheckoutMetadata(eol,
520 					tw.getFilterCommand(Constants.ATTR_FILTER_TYPE_SMUDGE));
521 			checkoutMetadata.put(path, data);
522 		}
523 	}
524 
525 	/**
526 	 * Adds a {@link DirCacheEntry} for direct checkout and remembers its
527 	 * {@link CheckoutMetadata}.
528 	 *
529 	 * @param path
530 	 *            of the entry
531 	 * @param entry
532 	 *            to add
533 	 * @param attributes
534 	 *            for the current entry
535 	 * @throws IOException
536 	 *             if the {@link CheckoutMetadata} cannot be determined
537 	 * @since 5.1
538 	 */
539 	protected void addToCheckout(String path, DirCacheEntry entry,
540 			Attributes attributes) throws IOException {
541 		toBeCheckedOut.put(path, entry);
542 		addCheckoutMetadata(path, attributes);
543 	}
544 
545 	/**
546 	 * Remember a path for deletion, and remember its {@link CheckoutMetadata}
547 	 * in case it has to be restored in {@link #cleanUp()}.
548 	 *
549 	 * @param path
550 	 *            of the entry
551 	 * @param isFile
552 	 *            whether it is a file
553 	 * @param attributes
554 	 *            for the entry
555 	 * @throws IOException
556 	 *             if the {@link CheckoutMetadata} cannot be determined
557 	 * @since 5.1
558 	 */
559 	protected void addDeletion(String path, boolean isFile,
560 			Attributes attributes) throws IOException {
561 		toBeDeleted.add(path);
562 		if (isFile) {
563 			addCheckoutMetadata(path, attributes);
564 		}
565 	}
566 
567 	/**
568 	 * Processes one path and tries to merge taking git attributes in account.
569 	 * This method will do all trivial (not content) merges and will also detect
570 	 * if a merge will fail. The merge will fail when one of the following is
571 	 * true
572 	 * <ul>
573 	 * <li>the index entry does not match the entry in ours. When merging one
574 	 * branch into the current HEAD, ours will point to HEAD and theirs will
575 	 * point to the other branch. It is assumed that the index matches the HEAD
576 	 * because it will only not match HEAD if it was populated before the merge
577 	 * operation. But the merge commit should not accidentally contain
578 	 * modifications done before the merge. Check the <a href=
579 	 * "http://www.kernel.org/pub/software/scm/git/docs/git-read-tree.html#_3_way_merge"
580 	 * >git read-tree</a> documentation for further explanations.</li>
581 	 * <li>A conflict was detected and the working-tree file is dirty. When a
582 	 * conflict is detected the content-merge algorithm will try to write a
583 	 * merged version into the working-tree. If the file is dirty we would
584 	 * override unsaved data.</li>
585 	 * </ul>
586 	 *
587 	 * @param base
588 	 *            the common base for ours and theirs
589 	 * @param ours
590 	 *            the ours side of the merge. When merging a branch into the
591 	 *            HEAD ours will point to HEAD
592 	 * @param theirs
593 	 *            the theirs side of the merge. When merging a branch into the
594 	 *            current HEAD theirs will point to the branch which is merged
595 	 *            into HEAD.
596 	 * @param index
597 	 *            the index entry
598 	 * @param work
599 	 *            the file in the working tree
600 	 * @param ignoreConflicts
601 	 *            see
602 	 *            {@link org.eclipse.jgit.merge.ResolveMerger#mergeTrees(AbstractTreeIterator, RevTree, RevTree, boolean)}
603 	 * @param attributes
604 	 *            the attributes defined for this entry
605 	 * @return <code>false</code> if the merge will fail because the index entry
606 	 *         didn't match ours or the working-dir file was dirty and a
607 	 *         conflict occurred
608 	 * @throws org.eclipse.jgit.errors.MissingObjectException
609 	 * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
610 	 * @throws org.eclipse.jgit.errors.CorruptObjectException
611 	 * @throws java.io.IOException
612 	 * @since 4.9
613 	 */
614 	protected boolean processEntry(CanonicalTreeParser base,
615 			CanonicalTreeParser ours, CanonicalTreeParser theirs,
616 			DirCacheBuildIterator index, WorkingTreeIterator work,
617 			boolean ignoreConflicts, Attributes attributes)
618 			throws MissingObjectException, IncorrectObjectTypeException,
619 			CorruptObjectException, IOException {
620 		enterSubtree = true;
621 		final int modeO = tw.getRawMode(T_OURS);
622 		final int modeT = tw.getRawMode(T_THEIRS);
623 		final int modeB = tw.getRawMode(T_BASE);
624 
625 		if (modeO == 0 && modeT == 0 && modeB == 0)
626 			// File is either untracked or new, staged but uncommitted
627 			return true;
628 
629 		if (isIndexDirty())
630 			return false;
631 
632 		DirCacheEntry ourDce = null;
633 
634 		if (index == null || index.getDirCacheEntry() == null) {
635 			// create a fake DCE, but only if ours is valid. ours is kept only
636 			// in case it is valid, so a null ourDce is ok in all other cases.
637 			if (nonTree(modeO)) {
638 				ourDce = new DirCacheEntry(tw.getRawPath());
639 				ourDce.setObjectId(tw.getObjectId(T_OURS));
640 				ourDce.setFileMode(tw.getFileMode(T_OURS));
641 			}
642 		} else {
643 			ourDce = index.getDirCacheEntry();
644 		}
645 
646 		if (nonTree(modeO) && nonTree(modeT) && tw.idEqual(T_OURS, T_THEIRS)) {
647 			// OURS and THEIRS have equal content. Check the file mode
648 			if (modeO == modeT) {
649 				// content and mode of OURS and THEIRS are equal: it doesn't
650 				// matter which one we choose. OURS is chosen. Since the index
651 				// is clean (the index matches already OURS) we can keep the existing one
652 				keep(ourDce);
653 				// no checkout needed!
654 				return true;
655 			} else {
656 				// same content but different mode on OURS and THEIRS.
657 				// Try to merge the mode and report an error if this is
658 				// not possible.
659 				int newMode = mergeFileModes(modeB, modeO, modeT);
660 				if (newMode != FileMode.MISSING.getBits()) {
661 					if (newMode == modeO)
662 						// ours version is preferred
663 						keep(ourDce);
664 					else {
665 						// the preferred version THEIRS has a different mode
666 						// than ours. Check it out!
667 						if (isWorktreeDirty(work, ourDce))
668 							return false;
669 						// we know about length and lastMod only after we have written the new content.
670 						// This will happen later. Set these values to 0 for know.
671 						DirCacheEntry e = add(tw.getRawPath(), theirs,
672 								DirCacheEntry.STAGE_0, EPOCH, 0);
673 						addToCheckout(tw.getPathString(), e, attributes);
674 					}
675 					return true;
676 				} else {
677 					// FileModes are not mergeable. We found a conflict on modes.
678 					// For conflicting entries we don't know lastModified and length.
679 					add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
680 					add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
681 					add(tw.getRawPath(), theirs, DirCacheEntry.STAGE_3, EPOCH,
682 							0);
683 					unmergedPaths.add(tw.getPathString());
684 					mergeResults.put(
685 							tw.getPathString(),
686 							new MergeResult<>(Collections
687 									.<RawText> emptyList()));
688 				}
689 				return true;
690 			}
691 		}
692 
693 		if (modeB == modeT && tw.idEqual(T_BASE, T_THEIRS)) {
694 			// THEIRS was not changed compared to BASE. All changes must be in
695 			// OURS. OURS is chosen. We can keep the existing entry.
696 			if (ourDce != null)
697 				keep(ourDce);
698 			// no checkout needed!
699 			return true;
700 		}
701 
702 		if (modeB == modeO && tw.idEqual(T_BASE, T_OURS)) {
703 			// OURS was not changed compared to BASE. All changes must be in
704 			// THEIRS. THEIRS is chosen.
705 
706 			// Check worktree before checking out THEIRS
707 			if (isWorktreeDirty(work, ourDce))
708 				return false;
709 			if (nonTree(modeT)) {
710 				// we know about length and lastMod only after we have written
711 				// the new content.
712 				// This will happen later. Set these values to 0 for know.
713 				DirCacheEntry e = add(tw.getRawPath(), theirs,
714 						DirCacheEntry.STAGE_0, EPOCH, 0);
715 				if (e != null) {
716 					addToCheckout(tw.getPathString(), e, attributes);
717 				}
718 				return true;
719 			} else {
720 				// we want THEIRS ... but THEIRS contains a folder or the
721 				// deletion of the path. Delete what's in the working tree,
722 				// which we know to be clean.
723 				if (tw.getTreeCount() > T_FILE && tw.getRawMode(T_FILE) == 0) {
724 					// Not present in working tree, so nothing to delete
725 					return true;
726 				}
727 				if (modeT != 0 && modeT == modeB) {
728 					// Base, ours, and theirs all contain a folder: don't delete
729 					return true;
730 				}
731 				addDeletion(tw.getPathString(), nonTree(modeO), attributes);
732 				return true;
733 			}
734 		}
735 
736 		if (tw.isSubtree()) {
737 			// file/folder conflicts: here I want to detect only file/folder
738 			// conflict between ours and theirs. file/folder conflicts between
739 			// base/index/workingTree and something else are not relevant or
740 			// detected later
741 			if (nonTree(modeO) && !nonTree(modeT)) {
742 				if (nonTree(modeB))
743 					add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
744 				add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
745 				unmergedPaths.add(tw.getPathString());
746 				enterSubtree = false;
747 				return true;
748 			}
749 			if (nonTree(modeT) && !nonTree(modeO)) {
750 				if (nonTree(modeB))
751 					add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
752 				add(tw.getRawPath(), theirs, DirCacheEntry.STAGE_3, EPOCH, 0);
753 				unmergedPaths.add(tw.getPathString());
754 				enterSubtree = false;
755 				return true;
756 			}
757 
758 			// ours and theirs are both folders or both files (and treewalk
759 			// tells us we are in a subtree because of index or working-dir).
760 			// If they are both folders no content-merge is required - we can
761 			// return here.
762 			if (!nonTree(modeO))
763 				return true;
764 
765 			// ours and theirs are both files, just fall out of the if block
766 			// and do the content merge
767 		}
768 
769 		if (nonTree(modeO) && nonTree(modeT)) {
770 			// Check worktree before modifying files
771 			boolean worktreeDirty = isWorktreeDirty(work, ourDce);
772 			if (!attributes.canBeContentMerged() && worktreeDirty) {
773 				return false;
774 			}
775 
776 			boolean gitlinkConflict = isGitLink(modeO) || isGitLink(modeT);
777 			// Don't attempt to resolve submodule link conflicts
778 			if (gitlinkConflict || !attributes.canBeContentMerged()) {
779 				add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
780 				add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
781 				add(tw.getRawPath(), theirs, DirCacheEntry.STAGE_3, EPOCH, 0);
782 
783 				if (gitlinkConflict) {
784 					MergeResult<SubmoduleConflict> result = new MergeResult<>(
785 							Arrays.asList(
786 									new SubmoduleConflict(base == null ? null
787 											: base.getEntryObjectId()),
788 									new SubmoduleConflict(ours == null ? null
789 											: ours.getEntryObjectId()),
790 									new SubmoduleConflict(theirs == null ? null
791 											: theirs.getEntryObjectId())));
792 					result.setContainsConflicts(true);
793 					mergeResults.put(tw.getPathString(), result);
794 					if (!ignoreConflicts) {
795 						unmergedPaths.add(tw.getPathString());
796 					}
797 				} else {
798 					// attribute merge issues are conflicts but not failures
799 					unmergedPaths.add(tw.getPathString());
800 				}
801 				return true;
802 			}
803 
804 			// Check worktree before modifying files
805 			if (worktreeDirty) {
806 				return false;
807 			}
808 
809 			MergeResult<RawText> result = contentMerge(base, ours, theirs,
810 					attributes);
811 			if (ignoreConflicts) {
812 				result.setContainsConflicts(false);
813 			}
814 			updateIndex(base, ours, theirs, result, attributes);
815 			String currentPath = tw.getPathString();
816 			if (result.containsConflicts() && !ignoreConflicts) {
817 				unmergedPaths.add(currentPath);
818 			}
819 			modifiedFiles.add(currentPath);
820 			addCheckoutMetadata(currentPath, attributes);
821 		} else if (modeO != modeT) {
822 			// OURS or THEIRS has been deleted
823 			if (((modeO != 0 && !tw.idEqual(T_BASE, T_OURS)) || (modeT != 0 && !tw
824 					.idEqual(T_BASE, T_THEIRS)))) {
825 				MergeResult<RawText> result = contentMerge(base, ours, theirs,
826 						attributes);
827 
828 				add(tw.getRawPath(), base, DirCacheEntry.STAGE_1, EPOCH, 0);
829 				add(tw.getRawPath(), ours, DirCacheEntry.STAGE_2, EPOCH, 0);
830 				DirCacheEntry e = add(tw.getRawPath(), theirs,
831 						DirCacheEntry.STAGE_3, EPOCH, 0);
832 
833 				// OURS was deleted checkout THEIRS
834 				if (modeO == 0) {
835 					// Check worktree before checking out THEIRS
836 					if (isWorktreeDirty(work, ourDce))
837 						return false;
838 					if (nonTree(modeT)) {
839 						if (e != null) {
840 							addToCheckout(tw.getPathString(), e, attributes);
841 						}
842 					}
843 				}
844 
845 				unmergedPaths.add(tw.getPathString());
846 
847 				// generate a MergeResult for the deleted file
848 				mergeResults.put(tw.getPathString(), result);
849 			}
850 		}
851 		return true;
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 		} else {
1314 			resultTree = null;
1315 			return false;
1316 		}
1317 	}
1318 
1319 	/**
1320 	 * Process the given TreeWalk's entries.
1321 	 *
1322 	 * @param treeWalk
1323 	 *            The walk to iterate over.
1324 	 * @param ignoreConflicts
1325 	 *            see
1326 	 *            {@link org.eclipse.jgit.merge.ResolveMerger#mergeTrees(AbstractTreeIterator, RevTree, RevTree, boolean)}
1327 	 * @return Whether the trees merged cleanly.
1328 	 * @throws java.io.IOException
1329 	 * @since 3.5
1330 	 */
1331 	protected boolean mergeTreeWalk(TreeWalk treeWalk, boolean ignoreConflicts)
1332 			throws IOException {
1333 		boolean hasWorkingTreeIterator = tw.getTreeCount() > T_FILE;
1334 		boolean hasAttributeNodeProvider = treeWalk
1335 				.getAttributesNodeProvider() != null;
1336 		while (treeWalk.next()) {
1337 			if (!processEntry(
1338 					treeWalk.getTree(T_BASE, CanonicalTreeParser.class),
1339 					treeWalk.getTree(T_OURS, CanonicalTreeParser.class),
1340 					treeWalk.getTree(T_THEIRS, CanonicalTreeParser.class),
1341 					treeWalk.getTree(T_INDEX, DirCacheBuildIterator.class),
1342 					hasWorkingTreeIterator ? treeWalk.getTree(T_FILE,
1343 							WorkingTreeIterator.class) : null,
1344 					ignoreConflicts, hasAttributeNodeProvider
1345 							? treeWalk.getAttributes()
1346 							: NO_ATTRIBUTES)) {
1347 				cleanUp();
1348 				return false;
1349 			}
1350 			if (treeWalk.isSubtree() && enterSubtree)
1351 				treeWalk.enterSubtree();
1352 		}
1353 		return true;
1354 	}
1355 }