Merge branch 'feature/mailaccount_setup'

* feature/mailaccount_setup:
  implement password change for mailboxes
  enable mailbox creation
  implement create_mailbox functionality
  add changelog entry for refactoring
  refactor osusers password forms
  implement new module gvawebcore to provide common code
This commit is contained in:
Jan Dittberner 2015-01-25 12:54:25 +01:00
commit 353ea7ad90
19 changed files with 489 additions and 37 deletions

View file

@ -1,6 +1,9 @@
Changelog Changelog
========= =========
* :feature:`-` implement password change functionality for mailboxes
* :feature:`-` implement creation of new mailboxes for hosting packages
* :support:`-` move common form code to new module gvawebcore.forms
* :feature:`-` make it possible to assign domains to a customer * :feature:`-` make it possible to assign domains to a customer
* :feature:`-` add hosting packages list for staff users * :feature:`-` add hosting packages list for staff users
* :feature:`-` allow creation of new hosting packages for staff users without * :feature:`-` allow creation of new hosting packages for staff users without

View file

@ -15,6 +15,7 @@ Common code
.. toctree:: .. toctree::
code/gvacommon code/gvacommon
code/gvawebcore
Celery task stubs Celery task stubs

11
docs/code/gvawebcore.rst Normal file
View file

@ -0,0 +1,11 @@
:py:mod:`gvawebcore`
====================
.. automodule:: gvawebcore
:py:mod:`forms <gvawebcore.forms>`
----------------------------------
.. automodule:: gvawebcore.forms
:members:

View file

@ -12,14 +12,35 @@
:py:mod:`apps <managemails.apps>` :py:mod:`apps <managemails.apps>`
----------------------------------- ---------------------------------
.. automodule:: managemails.apps .. automodule:: managemails.apps
:members: :members:
:py:mod:`forms <managemails.forms>`
-----------------------------------
.. automodule:: managemails.forms
:members:
:py:mod:`models <managemails.models>` :py:mod:`models <managemails.models>`
------------------------------------- -------------------------------------
.. automodule:: managemails.models .. automodule:: managemails.models
:members: :members:
:py:mod:`urls <managemails.urls>`
---------------------------------
.. automodule:: managemails.urls
:members:
:py:mod:`views <managemails.views>`
-----------------------------------
.. automodule:: managemails.views
:members:

View file

@ -12,6 +12,7 @@ urlpatterns = patterns(
url(r'^accounts/', include('allauth.urls')), url(r'^accounts/', include('allauth.urls')),
url(r'^domains/', include('domains.urls')), url(r'^domains/', include('domains.urls')),
url(r'^hosting/', include('hostingpackages.urls')), url(r'^hosting/', include('hostingpackages.urls')),
url(r'^mail/', include('managemails.urls')),
url(r'^osuser/', include('osusers.urls')), url(r'^osuser/', include('osusers.urls')),
url(r'^admin/', include(admin.site.urls)), url(r'^admin/', include(admin.site.urls)),
) )

View file

@ -0,0 +1,5 @@
"""
This is a collection of modules that can be used by multiple gnuviechadmin
apps.
"""

View file

@ -0,0 +1,43 @@
"""
This module defines form classes that can be extended by other gnuviechadmin
apps' forms.
"""
from __future__ import absolute_import, unicode_literals
from django import forms
from django.utils.translation import ugettext_lazy as _
PASSWORD_MISMATCH_ERROR = _("Passwords don't match")
"""
Error message for non matching passwords.
"""
class PasswordModelFormMixin(forms.Form):
"""
A form for entering a password in two password fields. The form checks
whether both fields contain the same string.
"""
password1 = forms.CharField(
label=_('Password'), widget=forms.PasswordInput,
)
password2 = forms.CharField(
label=_('Password (again)'), widget=forms.PasswordInput,
)
def clean_password2(self):
"""
Check that the two password entries match.
:return: the validated password
:rtype: str or None
"""
password1 = self.cleaned_data.get('password1')
password2 = self.cleaned_data.get('password2')
if password1 and password2 and password1 != password2:
raise forms.ValidationError(PASSWORD_MISMATCH_ERROR)
return password2

View file

@ -0,0 +1,32 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: gvawebcore\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2015-01-25 11:49+0100\n"
"PO-Revision-Date: 2015-01-25 11:49+0100\n"
"Last-Translator: Jan Dittberner <jan@dittberner.info>\n"
"Language-Team: Jan Dittberner <jan@dittberner.info>\n"
"Language: de\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
"X-Generator: Poedit 1.6.10\n"
"X-Poedit-SourceCharset: UTF-8\n"
#: forms.py:12
msgid "Passwords don't match"
msgstr "Passwörter stimmen nicht überein"
#: forms.py:25
msgid "Password"
msgstr "Passwort: "
#: forms.py:28
msgid "Password (again)"
msgstr "Passwortwiederholung"

View file

@ -7,8 +7,8 @@ msgid ""
msgstr "" msgstr ""
"Project-Id-Version: gnuviechadmin\n" "Project-Id-Version: gnuviechadmin\n"
"Report-Msgid-Bugs-To: \n" "Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2015-01-25 00:46+0100\n" "POT-Creation-Date: 2015-01-25 12:46+0100\n"
"PO-Revision-Date: 2015-01-25 00:55+0100\n" "PO-Revision-Date: 2015-01-25 12:49+0100\n"
"Last-Translator: Jan Dittberner <jan@dittberner.info>\n" "Last-Translator: Jan Dittberner <jan@dittberner.info>\n"
"Language-Team: Jan Dittberner <jan@dittberner.info>\n" "Language-Team: Jan Dittberner <jan@dittberner.info>\n"
"Language: de\n" "Language: de\n"
@ -793,6 +793,47 @@ msgstr "Diesem Hostingpaket sind noch keine Datenbanken zugeordnet."
msgid "Add database" msgid "Add database"
msgstr "Datenbank hinzufügen" msgstr "Datenbank hinzufügen"
#: templates/managemails/mailbox_create.html:6
#: templates/managemails/mailbox_create.html:15
#, python-format
msgid "Add Mailbox to Hosting Package %(package)s"
msgstr "Postfach zum Hostingpaket %(package)s hinzufügen"
#: templates/managemails/mailbox_create.html:8
#: templates/managemails/mailbox_create.html:17
#, python-format
msgid "Add Mailbox to Hosting Package %(package)s of Customer %(full_name)s"
msgstr ""
"Postfach zum Hostingpaket %(package)s des Kunden %(full_name)s hinzufügen"
#: templates/managemails/mailbox_create.html:23
msgid "Please specify the password for your new mailbox."
msgstr "Bitte geben Sie das Passwort für Ihr neues Postfach ein."
#: templates/managemails/mailbox_create.html:23
msgid "Please specify the password for the new mailbox."
msgstr "Bitte geben Sie das Passwort für das neue Postfach ein."
#: templates/managemails/mailbox_setpassword.html:6
#: templates/managemails/mailbox_setpassword.html:15
#, python-format
msgid "Set Password for Mailbox %(mailbox)s"
msgstr "Passwort für Postfach %(mailbox)s setzen"
#: templates/managemails/mailbox_setpassword.html:8
#: templates/managemails/mailbox_setpassword.html:17
#, python-format
msgid "Set Password for Mailbox %(mailbox)s of Customer %(full_name)s"
msgstr "Passwort für Postfach %(mailbox)s des Kunden %(full_name)s setzen"
#: templates/managemails/mailbox_setpassword.html:23
msgid "Please specify the new password for your mailbox."
msgstr "Bitte geben Sie das neue Passwort für Ihr Postfach ein."
#: templates/managemails/mailbox_setpassword.html:23
msgid "Please specify the new password for the mailbox."
msgstr "Bitte geben Sie das neue Passwort für das Postfach ein."
#: templates/osusers/user_setpassword.html:5 #: templates/osusers/user_setpassword.html:5
#: templates/osusers/user_setpassword.html:13 #: templates/osusers/user_setpassword.html:13
#, python-format #, python-format
@ -897,5 +938,10 @@ msgstr ""
"%(site_name)s zu nutzen. Als letzten Schritt füllen Sie bitte folgendes " "%(site_name)s zu nutzen. Als letzten Schritt füllen Sie bitte folgendes "
"Formular aus:" "Formular aus:"
#, fuzzy
#~| msgid "Password Reset"
#~ msgid "Password (again)"
#~ msgstr "Passwort zurücksetzen"
#~ msgid "My Profile" #~ msgid "My Profile"
#~ msgstr "Mein Profil" #~ msgstr "Mein Profil"

View file

@ -0,0 +1,81 @@
"""
This module defines form classes for mailbox and mail address editing.
"""
from __future__ import absolute_import, unicode_literals
from django import forms
from django.core.urlresolvers import reverse
from django.utils.translation import ugettext as _
from crispy_forms.helper import FormHelper
from crispy_forms.layout import Submit
from .models import Mailbox
from gvawebcore.forms import PasswordModelFormMixin
class CreateMailboxForm(PasswordModelFormMixin, forms.ModelForm):
"""
This form is used to create new Mailbox instances.
"""
class Meta:
model = Mailbox
fields = []
def __init__(self, *args, **kwargs):
self.hosting_package = kwargs.pop('hostingpackage')
super(CreateMailboxForm, self).__init__(*args, **kwargs)
self.helper = FormHelper()
self.helper.form_action = reverse(
'create_mailbox', kwargs={'package': self.hosting_package.id})
self.helper.add_input(Submit('submit', _('Create mailbox')))
def save(self, commit=True):
"""
Set the new mailbox's password and osuser.
:param boolean commit: whether to save the created mailbox
:return: mailbox instance
:rtype: :py:class:`managemails.models.Mailbox`
"""
osuser = self.hosting_package.osuser
self.instance.osuser = osuser
self.instance.username = Mailbox.objects.get_next_mailbox_name(osuser)
self.instance.set_password(self.cleaned_data['password1'])
return super(CreateMailboxForm, self).save(commit=commit)
class ChangeMailboxPasswordForm(PasswordModelFormMixin, forms.ModelForm):
"""
This form is used to set a new password for an existing mailbox.
"""
class Meta:
model = Mailbox
fields = []
def __init__(self, *args, **kwargs):
self.hosting_package = kwargs.pop('hostingpackage')
super(ChangeMailboxPasswordForm, self).__init__(*args, **kwargs)
self.helper = FormHelper()
self.helper.form_action = reverse(
'change_mailbox_password', kwargs={
'package': self.hosting_package.id,
'slug': self.instance.username,
})
self.helper.add_input(Submit('submit', _('Set password')))
def save(self, commit=True):
"""
Set the mailbox password.
:param boolean commit: whether to save the mailbox instance
:return: mailbox instance
:rtype: :py:class:`managemails.models.Mailbox`
"""
self.instance.set_password(self.cleaned_data['password1'])
return super(ChangeMailboxPasswordForm, self).save(commit=commit)

View file

@ -7,8 +7,8 @@ msgid ""
msgstr "" msgstr ""
"Project-Id-Version: managemails\n" "Project-Id-Version: managemails\n"
"Report-Msgid-Bugs-To: \n" "Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2015-01-25 00:46+0100\n" "POT-Creation-Date: 2015-01-25 12:46+0100\n"
"PO-Revision-Date: 2015-01-25 00:48+0100\n" "PO-Revision-Date: 2015-01-25 12:47+0100\n"
"Last-Translator: Jan Dittberner <jan@dittberner.info>\n" "Last-Translator: Jan Dittberner <jan@dittberner.info>\n"
"Language-Team: Jan Dittberner <jan@dittberner.info>\n" "Language-Team: Jan Dittberner <jan@dittberner.info>\n"
"Language: de\n" "Language: de\n"
@ -47,6 +47,14 @@ msgstr "Deaktivieren"
msgid "Mailboxes and Mail Addresses" msgid "Mailboxes and Mail Addresses"
msgstr "Postfächer und E-Mailadressen" msgstr "Postfächer und E-Mailadressen"
#: managemails/forms.py:33
msgid "Create mailbox"
msgstr "Postfach anlegen"
#: managemails/forms.py:69
msgid "Set password"
msgstr "Passwort setzen"
#: managemails/models.py:79 #: managemails/models.py:79
msgid "Mailbox" msgid "Mailbox"
msgstr "Postfach" msgstr "Postfach"
@ -70,3 +78,18 @@ msgstr "E-Mailadresse"
#: managemails/models.py:142 #: managemails/models.py:142
msgid "mailbox" msgid "mailbox"
msgstr "Postfach" msgstr "Postfach"
#: managemails/views.py:63
msgid "You are not allowed to add more mailboxes to this hosting package"
msgstr "Sie können keine weiteren Postfächer zu diesem Hostingpaket hinzufügen"
#: managemails/views.py:82
#, python-brace-format
msgid "Mailbox {mailbox} created successfully."
msgstr "Postfach {mailbox} erfolgreich angelegt."
#: managemails/views.py:117
#, python-brace-format
msgid "Successfully set new password for mailbox {mailbox}."
msgstr ""
"Für das Postfach {mailbox} wurde erfolgreich ein neues Passwort gesetzt."

View file

@ -0,0 +1,21 @@
"""
This module defines the URL patterns for mailbox and mail address related
views.
"""
from __future__ import absolute_import, unicode_literals
from django.conf.urls import patterns, url
from .views import (
ChangeMailboxPassword,
CreateMailbox,
)
urlpatterns = patterns(
'',
url(r'^(?P<package>\d+)/mailbox/create$',
CreateMailbox.as_view(), name='create_mailbox'),
url(r'^(?P<package>\d+)/mailbox/(?P<slug>[\w0-9]+)/setpassword$',
ChangeMailboxPassword.as_view(), name='change_mailbox_password'),
)

View file

@ -0,0 +1,121 @@
"""
This module defines views for mailbox and mail address handling.
"""
from __future__ import absolute_import, unicode_literals
from django.http import HttpResponseForbidden
from django.shortcuts import get_object_or_404, redirect
from django.utils.translation import ugettext as _
from django.views.generic.edit import (
CreateView,
UpdateView,
)
from django.contrib import messages
from gvacommon.viewmixins import StaffOrSelfLoginRequiredMixin
from hostingpackages.models import CustomerHostingPackage
from .forms import (
CreateMailboxForm,
ChangeMailboxPasswordForm,
)
from .models import Mailbox
class HostingPackageAndCustomerMixin(object):
"""
Mixin for views that gets the hosting package instance from the URL
keyword argument 'package'.
"""
hosting_package_kwarg = 'package'
"""Keyword argument used to find the hosting package in the URL."""
def get_hosting_package(self):
return get_object_or_404(
CustomerHostingPackage,
pk=int(self.kwargs[self.hosting_package_kwarg]))
def get_customer_object(self):
return self.get_hosting_package().customer
class CreateMailbox(
HostingPackageAndCustomerMixin, StaffOrSelfLoginRequiredMixin, CreateView
):
"""
This view is used to setup new mailboxes for a customer hosting package.
"""
model = Mailbox
context_object_name = 'mailbox'
template_name_suffix = '_create'
form_class = CreateMailboxForm
def dispatch(self, request, *args, **kwargs):
resp = super(CreateMailbox, self).dispatch(request, *args, **kwargs)
if not self.get_hosting_package().may_add_mailbox():
resp = HttpResponseForbidden(
_('You are not allowed to add more mailboxes to this'
' hosting package'))
return resp
def get_context_data(self, **kwargs):
context = super(CreateMailbox, self).get_context_data(**kwargs)
context['hostingpackage'] = self.get_hosting_package()
context['customer'] = self.get_customer_object()
return context
def get_form_kwargs(self):
kwargs = super(CreateMailbox, self).get_form_kwargs()
kwargs['hostingpackage'] = self.get_hosting_package()
return kwargs
def form_valid(self, form):
mailbox = form.save()
messages.success(
self.request,
_('Mailbox {mailbox} created successfully.').format(
mailbox=mailbox.username
)
)
return redirect(self.get_hosting_package())
class ChangeMailboxPassword(
HostingPackageAndCustomerMixin, StaffOrSelfLoginRequiredMixin, UpdateView
):
"""
This view is used to set a new password for an existing mailbox.
"""
context_object_name = 'mailbox'
form_class = ChangeMailboxPasswordForm
model = Mailbox
slug_field = 'username'
template_name_suffix = '_setpassword'
def get_context_data(self, **kwargs):
context = super(ChangeMailboxPassword, self).get_context_data(**kwargs)
context['hostingpackage'] = self.get_hosting_package()
context['customer'] = self.get_customer_object()
return context
def get_form_kwargs(self):
kwargs = super(ChangeMailboxPassword, self).get_form_kwargs()
kwargs['hostingpackage'] = self.get_hosting_package()
return kwargs
def form_valid(self, form):
mailbox = form.save()
messages.success(
self.request,
_('Successfully set new password for mailbox {mailbox}.').format(
mailbox=mailbox.username
)
)
return redirect(self.get_hosting_package())

View file

@ -6,7 +6,7 @@ from django import forms
from django.utils.translation import ugettext as _ from django.utils.translation import ugettext as _
from django.contrib import admin from django.contrib import admin
from .forms import ( from gvawebcore.forms import (
PASSWORD_MISMATCH_ERROR PASSWORD_MISMATCH_ERROR
) )
from .models import ( from .models import (

View file

@ -11,28 +11,16 @@ from django.utils.translation import ugettext_lazy as _
from crispy_forms.helper import FormHelper from crispy_forms.helper import FormHelper
from crispy_forms.layout import Submit from crispy_forms.layout import Submit
from gvawebcore.forms import PasswordModelFormMixin
from .models import User from .models import User
PASSWORD_MISMATCH_ERROR = _("Passwords don't match")
"""
Error message for non matching passwords.
"""
class ChangeOsUserPasswordForm(PasswordModelFormMixin, forms.ModelForm):
class ChangeOsUserPasswordForm(forms.ModelForm):
""" """
A form for setting an OS user's password. A form for setting an OS user's password.
""" """
password1 = forms.CharField(
label=_('Password'), widget=forms.PasswordInput,
required=False,
)
password2 = forms.CharField(
label=_('Password (again)'), widget=forms.PasswordInput,
required=False,
)
class Meta: class Meta:
model = User model = User
fields = [] fields = []
@ -44,20 +32,6 @@ class ChangeOsUserPasswordForm(forms.ModelForm):
'set_osuser_password', kwargs={'slug': self.instance.username}) 'set_osuser_password', kwargs={'slug': self.instance.username})
self.helper.add_input(Submit('submit', _('Set password'))) self.helper.add_input(Submit('submit', _('Set password')))
def clean_password2(self):
"""
Check that the two password entries match.
:return: the validated password
:rtype: str or None
"""
password1 = self.cleaned_data.get('password1')
password2 = self.cleaned_data.get('password2')
if password1 and password2 and password1 != password2:
raise forms.ValidationError(PASSWORD_MISMATCH_ERROR)
return password2
def save(self, commit=True): def save(self, commit=True):
""" """
Save the provided password in hashed format. Save the provided password in hashed format.

View file

@ -131,7 +131,7 @@
<td>{{ mailbox.mailaddresses|join:", " }}</td> <td>{{ mailbox.mailaddresses|join:", " }}</td>
<td><i class="glyphicon glyphicon-{% if mailbox.active %}ok-circle{% else %}minus-sign{% endif %}"></i><span class="sr-only"> {% if mailbox.active %}{% trans "Active" %}{% else %}{% trans "inactive" %}{% endif %}</span></td> <td><i class="glyphicon glyphicon-{% if mailbox.active %}ok-circle{% else %}minus-sign{% endif %}"></i><span class="sr-only"> {% if mailbox.active %}{% trans "Active" %}{% else %}{% trans "inactive" %}{% endif %}</span></td>
<td> <td>
<a href="#"><i class="fa fa-user-secret" title="{% trans "Set mailbox password" %}"></i><span class="sr-only"> {% trans "Set mailbox password" %}</span></a> <a href="{% url 'change_mailbox_password' package=hostingpackage.id slug=mailbox.username %}"><i class="fa fa-user-secret" title="{% trans "Set mailbox password" %}"></i><span class="sr-only"> {% trans "Set mailbox password" %}</span></a>
</td> </td>
{% endfor %} {% endfor %}
</tbody> </tbody>
@ -140,7 +140,7 @@
<p class="panel-body text-info">{% trans "There are no mailboxes assigned to this hosting package yet." %}</p> <p class="panel-body text-info">{% trans "There are no mailboxes assigned to this hosting package yet." %}</p>
{% endif %} {% endif %}
{% if hostingpackage.may_add_mailbox %} {% if hostingpackage.may_add_mailbox %}
<p class="panel-body"><a href="#" class="btn btn-primary">{% trans "Add mailbox" %}</a></p> <p class="panel-body"><a href="{% url 'create_mailbox' package=hostingpackage.id %}" class="btn btn-primary">{% trans "Add mailbox" %}</a></p>
{% endif %} {% endif %}
</div> </div>
</div> </div>

View file

@ -0,0 +1 @@
{% extends "base.html" %}

View file

@ -0,0 +1,34 @@
{% extends "managemails/base.html" %}
{% load i18n crispy_forms_tags %}
{% block title %}{{ block.user }} - {% spaceless %}
{% with full_name=customer.get_full_name package=hostingpackage.name %}
{% if customer == user %}
{% blocktrans %}Add Mailbox to Hosting Package {{ package }}{% endblocktrans %}
{% else %}
{% blocktrans %}Add Mailbox to Hosting Package {{ package }} of Customer {{ full_name }}{% endblocktrans %}
{% endif %}
{% endwith %}
{% endspaceless %}{% endblock title %}
{% block page_title %}{% spaceless %}
{% with full_name=customer.get_full_name package=hostingpackage.name %}
{% if customer == user %}
{% blocktrans %}Add Mailbox to Hosting Package {{ package }}{% endblocktrans %}
{% else %}
{% blocktrans %}Add Mailbox to Hosting Package {{ package }} of Customer {{ full_name }}{% endblocktrans %}
{% endif %}
{% endwith %}
{% endspaceless %}{% endblock page_title %}
{% block content %}
<p>{% if customer == user %}{% trans "Please specify the password for your new mailbox." %}{% else %}{% trans "Please specify the password for the new mailbox." %}{% endif %}</p>
{% crispy form %}
{% endblock content %}
{% block extra_js %}
<script type="text/javascript">
$(document).ready(function() {
$('input[type=password]').val('');
$('input[type=password]').first().focus();
});
</script>
{% endblock extra_js %}

View file

@ -0,0 +1,34 @@
{% extends "managemails/base.html" %}
{% load i18n crispy_forms_tags %}
{% block title %}{{ block.user }} - {% spaceless %}
{% with full_name=customer.get_full_name mailbox=mailbox.username %}
{% if customer == user %}
{% blocktrans %}Set Password for Mailbox {{ mailbox }}{% endblocktrans %}
{% else %}
{% blocktrans %}Set Password for Mailbox {{ mailbox }} of Customer {{ full_name }}{% endblocktrans %}
{% endif %}
{% endwith %}
{% endspaceless %}{% endblock title %}
{% block page_title %}{% spaceless %}
{% with full_name=customer.get_full_name mailbox=mailbox.username %}
{% if customer == user %}
{% blocktrans %}Set Password for Mailbox {{ mailbox }}{% endblocktrans %}
{% else %}
{% blocktrans %}Set Password for Mailbox {{ mailbox }} of Customer {{ full_name }}{% endblocktrans %}
{% endif %}
{% endwith %}
{% endspaceless %}{% endblock page_title %}
{% block content %}
<p>{% if customer == user %}{% trans "Please specify the new password for your mailbox." %}{% else %}{% trans "Please specify the new password for the mailbox." %}{% endif %}</p>
{% crispy form %}
{% endblock content %}
{% block extra_js %}
<script type="text/javascript">
$(document).ready(function() {
$('input[type=password]').val('');
$('input[type=password]').first().focus();
});
</script>
{% endblock extra_js %}