Ticket #1242: xref_cs1343.diff

scripts/trac-admin

@@ -30 +30 @@
 import sqlite
 import StringIO
 
+import trac.Environment # has to be imported before Xref
 from trac import perm
 from trac import util
 from trac import sync
+from trac import Xref
+from trac import Href
 import trac.siteconfig
-import trac.Environment
 
 def my_sum(list):
     """Python2.1 doesn't have sum()"""
@@ -272 +274 @@
             docs = (self._help_about + self._help_help +
                     self._help_initenv + self._help_hotcopy +
                     self._help_resync + self._help_upgrade +
+                    self._help_xref +
                     self._help_wiki +
 #                    self._help_config + self._help_wiki +
                     self._help_permission + self._help_component +
@@ -542 +545 @@
             print ' Installing wiki pages'
             cursor = cnx.cursor()
             self._do_wiki_load(trac.siteconfig.__default_wiki_dir__,cursor)
+            print ' Cross-referencing'
+            self.__env.href = Href('trac-admin::initenv')
+            self.__env._wiki_pages = {}
+            Xref.rebuild_cross_references(self.__env, cnx)
 
             print ' Indexing repository'
-            sync.sync(cnx, rep, fs_ptr, pool)
+            sync.sync(self.__env, cnx, rep, fs_ptr, pool)
         except Exception, e:
             print 'Failed to initialize database.', e
             sys.exit(2)
@@ -592 +599 @@
         pool = core.svn_pool_create(None)
 
         self.db_open() # We need to call this function to open the env, really stupid
+        self.__env.href = Href.Href('trac-admin::resync') # We need this for the WikiFormatter
+        self.__env._wiki_pages = {}
 
         # Remove any trailing slash or else subversion might abort
         repository_dir = self.__env.get_config('trac', 'repository_dir')
@@ -605 +614 @@
         print 'resyncing...'
         self.db_execsql("DELETE FROM revision")
         self.db_execsql("DELETE FROM node_change")
-        sync.sync(cnx, rep, fs_ptr, pool)
+        sync.sync(self.__env, cnx, rep, fs_ptr, pool)
         print 'done.'
         
+    _help_xref = [('xref', 'Regenerate all the cross-reference information between trac objects')]
+    
+    ## XRef
+    def do_xref(self, line):
+        self.db_open() # We need to call this function to open the env, really stupid
+        cnx = self.__env.get_db_cnx()
+        print 'cross-referencing... (except changesets: use \'resync\' for that)'
+        self.__env.href = Href.Href('trac-admin::xref')
+        self.__env._wiki_pages = {}
+        Xref.rebuild_cross_references(self.__env, cnx, False)
+        print 'done.'
+        
     ## Wiki
     _help_wiki = [('wiki list', 'List wiki pages'),
                   ('wiki remove <name>', 'Remove wiki page'),

trac/core.py

@@ -40 +40 @@
     'search'      : ('Search', 'Search', 0),
     'report'      : ('Report', 'Report', 0),
     'ticket'      : ('Ticket', 'TicketModule', 0),
+    'bug'         : ('Ticket', 'TicketModule', 0),
+    'issue'       : ('Ticket', 'TicketModule', 0),
+    'source'      : ('Browser', 'Browser', 1),
+    'repos'       : ('Browser', 'Browser', 1),
     'browser'     : ('Browser', 'Browser', 1),
     'timeline'    : ('Timeline', 'Timeline', 1),
     'changeset'   : ('Changeset', 'Changeset', 1),
@@ -48 +52 @@
     'attachment'  : ('File', 'Attachment', 0),
     'roadmap'     : ('Roadmap', 'Roadmap', 0),
     'settings'    : ('Settings', 'Settings', 0),
+    'xref'        : ('Xref', 'XrefModule', 0),
+    'orphans'     : ('Xref', 'XrefModule', 0),
     'milestone'   : ('Milestone', 'Milestone', 0)
     }
 
@@ -74 +80 @@
         pool, rep, fs_ptr = open_svn_repos(repos_dir)
         module.repos = rep
         module.fs_ptr = fs_ptr
-        sync.sync(db, rep, fs_ptr, pool)
+        sync.sync(env, db, rep, fs_ptr, pool)
         module.pool = pool
 
     return module

trac/db_default.py

@@ -21 +21 @@
 
 
 # Database version identifier. Used for automatic upgrades.
-db_version = 9
+db_version = 10
 
 def __mkreports(reports):
     """Utility function used to create report data in same syntax as the
@@ -159 +159 @@
          UNIQUE(sid,var_name)
 );
 
+CREATE TABLE xref (
+         src_type        text,
+         src_id          text,
+         relation        text,
+         dest_type       text,
+         dest_id         text,
+         facet           text,
+         context         text
+);
+
+
 CREATE INDEX node_change_idx    ON node_change(rev);
 CREATE INDEX ticket_change_idx  ON ticket_change(ticket, time);
 CREATE INDEX wiki_idx           ON wiki(name,version);
 CREATE INDEX session_idx        ON session(sid,var_name);
+CREATE INDEX xref_src_idx       ON xref(src_id,src_type);
+CREATE INDEX xref_dest_idx      ON xref(dest_id,dest_type);
 """
 
 ##

trac/Milestone.py

@@ -24 +24 @@
 from trac.Ticket import get_custom_fields, Ticket
 from trac.WikiFormatter import wiki_to_html
 from trac.util import *
+from trac.Xref import TracRef
 
 import time
 
@@ -159 +160 @@
         cursor.execute("INSERT INTO milestone (name,due,completed,description) "
                        "VALUES (%s,%s,%s,%s)",
                        (name, due, completed, description))
+        TracRef('milestone', name).replace_xrefs_from_wiki(self.env, self.db, 'description', description)
         self.db.commit()
         req.redirect(self.env.href.milestone(name))
 
@@ -182 +184 @@
                                    "WHERE milestone=%s", (id,))
             self.log.info('Deleting milestone %s' % id)
             cursor.execute("DELETE FROM milestone WHERE name=%s", (id,))
+            TracRef('milestone', id).delete_xrefs(self.db, 'description')
             self.db.commit()
             req.redirect(self.env.href.roadmap())
         else:
@@ -266 +269 @@
         action = req.args.get('action', 'view')
         id = req.args.get('id')
 
+        TracRef('milestone', id).add_backlinks(self.db, req)
+
         if action == 'new':
             self.perm.assert_permission(perm.MILESTONE_CREATE)
             self.render_editor(req)

trac/tests/href.py

@@ -94 +94 @@
         self.assertEqual('/attachment/ticket/42/foo.txt?format=raw',
                          self.href.attachment('ticket', '42', 'foo.txt', 'raw'))
 
+    def test_xref(self):
+        """Testing Href.xref"""
+        self.assertEqual('/xref', self.href.xref())
+        self.assertEqual('/xref/wiki', self.href.xref('wiki'))
+        self.assertEqual('/xref/wiki/WikiStart', self.href.xref('wiki', 'WikiStart'))
+
+    def test_orphans(self):
+        """Testing Href.orphans"""
+        self.assertEqual('/orphans', self.href.orphans())
+
 def suite():
     return unittest.makeSuite(HrefTestCase,'test')
 

trac/Report.py

@@ -22 +22 @@
 from trac import perm, util
 from trac.Module import Module
 from trac.WikiFormatter import wiki_to_html
+from trac.Xref import TracRef
 
 import re
 import time
@@ -113 +114 @@
         cursor.execute("INSERT INTO report (title,sql,description) "
                        "VALUES (%s,%s,%s)", (title, sql, description))
         id = self.db.get_last_id()
+        TracRef('report', id).replace_xrefs_from_wiki(self.env, self.db, 'description', description)
         self.db.commit()
         req.redirect(self.env.href.report(id))
 
@@ -122 +124 @@
         if not req.args.has_key('cancel'):
             cursor = self.db.cursor ()
             cursor.execute("DELETE FROM report WHERE id=%s", (id,))
+            TracRef('report', id).delete_xrefs(self.db, 'description')
             self.db.commit()
             req.redirect(self.env.href.report())
         else:
@@ -401 +404 @@
                                    req.args.get('description', ''),
                                    req.args.get('sql', ''))
 
+        if id != -1:
+            TracRef('report', id).add_backlinks(self.db, req)
+
         if id != -1 or action == 'new':
             self.add_link('up', self.env.href.report(), 'Available Reports')
 

trac/sync.py

@@ -20 +20 @@
 # Author: Jonas Borgstr�jonas@edgewall.com>
 
 from svn import fs, util, delta, repos, core
+from trac.Xref import TracRef
 
 import posixpath
 
 
-def sync(db, repos, fs_ptr, pool):
+def sync(env, db, repos, fs_ptr, pool):
     """
     Update the revision and node_change tables to be in sync with
     the repository.
@@ -56 +57 @@
         cursor.execute ('INSERT INTO revision (rev, time, author, message) '
                         'VALUES (%s, %s, %s, %s)', rev + offset, date,
                         author, message)
+        TracRef('changeset', rev + offset).replace_xrefs_from_wiki(env, db, 'content', message)
         insert_change (subpool, fs_ptr, rev + offset, cursor)
         core.svn_pool_clear(subpool)
 
@@ -125 +127 @@
                 old_path = posixpath.join(old_path, posixpath.split(path)[1])
                 action = 'A'
             else:
-                self._save_change(core.svn_node_file, 'A', path) 
+                self._save_change(core.svn_node_dir, 'A', path) 
                 action = None
 
             if action:

trac/File.py

@@ -25 +25 @@
 from trac import perm, util
 from trac.Module import Module
 from trac.WikiFormatter import wiki_to_html
+from trac.Xref import TracRef
 
 import svn.core
 import svn.fs
@@ -261 +262 @@
 
         self.rev = req.args.get('rev', None)
         self.path = req.args.get('path', '/')
+
+        TracRef('source', self.path).add_backlinks(self.db, req)
+        
         if not self.rev:
             rev_specified = 0
             self.rev = svn.fs.youngest_rev(self.fs_ptr, self.pool)

trac/Log.py

@@ -22 +22 @@
 from trac import perm, util
 from trac.Module import Module
 from trac.WikiFormatter import wiki_to_oneliner
+from trac.Xref import TracRef
 
 import svn.core
 import svn.fs
@@ -121 +122 @@
 
         self.path = req.args.get('path', '/')
         self.authzperm.assert_permission(self.path)
+
+        TracRef('source', self.path).add_backlinks(self.db, req)
+        
         if req.args.has_key('rev'):
             try:
                 rev = int(req.args.get('rev'))

trac/upgrades/db10.py

@@ +1 @@
+import time
+
+sql = """
+-- Initial creation of the general cross-reference table
+CREATE TABLE xref (
+         src_type        text,
+         src_id          text,
+         relation        text,
+         dest_type       text,
+         dest_id         text,
+         facet           text,
+         context         text
+);
+
+CREATE INDEX xref_src_idx       ON xref(src_id,src_type);
+CREATE INDEX xref_dest_idx      ON xref(dest_id,dest_type);
+"""
+
+def do_upgrade(env, ver, cursor):
+    cursor.execute(sql)
+
+def do_db_upgrade(env, ver, db):
+    """Renumbering of ticket comments (using the spare 'oldvalue' field)"""
+    cursor = db.cursor()
+    update_cursor = db.cursor()
+    cursor.execute("SELECT ticket, time, author FROM ticket_change "
+                   "WHERE field = 'comment' "
+                   "ORDER BY ticket, time, author ")
+    previous_ticket = None
+    for ticket, time, author in cursor:
+        if ticket != previous_ticket:
+            previous_ticket = ticket
+            n = 1
+        update_cursor.execute("UPDATE ticket_change SET "
+                              "oldvalue = %s ",
+                              (n))
+        n += 1
+
+        
+
+
+
+
+
+
+
+
+
+
+
+
+
+    

trac/Href.py

@@ -56 +56 @@
         else:
             return href_join(self.base, 'browser', path)
 
+    def source(self, path, rev=None):
+        return self.browser(path, rev)
+
     def login(self):
         return href_join(self.base, 'login')
 
@@ -176 +179 @@
         if format:
             href += '?format=%s' % format
         return href
+
+    def xref(self, module=None, id=None):
+        if module and id:
+            href = href_join(self.base, 'xref', str(module), str(id))
+        else:
+            href = href_join(self.base, 'xref')
+        return href
+
+    def orphans(self, module=None):
+        if module:
+            href = href_join(self.base, 'orphans', str(module))
+        else:
+            href = href_join(self.base, 'orphans')
+        return href
+

trac/web/main.py

@@ -153 +153 @@
     if match:
         set_if_missing(args, 'mode', match.group(1))
         return args
-    match = re.search('^/(ticket|report)(?:/([0-9]+)/*)?', path_info)
+    match = re.search('^/(ticket|bug|issue|report)(?:/([0-9]+)/*)?', path_info)
     if match:
         set_if_missing(args, 'mode', match.group(1))
         if match.group(2):
             set_if_missing(args, 'id', match.group(2))
         return args
-    match = re.search('^/(browser|log|file)(?:(/.*))?', path_info)
+    match = re.search('^/(browser|source|repos|log|file)(?:(/.*))?', path_info)
     if match:
         set_if_missing(args, 'mode', match.group(1))
         if match.group(2):
@@ -183 +183 @@
         if match.group(1):
             set_if_missing(args, 'id', urllib.unquote(match.group(1)))
         return args
+    match = re.search('^/(xref|orphans)(?:/([^/]+))?(?:/(.*)/?)?', path_info)
+    if match:
+        set_if_missing(args, 'mode', match.group(1))
+        set_if_missing(args, 'type', match.group(2))
+        id = match.group(3)
+        if id:
+            set_if_missing(args, 'id', urllib.unquote(id))
+        return args
     return args
 
 def populate_hdf(hdf, env, req=None):
@@ -208 +216 @@
         'login': env.href.login(),
         'logout': env.href.logout(),
         'settings': env.href.settings(),
+        'xref': env.href.xref(),
+        'orphans': env.href.orphans(),
         'homepage': 'http://trac.edgewall.com/'
     }
 

trac/Changeset.py

@@ -24 +24 @@
 from trac.Diff import get_diff_options, hdf_diff, unified_diff
 from trac.Module import Module
 from trac.WikiFormatter import wiki_to_html
+from trac.Xref import TracRef
 from trac import authzperm, perm
 
 import svn.core
@@ -435 +436 @@
         else:
             self.rev = youngest_rev
 
+        TracRef('changeset', self.rev).add_backlinks(self.db, req)
+
         self.diff_options = get_diff_options(req)
         if req.args.has_key('update'):
             req.redirect(self.env.href.changeset(self.rev))
@@ -462 +465 @@
         req.hdf['changeset.revision'] = self.rev
         req.hdf['changeset.changes'] = change_info
         req.hdf['changeset.href'] = self.env.href.changeset(self.rev)
-        
+
         if len(change_info) == 0:
             raise authzperm.AuthzPermissionError()
         

trac/Wiki.py

@@ -24 +24 @@
 from trac.Module import Module
 from trac.util import escape, TracError, get_reporter_id
 from trac.WikiFormatter import *
+from trac.Xref import TracRef
 
 import os
 import time
@@ -51 +52 @@
     Represents a wiki page (new or existing).
     """
 
-    def __init__(self, name, version, perm_, db):
-        self.db = db
+    def __init__(self, name, version, perm_, env, db):
+        self.env = env
+        self.db  = db
         self.name = name
         self.perm = perm_
         cursor = self.db.cursor ()
@@ -108 +110 @@
                             "%s,%s)", (self.name, self.version + 1,
                             int(time.time()), author, remote_addr, self.text,
                             comment, self.readonly))
+            TracRef('wiki', self.name).replace_xrefs_from_wiki(self.env, self.db, 'content', self.text)
             self.db.commit()
             self.version += 1
             self.old_readonly = self.readonly
@@ -126 +129 @@
         req.hdf['wiki.page_name'] = escape(pagename)
         req.hdf['wiki.current_href'] = escape(self.env.href.wiki(pagename))
 
+        self.ref = TracRef('wiki', pagename)
+        self.ref.add_backlinks(self.db, req)
+
         if action == 'diff':
             version = int(req.args.get('version', 0))
             self._render_diff(req, pagename, version)
@@ -136 +142 @@
         elif action == 'delete':
             version = None
             if req.args.has_key('delete_version'):
-                version = int(req.args['version'])
+                version = int(req.args.get('version'))
             self._delete_page(req, pagename, version)
         elif action == 'save':
             if req.args.has_key('cancel'):
@@ -164 +170 @@
             cursor = self.db.cursor()
             cursor.execute("DELETE FROM wiki WHERE name=%s and version=%s",
                            (pagename, version))
+            self.ref.delete_xrefs(self.db, 'comment:%s' % version)
             self.log.info('Deleted version %d of page %s' % (version, pagename))
             cursor.execute("SELECT COUNT(*) FROM wiki WHERE name=%s", (pagename,))
-            if not cursor.fetchone():
+            last_version = cursor.fetchone()[0]
+            if last_version == 0:
                 page_deleted = 1
+            elif version > last_version: # resurrect the previous 'content' 
+                cursor.execute("SELECT text FROM wiki WHERE name=%s ORDER BY version DESC",
+                               (pagename))
+                text = cursor.fetchone()[0]
+                self.ref.replace_xrefs_from_wiki(self.env, self.db, 'content', text)
         else: # Delete a wiki page completely
             cursor.execute("DELETE FROM wiki WHERE name=%s", (pagename,))
             page_deleted = 1
@@ -175 +188 @@
         self.db.commit()
 
         if page_deleted:
+            self.ref.delete_xrefs(self.db)
             # Delete orphaned attachments
             for attachment in self.env.get_attachments(self.db, 'wiki', pagename):
                 self.env.delete_attachment(self.db, 'wiki', pagename,
@@ -233 +247 @@
     def _render_editor(self, req, pagename, preview=0):
         self.perm.assert_permission(perm.WIKI_MODIFY)
 
-        page = WikiPage(pagename, None, self.perm, self.db)
+        page = WikiPage(pagename, None, self.perm, self.env, self.db)
         if req.args.has_key('text'):
             page.set_content(req.args.get('text'))
         if preview:
@@ -311 +325 @@
             self.add_link('alternate', '?format=txt', 'Plain Text',
                           'text/plain')
 
-        page = WikiPage(pagename, version, self.perm, self.db)
+        page = WikiPage(pagename, version, self.perm, self.env, self.db)
 
         info = {
             'version': page.version,
@@ -331 +345 @@
     def _save_page(self, req, pagename):
         self.perm.assert_permission(perm.WIKI_MODIFY)
 
-        page = WikiPage(pagename, None, self.perm, self.db)
+        page = WikiPage(pagename, None, self.perm, self.env, self.db)
         if req.args.has_key('text'):
             page.set_content(req.args.get('text'))
 

trac/Environment.py

@@ -23 +23 @@
 #
 
 from trac import db, db_default, Logging, Mimeview, util
+from trac.Xref import TracRef
 
+
 import ConfigParser
 import os
 import shutil
@@ -253 +255 @@
         cursor.execute('INSERT INTO attachment VALUES(%s,%s,%s,%s,%s,%s,%s,%s)',
                        (type, id, filename, length, int(time.time()),
                        description, author, ipnr))
+        TracRef(type, id).replace_xrefs_from_wiki(self, cnx, 'attachment:%s' % filename, description)
         shutil.copyfileobj(attachment.file, fd)
         self.log.info('New attachment: %s/%s/%s by %s', type, id, filename, author)
         cnx.commit()
@@ -265 +268 @@
         cursor = cnx.cursor()
         cursor.execute('DELETE FROM attachment WHERE type=%s AND id=%s AND '
                        'filename=%s', (type, id, filename))
+        TracRef(type, id).delete_xrefs(cnx, 'attachment:%s' % filename)
         os.unlink(path)
         self.log.info('Attachment removed: %s/%s/%s', type, id, filename)
         cnx.commit()
@@ -324 +328 @@
                     err = 'No upgrade module for version %i (%s.py)' % (i, upg)
                     raise EnvironmentError, err
                 d.do_upgrade(self, i, cursor)
+                if hasattr(d, 'do_db_upgrade'): # for more complex upgrades, as in 'db9.py'
+                    d.do_db_upgrade(self, i, cnx)
             cursor.execute("UPDATE system SET value=%s WHERE "
                            "name='database_version'", (db_default.db_version))
             self.log.info('Upgraded db version from %d to %d',

trac/Xref.py

@@ +1 @@
+# -*- coding: iso8859-1 -*-
+#
+# Copyright (C) 2005 Edgewall Software
+# Copyright (C) 2005 Christian Boos <cboos@wanadoo.fr>
+#
+# Trac is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version.
+#
+# Trac 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 General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#
+# Author: Christian Boos <cboos@wanadoo.fr>
+
+"""
+
+  This module implements a general cross-reference facility for Trac,
+  as suggested in #1242.
+
+  Currently, cross-references between the following Trac objects are supported:
+   * Wiki page
+   * Ticket
+   * Changeset
+   * Report
+   * Milestone
+   * Source (only as targets for now)
+
+  Basically, two kinds of references are supported:
+   * ''implicit references between objects''
+     Implicit references are created for every TracLinks that can be found
+     in (any of) the wiki text of a Trac object.
+     Indeed, some objects may have separately editable wiki texts,
+     each of them being a ''facet'' of this object.
+     (TODO: generic fine grained anchoring: <object href>#<facet> should go to the facet)
+   * ''explicit relation between objects''
+     An explicit relation must be created explicitely as such,
+     by some programmatic mean.
+     Currently, some of the ticket fields are setting up explicit relationships.
+
+   Note that implicit references always have an empty 'relation',
+   whereas explicit references may use the 'facet' for informative purpose.
+
+"""
+
+
+from trac.Module import Module
+from trac.util import escape
+from trac.WikiFormatter import XRefFormatter
+
+__all__ = ['TracRef', 'rebuild_cross_references']
+
+
+how_much_context = 40
+
+
+class TracRef:
+    """