diff --git a/mailing_lists/forms.py b/mailing_lists/forms.py
index b8b73d6efffc49c37895448538631fac0282a3c8..b5fed11fb236bad305fcafd7e966675f202582cd 100644
--- a/mailing_lists/forms.py
+++ b/mailing_lists/forms.py
@@ -6,8 +6,6 @@ from mailchimp3 import MailChimp
from .constants import MAIL_LIST_STATUS_ACTIVE, MAIL_LIST_STATUS_DEACTIVATED
from .models import MailchimpList
-from scipost.models import Contributor
-
class MailchimpUpdateForm(forms.Form):
"""
@@ -37,5 +35,4 @@ class MailchimpUpdateForm(forms.Form):
return count
def sync_members(self, _list):
- contributors = Contributor.objects.active().filter(accepts_SciPost_emails=True)
- return _list.update_membership(contributors)
+ return _list.update_members()
diff --git a/mailing_lists/migrations/0005_mailchimplist_subscriber_count.py b/mailing_lists/migrations/0005_mailchimplist_subscriber_count.py
new file mode 100644
index 0000000000000000000000000000000000000000..eba275dced47db292b60ef89881325ff0b913194
--- /dev/null
+++ b/mailing_lists/migrations/0005_mailchimplist_subscriber_count.py
@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.10.3 on 2017-06-07 21:24
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('mailing_lists', '0004_auto_20170423_2238'),
+ ]
+
+ operations = [
+ migrations.AddField(
+ model_name='mailchimplist',
+ name='subscriber_count',
+ field=models.PositiveIntegerField(default=0),
+ ),
+ ]
diff --git a/mailing_lists/models.py b/mailing_lists/models.py
index 262f50eb40ad059683aa59cd92928ad292bad0d2..e9e3660f3b207f9989286f540aa3f5c6de96f680 100644
--- a/mailing_lists/models.py
+++ b/mailing_lists/models.py
@@ -1,4 +1,5 @@
-from django.db import models
+from django.db import models, transaction
+from django.contrib.auth.models import User
from django.conf import settings
from django.contrib.auth.models import Group
from django.urls import reverse
@@ -10,6 +11,8 @@ from .constants import MAIL_LIST_STATUSES, MAIL_LIST_STATUS_ACTIVE,\
from .managers import MailListManager
from scipost.behaviors import TimeStampedModel
+from scipost.constants import CONTRIBUTOR_NORMAL
+from scipost.models import Contributor
class MailchimpList(TimeStampedModel):
@@ -24,6 +27,7 @@ class MailchimpList(TimeStampedModel):
mailchimp_list_id = models.CharField(max_length=255, unique=True)
status = models.CharField(max_length=255, choices=MAIL_LIST_STATUSES,
default=MAIL_LIST_STATUS_ACTIVE)
+ subscriber_count = models.PositiveIntegerField(default=0)
open_for_subscription = models.BooleanField(default=False)
allowed_groups = models.ManyToManyField(Group, related_name='allowed_mailchimp_lists')
@@ -40,23 +44,79 @@ class MailchimpList(TimeStampedModel):
def get_absolute_url(self):
return reverse('mailing_lists:list_detail', args=[self.mailchimp_list_id])
- def update_membership(self, contributors, status='subscribed'):
+ @transaction.atomic
+ def update_members(self, status='subscribed'):
+ """
+ Update the subscribers in the MailChimp account.
+ """
+ # Extreme timeset value (1 minute) to allow for huge maillist subscribes
client = MailChimp(settings.MAILCHIMP_API_USER, settings.MAILCHIMP_API_KEY)
- for contributor in contributors:
- if self.allowed_groups.filter(user__contributor=contributor).exists():
- payload = {
- 'email_address': contributor.user.email,
+ try:
+ unsubscribe_emails = []
+ # Find all campaigns on the account
+ campaigns = client.campaigns.all(get_all=True)
+ for campaign in campaigns['campaigns']:
+
+ # All unsubscriptions are registered per campaign
+ # Should be improved later on
+ unsubscribers = client.reports.unsubscribes.all(campaign['id'], True)
+ for unsubscriber in unsubscribers['unsubscribes']:
+ if unsubscriber['list_id'] == self.mailchimp_list_id:
+ unsubscribe_emails.append(unsubscriber['email_address'])
+ except KeyError:
+ # Call with MailChimp went wrong, returned invalid data
+ return None
+
+ # Unsubscribe *all* Contributors in the database if asked for
+ updated_contributors = (Contributor.objects
+ .filter(accepts_SciPost_emails=True,
+ user__email__in=unsubscribe_emails)
+ .update(accepts_SciPost_emails=False))
+
+ # Check the current list of subscribers in MailChimp account
+ subscribers_list = client.lists.members.all(self.mailchimp_list_id, True,
+ fields="members.email_address")
+ subscribers_list = [sub['email_address'] for sub in subscribers_list['members']]
+
+ # Retrieve *users* that are in the right group and didn't unsubscribe and
+ # are not in the list yet.
+ db_subscribers = (User.objects
+ .filter(contributor__isnull=False)
+ .filter(is_active=True, contributor__status=CONTRIBUTOR_NORMAL)
+ .filter(contributor__accepts_SciPost_emails=True,
+ groups__in=self.allowed_groups.all(),
+ email__isnull=False,
+ first_name__isnull=False,
+ last_name__isnull=False)
+ .exclude(email__in=subscribers_list))
+
+ # Build batch data
+ batch_data = {'operations': []}
+ add_member_path = 'lists/%s/members' % self.mailchimp_list_id
+ for user in db_subscribers:
+ batch_data['operations'].append({
+ 'method': 'POST',
+ 'path': add_member_path,
+ 'data': {
'status': status,
'status_if_new': status,
+ 'email_address': user.email,
'merge_fields': {
- 'FNAME': contributor.user.first_name,
- 'LNAME': contributor.user.last_name,
+ 'FNAME': user.first_name,
+ 'LNAME': user.last_name,
},
}
- client.lists.members.create_or_update(self.mailchimp_list_id,
- payload['email_address'],
- payload)
- return True
+ })
+ # Make the subscribe call
+ client.batches.create(data=batch_data)
+
+ # No need to update Contributor field *yet*. MailChimp account is leading here.
+ # Contributor.objects.filter(user__in=db_subscribers).update(accepts_SciPost_emails=True)
+
+ list_data = client.lists.get(list_id=self.mailchimp_list_id)
+ self.subscriber_count = list_data['stats']['member_count']
+ self.save()
+ return (updated_contributors, len(db_subscribers),)
class MailchimpSubscription(TimeStampedModel):
diff --git a/mailing_lists/templates/mailing_lists/mailchimplist_form.html b/mailing_lists/templates/mailing_lists/mailchimplist_form.html
index 88fd7fface6bf3186f8ff11edb3cb6d56d0f28a6..37347dc82164961bf6bdd427468983105174fda8 100644
--- a/mailing_lists/templates/mailing_lists/mailchimplist_form.html
+++ b/mailing_lists/templates/mailing_lists/mailchimplist_form.html
@@ -17,7 +17,7 @@
<div class="col-12">
<h1>Edit the mailing list <i>{{object}}</i></h1>
<h3>Mailchimp configuration:</h3>
- <pre><code>ID: {{object.mailchimp_list_id}}<br>name: {{object.name}}<br>Status: {{object.get_status_display}}</code></pre>
+ <pre><code>ID: {{object.mailchimp_list_id}}<br>Name: {{object.name}}<br>Status: {{object.get_status_display}}<br>Member count: {{object.subscriber_count}}</code></pre>
<h3 class="mt-2">Actions:</h3>
<ul class="actions">
<li><a href="{% url 'mailing_lists:sync_members' object.mailchimp_list_id %}">Syncronize members of the list</a></li>
diff --git a/mailing_lists/views.py b/mailing_lists/views.py
index 85396f413f8f982cd0683d587c1e1abc92929f05..a6952dc61e4661080127d4d588d091d3f0809ff3 100644
--- a/mailing_lists/views.py
+++ b/mailing_lists/views.py
@@ -48,8 +48,15 @@ def syncronize_members(request, list_id):
"""
_list = get_object_or_404(MailchimpList, mailchimp_list_id=list_id)
form = MailchimpUpdateForm()
- updated = form.sync_members(_list)
- messages.success(request, '%i members have succesfully been updated.' % updated)
+ unsubscribed, subscribed = form.sync_members(_list)
+
+ # Let the user know
+ text = '<h3>Syncronize members complete.</h3>'
+ if unsubscribed:
+ text += '<br>%i members have succesfully been unsubscribed.' % unsubscribed
+ if subscribed:
+ text += '<br>%i members have succesfully been subscribed.' % subscribed
+ messages.success(request, text)
return redirect(_list.get_absolute_url())