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
45 package org.eclipse.jgit.lib;
46
47 import java.io.IOException;
48
49 import org.eclipse.jgit.revwalk.RevCommit;
50 import org.eclipse.jgit.revwalk.RevWalk;
51 import org.eclipse.jgit.revwalk.RevWalkUtils;
52 import org.eclipse.jgit.revwalk.filter.RevFilter;
53
54 /**
55 * Status of a branch's relation to its remote-tracking branch.
56 */
57 public class BranchTrackingStatus {
58
59 /**
60 * Compute the tracking status for the <code>branchName</code> in
61 * <code>repository</code>.
62 *
63 * @param repository
64 * the git repository to compute the status from
65 * @param branchName
66 * the local branch
67 * @return the tracking status, or null if it is not known
68 * @throws java.io.IOException
69 */
70 public static BranchTrackingStatus of(Repository repository, String branchName)
71 throws IOException {
72
73 String shortBranchName = Repository.shortenRefName(branchName);
74 String fullBranchName = Constants.R_HEADS + shortBranchName;
75 BranchConfig branchConfig = new BranchConfig(repository.getConfig(),
76 shortBranchName);
77
78 String trackingBranch = branchConfig.getTrackingBranch();
79 if (trackingBranch == null)
80 return null;
81
82 Ref tracking = repository.exactRef(trackingBranch);
83 if (tracking == null)
84 return null;
85
86 Ref local = repository.exactRef(fullBranchName);
87 if (local == null)
88 return null;
89
90 try (RevWalkvWalk.html#RevWalk">RevWalk walk = new RevWalk(repository)) {
91
92 RevCommit localCommit = walk.parseCommit(local.getObjectId());
93 RevCommit trackingCommit = walk.parseCommit(tracking.getObjectId());
94
95 walk.setRevFilter(RevFilter.MERGE_BASE);
96 walk.markStart(localCommit);
97 walk.markStart(trackingCommit);
98 RevCommit mergeBase = walk.next();
99
100 walk.reset();
101 walk.setRevFilter(RevFilter.ALL);
102 int aheadCount = RevWalkUtils.count(walk, localCommit, mergeBase);
103 int behindCount = RevWalkUtils.count(walk, trackingCommit,
104 mergeBase);
105
106 return new BranchTrackingStatus(trackingBranch, aheadCount,
107 behindCount);
108 }
109 }
110
111 private final String remoteTrackingBranch;
112
113 private final int aheadCount;
114
115 private final int behindCount;
116
117 private BranchTrackingStatus(String remoteTrackingBranch, int aheadCount,
118 int behindCount) {
119 this.remoteTrackingBranch = remoteTrackingBranch;
120 this.aheadCount = aheadCount;
121 this.behindCount = behindCount;
122 }
123
124 /**
125 * Get full remote-tracking branch name
126 *
127 * @return full remote-tracking branch name
128 */
129 public String getRemoteTrackingBranch() {
130 return remoteTrackingBranch;
131 }
132
133 /**
134 * Get number of commits that the local branch is ahead of the
135 * remote-tracking branch
136 *
137 * @return number of commits that the local branch is ahead of the
138 * remote-tracking branch
139 */
140 public int getAheadCount() {
141 return aheadCount;
142 }
143
144 /**
145 * Get number of commits that the local branch is behind of the
146 * remote-tracking branch
147 *
148 * @return number of commits that the local branch is behind of the
149 * remote-tracking branch
150 */
151 public int getBehindCount() {
152 return behindCount;
153 }
154 }