Java tutorial
// Copyright (C) 2008 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.httpd.rpc.changedetail; import com.google.common.base.Function; import com.google.common.base.Optional; import com.google.common.collect.Iterables; import com.google.common.collect.Lists; import com.google.gerrit.common.Nullable; import com.google.gerrit.common.data.PatchSetDetail; import com.google.gerrit.common.data.UiCommandDetail; import com.google.gerrit.common.errors.NoSuchEntityException; import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.extensions.webui.UiAction; import com.google.gerrit.httpd.rpc.Handler; import com.google.gerrit.reviewdb.client.Account; import com.google.gerrit.reviewdb.client.AccountDiffPreference; import com.google.gerrit.reviewdb.client.AccountDiffPreference.Whitespace; import com.google.gerrit.reviewdb.client.AccountPatchReview; import com.google.gerrit.reviewdb.client.Change; import com.google.gerrit.reviewdb.client.Patch; import com.google.gerrit.reviewdb.client.PatchLineComment; import com.google.gerrit.reviewdb.client.PatchSet; import com.google.gerrit.reviewdb.client.Project; import com.google.gerrit.reviewdb.server.ReviewDb; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.PatchLineCommentsUtil; import com.google.gerrit.server.change.ChangesCollection; import com.google.gerrit.server.change.RevisionResource; import com.google.gerrit.server.change.Revisions; import com.google.gerrit.server.edit.ChangeEdit; import com.google.gerrit.server.edit.ChangeEditUtil; import com.google.gerrit.server.extensions.webui.UiActions; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.patch.PatchList; import com.google.gerrit.server.patch.PatchListCache; import com.google.gerrit.server.patch.PatchListKey; import com.google.gerrit.server.patch.PatchListNotAvailableException; import com.google.gerrit.server.patch.PatchSetInfoFactory; import com.google.gerrit.server.patch.PatchSetInfoNotAvailableException; import com.google.gerrit.server.project.ChangeControl; import com.google.gerrit.server.project.NoSuchChangeException; import com.google.gwtorm.server.OrmException; import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.assistedinject.Assisted; import com.google.inject.util.Providers; import org.eclipse.jgit.lib.ObjectId; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.io.IOException; import java.util.HashMap; import java.util.List; import java.util.Map; /** Creates a {@link PatchSetDetail} from a {@link PatchSet}. */ class PatchSetDetailFactory extends Handler<PatchSetDetail> { private static final Logger log = LoggerFactory.getLogger(PatchSetDetailFactory.class); interface Factory { PatchSetDetailFactory create(@Assisted("psIdBase") @Nullable PatchSet.Id psIdBase, @Assisted("psIdNew") PatchSet.Id psIdNew, @Nullable AccountDiffPreference diffPrefs); } private final PatchSetInfoFactory infoFactory; private final ReviewDb db; private final PatchListCache patchListCache; private final Provider<CurrentUser> userProvider; private final ChangeControl.GenericFactory changeControlFactory; private final ChangesCollection changes; private final Revisions revisions; private final PatchLineCommentsUtil plcUtil; private final ChangeEditUtil editUtil; private Project.NameKey project; private final PatchSet.Id psIdBase; private final PatchSet.Id psIdNew; private final AccountDiffPreference diffPrefs; private ObjectId oldId; private ObjectId newId; private PatchSetDetail detail; ChangeControl control; PatchSet patchSet; @Inject PatchSetDetailFactory(final PatchSetInfoFactory psif, final ReviewDb db, final PatchListCache patchListCache, final Provider<CurrentUser> userProvider, final ChangeControl.GenericFactory changeControlFactory, final ChangesCollection changes, final Revisions revisions, final PatchLineCommentsUtil plcUtil, ChangeEditUtil editUtil, @Assisted("psIdBase") @Nullable final PatchSet.Id psIdBase, @Assisted("psIdNew") final PatchSet.Id psIdNew, @Assisted @Nullable final AccountDiffPreference diffPrefs) { this.infoFactory = psif; this.db = db; this.patchListCache = patchListCache; this.userProvider = userProvider; this.changeControlFactory = changeControlFactory; this.changes = changes; this.revisions = revisions; this.plcUtil = plcUtil; this.editUtil = editUtil; this.psIdBase = psIdBase; this.psIdNew = psIdNew; this.diffPrefs = diffPrefs; } @Override public PatchSetDetail call() throws OrmException, NoSuchEntityException, PatchSetInfoNotAvailableException, NoSuchChangeException, AuthException, IOException { Optional<ChangeEdit> edit = null; if (control == null || patchSet == null) { control = changeControlFactory.validateFor(psIdNew.getParentKey(), userProvider.get()); if (psIdNew.get() == 0) { Change change = db.changes().get(psIdNew.getParentKey()); edit = editUtil.byChange(change); if (edit.isPresent()) { patchSet = edit.get().getBasePatchSet(); } } else { patchSet = db.patchSets().get(psIdNew); } if (patchSet == null) { throw new NoSuchEntityException(); } } project = control.getProject().getNameKey(); final PatchList list; try { if (psIdBase != null) { oldId = toObjectId(psIdBase); if (edit != null && edit.isPresent()) { newId = edit.get().getEditCommit().toObjectId(); } else { newId = toObjectId(psIdNew); } list = listFor(keyFor(diffPrefs.getIgnoreWhitespace())); } else { // OK, means use base to compare list = patchListCache.get(control.getChange(), patchSet); } } catch (PatchListNotAvailableException e) { throw new NoSuchEntityException(); } final List<Patch> patches = list.toPatchList(patchSet.getId()); final Map<Patch.Key, Patch> byKey = new HashMap<>(); for (final Patch p : patches) { byKey.put(p.getKey(), p); } ChangeNotes notes = control.getNotes(); if (edit == null) { for (PatchLineComment c : plcUtil.publishedByPatchSet(db, notes, psIdNew)) { final Patch p = byKey.get(c.getKey().getParentKey()); if (p != null) { p.setCommentCount(p.getCommentCount() + 1); } } } detail = new PatchSetDetail(); detail.setPatchSet(patchSet); detail.setProject(project); detail.setInfo(infoFactory.get(db, patchSet.getId())); detail.setPatches(patches); final CurrentUser user = control.getCurrentUser(); if (user.isIdentifiedUser() && edit == null) { // If we are signed in, compute the number of draft comments by the // current user on each of these patch files. This way they can more // quickly locate where they have pending drafts, and review them. // final Account.Id me = ((IdentifiedUser) user).getAccountId(); for (PatchLineComment c : plcUtil.draftByPatchSetAuthor(db, psIdNew, me, notes)) { final Patch p = byKey.get(c.getKey().getParentKey()); if (p != null) { p.setDraftCount(p.getDraftCount() + 1); } } for (AccountPatchReview r : db.accountPatchReviews().byReviewer(me, psIdNew)) { final Patch p = byKey.get(r.getKey().getPatchKey()); if (p != null) { p.setReviewedByCurrentUser(true); } } } detail.setCommands(Lists.newArrayList(Iterables.transform( UiActions.sorted(UiActions.plugins(UiActions.from(revisions, new RevisionResource(changes.parse(control), patchSet), Providers.of(user)))), new Function<UiAction.Description, UiCommandDetail>() { @Override public UiCommandDetail apply(UiAction.Description in) { UiCommandDetail r = new UiCommandDetail(); r.method = in.getMethod(); r.id = in.getId(); r.label = in.getLabel(); r.title = in.getTitle(); r.enabled = in.isEnabled(); return r; } }))); return detail; } private ObjectId toObjectId(final PatchSet.Id psId) throws OrmException, NoSuchEntityException { final PatchSet ps = db.patchSets().get(psId); if (ps == null) { throw new NoSuchEntityException(); } try { return ObjectId.fromString(ps.getRevision().get()); } catch (IllegalArgumentException e) { log.error("Patch set " + psId + " has invalid revision"); throw new NoSuchEntityException(); } } private PatchListKey keyFor(Whitespace whitespace) { return new PatchListKey(oldId, newId, whitespace); } private PatchList listFor(PatchListKey key) throws PatchListNotAvailableException { return patchListCache.get(key, project); } }