Ticket #1847: vc-refactoring_for_trac-0.9.patch

htdocs/css/trac.css

@@ -257 +257 @@
 .wikipage { padding-left: 18px }
 .wikipage h1, .wikipage h2, .wikipage h3 { margin-left: -18px }
 
-a.missing:link, a.missing:visited { background: #fafaf0; color: #998 }
+a.missing:link, a.missing:visited, span.missing { background: #fafaf0; color: #998 }
 a.missing:hover { color: #000; }
 a.closed:link, a.closed:visited { text-decoration: line-through }
 

htdocs/css/browser.css

@@ -2 +2 @@
 * html #prefs { width: 34em } /* Set width only for IE */
 #prefs fieldset label { display: block }
 #prefs .buttons { margin-top: -1.6em }
+#prefs .button { margin-left: 1.6em }
 #prefs .choice { margin-top: -0.6em }
+#prefs .rev { align: right }
 
 #legend { clear: right; }
 
@@ -24 +26 @@
  color: #888;
  white-space: nowrap;
 }
+#dirlist td.rev { 
+ font-family: courier;  
+ letter-spacing: -0.02em;
+ font-size: 90%;
+ text-align: right;
+}
 #dirlist td.size {  
  color: #888;
  white-space: nowrap;
@@ -59 +67 @@
 #chglist td.old_path { font-style: italic }
 #chglist td.date { font-size: 85%; vertical-align: top; padding-top: 0.55em; white-space: nowrap }
 #chglist td.author { font-size: 85%; vertical-align: top; padding-top: 0.55em }
-#chglist td.rev, #chglist td.chgset { text-align: right }
+#chglist td.rev, #chglist td.chgset { 
+ font-family: courier;  
+ letter-spacing: -0.02em;
+ font-size: 90%;
+ text-align: right; 
+}
 #chglist td.rev a, #chglist td.chgset a { border-bottom: none }
 #chglist td.summary { width: 100%; font-size: 85%; vertical-align: middle; white-space: nowrap }
 #chglist td.summary * { margin-top: 0; margin-bottom: 0 }

trac/env.py

@@ -22 +22 @@
 from trac.config import Configuration
 from trac.core import Component, ComponentManager, implements, Interface, \
                       ExtensionPoint, TracError
+from trac.versioncontrol import ScmBackendManager
 
 __all__ = ['Environment', 'IEnvironmentSetupParticipant', 'open_environment']
 
@@ -120 +121 @@
                     and component_name.startswith(pattern[:-1]):
                 return enabled
 
+        # versioncontrol components are enabled if the repository is configured
+        if component_name.startswith('trac.versioncontrol'):
+            return self.config.get('trac', 'repository_dir') != ''
+
         # By default, all components in the trac package are enabled
         return component_name.startswith('trac.')
 
@@ -146 +151 @@
         """Return the version control repository configured for this
         environment.
         
-        The repository is wrapped in a `CachedRepository`.
-        
         @param authname: user name for authorization
         """
-        from trac.versioncontrol.cache import CachedRepository
-        from trac.versioncontrol.svn_authz import SubversionAuthorizer
-        from trac.versioncontrol.svn_fs import SubversionRepository
         repos_dir = self.config.get('trac', 'repository_dir')
         if not repos_dir:
             raise EnvironmentError, 'Path to repository not configured'
-        authz = None
-        if authname:
-            authz = SubversionAuthorizer(self, authname)
-        repos = SubversionRepository(repos_dir, authz, self.log)
-        return CachedRepository(self.get_db_cnx(), repos, authz, self.log)
+        return ScmBackendManager(self).get_repository(repos_dir, authname)
 
     def create(self, db_str=None):
         """Create the basic directory structure of the environment, initialize

trac/db_default.py

@@ -445 +445 @@
                       'trac.ticket.roadmap', 'trac.ticket.web_ui',
                       'trac.Timeline',
                       'trac.versioncontrol.web_ui',
+                      'trac.versioncontrol.svn_fs',
                       'trac.wiki.macros', 'trac.wiki.web_ui',
                       'trac.web.auth')

trac/versioncontrol/api.py

@@ -16 +16 @@
 
 from __future__ import generators
 from trac.perm import PermissionError
+from trac.core import *
 
+### Source Configuration Management interface and manager
+
+class IScmBackend(Interface):
+    """SCM backend for Trac"""
+
+    def identifiers(self):
+        """SCM string prefixes that are supported by the backend,
+        and their relative priorities.
+
+        Highest number is highest priority.
+        """
+
+    def repository(self, scheme, args, authname):
+        """Get a Repository object.
+
+        `scheme` is the scheme that was used to select this backend,
+        `args` is the remaining specification for the repository and
+        `authname` is the user name, for authentication purpose.
+        """
+
+    def init_repository(self, **params): # TBD
+        """Initialize a repository"""
+
+
+class ScmBackendManager(Component):
+    """TODO: share some code with the DatabaseBackendManager"""
+
+    backends = ExtensionPoint(IScmBackend)
+
+    def __init__(self):
+        self._backend_map = None
+
+    def get_repository(self, repos_str, authname):
+        if ':' in repos_str and len(repos_str) > 2 and repos_str[1] != ':':
+            scheme, args = repos_str.split(':', 1)
+        else:
+            scheme, args = 'svn', repos_str
+        backend = self._get_backend(scheme)
+        return backend.repository(scheme, args, authname)
+
+    def _get_backend(self, scheme):
+        if not self._backend_map:
+            self._backend_map = {}
+            for backend in self.backends:
+                for ident, prio in backend.identifiers():
+                    if ident in self._backend_map:
+                        highest = self._backend_map[ident][1]
+                    else:
+                        highest = 0
+                    if prio > highest:
+                        self._backend_map[ident] = (backend, prio)
+        if not scheme in self._backend_map:
+            raise TracError, 'Unsupported SCM "%s"' % scheme
+        return self._backend_map[scheme][0]
+
+
+### Abstract classes for the backends
+
 class Repository(object):
     """
     Base class for a repository provided by a version control system.
@@ -40 +99 @@
         """
         raise NotImplementedError
 
+    def get_changesets(self, start, stop):
+        """
+        Generate Changeset belonging to the given time period (start, stop).
+        """
+        rev = self.youngest_rev
+        while rev:
+            if self.authz.has_permission_for_changeset(rev):
+                chgset = self.get_changeset(rev)
+                if chgset.date < start:
+                    return
+                if chgset.date < stop:
+                    yield chgset
+            rev = self.previous_rev(rev)
+
     def has_node(self, path, rev):
         """
         Tell if there's a node at the specified (path,rev) combination.
@@ -122 +195 @@
         'None' is a valid revision value and represents the youngest revision.
         """
         return NotImplementedError
+
+    def short_rev(self, rev):
+        """
+        Return a compact representation of a revision in the repos.
+        """
+        return self.normalize_rev(rev)
         
 
 class Node(object):

trac/versioncontrol/tests/svn_fs.py

@@ -100 +100 @@
         self.assertEqual(11, self.repos.normalize_rev(11))
 
     def test_rev_navigation(self):
-        self.assertEqual(0, self.repos.oldest_rev)
+        self.assertEqual(1, self.repos.oldest_rev)
         self.assertEqual(None, self.repos.previous_rev(0))
-        self.assertEqual(0, self.repos.previous_rev(1))
+        self.assertEqual(None, self.repos.previous_rev(1))
         self.assertEqual(12, self.repos.youngest_rev)
         self.assertEqual(6, self.repos.next_rev(5))
         self.assertEqual(7, self.repos.next_rev(6))

trac/versioncontrol/svn_fs.py

@@ -17 +17 @@
 from __future__ import generators
 
 from trac.util import TracError
-from trac.versioncontrol import Changeset, Node, Repository
+from trac.versioncontrol import Changeset, Node, Repository, IScmBackend
+from trac.versioncontrol.cache import CachedRepository
+from trac.versioncontrol.svn_authz import SubversionAuthorizer
+from trac.versioncontrol.web_ui import ChangesetModule, BrowserModule
+from trac.core import *
 
 import os.path
 import time
 import weakref
 import posixpath
 
-from svn import fs, repos, core, delta
+try:
+    from svn import fs, repos, core, delta
+    has_subversion = True
+except ImportError:
+    has_subversion = False
+    class dummy_svn(object):
+        svn_node_dir = 1
+        svn_node_file = 2
+        def apr_pool_destroy(): pass
+        def apr_terminate(): pass
+        def apr_pool_clear(): pass
+    core = dummy_svn()
 
 _kindmap = {core.svn_node_dir: Node.DIRECTORY,
             core.svn_node_file: Node.FILE}
 
+
+### Components
+
+class SvnFsBackend(Component):
+
+    implements(IScmBackend)
+
+    def identifiers(self):
+        global has_subversion
+        if has_subversion:
+            yield ("direct-svn-fs", 8)
+            yield ("svn-fs", 4)
+            yield ("svn", 2)
+
+    def repository(self, scheme, args, authname):
+        """Return a `SubversionRepository`.
+
+        The repository is generally wrapped in a `CachedRepository`,
+        unless `direct-svn-fs` is the specified scheme.
+        """
+        authz = None
+        if authname:
+            authz = SubversionAuthorizer(self.env, authname)
+        repos = SubversionRepository(args, authz, self.log)
+        if scheme == 'direct-svn-fs':
+            return repos
+        else:
+            db = self.env.get_db_cnx()
+            return CachedRepository(db, repos, authz, self.log)
+
+
+class SvnFsBrowserModule(BrowserModule):
+    pass
+
+class SvnFsChangesetModule(ChangesetModule):
+    pass
+
+
+### Helpers
+
 application_pool = None
 
     
@@ -58 +113 @@
     """Remove leading "/", except for the root"""
     return path and path.strip('/') or '/'
 
-def _scoped_path(scope, fullpath):
+def _path_within_scope(scope, fullpath):
     """Remove the leading scope from repository paths"""
     if fullpath:
         if scope == '/':
@@ -168 +223 @@
                 del self._weakref
 
 # Initialize application-level pool
-Pool()
+if has_subversion:
+    Pool()
 
-
 class SubversionRepository(Repository):
     """
     Repository implementation based on the svn.fs API.
@@ -185 +240 @@
         self.pool = Pool()
         
         # Remove any trailing slash or else subversion might abort
-        if not os.path.split(path)[1]:
-            path = os.path.split(path)[0]
+        path = os.path.normpath(path).replace('\\', '/')
         self.path = repos.svn_repos_find_root_path(path, self.pool())
         if self.path is None:
             raise TracError, \
@@ -208 +262 @@
             self.scope = '/'
         self.log.debug("Opening subversion file-system at %s with scope %s" \
                        % (self.path, self.scope))
+        self.youngest = None
+        self.oldest = None
 
-        self.rev = fs.youngest_rev(self.fs_ptr, self.pool())
-
-        self.history = None
-        if self.scope != '/':
-            self.history = []
-            for path,rev in _get_history(self.scope[1:], self.authz,
-                                         self.fs_ptr, self.pool, 0, self.rev):
-                self.history.append(rev)
-
     def __del__(self):
         self.close()
 
@@ -246 +293 @@
         self.log.debug("Closing subversion file-system at %s" % self.path)
         self.repos = None
         self.fs_ptr = None
-        self.rev = None
         self.pool = None
 
     def get_changeset(self, rev):
@@ -263 +309 @@
         return SubversionNode(path, rev, self.authz, self.scope, self.fs_ptr,
                               self.pool)
 
+    def _history(self, path, start, end, limit=None):
+        scoped_path = self.scope[1:]+path
+        return _get_history(scoped_path, self.authz, self.fs_ptr, self.pool,
+                            start, end, limit)
+
     def get_oldest_rev(self):
-        rev = 0
-        if self.scope == '/':
-            return rev
-        return self.history[-1]
+        if self.oldest is None:
+            self.oldest = 1
+            if self.scope != '/':
+                self.oldest = self.next_rev(0)
+        return self.oldest
 
     def get_youngest_rev(self):
-        rev = self.rev
-        if self.scope == '/':
-            return rev
-        return self.history[0]
+        if not self.youngest:
+            self.youngest = fs.youngest_rev(self.fs_ptr, self.pool())
+            if self.scope != '/':
+                for path, rev in self._history('', 0, self.youngest, limit=1):
+                    self.youngest = rev
+        return self.youngest
 
     def previous_rev(self, rev):
-        rev = int(rev)
-        if rev == 0:
-            return None
-        if self.scope == '/':
-            return rev - 1
-        idx = self.history.index(rev)
-        if idx + 1 < len(self.history):
-            return self.history[idx + 1]
+        rev = self.normalize_rev(rev)
+        if rev > 1: # don't use oldest here, as it's too expensive
+            try:
+                for path, prev in self._history('', 0, rev-1, limit=1):
+                    return prev
+            except SystemError:
+                pass
         return None
 
     def next_rev(self, rev):
-        rev = int(rev)
-        if rev == self.rev:
-            return None
-        if self.scope == '/':
-            return rev + 1
-        if rev == 0:
-            return self.oldest_rev
-        idx = self.history.index(rev)
-        if idx > 0:
-            return self.history[idx - 1]
+        rev = self.normalize_rev(rev)
+        next = rev + 1
+        youngest = self.youngest_rev
+        while next <= youngest:
+            try:
+                for path, next in self._history('', rev+1, next, limit=1):
+                    return next
+                next += 1
+            except SystemError: # i.e. "null arg to internal routine"
+                return next # a 'delete' event is also interesting... 
         return None
 
     def rev_older_than(self, rev1, rev2):
@@ -328 +381 @@
                 older = None # 'older' is the currently examined history tuple
                 for p, r in _get_history(self.scope + path, self.authz,
                                          self.fs_ptr, subpool, 0, rev, limit):
-                    older = (_scoped_path(self.scope, p), r, Changeset.ADD)
+                    older = (_path_within_scope(self.scope, p), r,
+                             Changeset.ADD)
                     rev = self.previous_rev(r)
                     if newer:
                         if older[0] == path:
@@ -405 +459 @@
         pool = Pool(self.pool)
         for path, rev in _get_history(self.scoped_path, self.authz, self.fs_ptr,
                                       pool, 0, self._requested_rev, limit):
-            scoped_path = _scoped_path(self.scope, path)
-            if rev > 0 and scoped_path:
-                older = (scoped_path, rev, Changeset.ADD)
+            path = _path_within_scope(self.scope, path)
+            if rev > 0 and path:
+                older = (path, rev, Changeset.ADD)
                 if newer:
                     change = newer[0] == older[0] and Changeset.EDIT or \
                              Changeset.COPY
@@ -472 +526 @@
                 continue
             if not path.startswith(self.scope[1:]):
                 continue
-            base_path = _scoped_path(self.scope, change.base_path)
+            base_path = _path_within_scope(self.scope, change.base_path)
             action = ''
             if not change.path:
                 action = Changeset.DELETE

trac/versioncontrol/web_ui/changeset.py

@@ -35 +35 @@
 
 class ChangesetModule(Component):
 
+    abstract = True
+
     implements(INavigationContributor, IPermissionRequestor, IRequestHandler,
                ITimelineEventProvider, IWikiSyntaxProvider, ISearchSource)
 
@@ -106 +108 @@
                                              'changeset_show_files'))
             db = self.env.get_db_cnx()
             repos = self.env.get_repository()
-            authzperm = SubversionAuthorizer(self.env, req.authname)
-            rev = repos.youngest_rev
-            while rev:
-                if not authzperm.has_permission_for_changeset(rev):
-                    rev = repos.previous_rev(rev)
-                    continue
+            for chgset in repos.get_changesets(start, stop):
+                message = chgset.message or '--'
+                if format == 'rss':
+                    title = 'Changeset <em>[%s]</em>: %s' \
+                            % (util.escape(chgset.rev),
+                               util.escape(util.shorten_line(message)))
+                    href = self.env.abs_href.changeset(chgset.rev)
+                    message = wiki_to_html(message, self.env, db,
+                                           absurls=True)
+                else:
+                    title = 'Changeset <em>[%s]</em> by %s' \
+                            % (util.escape(chgset.rev),
+                               util.escape(chgset.author))
+                    href = self.env.href.changeset(chgset.rev)
+                    message = wiki_to_oneliner(message, self.env, db,
+                                               shorten=True)
+                if show_files:
+                    files = []
+                    for chg in chgset.get_changes():
+                        if show_files > 0 and len(files) >= show_files:
+                            files.append('...')
+                            break
+                        files.append('<span class="%s">%s</span>'
+                                     % (chg[2], util.escape(chg[0])))
+                    message = '<span class="changes">' + ', '.join(files) +\
+                              '</span>: ' + message
+                yield 'changeset', href, title, chgset.date, chgset.author,\
+                      message
 
-                chgset = repos.get_changeset(rev)
-                if chgset.date < start:
-                    return
-                if chgset.date < stop:
-                    message = chgset.message or '--'
-                    if format == 'rss':
-                        title = 'Changeset <em>[%s]</em>: %s' \
-                                % (util.escape(chgset.rev),
-                                   util.escape(util.shorten_line(message)))
-                        href = self.env.abs_href.changeset(chgset.rev)
-                        message = wiki_to_html(message, self.env, db,
-                                               absurls=True)
-                    else:
-                        title = 'Changeset <em>[%s]</em> by %s' \
-                                % (util.escape(chgset.rev),
-                                   util.escape(chgset.author))
-                        href = self.env.href.changeset(chgset.rev)
-                        message = wiki_to_oneliner(message, self.env, db,
-                                                   shorten=True)
-                    if show_files:
-                        files = []
-                        for chg in chgset.get_changes():
-                            if show_files > 0 and len(files) >= show_files:
-                                files.append('...')
-                                break
-                            files.append('<span class="%s">%s</span>'
-                                         % (chg[2], util.escape(chg[0])))
-                        message = '<span class="changes">' + ', '.join(files) +\
-                                  '</span>: ' + message
-                    yield 'changeset', href, title, chgset.date, chgset.author,\
-                          message
-                rev = repos.previous_rev(rev)
-
     # Internal methods
 
     def _render_html(self, req, repos, chgset, diff_options):
@@ -169 +160 @@
         youngest_rev = repos.youngest_rev
         if str(chgset.rev) != str(youngest_rev):
             next_rev = repos.next_rev(chgset.rev)
-            add_link(req, 'next', self.env.href.changeset(next_rev),
-                     'Changeset %s' % next_rev)
+            if next_rev:
+                add_link(req, 'next', self.env.href.changeset(next_rev),
+                         'Changeset %s' % next_rev)
             add_link(req, 'last', self.env.href.changeset(youngest_rev),
                      'Changeset %s' % youngest_rev)
 
@@ -180 +172 @@
             info = {'change': change}
             if base_path:
                 info['path.old'] = base_path
-                info['rev.old'] = base_rev
+                info['rev.old'] = repos.short_rev(base_rev)
                 info['browser_href.old'] = self.env.href.browser(base_path,
                                                                  rev=base_rev)
             if path:
                 info['path.new'] = path
-                info['rev.new'] = chgset.rev
+                info['rev.new'] = repos.short_rev(chgset.rev)
                 info['browser_href.new'] = self.env.href.browser(path,
                                                                  rev=chgset.rev)
             if change in (Changeset.COPY, Changeset.EDIT, Changeset.MOVE):

trac/versioncontrol/web_ui/browser.py

@@ -50 +50 @@
 
 class BrowserModule(Component):
 
+    abstract = True
+
     implements(INavigationContributor, IPermissionRequestor, IRequestHandler,
                IWikiSyntaxProvider)
 

trac/scripts/admin.py

@@ -541 +541 @@
         prompt = 'Database connection string [%s]> ' % ddb
         returnvals.append(raw_input(prompt).strip()  or ddb)
         print
-        print ' Please specify the absolute path to the project Subversion repository.'
-        print ' Repository must be local, and trac-admin requires read+write'
-        print ' permission to initialize the Trac database.'
+        print ' Please specify the absolute path to the project SCM repository,'
+        print ' or leave it blank to use Trac without a repository.'
         print
-        drp = '/var/svn/test'
-        prompt = 'Path to repository [%s]> ' % drp
-        returnvals.append(raw_input(prompt).strip()  or drp)
+        print ' Also, the repository can be specified later.'
+        print 
+        drp = 'svn:/path/to/repos/optional_scope_within_repos'
+        prompt = 'Path to repository, e.g. "%s"> ' % drp
+        returnvals.append(raw_input(prompt).strip())
         print
         print ' Please enter location of Trac page templates.'
         print ' Default is the location of the site-wide templates installed with Trac.'
@@ -605 +606 @@
             self._do_wiki_load(default_dir('wiki'), cursor)
             cnx.commit()
 
-            print ' Indexing repository'
-            repos = self.__env.get_repository()
-            repos.sync()
+            if repository_dir:
+                try:
+                    repos = self.__env.get_repository()
+                    if repos:
+                        print ' Indexing repository'
+                        repos.sync()
+                except util.TracError, e:
+                    print>>sys.stderr, """
+Warning: %s
 
+You should install the support libraries or the plugin needed
+for the SCM corresponding to:
+
+  %s
+""" % (str(e), repository_dir)
         except Exception, e:
             print 'Failed to initialize environment.', e
             traceback.print_exc()

trac/loader.py

@@ -45 +45 @@
     def enable_modules(egg_path, modules):
         """Automatically enable any components provided by plugins loaded from
         the environment plugins directory."""
-        if os.path.dirname(egg_path) == os.path.realpath(plugins_dir):
+        plugins_path = os.path.realpath(plugins_dir)
+        if os.name == 'nt':
+            plugins_path = plugins_path.lower()
+        if os.path.dirname(egg_path) == plugins_path:
             for module in modules:
                 env.config.setdefault('components', module + '.*', 'enabled')