##// END OF EJS Templates
api: use consistent way to extract users, repos, repo groups and user groups by id or name....
api: use consistent way to extract users, repos, repo groups and user groups by id or name. - makes usage of Number vs String to differenciate if we pick objec ID or it's name this will allow easy fetching of objects by either id or it's name, including numeric string name - fixes #5230

File last commit:

r1271:47a44c03 default
r1530:1efcb4ee default
Show More
__init__.py
89 lines | 3.3 KiB | text/x-python | PythonLexer
# -*- coding: utf-8 -*-
# Copyright (C) 2016-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 os
import shlex
# Do not use `from rhodecode import events` here, it will be overridden by the
# events module in this package due to pythons import mechanism.
from rhodecode.events import RepoGroupEvent
from rhodecode.subscribers import AsyncSubprocessSubscriber
from rhodecode.config.middleware import (
_bool_setting, _string_setting, _int_setting)
from .events import ModDavSvnConfigChange
from .subscribers import generate_config_subscriber
from . import config_keys
log = logging.getLogger(__name__)
def includeme(config):
settings = config.registry.settings
_sanitize_settings_and_apply_defaults(settings)
if settings[config_keys.generate_config]:
# Add subscriber to generate the Apache mod dav svn configuration on
# repository group events.
config.add_subscriber(generate_config_subscriber, RepoGroupEvent)
# If a reload command is set add a subscriber to execute it on
# configuration changes.
reload_cmd = shlex.split(settings[config_keys.reload_command])
if reload_cmd:
reload_timeout = settings[config_keys.reload_timeout] or None
reload_subscriber = AsyncSubprocessSubscriber(
cmd=reload_cmd, timeout=reload_timeout)
config.add_subscriber(reload_subscriber, ModDavSvnConfigChange)
def _sanitize_settings_and_apply_defaults(settings):
"""
Set defaults, convert to python types and validate settings.
"""
_bool_setting(settings, config_keys.generate_config, 'false')
_bool_setting(settings, config_keys.list_parent_path, 'true')
_int_setting(settings, config_keys.reload_timeout, 10)
_string_setting(settings, config_keys.config_file_path, '', lower=False)
_string_setting(settings, config_keys.location_root, '/', lower=False)
_string_setting(settings, config_keys.reload_command, '', lower=False)
# Convert negative timeout values to zero.
if settings[config_keys.reload_timeout] < 0:
settings[config_keys.reload_timeout] = 0
# Append path separator to location root.
settings[config_keys.location_root] = _append_path_sep(
settings[config_keys.location_root])
# Validate settings.
if settings[config_keys.generate_config]:
assert len(settings[config_keys.config_file_path]) > 0
def _append_path_sep(path):
"""
Append the path separator if missing.
"""
if isinstance(path, basestring) and not path.endswith(os.path.sep):
path += os.path.sep
return path