Files @ 7e5f8c12a3fc
Branch filter:

Location: kallithea/rhodecode/lib/middleware/simplehg.py - annotation

Bradley M. Kuhn
First step in two-part process to rename directories to kallithea.
This first step is to change all references in the files where they refer
to the old directory name.
04c9bb9ca6d6
a671db5bdd58
a671db5bdd58
a671db5bdd58
a671db5bdd58
6832ef664673
1e757ac98988
1e757ac98988
1e757ac98988
1e757ac98988
6832ef664673
1e757ac98988
a671db5bdd58
ffd45b185016
7e5f8c12a3fc
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
1e757ac98988
811fa5d45de8
811fa5d45de8
811fa5d45de8
811fa5d45de8
1e757ac98988
f0851f37d6be
ffd45b185016
7e5f8c12a3fc
811fa5d45de8
7e5f8c12a3fc
238486bb71ab
7e5f8c12a3fc
7e5f8c12a3fc
7e5f8c12a3fc
7e5f8c12a3fc
7e5f8c12a3fc
72bed56219d6
1e757ac98988
1e757ac98988
2723276285ae
01be209b9828
f0649c7cf94a
f0649c7cf94a
01be209b9828
01be209b9828
01be209b9828
f0649c7cf94a
01be209b9828
f0649c7cf94a
f0649c7cf94a
f0649c7cf94a
f0649c7cf94a
f0649c7cf94a
f0649c7cf94a
f0649c7cf94a
f0649c7cf94a
01be209b9828
2723276285ae
b265be1c6093
1e757ac98988
b265be1c6093
1e757ac98988
1e757ac98988
f0851f37d6be
f0851f37d6be
070f32743632
9b92cf5a0cca
d5e42c00f3c1
9c4851dce8e6
9c4851dce8e6
0b268dd369ec
5bd42279930c
5bd42279930c
5bd42279930c
5bd42279930c
5bd42279930c
5bd42279930c
10b4e34841a4
5bd42279930c
070f32743632
c137b8a81f8e
260a7a01b054
c137b8a81f8e
c137b8a81f8e
811fa5d45de8
811fa5d45de8
811fa5d45de8
5bd42279930c
f0649c7cf94a
811fa5d45de8
811fa5d45de8
811fa5d45de8
5bd42279930c
811fa5d45de8
5bd42279930c
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
811fa5d45de8
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
260a7a01b054
2723276285ae
2723276285ae
ffd45b185016
ffd45b185016
b2d5868cc4b8
6832ef664673
b2d5868cc4b8
b2d5868cc4b8
ff449e9e6e38
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
ffd45b185016
25d8e4836bc2
25d8e4836bc2
25d8e4836bc2
b7563ad4e7ee
b7563ad4e7ee
811fa5d45de8
811fa5d45de8
811fa5d45de8
811fa5d45de8
25d8e4836bc2
811fa5d45de8
811fa5d45de8
811fa5d45de8
b2d5868cc4b8
25d8e4836bc2
b2d5868cc4b8
94ef0b609d17
94ef0b609d17
94ef0b609d17
94ef0b609d17
94ef0b609d17
10b4e34841a4
94ef0b609d17
94ef0b609d17
811fa5d45de8
94ef0b609d17
9b92cf5a0cca
260a7a01b054
94ef0b609d17
070f32743632
f0649c7cf94a
f0649c7cf94a
7e5f8c12a3fc
5085e51fba3a
f0649c7cf94a
9b92cf5a0cca
f0649c7cf94a
f0649c7cf94a
d9972f76322e
d9972f76322e
bad89b2fe618
5085e51fba3a
aa17c7a1b8a5
aa17c7a1b8a5
f0649c7cf94a
2723276285ae
1e757ac98988
2723276285ae
336184b9f4cf
336184b9f4cf
5bd42279930c
0b268dd369ec
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
aa17c7a1b8a5
ccbdff90e5a0
aa17c7a1b8a5
5bd42279930c
5bd42279930c
0b268dd369ec
1e757ac98988
e7ba69286276
336184b9f4cf
5bd42279930c
5bd42279930c
1e757ac98988
1e757ac98988
1e757ac98988
aa17c7a1b8a5
7174ee850baa
7174ee850baa
aa17c7a1b8a5
1e757ac98988
1e757ac98988
1e757ac98988
c2bf0fa7b3cb
c2bf0fa7b3cb
c2bf0fa7b3cb
c2bf0fa7b3cb
72bed56219d6
5bd42279930c
88e750527c7c
88e750527c7c
88e750527c7c
811fa5d45de8
5bd42279930c
811fa5d45de8
811fa5d45de8
88e750527c7c
a5888ca796b5
6832ef664673
811fa5d45de8
811fa5d45de8
811fa5d45de8
a8c66e870bd0
811fa5d45de8
811fa5d45de8
811fa5d45de8
10b4e34841a4
811fa5d45de8
811fa5d45de8
811fa5d45de8
811fa5d45de8
811fa5d45de8
1e757ac98988
04027bdb876c
72bed56219d6
1e757ac98988
88e750527c7c
88e750527c7c
f31f1327c1e9
6832ef664673
72bed56219d6
1e757ac98988
1e757ac98988
1e757ac98988
1e757ac98988
7f5976da192c
1e757ac98988
1e757ac98988
1e757ac98988
1e757ac98988
1e757ac98988
2723276285ae
1e757ac98988
044c31d67ccc
c35980ae7958
c35980ae7958
c35980ae7958
c35980ae7958
72bed56219d6
0b268dd369ec
560206522815
560206522815
cf51bbfb120e
560206522815
cf51bbfb120e
560206522815
560206522815
560206522815
72bed56219d6
5bd42279930c
5bd42279930c
5bd42279930c
5bd42279930c
070f32743632
1e757ac98988
72bed56219d6
1e757ac98988
1e757ac98988
1e757ac98988
1e757ac98988
560206522815
238486bb71ab
# -*- coding: utf-8 -*-
# This program 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.
#
# 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 General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""
kallithea.lib.middleware.simplehg
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

SimpleHG middleware for handling mercurial protocol request
(push/clone etc.). It's implemented with basic auth function

:created_on: Apr 28, 2010
:author: marcink
:copyright: (c) 2013 RhodeCode GmbH.
:license: GPLv3, see LICENSE for more details.

"""


import os
import logging
import traceback

from paste.httpheaders import REMOTE_USER, AUTH_TYPE
from webob.exc import HTTPNotFound, HTTPForbidden, HTTPInternalServerError, \
    HTTPNotAcceptable
from kallithea.model.db import User

from kallithea.lib.utils2 import safe_str, fix_PATH, get_server_url,\
    _set_extras
from kallithea.lib.base import BaseVCSController
from kallithea.lib.utils import make_ui, is_valid_repo, ui_sections
from kallithea.lib.vcs.utils.hgcompat import RepoError, hgweb_mod
from kallithea.lib.exceptions import HTTPLockedRC
from kallithea.lib import auth_modules

log = logging.getLogger(__name__)


def is_mercurial(environ):
    """
    Returns True if request's target is mercurial server - header
    ``HTTP_ACCEPT`` of such request would start with ``application/mercurial``.
    """
    http_accept = environ.get('HTTP_ACCEPT')
    path_info = environ['PATH_INFO']
    if http_accept and http_accept.startswith('application/mercurial'):
        ishg_path = True
    else:
        ishg_path = False

    log.debug('pathinfo: %s detected as HG %s' % (
        path_info, ishg_path)
    )
    return ishg_path


class SimpleHg(BaseVCSController):

    def _handle_request(self, environ, start_response):
        if not is_mercurial(environ):
            return self.application(environ, start_response)
        if not self._check_ssl(environ, start_response):
            return HTTPNotAcceptable('SSL REQUIRED !')(environ, start_response)

        ip_addr = self._get_ip_addr(environ)
        username = None
        # skip passing error to error controller
        environ['pylons.status_code_redirect'] = True

        #======================================================================
        # EXTRACT REPOSITORY NAME FROM ENV
        #======================================================================
        try:
            repo_name = environ['REPO_NAME'] = self.__get_repository(environ)
            log.debug('Extracted repo name is %s' % repo_name)
        except Exception:
            return HTTPInternalServerError()(environ, start_response)

        # quick check if that dir exists...
        if not is_valid_repo(repo_name, self.basepath, 'hg'):
            return HTTPNotFound()(environ, start_response)

        #======================================================================
        # GET ACTION PULL or PUSH
        #======================================================================
        action = self.__get_action(environ)

        #======================================================================
        # CHECK ANONYMOUS PERMISSION
        #======================================================================
        if action in ['pull', 'push']:
            anonymous_user = self.__get_user('default')
            username = anonymous_user.username
            if anonymous_user.active:
                # ONLY check permissions if the user is activated
                anonymous_perm = self._check_permission(action, anonymous_user,
                                                        repo_name, ip_addr)
            else:
                anonymous_perm = False

            if not anonymous_user.active or not anonymous_perm:
                if not anonymous_user.active:
                    log.debug('Anonymous access is disabled, running '
                              'authentication')

                if not anonymous_perm:
                    log.debug('Not enough credentials to access this '
                              'repository as anonymous user')

                username = None
                #==============================================================
                # DEFAULT PERM FAILED OR ANONYMOUS ACCESS IS DISABLED SO WE
                # NEED TO AUTHENTICATE AND ASK FOR AUTH USER PERMISSIONS
                #==============================================================

                # try to auth based on environ, container auth methods
                log.debug('Running PRE-AUTH for container based authentication')
                pre_auth = auth_modules.authenticate('', '', environ)
                if pre_auth and pre_auth.get('username'):
                    username = pre_auth['username']
                log.debug('PRE-AUTH got %s as username' % username)

                # If not authenticated by the container, running basic auth
                if not username:
                    self.authenticate.realm = \
                        safe_str(self.config['rhodecode_realm'])
                    result = self.authenticate(environ)
                    if isinstance(result, str):
                        AUTH_TYPE.update(environ, 'basic')
                        REMOTE_USER.update(environ, result)
                        username = result
                    else:
                        return result.wsgi_application(environ, start_response)

                #==============================================================
                # CHECK PERMISSIONS FOR THIS REQUEST USING GIVEN USERNAME
                #==============================================================
                try:
                    user = self.__get_user(username)
                    if user is None or not user.active:
                        return HTTPForbidden()(environ, start_response)
                    username = user.username
                except Exception:
                    log.error(traceback.format_exc())
                    return HTTPInternalServerError()(environ, start_response)

                #check permissions for this repository
                perm = self._check_permission(action, user, repo_name, ip_addr)
                if not perm:
                    return HTTPForbidden()(environ, start_response)

        # extras are injected into mercurial UI object and later available
        # in hg hooks executed by rhodecode
        from kallithea import CONFIG
        server_url = get_server_url(environ)
        extras = {
            'ip': ip_addr,
            'username': username,
            'action': action,
            'repository': repo_name,
            'scm': 'hg',
            'config': CONFIG['__file__'],
            'server_url': server_url,
            'make_lock': None,
            'locked_by': [None, None]
        }
        #======================================================================
        # MERCURIAL REQUEST HANDLING
        #======================================================================
        str_repo_name = safe_str(repo_name)
        repo_path = os.path.join(safe_str(self.basepath), str_repo_name)
        log.debug('Repository path is %s' % repo_path)

        # CHECK LOCKING only if it's not ANONYMOUS USER
        if username != User.DEFAULT_USER:
            log.debug('Checking locking on repository')
            (make_lock,
             locked,
             locked_by) = self._check_locking_state(
                            environ=environ, action=action,
                            repo=repo_name, user_id=user.user_id
                       )
            # store the make_lock for later evaluation in hooks
            extras.update({'make_lock': make_lock,
                           'locked_by': locked_by})

        fix_PATH()
        log.debug('HOOKS extras is %s' % extras)
        baseui = make_ui('db')
        self.__inject_extras(repo_path, baseui, extras)

        try:
            log.info('%s action on HG repo "%s" by "%s" from %s' %
                     (action, str_repo_name, safe_str(username), ip_addr))
            app = self.__make_app(repo_path, baseui, extras)
            return app(environ, start_response)
        except RepoError, e:
            if str(e).find('not found') != -1:
                return HTTPNotFound()(environ, start_response)
        except HTTPLockedRC, e:
            _code = CONFIG.get('lock_ret_code')
            log.debug('Repository LOCKED ret code %s!' % (_code))
            return e(environ, start_response)
        except Exception:
            log.error(traceback.format_exc())
            return HTTPInternalServerError()(environ, start_response)
        finally:
            # invalidate cache on push
            if action == 'push':
                self._invalidate_cache(repo_name)

    def __make_app(self, repo_name, baseui, extras):
        """
        Make an wsgi application using hgweb, and inject generated baseui
        instance, additionally inject some extras into ui object
        """
        return hgweb_mod.hgweb(repo_name, name=repo_name, baseui=baseui)

    def __get_repository(self, environ):
        """
        Gets repository name out of PATH_INFO header

        :param environ: environ where PATH_INFO is stored
        """
        try:
            environ['PATH_INFO'] = self._get_by_id(environ['PATH_INFO'])
            repo_name = '/'.join(environ['PATH_INFO'].split('/')[1:])
            if repo_name.endswith('/'):
                repo_name = repo_name.rstrip('/')
        except Exception:
            log.error(traceback.format_exc())
            raise

        return repo_name

    def __get_user(self, username):
        return User.get_by_username(username)

    def __get_action(self, environ):
        """
        Maps mercurial request commands into a clone,pull or push command.
        This should always return a valid command string

        :param environ:
        """
        mapping = {'changegroup': 'pull',
                   'changegroupsubset': 'pull',
                   'stream_out': 'pull',
                   'listkeys': 'pull',
                   'unbundle': 'push',
                   'pushkey': 'push', }
        for qry in environ['QUERY_STRING'].split('&'):
            if qry.startswith('cmd'):
                cmd = qry.split('=')[-1]
                if cmd in mapping:
                    return mapping[cmd]

                return 'pull'

        raise Exception('Unable to detect pull/push action !!'
                        'Are you using non standard command or client ?')

    def __inject_extras(self, repo_path, baseui, extras={}):
        """
        Injects some extra params into baseui instance

        also overwrites global settings with those takes from local hgrc file

        :param baseui: baseui instance
        :param extras: dict with extra params to put into baseui
        """

        hgrc = os.path.join(repo_path, '.hg', 'hgrc')

        # make our hgweb quiet so it doesn't print output
        baseui.setconfig('ui', 'quiet', 'true')

        repoui = make_ui('file', hgrc, False)

        if repoui:
            #overwrite our ui instance with the section from hgrc file
            for section in ui_sections:
                for k, v in repoui.configitems(section):
                    baseui.setconfig(section, k, v)
        _set_extras(extras)