| // Copyright (C) 2009 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.patch; |
| |
| import com.google.gerrit.common.data.ApprovalType; |
| import com.google.gerrit.common.data.ApprovalTypes; |
| import com.google.gerrit.common.data.ReviewerResult; |
| import com.google.gerrit.reviewdb.client.Account; |
| import com.google.gerrit.reviewdb.client.AccountGroup; |
| import com.google.gerrit.reviewdb.client.ApprovalCategory; |
| import com.google.gerrit.reviewdb.client.Change; |
| import com.google.gerrit.reviewdb.client.PatchSet; |
| import com.google.gerrit.reviewdb.client.PatchSetApproval; |
| import com.google.gerrit.reviewdb.server.ReviewDb; |
| import com.google.gerrit.server.IdentifiedUser; |
| import com.google.gerrit.server.account.AccountResolver; |
| import com.google.gerrit.server.account.GroupCache; |
| import com.google.gerrit.server.account.GroupMembers; |
| import com.google.gerrit.server.config.GerritServerConfig; |
| import com.google.gerrit.server.mail.AddReviewerSender; |
| import com.google.gerrit.server.project.ChangeControl; |
| import com.google.gwtorm.server.OrmException; |
| import com.google.inject.Inject; |
| import com.google.inject.assistedinject.Assisted; |
| |
| import org.eclipse.jgit.lib.Config; |
| |
| import java.util.ArrayList; |
| import java.util.Collection; |
| import java.util.HashSet; |
| import java.util.List; |
| import java.util.Set; |
| import java.util.concurrent.Callable; |
| |
| public class AddReviewer implements Callable<ReviewerResult> { |
| public final static int DEFAULT_MAX_REVIEWERS_WITHOUT_CHECK = 10; |
| public final static int DEFAULT_MAX_REVIEWERS = 20; |
| |
| public interface Factory { |
| AddReviewer create(Change.Id changeId, |
| Collection<String> userNameOrEmailOrGroupNames, boolean confirmed); |
| } |
| |
| private final AddReviewerSender.Factory addReviewerSenderFactory; |
| private final AccountResolver accountResolver; |
| private final GroupCache groupCache; |
| private final GroupMembers.Factory groupMembersFactory; |
| private final ChangeControl.Factory changeControlFactory; |
| private final ReviewDb db; |
| private final IdentifiedUser currentUser; |
| private final IdentifiedUser.GenericFactory identifiedUserFactory; |
| private final ApprovalCategory.Id addReviewerCategoryId; |
| private final Config cfg; |
| |
| private final Change.Id changeId; |
| private final Collection<String> reviewers; |
| private final boolean confirmed; |
| |
| @Inject |
| AddReviewer(final AddReviewerSender.Factory addReviewerSenderFactory, |
| final AccountResolver accountResolver, final GroupCache groupCache, |
| final GroupMembers.Factory groupMembersFactory, |
| final ChangeControl.Factory changeControlFactory, final ReviewDb db, |
| final IdentifiedUser.GenericFactory identifiedUserFactory, |
| final IdentifiedUser currentUser, final ApprovalTypes approvalTypes, |
| final @GerritServerConfig Config cfg, @Assisted final Change.Id changeId, |
| @Assisted final Collection<String> reviewers, |
| @Assisted final boolean confirmed) { |
| this.addReviewerSenderFactory = addReviewerSenderFactory; |
| this.accountResolver = accountResolver; |
| this.groupCache = groupCache; |
| this.groupMembersFactory = groupMembersFactory; |
| this.db = db; |
| this.changeControlFactory = changeControlFactory; |
| this.identifiedUserFactory = identifiedUserFactory; |
| this.currentUser = currentUser; |
| this.cfg = cfg; |
| |
| final List<ApprovalType> allTypes = approvalTypes.getApprovalTypes(); |
| addReviewerCategoryId = |
| allTypes.get(allTypes.size() - 1).getCategory().getId(); |
| |
| this.changeId = changeId; |
| this.reviewers = reviewers; |
| this.confirmed = confirmed; |
| } |
| |
| @Override |
| public ReviewerResult call() throws Exception { |
| final Set<Account.Id> reviewerIds = new HashSet<Account.Id>(); |
| final ChangeControl control = changeControlFactory.validateFor(changeId); |
| |
| final ReviewerResult result = new ReviewerResult(); |
| for (final String reviewer : reviewers) { |
| final Account account = accountResolver.find(reviewer); |
| if (account == null) { |
| AccountGroup group = groupCache.get(new AccountGroup.NameKey(reviewer)); |
| |
| if (group == null) { |
| result.addError(new ReviewerResult.Error( |
| ReviewerResult.Error.Type.REVIEWER_NOT_FOUND, reviewer)); |
| continue; |
| } |
| |
| if (!isLegalReviewerGroup(group.getGroupUUID())) { |
| result.addError(new ReviewerResult.Error( |
| ReviewerResult.Error.Type.GROUP_NOT_ALLOWED, reviewer)); |
| continue; |
| } |
| |
| final Set<Account> members = |
| groupMembersFactory.create().listAccounts(group.getGroupUUID(), |
| control.getProject().getNameKey()); |
| if (members == null || members.size() == 0) { |
| result.addError(new ReviewerResult.Error( |
| ReviewerResult.Error.Type.GROUP_EMPTY, reviewer)); |
| continue; |
| } |
| |
| // if maxAllowed is set to 0, it is allowed to add any number of |
| // reviewers |
| final int maxAllowed = |
| cfg.getInt("addreviewer", "maxAllowed", DEFAULT_MAX_REVIEWERS); |
| if (maxAllowed > 0 && members.size() > maxAllowed) { |
| result.setMemberCount(members.size()); |
| result.setAskForConfirmation(false); |
| result.addError(new ReviewerResult.Error( |
| ReviewerResult.Error.Type.GROUP_HAS_TOO_MANY_MEMBERS, reviewer)); |
| continue; |
| } |
| |
| // if maxWithoutCheck is set to 0, we never ask for confirmation |
| final int maxWithoutConfirmation = |
| cfg.getInt("addreviewer", "maxWithoutConfirmation", |
| DEFAULT_MAX_REVIEWERS_WITHOUT_CHECK); |
| if (!confirmed && maxWithoutConfirmation > 0 |
| && members.size() > maxWithoutConfirmation) { |
| result.setMemberCount(members.size()); |
| result.setAskForConfirmation(true); |
| result.addError(new ReviewerResult.Error( |
| ReviewerResult.Error.Type.GROUP_HAS_TOO_MANY_MEMBERS, reviewer)); |
| continue; |
| } |
| |
| for (final Account member : members) { |
| if (member.isActive()) { |
| final IdentifiedUser user = |
| identifiedUserFactory.create(member.getId()); |
| // Does not account for draft status as a user might want to let a |
| // reviewer see a draft. |
| if (control.forUser(user).isRefVisible()) { |
| reviewerIds.add(member.getId()); |
| } |
| } |
| } |
| continue; |
| } |
| |
| if (!account.isActive()) { |
| result.addError(new ReviewerResult.Error( |
| ReviewerResult.Error.Type.ACCOUNT_INACTIVE, |
| formatUser(account, reviewer))); |
| continue; |
| } |
| |
| final IdentifiedUser user = identifiedUserFactory.create(account.getId()); |
| // Does not account for draft status as a user might want to let a |
| // reviewer see a draft. |
| if (!control.forUser(user).isRefVisible()) { |
| result.addError(new ReviewerResult.Error( |
| ReviewerResult.Error.Type.CHANGE_NOT_VISIBLE, |
| formatUser(account, reviewer))); |
| continue; |
| } |
| |
| reviewerIds.add(account.getId()); |
| } |
| |
| if (reviewerIds.isEmpty()) { |
| return result; |
| } |
| |
| // Add the reviewers to the database |
| // |
| final Set<Account.Id> added = new HashSet<Account.Id>(); |
| final List<PatchSetApproval> toInsert = new ArrayList<PatchSetApproval>(); |
| final PatchSet.Id psid = control.getChange().currentPatchSetId(); |
| for (final Account.Id reviewer : reviewerIds) { |
| if (!exists(psid, reviewer)) { |
| // This reviewer has not entered an approval for this change yet. |
| // |
| final PatchSetApproval myca = |
| dummyApproval(control.getChange(), psid, reviewer); |
| toInsert.add(myca); |
| added.add(reviewer); |
| } |
| } |
| db.patchSetApprovals().insert(toInsert); |
| |
| // Email the reviewers |
| // |
| // The user knows they added themselves, don't bother emailing them. |
| added.remove(currentUser.getAccountId()); |
| if (!added.isEmpty()) { |
| final AddReviewerSender cm; |
| |
| cm = addReviewerSenderFactory.create(control.getChange()); |
| cm.setFrom(currentUser.getAccountId()); |
| cm.addReviewers(added); |
| cm.send(); |
| } |
| |
| return result; |
| } |
| |
| private String formatUser(Account account, String nameOrEmail) { |
| if (nameOrEmail.matches("^[1-9][0-9]*$")) { |
| return RemoveReviewer.formatUser(account, nameOrEmail); |
| } else { |
| return nameOrEmail; |
| } |
| } |
| |
| private boolean exists(final PatchSet.Id patchSetId, |
| final Account.Id reviewerId) throws OrmException { |
| return db.patchSetApprovals().byPatchSetUser(patchSetId, reviewerId) |
| .iterator().hasNext(); |
| } |
| |
| private PatchSetApproval dummyApproval(final Change change, |
| final PatchSet.Id patchSetId, final Account.Id reviewerId) { |
| final PatchSetApproval dummyApproval = |
| new PatchSetApproval(new PatchSetApproval.Key(patchSetId, reviewerId, |
| addReviewerCategoryId), (short) 0); |
| dummyApproval.cache(change); |
| return dummyApproval; |
| } |
| |
| public static boolean isLegalReviewerGroup(final AccountGroup.UUID groupUUID) { |
| return !(AccountGroup.ANONYMOUS_USERS.equals(groupUUID) |
| || AccountGroup.REGISTERED_USERS.equals(groupUUID)); |
| } |
| } |