core: use proper event to bootstrap pylons env.

- allows to skip this for VCS and API calls in more efficient way.
- fixes  #5164

rhodecode/subscribers.py

@@ -1,166 +1,213 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program 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 Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 
 import logging
 import pylons
 import Queue
 import subprocess32
 
 from pyramid.i18n import get_localizer
 from pyramid.threadlocal import get_current_request
 from threading import Thread
 
 from rhodecode.translation import _ as tsf
 
+import rhodecode
+
+from pylons.i18n.translation import _get_translator
+from pylons.util import ContextObj
+from routes.util import URLGenerator
+
+from rhodecode.lib.base import attach_context_attributes, get_auth_user
+
 log = logging.getLogger(__name__)
 
 
 def add_renderer_globals(event):
     # Put pylons stuff into the context. This will be removed as soon as
     # migration to pyramid is finished.
     conf = pylons.config._current_obj()
     event['h'] = conf.get('pylons.h')
     event['c'] = pylons.tmpl_context
     event['url'] = pylons.url
 
     # TODO: When executed in pyramid view context the request is not available
     # in the event. Find a better solution to get the request.
     request = event['request'] or get_current_request()
 
     # Add Pyramid translation as '_' to context
     event['_'] = request.translate
     event['_ungettext'] = request.plularize
 
 
 def add_localizer(event):
     request = event.request
     localizer = get_localizer(request)
 
     def auto_translate(*args, **kwargs):
         return localizer.translate(tsf(*args, **kwargs))
 
     request.localizer = localizer
     request.translate = auto_translate
     request.plularize = localizer.pluralize
 
 
 def set_user_lang(event):
-    cur_user = getattr(event.request, 'user', None)
+    request = event.request
+    cur_user = getattr(request, 'user', None)
 
     if cur_user:
         user_lang = cur_user.get_instance().user_data.get('language')
         if user_lang:
             log.debug('lang: setting current user:%s language to: %s', cur_user, user_lang)
             event.request._LOCALE_ = user_lang
 
 
+def add_pylons_context(event):
+    request = event.request
+
+    config = rhodecode.CONFIG
+    environ = request.environ
+    session = request.session
+
+    if hasattr(request, 'vcs_call'):
+        # skip vcs calls
+        return
+
+    # Setup pylons globals.
+    pylons.config._push_object(config)
+    pylons.request._push_object(request)
+    pylons.session._push_object(session)
+    pylons.translator._push_object(_get_translator(config.get('lang')))
+
+    pylons.url._push_object(URLGenerator(config['routes.map'], environ))
+    session_key = (
+        config['pylons.environ_config'].get('session', 'beaker.session'))
+    environ[session_key] = session
+
+    if hasattr(request, 'rpc_method'):
+        # skip api calls
+        return
+
+    # Get the rhodecode auth user object and make it available.
+    auth_user = get_auth_user(environ)
+    request.user = auth_user
+    environ['rc_auth_user'] = auth_user
+
+    # Setup the pylons context object ('c')
+    context = ContextObj()
+    context.rhodecode_user = auth_user
+    attach_context_attributes(context, request)
+    pylons.tmpl_context._push_object(context)
+
+
 def scan_repositories_if_enabled(event):
     """
     This is subscribed to the `pyramid.events.ApplicationCreated` event. It
     does a repository scan if enabled in the settings.
     """
     from rhodecode.model.scm import ScmModel
     from rhodecode.lib.utils import repo2db_mapper, get_rhodecode_base_path
     settings = event.app.registry.settings
     vcs_server_enabled = settings['vcs.server.enable']
     import_on_startup = settings['startup.import_repos']
     if vcs_server_enabled and import_on_startup:
         repositories = ScmModel().repo_scan(get_rhodecode_base_path())
         repo2db_mapper(repositories, remove_obsolete=False)
 
 
 class Subscriber(object):
     """
     Base class for subscribers to the pyramid event system.
     """
     def __call__(self, event):
         self.run(event)
 
     def run(self, event):
         raise NotImplementedError('Subclass has to implement this.')
 
 
 class AsyncSubscriber(Subscriber):
     """
     Subscriber that handles the execution of events in a separate task to not
     block the execution of the code which triggers the event. It puts the
     received events into a queue from which the worker process takes them in
     order.
     """
     def __init__(self):
         self._stop = False
         self._eventq = Queue.Queue()
         self._worker = self.create_worker()
         self._worker.start()
 
     def __call__(self, event):
         self._eventq.put(event)
 
     def create_worker(self):
         worker = Thread(target=self.do_work)
         worker.daemon = True
         return worker
 
     def stop_worker(self):
         self._stop = False
         self._eventq.put(None)
         self._worker.join()
 
     def do_work(self):
         while not self._stop:
             event = self._eventq.get()
             if event is not None:
                 self.run(event)
 
 
 class AsyncSubprocessSubscriber(AsyncSubscriber):
     """
     Subscriber that uses the subprocess32 module to execute a command if an
     event is received. Events are handled asynchronously.
     """
 
     def __init__(self, cmd, timeout=None):
         super(AsyncSubprocessSubscriber, self).__init__()
         self._cmd = cmd
         self._timeout = timeout
 
     def run(self, event):
         cmd = self._cmd
         timeout = self._timeout
         log.debug('Executing command %s.', cmd)
 
         try:
             output = subprocess32.check_output(
                 cmd, timeout=timeout, stderr=subprocess32.STDOUT)
             log.debug('Command finished %s', cmd)
             if output:
                 log.debug('Command output: %s', output)
         except subprocess32.TimeoutExpired as e:
             log.exception('Timeout while executing command.')
             if e.output:
                 log.error('Command output: %s', e.output)
         except subprocess32.CalledProcessError as e:
             log.exception('Error while executing command.')
             if e.output:
                 log.error('Command output: %s', e.output)
         except:
             log.exception(
                 'Exception while executing command %s.', cmd)

rhodecode/tweens.py

@@ -1,98 +1,66 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2017 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program 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 Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 
 import logging
-import pylons
-import rhodecode
 
-from pylons.i18n.translation import _get_translator
-from pylons.util import ContextObj
-from routes.util import URLGenerator
-
-from rhodecode.lib.base import attach_context_attributes, get_auth_user
 from rhodecode.lib.middleware.vcs import (
     detect_vcs_request, VCS_TYPE_KEY, VCS_TYPE_SKIP)
-from rhodecode.model import meta
 
 
 log = logging.getLogger(__name__)
 
 
-def pylons_compatibility_tween_factory(handler, registry):
+def vcs_detection_tween_factory(handler, registry):
 
-    def pylons_compatibility_tween(request):
+    def vcs_detection_tween(request):
         """
-        While migrating from pylons to pyramid we need to call some pylons code
-        from pyramid. For example while rendering an old template that uses the
-        'c' or 'h' objects. This tween sets up the needed pylons globals.
+        Do detection of vcs type, and save results for other layers to re-use
+        this information
         """
-        config = rhodecode.CONFIG
-        environ = request.environ
-        session = request.session
 
         vcs_handler = detect_vcs_request(
             request.environ, request.registry.settings.get('vcs.backends'))
 
         if vcs_handler:
             # save detected VCS type for later re-use
             request.environ[VCS_TYPE_KEY] = vcs_handler.SCM
+            request.vcs_call = vcs_handler.SCM
             return handler(request)
 
         # mark that we didn't detect an VCS, and we can skip detection later on
         request.environ[VCS_TYPE_KEY] = VCS_TYPE_SKIP
 
-        # Setup pylons globals.
-        pylons.config._push_object(config)
-        pylons.request._push_object(request)
-        pylons.session._push_object(session)
-
-        session_key = (
-            config['pylons.environ_config'].get('session', 'beaker.session'))
-        environ[session_key] = session
-        pylons.url._push_object(URLGenerator(config['routes.map'], environ))
-
-        # TODO: Maybe we should use the language from pyramid.
-        translator = _get_translator(config.get('lang'))
-        pylons.translator._push_object(translator)
-
-        # Get the rhodecode auth user object and make it available.
-        auth_user = get_auth_user(environ)
-        request.user = auth_user
-        environ['rc_auth_user'] = auth_user
-
-        # Setup the pylons context object ('c')
-        context = ContextObj()
-        context.rhodecode_user = auth_user
-        attach_context_attributes(context, request)
-        pylons.tmpl_context._push_object(context)
         return handler(request)
 
-    return pylons_compatibility_tween
+    return vcs_detection_tween
 
 
 def includeme(config):
     config.add_subscriber('rhodecode.subscribers.add_renderer_globals',
                           'pyramid.events.BeforeRender')
     config.add_subscriber('rhodecode.subscribers.set_user_lang',
                           'pyramid.events.NewRequest')
     config.add_subscriber('rhodecode.subscribers.add_localizer',
                           'pyramid.events.NewRequest')
-    config.add_tween('rhodecode.tweens.pylons_compatibility_tween_factory')
+    config.add_subscriber('rhodecode.subscribers.add_pylons_context',
+                          'pyramid.events.ContextFound')
+
+    config.add_tween('rhodecode.tweens.vcs_detection_tween_factory')