summaryrefslogtreecommitdiffstats
path: root/java/com/google/gerrit/httpd/rpc/project/ProjectAccessHandler.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/com/google/gerrit/httpd/rpc/project/ProjectAccessHandler.java')
-rw-r--r--java/com/google/gerrit/httpd/rpc/project/ProjectAccessHandler.java251
1 files changed, 251 insertions, 0 deletions
diff --git a/java/com/google/gerrit/httpd/rpc/project/ProjectAccessHandler.java b/java/com/google/gerrit/httpd/rpc/project/ProjectAccessHandler.java
new file mode 100644
index 0000000000..44c896681c
--- /dev/null
+++ b/java/com/google/gerrit/httpd/rpc/project/ProjectAccessHandler.java
@@ -0,0 +1,251 @@
+// 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.httpd.rpc.project;
+
+import static com.google.gerrit.common.ProjectAccessUtil.mergeSections;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.base.MoreObjects;
+import com.google.gerrit.common.data.AccessSection;
+import com.google.gerrit.common.data.GroupReference;
+import com.google.gerrit.common.data.Permission;
+import com.google.gerrit.common.data.PermissionRule;
+import com.google.gerrit.common.errors.InvalidNameException;
+import com.google.gerrit.common.errors.NoSuchGroupException;
+import com.google.gerrit.common.errors.UpdateParentFailedException;
+import com.google.gerrit.extensions.restapi.AuthException;
+import com.google.gerrit.extensions.restapi.BadRequestException;
+import com.google.gerrit.extensions.restapi.ResourceConflictException;
+import com.google.gerrit.extensions.restapi.UnprocessableEntityException;
+import com.google.gerrit.httpd.rpc.Handler;
+import com.google.gerrit.reviewdb.client.Project;
+import com.google.gerrit.server.CurrentUser;
+import com.google.gerrit.server.account.GroupBackend;
+import com.google.gerrit.server.account.GroupBackends;
+import com.google.gerrit.server.config.AllProjectsName;
+import com.google.gerrit.server.git.meta.MetaDataUpdate;
+import com.google.gerrit.server.permissions.PermissionBackend;
+import com.google.gerrit.server.permissions.PermissionBackendException;
+import com.google.gerrit.server.permissions.ProjectPermission;
+import com.google.gerrit.server.permissions.RefPermission;
+import com.google.gerrit.server.project.ContributorAgreementsChecker;
+import com.google.gerrit.server.project.NoSuchProjectException;
+import com.google.gerrit.server.project.ProjectConfig;
+import com.google.gerrit.server.project.RefPattern;
+import com.google.gerrit.server.restapi.project.SetParent;
+import com.google.gwtorm.server.OrmException;
+import com.google.inject.Provider;
+import java.io.IOException;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import org.eclipse.jgit.errors.ConfigInvalidException;
+import org.eclipse.jgit.errors.RepositoryNotFoundException;
+import org.eclipse.jgit.lib.ObjectId;
+
+public abstract class ProjectAccessHandler<T> extends Handler<T> {
+
+ protected final GroupBackend groupBackend;
+ protected final Project.NameKey projectName;
+ protected final ObjectId base;
+ protected final CurrentUser user;
+
+ private final MetaDataUpdate.User metaDataUpdateFactory;
+ private final AllProjectsName allProjects;
+ private final Provider<SetParent> setParent;
+ private final ContributorAgreementsChecker contributorAgreements;
+ private final PermissionBackend permissionBackend;
+ private final Project.NameKey parentProjectName;
+
+ protected String message;
+
+ private List<AccessSection> sectionList;
+ private boolean checkIfOwner;
+ private Boolean canWriteConfig;
+
+ protected ProjectAccessHandler(
+ GroupBackend groupBackend,
+ MetaDataUpdate.User metaDataUpdateFactory,
+ AllProjectsName allProjects,
+ Provider<SetParent> setParent,
+ CurrentUser user,
+ Project.NameKey projectName,
+ ObjectId base,
+ List<AccessSection> sectionList,
+ Project.NameKey parentProjectName,
+ String message,
+ ContributorAgreementsChecker contributorAgreements,
+ PermissionBackend permissionBackend,
+ boolean checkIfOwner) {
+ this.groupBackend = groupBackend;
+ this.metaDataUpdateFactory = metaDataUpdateFactory;
+ this.allProjects = allProjects;
+ this.setParent = setParent;
+ this.user = user;
+
+ this.projectName = projectName;
+ this.base = base;
+ this.sectionList = sectionList;
+ this.parentProjectName = parentProjectName;
+ this.message = message;
+ this.contributorAgreements = contributorAgreements;
+ this.permissionBackend = permissionBackend;
+ this.checkIfOwner = checkIfOwner;
+ }
+
+ @Override
+ public final T call()
+ throws NoSuchProjectException, IOException, ConfigInvalidException, InvalidNameException,
+ NoSuchGroupException, OrmException, UpdateParentFailedException, AuthException,
+ PermissionBackendException, ResourceConflictException {
+ contributorAgreements.check(projectName, user);
+
+ try (MetaDataUpdate md = metaDataUpdateFactory.create(projectName)) {
+ ProjectConfig config = ProjectConfig.read(md, base);
+ Set<String> toDelete = scanSectionNames(config);
+ PermissionBackend.ForProject forProject = permissionBackend.user(user).project(projectName);
+
+ for (AccessSection section : mergeSections(sectionList)) {
+ String name = section.getName();
+
+ if (AccessSection.GLOBAL_CAPABILITIES.equals(name)) {
+ if (checkIfOwner && !canWriteConfig()) {
+ continue;
+ }
+ replace(config, toDelete, section);
+
+ } else if (AccessSection.isValid(name)) {
+ if (checkIfOwner) {
+ try {
+ forProject.ref(name).check(RefPermission.WRITE_CONFIG);
+ } catch (AuthException e) {
+ continue;
+ }
+ }
+
+ RefPattern.validate(name);
+
+ replace(config, toDelete, section);
+ }
+ }
+
+ for (String name : toDelete) {
+ if (AccessSection.GLOBAL_CAPABILITIES.equals(name)) {
+ if (!checkIfOwner || canWriteConfig()) {
+ config.remove(config.getAccessSection(name));
+ }
+
+ } else if (!checkIfOwner) {
+ config.remove(config.getAccessSection(name));
+ } else {
+ try {
+ forProject.ref(name).check(RefPermission.WRITE_CONFIG);
+ config.remove(config.getAccessSection(name));
+ } catch (AuthException e) {
+ // Do nothing.
+ }
+ }
+ }
+
+ boolean parentProjectUpdate = false;
+ if (!config.getProject().getNameKey().equals(allProjects)
+ && !config.getProject().getParent(allProjects).equals(parentProjectName)) {
+ parentProjectUpdate = true;
+ try {
+ setParent
+ .get()
+ .validateParentUpdate(
+ projectName,
+ user.asIdentifiedUser(),
+ MoreObjects.firstNonNull(parentProjectName, allProjects).get(),
+ checkIfOwner);
+ } catch (AuthException e) {
+ throw new UpdateParentFailedException(
+ "You are not allowed to change the parent project since you are "
+ + "not an administrator. You may save the modifications for review "
+ + "so that an administrator can approve them.",
+ e);
+ } catch (ResourceConflictException | UnprocessableEntityException | BadRequestException e) {
+ throw new UpdateParentFailedException(e.getMessage(), e);
+ }
+ config.getProject().setParentName(parentProjectName);
+ }
+
+ if (message != null && !message.isEmpty()) {
+ if (!message.endsWith("\n")) {
+ message += "\n";
+ }
+ md.setMessage(message);
+ } else {
+ md.setMessage("Modify access rules\n");
+ }
+
+ return updateProjectConfig(config, md, parentProjectUpdate);
+ } catch (RepositoryNotFoundException notFound) {
+ throw new NoSuchProjectException(projectName);
+ }
+ }
+
+ protected abstract T updateProjectConfig(
+ ProjectConfig config, MetaDataUpdate md, boolean parentProjectUpdate)
+ throws IOException, NoSuchProjectException, ConfigInvalidException, OrmException,
+ AuthException, PermissionBackendException, ResourceConflictException;
+
+ private void replace(ProjectConfig config, Set<String> toDelete, AccessSection section)
+ throws NoSuchGroupException {
+ for (Permission permission : section.getPermissions()) {
+ for (PermissionRule rule : permission.getRules()) {
+ lookupGroup(rule);
+ }
+ }
+ config.replace(section);
+ toDelete.remove(section.getName());
+ }
+
+ private static Set<String> scanSectionNames(ProjectConfig config) {
+ Set<String> names = new HashSet<>();
+ for (AccessSection section : config.getAccessSections()) {
+ names.add(section.getName());
+ }
+ return names;
+ }
+
+ private void lookupGroup(PermissionRule rule) throws NoSuchGroupException {
+ GroupReference ref = rule.getGroup();
+ if (ref.getUUID() == null) {
+ final GroupReference group = GroupBackends.findBestSuggestion(groupBackend, ref.getName());
+ if (group == null) {
+ throw new NoSuchGroupException(ref.getName());
+ }
+ ref.setUUID(group.getUUID());
+ }
+ }
+
+ /** Provide a local cache for {@code ProjectPermission.WRITE_CONFIG} capability. */
+ private boolean canWriteConfig() throws PermissionBackendException {
+ requireNonNull(user);
+
+ if (canWriteConfig != null) {
+ return canWriteConfig;
+ }
+ try {
+ permissionBackend.user(user).project(projectName).check(ProjectPermission.WRITE_CONFIG);
+ canWriteConfig = true;
+ } catch (AuthException e) {
+ canWriteConfig = false;
+ }
+ return canWriteConfig;
+ }
+}