com.google.gerrit.server.restapi.change.PutDraftComment Maven / Gradle / Ivy
The newest version!
// 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 static com.google.gerrit.entities.Patch.PATCHSET_LEVEL;
import static com.google.gerrit.server.update.context.RefUpdateContext.RefUpdateType.CHANGE_MODIFICATION;
import com.google.gerrit.entities.Comment;
import com.google.gerrit.entities.HumanComment;
import com.google.gerrit.entities.PatchSet;
import com.google.gerrit.extensions.api.changes.DraftInput;
import com.google.gerrit.extensions.common.CommentInfo;
import com.google.gerrit.extensions.restapi.BadRequestException;
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.RestModifyView;
import com.google.gerrit.extensions.restapi.Url;
import com.google.gerrit.extensions.validators.CommentValidator;
import com.google.gerrit.server.CommentsUtil;
import com.google.gerrit.server.DraftCommentsReader;
import com.google.gerrit.server.PatchSetUtil;
import com.google.gerrit.server.change.DraftCommentResource;
import com.google.gerrit.server.notedb.ChangeNotes;
import com.google.gerrit.server.notedb.ChangeUpdate;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.plugincontext.PluginSetContext;
import com.google.gerrit.server.update.BatchUpdate;
import com.google.gerrit.server.update.BatchUpdateOp;
import com.google.gerrit.server.update.ChangeContext;
import com.google.gerrit.server.update.UpdateException;
import com.google.gerrit.server.update.context.RefUpdateContext;
import com.google.gerrit.server.util.time.TimeUtil;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import java.time.Instant;
import java.util.Collections;
import java.util.Optional;
@Singleton
public class PutDraftComment implements RestModifyView {
private final BatchUpdate.Factory updateFactory;
private final DeleteDraftComment delete;
private final CommentsUtil commentsUtil;
private final DraftCommentsReader draftCommentsReader;
private final PatchSetUtil psUtil;
private final Provider commentJson;
private final ChangeNotes.Factory changeNotesFactory;
private final PluginSetContext commentValidators;
@Inject
PutDraftComment(
BatchUpdate.Factory updateFactory,
DeleteDraftComment delete,
CommentsUtil commentsUtil,
DraftCommentsReader draftCommentsReader,
PatchSetUtil psUtil,
Provider commentJson,
ChangeNotes.Factory changeNotesFactory,
PluginSetContext commentValidators) {
this.updateFactory = updateFactory;
this.delete = delete;
this.commentsUtil = commentsUtil;
this.draftCommentsReader = draftCommentsReader;
this.psUtil = psUtil;
this.commentJson = commentJson;
this.changeNotesFactory = changeNotesFactory;
this.commentValidators = commentValidators;
}
@Override
public Response apply(DraftCommentResource rsrc, DraftInput in)
throws RestApiException, UpdateException, PermissionBackendException {
if (in == null || in.message == null || in.message.trim().isEmpty()) {
return delete.apply(rsrc, null);
} else if (in.id != null && !rsrc.getId().equals(in.id)) {
throw new BadRequestException("id must match URL");
} else if (in.line != null && in.line < 0) {
throw new BadRequestException("line must be >= 0");
} else if (in.path.equals(PATCHSET_LEVEL)
&& (in.side != null || in.range != null || in.line != null)) {
throw new BadRequestException("patchset-level comments can't have side, range, or line");
} else if (in.line != null && in.range != null && in.line != in.range.endLine) {
throw new BadRequestException("range endLine must be on the same line as the comment");
} else if (in.inReplyTo != null
&& !commentsUtil.getPublishedHumanComment(rsrc.getNotes(), in.inReplyTo).isPresent()
&& !commentsUtil.getRobotComment(rsrc.getNotes(), in.inReplyTo).isPresent()) {
throw new BadRequestException(
String.format("Invalid inReplyTo, comment %s not found", in.inReplyTo));
}
CreateDraftComment.validateDraftComment(
rsrc.getRevisionResource(), in, changeNotesFactory, commentValidators, commentsUtil);
try (RefUpdateContext ctx = RefUpdateContext.open(CHANGE_MODIFICATION)) {
try (BatchUpdate bu =
updateFactory.create(rsrc.getChange().getProject(), rsrc.getUser(), TimeUtil.now())) {
Op op = new Op(rsrc.getComment().key, in);
bu.addOp(rsrc.getChange().getId(), op);
bu.execute();
return Response.ok(
commentJson.get().setFillAccounts(false).newHumanCommentFormatter().format(op.comment));
}
}
}
private class Op implements BatchUpdateOp {
private final Comment.Key key;
private final DraftInput in;
private HumanComment comment;
private Op(Comment.Key key, DraftInput in) {
this.key = key;
this.in = in;
}
@Override
public boolean updateChange(ChangeContext ctx) throws ResourceNotFoundException {
Optional maybeComment =
draftCommentsReader.getDraftComment(ctx.getNotes(), ctx.getIdentifiedUser(), key);
if (!maybeComment.isPresent()) {
// Disappeared out from under us. Can't easily fall back to insert,
// because the input might be missing required fields. Just give up.
throw new ResourceNotFoundException("comment not found: " + key);
}
HumanComment origComment = maybeComment.get();
comment = new HumanComment(origComment);
// Copy constructor preserved old real author; replace with current real
// user.
ctx.getUser().updateRealAccountId(comment::setRealAuthor);
PatchSet.Id psId = PatchSet.id(ctx.getChange().getId(), origComment.key.patchSetId);
ChangeUpdate update = ctx.getUpdate(psId);
PatchSet ps = psUtil.get(ctx.getNotes(), psId);
if (ps == null) {
throw new ResourceNotFoundException("patch set not found: " + psId);
}
if (in.path != null && !in.path.equals(origComment.key.filename)) {
// Updating the path alters the primary key, which isn't possible.
// Delete then recreate the comment instead of an update.
commentsUtil.deleteHumanComments(update, Collections.singleton(origComment));
comment.key.filename = in.path;
}
commentsUtil.setCommentCommitId(comment, ctx.getChange(), ps);
commentsUtil.putHumanComments(
update,
HumanComment.Status.DRAFT,
Collections.singleton(update(comment, in, ctx.getWhen())));
return true;
}
}
private static HumanComment update(HumanComment e, DraftInput in, Instant when) {
if (in.side != null) {
e.side = in.side();
}
if (in.inReplyTo != null) {
e.parentUuid = Url.decode(in.inReplyTo);
}
e.setLineNbrAndRange(in.line, in.range);
e.message = in.message.trim();
e.setWrittenOn(when);
if (in.tag != null) {
// TODO(dborowitz): Can we support changing tags via PUT?
e.tag = in.tag;
}
if (in.unresolved != null) {
e.unresolved = in.unresolved;
}
if (in.fixSuggestions != null) {
e.fixSuggestions = CommentsUtil.createFixSuggestionsFromInput(in.fixSuggestions);
}
return e;
}
}