BranchTrackingStatus.java

  1. /*
  2.  * Copyright (C) 2011, Robin Stocker <robin@nibor.org>
  3.  * Copyright (C) 2012, Matthias Sohn <matthias.sohn@sap.com>
  4.  * and other copyright owners as documented in the project's IP log.
  5.  *
  6.  * This program and the accompanying materials are made available
  7.  * under the terms of the Eclipse Distribution License v1.0 which
  8.  * accompanies this distribution, is reproduced below, and is
  9.  * available at http://www.eclipse.org/org/documents/edl-v10.php
  10.  *
  11.  * All rights reserved.
  12.  *
  13.  * Redistribution and use in source and binary forms, with or
  14.  * without modification, are permitted provided that the following
  15.  * conditions are met:
  16.  *
  17.  * - Redistributions of source code must retain the above copyright
  18.  *   notice, this list of conditions and the following disclaimer.
  19.  *
  20.  * - Redistributions in binary form must reproduce the above
  21.  *   copyright notice, this list of conditions and the following
  22.  *   disclaimer in the documentation and/or other materials provided
  23.  *   with the distribution.
  24.  *
  25.  * - Neither the name of the Eclipse Foundation, Inc. nor the
  26.  *   names of its contributors may be used to endorse or promote
  27.  *   products derived from this software without specific prior
  28.  *   written permission.
  29.  *
  30.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  31.  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  32.  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  33.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  34.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  35.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  36.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  37.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  38.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  39.  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  40.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  41.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  42.  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  43.  */

  44. package org.eclipse.jgit.lib;

  45. import java.io.IOException;

  46. import org.eclipse.jgit.revwalk.RevCommit;
  47. import org.eclipse.jgit.revwalk.RevWalk;
  48. import org.eclipse.jgit.revwalk.RevWalkUtils;
  49. import org.eclipse.jgit.revwalk.filter.RevFilter;

  50. /**
  51.  * Status of a branch's relation to its remote-tracking branch.
  52.  */
  53. public class BranchTrackingStatus {

  54.     /**
  55.      * Compute the tracking status for the <code>branchName</code> in
  56.      * <code>repository</code>.
  57.      *
  58.      * @param repository
  59.      *            the git repository to compute the status from
  60.      * @param branchName
  61.      *            the local branch
  62.      * @return the tracking status, or null if it is not known
  63.      * @throws java.io.IOException
  64.      */
  65.     public static BranchTrackingStatus of(Repository repository, String branchName)
  66.             throws IOException {

  67.         String shortBranchName = Repository.shortenRefName(branchName);
  68.         String fullBranchName = Constants.R_HEADS + shortBranchName;
  69.         BranchConfig branchConfig = new BranchConfig(repository.getConfig(),
  70.                 shortBranchName);

  71.         String trackingBranch = branchConfig.getTrackingBranch();
  72.         if (trackingBranch == null)
  73.             return null;

  74.         Ref tracking = repository.exactRef(trackingBranch);
  75.         if (tracking == null)
  76.             return null;

  77.         Ref local = repository.exactRef(fullBranchName);
  78.         if (local == null)
  79.             return null;

  80.         try (RevWalk walk = new RevWalk(repository)) {

  81.             RevCommit localCommit = walk.parseCommit(local.getObjectId());
  82.             RevCommit trackingCommit = walk.parseCommit(tracking.getObjectId());

  83.             walk.setRevFilter(RevFilter.MERGE_BASE);
  84.             walk.markStart(localCommit);
  85.             walk.markStart(trackingCommit);
  86.             RevCommit mergeBase = walk.next();

  87.             walk.reset();
  88.             walk.setRevFilter(RevFilter.ALL);
  89.             int aheadCount = RevWalkUtils.count(walk, localCommit, mergeBase);
  90.             int behindCount = RevWalkUtils.count(walk, trackingCommit,
  91.                     mergeBase);

  92.             return new BranchTrackingStatus(trackingBranch, aheadCount,
  93.                     behindCount);
  94.         }
  95.     }

  96.     private final String remoteTrackingBranch;

  97.     private final int aheadCount;

  98.     private final int behindCount;

  99.     private BranchTrackingStatus(String remoteTrackingBranch, int aheadCount,
  100.             int behindCount) {
  101.         this.remoteTrackingBranch = remoteTrackingBranch;
  102.         this.aheadCount = aheadCount;
  103.         this.behindCount = behindCount;
  104.     }

  105.     /**
  106.      * Get full remote-tracking branch name
  107.      *
  108.      * @return full remote-tracking branch name
  109.      */
  110.     public String getRemoteTrackingBranch() {
  111.         return remoteTrackingBranch;
  112.     }

  113.     /**
  114.      * Get number of commits that the local branch is ahead of the
  115.      * remote-tracking branch
  116.      *
  117.      * @return number of commits that the local branch is ahead of the
  118.      *         remote-tracking branch
  119.      */
  120.     public int getAheadCount() {
  121.         return aheadCount;
  122.     }

  123.     /**
  124.      * Get number of commits that the local branch is behind of the
  125.      * remote-tracking branch
  126.      *
  127.      * @return number of commits that the local branch is behind of the
  128.      *         remote-tracking branch
  129.      */
  130.     public int getBehindCount() {
  131.         return behindCount;
  132.     }
  133. }