| // Copyright (C) 2013 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.config; |
| |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.flogger.FluentLogger; |
| import com.google.gerrit.common.data.GlobalCapability; |
| import com.google.gerrit.extensions.config.CapabilityDefinition; |
| import com.google.gerrit.extensions.registration.DynamicMap; |
| import com.google.gerrit.extensions.restapi.ResourceNotFoundException; |
| import com.google.gerrit.extensions.restapi.RestReadView; |
| import com.google.gerrit.server.config.CapabilityConstants; |
| import com.google.gerrit.server.config.ConfigResource; |
| import com.google.gerrit.server.permissions.PermissionBackend; |
| import com.google.inject.Inject; |
| import com.google.inject.Provider; |
| import com.google.inject.Singleton; |
| import java.util.HashMap; |
| import java.util.Map; |
| import java.util.regex.Pattern; |
| |
| /** List capabilities visible to the calling user. */ |
| @Singleton |
| public class ListCapabilities implements RestReadView<ConfigResource> { |
| private static final FluentLogger logger = FluentLogger.forEnclosingClass(); |
| |
| private static final Pattern PLUGIN_NAME_PATTERN = Pattern.compile("^[a-zA-Z0-9-]+$"); |
| |
| private final PermissionBackend permissionBackend; |
| private final DynamicMap<CapabilityDefinition> pluginCapabilities; |
| |
| @Inject |
| public ListCapabilities( |
| PermissionBackend permissionBackend, DynamicMap<CapabilityDefinition> pluginCapabilities) { |
| this.permissionBackend = permissionBackend; |
| this.pluginCapabilities = pluginCapabilities; |
| } |
| |
| @Override |
| public Map<String, CapabilityInfo> apply(ConfigResource resource) |
| throws ResourceNotFoundException, IllegalAccessException, NoSuchFieldException { |
| permissionBackend.checkUsesDefaultCapabilities(); |
| return ImmutableMap.<String, CapabilityInfo>builder() |
| .putAll(collectCoreCapabilities()) |
| .putAll(collectPluginCapabilities()) |
| .build(); |
| } |
| |
| public Map<String, CapabilityInfo> collectPluginCapabilities() { |
| Map<String, CapabilityInfo> output = new HashMap<>(); |
| for (String pluginName : pluginCapabilities.plugins()) { |
| if (!PLUGIN_NAME_PATTERN.matcher(pluginName).matches()) { |
| logger.atWarning().log( |
| "Plugin name '%s' must match '%s' to use capabilities; rename the plugin", |
| pluginName, PLUGIN_NAME_PATTERN.pattern()); |
| continue; |
| } |
| for (Map.Entry<String, Provider<CapabilityDefinition>> entry : |
| pluginCapabilities.byPlugin(pluginName).entrySet()) { |
| String id = String.format("%s-%s", pluginName, entry.getKey()); |
| output.put(id, new CapabilityInfo(id, entry.getValue().get().getDescription())); |
| } |
| } |
| return output; |
| } |
| |
| private Map<String, CapabilityInfo> collectCoreCapabilities() |
| throws IllegalAccessException, NoSuchFieldException { |
| Map<String, CapabilityInfo> output = new HashMap<>(); |
| Class<? extends CapabilityConstants> bundleClass = CapabilityConstants.get().getClass(); |
| CapabilityConstants c = CapabilityConstants.get(); |
| for (String id : GlobalCapability.getAllNames()) { |
| String name = (String) bundleClass.getField(id).get(c); |
| output.put(id, new CapabilityInfo(id, name)); |
| } |
| return output; |
| } |
| |
| public static class CapabilityInfo { |
| public String id; |
| public String name; |
| |
| public CapabilityInfo(String id, String name) { |
| this.id = id; |
| this.name = name; |
| } |
| } |
| } |