##// END OF EJS Templates
authn: Remove doubled colon in plugin ID generation.
johbo -
r138:6e8f05fd default
parent child Browse files
Show More
@@ -1,122 +1,122 b''
1 1 # -*- coding: utf-8 -*-
2 2
3 3 # Copyright (C) 2012-2016 RhodeCode GmbH
4 4 #
5 5 # This program is free software: you can redistribute it and/or modify
6 6 # it under the terms of the GNU Affero General Public License, version 3
7 7 # (only), as published by the Free Software Foundation.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU Affero General Public License
15 15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 16 #
17 17 # This program is dual-licensed. If you wish to learn more about the
18 18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20 20
21 21 import logging
22 22 import importlib
23 23
24 24 from pkg_resources import iter_entry_points
25 25 from pyramid.authentication import SessionAuthenticationPolicy
26 26
27 27 from rhodecode.authentication.registry import AuthenticationPluginRegistry
28 28 from rhodecode.authentication.routes import root_factory
29 29 from rhodecode.authentication.routes import AuthnRootResource
30 30 from rhodecode.config.routing import ADMIN_PREFIX
31 31 from rhodecode.model.settings import SettingsModel
32 32
33 33
34 34 log = logging.getLogger(__name__)
35 35
36 36 # Plugin ID prefixes to distinct between normal and legacy plugins.
37 37 plugin_prefix = 'egg:'
38 38 legacy_plugin_prefix = 'py:'
39 39
40 40
41 41 # TODO: Currently this is only used to discover the authentication plugins.
42 42 # Later on this may be used in a generic way to look up and include all kinds
43 43 # of supported enterprise plugins. Therefore this has to be moved and
44 44 # refactored to a real 'plugin look up' machinery.
45 45 # TODO: When refactoring this think about splitting it up into distinct
46 46 # discover, load and include phases.
47 47 def _discover_plugins(config, entry_point='enterprise.plugins1'):
48 48 for ep in iter_entry_points(entry_point):
49 plugin_id = '{}:{}#{}'.format(
49 plugin_id = '{}{}#{}'.format(
50 50 plugin_prefix, ep.dist.project_name, ep.name)
51 51 log.debug('Plugin discovered: "%s"', plugin_id)
52 52 try:
53 53 module = ep.load()
54 54 plugin = module(plugin_id=plugin_id)
55 55 config.include(plugin.includeme)
56 56 except Exception as e:
57 57 log.exception(
58 58 'Exception while loading authentication plugin '
59 59 '"{}": {}'.format(plugin_id, e.message))
60 60
61 61
62 62 def _import_legacy_plugin(plugin_id):
63 63 module_name = plugin_id.split(legacy_plugin_prefix, 1)[-1]
64 64 module = importlib.import_module(module_name)
65 65 return module.plugin_factory(plugin_id=plugin_id)
66 66
67 67
68 68 def _discover_legacy_plugins(config, prefix=legacy_plugin_prefix):
69 69 """
70 70 Function that imports the legacy plugins stored in the 'auth_plugins'
71 71 setting in database which are using the specified prefix. Normally 'py:' is
72 72 used for the legacy plugins.
73 73 """
74 74 auth_plugins = SettingsModel().get_setting_by_name('auth_plugins')
75 75 enabled_plugins = auth_plugins.app_settings_value
76 76 legacy_plugins = [id_ for id_ in enabled_plugins if id_.startswith(prefix)]
77 77
78 78 for plugin_id in legacy_plugins:
79 79 log.debug('Legacy plugin discovered: "%s"', plugin_id)
80 80 try:
81 81 plugin = _import_legacy_plugin(plugin_id)
82 82 config.include(plugin.includeme)
83 83 except Exception as e:
84 84 log.exception(
85 85 'Exception while loading legacy authentication plugin '
86 86 '"{}": {}'.format(plugin_id, e.message))
87 87
88 88
89 89 def includeme(config):
90 90 # Set authentication policy.
91 91 authn_policy = SessionAuthenticationPolicy()
92 92 config.set_authentication_policy(authn_policy)
93 93
94 94 # Create authentication plugin registry and add it to the pyramid registry.
95 95 authn_registry = AuthenticationPluginRegistry(config.get_settings())
96 96 config.add_directive('add_authn_plugin', authn_registry.add_authn_plugin)
97 97 config.registry.registerUtility(authn_registry)
98 98
99 99 # Create authentication traversal root resource.
100 100 authn_root_resource = root_factory()
101 101 config.add_directive('add_authn_resource',
102 102 authn_root_resource.add_authn_resource)
103 103
104 104 # Add the authentication traversal route.
105 105 config.add_route('auth_home',
106 106 ADMIN_PREFIX + '/auth*traverse',
107 107 factory=root_factory)
108 108 # Add the authentication settings root views.
109 109 config.add_view('rhodecode.authentication.views.AuthSettingsView',
110 110 attr='index',
111 111 request_method='GET',
112 112 route_name='auth_home',
113 113 context=AuthnRootResource)
114 114 config.add_view('rhodecode.authentication.views.AuthSettingsView',
115 115 attr='auth_settings',
116 116 request_method='POST',
117 117 route_name='auth_home',
118 118 context=AuthnRootResource)
119 119
120 120 # Auto discover authentication plugins and include their configuration.
121 121 _discover_plugins(config)
122 122 _discover_legacy_plugins(config)
General Comments 0
You need to be logged in to leave comments. Login now