src/postorius/views/generic.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (C) 1998-2019 by the Free Software Foundation, Inc.
   3 #
   4 # This file is part of Postorius.
   5 #
   6 # Postorius is free software: you can redistribute it and/or modify it under
   7 # the terms of the GNU General Public License as published by the Free
   8 # Software Foundation, either version 3 of the License, or (at your option)
   9 # any later version.
  10 #
  11 # Postorius is distributed in the hope that it will be useful, but WITHOUT
  12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14 # more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Postorius.  If not, see <http://www.gnu.org/licenses/>.
  18
  19
  20 from urllib.error import HTTPError
  21
  22 from django.contrib import messages
  23 from django.http import HttpResponse
  24 from django.shortcuts import redirect, render
  25 from django.urls import reverse
  26 from django.utils.translation import gettext as _
  27 from django.views.generic import TemplateView
  28
  29 from django_mailman3.lib.mailman import get_mailman_client
  30 from django_mailman3.lib.paginator import paginate
  31
  32 from postorius.auth.utils import set_list_access_props
  33 from postorius.forms import AddBanForm
  34 from postorius.models import List
  35
  36
  37 class MailmanClientMixin(object):
  38
  39     """Adds a mailmanclient.Client instance."""
  40
  41     def client(self):
  42         if getattr(self, '_client', None) is None:
  43             self._client = get_mailman_client()
  44         return self._client
  45
  46
  47 class MailingListView(TemplateView, MailmanClientMixin):
  48
  49     """A generic view for everything based on a mailman.client
  50     list object.
  51
  52     Sets self.mailing_list to list object if list_id is in **kwargs.
  53     """
  54     def get(self, request, *args, **kwargs):
  55         # This should be overridden by the subclass.
  56         return HttpResponse(status=405)
  57
  58     def post(self, request, *args, **kwargs):
  59         # This should be overridden by the subclass.
  60         return HttpResponse(status=405)
  61
  62     def _get_list(self, list_id, page):
  63         return List.objects.get_or_404(fqdn_listname=list_id)
  64
  65     def dispatch(self, request, *args, **kwargs):
  66         # get the list object.
  67         if 'list_id' in kwargs:
  68             self.mailing_list = self._get_list(kwargs['list_id'],
  69                                                int(kwargs.get('page', 1)))
  70             set_list_access_props(request.user, self.mailing_list)
  71         # set the template
  72         if 'template' in kwargs:
  73             self.template = kwargs['template']
  74         return super(MailingListView, self).dispatch(request, *args, **kwargs)
  75
  76
  77 def bans_view(request, template, list_id=None):
  78     """Ban or unban email addresses.
  79
  80     This is a reusable view which works for both global and list specific bans.
  81     Whether a MailingList ban is updated or a Global one depends on list_id
  82     being passed in.
  83
  84     :list_id: MailingList Id if this is a List ban, None otherwise.
  85
  86     """
  87     if list_id:
  88         m_list = List.objects.get_or_404(fqdn_listname=list_id)
  89         url = reverse('list_bans', args=[list_id])
  90         ban_list = m_list.bans
  91     else:
  92         ban_list = get_mailman_client().bans
  93         url = reverse('global_bans')
  94         m_list = None
  95
  96     # Process form submission.
  97     if request.method == 'POST':
  98         if 'add' in request.POST:
  99             addban_form = AddBanForm(request.POST)
 100             if addban_form.is_valid():
 101                 try:
 102                     ban_list.add(addban_form.cleaned_data['email'])
 103                     messages.success(request, _(
 104                         'The email {} has been banned.'.format(
 105                             addban_form.cleaned_data['email'])))
 106                 except HTTPError as e:
 107                     messages.error(
 108                         request, _('An error occurred: %s') % e.reason)
 109                 except ValueError as e:
 110                     messages.error(request, _('Invalid data: %s') % e)
 111                 return redirect(url)
 112         elif 'del' in request.POST:
 113             try:
 114                 ban_list.remove(request.POST['email'])
 115                 messages.success(request, _(
 116                     'The email {} has been un-banned'.format(
 117                         request.POST['email'])))
 118             except HTTPError as e:
 119                 messages.error(request, _('An error occurred: %s') % e.reason)
 120             except ValueError as e:
 121                 messages.error(request, _('Invalid data: %s') % e)
 122             return redirect(url)
 123     else:
 124         addban_form = AddBanForm(initial=request.GET)
 125     banned_addresses = paginate(
 126         list(ban_list), request.GET.get('page'), request.GET.get('count'))
 127
 128     context = {
 129         'addban_form': addban_form,
 130         'banned_addresses': banned_addresses,
 131     }
 132
 133     if list_id:
 134         context['list'] = m_list
 135
 136     return render(request, template, context)