diff options
Diffstat (limited to 'gerrit-server/src/main/java/com/google/gerrit/server/change/DeleteReviewerOp.java')
| -rw-r--r-- | gerrit-server/src/main/java/com/google/gerrit/server/change/DeleteReviewerOp.java | 253 |
1 files changed, 253 insertions, 0 deletions
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/change/DeleteReviewerOp.java b/gerrit-server/src/main/java/com/google/gerrit/server/change/DeleteReviewerOp.java new file mode 100644 index 0000000000..ad1cf60b09 --- /dev/null +++ b/gerrit-server/src/main/java/com/google/gerrit/server/change/DeleteReviewerOp.java @@ -0,0 +1,253 @@ +// Copyright (C) 2017 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.change; + +import com.google.common.collect.Iterables; +import com.google.gerrit.common.data.LabelType; +import com.google.gerrit.common.data.LabelTypes; +import com.google.gerrit.extensions.api.changes.DeleteReviewerInput; +import com.google.gerrit.extensions.api.changes.NotifyHandling; +import com.google.gerrit.extensions.restapi.AuthException; +import com.google.gerrit.extensions.restapi.ResourceNotFoundException; +import com.google.gerrit.reviewdb.client.Account; +import com.google.gerrit.reviewdb.client.Change; +import com.google.gerrit.reviewdb.client.ChangeMessage; +import com.google.gerrit.reviewdb.client.PatchSet; +import com.google.gerrit.reviewdb.client.PatchSetApproval; +import com.google.gerrit.reviewdb.client.Project; +import com.google.gerrit.reviewdb.server.ReviewDb; +import com.google.gerrit.reviewdb.server.ReviewDbUtil; +import com.google.gerrit.server.ApprovalsUtil; +import com.google.gerrit.server.ChangeMessagesUtil; +import com.google.gerrit.server.IdentifiedUser; +import com.google.gerrit.server.PatchSetUtil; +import com.google.gerrit.server.extensions.events.ReviewerDeleted; +import com.google.gerrit.server.mail.send.DeleteReviewerSender; +import com.google.gerrit.server.notedb.ChangeUpdate; +import com.google.gerrit.server.notedb.NoteDbChangeState.PrimaryStorage; +import com.google.gerrit.server.notedb.NotesMigration; +import com.google.gerrit.server.permissions.PermissionBackendException; +import com.google.gerrit.server.project.NoSuchProjectException; +import com.google.gerrit.server.project.ProjectCache; +import com.google.gerrit.server.project.RemoveReviewerControl; +import com.google.gerrit.server.update.BatchUpdateOp; +import com.google.gerrit.server.update.BatchUpdateReviewDb; +import com.google.gerrit.server.update.ChangeContext; +import com.google.gerrit.server.update.Context; +import com.google.gwtorm.server.OrmException; +import com.google.inject.Inject; +import com.google.inject.Provider; +import com.google.inject.assistedinject.Assisted; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class DeleteReviewerOp implements BatchUpdateOp { + private static final Logger log = LoggerFactory.getLogger(DeleteReviewer.class); + + public interface Factory { + DeleteReviewerOp create(Account reviewerAccount, DeleteReviewerInput input); + } + + private final ApprovalsUtil approvalsUtil; + private final PatchSetUtil psUtil; + private final ChangeMessagesUtil cmUtil; + private final IdentifiedUser.GenericFactory userFactory; + private final ReviewerDeleted reviewerDeleted; + private final Provider<IdentifiedUser> user; + private final DeleteReviewerSender.Factory deleteReviewerSenderFactory; + private final NotesMigration migration; + private final NotifyUtil notifyUtil; + private final RemoveReviewerControl removeReviewerControl; + private final ProjectCache projectCache; + + private final Account reviewer; + private final DeleteReviewerInput input; + + ChangeMessage changeMessage; + Change currChange; + PatchSet currPs; + Map<String, Short> newApprovals = new HashMap<>(); + Map<String, Short> oldApprovals = new HashMap<>(); + + @Inject + DeleteReviewerOp( + ApprovalsUtil approvalsUtil, + PatchSetUtil psUtil, + ChangeMessagesUtil cmUtil, + IdentifiedUser.GenericFactory userFactory, + ReviewerDeleted reviewerDeleted, + Provider<IdentifiedUser> user, + DeleteReviewerSender.Factory deleteReviewerSenderFactory, + NotesMigration migration, + NotifyUtil notifyUtil, + RemoveReviewerControl removeReviewerControl, + ProjectCache projectCache, + @Assisted Account reviewerAccount, + @Assisted DeleteReviewerInput input) { + this.approvalsUtil = approvalsUtil; + this.psUtil = psUtil; + this.cmUtil = cmUtil; + this.userFactory = userFactory; + this.reviewerDeleted = reviewerDeleted; + this.user = user; + this.deleteReviewerSenderFactory = deleteReviewerSenderFactory; + this.migration = migration; + this.notifyUtil = notifyUtil; + this.removeReviewerControl = removeReviewerControl; + this.projectCache = projectCache; + this.reviewer = reviewerAccount; + this.input = input; + } + + @Override + public boolean updateChange(ChangeContext ctx) + throws AuthException, ResourceNotFoundException, OrmException, PermissionBackendException, + IOException, NoSuchProjectException { + Account.Id reviewerId = reviewer.getId(); + // Check of removing this reviewer (even if there is no vote processed by the loop below) is OK + removeReviewerControl.checkRemoveReviewer(ctx.getNotes(), ctx.getUser(), reviewerId); + + if (!approvalsUtil.getReviewers(ctx.getDb(), ctx.getNotes()).all().contains(reviewerId)) { + throw new ResourceNotFoundException(); + } + currChange = ctx.getChange(); + currPs = psUtil.current(ctx.getDb(), ctx.getNotes()); + + LabelTypes labelTypes = + projectCache.checkedGet(ctx.getProject()).getLabelTypes(ctx.getNotes(), ctx.getUser()); + // removing a reviewer will remove all her votes + for (LabelType lt : labelTypes.getLabelTypes()) { + newApprovals.put(lt.getName(), (short) 0); + } + + StringBuilder msg = new StringBuilder(); + msg.append("Removed reviewer " + reviewer.getFullName()); + StringBuilder removedVotesMsg = new StringBuilder(); + removedVotesMsg.append(" with the following votes:\n\n"); + List<PatchSetApproval> del = new ArrayList<>(); + boolean votesRemoved = false; + for (PatchSetApproval a : approvals(ctx, reviewerId)) { + // Check if removing this vote is OK + removeReviewerControl.checkRemoveReviewer(ctx.getNotes(), ctx.getUser(), a); + del.add(a); + if (a.getPatchSetId().equals(currPs.getId()) && a.getValue() != 0) { + oldApprovals.put(a.getLabel(), a.getValue()); + removedVotesMsg + .append("* ") + .append(a.getLabel()) + .append(formatLabelValue(a.getValue())) + .append(" by ") + .append(userFactory.create(a.getAccountId()).getNameEmail()) + .append("\n"); + votesRemoved = true; + } + } + + if (votesRemoved) { + msg.append(removedVotesMsg); + } else { + msg.append("."); + } + ctx.getDb().patchSetApprovals().delete(del); + ChangeUpdate update = ctx.getUpdate(currPs.getId()); + update.removeReviewer(reviewerId); + + changeMessage = + ChangeMessagesUtil.newMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_DELETE_REVIEWER); + cmUtil.addChangeMessage(ctx.getDb(), update, changeMessage); + + return true; + } + + @Override + public void postUpdate(Context ctx) { + if (input.notify == null) { + if (currChange.isWorkInProgress()) { + input.notify = oldApprovals.isEmpty() ? NotifyHandling.NONE : NotifyHandling.OWNER; + } else { + input.notify = NotifyHandling.ALL; + } + } + if (NotifyUtil.shouldNotify(input.notify, input.notifyDetails)) { + emailReviewers(ctx.getProject(), currChange, changeMessage); + } + reviewerDeleted.fire( + currChange, + currPs, + reviewer, + ctx.getAccount(), + changeMessage.getMessage(), + newApprovals, + oldApprovals, + input.notify, + ctx.getWhen()); + } + + private Iterable<PatchSetApproval> approvals(ChangeContext ctx, Account.Id accountId) + throws OrmException { + Change.Id changeId = ctx.getNotes().getChangeId(); + Iterable<PatchSetApproval> approvals; + PrimaryStorage r = PrimaryStorage.of(ctx.getChange()); + + if (migration.readChanges() && r == PrimaryStorage.REVIEW_DB) { + // Because NoteDb and ReviewDb have different semantics for zero-value + // approvals, we must fall back to ReviewDb as the source of truth here. + ReviewDb db = ctx.getDb(); + + if (db instanceof BatchUpdateReviewDb) { + db = ((BatchUpdateReviewDb) db).unsafeGetDelegate(); + } + db = ReviewDbUtil.unwrapDb(db); + approvals = db.patchSetApprovals().byChange(changeId); + } else { + approvals = approvalsUtil.byChange(ctx.getDb(), ctx.getNotes()).values(); + } + + return Iterables.filter(approvals, psa -> accountId.equals(psa.getAccountId())); + } + + private String formatLabelValue(short value) { + if (value > 0) { + return "+" + value; + } + return Short.toString(value); + } + + private void emailReviewers( + Project.NameKey projectName, Change change, ChangeMessage changeMessage) { + Account.Id userId = user.get().getAccountId(); + if (userId.equals(reviewer.getId())) { + // The user knows they removed themselves, don't bother emailing them. + return; + } + try { + DeleteReviewerSender cm = deleteReviewerSenderFactory.create(projectName, change.getId()); + cm.setFrom(userId); + cm.addReviewers(Collections.singleton(reviewer.getId())); + cm.setChangeMessage(changeMessage.getMessage(), changeMessage.getWrittenOn()); + cm.setNotify(input.notify); + cm.setAccountsToNotify(notifyUtil.resolveAccounts(input.notifyDetails)); + cm.send(); + } catch (Exception err) { + log.error("Cannot email update for change " + change.getId(), err); + } + } +} |