Add email opt-out system

We're going to start generating emails on patchwork updates, so firstly
allow people to opt-out of all patchwork communications.

We do this with a 'mail settings' interface, allowing non-registered
users to set preferences on their email address. Logged-in users can do
this through the user profile view.

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>

3 files changed, 131 insertions, 3 deletions

diff --git a/apps/patchwork/views/base.py b/apps/patchwork/views/base.py
index 590a3b6..82c0368 100644
--- a/apps/patchwork/views/base.py
+++ b/apps/patchwork/views/base.py
@@ -59,10 +59,12 @@ def pwclient(request):
     return response
 
 def confirm(request, key):
-    import patchwork.views.user
+    import patchwork.views.user, patchwork.views.mail
     views = {
         'userperson': patchwork.views.user.link_confirm,
         'registration': patchwork.views.user.register_confirm,
+        'optout': patchwork.views.mail.optout_confirm,
+        'optin': patchwork.views.mail.optin_confirm,
     }
 
     conf = get_object_or_404(EmailConfirmation, key = key)
diff --git a/apps/patchwork/views/mail.py b/apps/patchwork/views/mail.py
new file mode 100644
index 0000000..aebba34
--- /dev/null
+++ b/apps/patchwork/views/mail.py
@@ -0,0 +1,119 @@
+# Patchwork - automated patch tracking system
+# Copyright (C) 2010 Jeremy Kerr <jk@ozlabs.org>
+#
+# This file is part of the Patchwork package.
+#
+# Patchwork is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# Patchwork is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Patchwork; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+from patchwork.requestcontext import PatchworkRequestContext
+from patchwork.models import EmailOptout, EmailConfirmation
+from patchwork.forms import OptinoutRequestForm, EmailForm
+from django.shortcuts import render_to_response
+from django.template.loader import render_to_string
+from django.conf import settings as conf_settings
+from django.core.mail import send_mail
+from django.core.urlresolvers import reverse
+from django.http import HttpResponseRedirect
+
+def settings(request):
+    context = PatchworkRequestContext(request)
+    if request.method == 'POST':
+        form = EmailForm(data = request.POST)
+        if form.is_valid():
+            email = form.cleaned_data['email']
+            is_optout = EmailOptout.objects.filter(email = email).count() > 0
+            context.update({
+                'email': email,
+                'is_optout': is_optout,
+            })
+            return render_to_response('patchwork/mail-settings.html', context)
+
+    else:
+        form = EmailForm()
+    context['form'] = form
+    return render_to_response('patchwork/mail-form.html', context)
+
+def optout_confirm(request, conf):
+    context = PatchworkRequestContext(request)
+
+    email = conf.email.strip().lower()
+    # silently ignore duplicated optouts
+    if EmailOptout.objects.filter(email = email).count() == 0:
+        optout = EmailOptout(email = email)
+        optout.save()
+
+    conf.deactivate()
+    context['email'] = conf.email
+
+    return render_to_response('patchwork/optout.html', context)
+
+def optin_confirm(request, conf):
+    context = PatchworkRequestContext(request)
+
+    email = conf.email.strip().lower()
+    EmailOptout.objects.filter(email = email).delete()
+
+    conf.deactivate()
+    context['email'] = conf.email
+
+    return render_to_response('patchwork/optin.html', context)
+
+def optinout(request, action, description):
+    context = PatchworkRequestContext(request)
+
+    mail_template = 'patchwork/%s-request.mail' % action
+    html_template = 'patchwork/%s-request.html' % action
+
+    if request.method != 'POST':
+        return HttpResponseRedirect(reverse(settings))
+
+    form = OptinoutRequestForm(data = request.POST)
+    if not form.is_valid():
+        context['error'] = ('There was an error in the %s form. ' +
+                           'Please review the form and re-submit.') % \
+                            description
+        context['form'] = form
+        return render_to_response(html_template, context)
+
+    email = form.cleaned_data['email']
+    if action == 'optin' and \
+            EmailOptout.objects.filter(email = email).count() == 0:
+        context['error'] = ('The email address %s is not on the ' +
+                            'patchwork opt-out list, so you don\'t ' +
+                            'need to opt back in') % email
+        context['form'] = form
+        return render_to_response(html_template, context)
+
+    conf = EmailConfirmation(type = action, email = email)
+    conf.save()
+    context['confirmation'] = conf
+    mail = render_to_string(mail_template, context)
+    try:
+        send_mail('Patchwork %s confirmation' % description, mail,
+                    conf_settings.DEFAULT_FROM_EMAIL, [email])
+        context['email'] = mail
+        context['email_sent'] = True
+    except Exception, ex:
+        context['error'] = 'An error occurred during confirmation . ' + \
+                           'Please try again later.'
+        context['admins'] = conf_settings.ADMINS
+
+    return render_to_response(html_template, context)
+
+def optout(request):
+    return optinout(request, 'optout', 'opt-out')
+
+def optin(request):
+    return optinout(request, 'optin', 'opt-in')
diff --git a/apps/patchwork/views/user.py b/apps/patchwork/views/user.py
index 3d28f4b..4a0e845 100644
--- a/apps/patchwork/views/user.py
+++ b/apps/patchwork/views/user.py
@@ -24,7 +24,8 @@ from django.shortcuts import render_to_response, get_object_or_404
 from django.contrib import auth
 from django.contrib.sites.models import Site
 from django.http import HttpResponseRedirect
-from patchwork.models import Project, Bundle, Person, EmailConfirmation, State
+from patchwork.models import Project, Bundle, Person, EmailConfirmation, \
+         State, EmailOptout
 from patchwork.forms import UserProfileForm, UserPersonLinkForm, \
          RegistrationForm
 from patchwork.filters import DelegateFilter
@@ -99,7 +100,13 @@ def profile(request):
     context['bundles'] = Bundle.objects.filter(owner = request.user)
     context['profileform'] = form
 
-    people = Person.objects.filter(user = request.user)
+    optout_query = '%s.%s IN (SELECT %s FROM %s)' % (
+                        Person._meta.db_table,
+                        Person._meta.get_field('email').column,
+                        EmailOptout._meta.get_field('email').column,
+                        EmailOptout._meta.db_table)
+    people = Person.objects.filter(user = request.user) \
+             .extra(select = {'is_optout': optout_query})
     context['linked_emails'] = people
     context['linkform'] = UserPersonLinkForm()