PushProcess.java

  1. /*
  2.  * Copyright (C) 2008, 2022 Marek Zawirski <marek.zawirski@gmail.com> 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.  */

  11. package org.eclipse.jgit.transport;

  13. import java.io.IOException;
  14. import java.io.OutputStream;
  15. import java.text.MessageFormat;
  16. import java.util.Collection;
  17. import java.util.Collections;
  18. import java.util.LinkedHashMap;
  19. import java.util.List;
  20. import java.util.Map;
  21. import java.util.stream.Collectors;

  23. import org.eclipse.jgit.api.errors.AbortedByHookException;
  24. import org.eclipse.jgit.errors.MissingObjectException;
  25. import org.eclipse.jgit.errors.NotSupportedException;
  26. import org.eclipse.jgit.errors.TransportException;
  27. import org.eclipse.jgit.hooks.PrePushHook;
  28. import org.eclipse.jgit.internal.JGitText;
  29. import org.eclipse.jgit.lib.Constants;
  30. import org.eclipse.jgit.lib.ObjectId;
  31. import org.eclipse.jgit.lib.ProgressMonitor;
  32. import org.eclipse.jgit.lib.Ref;
  33. import org.eclipse.jgit.revwalk.RevCommit;
  34. import org.eclipse.jgit.revwalk.RevObject;
  35. import org.eclipse.jgit.revwalk.RevWalk;
  36. import org.eclipse.jgit.transport.RemoteRefUpdate.Status;

  38. /**
  39.  * Class performing push operation on remote repository.
  40.  *
  41.  * @see Transport#push(ProgressMonitor, Collection, OutputStream)
  42.  */
  43. class PushProcess {
  44.     /** Task name for {@link ProgressMonitor} used during opening connection. */
  45.     static final String PROGRESS_OPENING_CONNECTION = JGitText.get().openingConnection;

  47.     /** Transport used to perform this operation. */
  48.     private final Transport transport;

  50.     /** Push operation connection created to perform this operation */
  51.     private PushConnection connection;

  53.     /** Refs to update on remote side. */
  54.     private final Map<String, RemoteRefUpdate> toPush;

  56.     /** Revision walker for checking some updates properties. */
  57.     private final RevWalk walker;

  59.     /** an outputstream to write messages to */
  60.     private final OutputStream out;

  62.     /** A list of option strings associated with this push */
  63.     private List<String> pushOptions;

  65.     private final PrePushHook prePush;

  67.     /**
  68.      * Create process for specified transport and refs updates specification.
  69.      *
  70.      * @param transport
  71.      *            transport between remote and local repository, used to create
  72.      *            connection.
  73.      * @param toPush
  74.      *            specification of refs updates (and local tracking branches).
  75.      * @param prePush
  76.      *            {@link PrePushHook} to run after the remote advertisement has
  77.      *            been gotten
  78.      * @throws TransportException
  79.      */
  80.     PushProcess(Transport transport, Collection<RemoteRefUpdate> toPush,
  81.             PrePushHook prePush) throws TransportException {
  82.         this(transport, toPush, prePush, null);
  83.     }

  85.     /**
  86.      * Create process for specified transport and refs updates specification.
  87.      *
  88.      * @param transport
  89.      *            transport between remote and local repository, used to create
  90.      *            connection.
  91.      * @param toPush
  92.      *            specification of refs updates (and local tracking branches).
  93.      * @param prePush
  94.      *            {@link PrePushHook} to run after the remote advertisement has
  95.      *            been gotten
  96.      * @param out
  97.      *            OutputStream to write messages to
  98.      * @throws TransportException
  99.      */
  100.     PushProcess(Transport transport, Collection<RemoteRefUpdate> toPush,
  101.             PrePushHook prePush, OutputStream out) throws TransportException {
  102.         this.walker = new RevWalk(transport.local);
  103.         this.transport = transport;
  104.         this.toPush = new LinkedHashMap<>();
  105.         this.prePush = prePush;
  106.         this.out = out;
  107.         this.pushOptions = transport.getPushOptions();
  108.         for (RemoteRefUpdate rru : toPush) {
  109.             if (this.toPush.put(rru.getRemoteName(), rru) != null)
  110.                 throw new TransportException(MessageFormat.format(
  111.                         JGitText.get().duplicateRemoteRefUpdateIsIllegal, rru.getRemoteName()));
  112.         }
  113.     }

  115.     /**
  116.      * Perform push operation between local and remote repository - set remote
  117.      * refs appropriately, send needed objects and update local tracking refs.
  118.      * <p>
  119.      * When {@link Transport#isDryRun()} is true, result of this operation is
  120.      * just estimation of real operation result, no real action is performed.
  121.      *
  122.      * @param monitor
  123.      *            progress monitor used for feedback about operation.
  124.      * @return result of push operation with complete status description.
  125.      * @throws NotSupportedException
  126.      *             when push operation is not supported by provided transport.
  127.      * @throws TransportException
  128.      *             when some error occurred during operation, like I/O, protocol
  129.      *             error, or local database consistency error.
  130.      */
  131.     PushResult execute(ProgressMonitor monitor)
  132.             throws NotSupportedException, TransportException {
  133.         try {
  134.             monitor.beginTask(PROGRESS_OPENING_CONNECTION,
  135.                     ProgressMonitor.UNKNOWN);

  137.             final PushResult res = new PushResult();
  138.             connection = transport.openPush();
  139.             try {
  140.                 res.setAdvertisedRefs(transport.getURI(), connection
  141.                         .getRefsMap());
  142.                 res.peerUserAgent = connection.getPeerUserAgent();
  143.                 monitor.endTask();

  145.                 Map<String, RemoteRefUpdate> expanded = expandMatching();
  146.                 toPush.clear();
  147.                 toPush.putAll(expanded);

  149.                 res.setRemoteUpdates(toPush);
  150.                 final Map<String, RemoteRefUpdate> preprocessed = prepareRemoteUpdates();
  151.                 List<RemoteRefUpdate> willBeAttempted = preprocessed.values()
  152.                         .stream().filter(u -> {
  153.                             switch (u.getStatus()) {
  154.                             case NON_EXISTING:
  155.                             case REJECTED_NODELETE:
  156.                             case REJECTED_NONFASTFORWARD:
  157.                             case REJECTED_OTHER_REASON:
  158.                             case REJECTED_REMOTE_CHANGED:
  159.                             case UP_TO_DATE:
  160.                                 return false;
  161.                             default:
  162.                                 return true;
  163.                             }
  164.                         }).collect(Collectors.toList());
  165.                 if (!willBeAttempted.isEmpty()) {
  166.                     if (prePush != null) {
  167.                         try {
  168.                             prePush.setRefs(willBeAttempted);
  169.                             prePush.setDryRun(transport.isDryRun());
  170.                             prePush.call();
  171.                         } catch (AbortedByHookException | IOException e) {
  172.                             throw new TransportException(e.getMessage(), e);
  173.                         }
  174.                     }
  175.                 }
  176.                 if (transport.isDryRun())
  177.                     modifyUpdatesForDryRun();
  178.                 else if (!preprocessed.isEmpty())
  179.                     connection.push(monitor, preprocessed, out);
  180.             } finally {
  181.                 connection.close();
  182.                 res.addMessages(connection.getMessages());
  183.             }
  184.             if (!transport.isDryRun())
  185.                 updateTrackingRefs();
  186.             for (RemoteRefUpdate rru : toPush.values()) {
  187.                 final TrackingRefUpdate tru = rru.getTrackingRefUpdate();
  188.                 if (tru != null)
  189.                     res.add(tru);
  190.             }
  191.             return res;
  192.         } finally {
  193.             walker.close();
  194.         }
  195.     }

  197.     private Map<String, RemoteRefUpdate> prepareRemoteUpdates()
  198.             throws TransportException {
  199.         boolean atomic = transport.isPushAtomic();
  200.         final Map<String, RemoteRefUpdate> result = new LinkedHashMap<>();
  201.         for (RemoteRefUpdate rru : toPush.values()) {
  202.             final Ref advertisedRef = connection.getRef(rru.getRemoteName());
  203.             ObjectId advertisedOld = null;
  204.             if (advertisedRef != null) {
  205.                 advertisedOld = advertisedRef.getObjectId();
  206.             }
  207.             if (advertisedOld == null) {
  208.                 advertisedOld = ObjectId.zeroId();
  209.             }

  211.             if (rru.getNewObjectId().equals(advertisedOld)) {
  212.                 if (rru.isDelete()) {
  213.                     // ref does exist neither locally nor remotely
  214.                     rru.setStatus(Status.NON_EXISTING);
  215.                 } else {
  216.                     // same object - nothing to do
  217.                     rru.setStatus(Status.UP_TO_DATE);
  218.                 }
  219.                 continue;
  220.             }

  222.             // caller has explicitly specified expected old object id, while it
  223.             // has been changed in the mean time - reject
  224.             if (rru.isExpectingOldObjectId()
  225.                     && !rru.getExpectedOldObjectId().equals(advertisedOld)) {
  226.                 rru.setStatus(Status.REJECTED_REMOTE_CHANGED);
  227.                 if (atomic) {
  228.                     return rejectAll();
  229.                 }
  230.                 continue;
  231.             }
  232.             if (!rru.isExpectingOldObjectId()) {
  233.                 rru.setExpectedOldObjectId(advertisedOld);
  234.             }

  236.             // create ref (hasn't existed on remote side) and delete ref
  237.             // are always fast-forward commands, feasible at this level
  238.             if (advertisedOld.equals(ObjectId.zeroId()) || rru.isDelete()) {
  239.                 rru.setFastForward(true);
  240.                 result.put(rru.getRemoteName(), rru);
  241.                 continue;
  242.             }

  244.             boolean fastForward = isFastForward(advertisedOld,
  245.                     rru.getNewObjectId());
  246.             rru.setFastForward(fastForward);
  247.             if (!fastForward && !rru.isForceUpdate()) {
  248.                 rru.setStatus(Status.REJECTED_NONFASTFORWARD);
  249.                 if (atomic) {
  250.                     return rejectAll();
  251.                 }
  252.             } else {
  253.                 result.put(rru.getRemoteName(), rru);
  254.             }
  255.         }
  256.         return result;
  257.     }

  259.     /**
  260.      * Determines whether an update from {@code oldOid} to {@code newOid} is a
  261.      * fast-forward update:
  262.      * <ul>
  263.      * <li>both old and new must be commits, AND</li>
  264.      * <li>both of them must be known to us and exist in the repository,
  265.      * AND</li>
  266.      * <li>the old commit must be an ancestor of the new commit.</li>
  267.      * </ul>
  268.      *
  269.      * @param oldOid
  270.      *            {@link ObjectId} of the old commit
  271.      * @param newOid
  272.      *            {@link ObjectId} of the new commit
  273.      * @return {@code true} if the update fast-forwards, {@code false} otherwise
  274.      * @throws TransportException
  275.      */
  276.     private boolean isFastForward(ObjectId oldOid, ObjectId newOid)
  277.             throws TransportException {
  278.         try {
  279.             RevObject oldRev = walker.parseAny(oldOid);
  280.             RevObject newRev = walker.parseAny(newOid);
  281.             if (!(oldRev instanceof RevCommit) || !(newRev instanceof RevCommit)
  282.                     || !walker.isMergedInto((RevCommit) oldRev,
  283.                             (RevCommit) newRev)) {
  284.                 return false;
  285.             }
  286.         } catch (MissingObjectException x) {
  287.             return false;
  288.         } catch (Exception x) {
  289.             throw new TransportException(transport.getURI(),
  290.                     MessageFormat.format(JGitText
  291.                             .get().readingObjectsFromLocalRepositoryFailed,
  292.                             x.getMessage()),
  293.                     x);
  294.         }
  295.         return true;
  296.     }

  298.     /**
  299.      * Expands all placeholder {@link RemoteRefUpdate}s for "matching"
  300.      * {@link RefSpec}s ":" in {@link #toPush} and returns the resulting map in
  301.      * which the placeholders have been replaced by their expansion.
  302.      *
  303.      * @return a new map of {@link RemoteRefUpdate}s keyed by remote name
  304.      * @throws TransportException
  305.      *             if the expansion results in duplicate updates
  306.      */
  307.     private Map<String, RemoteRefUpdate> expandMatching()
  308.             throws TransportException {
  309.         Map<String, RemoteRefUpdate> result = new LinkedHashMap<>();
  310.         boolean hadMatch = false;
  311.         for (RemoteRefUpdate update : toPush.values()) {
  312.             if (update.isMatching()) {
  313.                 if (hadMatch) {
  314.                     throw new TransportException(MessageFormat.format(
  315.                             JGitText.get().duplicateRemoteRefUpdateIsIllegal,
  316.                             ":")); //$NON-NLS-1$
  317.                 }
  318.                 expandMatching(result, update);
  319.                 hadMatch = true;
  320.             } else if (result.put(update.getRemoteName(), update) != null) {
  321.                 throw new TransportException(MessageFormat.format(
  322.                         JGitText.get().duplicateRemoteRefUpdateIsIllegal,
  323.                         update.getRemoteName()));
  324.             }
  325.         }
  326.         return result;
  327.     }

  329.     /**
  330.      * Expands the placeholder {@link RemoteRefUpdate} {@code match} for a
  331.      * "matching" {@link RefSpec} ":" or "+:" and puts the expansion into the
  332.      * given map {@code updates}.
  333.      *
  334.      * @param updates
  335.      *            map to put the expansion in
  336.      * @param match
  337.      *            the placeholder {@link RemoteRefUpdate} to expand
  338.      *
  339.      * @throws TransportException
  340.      *             if the expansion results in duplicate updates, or the local
  341.      *             branches cannot be determined
  342.      */
  343.     private void expandMatching(Map<String, RemoteRefUpdate> updates,
  344.             RemoteRefUpdate match) throws TransportException {
  345.         try {
  346.             Map<String, Ref> advertisement = connection.getRefsMap();
  347.             Collection<RefSpec> fetchSpecs = match.getFetchSpecs();
  348.             boolean forceUpdate = match.isForceUpdate();
  349.             for (Ref local : transport.local.getRefDatabase()
  350.                     .getRefsByPrefix(Constants.R_HEADS)) {
  351.                 if (local.isSymbolic()) {
  352.                     continue;
  353.                 }
  354.                 String name = local.getName();
  355.                 Ref advertised = advertisement.get(name);
  356.                 if (advertised == null || advertised.isSymbolic()) {
  357.                     continue;
  358.                 }
  359.                 ObjectId oldOid = advertised.getObjectId();
  360.                 if (oldOid == null || ObjectId.zeroId().equals(oldOid)) {
  361.                     continue;
  362.                 }
  363.                 ObjectId newOid = local.getObjectId();
  364.                 if (newOid == null || ObjectId.zeroId().equals(newOid)) {
  365.                     continue;
  366.                 }

  368.                 RemoteRefUpdate rru = new RemoteRefUpdate(transport.local, name,
  369.                         newOid, name, forceUpdate,
  370.                         Transport.findTrackingRefName(name, fetchSpecs),
  371.                         oldOid);
  372.                 if (updates.put(rru.getRemoteName(), rru) != null) {
  373.                     throw new TransportException(MessageFormat.format(
  374.                             JGitText.get().duplicateRemoteRefUpdateIsIllegal,
  375.                             rru.getRemoteName()));
  376.                 }
  377.             }
  378.         } catch (IOException x) {
  379.             throw new TransportException(transport.getURI(),
  380.                     MessageFormat.format(JGitText
  381.                             .get().readingObjectsFromLocalRepositoryFailed,
  382.                             x.getMessage()),
  383.                     x);
  384.         }
  385.     }

  387.     private Map<String, RemoteRefUpdate> rejectAll() {
  388.         for (RemoteRefUpdate rru : toPush.values()) {
  389.             if (rru.getStatus() == Status.NOT_ATTEMPTED) {
  390.                 rru.setStatus(RemoteRefUpdate.Status.REJECTED_OTHER_REASON);
  391.                 rru.setMessage(JGitText.get().transactionAborted);
  392.             }
  393.         }
  394.         return Collections.emptyMap();
  395.     }

  397.     private void modifyUpdatesForDryRun() {
  398.         for (RemoteRefUpdate rru : toPush.values())
  399.             if (rru.getStatus() == Status.NOT_ATTEMPTED)
  400.                 rru.setStatus(Status.OK);
  401.     }

  403.     private void updateTrackingRefs() {
  404.         for (RemoteRefUpdate rru : toPush.values()) {
  405.             final Status status = rru.getStatus();
  406.             if (rru.hasTrackingRefUpdate()
  407.                     && (status == Status.UP_TO_DATE || status == Status.OK)) {
  408.                 // update local tracking branch only when there is a chance that
  409.                 // it has changed; this is possible for:
  410.                 // -updated (OK) status,
  411.                 // -up to date (UP_TO_DATE) status
  412.                 try {
  413.                     rru.updateTrackingRef(walker);
  414.                 } catch (IOException e) {
  415.                     // ignore as RefUpdate has stored I/O error status
  416.                 }
  417.             }
  418.         }
  419.     }

  421.     /**
  422.      * Gets the list of option strings associated with this push.
  423.      *
  424.      * @return pushOptions
  425.      * @since 4.5
  426.      */
  427.     public List<String> getPushOptions() {
  428.         return pushOptions;
  429.     }
  430. }
Created with JaCoCo 0.8.7.202105040129