Merge branch 'moderated_private_email_lists' into 'master'

Added moderated email lists subscriptions/unsubscriptions notifications See merge request !82

Merge branch 'moderated_private_email_lists' into 'master'
Added moderated email lists subscriptions/unsubscriptions notifications See merge request !82
Lucas Kanashiro
2 parents 5a960e93 9acafb94
Showing 11 changed files with 123 additions and 58 deletions Show diff stats
colab/accounts/forms.py
colab/accounts/models.py
colab/accounts/templates/accounts/user_detail.html
colab/accounts/utils/mailman.py
colab/accounts/views.py
colab/home/views.py
colab/search/utils.py
colab/settings.py
colab/super_archives/fixtures/mailinglistdata.json
colab/super_archives/tests/test_privatelist.py
colab/super_archives/views.py
@@ -141,8 +141,9 @@ class UserUpdateForm(UserForm):
 class ListsForm(forms.Form):
     LISTS_NAMES = ((
-        listname, u'{} ({})'.format(listname, description)
-    ) for listname, description in mailman.all_lists(description=True))
+        mlist.get('listname'), u'{} ({})'.format(mlist.get('listname'),
+                                                 mlist.get('description'))
+    ) for mlist in mailman.all_lists())
     lists = forms.MultipleChoiceField(label=_(u'Mailing lists'),
                                       required=False,
@@ -60,7 +60,7 @@ class User(AbstractUser):
         return mailman.user_lists(self)
     def update_subscription(self, email, lists):
-        mailman.update_subscription(email, lists)
+        return mailman.update_subscription(email, lists)
     def save(self, *args, **kwargs):
@@ -84,7 +84,6 @@
           {% endif %}
         {% endif %}
       </ul>
-
       {% if user_.mailinglists %}
         <b>{% trans 'Groups: ' %}</b>
         {% for list in user_.mailinglists %}
@@ -4,66 +4,99 @@ import requests
 import logging
 from django.conf import settings
+from django.contrib import messages
 TIMEOUT = 1
 LOGGER = logging.getLogger('colab.mailman')
-
-def get_url(listname=None):
+S = 'success'
+I = 'info'
+E = 'error'
+
+MAILMAN_MSGS = {
+    0: (S, '%s: Success!'),
+    1: (S, '%s: An email confirmation was sent to you, please check your inbox.'),
+    2: (I, '%s: Your subscription was sent successfully! Please wait for the list\'s admin approval.'),
+    3: (I, '%s: You are already a member of this list.'),
+    4: (E, '%s: You are banned from this list!'),
+    5: (E, '%s: You appear to have an invalid email address.'),
+    6: (E, '%s: Your email address is considered to be hostile.'),
+    7: (E, '%s: You are not a member of this list.'),
+    8: (E, 'Missing information: `email_from`, `subject` and `body` are mandatory.'),
+}
+
+
+def get_url(path, listname=None):
+    url = urlparse.urljoin(settings.MAILMAN_API_URL, path)
     if listname:
-        return urlparse.urljoin(settings.MAILMAN_API_URL, '/' + listname)
-
-    return settings.MAILMAN_API_URL
+        return urlparse.urljoin(url, listname)
+    return url
 def subscribe(listname, address):
-    url = get_url(listname)
+    url = get_url('subscribe/', listname=listname)
     try:
-        requests.put(url, timeout=TIMEOUT, data={'address': address})
+        result = requests.put(url, timeout=TIMEOUT, data={'address': address})
+        msg_type, message = MAILMAN_MSGS[result.json()]
+        return msg_type, message % listname
     except:
         LOGGER.exception('Unable to subscribe user')
-        return False
-    return True
+        return E, 'Error: Unable to subscribe user'
 def unsubscribe(listname, address):
-    url = get_url(listname)
+    url = get_url('subscribe/', listname)
     try:
-        requests.delete(url, timeout=TIMEOUT, data={'address': address})
+        result = requests.delete(url, timeout=TIMEOUT, data={'address': address})
+        msg_type, message = MAILMAN_MSGS[result.json()]
+        return msg_type, message % listname
     except:
         LOGGER.exception('Unable to unsubscribe user')
-        return False
-    return True
+        return E, 'Error: Unable to subscribe user'
 def update_subscription(address, lists):
-    current_lists = mailing_lists(address=address)
+    current_lists = mailing_lists(address=address, names_only=True)
+    info_messages = []
     for maillist in current_lists:
         if maillist not in lists:
-            unsubscribe(maillist, address)
+            info_messages.append(unsubscribe(maillist, address))
     for maillist in lists:
         if maillist not in current_lists:
-            subscribe(maillist, address)
+            info_messages.append(subscribe(maillist, address))
+
+    return info_messages
 def mailing_lists(**kwargs):
-    url = get_url()
+    url = get_url('lists/')
     try:
-        lists = requests.get(url, timeout=TIMEOUT, params=kwargs)
+        lists = requests.get(url, timeout=TIMEOUT, params=kwargs).json()
+        if not isinstance(lists, (list, tuple)):
+            raise
     except:
         LOGGER.exception('Unable to list mailing lists')
         return []
-    return lists.json()
+    if kwargs.get('names_only'):
+        names_only = []
+        for l in lists:
+            names_only.append(l['listname'])
+        return names_only
+    else:
+        return lists
 def is_private_list(name):
     try:
-        return dict(all_lists(private=True))[name]
+        privacy = {}
+        privacy.update({mlist.get('listname'): mlist.get('archive_private')
+                        for mlist in all_lists()})
+        return privacy[name]
     except KeyError:
         return []
@@ -76,22 +109,25 @@ def user_lists(user):
     list_set = set()
     for email in user.emails.values_list('address', flat=True):
-        list_set.update(mailing_lists(address=email))
+        mlists = mailing_lists(address=email)
+        list_set.update(mlist.get('listname') for mlist in mlists)
     return tuple(list_set)
 def get_list_description(listname, lists=None):
     if not lists:
-        lists = dict(all_lists(description=True))
-    elif not isinstance(lists, dict):
-        lists = dict(lists)
+        lists = all_lists()
+
+    desc = "".join(mlist.get('description') for mlist in lists
+                   if isinstance(mlist, dict) and
+                   mlist.get('listname') == listname)
-    return lists.get(listname)
+    return desc
 def list_users(listname):
-    url = get_url(listname)
+    url = get_url('members/', listname)
     params = {}
@@ -114,3 +150,10 @@ def get_user_mailinglists(user):
         lists_for_user.extend(mailing_lists(address=email))
     return lists_for_user
+
+
+def extract_listname_from_list(lists):
+    try:
+        return [mlist.get('listname') for mlist in lists]
+    except ValueError:
+        return []
@@ -144,7 +144,11 @@ class ManageUserSubscriptionsView(UserProfileBaseMixin, DetailView):
         user = self.get_object()
         for email in user.emails.values_list('address', flat=True):
             lists = self.request.POST.getlist(email)
-            user.update_subscription(email, lists)
+            info_messages = user.update_subscription(email, lists)
+            for msg_type, message in info_messages:
+                show_message = getattr(messages, msg_type)
+                show_message(request, _(message))
+
         return redirect('user_profile', username=user.username)
@@ -154,18 +158,19 @@ class ManageUserSubscriptionsView(UserProfileBaseMixin, DetailView):
         user = self.get_object()
         emails = user.emails.values_list('address', flat=True)
-        all_lists = mailman.all_lists(description=True)
+        all_lists = mailman.all_lists()
         for email in emails:
             lists = []
-            lists_for_address = mailman.mailing_lists(address=email)
-            for listname, description in all_lists:
-                if listname in lists_for_address:
+            lists_for_address = mailman.mailing_lists(address=email, names_only=True)
+            for mlist in all_lists:
+                if mlist.get('listname') in lists_for_address:
                     checked = True
                 else:
                     checked = False
                 lists.append((
-                    {'listname': listname, 'description': description},
+                    {'listname': mlist.get('listname'),
+                      'description': mlist.get('description')},
                     checked
                 ))
@@ -10,9 +10,10 @@ from colab.accounts.models import User
 def get_user_threads(threads, lists_for_user, key):
     visible_threads = []
+    listnames_for_user = mailman.extract_listname_from_list(lists_for_user)
     for t in threads:
         if not t.mailinglist.is_private or \
-           t.mailinglist.name in lists_for_user:
+           t.mailinglist.name in listnames_for_user:
                 visible_threads.append(key(t))
     return visible_threads
@@ -15,11 +15,12 @@ from colab.accounts.utils import mailman
 def get_visible_threads_queryset(logged_user):
     queryset = Thread.objects
-    lists_for_user = []
+    listnames_for_user = []
     if logged_user:
         lists_for_user = mailman.get_user_mailinglists(logged_user)
+        listnames_for_user = mailman.extract_listname_from_list(lists_for_user)
-    user_lists = Condition(mailinglist__name__in=lists_for_user)
+    user_lists = Condition(mailinglist__name__in=listnames_for_user)
     public_lists = Condition(mailinglist__is_private=False)
     queryset = Thread.objects.filter(user_lists | public_lists)
@@ -28,6 +29,7 @@ def get_visible_threads_queryset(logged_user):
 def get_visible_threads(logged_user, filter_by_user=None):
     thread_qs = get_visible_threads_queryset(logged_user)
+
     if filter_by_user:
         message_qs = Message.objects.filter(thread__in=thread_qs)
         messages = message_qs.filter(
@@ -239,7 +239,7 @@ SUPER_ARCHIVES_EXCLUDE = []
 SUPER_ARCHIVES_LOCK_FILE = '/var/lock/colab/import_emails.lock'
 # Mailman API settings
-MAILMAN_API_URL = 'http://localhost:8124'
+MAILMAN_API_URL = 'http://localhost:8124/v2/'
 LOGIN_URL = '/user/login'
 LOGIN_REDIRECT_URL = '/'
@@ -6,23 +6,23 @@
       "twitter": null,
       "is_staff": false,
       "user_permissions": [
-        
+
       ],
       "date_joined": "2015-02-24T21:10:35.004Z",
       "google_talk": null,
-      "first_name": "Gust",
+      "first_name": "John",
       "is_superuser": false,
       "last_login": "2015-02-26T17:56:13.378Z",
       "verification_hash": null,
       "role": null,
-      "email": "gustmax@hotmail.com",
-      "username": "gustmax",
+      "email": "johndoe@example.com",
+      "username": "johndoe",
       "bio": null,
       "needs_update": false,
       "is_active": true,
       "facebook": null,
       "groups": [
-        
+
       ],
       "password": "pbkdf2_sha256$12000$ez83ccNOUQZk$vYT/QcYMukXZ7D7L1qQPyYlzCUEEEF20J7/Xjef0Rqg=",
       "institution": null,
@@ -37,7 +37,7 @@
       "real_name": "",
       "user": 1,
       "md5": "ed8f47ae6048f8d4456c0554578f53ff",
-      "address": "gustmax@hotmail.com"
+      "address": "johndoe@example.com"
     },
     "model": "super_archives.emailaddress",
     "pk": 1
@@ -2,7 +2,7 @@
 import mock
 from colab.accounts.utils import mailman
-from django.test import TestCase,  Client
+from django.test import TestCase, Client
 class ArchivesViewTest(TestCase):
@@ -13,11 +13,14 @@ class ArchivesViewTest(TestCase):
         self.client = Client()
     def authenticate_user(self):
-        self.client.login(username='gustmax', password='1234')
+        self.client.login(username='johndoe', password='1234')
     def test_see_only_private_list_if_member(self):
         mailman.get_user_mailinglists = mock.Mock(
+            return_value="[{'listname': 'privatelist'}]")
+        mailman.extract_listname_from_list = mock.Mock(
             return_value="['privatelist']")
+        mailman.list_users = mock.Mock(return_value="['johndoe@example.com']")
         self.authenticate_user()
         request = self.client.get('/archives/thread/')
@@ -26,7 +29,7 @@ class ArchivesViewTest(TestCase):
         self.assertEqual('lista', list_data[0][0])
         self.assertEqual('privatelist', list_data[1][0])
-        self.assertEqual(2,  len(list_data))
+        self.assertEqual(2, len(list_data))
     def test_see_only_public_if_not_logged_in(self):
         request = self.client.get('/archives/thread/')
@@ -34,10 +37,12 @@ class ArchivesViewTest(TestCase):
         list_data = request.context['lists']
         self.assertEqual('lista', list_data[0][0])
-        self.assertEqual(1,  len(list_data))
+        self.assertEqual(1, len(list_data))
     def test_see_private_thread_in_dashboard_if_member(self):
         mailman.get_user_mailinglists = mock.Mock(
+            return_value="[{'listname': 'privatelist'}]")
+        mailman.extract_listname_from_list = mock.Mock(
             return_value="['privatelist']")
         self.authenticate_user()
@@ -59,7 +64,7 @@ class ArchivesViewTest(TestCase):
         self.assertEqual(1, len(hottest_threads))
     def test_dont_see_private_threads_in_profile_if_logged_out(self):
-        request = self.client.get('/account/gustmax')
+        request = self.client.get('/account/johndoe')
         emails = request.context['emails']
@@ -33,17 +33,23 @@ class ThreadView(View):
         thread = get_object_or_404(Thread, subject_token=thread_token,
                                    mailinglist__name=mailinglist)
-        # TODO: Refactor this code
-        # Use local flag is_private instead of always check the API!!
-        all_privates = dict(mailman.all_lists(private=True))
-        if all_privates[thread.mailinglist.name]:
+        all_privates = []
+        all_privates.extend(
+            [mlist.get('listname')
+                for mlist in mailman.all_lists()
+                if mlist.get('archive_private')]
+        )
+
+        if all_privates.count(thread.mailinglist.name):
             if not request.user.is_authenticated():
                 raise PermissionDenied
             else:
                 user = User.objects.get(username=request.user)
                 emails = user.emails.values_list('address', flat=True)
                 lists_for_user = mailman.get_user_mailinglists(user)
-                if thread.mailinglist.name not in lists_for_user:
+                listnames_for_user = mailman.extract_listname_from_list(
+                    lists_for_user)
+                if thread.mailinglist.name not in listnames_for_user:
                     raise PermissionDenied
         thread.hit(request)
@@ -145,13 +151,16 @@ class ThreadDashboardView(View):
         context['lists'] = []
-        lists_for_user = []
+        listnames_for_user = []
         if request.user.is_authenticated():
             user = User.objects.get(username=request.user)
             lists_for_user = mailman.get_user_mailinglists(user)
+            listnames_for_user = mailman.extract_listname_from_list(
+                lists_for_user)
         for list_ in MailingList.objects.order_by('name'):
-            if list_.name not in all_privates or list_.name in lists_for_user:
+            if list_.name not in all_privates\
+                    or list_.name in listnames_for_user:
                 context['lists'].append((
                     list_.name,
                     mailman.get_list_description(list_.name),
	@@ -60,7 +60,7 @@ class User(AbstractUser):		@@ -60,7 +60,7 @@ class User(AbstractUser):
60	return mailman.user_lists(self)	60	return mailman.user_lists(self)
61		61
62	def update_subscription(self, email, lists):	62	def update_subscription(self, email, lists):
63	- mailman.update_subscription(email, lists)	63	+ return mailman.update_subscription(email, lists)
64		64
65	def save(self, args, *kwargs):	65	def save(self, args, *kwargs):
66		66
	@@ -239,7 +239,7 @@ SUPER_ARCHIVES_EXCLUDE = []		@@ -239,7 +239,7 @@ SUPER_ARCHIVES_EXCLUDE = []
239	SUPER_ARCHIVES_LOCK_FILE = '/var/lock/colab/import_emails.lock'	239	SUPER_ARCHIVES_LOCK_FILE = '/var/lock/colab/import_emails.lock'
240		240
241	# Mailman API settings	241	# Mailman API settings
242	-MAILMAN_API_URL = 'http://localhost:8124'	242	+MAILMAN_API_URL = 'http://localhost:8124/v2/'
243		243
244	LOGIN_URL = '/user/login'	244	LOGIN_URL = '/user/login'
245	LOGIN_REDIRECT_URL = '/'	245	LOGIN_REDIRECT_URL = '/'