com.google.gerrit.server.restapi.change.GetRelated 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.change;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.google.common.flogger.FluentLogger;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.PatchSet;
import com.google.gerrit.entities.Project;
import com.google.gerrit.entities.SubmitRequirementResult;
import com.google.gerrit.extensions.api.changes.GetRelatedOption;
import com.google.gerrit.extensions.api.changes.RelatedChangeAndCommitInfo;
import com.google.gerrit.extensions.api.changes.RelatedChangesInfo;
import com.google.gerrit.extensions.common.CommitInfo;
import com.google.gerrit.extensions.restapi.Response;
import com.google.gerrit.extensions.restapi.RestReadView;
import com.google.gerrit.server.ChangeUtil;
import com.google.gerrit.server.CommonConverters;
import com.google.gerrit.server.change.GetRelatedChangesUtil;
import com.google.gerrit.server.change.RelatedChangesSorter;
import com.google.gerrit.server.change.RevisionResource;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.project.NoSuchProjectException;
import com.google.gerrit.server.query.change.ChangeData;
import com.google.inject.Inject;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import org.eclipse.jgit.revwalk.RevCommit;
import org.kohsuke.args4j.Option;
public class GetRelated implements RestReadView {
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
private final ChangeData.Factory changeDataFactory;
private final GetRelatedChangesUtil getRelatedChangesUtil;
private boolean computeSubmittable = false;
@Inject
GetRelated(ChangeData.Factory changeDataFactory, GetRelatedChangesUtil getRelatedChangesUtil) {
this.changeDataFactory = changeDataFactory;
this.getRelatedChangesUtil = getRelatedChangesUtil;
}
@Option(name = "-o", usage = "Options")
public void addOption(GetRelatedOption option) {
if (option == GetRelatedOption.SUBMITTABLE) {
computeSubmittable = true;
} else {
throw new IllegalArgumentException("option not recognized: " + option);
}
}
@Override
public Response apply(RevisionResource rsrc)
throws IOException, NoSuchProjectException, PermissionBackendException {
RelatedChangesInfo relatedChangesInfo = new RelatedChangesInfo();
relatedChangesInfo.changes = getRelated(rsrc);
return Response.ok(relatedChangesInfo);
}
public ImmutableList getRelated(RevisionResource rsrc)
throws IOException, PermissionBackendException {
boolean isEdit = rsrc.getEdit().isPresent();
PatchSet basePs = isEdit ? rsrc.getEdit().get().getBasePatchSet() : rsrc.getPatchSet();
logger.atFine().log("isEdit = %s, basePs = %s", isEdit, basePs);
List sortedResult =
getRelatedChangesUtil.getRelated(changeDataFactory.create(rsrc.getNotes()), basePs);
List result = new ArrayList<>(sortedResult.size());
for (RelatedChangesSorter.PatchSetData d : sortedResult) {
PatchSet ps = d.patchSet();
RevCommit commit;
if (isEdit && ps.id().equals(basePs.id())) {
// Replace base of an edit with the edit itself.
ps = rsrc.getPatchSet();
commit = rsrc.getEdit().get().getEditCommit();
logger.atFine().log(
"Replaced base of edit (patch set %s, commit %s) with edit (patch set %s, commit %s)",
d.patchSet().id(), d.commit(), ps.id(), commit);
} else {
commit = d.commit();
}
result.add(newChangeAndCommit(rsrc.getProject(), d.data(), ps, commit));
}
if (result.size() == 1) {
RelatedChangeAndCommitInfo r = result.get(0);
if (r.commit != null && r.commit.commit.equals(rsrc.getPatchSet().commitId().name())) {
return ImmutableList.of();
}
}
return ImmutableList.copyOf(result);
}
private RelatedChangeAndCommitInfo newChangeAndCommit(
Project.NameKey project, ChangeData cd, @Nullable PatchSet ps, RevCommit c) {
RelatedChangeAndCommitInfo info = new RelatedChangeAndCommitInfo();
info.project = project.get();
Change change = cd.change();
if (change != null) {
info.changeId = change.getKey().get();
info._changeNumber = change.getChangeId();
info._revisionNumber = ps != null ? ps.number() : null;
PatchSet.Id curr = change.currentPatchSetId();
info._currentRevisionNumber = curr != null ? curr.get() : null;
info.status = ChangeUtil.status(change).toUpperCase(Locale.US);
info.submittable = computeSubmittable ? submittable(cd) : null;
}
info.commit = new CommitInfo();
info.commit.commit = c.name();
info.commit.parents = Lists.newArrayListWithCapacity(c.getParentCount());
for (int i = 0; i < c.getParentCount(); i++) {
CommitInfo p = new CommitInfo();
p.commit = c.getParent(i).name();
info.commit.parents.add(p);
}
info.commit.author = CommonConverters.toGitPerson(c.getAuthorIdent());
info.commit.subject = c.getShortMessage();
return info;
}
private static boolean submittable(ChangeData cd) {
return cd.submitRequirementsIncludingLegacy().values().stream()
.allMatch(SubmitRequirementResult::fulfilled);
}
}