StashApplyCommand.java

  1. /*
  2.  * Copyright (C) 2012, 2021 GitHub Inc. and others
  3.  *
  4.  * This program and the accompanying materials are made available under the
  5.  * terms of the Eclipse Distribution License v. 1.0 which is available at
  6.  * https://www.eclipse.org/org/documents/edl-v10.php.
  7.  *
  8.  * SPDX-License-Identifier: BSD-3-Clause
  9.  */
  10. package org.eclipse.jgit.api;

  12. import static org.eclipse.jgit.treewalk.TreeWalk.OperationType.CHECKOUT_OP;

  14. import java.io.IOException;
  15. import java.text.MessageFormat;
  16. import java.util.HashSet;
  17. import java.util.List;
  18. import java.util.Set;

  20. import org.eclipse.jgit.api.errors.GitAPIException;
  21. import org.eclipse.jgit.api.errors.InvalidRefNameException;
  22. import org.eclipse.jgit.api.errors.JGitInternalException;
  23. import org.eclipse.jgit.api.errors.NoHeadException;
  24. import org.eclipse.jgit.api.errors.StashApplyFailureException;
  25. import org.eclipse.jgit.api.errors.WrongRepositoryStateException;
  26. import org.eclipse.jgit.dircache.DirCache;
  27. import org.eclipse.jgit.dircache.DirCacheBuilder;
  28. import org.eclipse.jgit.dircache.DirCacheCheckout;
  29. import org.eclipse.jgit.dircache.DirCacheCheckout.CheckoutMetadata;
  30. import org.eclipse.jgit.dircache.DirCacheEntry;
  31. import org.eclipse.jgit.dircache.DirCacheIterator;
  32. import org.eclipse.jgit.errors.CheckoutConflictException;
  33. import org.eclipse.jgit.events.WorkingTreeModifiedEvent;
  34. import org.eclipse.jgit.internal.JGitText;
  35. import org.eclipse.jgit.lib.Constants;
  36. import org.eclipse.jgit.lib.CoreConfig.EolStreamType;
  37. import org.eclipse.jgit.lib.ObjectId;
  38. import org.eclipse.jgit.lib.ObjectReader;
  39. import org.eclipse.jgit.lib.Repository;
  40. import org.eclipse.jgit.lib.RepositoryState;
  41. import org.eclipse.jgit.merge.ContentMergeStrategy;
  42. import org.eclipse.jgit.merge.MergeStrategy;
  43. import org.eclipse.jgit.merge.Merger;
  44. import org.eclipse.jgit.merge.ResolveMerger;
  45. import org.eclipse.jgit.revwalk.RevCommit;
  46. import org.eclipse.jgit.revwalk.RevTree;
  47. import org.eclipse.jgit.revwalk.RevWalk;
  48. import org.eclipse.jgit.treewalk.AbstractTreeIterator;
  49. import org.eclipse.jgit.treewalk.FileTreeIterator;
  50. import org.eclipse.jgit.treewalk.TreeWalk;
  51. import org.eclipse.jgit.treewalk.WorkingTreeOptions;

  53. /**
  54.  * Command class to apply a stashed commit.
  55.  *
  56.  * This class behaves like <em>git stash apply --index</em>, i.e. it tries to
  57.  * recover the stashed index state in addition to the working tree state.
  58.  *
  59.  * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-stash.html"
  60.  *      >Git documentation about Stash</a>
  61.  * @since 2.0
  62.  */
  63. public class StashApplyCommand extends GitCommand<ObjectId> {

  65.     private static final String DEFAULT_REF = Constants.STASH + "@{0}"; //$NON-NLS-1$

  67.     private String stashRef;

  69.     private boolean restoreIndex = true;

  71.     private boolean restoreUntracked = true;

  73.     private boolean ignoreRepositoryState;

  75.     private MergeStrategy strategy = MergeStrategy.RECURSIVE;

  77.     private ContentMergeStrategy contentStrategy;

  79.     /**
  80.      * Create command to apply the changes of a stashed commit
  81.      *
  82.      * @param repo
  83.      *            the {@link org.eclipse.jgit.lib.Repository} to apply the stash
  84.      *            to
  85.      */
  86.     public StashApplyCommand(Repository repo) {
  87.         super(repo);
  88.     }

  90.     /**
  91.      * Set the stash reference to apply
  92.      * <p>
  93.      * This will default to apply the latest stashed commit (stash@{0}) if
  94.      * unspecified
  95.      *
  96.      * @param stashRef
  97.      *            name of the stash {@code Ref} to apply
  98.      * @return {@code this}
  99.      */
  100.     public StashApplyCommand setStashRef(String stashRef) {
  101.         this.stashRef = stashRef;
  102.         return this;
  103.     }

  105.     /**
  106.      * Whether to ignore the repository state when applying the stash
  107.      *
  108.      * @param willIgnoreRepositoryState
  109.      *            whether to ignore the repository state when applying the stash
  110.      * @return {@code this}
  111.      * @since 3.2
  112.      */
  113.     public StashApplyCommand ignoreRepositoryState(boolean willIgnoreRepositoryState) {
  114.         this.ignoreRepositoryState = willIgnoreRepositoryState;
  115.         return this;
  116.     }

  118.     private ObjectId getStashId() throws GitAPIException {
  119.         final String revision = stashRef != null ? stashRef : DEFAULT_REF;
  120.         final ObjectId stashId;
  121.         try {
  122.             stashId = repo.resolve(revision);
  123.         } catch (IOException e) {
  124.             throw new InvalidRefNameException(MessageFormat.format(
  125.                     JGitText.get().stashResolveFailed, revision), e);
  126.         }
  127.         if (stashId == null)
  128.             throw new InvalidRefNameException(MessageFormat.format(
  129.                     JGitText.get().stashResolveFailed, revision));
  130.         return stashId;
  131.     }

  133.     /**
  134.      * {@inheritDoc}
  135.      * <p>
  136.      * Apply the changes in a stashed commit to the working directory and index
  137.      */
  138.     @Override
  139.     public ObjectId call() throws GitAPIException,
  140.             WrongRepositoryStateException, NoHeadException,
  141.             StashApplyFailureException {
  142.         checkCallable();

  144.         if (!ignoreRepositoryState
  145.                 && repo.getRepositoryState() != RepositoryState.SAFE)
  146.             throw new WrongRepositoryStateException(MessageFormat.format(
  147.                     JGitText.get().stashApplyOnUnsafeRepository,
  148.                     repo.getRepositoryState()));

  150.         try (ObjectReader reader = repo.newObjectReader();
  151.                 RevWalk revWalk = new RevWalk(reader)) {

  153.             ObjectId headCommit = repo.resolve(Constants.HEAD);
  154.             if (headCommit == null)
  155.                 throw new NoHeadException(JGitText.get().stashApplyWithoutHead);

  157.             final ObjectId stashId = getStashId();
  158.             RevCommit stashCommit = revWalk.parseCommit(stashId);
  159.             if (stashCommit.getParentCount() < 2
  160.                     || stashCommit.getParentCount() > 3)
  161.                 throw new JGitInternalException(MessageFormat.format(
  162.                         JGitText.get().stashCommitIncorrectNumberOfParents,
  163.                         stashId.name(),
  164.                         Integer.valueOf(stashCommit.getParentCount())));

  166.             ObjectId headTree = repo.resolve(Constants.HEAD + "^{tree}"); //$NON-NLS-1$
  167.             ObjectId stashIndexCommit = revWalk.parseCommit(stashCommit
  168.                     .getParent(1));
  169.             ObjectId stashHeadCommit = stashCommit.getParent(0);
  170.             ObjectId untrackedCommit = null;
  171.             if (restoreUntracked && stashCommit.getParentCount() == 3)
  172.                 untrackedCommit = revWalk.parseCommit(stashCommit.getParent(2));

  174.             Merger merger = strategy.newMerger(repo);
  175.             boolean mergeSucceeded;
  176.             if (merger instanceof ResolveMerger) {
  177.                 ResolveMerger resolveMerger = (ResolveMerger) merger;
  178.                 resolveMerger
  179.                         .setCommitNames(new String[] { "stashed HEAD", "HEAD", //$NON-NLS-1$ //$NON-NLS-2$
  180.                                 "stash" }); //$NON-NLS-1$
  181.                 resolveMerger.setBase(stashHeadCommit);
  182.                 resolveMerger
  183.                         .setWorkingTreeIterator(new FileTreeIterator(repo));
  184.                 resolveMerger.setContentMergeStrategy(contentStrategy);
  185.                 mergeSucceeded = resolveMerger.merge(headCommit, stashCommit);
  186.                 List<String> modifiedByMerge = resolveMerger.getModifiedFiles();
  187.                 if (!modifiedByMerge.isEmpty()) {
  188.                     repo.fireEvent(new WorkingTreeModifiedEvent(modifiedByMerge,
  189.                             null));
  190.                 }
  191.             } else {
  192.                 mergeSucceeded = merger.merge(headCommit, stashCommit);
  193.             }
  194.             if (mergeSucceeded) {
  195.                 DirCache dc = repo.lockDirCache();
  196.                 DirCacheCheckout dco = new DirCacheCheckout(repo, headTree,
  197.                         dc, merger.getResultTreeId());
  198.                 dco.setFailOnConflict(true);
  199.                 dco.checkout(); // Ignoring failed deletes....
  200.                 if (restoreIndex) {
  201.                     Merger ixMerger = strategy.newMerger(repo, true);
  202.                     if (ixMerger instanceof ResolveMerger) {
  203.                         ResolveMerger resolveMerger = (ResolveMerger) ixMerger;
  204.                         resolveMerger.setCommitNames(new String[] { "stashed HEAD", //$NON-NLS-1$
  205.                                 "HEAD", "stashed index" }); //$NON-NLS-1$//$NON-NLS-2$
  206.                         resolveMerger.setBase(stashHeadCommit);
  207.                         resolveMerger.setContentMergeStrategy(contentStrategy);
  208.                     }
  209.                     boolean ok = ixMerger.merge(headCommit, stashIndexCommit);
  210.                     if (ok) {
  211.                         resetIndex(revWalk
  212.                                 .parseTree(ixMerger.getResultTreeId()));
  213.                     } else {
  214.                         throw new StashApplyFailureException(
  215.                                 JGitText.get().stashApplyConflict);
  216.                     }
  217.                 }

  219.                 if (untrackedCommit != null) {
  220.                     Merger untrackedMerger = strategy.newMerger(repo, true);
  221.                     if (untrackedMerger instanceof ResolveMerger) {
  222.                         ResolveMerger resolveMerger = (ResolveMerger) untrackedMerger;
  223.                         resolveMerger.setCommitNames(new String[] { "null", "HEAD", //$NON-NLS-1$//$NON-NLS-2$
  224.                                 "untracked files" }); //$NON-NLS-1$
  225.                         // There is no common base for HEAD & untracked files
  226.                         // because the commit for untracked files has no parent.
  227.                         // If we use stashHeadCommit as common base (as in the
  228.                         // other merges) we potentially report conflicts for
  229.                         // files which are not even member of untracked files
  230.                         // commit.
  231.                         resolveMerger.setBase(null);
  232.                         resolveMerger.setContentMergeStrategy(contentStrategy);
  233.                     }
  234.                     boolean ok = untrackedMerger.merge(headCommit,
  235.                             untrackedCommit);
  236.                     if (ok) {
  237.                         try {
  238.                             RevTree untrackedTree = revWalk
  239.                                     .parseTree(untrackedCommit);
  240.                             resetUntracked(untrackedTree);
  241.                         } catch (CheckoutConflictException e) {
  242.                             throw new StashApplyFailureException(
  243.                                     JGitText.get().stashApplyConflict, e);
  244.                         }
  245.                     } else {
  246.                         throw new StashApplyFailureException(
  247.                                 JGitText.get().stashApplyConflict);
  248.                     }
  249.                 }
  250.             } else {
  251.                 throw new StashApplyFailureException(
  252.                         JGitText.get().stashApplyConflict);
  253.             }
  254.             return stashId;

  256.         } catch (JGitInternalException e) {
  257.             throw e;
  258.         } catch (IOException e) {
  259.             throw new JGitInternalException(JGitText.get().stashApplyFailed, e);
  260.         }
  261.     }

  263.     /**
  264.      * Whether to restore the index state
  265.      *
  266.      * @param applyIndex
  267.      *            true (default) if the command should restore the index state
  268.      * @deprecated use {@link #setRestoreIndex} instead
  269.      */
  270.     @Deprecated
  271.     public void setApplyIndex(boolean applyIndex) {
  272.         this.restoreIndex = applyIndex;
  273.     }

  275.     /**
  276.      * Whether to restore the index state
  277.      *
  278.      * @param restoreIndex
  279.      *            true (default) if the command should restore the index state
  280.      * @return {@code this}
  281.      * @since 5.3
  282.      */
  283.     public StashApplyCommand setRestoreIndex(boolean restoreIndex) {
  284.         this.restoreIndex = restoreIndex;
  285.         return this;
  286.     }

  288.     /**
  289.      * Set the <code>MergeStrategy</code> to use.
  290.      *
  291.      * @param strategy
  292.      *            The merge strategy to use in order to merge during this
  293.      *            command execution.
  294.      * @return {@code this}
  295.      * @since 3.4
  296.      */
  297.     public StashApplyCommand setStrategy(MergeStrategy strategy) {
  298.         this.strategy = strategy;
  299.         return this;
  300.     }

  302.     /**
  303.      * Sets the content merge strategy to use if the
  304.      * {@link #setStrategy(MergeStrategy) merge strategy} is "resolve" or
  305.      * "recursive".
  306.      *
  307.      * @param strategy
  308.      *            the {@link ContentMergeStrategy} to be used
  309.      * @return {@code this}
  310.      * @since 5.12
  311.      */
  312.     public StashApplyCommand setContentMergeStrategy(
  313.             ContentMergeStrategy strategy) {
  314.         checkCallable();
  315.         this.contentStrategy = strategy;
  316.         return this;
  317.     }

  319.     /**
  320.      * Whether the command should restore untracked files
  321.      *
  322.      * @param applyUntracked
  323.      *            true (default) if the command should restore untracked files
  324.      * @since 3.4
  325.      * @deprecated use {@link #setRestoreUntracked} instead
  326.      */
  327.     @Deprecated
  328.     public void setApplyUntracked(boolean applyUntracked) {
  329.         this.restoreUntracked = applyUntracked;
  330.     }

  332.     /**
  333.      * Whether the command should restore untracked files
  334.      *
  335.      * @param restoreUntracked
  336.      *            true (default) if the command should restore untracked files
  337.      * @return {@code this}
  338.      * @since 5.3
  339.      */
  340.     public StashApplyCommand setRestoreUntracked(boolean restoreUntracked) {
  341.         this.restoreUntracked = restoreUntracked;
  342.         return this;
  343.     }

  345.     private void resetIndex(RevTree tree) throws IOException {
  346.         DirCache dc = repo.lockDirCache();
  347.         try (TreeWalk walk = new TreeWalk(repo)) {
  348.             DirCacheBuilder builder = dc.builder();

  350.             walk.addTree(tree);
  351.             walk.addTree(new DirCacheIterator(dc));
  352.             walk.setRecursive(true);

  354.             while (walk.next()) {
  355.                 AbstractTreeIterator cIter = walk.getTree(0,
  356.                         AbstractTreeIterator.class);
  357.                 if (cIter == null) {
  358.                     // Not in commit, don't add to new index
  359.                     continue;
  360.                 }

  362.                 final DirCacheEntry entry = new DirCacheEntry(walk.getRawPath());
  363.                 entry.setFileMode(cIter.getEntryFileMode());
  364.                 entry.setObjectIdFromRaw(cIter.idBuffer(), cIter.idOffset());

  366.                 DirCacheIterator dcIter = walk.getTree(1,
  367.                         DirCacheIterator.class);
  368.                 if (dcIter != null && dcIter.idEqual(cIter)) {
  369.                     DirCacheEntry indexEntry = dcIter.getDirCacheEntry();
  370.                     entry.setLastModified(indexEntry.getLastModifiedInstant());
  371.                     entry.setLength(indexEntry.getLength());
  372.                 }

  374.                 builder.add(entry);
  375.             }

  377.             builder.commit();
  378.         } finally {
  379.             dc.unlock();
  380.         }
  381.     }

  383.     private void resetUntracked(RevTree tree) throws CheckoutConflictException,
  384.             IOException {
  385.         Set<String> actuallyModifiedPaths = new HashSet<>();
  386.         WorkingTreeOptions options = repo.getConfig()
  387.                 .get(WorkingTreeOptions.KEY);
  388.         // TODO maybe NameConflictTreeWalk ?
  389.         try (TreeWalk walk = new TreeWalk(repo)) {
  390.             walk.addTree(tree);
  391.             walk.addTree(new FileTreeIterator(repo));
  392.             walk.setRecursive(true);

  394.             final ObjectReader reader = walk.getObjectReader();

  396.             while (walk.next()) {
  397.                 final AbstractTreeIterator cIter = walk.getTree(0,
  398.                         AbstractTreeIterator.class);
  399.                 if (cIter == null)
  400.                     // Not in commit, don't create untracked
  401.                     continue;

  403.                 final EolStreamType eolStreamType = walk
  404.                         .getEolStreamType(CHECKOUT_OP);
  405.                 final DirCacheEntry entry = new DirCacheEntry(walk.getRawPath());
  406.                 entry.setFileMode(cIter.getEntryFileMode());
  407.                 entry.setObjectIdFromRaw(cIter.idBuffer(), cIter.idOffset());

  409.                 FileTreeIterator fIter = walk
  410.                         .getTree(1, FileTreeIterator.class);
  411.                 if (fIter != null) {
  412.                     if (fIter.isModified(entry, true, reader)) {
  413.                         // file exists and is dirty
  414.                         throw new CheckoutConflictException(
  415.                                 entry.getPathString());
  416.                     }
  417.                 }

  419.                 checkoutPath(entry, reader, options,
  420.                         new CheckoutMetadata(eolStreamType, null));
  421.                 actuallyModifiedPaths.add(entry.getPathString());
  422.             }
  423.         } finally {
  424.             if (!actuallyModifiedPaths.isEmpty()) {
  425.                 repo.fireEvent(new WorkingTreeModifiedEvent(
  426.                         actuallyModifiedPaths, null));
  427.             }
  428.         }
  429.     }

  431.     private void checkoutPath(DirCacheEntry entry, ObjectReader reader,
  432.             WorkingTreeOptions options, CheckoutMetadata checkoutMetadata) {
  433.         try {
  434.             DirCacheCheckout.checkoutEntry(repo, entry, reader, true,
  435.                     checkoutMetadata, options);
  436.         } catch (IOException e) {
  437.             throw new JGitInternalException(MessageFormat.format(
  438.                     JGitText.get().checkoutConflictWithFile,
  439.                     entry.getPathString()), e);
  440.         }
  441.     }
  442. }
Created with JaCoCo 0.8.7.202105040129