Show More
@@ -1,614 +1,614 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | |
|
3 | 3 | # Copyright (C) 2010-2020 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 os |
|
22 | 22 | import sys |
|
23 | 23 | import collections |
|
24 | 24 | import tempfile |
|
25 | 25 | import time |
|
26 | 26 | import logging.config |
|
27 | 27 | |
|
28 | 28 | from paste.gzipper import make_gzip_middleware |
|
29 | 29 | import pyramid.events |
|
30 | 30 | from pyramid.wsgi import wsgiapp |
|
31 | 31 | from pyramid.authorization import ACLAuthorizationPolicy |
|
32 | 32 | from pyramid.config import Configurator |
|
33 | 33 | from pyramid.settings import asbool, aslist |
|
34 | 34 | from pyramid.httpexceptions import ( |
|
35 | 35 | HTTPException, HTTPError, HTTPInternalServerError, HTTPFound, HTTPNotFound) |
|
36 | 36 | from pyramid.renderers import render_to_response |
|
37 | 37 | |
|
38 | 38 | from rhodecode.model import meta |
|
39 | 39 | from rhodecode.config import patches |
|
40 | 40 | from rhodecode.config import utils as config_utils |
|
41 | 41 | from rhodecode.config.settings_maker import SettingsMaker |
|
42 | 42 | from rhodecode.config.environment import load_pyramid_environment |
|
43 | 43 | |
|
44 | 44 | import rhodecode.events |
|
45 | 45 | from rhodecode.lib.middleware.vcs import VCSMiddleware |
|
46 | 46 | from rhodecode.lib.request import Request |
|
47 | 47 | from rhodecode.lib.vcs import VCSCommunicationError |
|
48 | 48 | from rhodecode.lib.exceptions import VCSServerUnavailable |
|
49 | 49 | from rhodecode.lib.middleware.appenlight import wrap_in_appenlight_if_enabled |
|
50 | 50 | from rhodecode.lib.middleware.https_fixup import HttpsFixup |
|
51 | 51 | from rhodecode.lib.plugins.utils import register_rhodecode_plugin |
|
52 | 52 | from rhodecode.lib.utils2 import AttributeDict |
|
53 | 53 | from rhodecode.lib.exc_tracking import store_exception |
|
54 | 54 | from rhodecode.subscribers import ( |
|
55 | 55 | scan_repositories_if_enabled, write_js_routes_if_enabled, |
|
56 | 56 | write_metadata_if_needed, write_usage_data) |
|
57 | 57 | from rhodecode.lib.statsd_client import StatsdClient |
|
58 | 58 | |
|
59 | 59 | log = logging.getLogger(__name__) |
|
60 | 60 | |
|
61 | 61 | |
|
62 | 62 | def is_http_error(response): |
|
63 | 63 | # error which should have traceback |
|
64 | 64 | return response.status_code > 499 |
|
65 | 65 | |
|
66 | 66 | |
|
67 | 67 | def should_load_all(): |
|
68 | 68 | """ |
|
69 | 69 | Returns if all application components should be loaded. In some cases it's |
|
70 | 70 | desired to skip apps loading for faster shell script execution |
|
71 | 71 | """ |
|
72 | 72 | ssh_cmd = os.environ.get('RC_CMD_SSH_WRAPPER') |
|
73 | 73 | if ssh_cmd: |
|
74 | 74 | return False |
|
75 | 75 | |
|
76 | 76 | return True |
|
77 | 77 | |
|
78 | 78 | |
|
79 | 79 | def make_pyramid_app(global_config, **settings): |
|
80 | 80 | """ |
|
81 | 81 | Constructs the WSGI application based on Pyramid. |
|
82 | 82 | |
|
83 | 83 | Specials: |
|
84 | 84 | |
|
85 | 85 | * The application can also be integrated like a plugin via the call to |
|
86 | 86 | `includeme`. This is accompanied with the other utility functions which |
|
87 | 87 | are called. Changing this should be done with great care to not break |
|
88 | 88 | cases when these fragments are assembled from another place. |
|
89 | 89 | |
|
90 | 90 | """ |
|
91 | 91 | start_time = time.time() |
|
92 | 92 | log.info('Pyramid app config starting') |
|
93 | 93 | |
|
94 | 94 | sanitize_settings_and_apply_defaults(global_config, settings) |
|
95 | 95 | |
|
96 | 96 | # init and bootstrap StatsdClient |
|
97 | 97 | StatsdClient.setup(settings) |
|
98 | 98 | |
|
99 | 99 | config = Configurator(settings=settings) |
|
100 | 100 | # Init our statsd at very start |
|
101 | 101 | config.registry.statsd = StatsdClient.statsd |
|
102 | 102 | |
|
103 | 103 | # Apply compatibility patches |
|
104 | 104 | patches.inspect_getargspec() |
|
105 | 105 | |
|
106 | 106 | load_pyramid_environment(global_config, settings) |
|
107 | 107 | |
|
108 | 108 | # Static file view comes first |
|
109 | 109 | includeme_first(config) |
|
110 | 110 | |
|
111 | 111 | includeme(config) |
|
112 | 112 | |
|
113 | 113 | pyramid_app = config.make_wsgi_app() |
|
114 | 114 | pyramid_app = wrap_app_in_wsgi_middlewares(pyramid_app, config) |
|
115 | 115 | pyramid_app.config = config |
|
116 | 116 | |
|
117 | 117 | celery_settings = get_celery_config(settings) |
|
118 | 118 | config.configure_celery(celery_settings) |
|
119 | 119 | |
|
120 | 120 | # creating the app uses a connection - return it after we are done |
|
121 | 121 | meta.Session.remove() |
|
122 | 122 | |
|
123 | 123 | total_time = time.time() - start_time |
|
124 | 124 | log.info('Pyramid app `%s` created and configured in %.2fs', |
|
125 | 125 | getattr(pyramid_app, 'func_name', 'pyramid_app'), total_time) |
|
126 | 126 | return pyramid_app |
|
127 | 127 | |
|
128 | 128 | |
|
129 | 129 | def get_celery_config(settings): |
|
130 | 130 | """ |
|
131 | 131 | Converts basic ini configuration into celery 4.X options |
|
132 | 132 | """ |
|
133 | 133 | |
|
134 | 134 | def key_converter(key_name): |
|
135 | 135 | pref = 'celery.' |
|
136 | 136 | if key_name.startswith(pref): |
|
137 | 137 | return key_name[len(pref):].replace('.', '_').lower() |
|
138 | 138 | |
|
139 | 139 | def type_converter(parsed_key, value): |
|
140 | 140 | # cast to int |
|
141 | 141 | if value.isdigit(): |
|
142 | 142 | return int(value) |
|
143 | 143 | |
|
144 | 144 | # cast to bool |
|
145 | 145 | if value.lower() in ['true', 'false', 'True', 'False']: |
|
146 | 146 | return value.lower() == 'true' |
|
147 | 147 | return value |
|
148 | 148 | |
|
149 | 149 | celery_config = {} |
|
150 | 150 | for k, v in settings.items(): |
|
151 | 151 | pref = 'celery.' |
|
152 | 152 | if k.startswith(pref): |
|
153 | 153 | celery_config[key_converter(k)] = type_converter(key_converter(k), v) |
|
154 | 154 | |
|
155 | 155 | # TODO:rethink if we want to support celerybeat based file config, probably NOT |
|
156 | 156 | # beat_config = {} |
|
157 | 157 | # for section in parser.sections(): |
|
158 | 158 | # if section.startswith('celerybeat:'): |
|
159 | 159 | # name = section.split(':', 1)[1] |
|
160 | 160 | # beat_config[name] = get_beat_config(parser, section) |
|
161 | 161 | |
|
162 | 162 | # final compose of settings |
|
163 | 163 | celery_settings = {} |
|
164 | 164 | |
|
165 | 165 | if celery_config: |
|
166 | 166 | celery_settings.update(celery_config) |
|
167 | 167 | # if beat_config: |
|
168 | 168 | # celery_settings.update({'beat_schedule': beat_config}) |
|
169 | 169 | |
|
170 | 170 | return celery_settings |
|
171 | 171 | |
|
172 | 172 | |
|
173 | 173 | def not_found_view(request): |
|
174 | 174 | """ |
|
175 | 175 | This creates the view which should be registered as not-found-view to |
|
176 | 176 | pyramid. |
|
177 | 177 | """ |
|
178 | 178 | |
|
179 | 179 | if not getattr(request, 'vcs_call', None): |
|
180 | 180 | # handle like regular case with our error_handler |
|
181 | 181 | return error_handler(HTTPNotFound(), request) |
|
182 | 182 | |
|
183 | 183 | # handle not found view as a vcs call |
|
184 | 184 | settings = request.registry.settings |
|
185 | 185 | ae_client = getattr(request, 'ae_client', None) |
|
186 | 186 | vcs_app = VCSMiddleware( |
|
187 | 187 | HTTPNotFound(), request.registry, settings, |
|
188 | 188 | appenlight_client=ae_client) |
|
189 | 189 | |
|
190 | 190 | return wsgiapp(vcs_app)(None, request) |
|
191 | 191 | |
|
192 | 192 | |
|
193 | 193 | def error_handler(exception, request): |
|
194 | 194 | import rhodecode |
|
195 | 195 | from rhodecode.lib import helpers |
|
196 | 196 | from rhodecode.lib.utils2 import str2bool |
|
197 | 197 | |
|
198 | 198 | rhodecode_title = rhodecode.CONFIG.get('rhodecode_title') or 'RhodeCode' |
|
199 | 199 | |
|
200 | 200 | base_response = HTTPInternalServerError() |
|
201 | 201 | # prefer original exception for the response since it may have headers set |
|
202 | 202 | if isinstance(exception, HTTPException): |
|
203 | 203 | base_response = exception |
|
204 | 204 | elif isinstance(exception, VCSCommunicationError): |
|
205 | 205 | base_response = VCSServerUnavailable() |
|
206 | 206 | |
|
207 | 207 | if is_http_error(base_response): |
|
208 | 208 | log.exception( |
|
209 | 209 | 'error occurred handling this request for path: %s', request.path) |
|
210 | 210 | |
|
211 | 211 | error_explanation = base_response.explanation or str(base_response) |
|
212 | 212 | if base_response.status_code == 404: |
|
213 | 213 | error_explanation += " Optionally you don't have permission to access this page." |
|
214 | 214 | c = AttributeDict() |
|
215 | 215 | c.error_message = base_response.status |
|
216 | 216 | c.error_explanation = error_explanation |
|
217 | 217 | c.visual = AttributeDict() |
|
218 | 218 | |
|
219 | 219 | c.visual.rhodecode_support_url = ( |
|
220 | 220 | request.registry.settings.get('rhodecode_support_url') or |
|
221 | 221 | request.route_url('rhodecode_support') |
|
222 | 222 | ) |
|
223 | 223 | c.redirect_time = 0 |
|
224 | 224 | c.rhodecode_name = rhodecode_title |
|
225 | 225 | if not c.rhodecode_name: |
|
226 | 226 | c.rhodecode_name = 'Rhodecode' |
|
227 | 227 | |
|
228 | 228 | c.causes = [] |
|
229 | 229 | if is_http_error(base_response): |
|
230 | 230 | c.causes.append('Server is overloaded.') |
|
231 | 231 | c.causes.append('Server database connection is lost.') |
|
232 | 232 | c.causes.append('Server expected unhandled error.') |
|
233 | 233 | |
|
234 | 234 | if hasattr(base_response, 'causes'): |
|
235 | 235 | c.causes = base_response.causes |
|
236 | 236 | |
|
237 | 237 | c.messages = helpers.flash.pop_messages(request=request) |
|
238 | 238 | |
|
239 | 239 | exc_info = sys.exc_info() |
|
240 | 240 | c.exception_id = id(exc_info) |
|
241 | 241 | c.show_exception_id = isinstance(base_response, VCSServerUnavailable) \ |
|
242 | 242 | or base_response.status_code > 499 |
|
243 | 243 | c.exception_id_url = request.route_url( |
|
244 | 244 | 'admin_settings_exception_tracker_show', exception_id=c.exception_id) |
|
245 | 245 | |
|
246 | 246 | if c.show_exception_id: |
|
247 | 247 | store_exception(c.exception_id, exc_info) |
|
248 | 248 | c.exception_debug = str2bool(rhodecode.CONFIG.get('debug')) |
|
249 | 249 | c.exception_config_ini = rhodecode.CONFIG.get('__file__') |
|
250 | 250 | |
|
251 | 251 | response = render_to_response( |
|
252 | 252 | '/errors/error_document.mako', {'c': c, 'h': helpers}, request=request, |
|
253 | 253 | response=base_response) |
|
254 | 254 | |
|
255 | 255 | statsd = request.registry.statsd |
|
256 | 256 | if statsd and base_response.status_code > 499: |
|
257 | 257 | exc_type = "{}.{}".format(exception.__class__.__module__, exception.__class__.__name__) |
|
258 | 258 | statsd.incr('rhodecode_exception_total', |
|
259 | 259 | tags=["exc_source:web", |
|
260 | 260 | "http_code:{}".format(base_response.status_code), |
|
261 | 261 | "type:{}".format(exc_type)]) |
|
262 | 262 | |
|
263 | 263 | return response |
|
264 | 264 | |
|
265 | 265 | |
|
266 | 266 | def includeme_first(config): |
|
267 | 267 | # redirect automatic browser favicon.ico requests to correct place |
|
268 | 268 | def favicon_redirect(context, request): |
|
269 | 269 | return HTTPFound( |
|
270 | 270 | request.static_path('rhodecode:public/images/favicon.ico')) |
|
271 | 271 | |
|
272 | 272 | config.add_view(favicon_redirect, route_name='favicon') |
|
273 | 273 | config.add_route('favicon', '/favicon.ico') |
|
274 | 274 | |
|
275 | 275 | def robots_redirect(context, request): |
|
276 | 276 | return HTTPFound( |
|
277 | 277 | request.static_path('rhodecode:public/robots.txt')) |
|
278 | 278 | |
|
279 | 279 | config.add_view(robots_redirect, route_name='robots') |
|
280 | 280 | config.add_route('robots', '/robots.txt') |
|
281 | 281 | |
|
282 | 282 | config.add_static_view( |
|
283 | 283 | '_static/deform', 'deform:static') |
|
284 | 284 | config.add_static_view( |
|
285 | 285 | '_static/rhodecode', path='rhodecode:public', cache_max_age=3600 * 24) |
|
286 | 286 | |
|
287 | 287 | |
|
288 | 288 | def includeme(config, auth_resources=None): |
|
289 | 289 | from rhodecode.lib.celerylib.loader import configure_celery |
|
290 | 290 | log.debug('Initializing main includeme from %s', os.path.basename(__file__)) |
|
291 | 291 | settings = config.registry.settings |
|
292 | 292 | config.set_request_factory(Request) |
|
293 | 293 | |
|
294 | 294 | # plugin information |
|
295 | 295 | config.registry.rhodecode_plugins = collections.OrderedDict() |
|
296 | 296 | |
|
297 | 297 | config.add_directive( |
|
298 | 298 | 'register_rhodecode_plugin', register_rhodecode_plugin) |
|
299 | 299 | |
|
300 | 300 | config.add_directive('configure_celery', configure_celery) |
|
301 | 301 | |
|
302 | 302 | if settings.get('appenlight', False): |
|
303 | 303 | config.include('appenlight_client.ext.pyramid_tween') |
|
304 | 304 | |
|
305 | 305 | load_all = should_load_all() |
|
306 | 306 | |
|
307 | 307 | # Includes which are required. The application would fail without them. |
|
308 | 308 | config.include('pyramid_mako') |
|
309 | 309 | config.include('rhodecode.lib.rc_beaker') |
|
310 | 310 | config.include('rhodecode.lib.rc_cache') |
|
311 | 311 | config.include('rhodecode.apps._base.navigation') |
|
312 | 312 | config.include('rhodecode.apps._base.subscribers') |
|
313 | 313 | config.include('rhodecode.tweens') |
|
314 | 314 | config.include('rhodecode.authentication') |
|
315 | 315 | |
|
316 | 316 | if load_all: |
|
317 | 317 | ce_auth_resources = [ |
|
318 | 318 | 'rhodecode.authentication.plugins.auth_crowd', |
|
319 | 319 | 'rhodecode.authentication.plugins.auth_headers', |
|
320 | 320 | 'rhodecode.authentication.plugins.auth_jasig_cas', |
|
321 | 321 | 'rhodecode.authentication.plugins.auth_ldap', |
|
322 | 322 | 'rhodecode.authentication.plugins.auth_pam', |
|
323 | 323 | 'rhodecode.authentication.plugins.auth_rhodecode', |
|
324 | 324 | 'rhodecode.authentication.plugins.auth_token', |
|
325 | 325 | ] |
|
326 | 326 | |
|
327 | 327 | # load CE authentication plugins |
|
328 | 328 | |
|
329 | 329 | if auth_resources: |
|
330 | 330 | ce_auth_resources.extend(auth_resources) |
|
331 | 331 | |
|
332 | 332 | for resource in ce_auth_resources: |
|
333 | 333 | config.include(resource) |
|
334 | 334 | |
|
335 | 335 | # Auto discover authentication plugins and include their configuration. |
|
336 | 336 | if asbool(settings.get('auth_plugin.import_legacy_plugins', 'true')): |
|
337 | 337 | from rhodecode.authentication import discover_legacy_plugins |
|
338 | 338 | discover_legacy_plugins(config) |
|
339 | 339 | |
|
340 | 340 | # apps |
|
341 | 341 | if load_all: |
|
342 | 342 | config.include('rhodecode.api') |
|
343 | 343 | config.include('rhodecode.apps._base') |
|
344 | 344 | config.include('rhodecode.apps.hovercards') |
|
345 | 345 | config.include('rhodecode.apps.ops') |
|
346 | 346 | config.include('rhodecode.apps.channelstream') |
|
347 | 347 | config.include('rhodecode.apps.file_store') |
|
348 | 348 | config.include('rhodecode.apps.admin') |
|
349 | 349 | config.include('rhodecode.apps.login') |
|
350 | 350 | config.include('rhodecode.apps.home') |
|
351 | 351 | config.include('rhodecode.apps.journal') |
|
352 | 352 | |
|
353 | 353 | config.include('rhodecode.apps.repository') |
|
354 | 354 | config.include('rhodecode.apps.repo_group') |
|
355 | 355 | config.include('rhodecode.apps.user_group') |
|
356 | 356 | config.include('rhodecode.apps.search') |
|
357 | 357 | config.include('rhodecode.apps.user_profile') |
|
358 | 358 | config.include('rhodecode.apps.user_group_profile') |
|
359 | 359 | config.include('rhodecode.apps.my_account') |
|
360 | 360 | config.include('rhodecode.apps.gist') |
|
361 | 361 | |
|
362 | 362 | config.include('rhodecode.apps.svn_support') |
|
363 | 363 | config.include('rhodecode.apps.ssh_support') |
|
364 | 364 | config.include('rhodecode.apps.debug_style') |
|
365 | 365 | |
|
366 | 366 | if load_all: |
|
367 | 367 | config.include('rhodecode.integrations') |
|
368 | 368 | |
|
369 | 369 | config.add_route('rhodecode_support', 'https://rhodecode.com/help/', static=True) |
|
370 | 370 | config.add_translation_dirs('rhodecode:i18n/') |
|
371 | 371 | settings['default_locale_name'] = settings.get('lang', 'en') |
|
372 | 372 | |
|
373 | 373 | # Add subscribers. |
|
374 | 374 | if load_all: |
|
375 | 375 | config.add_subscriber(scan_repositories_if_enabled, |
|
376 | 376 | pyramid.events.ApplicationCreated) |
|
377 | 377 | config.add_subscriber(write_metadata_if_needed, |
|
378 | 378 | pyramid.events.ApplicationCreated) |
|
379 | 379 | config.add_subscriber(write_usage_data, |
|
380 | 380 | pyramid.events.ApplicationCreated) |
|
381 | 381 | config.add_subscriber(write_js_routes_if_enabled, |
|
382 | 382 | pyramid.events.ApplicationCreated) |
|
383 | 383 | |
|
384 | 384 | # request custom methods |
|
385 | 385 | config.add_request_method( |
|
386 | 386 | 'rhodecode.lib.partial_renderer.get_partial_renderer', |
|
387 | 387 | 'get_partial_renderer') |
|
388 | 388 | |
|
389 | 389 | config.add_request_method( |
|
390 | 390 | 'rhodecode.lib.request_counter.get_request_counter', |
|
391 | 391 | 'request_count') |
|
392 | 392 | |
|
393 | 393 | # Set the authorization policy. |
|
394 | 394 | authz_policy = ACLAuthorizationPolicy() |
|
395 | 395 | config.set_authorization_policy(authz_policy) |
|
396 | 396 | |
|
397 | 397 | # Set the default renderer for HTML templates to mako. |
|
398 | 398 | config.add_mako_renderer('.html') |
|
399 | 399 | |
|
400 | 400 | config.add_renderer( |
|
401 | 401 | name='json_ext', |
|
402 | 402 | factory='rhodecode.lib.ext_json_renderer.pyramid_ext_json') |
|
403 | 403 | |
|
404 | 404 | config.add_renderer( |
|
405 | 405 | name='string_html', |
|
406 | 406 | factory='rhodecode.lib.string_renderer.html') |
|
407 | 407 | |
|
408 | 408 | # include RhodeCode plugins |
|
409 | 409 | includes = aslist(settings.get('rhodecode.includes', [])) |
|
410 | 410 | for inc in includes: |
|
411 | 411 | config.include(inc) |
|
412 | 412 | |
|
413 | 413 | # custom not found view, if our pyramid app doesn't know how to handle |
|
414 | 414 | # the request pass it to potential VCS handling ap |
|
415 | 415 | config.add_notfound_view(not_found_view) |
|
416 | 416 | if not settings.get('debugtoolbar.enabled', False): |
|
417 | 417 | # disabled debugtoolbar handle all exceptions via the error_handlers |
|
418 | 418 | config.add_view(error_handler, context=Exception) |
|
419 | 419 | |
|
420 | 420 | # all errors including 403/404/50X |
|
421 | 421 | config.add_view(error_handler, context=HTTPError) |
|
422 | 422 | |
|
423 | 423 | |
|
424 | 424 | def wrap_app_in_wsgi_middlewares(pyramid_app, config): |
|
425 | 425 | """ |
|
426 | 426 | Apply outer WSGI middlewares around the application. |
|
427 | 427 | """ |
|
428 | 428 | registry = config.registry |
|
429 | 429 | settings = registry.settings |
|
430 | 430 | |
|
431 | 431 | # enable https redirects based on HTTP_X_URL_SCHEME set by proxy |
|
432 | 432 | pyramid_app = HttpsFixup(pyramid_app, settings) |
|
433 | 433 | |
|
434 | 434 | pyramid_app, _ae_client = wrap_in_appenlight_if_enabled( |
|
435 | 435 | pyramid_app, settings) |
|
436 | 436 | registry.ae_client = _ae_client |
|
437 | 437 | |
|
438 | 438 | if settings['gzip_responses']: |
|
439 | 439 | pyramid_app = make_gzip_middleware( |
|
440 | 440 | pyramid_app, settings, compress_level=1) |
|
441 | 441 | |
|
442 | 442 | # this should be the outer most middleware in the wsgi stack since |
|
443 | 443 | # middleware like Routes make database calls |
|
444 | 444 | def pyramid_app_with_cleanup(environ, start_response): |
|
445 | 445 | try: |
|
446 | 446 | return pyramid_app(environ, start_response) |
|
447 | 447 | finally: |
|
448 | 448 | # Dispose current database session and rollback uncommitted |
|
449 | 449 | # transactions. |
|
450 | 450 | meta.Session.remove() |
|
451 | 451 | |
|
452 | 452 | # In a single threaded mode server, on non sqlite db we should have |
|
453 | 453 | # '0 Current Checked out connections' at the end of a request, |
|
454 | 454 | # if not, then something, somewhere is leaving a connection open |
|
455 | 455 | pool = meta.Base.metadata.bind.engine.pool |
|
456 | 456 | log.debug('sa pool status: %s', pool.status()) |
|
457 | 457 | log.debug('Request processing finalized') |
|
458 | 458 | |
|
459 | 459 | return pyramid_app_with_cleanup |
|
460 | 460 | |
|
461 | 461 | |
|
462 | 462 | def sanitize_settings_and_apply_defaults(global_config, settings): |
|
463 | 463 | """ |
|
464 | 464 | Applies settings defaults and does all type conversion. |
|
465 | 465 | |
|
466 | 466 | We would move all settings parsing and preparation into this place, so that |
|
467 | 467 | we have only one place left which deals with this part. The remaining parts |
|
468 | 468 | of the application would start to rely fully on well prepared settings. |
|
469 | 469 | |
|
470 | 470 | This piece would later be split up per topic to avoid a big fat monster |
|
471 | 471 | function. |
|
472 | 472 | """ |
|
473 | 473 | |
|
474 | 474 | global_settings_maker = SettingsMaker(global_config) |
|
475 | 475 | global_settings_maker.make_setting('debug', default=False, parser='bool') |
|
476 | 476 | debug_enabled = asbool(global_config.get('debug')) |
|
477 | 477 | |
|
478 | 478 | settings_maker = SettingsMaker(settings) |
|
479 | 479 | |
|
480 | 480 | settings_maker.make_setting( |
|
481 | 481 | 'logging.autoconfigure', |
|
482 | 482 | default=True, |
|
483 | 483 | parser='bool') |
|
484 | 484 | |
|
485 | 485 | logging_conf = os.path.join(os.path.dirname(global_config.get('__file__')), 'logging.ini') |
|
486 | 486 | settings_maker.enable_logging(logging_conf, level='INFO' if debug_enabled else 'DEBUG') |
|
487 | 487 | |
|
488 | 488 | # Default includes, possible to change as a user |
|
489 | 489 | pyramid_includes = settings_maker.make_setting('pyramid.includes', [], parser='list:newline') |
|
490 | 490 | log.debug( |
|
491 | 491 | "Using the following pyramid.includes: %s", |
|
492 | 492 | pyramid_includes) |
|
493 | 493 | |
|
494 | 494 | settings_maker.make_setting('rhodecode.edition', 'Community Edition') |
|
495 | 495 | settings_maker.make_setting('rhodecode.edition_id', 'CE') |
|
496 | 496 | |
|
497 | 497 | if 'mako.default_filters' not in settings: |
|
498 | 498 | # set custom default filters if we don't have it defined |
|
499 | 499 | settings['mako.imports'] = 'from rhodecode.lib.base import h_filter' |
|
500 | 500 | settings['mako.default_filters'] = 'h_filter' |
|
501 | 501 | |
|
502 | 502 | if 'mako.directories' not in settings: |
|
503 | 503 | mako_directories = settings.setdefault('mako.directories', [ |
|
504 | 504 | # Base templates of the original application |
|
505 | 505 | 'rhodecode:templates', |
|
506 | 506 | ]) |
|
507 | 507 | log.debug( |
|
508 | 508 | "Using the following Mako template directories: %s", |
|
509 | 509 | mako_directories) |
|
510 | 510 | |
|
511 | 511 | # NOTE(marcink): fix redis requirement for schema of connection since 3.X |
|
512 | 512 | if 'beaker.session.type' in settings and settings['beaker.session.type'] == 'ext:redis': |
|
513 | 513 | raw_url = settings['beaker.session.url'] |
|
514 | 514 | if not raw_url.startswith(('redis://', 'rediss://', 'unix://')): |
|
515 | 515 | settings['beaker.session.url'] = 'redis://' + raw_url |
|
516 | 516 | |
|
517 | 517 | settings_maker.make_setting('__file__', global_config.get('__file__')) |
|
518 | 518 | |
|
519 | 519 | # TODO: johbo: Re-think this, usually the call to config.include |
|
520 | 520 | # should allow to pass in a prefix. |
|
521 | 521 | settings_maker.make_setting('rhodecode.api.url', '/_admin/api') |
|
522 | 522 | |
|
523 | 523 | # Sanitize generic settings. |
|
524 | 524 | settings_maker.make_setting('default_encoding', 'UTF-8', parser='list') |
|
525 | 525 | settings_maker.make_setting('is_test', False, parser='bool') |
|
526 | 526 | settings_maker.make_setting('gzip_responses', False, parser='bool') |
|
527 | 527 | |
|
528 | 528 | # statsd |
|
529 | 529 | settings_maker.make_setting('statsd.enabled', False, parser='bool') |
|
530 |
settings_maker.make_setting('statsd.statsd_host', ' |
|
|
531 |
settings_maker.make_setting('statsd.statsd_port', |
|
|
530 | settings_maker.make_setting('statsd.statsd_host', 'statsd-exporter', parser='string') | |
|
531 | settings_maker.make_setting('statsd.statsd_port', 9125, parser='int') | |
|
532 | 532 | settings_maker.make_setting('statsd.statsd_prefix', '') |
|
533 | 533 | settings_maker.make_setting('statsd.statsd_ipv6', False, parser='bool') |
|
534 | 534 | |
|
535 | 535 | settings_maker.make_setting('vcs.svn.compatible_version', '') |
|
536 | 536 | settings_maker.make_setting('vcs.hooks.protocol', 'http') |
|
537 | 537 | settings_maker.make_setting('vcs.hooks.host', '127.0.0.1') |
|
538 | 538 | settings_maker.make_setting('vcs.scm_app_implementation', 'http') |
|
539 | 539 | settings_maker.make_setting('vcs.server', '') |
|
540 | 540 | settings_maker.make_setting('vcs.server.protocol', 'http') |
|
541 | 541 | settings_maker.make_setting('startup.import_repos', 'false', parser='bool') |
|
542 | 542 | settings_maker.make_setting('vcs.hooks.direct_calls', 'false', parser='bool') |
|
543 | 543 | settings_maker.make_setting('vcs.server.enable', 'true', parser='bool') |
|
544 | 544 | settings_maker.make_setting('vcs.start_server', 'false', parser='bool') |
|
545 | 545 | settings_maker.make_setting('vcs.backends', 'hg, git, svn', parser='list') |
|
546 | 546 | settings_maker.make_setting('vcs.connection_timeout', 3600, parser='int') |
|
547 | 547 | |
|
548 | 548 | settings_maker.make_setting('vcs.methods.cache', True, parser='bool') |
|
549 | 549 | |
|
550 | 550 | # Support legacy values of vcs.scm_app_implementation. Legacy |
|
551 | 551 | # configurations may use 'rhodecode.lib.middleware.utils.scm_app_http', or |
|
552 | 552 | # disabled since 4.13 'vcsserver.scm_app' which is now mapped to 'http'. |
|
553 | 553 | scm_app_impl = settings['vcs.scm_app_implementation'] |
|
554 | 554 | if scm_app_impl in ['rhodecode.lib.middleware.utils.scm_app_http', 'vcsserver.scm_app']: |
|
555 | 555 | settings['vcs.scm_app_implementation'] = 'http' |
|
556 | 556 | |
|
557 | 557 | settings_maker.make_setting('appenlight', False, parser='bool') |
|
558 | 558 | |
|
559 | 559 | temp_store = tempfile.gettempdir() |
|
560 | 560 | default_cache_dir = os.path.join(temp_store, 'rc_cache') |
|
561 | 561 | |
|
562 | 562 | # save default, cache dir, and use it for all backends later. |
|
563 | 563 | default_cache_dir = settings_maker.make_setting( |
|
564 | 564 | 'cache_dir', |
|
565 | 565 | default=default_cache_dir, default_when_empty=True, |
|
566 | 566 | parser='dir:ensured') |
|
567 | 567 | |
|
568 | 568 | # exception store cache |
|
569 | 569 | settings_maker.make_setting( |
|
570 | 570 | 'exception_tracker.store_path', |
|
571 | 571 | default=os.path.join(default_cache_dir, 'exc_store'), default_when_empty=True, |
|
572 | 572 | parser='dir:ensured' |
|
573 | 573 | ) |
|
574 | 574 | |
|
575 | 575 | settings_maker.make_setting( |
|
576 | 576 | 'celerybeat-schedule.path', |
|
577 | 577 | default=os.path.join(default_cache_dir, 'celerybeat_schedule', 'celerybeat-schedule.db'), default_when_empty=True, |
|
578 | 578 | parser='file:ensured' |
|
579 | 579 | ) |
|
580 | 580 | |
|
581 | 581 | settings_maker.make_setting('exception_tracker.send_email', False, parser='bool') |
|
582 | 582 | settings_maker.make_setting('exception_tracker.email_prefix', '[RHODECODE ERROR]', default_when_empty=True) |
|
583 | 583 | |
|
584 | 584 | # cache_perms |
|
585 | 585 | settings_maker.make_setting('rc_cache.cache_perms.backend', 'dogpile.cache.rc.file_namespace') |
|
586 | 586 | settings_maker.make_setting('rc_cache.cache_perms.expiration_time', 60, parser='int') |
|
587 | 587 | settings_maker.make_setting('rc_cache.cache_perms.arguments.filename', os.path.join(default_cache_dir, 'rhodecode_cache_perms.db')) |
|
588 | 588 | |
|
589 | 589 | # cache_repo |
|
590 | 590 | settings_maker.make_setting('rc_cache.cache_repo.backend', 'dogpile.cache.rc.file_namespace') |
|
591 | 591 | settings_maker.make_setting('rc_cache.cache_repo.expiration_time', 60, parser='int') |
|
592 | 592 | settings_maker.make_setting('rc_cache.cache_repo.arguments.filename', os.path.join(default_cache_dir, 'rhodecode_cache_repo.db')) |
|
593 | 593 | |
|
594 | 594 | # cache_license |
|
595 | 595 | settings_maker.make_setting('rc_cache.cache_license.backend', 'dogpile.cache.rc.file_namespace') |
|
596 | 596 | settings_maker.make_setting('rc_cache.cache_license.expiration_time', 5*60, parser='int') |
|
597 | 597 | settings_maker.make_setting('rc_cache.cache_license.arguments.filename', os.path.join(default_cache_dir, 'rhodecode_cache_license.db')) |
|
598 | 598 | |
|
599 | 599 | # cache_repo_longterm memory, 96H |
|
600 | 600 | settings_maker.make_setting('rc_cache.cache_repo_longterm.backend', 'dogpile.cache.rc.memory_lru') |
|
601 | 601 | settings_maker.make_setting('rc_cache.cache_repo_longterm.expiration_time', 345600, parser='int') |
|
602 | 602 | settings_maker.make_setting('rc_cache.cache_repo_longterm.max_size', 10000, parser='int') |
|
603 | 603 | |
|
604 | 604 | # sql_cache_short |
|
605 | 605 | settings_maker.make_setting('rc_cache.sql_cache_short.backend', 'dogpile.cache.rc.memory_lru') |
|
606 | 606 | settings_maker.make_setting('rc_cache.sql_cache_short.expiration_time', 30, parser='int') |
|
607 | 607 | settings_maker.make_setting('rc_cache.sql_cache_short.max_size', 10000, parser='int') |
|
608 | 608 | |
|
609 | 609 | settings_maker.env_expand() |
|
610 | 610 | |
|
611 | 611 | # configure instance id |
|
612 | 612 | config_utils.set_instance_id(settings) |
|
613 | 613 | |
|
614 | 614 | return settings |
@@ -1,204 +1,207 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | |
|
3 | 3 | # Copyright (C) 2010-2020 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 os |
|
22 | 22 | import textwrap |
|
23 | 23 | import string |
|
24 | 24 | import functools |
|
25 | 25 | import logging |
|
26 | 26 | import tempfile |
|
27 | 27 | import logging.config |
|
28 | 28 | log = logging.getLogger(__name__) |
|
29 | 29 | |
|
30 | set_keys = {} | |
|
30 | # skip keys, that are set here, so we don't double process those | |
|
31 | set_keys = { | |
|
32 | '__file__': '' | |
|
33 | } | |
|
31 | 34 | |
|
32 | 35 | |
|
33 | 36 | def str2bool(_str): |
|
34 | 37 | """ |
|
35 | 38 | returns True/False value from given string, it tries to translate the |
|
36 | 39 | string into boolean |
|
37 | 40 | |
|
38 | 41 | :param _str: string value to translate into boolean |
|
39 | 42 | :rtype: boolean |
|
40 | 43 | :returns: boolean from given string |
|
41 | 44 | """ |
|
42 | 45 | if _str is None: |
|
43 | 46 | return False |
|
44 | 47 | if _str in (True, False): |
|
45 | 48 | return _str |
|
46 | 49 | _str = str(_str).strip().lower() |
|
47 | 50 | return _str in ('t', 'true', 'y', 'yes', 'on', '1') |
|
48 | 51 | |
|
49 | 52 | |
|
50 | 53 | def aslist(obj, sep=None, strip=True): |
|
51 | 54 | """ |
|
52 | 55 | Returns given string separated by sep as list |
|
53 | 56 | |
|
54 | 57 | :param obj: |
|
55 | 58 | :param sep: |
|
56 | 59 | :param strip: |
|
57 | 60 | """ |
|
58 | 61 | if isinstance(obj, (basestring,)): |
|
59 | 62 | if obj in ['', ""]: |
|
60 | 63 | return [] |
|
61 | 64 | |
|
62 | 65 | lst = obj.split(sep) |
|
63 | 66 | if strip: |
|
64 | 67 | lst = [v.strip() for v in lst] |
|
65 | 68 | return lst |
|
66 | 69 | elif isinstance(obj, (list, tuple)): |
|
67 | 70 | return obj |
|
68 | 71 | elif obj is None: |
|
69 | 72 | return [] |
|
70 | 73 | else: |
|
71 | 74 | return [obj] |
|
72 | 75 | |
|
73 | 76 | |
|
74 | 77 | class SettingsMaker(object): |
|
75 | 78 | |
|
76 | 79 | def __init__(self, app_settings): |
|
77 | 80 | self.settings = app_settings |
|
78 | 81 | |
|
79 | 82 | @classmethod |
|
80 | 83 | def _bool_func(cls, input_val): |
|
81 | 84 | if isinstance(input_val, unicode): |
|
82 | 85 | input_val = input_val.encode('utf8') |
|
83 | 86 | return str2bool(input_val) |
|
84 | 87 | |
|
85 | 88 | @classmethod |
|
86 | 89 | def _int_func(cls, input_val): |
|
87 | 90 | return int(input_val) |
|
88 | 91 | |
|
89 | 92 | @classmethod |
|
90 | 93 | def _list_func(cls, input_val, sep=','): |
|
91 | 94 | return aslist(input_val, sep=sep) |
|
92 | 95 | |
|
93 | 96 | @classmethod |
|
94 | 97 | def _string_func(cls, input_val, lower=True): |
|
95 | 98 | if lower: |
|
96 | 99 | input_val = input_val.lower() |
|
97 | 100 | return input_val |
|
98 | 101 | |
|
99 | 102 | @classmethod |
|
100 | 103 | def _float_func(cls, input_val): |
|
101 | 104 | return float(input_val) |
|
102 | 105 | |
|
103 | 106 | @classmethod |
|
104 | 107 | def _dir_func(cls, input_val, ensure_dir=False, mode=0o755): |
|
105 | 108 | |
|
106 | 109 | # ensure we have our dir created |
|
107 | 110 | if not os.path.isdir(input_val) and ensure_dir: |
|
108 | 111 | os.makedirs(input_val, mode=mode) |
|
109 | 112 | |
|
110 | 113 | if not os.path.isdir(input_val): |
|
111 | 114 | raise Exception('Dir at {} does not exist'.format(input_val)) |
|
112 | 115 | return input_val |
|
113 | 116 | |
|
114 | 117 | @classmethod |
|
115 | 118 | def _file_path_func(cls, input_val, ensure_dir=False, mode=0o755): |
|
116 | 119 | dirname = os.path.dirname(input_val) |
|
117 | 120 | cls._dir_func(dirname, ensure_dir=ensure_dir) |
|
118 | 121 | return input_val |
|
119 | 122 | |
|
120 | 123 | @classmethod |
|
121 | 124 | def _key_transformator(cls, key): |
|
122 | 125 | return "{}_{}".format('RC'.upper(), key.upper().replace('.', '_').replace('-', '_')) |
|
123 | 126 | |
|
124 | 127 | def maybe_env_key(self, key): |
|
125 | 128 | # now maybe we have this KEY in env, search and use the value with higher priority. |
|
126 | 129 | transformed_key = self._key_transformator(key) |
|
127 | 130 | envvar_value = os.environ.get(transformed_key) |
|
128 | 131 | if envvar_value: |
|
129 | 132 | log.debug('using `%s` key instead of `%s` key for config', transformed_key, key) |
|
130 | 133 | |
|
131 | 134 | return envvar_value |
|
132 | 135 | |
|
133 | 136 | def env_expand(self): |
|
134 | 137 | replaced = {} |
|
135 | 138 | for k, v in self.settings.items(): |
|
136 | 139 | if k not in set_keys: |
|
137 | 140 | envvar_value = self.maybe_env_key(k) |
|
138 | 141 | if envvar_value: |
|
139 | 142 | replaced[k] = envvar_value |
|
140 | 143 | set_keys[k] = envvar_value |
|
141 | 144 | |
|
142 | 145 | # replace ALL keys updated |
|
143 | 146 | self.settings.update(replaced) |
|
144 | 147 | |
|
145 | 148 | def enable_logging(self, logging_conf=None, level='INFO', formatter='generic'): |
|
146 | 149 | """ |
|
147 | 150 | Helper to enable debug on running instance |
|
148 | 151 | :return: |
|
149 | 152 | """ |
|
150 | 153 | |
|
151 | 154 | if not str2bool(self.settings.get('logging.autoconfigure')): |
|
152 | 155 | log.info('logging configuration based on main .ini file') |
|
153 | 156 | return |
|
154 | 157 | |
|
155 | 158 | if logging_conf is None: |
|
156 | 159 | logging_conf = self.settings.get('logging.logging_conf_file') or '' |
|
157 | 160 | |
|
158 | 161 | if not os.path.isfile(logging_conf): |
|
159 | 162 | log.error('Unable to setup logging based on %s, ' |
|
160 | 163 | 'file does not exist.... specify path using logging.logging_conf_file= config setting. ', logging_conf) |
|
161 | 164 | return |
|
162 | 165 | |
|
163 | 166 | with open(logging_conf, 'rb') as f: |
|
164 | 167 | ini_template = textwrap.dedent(f.read()) |
|
165 | 168 | ini_template = string.Template(ini_template).safe_substitute( |
|
166 | 169 | RC_LOGGING_LEVEL=os.environ.get('RC_LOGGING_LEVEL', '') or level, |
|
167 | 170 | RC_LOGGING_FORMATTER=os.environ.get('RC_LOGGING_FORMATTER', '') or formatter |
|
168 | 171 | ) |
|
169 | 172 | |
|
170 | 173 | with tempfile.NamedTemporaryFile(prefix='rc_logging_', suffix='.ini', delete=False) as f: |
|
171 | 174 | log.info('Saved Temporary LOGGING config at %s', f.name) |
|
172 | 175 | f.write(ini_template) |
|
173 | 176 | |
|
174 | 177 | logging.config.fileConfig(f.name) |
|
175 | 178 | os.remove(f.name) |
|
176 | 179 | |
|
177 | 180 | def make_setting(self, key, default, lower=False, default_when_empty=False, parser=None): |
|
178 | 181 | input_val = self.settings.get(key, default) |
|
179 | 182 | |
|
180 | 183 | if default_when_empty and not input_val: |
|
181 | 184 | # use default value when value is set in the config but it is empty |
|
182 | 185 | input_val = default |
|
183 | 186 | |
|
184 | 187 | parser_func = { |
|
185 | 188 | 'bool': self._bool_func, |
|
186 | 189 | 'int': self._int_func, |
|
187 | 190 | 'list': self._list_func, |
|
188 | 191 | 'list:newline': functools.partial(self._list_func, sep='/n'), |
|
189 | 192 | 'list:spacesep': functools.partial(self._list_func, sep=' '), |
|
190 | 193 | 'string': functools.partial(self._string_func, lower=lower), |
|
191 | 194 | 'dir': self._dir_func, |
|
192 | 195 | 'dir:ensured': functools.partial(self._dir_func, ensure_dir=True), |
|
193 | 196 | 'file': self._file_path_func, |
|
194 | 197 | 'file:ensured': functools.partial(self._file_path_func, ensure_dir=True), |
|
195 | 198 | None: lambda i: i |
|
196 | 199 | }[parser] |
|
197 | 200 | |
|
198 | 201 | envvar_value = self.maybe_env_key(key) |
|
199 | 202 | if envvar_value: |
|
200 | 203 | input_val = envvar_value |
|
201 | 204 | set_keys[key] = input_val |
|
202 | 205 | |
|
203 | 206 | self.settings[key] = parser_func(input_val) |
|
204 | 207 | return self.settings[key] |
General Comments 0
You need to be logged in to leave comments.
Login now