Ticket #1106: rename_simple.diff

trac/admin/tests/console-tests.txt

@@ -120 +120 @@
  TICKET_EDIT_CC, TICKET_EDIT_COMMENT, TICKET_EDIT_DESCRIPTION,
  TICKET_MODIFY, TICKET_VIEW, TIMELINE_VIEW, TRAC_ADMIN,
  VERSIONCONTROL_ADMIN, WIKI_ADMIN, WIKI_CREATE, WIKI_DELETE, WIKI_MODIFY,
- WIKI_VIEW
+ WIKI_RENAME, WIKI_VIEW
 
 ===== test_permission_add_one_action_ok =====
 
@@ -155 +155 @@
  TICKET_EDIT_CC, TICKET_EDIT_COMMENT, TICKET_EDIT_DESCRIPTION,
  TICKET_MODIFY, TICKET_VIEW, TIMELINE_VIEW, TRAC_ADMIN,
  VERSIONCONTROL_ADMIN, WIKI_ADMIN, WIKI_CREATE, WIKI_DELETE, WIKI_MODIFY,
- WIKI_VIEW
+ WIKI_RENAME, WIKI_VIEW
 
 ===== test_permission_add_multiple_actions_ok =====
 
@@ -191 +191 @@
  TICKET_EDIT_CC, TICKET_EDIT_COMMENT, TICKET_EDIT_DESCRIPTION,
  TICKET_MODIFY, TICKET_VIEW, TIMELINE_VIEW, TRAC_ADMIN,
  VERSIONCONTROL_ADMIN, WIKI_ADMIN, WIKI_CREATE, WIKI_DELETE, WIKI_MODIFY,
- WIKI_VIEW
+ WIKI_RENAME, WIKI_VIEW
 
 ===== test_permission_remove_one_action_ok =====
 
@@ -225 +225 @@
  TICKET_EDIT_CC, TICKET_EDIT_COMMENT, TICKET_EDIT_DESCRIPTION,
  TICKET_MODIFY, TICKET_VIEW, TIMELINE_VIEW, TRAC_ADMIN,
  VERSIONCONTROL_ADMIN, WIKI_ADMIN, WIKI_CREATE, WIKI_DELETE, WIKI_MODIFY,
- WIKI_VIEW
+ WIKI_RENAME, WIKI_VIEW
 
 ===== test_permission_remove_multiple_actions_ok =====
 
@@ -259 +259 @@
  TICKET_EDIT_CC, TICKET_EDIT_COMMENT, TICKET_EDIT_DESCRIPTION,
  TICKET_MODIFY, TICKET_VIEW, TIMELINE_VIEW, TRAC_ADMIN,
  VERSIONCONTROL_ADMIN, WIKI_ADMIN, WIKI_CREATE, WIKI_DELETE, WIKI_MODIFY,
- WIKI_VIEW
+ WIKI_RENAME, WIKI_VIEW
 
 ===== test_component_list_ok =====
 

trac/attachment.py

@@ -274 +274 @@
             except OSError, e:
                 env.log.error("Can't delete attachment directory %s: %s",
                     attachment_dir, exception_to_unicode(e, traceback=True))
+
+    @classmethod
+    def reparent_all(cls, env, old_realm, old_id, new_realm, new_id, db=None):
+        """Reparent all attachments of a given resource to another resource.
+        
+        :param old_realm: old parent's realm
+        :param old_id: old parent's id
+        :param new_realm: new parent's realm
+        :param new_id: new parent's id
+        :param env: the environent
+        :param db: the database connection
+        """
+        old_dir = os.path.join(os.path.normpath(env.path), 'attachments',
+                               old_realm, old_id)
+        if not os.path.exists(old_dir):
+            return
+
+        new_dir = os.path.join(os.path.normpath(env.path), 'attachments',
+                               new_realm, new_id)
+        
+        @with_transaction(env, db)
+        def do_reparent(db):
+            cursor = db.cursor()
+            cursor.execute("""
+                SELECT filename FROM attachment
+                WHERE type=%s AND id=%s
+                """, (old_realm, old_id))
+            
+            renames = []
+            for filename, in cursor:
+                old_filename = os.path.join(old_dir, filename)
+                new_filename = os.path.join(new_dir, filename)
+                if os.path.exists(new_filename):
+                    raise TracError(_("Can't reparent attachment '%(att)s' as "
+                                      "it already exists in %(realm)s:%(id)s", 
+                                      att=new_filename,
+                                      realm=new_realm, id=new_id))
+                renames.append((old_filename, new_filename))
+            
+            try:
+                if not os.path.exists(new_dir):
+                    os.makedirs(new_dir)
+            except OSError, e:
+                env.log.error("Can't create attachment directory '%s'",
+                              new_dir, exc_info=True)
+                raise TracError(_("Can't create attachment folder for "
+                                  "%(realm)s:%(id)s: %(err)",
+                                  realm=new_realm, id=new_id, err=e))
+            
+            for old_filename, new_filename in renames:
+                try:
+                    os.rename(old_filename, new_filename)
+                except OSError, e:
+                    env.log.error("Can't move attachment from '%s' to '%s'",
+                                  old_filename, new_filename, exc_info=True)
+                    raise TracError(_("Can't move attachment '%(att)s'",
+                                      att=os.path.basename(new_filename)))
+            cursor.execute("""
+                UPDATE attachment SET type=%s, id=%s
+                WHERE type=%s AND id=%s
+                """, (new_realm, new_id, old_realm, old_id))
+            
+        env.log.info('Attachments reparented to: %s:%s', new_realm, new_id)
+
+        
+        return
             
     def open(self):
         self.env.log.debug('Trying to open attachment at %s', self.path)

trac/htdocs/css/wiki.css

@@ -42 +42 @@
 #changeinfo br { clear: left }
 #changeinfo .options { padding: 0 0 1em 1em }
 #changeinfo .options, #changeinfo .buttons { clear: left }
-#delete, #save { margin-left: 6em }
+#delete, #rename, #save { margin-left: 6em }
 #preview {
  background: #f4f4f4 url(../draft.png);
  margin: 1em 0 2em;

trac/tests/functional/tester.py

@@ -176 +176 @@
             tc.formvalue('attachment', 'replace', True)
         tc.submit()
         tc.url(self.url + '/attachment/ticket/%s/$' % ticketid)
+        return tempfilename
 
     def clone_ticket(self, ticketid):
         """Create a clone of the given ticket id using the clone button."""
@@ -232 +233 @@
         tc.formvalue('attachment', 'description', random_sentence())
         tc.submit()
         tc.url(self.url + '/attachment/wiki/%s/$' % name)
+        return tempfilename
 
     def create_milestone(self, name=None, due=None):
         """Creates the specified milestone, with a random name if none is

trac/wiki/api.py

@@ -42 +42 @@
     def wiki_page_deleted(page):
         """Called when a page has been deleted."""
 
+    def wiki_page_renamed(page,old_page_name): 
+        """Called when a page has been renamed in-place.""" 
+
     def wiki_page_version_deleted(page):
         """Called when a version of a page has been deleted."""
 

trac/wiki/model.py

@@ -158 +158 @@
         self.old_readonly = self.readonly
         self.old_text = self.text
 
+    def rename(self, new_name, db=None):
+        """Rename wiki page in-place, keeping the history intact.
+        Renaming a page this way will eventually leave dangling references
+        to the old page - which litterally doesn't exist anymore.
+        """
+        assert self.exists, 'Cannot rename non-existent page'
+
+        old_name = self.name
+        
+        @with_transaction(self.env, db)
+        def do_rename(db):
+            cursor = db.cursor()
+            new_page = WikiPage(self.env, new_name, version=None, db=db)
+            if new_page.exists:
+                raise TracError(_("Can't rename to existing %(nn)s page.",
+                                  nn=new_name))
+
+            cursor.execute("UPDATE wiki SET name=%s WHERE name=%s",
+                           (new_name, old_name))
+            self.name = new_name
+            self._fetch(self.name, None, db)
+
+            from trac.attachment import Attachment
+            Attachment.reparent_all(self.env, 'wiki', old_name,
+                                    'wiki', self.name, db)
+
+        self.env.log.info('Renamed page %s in-place to %s', old_name, new_name)
+        
+        for listener in WikiSystem(self.env).change_listeners:
+            if hasattr(listener, 'wiki_page_renamed'):
+                listener.wiki_page_renamed(self, old_name)
+
+
     def get_history(self, db=None):
         if not db:
             db = self.env.get_db_cnx()

new file trac/wiki/templates/wiki_rename.html

@@ +1 @@
+<!DOCTYPE html
+    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"
+      xmlns:py="http://genshi.edgewall.org/"
+      xmlns:xi="http://www.w3.org/2001/XInclude">
+  <xi:include href="layout.html" />
+  <head>
+    <title>$title</title>
+  </head>
+
+  <body>
+    <div id="content" class="wiki"
+      py:with="
+      current_href = href.wiki(page.name);
+     ">
+      <h1>${_('Rename')} <a href="$current_href">$page.name</a></h1>
+      <form action="$current_href" method="post">
+        <p>
+          <input type="hidden" name="action" value="rename" />
+          <strong>Renaming the page will rename all existing versions
+          of the page in place. <br />
+          The history of the renamed page will be exactly the same as the one
+          of the original page.</strong>
+          <br />
+          <p>
+            <label for="new_name">New name:</label>
+            <input type="text" id="new_name" name="new_name" size="40" value="$page.name" />
+          </p>
+          <br />
+          <fieldset id="rename_options" class="group">
+            <legend>${_('Rename')} ${_('Options')}</legend>
+            <input type="checkbox" id="leave_redirection" name="leave_redirection"/>
+            <label for="leave_redirection">Leave a redirection to the new page.</label>
+            <br />
+            If you choose to leave a redirection, this will 
+            re-create the $page.name page with a link pointing to the new
+            page.
+          </fieldset>
+       </p>
+        <div class="buttons">
+          <input type="submit" name="cancel" value="${_('Cancel')}" />
+          <input type="submit" value="${_('Rename')} $page.name" />
+        </div>
+      </form>
+    </div>
+  </body>
+</html>

trac/wiki/templates/wiki_view.html

@@ -71 +71 @@
 
       <py:with vars="modify_perm = 'WIKI_MODIFY' in perm(page.resource);
                      delete_perm = 'WIKI_DELETE' in perm(page.resource);
-                     admin_perm = 'WIKI_ADMIN' in perm(page.resource)">
+                     admin_perm = 'WIKI_ADMIN' in perm(page.resource);
+                           rename_perm = 'WIKI_RENAME' in perm(page.resource)">
         <py:if test="admin_perm or (not page.readonly and (modify_perm or delete_perm))">
           <div class="buttons">
             <py:if test="modify_perm">
@@ -101 +102 @@
                 <xi:include href="attach_file_form.html" py:with="alist = attachments"/>
               </py:if>
             </py:if>
+            <py:if test="page.exists and rename_perm"> 
+                     <form method="get" action="${href.wiki(page.name)}" id="rename"> 
+                        <div> 
+                          <input type="hidden" name="action" value="rename" /> 
+                          <input type="submit" value="${_('Rename page')}" /> 
+                        </div> 
+                     </form> 
+                  </py:if> 
             <py:if test="page.exists and delete_perm">
               <form method="get" action="${href.wiki(page.name)}">
                 <div id="delete">

trac/wiki/tests/functional.py

@@ -12 +12 @@
         self._tester.attach_file_to_wiki(pagename)
 
 
+class TestWikiRename(FunctionalTwillTestCaseSetup):
+    def runTest(self):
+        """Test for simple wiki rename"""
+        pagename = random_unique_camel()
+        self._tester.create_wiki_page(pagename)
+        self._tester.rename_wiki_page(pagename)
+        attachment = self._tester.attach_file_to_wiki(pagename)
+        base_url = self._tester.url
+        page_url = base_url + "/wiki/" + pagename
+        
+        def click_rename():
+            tc.formvalue('rename', 'action', 'rename')
+            tc.submit()
+            tc.url(page_url+r'\?action=rename')
+            tc.find("New name:")
+        
+        tc.go(page_url)
+        tc.find("Rename page")
+        click_rename()
+        # attempt to rename the page to the current page name ...        
+        tc.formvalue(page_url, 'new_name', 'rename')
+        tc.submit('rename')
+        tc.url(page_url)
+        tc.find("New name must be different from old name.")
+        # attempt to rename the page to an existing page name ...
+        tc.formvalue(page_url, 'new_name', 'WikiStart')
+        tc.submit('rename')
+        tc.url(page_url)
+        tc.find("Trac Error")
+        tc.find("Can't rename to existing WikiStart page")
+        # correct rename to new page name (old page replaced by a redirection)
+        tc.go(page_url)
+        click_rename()
+        newpagename = pagename+'Renamed'
+        tc.formvalue(page_url, 'new_name', newpagename)
+        tc.formvalue(page_url, 'leave_redirection', True) # the default
+        tc.submit('rename')
+        # check redirection page
+        tc.url(page_url)
+        tc.find("See.*/wiki/"+newpagename)
+        # check whether attachment exists on the new page but not on old page
+        tc.go(base_url+'/attachment/wiki/'+newpagename+'/'+attachment)
+        tc.notfind("Error: Invalid Attachment")
+        tc.go(base_url+'/attachment/wiki/'+pagename+'/'+attachment)
+        tc.find("Error: Invalid Attachment")
+        # rename again to another new page name (this time, no redirection)
+        tc.go(page_url)
+        click_rename()
+        newpagename = pagename+'RenamedAgain'
+        tc.formvalue(page_url, 'new_name', newpagename)
+        tc.formvalue(page_url, 'leave_redirection', False)
+        tc.submit('rename')
+        tc.url(base_url + "/wiki/" + newpagename)
+        # this time, the original page is gone
+        tc.go(page_url)
+        tc.url(page_url)
+        tc.find("Describe %s here" % pagename)
+        
+
+
 class RegressionTestTicket4812(FunctionalTwillTestCaseSetup):
     def runTest(self):
         """Test for regression of http://trac.edgewall.org/ticket/4812"""

trac/wiki/tests/model.py

@@ -1 +1 @@
 from datetime import datetime
+import tempfile
 import unittest
 
+from trac.attachment import Attachment
 from trac.core import *
 from trac.test import EnvironmentStub
 from trac.util.datefmt import utc, to_utimestamp
@@ -14 +16 @@
         self.changed = []
         self.deleted = []
         self.deleted_version = []
+        self.renamed = {}
 
     def wiki_page_added(self, page):
         self.added.append(page)
@@ -27 +30 @@
     def wiki_page_version_deleted(self, page):
         self.deleted_version.append(page)
 
+    def wiki_page_renamed(self, page, old_page_name):
+        self.renamed[old_page_name] = page
+
 
 class WikiPageTestCase(unittest.TestCase):
 
@@ -194 +200 @@
         listener = TestWikiChangeListener(self.env)
         self.assertEqual(page, listener.deleted[0])
 
+    def test_rename_page(self):
+        cursor = self.db.cursor()
+        data = (1, 42, 'joe', '::1', 'Bla bla', 'Testing', 0)
+        cursor.execute("INSERT INTO wiki VALUES(%s,%s,%s,%s,%s,%s,%s,%s)",
+                       ('TestPage',) + data)
+        
+        page = WikiPage(self.env, 'TestPage')
+
+        attachment = Attachment(self.env, 'wiki', 'TestPage')
+        attachment.insert('foo.txt', tempfile.TemporaryFile(), 0, 1)
+
+        page.rename('PageRenamed')
+        
+        cursor.execute("SELECT version,time,author,ipnr,text,comment,"
+                       "readonly FROM wiki WHERE name=%s", ('PageRenamed',))
+        self.assertEqual(data, cursor.fetchone())
+        self.assertEqual(None, cursor.fetchone())
+        
+        attachments = Attachment.select(self.env, 'wiki', 'PageRenamed')
+        self.assertEqual('foo.txt', attachments.next().filename)
+        self.assertRaises(StopIteration, attachments.next)
+        Attachment.delete_all(self.env, 'wiki', 'PageRenamed', self.db)
+
+
+        old_page = WikiPage(self.env, 'TestPage')
+        
+        cursor.execute("SELECT version,time,author,ipnr,text,comment,"
+                       "readonly FROM wiki WHERE name=%s", ('TestPage',))
+        self.assertEqual(None, cursor.fetchone())
+        
+        listener = TestWikiChangeListener(self.env)
+        self.assertEqual({'TestPage': page}, listener.renamed)
+
+
 
 def suite():
     return unittest.makeSuite(WikiPageTestCase, 'test')

trac/wiki/web_ui.py

@@ -93 +93 @@
     # IPermissionRequestor methods
 
     def get_permission_actions(self):
-        actions = ['WIKI_CREATE', 'WIKI_DELETE', 'WIKI_MODIFY', 'WIKI_VIEW']
+        actions = ['WIKI_CREATE', 'WIKI_DELETE', 'WIKI_MODIFY', 'WIKI_RENAME', 'WIKI_VIEW']
         return actions + [('WIKI_ADMIN', actions)]
 
     # IRequestHandler methods
@@ -145 +145 @@
                     return self._render_editor(req, page, action, has_collision)
             elif action == 'delete':
                 self._do_delete(req, versioned_page)
+            elif action == 'rename':
+                return self._do_rename(req, page)
             elif action == 'diff':
                 get_diff_options(req)
                 req.redirect(req.href.wiki(versioned_page.name, action='diff',
                                            old_version=old_version,
                                            version=version))
         elif action == 'delete':
-            return self._render_confirm(req, versioned_page)
+            return self._render_confirm_delete(req, versioned_page)
+        elif action == 'rename':
+            return self._render_confirm_rename(req, page)
         elif action == 'edit':
             return self._render_editor(req, versioned_page)
         elif action == 'diff':
@@ -246 +250 @@
         old_version = int(req.args.get('old_version', 0)) or version
 
         @with_transaction(self.env)
-        def do_transaction(db):
+        def do_delete(db):
             if version and old_version and version > old_version:
                 # delete from `old_version` exclusive to `version` inclusive:
                 for v in range(old_version, version):
@@ -270 +274 @@
                                   version=version, name=page.name))
             req.redirect(req.href.wiki(page.name))
 
+    def _do_rename(self, req, page):
+        if page.readonly:
+            req.perm(page.resource).require('WIKI_ADMIN')
+        else:
+            req.perm(page.resource).require('WIKI_RENAME')
+         
+        if 'cancel' in req.args:
+            req.redirect(get_resource_url(self.env, page.resource, req.href))
+         
+        new_name = req.args.get('new_name', '').rstrip('/')
+        old_name = page.name
+        old_version = page.version
+        leave_redirection = req.args.get('leave_redirection')
+         
+        # verify input parameters
+        warn = None
+        if not new_name:
+            warn = _("New name is mandatory for a rename.")
+        elif new_name == old_name:
+            warn = _("New name must be different from old name.")
+        if warn:
+            add_warning(req, warn)
+            return self._render_rename_form(req, page)
+        
+
+        @with_transaction(self.env)
+        def do_rename(db):
+            page.rename(new_name, db)
+            if leave_redirection:
+                redirection_page = WikiPage(self.env, old_name)
+                redirection_page.text = _("See [wiki:%(page)s].",
+                                          page=new_name)
+                author = get_reporter_id(req)
+                comment = _("[wiki:'%(new_name)s@%(old_version)d' "
+                            "%(old_name)s] was renamed to %(new_name)s",
+                            old_name=old_name, old_version=old_version,
+                            new_name=new_name)
+                redirection_page.save(author, comment, req.remote_addr,
+                                      None, db)
+        
+        req.redirect(req.href.wiki(leave_redirection and old_name or new_name))
+
+        
+
     def _do_save(self, req, page):
         if page.readonly:
             req.perm(page.resource).require('WIKI_ADMIN')
@@ -294 +342 @@
             add_warning(req, _("Page not modified, showing latest version."))
             return self._render_view(req, page)
 
-    def _render_confirm(self, req, page):
+    def _render_confirm_delete(self, req, page):
         if page.readonly:
             req.perm(page.resource).require('WIKI_ADMIN')
         else:
@@ -319 +367 @@
         self._wiki_ctxtnav(req, page)
         return 'wiki_delete.html', data, None
 
+    def _render_confirm_rename(self, req, page):
+        if page.readonly:
+            req.perm(page.resource).require('WIKI_ADMIN')
+        else:
+            req.perm(page.resource).require('WIKI_RENAME')
+           
+            data = self._page_data(req, page, 'rename')
+            self._wiki_ctxtnav(req, page)
+            return 'wiki_rename.html', data, None
+        
+
     def _render_diff(self, req, page):
         if not page.exists:
             raise TracError(_('Version %(num)s of page "%(name)s" does not '