rhodecode/svn_support/utils.py

# -*- coding: utf-8 -*-

# Copyright (C) 2016-2016  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

from pyramid.renderers import render

from rhodecode.lib.utils import get_rhodecode_realm
from rhodecode.model.db import RepoGroup
from . import config_keys


log = logging.getLogger(__name__)


def generate_mod_dav_svn_config(settings):
    """
    Generate the configuration file for use with subversion's mod_dav_svn
    module. The configuration has to contain a <Location> block for each
    available repository group because the mod_dav_svn module does not support
    repositories organized in sub folders.
    """
    config = _render_mod_dav_svn_config(
        settings[config_keys.parent_path_root],
        settings[config_keys.list_parent_path],
        settings[config_keys.location_root],
        RepoGroup.get_all_repo_groups())
    _write_mod_dav_svn_config(config, settings[config_keys.config_file_path])


def _render_mod_dav_svn_config(
        parent_path_root, list_parent_path, location_root, repo_groups):
    """
    Render mod_dav_svn configuration to string.
    """
    repo_group_paths = []
    for repo_group in repo_groups:
        group_path = repo_group.full_path_splitted
        location = os.path.join(location_root, *group_path)
        parent_path = os.path.join(parent_path_root, *group_path)
        repo_group_paths.append((location, parent_path))

    context = {
        'location_root': location_root,
        'parent_path_root': parent_path_root,
        'repo_group_paths': repo_group_paths,
        'svn_list_parent_path': list_parent_path,
        'rhodecode_realm': get_rhodecode_realm(),
    }

    # Render the configuration template to string.
    template = 'rhodecode:svn_support/templates/mod-dav-svn.conf.mako'
    return render(template, context)


def _write_mod_dav_svn_config(config, filepath):
    """
    Write mod_dav_svn config to file. Log on exceptions but do not raise.
    """
    try:
        with open(filepath, 'w') as file_:
            file_.write(config)
    except Exception:
        log.exception(
            'Can not write mod_dav_svn configuration to "%s"', filepath)