# Copyright (C) 2010-2017 by the Free Software Foundation, Inc. # # This file is part of GNU Mailman. # # GNU Mailman is free software: you can redistribute it and/or modify it under # the terms of the GNU General Public License as published by the Free # Software Foundation, either version 3 of the License, or (at your option) # any later version. # # GNU Mailman is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for # more details. # # You should have received a copy of the GNU General Public License along with # GNU Mailman. If not, see . """REST for plugins, dynamically proxies requests to plugin's rest_object.""" from lazr.config import as_boolean from mailman.config import config from mailman.rest.helpers import CollectionMixin, NotFound, etag, okay from public import public @public class AllPlugins(CollectionMixin): """Read-only list of all plugin configs.""" def _resource_as_dict(self, plugin_config): """See `CollectionMixin`.""" name, plugin_section = plugin_config resource = { 'name': name, 'class': plugin_section['class'], 'enable': as_boolean(plugin_section['enable']), 'path': plugin_section['path'], 'configuration': plugin_section['configuration'] } return resource def _get_collection(self, request): """See `CollectionMixin`.""" return sorted(config.plugin_configs) def on_get(self, request, response): """/plugins""" resource = self._make_collection(request) okay(response, etag(resource)) @public class APlugin: """REST proxy to the plugins rest_object.""" def __init__(self, plugin_name): self.__rest_object = None if plugin_name in config.plugins.keys(): plugin = config.plugins[plugin_name] self.__rest_object = plugin.rest_object() # If the plugin doesn't exist or doesn't provide a rest_object, # just proxy to NotFound if self.__rest_object is None: self.__rest_object = NotFound() def __getattr__(self, attrib): return getattr(self.__rest_object, attrib) def __dir__(self): return dir(self.__rest_object)