All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.google.gerrit.server.restapi.project.ListBranches Maven / Gradle / Ivy
// Copyright (C) 2013 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gerrit.server.restapi.project;
import static com.google.gerrit.entities.RefNames.isConfigRef;
import com.google.common.collect.ComparisonChain;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Sets;
import com.google.gerrit.entities.RefNames;
import com.google.gerrit.extensions.api.projects.BranchInfo;
import com.google.gerrit.extensions.api.projects.ProjectApi.ListRefsRequest;
import com.google.gerrit.extensions.common.ActionInfo;
import com.google.gerrit.extensions.common.WebLinkInfo;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.ResourceNotFoundException;
import com.google.gerrit.extensions.restapi.Response;
import com.google.gerrit.extensions.restapi.RestApiException;
import com.google.gerrit.extensions.restapi.RestReadView;
import com.google.gerrit.extensions.restapi.RestView;
import com.google.gerrit.extensions.webui.UiAction;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.WebLinks;
import com.google.gerrit.server.extensions.webui.UiActions;
import com.google.gerrit.server.git.GitRepositoryManager;
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.permissions.RefPermission;
import com.google.gerrit.server.project.BranchResource;
import com.google.gerrit.server.project.ProjectResource;
import com.google.gerrit.server.project.ProjectState;
import com.google.gerrit.server.project.RefFilter;
import com.google.inject.Inject;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.List;
import java.util.Set;
import java.util.TreeMap;
import org.eclipse.jgit.errors.RepositoryNotFoundException;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.lib.Repository;
import org.kohsuke.args4j.Option;
public class ListBranches implements RestReadView {
private final GitRepositoryManager repoManager;
private final PermissionBackend permissionBackend;
private final DynamicMap> branchViews;
private final UiActions uiActions;
private final WebLinks webLinks;
@Option(
name = "--limit",
aliases = {"-n"},
metaVar = "CNT",
usage = "maximum number of branches to list")
public void setLimit(int limit) {
this.limit = limit;
}
@Option(
name = "--start",
aliases = {"-S", "-s"},
metaVar = "CNT",
usage = "number of branches to skip")
public void setStart(int start) {
this.start = start;
}
@Option(
name = "--match",
aliases = {"-m"},
metaVar = "MATCH",
usage = "match branches substring")
public void setMatchSubstring(String matchSubstring) {
this.matchSubstring = matchSubstring;
}
@Option(
name = "--regex",
aliases = {"-r"},
metaVar = "REGEX",
usage = "match branches regex")
public void setMatchRegex(String matchRegex) {
this.matchRegex = matchRegex;
}
private int limit;
private int start;
private String matchSubstring;
private String matchRegex;
@Inject
public ListBranches(
GitRepositoryManager repoManager,
PermissionBackend permissionBackend,
DynamicMap> branchViews,
UiActions uiActions,
WebLinks webLinks) {
this.repoManager = repoManager;
this.permissionBackend = permissionBackend;
this.branchViews = branchViews;
this.uiActions = uiActions;
this.webLinks = webLinks;
}
public ListBranches request(ListRefsRequest request) {
this.setLimit(request.getLimit());
this.setStart(request.getStart());
this.setMatchSubstring(request.getSubstring());
this.setMatchRegex(request.getRegex());
return this;
}
@Override
public Response> apply(ProjectResource rsrc)
throws RestApiException, IOException, PermissionBackendException {
rsrc.getProjectState().checkStatePermitsRead();
return Response.ok(
new RefFilter(Constants.R_HEADS)
.subString(matchSubstring)
.regex(matchRegex)
.start(start)
.limit(limit)
.filter(allBranches(rsrc)));
}
BranchInfo toBranchInfo(BranchResource rsrc)
throws IOException, ResourceNotFoundException, PermissionBackendException {
try (Repository db = repoManager.openRepository(rsrc.getNameKey())) {
String refName = rsrc.getRef();
if (RefNames.isRefsUsersSelf(refName, rsrc.getProjectState().isAllUsers())) {
refName = RefNames.refsUsers(rsrc.getUser().getAccountId());
}
Ref r = db.exactRef(refName);
if (r == null) {
throw new ResourceNotFoundException();
}
return toBranchInfo(rsrc, ImmutableList.of(r)).get(0);
} catch (RepositoryNotFoundException noRepo) {
throw new ResourceNotFoundException(rsrc.getNameKey().get(), noRepo);
}
}
private List allBranches(ProjectResource rsrc)
throws IOException, ResourceNotFoundException, PermissionBackendException {
List[ refs;
try (Repository db = repoManager.openRepository(rsrc.getNameKey())) {
Collection][ heads = db.getRefDatabase().getRefsByPrefix(Constants.R_HEADS);
refs = new ArrayList<>(heads.size() + 3);
refs.addAll(heads);
refs.addAll(
db.getRefDatabase()
.exactRef(Constants.HEAD, RefNames.REFS_CONFIG, RefNames.REFS_USERS_DEFAULT)
.values());
} catch (RepositoryNotFoundException noGitRepository) {
throw new ResourceNotFoundException(rsrc.getNameKey().get(), noGitRepository);
}
return toBranchInfo(rsrc, refs);
}
private List] toBranchInfo(ProjectResource rsrc, List[ refs)
throws PermissionBackendException {
Set] targets = Sets.newHashSetWithExpectedSize(1);
for (Ref ref : refs) {
if (ref.isSymbolic()) {
targets.add(ref.getTarget().getName());
}
}
PermissionBackend.ForProject perm = permissionBackend.currentUser().project(rsrc.getNameKey());
List branches = new ArrayList<>(refs.size());
for (Ref ref : refs) {
if (ref.isSymbolic()) {
// A symbolic reference to another branch, instead of
// showing the resolved value, show the name it references.
//
String target = ref.getTarget().getName();
try {
perm.ref(target).check(RefPermission.READ);
} catch (AuthException e) {
continue;
}
if (target.startsWith(Constants.R_HEADS)) {
target = target.substring(Constants.R_HEADS.length());
}
BranchInfo b = new BranchInfo();
b.ref = ref.getName();
b.revision = target;
branches.add(b);
if (!Constants.HEAD.equals(ref.getName())) {
if (isConfigRef(ref.getName())) {
// Never allow to delete the meta config branch.
b.canDelete = null;
} else {
b.canDelete =
perm.ref(ref.getName()).testOrFalse(RefPermission.DELETE)
&& rsrc.getProjectState().statePermitsWrite()
? true
: null;
}
}
continue;
}
try {
perm.ref(ref.getName()).check(RefPermission.READ);
branches.add(
createBranchInfo(
perm.ref(ref.getName()), ref, rsrc.getProjectState(), rsrc.getUser(), targets));
} catch (AuthException e) {
// Do nothing.
}
}
branches.sort(new BranchComparator());
return branches;
}
private static class BranchComparator implements Comparator {
@Override
public int compare(BranchInfo a, BranchInfo b) {
return ComparisonChain.start()
.compareTrueFirst(isHead(a), isHead(b))
.compareTrueFirst(isConfig(a), isConfig(b))
.compare(a.ref, b.ref)
.result();
}
private static boolean isHead(BranchInfo i) {
return Constants.HEAD.equals(i.ref);
}
private static boolean isConfig(BranchInfo i) {
return RefNames.REFS_CONFIG.equals(i.ref);
}
}
private BranchInfo createBranchInfo(
PermissionBackend.ForRef perm,
Ref ref,
ProjectState projectState,
CurrentUser user,
Set targets) {
BranchInfo info = new BranchInfo();
info.ref = ref.getName();
info.revision = ref.getObjectId() != null ? ref.getObjectId().name() : null;
if (isConfigRef(ref.getName())) {
// Never allow to delete the meta config branch.
info.canDelete = null;
} else {
info.canDelete =
!targets.contains(ref.getName())
&& perm.testOrFalse(RefPermission.DELETE)
&& projectState.statePermitsWrite()
? true
: null;
}
BranchResource rsrc = new BranchResource(projectState, user, ref);
for (UiAction.Description d : uiActions.from(branchViews, rsrc)) {
if (info.actions == null) {
info.actions = new TreeMap<>();
}
info.actions.put(d.getId(), new ActionInfo(d));
}
ImmutableList links =
webLinks.getBranchLinks(projectState.getName(), ref.getName());
info.webLinks = links.isEmpty() ? null : links;
return info;
}
}
