Changes between Version 13 and Version 14 of CookBook/Notification/Subscriptions

Timestamp:

Sep 3, 2018, 10:57:51 PM (6 years ago)

Author:

Peter Suter

Comment:

Added TesterCustomFieldSubscriber

CookBook/Notification/Subscriptions

@@ -322 +322 @@
 1. Users can manage this subscription in [/prefs/notification their preferences].
 
-See also: #12728 
+See also: #12728
+
+== Subscribe via custom ticket field
+
+[TracTicketsCustomFields Custom ticket fields] can be configured to behave like an additional [wiki:TracTickets#/Cc Cc field]. For example a `tester` field can notify employees responsible for testing a feature, separately from other Cc'd users.
+
+1. Create a [TracTicketsCustomFields custom ticket fields] `tester`.
+1. Create a [TracDev/PluginDevelopment#Singlefileplugins single file plugin] that implements [wiki:TracDev/PluginDevelopment/ExtensionPoints/trac.notification.api.INotificationSubscriber INotificationSubscriber]:
+{{{#!python
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2018 Edgewall Software
+# All rights reserved.
+#
+# This software is licensed as described in the file COPYING, which
+# you should have received as part of this distribution. The terms
+# are also available at http://trac.edgewall.org/wiki/TracLicense.
+#
+# This software consists of voluntary contributions made by many
+# individuals. For the exact contribution history, see the revision
+# history and logs, available at http://trac.edgewall.org/log/.
+
+from trac.core import Component, implements
+from trac.notification.api import INotificationSubscriber, NotificationSystem
+from trac.notification.mail import RecipientMatcher
+from trac.notification.model import Subscription
+from trac.web.chrome import Chrome
+
+class TesterCustomFieldSubscriber(Component):
+    """Subscriber for custom ticket field."""
+
+    implements(INotificationSubscriber)
+   
+    field_name = 'tester'
+
+    # INotificationSubscriber methods
+
+    def matches(self, event):
+        if event.realm != 'ticket':
+            return
+        if event.category not in ('created', 'changed', 'attachment added',
+                                  'attachment deleted'):
+            return
+
+        # Custom field with comma-separated string. Parse to set.
+        chrome = Chrome(self.env)
+        to_set = lambda field: set(chrome.cc_list(field))
+        user_set = to_set(event.target[self.field_name] or '')
+
+        # Harvest previous field values
+        if 'fields' in event.changes and self.field_name in event.changes['fields']:
+            field_set.update(to_set(event.changes['fields'][self.field_name]['old']))
+
+        matcher = RecipientMatcher(self.env)
+        klass = self.__class__.__name__
+        sids = set()
+        for field in field_set:
+            recipient = matcher.match_recipient(field)
+            if not recipient:
+                continue
+            sid, auth, addr = recipient
+
+            # Default subscription
+            for s in self.default_subscriptions():
+                yield s[0], s[1], sid, auth, addr, s[2], s[3], s[4]
+            if sid:
+                sids.add((sid, auth))
+
+        for s in Subscription.find_by_sids_and_class(self.env, sids, klass):
+            yield s.subscription_tuple()
+
+    def description(self):
+        return "Ticket that I'm listed in as %s is modified" % self.field_name
+
+    def default_subscriptions(self):
+        klass = self.__class__.__name__
+        return NotificationSystem(self.env).default_subscriptions(klass)
+
+    def requires_authentication(self):
+        return True
+}}}
+1. Users can manage this subscription in [/prefs/notification their preferences].