Merge lp:~deryck/launchpad/unsubscribe-note-in-email into lp:launchpad

[Deryck Hodge]

Add a message to bug mail to offer an unsubscribe link for direct subscribers.

[Deryck Hodge (deryck)]

This is a branch to add an "to unsubscribe from this bug, go to URL"
link to bug mail. This only happens currently for direct subscribers of
bugs or duplicate bugs. So it's just a first step, but it will help in
the common case of individuals being subscribed unknowingly.

I've claimed the nearly ancient (in Internet years anyway) bug 48863 as
being the bug for this feature.

To test:

./bin/test -vv -t bugnotification-sending.txt

 reviewer intellectronica

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/lp/bugs/doc/bugnotification-sending.txt
  lib/canonical/launchpad/emailtemplates/bug-notification-verbose.txt
  lib/lp/bugs/scripts/bugnotification.py

[Eleanor Berger (intellectronica)]

as we discussed irl, this solution is awesome for solving an acute problem right now, but is quite hackish, so we're going to add an XXX referencing a bug for doing this in a more structured way, during the phase when we figure out the rationale for the email. also, the name of the unsubscribe_url variable is slightly misleading, since the value it holds isn't a URL. Hopefully this will make life easier for many frustrated users :)

review: Approve (code)

=== modified file 'lib/canonical/launchpad/emailtemplates/bug-notification-verbose.txt'
--- lib/canonical/launchpad/emailtemplates/bug-notification-verbose.txt	2008-01-15 00:51:07 +0000
+++ lib/canonical/launchpad/emailtemplates/bug-notification-verbose.txt	2009-11-17 17:35:22 +0000
@@ -9,3 +9,5 @@
 
 Bug description:
 %(bug_description)s
+
+%(unsubscribe_notice)s
 
=== modified file 'lib/lp/bugs/doc/bugnotification-sending.txt'
--- lib/lp/bugs/doc/bugnotification-sending.txt	2009-08-13 19:03:36 +0000
+++ lib/lp/bugs/doc/bugnotification-sending.txt	2009-11-17 17:35:22 +0000
@@ -1406,6 +1406,9 @@
     Bug description:
     desc
     <BLANKLINE>
+    To unsubscribe from this bug, go to:
+    http://bugs.launchpad.dev/product-name4/+bug/.../+subscribe
+    <BLANKLINE>
     ----------------------------------------------------------------------
 
 And Concise Team Person does too, even though his team doesn't want them: 
 
=== modified file 'lib/lp/bugs/scripts/bugnotification.py'
--- lib/lp/bugs/scripts/bugnotification.py	2009-07-23 14:52:33 +0000
+++ lib/lp/bugs/scripts/bugnotification.py	2009-11-17 17:35:22 +0000
@@ -118,10 +118,22 @@
         reason = recipient.reason_body
         rationale = recipient.reason_header
 
+        # XXX deryck 2009-11-17 Bug #484319
+        # This should be refactored to add a link inside the
+        # code where we build `reason`.  However, this will
+        # require some extra work, and this small change now
+        # will ease pain for a lot of unhappy users.
+        if 'direct subscriber' in reason and 'member of' not in reason:
+            unsubscribe_notice = ('To unsubscribe from this bug, go to:\n'
+                '%s/+subscribe' % canonical_url(bug.bugtasks[0]))
+        else:
+            unsubscribe_notice = ''
+
         body_data = {
             'content': mail_wrapper.format(content),
             'bug_title': bug.title,
             'bug_url': canonical_url(bug),
+            'unsubscribe_notice': unsubscribe_notice,
             'notification_rationale': mail_wrapper.format(reason)}
 
         # If the person we're sending to receives verbose notifications