svn: expose file path for generated config.

rhodecode/apps/admin/views/svn_config.py

@@ -1,59 +1,59 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2020 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
 
 from pyramid.view import view_config
 
 from rhodecode.apps._base import BaseAppView
 from rhodecode.apps.svn_support.utils import generate_mod_dav_svn_config
 from rhodecode.lib.auth import (
     LoginRequired, HasPermissionAllDecorator, CSRFRequired)
 
 log = logging.getLogger(__name__)
 
 
 class SvnConfigAdminSettingsView(BaseAppView):
 
     @LoginRequired()
     @HasPermissionAllDecorator('hg.admin')
     @CSRFRequired()
     @view_config(
         route_name='admin_settings_vcs_svn_generate_cfg',
         request_method='POST', renderer='json')
     def vcs_svn_generate_config(self):
         _ = self.request.translate
         try:
-            generate_mod_dav_svn_config(self.request.registry)
+            file_path = generate_mod_dav_svn_config(self.request.registry)
             msg = {
-                'message': _('Apache configuration for Subversion generated.'),
+                'message': _('Apache configuration for Subversion generated at `{}`.').format(file_path),
                 'level': 'success',
             }
         except Exception:
             log.exception(
                 'Exception while generating the Apache '
                 'configuration for Subversion.')
             msg = {
                 'message': _('Failed to generate the Apache configuration for Subversion.'),
                 'level': 'error',
             }
 
         data = {'message': msg}
         return data

rhodecode/apps/svn_support/utils.py

@@ -1,97 +1,98 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2016-2020 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 codecs
 import logging
 import os
 from pyramid.renderers import render
 
 from rhodecode.events import trigger
 from rhodecode.lib.utils import get_rhodecode_realm, get_rhodecode_base_path
 from rhodecode.lib.utils2 import str2bool
 from rhodecode.model.db import RepoGroup
 
 from . import config_keys
 from .events import ModDavSvnConfigChange
 
 
 log = logging.getLogger(__name__)
 
 
 def write_mod_dav_svn_config(settings):
     use_ssl = str2bool(settings['force_https'])
-
+    file_path = settings[config_keys.config_file_path]
     config = _render_mod_dav_svn_config(
         use_ssl=use_ssl,
         parent_path_root=get_rhodecode_base_path(),
         list_parent_path=settings[config_keys.list_parent_path],
         location_root=settings[config_keys.location_root],
         repo_groups=RepoGroup.get_all_repo_groups(),
         realm=get_rhodecode_realm(), template=settings[config_keys.template])
-    _write_mod_dav_svn_config(config, settings[config_keys.config_file_path])
+    _write_mod_dav_svn_config(config, file_path)
+    return file_path
 
 
 def generate_mod_dav_svn_config(registry):
     """
     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.
     """
     settings = registry.settings
-    write_mod_dav_svn_config(settings)
+    file_path = write_mod_dav_svn_config(settings)
 
     # Trigger an event on mod dav svn configuration change.
     trigger(ModDavSvnConfigChange(), registry)
-
+    return file_path
 
 def _render_mod_dav_svn_config(
         parent_path_root, list_parent_path, location_root, repo_groups, realm,
         use_ssl, template):
     """
     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': realm,
         'use_https': use_ssl,
     }
     template = template or \
                'rhodecode:apps/svn_support/templates/mod-dav-svn.conf.mako'
     # Render the configuration template to string.
     return render(template, context)
 
 
 def _write_mod_dav_svn_config(config, filepath):
     """
     Write mod_dav_svn config to file.
     """
     with codecs.open(filepath, 'w', encoding='utf-8') as f:
         f.write(config)