##// END OF EJS Templates
pyramid: changes for pyramid migration.
pyramid: changes for pyramid migration.

File last commit:

r1711:2c4aeb83 default
r1908:81441341 default
Show More
simplevcs.py
531 lines | 21.7 KiB | text/x-python | PythonLexer
project: added all source files and assets
r1 # -*- coding: utf-8 -*-
license: updated copyright year to 2017
r1271 # Copyright (C) 2014-2017 RhodeCode GmbH
project: added all source files and assets
r1 #
# 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/
"""
SimpleVCS middleware for handling protocol request (push/clone etc.)
It's implemented with basic auth function
"""
import os
import logging
import importlib
Martin Bornhold
vcs: Move code for parsing the repository names (url, vcs, acl) from vcs to simplevcs.
r889 import re
project: added all source files and assets
r1 from functools import wraps
from paste.httpheaders import REMOTE_USER, AUTH_TYPE
from webob.exc import (
HTTPNotFound, HTTPForbidden, HTTPNotAcceptable, HTTPInternalServerError)
import rhodecode
from rhodecode.authentication.base import authenticate, VCS_TYPE
from rhodecode.lib.auth import AuthUser, HasPermissionAnyMiddleware
audit-logs: log user agent for push/pull.
r1711 from rhodecode.lib.base import (
BasicAuth, get_ip_addr, get_user_agent, vcs_operation_context)
project: added all source files and assets
r1 from rhodecode.lib.exceptions import (
HTTPLockedRC, HTTPRequirementError, UserCreationError,
NotAllowedToCreateUserError)
from rhodecode.lib.hooks_daemon import prepare_callback_daemon
from rhodecode.lib.middleware import appenlight
core: removed pyro4 from Enterprise code. Fixes #5198
r1409 from rhodecode.lib.middleware.utils import scm_app_http
Martin Bornhold
vcs: Retrieve base path and realm with new helper methods.
r579 from rhodecode.lib.utils import (
Martin Bornhold
vcs: Move shadow repo regex up to class level.
r902 is_valid_repo, get_rhodecode_realm, get_rhodecode_base_path, SLUG_RE)
Martin Bornhold
vcs: Clean up the shadow-repo-expose code and make some nicer comments.
r904 from rhodecode.lib.utils2 import safe_str, fix_PATH, str2bool, safe_unicode
Martin Bornhold
config: Use hooks protocol and direc calls seting from vcs settings module.
r590 from rhodecode.lib.vcs.conf import settings as vcs_settings
vcs: moved svn proxy settings into vcs related settings...
r754 from rhodecode.lib.vcs.backends import base
project: added all source files and assets
r1 from rhodecode.model import meta
Martin Bornhold
vcs: Fix missing import.
r894 from rhodecode.model.db import User, Repository, PullRequest
project: added all source files and assets
r1 from rhodecode.model.scm import ScmModel
Martin Bornhold
vcs: Fix missing import.
r894 from rhodecode.model.pull_request import PullRequestModel
project: added all source files and assets
r1
vcs: moved svn proxy settings into vcs related settings...
r754
project: added all source files and assets
r1 log = logging.getLogger(__name__)
def initialize_generator(factory):
"""
Initializes the returned generator by draining its first element.
This can be used to give a generator an initializer, which is the code
up to the first yield statement. This decorator enforces that the first
produced element has the value ``"__init__"`` to make its special
purpose very explicit in the using code.
"""
@wraps(factory)
def wrapper(*args, **kwargs):
gen = factory(*args, **kwargs)
try:
init = gen.next()
except StopIteration:
raise ValueError('Generator must yield at least one element.')
if init != "__init__":
raise ValueError('First yielded element must be "__init__".')
return gen
return wrapper
class SimpleVCS(object):
"""Common functionality for SCM HTTP handlers."""
SCM = 'unknown'
vcs: Minimal change to expose the shadow repository...
r887 acl_repo_name = None
url_repo_name = None
vcs_repo_name = None
Martin Bornhold
vcs: Move shadow repo regex up to class level.
r902 # We have to handle requests to shadow repositories different than requests
# to normal repositories. Therefore we have to distinguish them. To do this
# we use this regex which will match only on URLs pointing to shadow
# repositories.
shadow_repo_re = re.compile(
Martin Bornhold
shadow: Simplyfy the regular expression for detecting shadow repository URLs
r918 '(?P<groups>(?:{slug_pat}/)*)' # repo groups
'(?P<target>{slug_pat})/' # target repo
'pull-request/(?P<pr_id>\d+)/' # pull request
'repository$' # shadow repo
Martin Bornhold
vcs: Move shadow repo regex up to class level.
r902 .format(slug_pat=SLUG_RE.pattern))
Martin Bornhold
vcs: Pass registry to vcs for user authentication....
r591 def __init__(self, application, config, registry):
self.registry = registry
project: added all source files and assets
r1 self.application = application
self.config = config
vcs: register repo_name as specialized middleware variables instead...
r757 # re-populated by specialized middleware
vcs: moved svn proxy settings into vcs related settings...
r754 self.repo_vcs_config = base.Config()
vcs: register repo_name as specialized middleware variables instead...
r757
project: added all source files and assets
r1 # base path of repo locations
Martin Bornhold
vcs: Retrieve base path and realm with new helper methods.
r579 self.basepath = get_rhodecode_base_path()
project: added all source files and assets
r1 # authenticate this VCS request using authfunc
auth_ret_code_detection = \
str2bool(self.config.get('auth_ret_code_detection', False))
Martin Bornhold
vcs: Pass registry to vcs for user authentication....
r591 self.authenticate = BasicAuth(
'', authenticate, registry, config.get('auth_ret_code'),
auth_ret_code_detection)
project: added all source files and assets
r1 self.ip_addr = '0.0.0.0'
Martin Bornhold
vcs: Move code for parsing the repository names (url, vcs, acl) from vcs to simplevcs.
r889 def set_repo_names(self, environ):
"""
Martin Bornhold
vcs: Get shadow repository file system path by using already existing functions....
r892 This will populate the attributes acl_repo_name, url_repo_name,
Martin Bornhold
vcs: Clean up the shadow-repo-expose code and make some nicer comments.
r904 vcs_repo_name and is_shadow_repo. In case of requests to normal (non
shadow) repositories all names are equal. In case of requests to a
shadow repository the acl-name points to the target repo of the pull
request and the vcs-name points to the shadow repo file system path.
The url-name is always the URL used by the vcs client program.
Martin Bornhold
vcs: Move code for parsing the repository names (url, vcs, acl) from vcs to simplevcs.
r889
Martin Bornhold
vcs: Clean up the shadow-repo-expose code and make some nicer comments.
r904 Example in case of a shadow repo:
acl_repo_name = RepoGroup/MyRepo
url_repo_name = RepoGroup/MyRepo/pull-request/3/repository
vcs_repo_name = /repo/base/path/RepoGroup/.__shadow_MyRepo_pr-3'
"""
# First we set the repo name from URL for all attributes. This is the
# default if handling normal (non shadow) repo requests.
self.url_repo_name = self._get_repository_name(environ)
self.acl_repo_name = self.vcs_repo_name = self.url_repo_name
self.is_shadow_repo = False
# Check if this is a request to a shadow repository.
Martin Bornhold
vcs: Move shadow repo regex up to class level.
r902 match = self.shadow_repo_re.match(self.url_repo_name)
Martin Bornhold
vcs: Move code for parsing the repository names (url, vcs, acl) from vcs to simplevcs.
r889 if match:
match_dict = match.groupdict()
Martin Bornhold
vcs: Get shadow repository file system path by using already existing functions....
r892
Martin Bornhold
vcs: Clean up the shadow-repo-expose code and make some nicer comments.
r904 # Build acl repo name from regex match.
Martin Bornhold
shadow: Fix an error in the regex to detect shadow repository URLs.
r911 acl_repo_name = safe_unicode('{groups}{target}'.format(
groups=match_dict['groups'] or '',
target=match_dict['target']))
Martin Bornhold
vcs: Clean up the shadow-repo-expose code and make some nicer comments.
r904
# Retrieve pull request instance by ID from regex match.
pull_request = PullRequest.get(match_dict['pr_id'])
Martin Bornhold
vcs: Get shadow repository file system path by using already existing functions....
r892
Martin Bornhold
vcs: Clean up the shadow-repo-expose code and make some nicer comments.
r904 # Only proceed if we got a pull request and if acl repo name from
# URL equals the target repo name of the pull request.
Martin Bornhold
shadow: Fix an error in the regex to detect shadow repository URLs.
r911 if pull_request and (acl_repo_name ==
pull_request.target_repo.repo_name):
Martin Bornhold
vcs: Clean up the shadow-repo-expose code and make some nicer comments.
r904 # Get file system path to shadow repository.
workspace_id = PullRequestModel()._workspace_id(pull_request)
target_vcs = pull_request.target_repo.scm_instance()
vcs_repo_name = target_vcs._get_shadow_repository_path(
workspace_id)
# Store names for later usage.
self.vcs_repo_name = vcs_repo_name
self.acl_repo_name = acl_repo_name
self.is_shadow_repo = True
vcs: do an early detection of vcs-type request....
r1297 log.debug('Setting all VCS repository names: %s', {
Martin Bornhold
vcs: Clean up the shadow-repo-expose code and make some nicer comments.
r904 'acl_repo_name': self.acl_repo_name,
'url_repo_name': self.url_repo_name,
'vcs_repo_name': self.vcs_repo_name,
})
Martin Bornhold
vcs: Move code for parsing the repository names (url, vcs, acl) from vcs to simplevcs.
r889
project: added all source files and assets
r1 @property
def scm_app(self):
Martin Bornhold
http: Allow http, pyro and custom implementations for scm app.
r962 custom_implementation = self.config['vcs.scm_app_implementation']
if custom_implementation == 'http':
log.info('Using HTTP implementation of scm app.')
scm_app_impl = scm_app_http
else:
log.info('Using custom implementation of scm_app: "{}"'.format(
custom_implementation))
project: added all source files and assets
r1 scm_app_impl = importlib.import_module(custom_implementation)
return scm_app_impl
def _get_by_id(self, repo_name):
"""
Gets a special pattern _<ID> from clone url and tries to replace it
vcs: register repo_name as specialized middleware variables instead...
r757 with a repository_name for support of _<ID> non changeable urls
project: added all source files and assets
r1 """
data = repo_name.split('/')
if len(data) >= 2:
from rhodecode.model.repo import RepoModel
by_id_match = RepoModel().get_repo_by_id(repo_name)
if by_id_match:
data[1] = by_id_match.repo_name
return safe_str('/'.join(data))
def _invalidate_cache(self, repo_name):
"""
Set's cache for this repository for invalidation on next access
:param repo_name: full repo name, also a cache key
"""
ScmModel().mark_for_invalidation(repo_name)
def is_valid_and_existing_repo(self, repo_name, base_path, scm_type):
db_repo = Repository.get_by_repo_name(repo_name)
if not db_repo:
logging: fixed log formatting
r10 log.debug('Repository `%s` not found inside the database.',
repo_name)
project: added all source files and assets
r1 return False
if db_repo.repo_type != scm_type:
log.warning(
'Repository `%s` have incorrect scm_type, expected %s got %s',
repo_name, db_repo.repo_type, scm_type)
return False
simplevcs: fix a typo when running detection of vcs backend....
r1125 return is_valid_repo(repo_name, base_path, explicit_scm=scm_type)
project: added all source files and assets
r1
def valid_and_active_user(self, user):
"""
Checks if that user is not empty, and if it's actually object it checks
if he's active.
:param user: user object or None
:return: boolean
"""
if user is None:
return False
elif user.active:
return True
return False
def _check_permission(self, action, user, repo_name, ip_addr=None):
"""
Checks permissions using action (push/pull) user and repository
name
:param action: push or pull action
:param user: user instance
:param repo_name: repository name
"""
# check IP
inherit = user.inherit_default_permissions
ip_allowed = AuthUser.check_ip_allowed(user.user_id, ip_addr,
inherit_from_default=inherit)
if ip_allowed:
log.info('Access for IP:%s allowed', ip_addr)
else:
return False
if action == 'push':
if not HasPermissionAnyMiddleware('repository.write',
'repository.admin')(user,
repo_name):
return False
else:
# any other action need at least read permission
if not HasPermissionAnyMiddleware('repository.read',
'repository.write',
'repository.admin')(user,
repo_name):
return False
return True
def _check_ssl(self, environ, start_response):
"""
Checks the SSL check flag and returns False if SSL is not present
and required True otherwise
"""
org_proto = environ['wsgi._org_proto']
# check if we have SSL required ! if not it's a bad request !
vcs: re-use repo config propagated to the middleware to extract push_ssl...
r756 require_ssl = str2bool(self.repo_vcs_config.get('web', 'push_ssl'))
project: added all source files and assets
r1 if require_ssl and org_proto == 'http':
log.debug('proto is %s and SSL is required BAD REQUEST !',
org_proto)
return False
return True
def __call__(self, environ, start_response):
try:
return self._handle_request(environ, start_response)
except Exception:
log.exception("Exception while handling request")
appenlight.track_exception(environ)
return HTTPInternalServerError()(environ, start_response)
finally:
meta.Session.remove()
def _handle_request(self, environ, start_response):
if not self._check_ssl(environ, start_response):
reason = ('SSL required, while RhodeCode was unable '
'to detect this as SSL request')
log.debug('User not allowed to proceed, %s', reason)
return HTTPNotAcceptable(reason)(environ, start_response)
Martin Bornhold
vcs: Use correct repo name attribute and remove workaround.
r898 if not self.url_repo_name:
log.warning('Repository name is empty: %s', self.url_repo_name)
vcs: register repo_name as specialized middleware variables instead...
r757 # failed to get repo name, we fail now
return HTTPNotFound()(environ, start_response)
Martin Bornhold
vcs: Use correct repo name attribute and remove workaround.
r898 log.debug('Extracted repo name is %s', self.url_repo_name)
vcs: register repo_name as specialized middleware variables instead...
r757
project: added all source files and assets
r1 ip_addr = get_ip_addr(environ)
audit-logs: log user agent for push/pull.
r1711 user_agent = get_user_agent(environ)
project: added all source files and assets
r1 username = None
# skip passing error to error controller
environ['pylons.status_code_redirect'] = True
# ======================================================================
# GET ACTION PULL or PUSH
# ======================================================================
action = self._get_action(environ)
# ======================================================================
Martin Bornhold
vcs: Only allow 'pull' actions on shadow repositories....
r891 # Check if this is a request to a shadow repository of a pull request.
# In this case only pull action is allowed.
# ======================================================================
Martin Bornhold
vcs: Add flag to indicate if repository is a shadow repository.
r899 if self.is_shadow_repo and action != 'pull':
Martin Bornhold
vcs: Only allow 'pull' actions on shadow repositories....
r891 reason = 'Only pull action is allowed for shadow repositories.'
log.debug('User not allowed to proceed, %s', reason)
return HTTPNotAcceptable(reason)(environ, start_response)
# ======================================================================
project: added all source files and assets
r1 # CHECK ANONYMOUS PERMISSION
# ======================================================================
if action in ['pull', 'push']:
anonymous_user = User.get_default_user()
username = anonymous_user.username
if anonymous_user.active:
# ONLY check permissions if the user is activated
anonymous_perm = self._check_permission(
Martin Bornhold
vcs: Use correct repo name attribute and remove workaround.
r898 action, anonymous_user, self.acl_repo_name, ip_addr)
project: added all source files and assets
r1 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')
Martin Bornhold
vcs: Pass registry to vcs for user authentication....
r591 pre_auth = authenticate(
authentication: enabled authentication with auth_token and repository scope....
r1510 '', '', environ, VCS_TYPE, registry=self.registry,
acl_repo_name=self.acl_repo_name)
project: added all source files and assets
r1 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
authentication: enabled authentication with auth_token and repository scope....
r1510 # before inject the calling repo_name for special scope checks
self.authenticate.acl_repo_name = self.acl_repo_name
project: added all source files and assets
r1 if not username:
Martin Bornhold
vcs: Retrieve base path and realm with new helper methods.
r579 self.authenticate.realm = get_rhodecode_realm()
project: added all source files and assets
r1
try:
result = self.authenticate(environ)
except (UserCreationError, NotAllowedToCreateUserError) as e:
log.error(e)
reason = safe_str(e)
return HTTPNotAcceptable(reason)(environ, start_response)
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
# ==============================================================
user = User.get_by_username(username)
if not self.valid_and_active_user(user):
return HTTPForbidden()(environ, start_response)
username = user.username
user.update_lastactivity()
meta.Session().commit()
# check user attributes for password change flag
user_obj = user
if user_obj and user_obj.username != User.DEFAULT_USER and \
user_obj.user_data.get('force_password_change'):
reason = 'password change required'
log.debug('User not allowed to authenticate, %s', reason)
return HTTPNotAcceptable(reason)(environ, start_response)
# check permissions for this repository
vcs: register repo_name as specialized middleware variables instead...
r757 perm = self._check_permission(
Martin Bornhold
vcs: Use correct repo name attribute and remove workaround.
r898 action, user, self.acl_repo_name, ip_addr)
project: added all source files and assets
r1 if not perm:
return HTTPForbidden()(environ, start_response)
# extras are injected into UI object and later available
# in hooks executed by rhodecode
check_locking = _should_check_locking(environ.get('QUERY_STRING'))
extras = vcs_operation_context(
Martin Bornhold
vcs: Use correct repo name attribute and remove workaround.
r898 environ, repo_name=self.acl_repo_name, username=username,
Martin Bornhold
vcs: Add flag to indicate if repository is a shadow repository.
r899 action=action, scm=self.SCM, check_locking=check_locking,
is_shadow_repo=self.is_shadow_repo
)
project: added all source files and assets
r1
# ======================================================================
# REQUEST HANDLING
# ======================================================================
vcs: Minimal change to expose the shadow repository...
r887 repo_path = os.path.join(
safe_str(self.basepath), safe_str(self.vcs_repo_name))
project: added all source files and assets
r1 log.debug('Repository path is %s', repo_path)
fix_PATH()
log.info(
audit-logs: log user agent for push/pull.
r1711 '%s action on %s repo "%s" by "%s" from %s %s',
Martin Bornhold
vcs: Explicit use one of the repo names (acl, url, vcs)
r905 action, self.SCM, safe_str(self.url_repo_name),
audit-logs: log user agent for push/pull.
r1711 safe_str(username), ip_addr, user_agent)
Martin Bornhold
vcs: Add a flag to the environ to skip the error handling for responses from VCSMiddleware
r600
project: added all source files and assets
r1 return self._generate_vcs_response(
Martin Bornhold
vcs: Explicit use one of the repo names (acl, url, vcs)
r905 environ, start_response, repo_path, extras, action)
project: added all source files and assets
r1
@initialize_generator
def _generate_vcs_response(
Martin Bornhold
vcs: Explicit use one of the repo names (acl, url, vcs)
r905 self, environ, start_response, repo_path, extras, action):
project: added all source files and assets
r1 """
Returns a generator for the response content.
This method is implemented as a generator, so that it can trigger
the cache validation after all content sent back to the client. It
also handles the locking exceptions which will be triggered when
the first chunk is produced by the underlying WSGI application.
"""
callback_daemon, extras = self._prepare_callback_daemon(extras)
vcs: Minimal change to expose the shadow repository...
r887 config = self._create_config(extras, self.acl_repo_name)
project: added all source files and assets
r1 log.debug('HOOKS extras is %s', extras)
Martin Bornhold
vcs: Explicit use one of the repo names (acl, url, vcs)
r905 app = self._create_wsgi_app(repo_path, self.url_repo_name, config)
project: added all source files and assets
r1
try:
with callback_daemon:
try:
response = app(environ, start_response)
finally:
# This statement works together with the decorator
# "initialize_generator" above. The decorator ensures that
# we hit the first yield statement before the generator is
# returned back to the WSGI server. This is needed to
# ensure that the call to "app" above triggers the
# needed callback to "start_response" before the
# generator is actually used.
yield "__init__"
for chunk in response:
yield chunk
except Exception as exc:
Martin Bornhold
vcs: Add a comment about removing some code when dropping Pyro4 support.
r978 # TODO: martinb: Exceptions are only raised in case of the Pyro4
# backend. Refactor this except block after dropping Pyro4 support.
project: added all source files and assets
r1 # TODO: johbo: Improve "translating" back the exception.
if getattr(exc, '_vcs_kind', None) == 'repo_locked':
exc = HTTPLockedRC(*exc.args)
_code = rhodecode.CONFIG.get('lock_ret_code')
log.debug('Repository LOCKED ret code %s!', (_code,))
elif getattr(exc, '_vcs_kind', None) == 'requirement':
log.debug(
'Repository requires features unknown to this Mercurial')
exc = HTTPRequirementError(*exc.args)
else:
raise
for chunk in exc(environ, start_response):
yield chunk
finally:
# invalidate cache on push
dan
db: move Session.remove to outer wsgi layer and also add it...
r669 try:
if action == 'push':
Martin Bornhold
vcs: Explicit use one of the repo names (acl, url, vcs)
r905 self._invalidate_cache(self.url_repo_name)
dan
db: move Session.remove to outer wsgi layer and also add it...
r669 finally:
meta.Session.remove()
project: added all source files and assets
r1
def _get_repository_name(self, environ):
"""Get repository name out of the environmnent
:param environ: WSGI environment
"""
raise NotImplementedError()
def _get_action(self, environ):
"""Map request commands into a pull or push command.
:param environ: WSGI environment
"""
raise NotImplementedError()
def _create_wsgi_app(self, repo_path, repo_name, config):
"""Return the WSGI app that will finally handle the request."""
raise NotImplementedError()
def _create_config(self, extras, repo_name):
core: removed pyro4 from Enterprise code. Fixes #5198
r1409 """Create a safe config representation."""
project: added all source files and assets
r1 raise NotImplementedError()
def _prepare_callback_daemon(self, extras):
return prepare_callback_daemon(
Martin Bornhold
config: Use hooks protocol and direc calls seting from vcs settings module.
r590 extras, protocol=vcs_settings.HOOKS_PROTOCOL,
use_direct_calls=vcs_settings.HOOKS_DIRECT_CALLS)
project: added all source files and assets
r1
def _should_check_locking(query_string):
# this is kind of hacky, but due to how mercurial handles client-server
# server see all operation on commit; bookmarks, phases and
# obsolescence marker in different transaction, we don't want to check
# locking on those
return query_string not in ['cmd=listkeys']