##// END OF EJS Templates
vcs: Move the setup code for vcs lib from pylons to pyramid layer....
Martin Bornhold -
r582:3ea09690 default
parent child Browse files
Show More
@@ -1,196 +1,195 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2
2
3 # Copyright (C) 2010-2016 RhodeCode GmbH
3 # Copyright (C) 2010-2016 RhodeCode GmbH
4 #
4 #
5 # This program is free software: you can redistribute it and/or modify
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Affero General Public License, version 3
6 # it under the terms of the GNU Affero General Public License, version 3
7 # (only), as published by the Free Software Foundation.
7 # (only), as published by the Free Software Foundation.
8 #
8 #
9 # This program is distributed in the hope that it will be useful,
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
12 # GNU General Public License for more details.
13 #
13 #
14 # You should have received a copy of the GNU Affero General Public License
14 # You should have received a copy of the GNU Affero General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16 #
16 #
17 # This program is dual-licensed. If you wish to learn more about the
17 # This program is dual-licensed. If you wish to learn more about the
18 # RhodeCode Enterprise Edition, including its added features, Support services,
18 # RhodeCode Enterprise Edition, including its added features, Support services,
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
19 # and proprietary license terms, please see https://rhodecode.com/licenses/
20
20
21 """
21 """
22 Pylons environment configuration
22 Pylons environment configuration
23 """
23 """
24
24
25 import os
25 import os
26 import logging
26 import logging
27 import rhodecode
27 import rhodecode
28 import platform
28 import platform
29 import re
29 import re
30 import io
30 import io
31
31
32 from mako.lookup import TemplateLookup
32 from mako.lookup import TemplateLookup
33 from pylons.configuration import PylonsConfig
33 from pylons.configuration import PylonsConfig
34 from pylons.error import handle_mako_error
34 from pylons.error import handle_mako_error
35 from pyramid.settings import asbool
35 from pyramid.settings import asbool
36
36
37 # don't remove this import it does magic for celery
37 # don't remove this import it does magic for celery
38 from rhodecode.lib import celerypylons # noqa
38 from rhodecode.lib import celerypylons # noqa
39
39
40 import rhodecode.lib.app_globals as app_globals
40 import rhodecode.lib.app_globals as app_globals
41
41
42 from rhodecode.config import utils
42 from rhodecode.config import utils
43 from rhodecode.config.routing import make_map
43 from rhodecode.config.routing import make_map
44 from rhodecode.config.jsroutes import generate_jsroutes_content
44 from rhodecode.config.jsroutes import generate_jsroutes_content
45
45
46 from rhodecode.lib import helpers
46 from rhodecode.lib import helpers
47 from rhodecode.lib.auth import set_available_permissions
47 from rhodecode.lib.auth import set_available_permissions
48 from rhodecode.lib.utils import (
48 from rhodecode.lib.utils import (
49 repo2db_mapper, make_db_config, set_rhodecode_config,
49 repo2db_mapper, make_db_config, set_rhodecode_config,
50 load_rcextensions)
50 load_rcextensions)
51 from rhodecode.lib.utils2 import str2bool, aslist
51 from rhodecode.lib.utils2 import str2bool, aslist
52 from rhodecode.lib.vcs import connect_vcs, start_vcs_server
52 from rhodecode.lib.vcs import connect_vcs, start_vcs_server
53 from rhodecode.model.scm import ScmModel
53 from rhodecode.model.scm import ScmModel
54
54
55 log = logging.getLogger(__name__)
55 log = logging.getLogger(__name__)
56
56
57 def load_environment(global_conf, app_conf, initial=False,
57 def load_environment(global_conf, app_conf, initial=False,
58 test_env=None, test_index=None):
58 test_env=None, test_index=None):
59 """
59 """
60 Configure the Pylons environment via the ``pylons.config``
60 Configure the Pylons environment via the ``pylons.config``
61 object
61 object
62 """
62 """
63 config = PylonsConfig()
63 config = PylonsConfig()
64
64
65
65
66 # Pylons paths
66 # Pylons paths
67 root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
67 root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
68 paths = {
68 paths = {
69 'root': root,
69 'root': root,
70 'controllers': os.path.join(root, 'controllers'),
70 'controllers': os.path.join(root, 'controllers'),
71 'static_files': os.path.join(root, 'public'),
71 'static_files': os.path.join(root, 'public'),
72 'templates': [os.path.join(root, 'templates')],
72 'templates': [os.path.join(root, 'templates')],
73 }
73 }
74
74
75 # Initialize config with the basic options
75 # Initialize config with the basic options
76 config.init_app(global_conf, app_conf, package='rhodecode', paths=paths)
76 config.init_app(global_conf, app_conf, package='rhodecode', paths=paths)
77
77
78 # store some globals into rhodecode
78 # store some globals into rhodecode
79 rhodecode.CELERY_ENABLED = str2bool(config['app_conf'].get('use_celery'))
79 rhodecode.CELERY_ENABLED = str2bool(config['app_conf'].get('use_celery'))
80 rhodecode.CELERY_EAGER = str2bool(
80 rhodecode.CELERY_EAGER = str2bool(
81 config['app_conf'].get('celery.always.eager'))
81 config['app_conf'].get('celery.always.eager'))
82
82
83 config['routes.map'] = make_map(config)
83 config['routes.map'] = make_map(config)
84
84
85 if asbool(config.get('generate_js_files', 'false')):
85 if asbool(config.get('generate_js_files', 'false')):
86 jsroutes = config['routes.map'].jsroutes()
86 jsroutes = config['routes.map'].jsroutes()
87 jsroutes_file_content = generate_jsroutes_content(jsroutes)
87 jsroutes_file_content = generate_jsroutes_content(jsroutes)
88 jsroutes_file_path = os.path.join(
88 jsroutes_file_path = os.path.join(
89 paths['static_files'], 'js', 'rhodecode', 'routes.js')
89 paths['static_files'], 'js', 'rhodecode', 'routes.js')
90
90
91 with io.open(jsroutes_file_path, 'w', encoding='utf-8') as f:
91 with io.open(jsroutes_file_path, 'w', encoding='utf-8') as f:
92 f.write(jsroutes_file_content)
92 f.write(jsroutes_file_content)
93
93
94 config['pylons.app_globals'] = app_globals.Globals(config)
94 config['pylons.app_globals'] = app_globals.Globals(config)
95 config['pylons.h'] = helpers
95 config['pylons.h'] = helpers
96 rhodecode.CONFIG = config
96 rhodecode.CONFIG = config
97
97
98 load_rcextensions(root_path=config['here'])
98 load_rcextensions(root_path=config['here'])
99
99
100 # Setup cache object as early as possible
100 # Setup cache object as early as possible
101 import pylons
101 import pylons
102 pylons.cache._push_object(config['pylons.app_globals'].cache)
102 pylons.cache._push_object(config['pylons.app_globals'].cache)
103
103
104 # Create the Mako TemplateLookup, with the default auto-escaping
104 # Create the Mako TemplateLookup, with the default auto-escaping
105 config['pylons.app_globals'].mako_lookup = TemplateLookup(
105 config['pylons.app_globals'].mako_lookup = TemplateLookup(
106 directories=paths['templates'],
106 directories=paths['templates'],
107 error_handler=handle_mako_error,
107 error_handler=handle_mako_error,
108 module_directory=os.path.join(app_conf['cache_dir'], 'templates'),
108 module_directory=os.path.join(app_conf['cache_dir'], 'templates'),
109 input_encoding='utf-8', default_filters=['escape'],
109 input_encoding='utf-8', default_filters=['escape'],
110 imports=['from webhelpers.html import escape'])
110 imports=['from webhelpers.html import escape'])
111
111
112 # sets the c attribute access when don't existing attribute are accessed
112 # sets the c attribute access when don't existing attribute are accessed
113 config['pylons.strict_tmpl_context'] = True
113 config['pylons.strict_tmpl_context'] = True
114
114
115 # configure channelstream
115 # configure channelstream
116 config['channelstream_config'] = {
116 config['channelstream_config'] = {
117 'enabled': asbool(config.get('channelstream.enabled', False)),
117 'enabled': asbool(config.get('channelstream.enabled', False)),
118 'server': config.get('channelstream.server'),
118 'server': config.get('channelstream.server'),
119 'secret': config.get('channelstream.secret')
119 'secret': config.get('channelstream.secret')
120 }
120 }
121
121
122 # Limit backends to "vcs.backends" from configuration
123 backends = config['vcs.backends'] = aslist(
124 config.get('vcs.backends', 'hg,git'), sep=',')
125 for alias in rhodecode.BACKENDS.keys():
126 if alias not in backends:
127 del rhodecode.BACKENDS[alias]
128 log.info("Enabled backends: %s", backends)
129
130 # initialize vcs client and optionally run the server if enabled
131 vcs_server_uri = config.get('vcs.server', '')
132 vcs_server_enabled = str2bool(config.get('vcs.server.enable', 'true'))
133 start_server = (
134 str2bool(config.get('vcs.start_server', 'false')) and
135 not int(os.environ.get('RC_VCSSERVER_TEST_DISABLE', '0')))
136 if vcs_server_enabled and start_server:
137 log.info("Starting vcsserver")
138 start_vcs_server(server_and_port=vcs_server_uri,
139 protocol=utils.get_vcs_server_protocol(config),
140 log_level=config['vcs.server.log_level'])
141
142 set_available_permissions(config)
122 set_available_permissions(config)
143 db_cfg = make_db_config(clear_session=True)
123 db_cfg = make_db_config(clear_session=True)
144
124
145 repos_path = list(db_cfg.items('paths'))[0][1]
125 repos_path = list(db_cfg.items('paths'))[0][1]
146 config['base_path'] = repos_path
126 config['base_path'] = repos_path
147
127
148 config['vcs.hooks.direct_calls'] = _use_direct_hook_calls(config)
128 config['vcs.hooks.direct_calls'] = _use_direct_hook_calls(config)
149 config['vcs.hooks.protocol'] = _get_vcs_hooks_protocol(config)
129 config['vcs.hooks.protocol'] = _get_vcs_hooks_protocol(config)
150
130
151 # store db config also in main global CONFIG
131 # store db config also in main global CONFIG
152 set_rhodecode_config(config)
132 set_rhodecode_config(config)
153
133
154 # configure instance id
134 # configure instance id
155 utils.set_instance_id(config)
135 utils.set_instance_id(config)
156
136
157 # CONFIGURATION OPTIONS HERE (note: all config options will override
137 # CONFIGURATION OPTIONS HERE (note: all config options will override
158 # any Pylons config options)
138 # any Pylons config options)
159
139
160 # store config reference into our module to skip import magic of pylons
140 # store config reference into our module to skip import magic of pylons
161 rhodecode.CONFIG.update(config)
141 rhodecode.CONFIG.update(config)
162
142
163 utils.configure_pyro4(config)
143 utils.configure_pyro4(config)
164 utils.configure_vcs(config)
165 if vcs_server_enabled:
166 connect_vcs(vcs_server_uri, utils.get_vcs_server_protocol(config))
167
168 return config
144 return config
169
145
170
146
171 def _use_direct_hook_calls(config):
147 def _use_direct_hook_calls(config):
172 default_direct_hook_calls = 'false'
148 default_direct_hook_calls = 'false'
173 direct_hook_calls = str2bool(
149 direct_hook_calls = str2bool(
174 config.get('vcs.hooks.direct_calls', default_direct_hook_calls))
150 config.get('vcs.hooks.direct_calls', default_direct_hook_calls))
175 return direct_hook_calls
151 return direct_hook_calls
176
152
177
153
178 def _get_vcs_hooks_protocol(config):
154 def _get_vcs_hooks_protocol(config):
179 protocol = config.get('vcs.hooks.protocol', 'pyro4').lower()
155 protocol = config.get('vcs.hooks.protocol', 'pyro4').lower()
180 return protocol
156 return protocol
181
157
182
158
183 def load_pyramid_environment(global_config, settings):
159 def load_pyramid_environment(global_config, settings):
184 # Some parts of the code expect a merge of global and app settings.
160 # Some parts of the code expect a merge of global and app settings.
185 settings_merged = global_config.copy()
161 settings_merged = global_config.copy()
186 settings_merged.update(settings)
162 settings_merged.update(settings)
187
163
188 # If this is a test run we prepare the test environment like
164 # If this is a test run we prepare the test environment like
189 # creating a test database, test search index and test repositories.
165 # creating a test database, test search index and test repositories.
190 # This has to be done before the database connection is initialized.
166 # This has to be done before the database connection is initialized.
191 if settings['is_test']:
167 if settings['is_test']:
192 rhodecode.is_test = True
168 rhodecode.is_test = True
193 utils.initialize_test_environment(settings_merged)
169 utils.initialize_test_environment(settings_merged)
194
170
195 # Initialize the database connection.
171 # Initialize the database connection.
196 utils.initialize_database(settings_merged)
172 utils.initialize_database(settings_merged)
173
174 # Limit backends to `vcs.backends` from configuration
175 for alias in rhodecode.BACKENDS.keys():
176 if alias not in settings['vcs.backends']:
177 del rhodecode.BACKENDS[alias]
178 log.info('Enabled VCS backends: %s', rhodecode.BACKENDS.keys())
179
180 # initialize vcs client and optionally run the server if enabled
181 vcs_server_uri = settings['vcs.server']
182 vcs_server_enabled = settings['vcs.server.enable']
183 start_server = (
184 settings['vcs.start_server'] and
185 not int(os.environ.get('RC_VCSSERVER_TEST_DISABLE', '0')))
186
187 if vcs_server_enabled and start_server:
188 log.info("Starting vcsserver")
189 start_vcs_server(server_and_port=vcs_server_uri,
190 protocol=utils.get_vcs_server_protocol(settings),
191 log_level=settings['vcs.server.log_level'])
192
193 utils.configure_vcs(settings)
194 if vcs_server_enabled:
195 connect_vcs(vcs_server_uri, utils.get_vcs_server_protocol(settings))
General Comments 0
You need to be logged in to leave comments. Login now