svn: Update and add doc strings and comments.

rhodecode/svn_support/__init__.py

@@ -1,69 +1,74 b''
 # -*- 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 rhodecode import events
 from rhodecode.lib.utils2 import str2bool
 from rhodecode.svn_support.subscribers import generate_mod_dav_svn_config
 from rhodecode.svn_support import keys
 
 
 log = logging.getLogger(__name__)
 
 
 def includeme(config):
     settings = config.registry.settings
     _sanitize_settings_and_apply_defaults(settings)
 
     if settings[keys.generate_config]:
-        log.error('Add subscriber')
         config.add_subscriber(
             generate_mod_dav_svn_config, events.RepoGroupEvent)
 
 
 def _sanitize_settings_and_apply_defaults(settings):
+    """
+    Set defaults, convert to python types and validate settings.
+    """
     # Convert bool settings from string to bool.
     settings[keys.generate_config] = str2bool(
         settings.get(keys.generate_config, 'false'))
     settings[keys.list_parent_path] = str2bool(
         settings.get(keys.list_parent_path, 'true'))
 
     # Set defaults if key not present.
     settings.setdefault(keys.config_file_path, None)
     settings.setdefault(keys.location_root, '/')
     settings.setdefault(keys.parent_path_root, None)
 
     # Append path separator to paths.
-    settings[keys.location_root] = _append_slash(
+    settings[keys.location_root] = _append_path_sep(
         settings[keys.location_root])
-    settings[keys.parent_path_root] = _append_slash(
+    settings[keys.parent_path_root] = _append_path_sep(
         settings[keys.parent_path_root])
 
     # Validate settings.
     if settings[keys.generate_config]:
         assert settings[keys.config_file_path] is not None
 
 
-def _append_slash(path):
+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

rhodecode/svn_support/keys.py

@@ -1,27 +1,28 b''
 # -*- 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/
 
 
-# Settings keys used in the ini file.
+# Definition of setting keys used to configure this module. Defined here to
+# avoid repetition of keys throughout the module.
 config_file_path = 'svn.proxy.config_file_path'
 generate_config = 'svn.proxy.generate_config'
 list_parent_path = 'svn.proxy.list_parent_path'
 location_root = 'svn.proxy.location_root'
 parent_path_root = 'svn.proxy.parent_path_root'

rhodecode/svn_support/subscribers.py

@@ -1,56 +1,70 b''
 # -*- 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
 
 from pyramid.renderers import render
 
 from rhodecode.model.db import RepoGroup
 from rhodecode.svn_support import keys
 
 
 log = logging.getLogger(__name__)
 
 
 def generate_mod_dav_svn_config(event):
-    _generate(event.request)
+    """
+    Subscriber to the `rhodcode.events.RepoGroupEvent`. This triggers the
+    automatic generation of mod_dav_svn config file on repository group
+    changes.
+    """
+    _generate(event.request.registry.settings)
 
 
-def _generate(request):
-    settings = request.registry.settings
+def _generate(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.
+
+    Currently this is only used by the subscriber above. If we extend this
+    to include it as API method and in the web interface this should be moved
+    to an appropriate place.
+    """
     filepath = settings[keys.config_file_path]
     repository_root = settings[keys.parent_path_root]
     list_parent_path = settings[keys.list_parent_path]
     location_root = settings[keys.location_root]
 
     # Render the configuration to string.
     template = 'rhodecode:svn_support/templates/mod-dav-svn.conf.mako'
     context = {
         'location_root': location_root,
         'repository_root': repository_root,
         'repo_groups': RepoGroup.get_all_repo_groups(),
         'svn_list_parent_path': list_parent_path,
     }
     mod_dav_svn_config = render(template, context)
 
     # Write configuration to file.
     with open(filepath, 'w') as file_:
         file_.write(mod_dav_svn_config)

rhodecode/svn_support/templates/mod-dav-svn.conf.mako

@@ -1,20 +1,28 b''
-# This file is auto generated by RhodeCode. It contains the configuration for
-# use with mod_dav_svn.
+# Auto generated configuration for use with the Apache mod_dav_svn module.
+
+# The mod_dav_svn module does not support subversion repositories which are
+# organized in subfolders. To support the repository groups of RhodeCode it is
+# required to provide a <Location> block for each group pointing to the
+# repository group sub folder.
+
+# To ease the configuration RhodeCode auto generates this file whenever a
+# repository group is created/changed/deleted. Auto generation can be configured
+# in the ini file.
 
 <Location ${location_root}>
     DAV svn
     SVNParentPath ${parent_path_root}
     SVNListParentPath ${'On' if svn_list_parent_path else 'Off'}
     Allow from all
     Order allow,deny
 </Location>
 
 % for repo_group in repo_groups:
 <Location ${location_root}${repo_group.full_path}>
     DAV svn
     SVNParentPath ${parent_path_root}${repo_group.full_path}
     SVNListParentPath ${'On' if svn_list_parent_path else 'Off'}
     Allow from all
     Order allow,deny
 </Location>
 % endfor