Context Navigation

Back to Ticket #2259

Ticket #2259: attachment_1.0.1dev.patch

File attachment_1.0.1dev.patch, 15.9 KB (added by Emmanuel Blot, 12 years ago)
New patch for latest development version (1.0.1dev), including cboos fixes.

trac/ticket/notification.py

From 96eea30c464c0aa22182ea6018c1fdbba63947fb Mon Sep 17 00:00:00 2001
From: Emmanuel Blot <[email protected]>
Date: Thu, 22 Nov 2012 14:31:31 +0100
Subject: [PATCH] Restore TicketAttachmentNotifier feature

---
 trac/ticket/notification.py | 299 ++++++++++++++++++++++++++++----------------
 1 file changed, 193 insertions(+), 106 deletions(-)

diff --git a/trac/ticket/notification.py b/trac/ticket/notification.py
index f4dc3ab..b20f0df 100644

-              a
 from __future__ import with_statement
+from datetime import datetime
 from hashlib import md5
 from genshi.template.text import NewTextTemplate
+from trac.attachment import IAttachmentChangeListener
 from trac.core import *
 from trac.config import *
 from trac.notification import NotifyEmail
 from trac.ticket.api import TicketSystem
+from trac.ticket.model import Ticket
 from trac.util.datefmt import format_date_or_datetime, get_timezone, \
                               to_utimestamp
+                              to_utimestamp, utc
 from trac.util.text import obfuscate_email_address, text_width, wrap
 from trac.util.translation import deactivate, reactivate
-…
+               class TicketNotifyEmail(NotifyEmail):
         translated_fields = ticket.fields
         try:
             ticket.fields = TicketSystem(self.env).get_ticket_fields()
+            self._notify(ticket, newticket, modtime)
+            self.ticket = ticket
+            self.modtime = modtime
+            self.newticket = newticket
+            self.reporter = ''
+            self.owner = ''
+            if not newticket and modtime:  # Ticket change
+                (link, summary, author) = \
+                    self._build_notification_changes(ticket, modtime)
+            else:
+                link = self.env.abs_href.ticket(ticket.id)
+                summary = self.ticket['summary']
+                author = None
+            if newticket:
+                author = ticket['reporter']
+            ticket_values = ticket.values.copy()
+            ticket_values['id'] = ticket.id
+            ticket_values['description'] = wrap(
+                ticket_values.get('description', ''), self.COLS,
+                initial_indent=' ', subsequent_indent=' ', linesep='\n',
+                ambiwidth=self.ambiwidth)
+            ticket_values['new'] = self.newticket
+            ticket_values['link'] = link
+            subject = self.format_subj(summary)
+            if not self.newticket:
+                subject = 'Re: ' + subject
+            self.data.update({
+                'ticket_props': self.format_props(),
+                'ticket_body_hdr': self.format_hdr(),
+                'subject': subject,
+                'ticket': ticket_values,
+                })
+            NotifyEmail.notify(self, ticket.id, subject, author)
         finally:
             ticket.fields = translated_fields
             reactivate(t)
+    def _notify(self, ticket, newticket=True, modtime=None):
+        self.ticket = ticket
+        self.modtime = modtime
+        self.newticket = newticket
+    def notify_attachment(self, ticket, author, filename, modtime, body):
+        """Send ticket attachment notification (untranslated)"""
+        t = deactivate()
+        translated_fields = ticket.fields
+        try:
+            ticket.fields = TicketSystem(self.env).get_ticket_fields()
+            self.ticket = ticket
+            self.modtime = modtime
+            self.newticket = False
+            self.reporter = ''
+            self.owner = ''
+            link = self.env.abs_href.ticket(ticket.id)
+            summary = self.ticket['summary']
+            ticket_values = ticket.values.copy()
+            ticket_values['id'] = ticket.id
+            ticket_values['description'] = wrap(
+                ticket_values.get('description', ''), self.COLS,
+                initial_indent=' ', subsequent_indent=' ', linesep='\n',
+                ambiwidth=self.ambiwidth)
+            ticket_values['new'] = self.newticket
+            ticket_values['link'] = link
+            subject = 'Re: ' + self.format_subj(summary)
+            changes_descr = ''
+            change_data = {'author': author}
+            self.data.update({
+                'ticket_props': self.format_props(),
+                'ticket_body_hdr': self.format_hdr(),
+                'subject': subject,
+                'ticket': ticket_values,
+                'changes_body': body,
+                'changes_descr': changes_descr,
+                'change': change_data,
+                })
+            NotifyEmail.notify(self, ticket.id, subject, author)
+        finally:
+            ticket.fields = translated_fields
+            reactivate(t)
+    def _build_notification_changes(self, ticket, modtime):
+        from trac.ticket.web_ui import TicketModule
         changes_body = ''
-        self.reporter = ''
-        self.owner = ''
         changes_descr = ''
         change_data = {}
         link = self.env.abs_href.ticket(ticket.id)
         summary = self.ticket['summary']
+        author = None
+        if not self.newticket and modtime:  # Ticket change
+            from trac.ticket.web_ui import TicketModule
+            for change in TicketModule(self.env).grouped_changelog_entries(
+                                                ticket, when=modtime):
+                if not change['permanent']: # attachment with same time...
+                    continue
+                author = change['author']
+                change_data.update({
+                    'author': self.obfuscate_email(author),
+                    'comment': wrap(change['comment'], self.COLS, ' ', ' ',
+                                    '\n', self.ambiwidth)
+                    })
+                link += '#comment:%s' % str(change.get('cnum', ''))
+                for field, values in change['fields'].iteritems():
+                    old = values['old']
+                    new = values['new']
+                    newv = ''
+                    if field == 'description':
+                        new_descr = wrap(new, self.COLS, ' ', ' ', '\n',
+                                         self.ambiwidth)
+                        old_descr = wrap(old, self.COLS, '> ', '> ', '\n',
+                                         self.ambiwidth)
+                        old_descr = old_descr.replace(2 * '\n', '\n' + '>' + \
+                                                      '\n')
+                        cdescr = '\n'
+                        cdescr += 'Old description:' + 2 * '\n' + old_descr + \
+* '\n'
+                        cdescr += 'New description:' + 2 * '\n' + new_descr + \
+                                  '\n'
+                        changes_descr = cdescr
+                    elif field == 'summary':
+                        summary = "%s (was: %s)" % (new, old)
+                    elif field == 'cc':
+                        (addcc, delcc) = self.diff_cc(old, new)
+                        chgcc = ''
+                        if delcc:
+                            chgcc += wrap(" * cc: %s (removed)" %
+                                          ', '.join(delcc),
+                                          self.COLS, ' ', ' ', '\n',
+                                          self.ambiwidth) + '\n'
+                        if addcc:
+                            chgcc += wrap(" * cc: %s (added)" %
+                                          ', '.join(addcc),
+                                          self.COLS, ' ', ' ', '\n',
+                                          self.ambiwidth) + '\n'
+                        if chgcc:
+                            changes_body += chgcc
+                        self.prev_cc += self.parse_cc(old) if old else []
+                    else:
+                        if field in ['owner', 'reporter']:
+                            old = self.obfuscate_email(old)
+                            new = self.obfuscate_email(new)
+                        elif field in ticket.time_fields:
+                            format = ticket.fields.by_name(field).get('format')
+                            old = self.format_time_field(old, format)
+                            new = self.format_time_field(new, format)
+                        newv = new
+                        length = 7 + len(field)
+                        spacer_old, spacer_new = ' ', ' '
+                        if len(old + new) + length > self.COLS:
+                            length = 5
+                            if len(old) + length > self.COLS:
+                                spacer_old = '\n'
+                            if len(new) + length > self.COLS:
+                                spacer_new = '\n'
+                        chg = '* %s: %s%s%s=>%s%s' % (field, spacer_old, old,
+                                                      spacer_old, spacer_new,
+                                                      new)
+                        chg = chg.replace('\n', '\n' + length * ' ')
+                        chg = wrap(chg, self.COLS, '', length * ' ', '\n',
+                                   self.ambiwidth)
+                        changes_body += ' %s%s' % (chg, '\n')
+                    if newv:
+                        change_data[field] = {'oldvalue': old, 'newvalue': new}
+        if newticket:
+            author = ticket['reporter']
+        ticket_values = ticket.values.copy()
+        ticket_values['id'] = ticket.id
+        ticket_values['description'] = wrap(
+            ticket_values.get('description', ''), self.COLS,
+            initial_indent=' ', subsequent_indent=' ', linesep='\n',
+            ambiwidth=self.ambiwidth)
+        ticket_values['new'] = self.newticket
+        ticket_values['link'] = link
+        subject = self.format_subj(summary)
+        if not self.newticket:
+            subject = 'Re: ' + subject
+        for change in TicketModule(self.env).grouped_changelog_entries(
+                                            ticket, when=modtime):
+            if not change['permanent']: # attachment with same time...
+                continue
+            author = change['author']
+            change_data.update({
+                'author': self.obfuscate_email(author),
+                'comment': wrap(change['comment'], self.COLS, ' ', ' ',
+                                '\n', self.ambiwidth)
+                })
+            link += '#comment:%s' % str(change.get('cnum', ''))
+            for field, values in change['fields'].iteritems():
+                old = values['old']
+                new = values['new']
+                newv = ''
+                if field == 'description':
+                    new_descr = wrap(new, self.COLS, ' ', ' ', '\n',
+                                     self.ambiwidth)
+                    old_descr = wrap(old, self.COLS, '> ', '> ', '\n',
+                                     self.ambiwidth)
+                    old_descr = old_descr.replace(2 * '\n', '\n' + '>' + \
+                                                  '\n')
+                    cdescr = '\n'
+                    cdescr += 'Old description:' + 2 * '\n' + old_descr + \
+* '\n'
+                    cdescr += 'New description:' + 2 * '\n' + new_descr + \
+                              '\n'
+                    changes_descr = cdescr
+                elif field == 'summary':
+                    summary = "%s (was: %s)" % (new, old)
+                elif field == 'cc':
+                    (addcc, delcc) = self.diff_cc(old, new)
+                    chgcc = ''
+                    if delcc:
+                        chgcc += wrap(" * cc: %s (removed)" %
+                                      ', '.join(delcc),
+                                      self.COLS, ' ', ' ', '\n',
+                                      self.ambiwidth) + '\n'
+                    if addcc:
+                        chgcc += wrap(" * cc: %s (added)" %
+                                      ', '.join(addcc),
+                                      self.COLS, ' ', ' ', '\n',
+                                      self.ambiwidth) + '\n'
+                    if chgcc:
+                        changes_body += chgcc
+                    self.prev_cc += self.parse_cc(old) if old else []
+                else:
+                    if field in ['owner', 'reporter']:
+                        old = self.obfuscate_email(old)
+                        new = self.obfuscate_email(new)
+                    elif field in ticket.time_fields:
+                        format = ticket.fields.by_name(field).get('format')
+                        old = self.format_time_field(old, format)
+                        new = self.format_time_field(new, format)
+                    newv = new
+                    length = 7 + len(field)
+                    spacer_old, spacer_new = ' ', ' '
+                    if len(old + new) + length > self.COLS:
+                        length = 5
+                        if len(old) + length > self.COLS:
+                            spacer_old = '\n'
+                        if len(new) + length > self.COLS:
+                            spacer_new = '\n'
+                    chg = '* %s: %s%s%s=>%s%s' % (field, spacer_old, old,
+                                                  spacer_old, spacer_new,
+                                                  new)
+                    chg = chg.replace('\n', '\n' + length * ' ')
+                    chg = wrap(chg, self.COLS, '', length * ' ', '\n',
+                               self.ambiwidth)
+                    changes_body += ' %s%s' % (chg, '\n')
+                if newv:
+                    change_data[field] = {'oldvalue': old, 'newvalue': new}
         self.data.update({
-            'ticket_props': self.format_props(),
-            'ticket_body_hdr': self.format_hdr(),
-            'subject': subject,
-            'ticket': ticket_values,
             'changes_body': changes_body,
             'changes_descr': changes_descr,
             'change': change_data
+            'change': change_data,
             })
         NotifyEmail.notify(self, ticket.id, subject, author)
+        return (link, summary, author)
     def format_props(self):
         tkt = self.ticket
-…
+               class TicketNotifyEmail(NotifyEmail):
         else:
             return obfuscate_email_address(text)
+class TicketAttachmentNotifier(Component):
+    """Sends notification on attachment change"""
+    implements(IAttachmentChangeListener)
+    ticket_notify_attachment = BoolOption('notification',
+                                          'ticket_notify_attachment',
+                                          'true',
+        """Always send notifications on ticket attachment events.""")
+    # IAttachmentChangeListener
+    def attachment_added(self, attachment):
+        if self.ticket_notify_attachment:
+            self._notify_attachment(attachment, True)
+    def attachment_deleted(self, attachment):
+        if self.ticket_notify_attachment:
+            self._notify_attachment(attachment, False)
+    def attachment_reparented(self, attachment, old_parent_realm,
+                              old_parent_id):
+        pass
+    # Implementation
+    def _notify_attachment(self, attachment, add):
+        author = attachment.author
+        resource = attachment.resource.parent
+        if resource.realm != 'ticket':
+            return
+        ticket = Ticket(self.env, resource.id)
+        tn = TicketNotifyEmail(self.env)
+        filename = attachment.filename
+        date = attachment.date or datetime.now(utc)
+        # Note: no translation yet
+        if add:
+            body = "Attachment \"%s\" added." % filename
+        else:
+            body = "Attachment \"%s\" removed." % filename
+        if attachment.description:
+            body += "\n\n" + attachment.description
+        tn.notify_attachment(ticket, author, filename, date, body)
 class BatchTicketNotifyEmail(NotifyEmail):
     """Notification of ticket batch modifications."""

Download in other formats:

Original Format