diff options
Diffstat (limited to 'java/com/google/gerrit/server/restapi/change/Abandon.java')
-rw-r--r-- | java/com/google/gerrit/server/restapi/change/Abandon.java | 169 |
1 files changed, 169 insertions, 0 deletions
diff --git a/java/com/google/gerrit/server/restapi/change/Abandon.java b/java/com/google/gerrit/server/restapi/change/Abandon.java new file mode 100644 index 0000000000..ccce99879e --- /dev/null +++ b/java/com/google/gerrit/server/restapi/change/Abandon.java @@ -0,0 +1,169 @@ +// Copyright (C) 2012 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.ImmutableListMultimap; +import com.google.common.collect.ListMultimap; +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.extensions.api.changes.AbandonInput; +import com.google.gerrit.extensions.api.changes.NotifyHandling; +import com.google.gerrit.extensions.api.changes.RecipientType; +import com.google.gerrit.extensions.common.ChangeInfo; +import com.google.gerrit.extensions.restapi.RestApiException; +import com.google.gerrit.extensions.webui.UiAction; +import com.google.gerrit.reviewdb.client.Account; +import com.google.gerrit.reviewdb.client.Change; +import com.google.gerrit.reviewdb.server.ReviewDb; +import com.google.gerrit.server.CurrentUser; +import com.google.gerrit.server.PatchSetUtil; +import com.google.gerrit.server.account.AccountState; +import com.google.gerrit.server.change.AbandonOp; +import com.google.gerrit.server.change.ChangeJson; +import com.google.gerrit.server.change.ChangeResource; +import com.google.gerrit.server.change.NotifyUtil; +import com.google.gerrit.server.notedb.ChangeNotes; +import com.google.gerrit.server.permissions.ChangePermission; +import com.google.gerrit.server.permissions.PermissionBackendException; +import com.google.gerrit.server.update.BatchUpdate; +import com.google.gerrit.server.update.RetryHelper; +import com.google.gerrit.server.update.RetryingRestModifyView; +import com.google.gerrit.server.update.UpdateException; +import com.google.gerrit.server.util.time.TimeUtil; +import com.google.gwtorm.server.OrmException; +import com.google.inject.Inject; +import com.google.inject.Provider; +import com.google.inject.Singleton; +import java.io.IOException; +import org.eclipse.jgit.errors.ConfigInvalidException; + +@Singleton +public class Abandon extends RetryingRestModifyView<ChangeResource, AbandonInput, ChangeInfo> + implements UiAction<ChangeResource> { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + private final Provider<ReviewDb> dbProvider; + private final ChangeJson.Factory json; + private final AbandonOp.Factory abandonOpFactory; + private final NotifyUtil notifyUtil; + private final PatchSetUtil patchSetUtil; + + @Inject + Abandon( + Provider<ReviewDb> dbProvider, + ChangeJson.Factory json, + RetryHelper retryHelper, + AbandonOp.Factory abandonOpFactory, + NotifyUtil notifyUtil, + PatchSetUtil patchSetUtil) { + super(retryHelper); + this.dbProvider = dbProvider; + this.json = json; + this.abandonOpFactory = abandonOpFactory; + this.notifyUtil = notifyUtil; + this.patchSetUtil = patchSetUtil; + } + + @Override + protected ChangeInfo applyImpl( + BatchUpdate.Factory updateFactory, ChangeResource rsrc, AbandonInput input) + throws RestApiException, UpdateException, OrmException, PermissionBackendException, + IOException, ConfigInvalidException { + // Not allowed to abandon if the current patch set is locked. + patchSetUtil.checkPatchSetNotLocked(rsrc.getNotes()); + + rsrc.permissions().database(dbProvider).check(ChangePermission.ABANDON); + + NotifyHandling notify = input.notify == null ? defaultNotify(rsrc.getChange()) : input.notify; + Change change = + abandon( + updateFactory, + rsrc.getNotes(), + rsrc.getUser(), + input.message, + notify, + notifyUtil.resolveAccounts(input.notifyDetails)); + return json.noOptions().format(change); + } + + private NotifyHandling defaultNotify(Change change) { + return change.hasReviewStarted() ? NotifyHandling.ALL : NotifyHandling.OWNER; + } + + public Change abandon(BatchUpdate.Factory updateFactory, ChangeNotes notes, CurrentUser user) + throws RestApiException, UpdateException { + return abandon( + updateFactory, + notes, + user, + "", + defaultNotify(notes.getChange()), + ImmutableListMultimap.of()); + } + + public Change abandon( + BatchUpdate.Factory updateFactory, ChangeNotes notes, CurrentUser user, String msgTxt) + throws RestApiException, UpdateException { + return abandon( + updateFactory, + notes, + user, + msgTxt, + defaultNotify(notes.getChange()), + ImmutableListMultimap.of()); + } + + public Change abandon( + BatchUpdate.Factory updateFactory, + ChangeNotes notes, + CurrentUser user, + String msgTxt, + NotifyHandling notifyHandling, + ListMultimap<RecipientType, Account.Id> accountsToNotify) + throws RestApiException, UpdateException { + AccountState accountState = user.isIdentifiedUser() ? user.asIdentifiedUser().state() : null; + AbandonOp op = abandonOpFactory.create(accountState, msgTxt, notifyHandling, accountsToNotify); + try (BatchUpdate u = + updateFactory.create(dbProvider.get(), notes.getProjectName(), user, TimeUtil.nowTs())) { + u.addOp(notes.getChangeId(), op).execute(); + } + return op.getChange(); + } + + @Override + public UiAction.Description getDescription(ChangeResource rsrc) { + UiAction.Description description = + new UiAction.Description() + .setLabel("Abandon") + .setTitle("Abandon the change") + .setVisible(false); + + Change change = rsrc.getChange(); + if (!change.getStatus().isOpen()) { + return description; + } + + try { + if (patchSetUtil.isPatchSetLocked(rsrc.getNotes())) { + return description; + } + } catch (OrmException | IOException e) { + logger.atSevere().withCause(e).log( + "Failed to check if the current patch set of change %s is locked", change.getId()); + return description; + } + + return description.setVisible(rsrc.permissions().testOrFalse(ChangePermission.ABANDON)); + } +} |