Add API to rename attachments

[anonymous]

Similar to API to reparent attachments:

trac/attachment.py

@@ -57 +57 @@
 
 class IAttachmentChangeListener(Interface):
     """Extension point interface for components that require
-    notification when attachments are created or deleted."""
+    notification when attachments are created or deleted etc."""
 
     def attachment_added(attachment):
         """Called when an attachment is added."""
@@ -65 +65 @@
     def attachment_deleted(attachment):
         """Called when an attachment is deleted."""
 
+    def attachment_renamed(attachment, old_filename):
+        """Called when an attachment is renamed."""
+
     def attachment_reparented(attachment, old_parent_realm, old_parent_id):
         """Called when an attachment is reparented."""
 
@@ -765 +768 @@
         for listener in AttachmentModule(self.env).change_listeners:
             listener.attachment_deleted(self)
 
+    def rename(self, new_filename):
+        assert self.filename, "Cannot rename non-existent attachment"
+        new_filename = unicode(new_filename)
+        new_path = self._get_path(self.env.attachments_dir, self.parent_realm,
+                                  self.parent_id, new_filename)
+
+        # Make sure the path to the attachment is inside the environment
+        # attachments directory
+        commonprefix = os.path.commonprefix([self.env.attachments_dir,
+                                             new_path])
+        if commonprefix != self.env.attachments_dir:
+            raise TracError(_('Cannot rename attachment "%(att)s" as '
+                              '%(new)s is invalid',
+                              att=self.filename, new=new_filename))
+
+        if os.path.exists(new_path):
+            raise TracError(_('Cannot rename attachment "%(att)s" to %(new)s '
+                              'as it already exists',
+                              att=self.filename, new=new_filename))
+        with self.env.db_transaction as db:
+            db("""UPDATE attachment SET filename=%s
+                  WHERE type=%s AND id=%s AND filename=%s
+                  """, (new_filename, self.parent_realm,
+                        self.parent_id, self.filename))
+            dirname = os.path.dirname(new_path)
+            if not os.path.exists(dirname):
+                os.makedirs(dirname)
+            path = self.path
+            if os.path.isfile(path):
+                try:
+                    os.rename(path, new_path)
+                except OSError as e:
+                    self.env.log.error("Failed to move attachment file %s: %s",
+                                       path,
+                                       exception_to_unicode(e, traceback=True))
+                    raise TracError(_("Could not rename attachment %(name)s",
+                                      name=self.filename))
+
+        old_filename = self.filename
+        self.filename = new_filename
+        self.env.log.info("Attachment renamed: %s", new_filename)
+
+        for listener in AttachmentModule(self.env).change_listeners:
+            if hasattr(listener, 'attachment_renamed'):
+                listener.attachment_renamed(self, old_filename)
+
     def reparent(self, new_realm, new_id):
         assert self.filename, "Cannot reparent non-existent attachment"
         new_id = unicode(new_id)

[Ryan J Ollos]

Looks fine to me, but patch didn't apply cleanly to the trunk (TracDev/SubmittingPatches). It will need unit tests before we can commit the changes.

We could also add TracAdmin rename and reparent commands. Or maybe combine them in a single move <realm:id> <name> <new_realm:new_id> <new_name> command. We should also consider whether rename and reparent should be combined in a single method, adding an optional filename argument to reparent and possibly renaming the method to move.

log:rjollos.git:t12870_attachment_rename.

[Ryan J Ollos]

Proposed changes in log:rjollos.git:t12870_attachment_rename.1.

[Ryan J Ollos]

Committed to trunk in r16160.

[Jun Omae]

I noticed the API changes, just now….