From be3d347471e1fd269263e6dc72b2d0e702e06ef4 Mon Sep 17 00:00:00 2001
From: Timo Stollenwerk <timo@zmag.de>
Date: Sat, 13 Feb 2010 21:31:17 +0000
Subject: [PATCH] user email notification added.

svn path=/plone.app.discussion/branches/notification/; revision=33963
---
 plone/app/discussion/browser/controlpanel.py  |  4 +-
 plone/app/discussion/comment.py               | 27 +++--
 plone/app/discussion/interfaces.py            | 11 ++-
 plone/app/discussion/subscribers.zcml         | 12 +++
 .../app/discussion/tests/test_controlpanel.py |  8 +-
 .../discussion/tests/test_notifications.py    | 99 ++++++++++++++++++-
 6 files changed, 140 insertions(+), 21 deletions(-)

diff --git a/plone/app/discussion/browser/controlpanel.py b/plone/app/discussion/browser/controlpanel.py
index 7f1e01d..ec4bc20 100644
--- a/plone/app/discussion/browser/controlpanel.py
+++ b/plone/app/discussion/browser/controlpanel.py
@@ -30,7 +30,7 @@ class DiscussionSettingsEditForm(controlpanel.RegistryEditForm):
         self.fields['anonymous_comments'].widgetFactory = SingleCheckBoxFieldWidget
         self.fields['show_commenter_image'].widgetFactory = SingleCheckBoxFieldWidget
         self.fields['moderator_notification_enabled'].widgetFactory = SingleCheckBoxFieldWidget
-        self.fields['notification_enabled'].widgetFactory = SingleCheckBoxFieldWidget
+        self.fields['user_notification_enabled'].widgetFactory = SingleCheckBoxFieldWidget
 
     def updateWidgets(self):
         super(DiscussionSettingsEditForm, self).updateWidgets()
@@ -38,7 +38,7 @@ class DiscussionSettingsEditForm(controlpanel.RegistryEditForm):
         self.widgets['anonymous_comments'].label = _(u"Anonymous Comments")
         self.widgets['show_commenter_image'].label = _(u"Commenter Image")
         self.widgets['moderator_notification_enabled'].label = _(u"Moderator Email Notification")
-        self.widgets['notification_enabled'].label = _(u"Email Notification")
+        self.widgets['user_notification_enabled'].label = _(u"User Email Notification")
 
 
 class DiscussionSettingsControlPanel(controlpanel.ControlPanelFormWrapper):
diff --git a/plone/app/discussion/comment.py b/plone/app/discussion/comment.py
index 1f7ac35..311143e 100644
--- a/plone/app/discussion/comment.py
+++ b/plone/app/discussion/comment.py
@@ -140,24 +140,33 @@ def notify_content_object(obj, event):
 def notify_user(obj, event):
     """Tell the user when a comment is added
     """
-    conversation = aq_parent(obj)
-    content_object = aq_parent(conversation)
+
+    # check if notification is enabled
+    registry = queryUtility(IRegistry)
+    settings = registry.forInterface(IDiscussionSettings)
+    if not settings.user_notification_enabled:
+        return
+
     mail_host = getToolByName(obj, 'MailHost')
     portal_url = getToolByName(obj, 'portal_url')
-    
     portal = portal_url.getPortalObject()
     sender = portal.getProperty('email_from_address')
 
     if not sender:
         return
+
+    conversation = aq_parent(obj)
+    content_object = aq_parent(conversation)
     
     for comment in conversation.getComments():
-        if comment.author_notification and comment.author_email:
-            subject = "A comment has been posted."
-            message = "A comment with the title '%s' has been posted here: %s" \
-                      % (obj.title,
-                         content_object.absolute_url(),)
-            mail_host.send(message, comment.author_email, sender, subject)
+        if obj != comment and \
+           comment.author_notification and \
+           comment.author_email:
+                subject = "A comment has been posted."
+                message = "A comment with the title '%s' has been posted here: %s" \
+                          % (obj.title,
+                             content_object.absolute_url(),)
+                mail_host.send(message, comment.author_email, sender, subject)
             
 def notify_moderator(obj, index):
     """Tell the moderator when a comment needs attention
diff --git a/plone/app/discussion/interfaces.py b/plone/app/discussion/interfaces.py
index 9740270..00354bf 100644
--- a/plone/app/discussion/interfaces.py
+++ b/plone/app/discussion/interfaces.py
@@ -68,17 +68,18 @@ class IDiscussionSettings(Interface):
                                          required=False,
                                          default=False)
     
-    notification_enabled = schema.Bool(
-                               title=_(u"label_notification_enabled",
-                               default=u"Enable email notification"),
-                               description=_(u"help_notification_enabled",
+    user_notification_enabled = schema.Bool(
+                               title=_(u"label_user_notification_enabled",
+                               default=u"Enable user email notification"),
+                               description=_(u"help_user_notification_enabled",
                                              default=u"If selected, users can "
                                                       "choose to be notified "
                                                       "of new comments by "
                                                       "email."),
                                required=False,
                                default=False)
-    
+
+
 class IConversation(IIterableMapping):
     """A conversation about a content object.
 
diff --git a/plone/app/discussion/subscribers.zcml b/plone/app/discussion/subscribers.zcml
index 8b23638..8b50424 100644
--- a/plone/app/discussion/subscribers.zcml
+++ b/plone/app/discussion/subscribers.zcml
@@ -37,6 +37,12 @@
           handler=".tool.unindex_object"
           />
 
+      <subscriber
+          for="plone.app.discussion.interfaces.IComment
+               zope.lifecycleevent.interfaces.IObjectAddedEvent"
+          handler=".comment.notify_user"
+          />
+
       <subscriber
           for="plone.app.discussion.interfaces.IComment
                zope.lifecycleevent.interfaces.IObjectAddedEvent"
@@ -77,6 +83,12 @@
           handler=".tool.unindex_object"
           />
 
+      <subscriber
+          for="plone.app.discussion.interfaces.IComment
+               zope.app.container.interfaces.IObjectAddedEvent"
+          handler=".comment.notify_user"
+          />
+
       <subscriber
           for="plone.app.discussion.interfaces.IComment
                zope.app.container.interfaces.IObjectAddedEvent"
diff --git a/plone/app/discussion/tests/test_controlpanel.py b/plone/app/discussion/tests/test_controlpanel.py
index 31e2368..5ef24af 100644
--- a/plone/app/discussion/tests/test_controlpanel.py
+++ b/plone/app/discussion/tests/test_controlpanel.py
@@ -68,12 +68,12 @@ class RegistryTest(PloneTestCase):
         self.failUnless('moderator_notification_enabled' in IDiscussionSettings)
         self.assertEquals(self.registry['plone.app.discussion.interfaces.IDiscussionSettings.moderator_notification_enabled'], False)
 
-    def test_notification_enabled(self):
+    def test_user_notification_enabled(self):
         # Check show_commenter_image record
-        show_commenter_image = self.registry.records['plone.app.discussion.interfaces.IDiscussionSettings.notification_enabled']
+        show_commenter_image = self.registry.records['plone.app.discussion.interfaces.IDiscussionSettings.user_notification_enabled']
 
-        self.failUnless('notification_enabled' in IDiscussionSettings)
-        self.assertEquals(self.registry['plone.app.discussion.interfaces.IDiscussionSettings.notification_enabled'], False)
+        self.failUnless('user_notification_enabled' in IDiscussionSettings)
+        self.assertEquals(self.registry['plone.app.discussion.interfaces.IDiscussionSettings.user_notification_enabled'], False)
 
 def test_suite():
     return unittest.defaultTestLoader.loadTestsFromName(__name__)
\ No newline at end of file
diff --git a/plone/app/discussion/tests/test_notifications.py b/plone/app/discussion/tests/test_notifications.py
index 39b9601..281e3fe 100644
--- a/plone/app/discussion/tests/test_notifications.py
+++ b/plone/app/discussion/tests/test_notifications.py
@@ -22,6 +22,103 @@ from plone.app.discussion.interfaces import IDiscussionSettings
 from plone.app.discussion.tests.layer import DiscussionLayer
 
 
+class TestUserNotificationUnit(PloneTestCase):
+
+    layer = DiscussionLayer
+
+    def afterSetUp(self):
+        # Set up a mock mailhost
+        self.portal._original_MailHost = self.portal.MailHost
+        self.portal.MailHost = mailhost = MockMailHost('MailHost')
+        sm = getSiteManager(context=self.portal)
+        sm.unregisterUtility(provided=IMailHost)
+        sm.registerUtility(mailhost, provided=IMailHost)
+
+        # We need to fake a valid mail setup
+        self.portal.email_from_address = "portal@plone.test"
+        self.mailhost = self.portal.MailHost
+
+        # Enable user notification setting
+        registry = queryUtility(IRegistry)
+        settings = registry.forInterface(IDiscussionSettings)
+        registry['plone.app.discussion.interfaces.IDiscussionSettings.user_notification_enabled'] = True        
+
+        # Create test content
+        self.loginAsPortalOwner()
+        self.portal.invokeFactory('Document', 'doc1')
+        self.portal_discussion = self.portal.portal_discussion
+        self.conversation = IConversation(self.portal.doc1)
+
+    def beforeTearDown(self):
+        self.portal.MailHost = self.portal._original_MailHost
+        sm = getSiteManager(context=self.portal)
+        sm.unregisterUtility(provided=IMailHost)
+        sm.registerUtility(aq_base(self.portal._original_MailHost), provided=IMailHost)
+    
+    def test_notify_user(self):
+        # Add a comment with user notification enabled. Add another comment
+        # and make sure an email is send to the user of the first comment.
+        comment = createObject('plone.Comment')
+        comment.title = 'Comment 1'
+        comment.text = 'Comment text'
+        comment.author_notification = True
+        comment.author_email = "john@plone.test"
+        self.conversation.addComment(comment)
+
+        comment = createObject('plone.Comment')
+        comment.title = 'Comment 2'
+        comment.text = 'Comment text'
+        self.conversation.addComment(comment)
+        
+        self.assertEquals(len(self.mailhost.messages), 1)
+        self.failUnless(self.mailhost.messages[0])
+        msg = self.mailhost.messages[0]
+        self.failUnless('To: john@plone.test' in msg)
+        self.failUnless('From: portal@plone.test' in msg)           
+
+        #We expect the headers to be properly header encoded (7-bit):
+        #>>> 'Subject: =?utf-8?q?Some_t=C3=A4st_subject=2E?=' in msg
+        #True
+
+        #The output should be encoded in a reasonable manner (in this case quoted-printable):
+        #>>> msg
+        #'...Another t=C3=A4st message...You are receiving this mail because T=C3=A4st user\ntest@plone.test...is sending feedback about the site you administer at...
+
+    def test_do_not_notify_user_when_notification_is_disabled(self):
+        # Disable user notification and make sure no email is send to the user.
+        registry = queryUtility(IRegistry)
+        settings = registry.forInterface(IDiscussionSettings)
+        registry['plone.app.discussion.interfaces.IDiscussionSettings.user_notification_enabled'] = False        
+
+        comment = createObject('plone.Comment')
+        comment.title = 'Comment 1'
+        comment.text = 'Comment text'
+        comment.author_notification = True
+        comment.author_email = "john@plone.test"
+        self.conversation.addComment(comment)
+
+        comment = createObject('plone.Comment')
+        comment.title = 'Comment 2'
+        comment.text = 'Comment text'
+        self.conversation.addComment(comment)
+        
+        self.assertEquals(len(self.mailhost.messages), 0)
+            
+    def test_do_not_notify_user_when_email_address_is_given(self):
+        comment = createObject('plone.Comment')
+        comment.title = 'Comment 1'
+        comment.text = 'Comment text'
+        comment.author_notification = True
+        self.conversation.addComment(comment)
+
+        comment = createObject('plone.Comment')
+        comment.title = 'Comment 2'
+        comment.text = 'Comment text'
+        self.conversation.addComment(comment)
+        
+        self.assertEquals(len(self.mailhost.messages), 0)
+
+
 class TestModeratorNotificationUnit(PloneTestCase):
 
     layer = DiscussionLayer
@@ -49,6 +146,7 @@ class TestModeratorNotificationUnit(PloneTestCase):
         settings = registry.forInterface(IDiscussionSettings)
         registry['plone.app.discussion.interfaces.IDiscussionSettings.moderator_notification_enabled'] = True        
 
+        # Create test content
         self.loginAsPortalOwner()
         self.portal.invokeFactory('Document', 'doc1')
         self.portal_discussion = self.portal.portal_discussion
@@ -121,4 +219,3 @@ class TestModeratorNotificationUnit(PloneTestCase):
 
 def test_suite():
     return unittest.defaultTestLoader.loadTestsFromName(__name__)
-