TracNotification for new tickets only

[me@…]

For a project I'm working on (​Warzone 2100), I'm currently setting up a Trac environment ​here (with an incomplete SSL certificate as of yet).

In this project we want to be sent notices on the mailinglist when new tickets are created. So I set up TracNotification to send some mails to the mailing list. The problem is though that we only want these notices on ticket creation, not when they're updated or modified. Unfortunately TracNotification didn't do this natively, so I had to extend the TicketNotifyEmail class somewhat.

The attached patch contains this extension/modification and adds a new configuration option to the [notification] section in trac.ini.

• cc_on_newticket: Email address(es) to send notifications about newly created tickets to, addresses can only be seen when use_public_cc is enabled (Cc:).

NOTE: This patch should work with trunk as well, it's just that I wrote it for my 0.10.3 Trac installation.

—
Giel

[me@…]

adds a TracNotification option for CC on new tickets

[Emmanuel Blot]

New features won't be integrated to the maintenance branch 0.10

The TracNotification subsystem will be rewritten for 0.12.

[anonymous]

For the rewrite of TracNotification I assume you mean trac.ticket.api.ITicketChangeListener​ as mentioned in PluginDevelopment ?

Something like that seems to be in progress @ track-hacks: ​AnnouncerPlugin.

Also initially I used a patch like this (which would add these mail addresses to the public Cc: list always, indepent from the user_public_cc setting. I personally think this option (i.e. independence of user_public_cc) is better, though this patch feels more like a hack to me (as it changes the interface/function prototypes):

notification.py

@@ -55 +55 @@
         """Email address(es) to always send notifications to,
            addresses can be see by all recipients (Cc:).""")
 
+    smtp_cc_on_newticket = Option('notification', 'smtp_cc_on_newticket', '',
+        """Email address(es) to send notifications about newly
+           created tickets to, addresses can be seen by all
+           recipients (Cc:).""")
+
     smtp_always_bcc = Option('notification', 'smtp_always_bcc', '',
         """Email address(es) to always send notifications to,
            addresses do not appear publicly (Bcc:). (''since 0.10'').""")
@@ -155 +160 @@
     longaddr_re = re.compile(r"^\s*(.*)\s+<(" + addrfmt + ")>\s*$");
     nodomaddr_re = re.compile(r"[\w\d_\.\-]+")
     addrsep_re = re.compile(r"[;\s,]+")
+    newticket = None
 
     def __init__(self, env):
         Notify.__init__(self, env)
@@ -192 +198 @@
         else:
             raise TracError, 'Invalid email encoding setting: %s' % pref
 
-    def notify(self, resid, subject):
+    def notify(self, resid, subject, newticket=False):
         self.subject = subject
+        self.newticket = newticket
 
         if not self.config.getbool('notification', 'smtp_enabled'):
             return
@@ -325 +332 @@
         bccaddrs = bccparam and \
                    build_addresses(bccparam.replace(',', ' ').split()) or []
 
+        if self.newticket:
+            naccparam = self.config.get('notification', 'smtp_cc_on_newticket')
+            accaddrs += naccparam and \
+                        build_addresses(naccparam.replace(',', ' ').split()) or []
+
         recipients = []
         (toaddrs, recipients) = remove_dup(toaddrs, recipients)
         (ccaddrs, recipients) = remove_dup(ccaddrs, recipients)

ticket/notification.py

@@ -126 +126 @@
                 self.hdf.set_unescaped('email.changes_body', changes)
         self.ticket['link'] = link
         self.hdf.set_unescaped('ticket', self.ticket.values)
-        NotifyEmail.notify(self, ticket.id, subject)
+        NotifyEmail.notify(self, ticket.id, subject, self.newticket)
 
     def format_props(self):
         tkt = self.ticket

[Christian Boos]

See also Stephen Hansen's mail on trac-dev, ​Notification Architecture.

Setting the milestone tentatively to 0.12, as I think the new notification architecture should be able to allow for such requests, though not necessarily through the way proposed in the patch, rather using some more general ways, like in Stephen's proposal.

[AH]

Might still be useful 7 years later with many Trac releases in between. Has it made its way into the product?

[Peter Suter]

Could now be implemented as a plugin (or optional component)? Untested:

from trac.core import Component, implements
from trac.notification.api import INotificationSubscriber
from trac.notification.model import Subscription

class NewTicketSubscriber(Component):
    """Subscribe to new created tickets."""

    implements(INotificationSubscriber)

    # INotificationSubscriber methods

    def matches(self, event):
        if event.realm != 'ticket':
            return
        if event.category != 'created':
            return

        klass = self.__class__.__name__
        for s in Subscription.find_by_class(self.env, klass):
            yield s.subscription_tuple()

    def description(self):
        return _("Any ticket is created")

    def default_subscriptions(self):
        return []

    def requires_authentication(self):
        return False

[Peter Suter]

See wiki:CookBook/Notification/Subscriptions#Subscribetonewcreatedtickets

Maybe a candidate for tracopt?

[Ryan J Ollos]

NewTicketSubscriber works well and I agree we should add to tracopt.

[Ryan J Ollos]

Or maybe just add to trac.ticket.notification. I don't see any downsides to enabling NewTicketSubscriber in a default installation.

[Ryan J Ollos]

Proposed changes in [99a7c844f/rjollos.git].

[Ryan J Ollos]

Committed to 1.2-stable in r16630, merged to trunk in r16631.