mirror of
https://github.com/jwinterm/modoboa.git
synced 2026-10-20 06:08:35 +02:00
407 lines
14 KiB
Python
407 lines
14 KiB
Python
"""Forms related to domains management."""
|
|
|
|
from django import forms
|
|
from django.core.urlresolvers import reverse
|
|
from django.http import QueryDict
|
|
from django.utils.translation import ugettext as _, ugettext_lazy
|
|
|
|
from modoboa.core.models import User
|
|
from modoboa.lib import events, parameters
|
|
from modoboa.lib.exceptions import ModoboaException, Conflict
|
|
from modoboa.lib.fields import DomainNameField
|
|
from modoboa.lib.form_utils import (
|
|
YesNoField, WizardForm, WizardStep, DynamicForm, TabForms
|
|
)
|
|
from modoboa.lib.web_utils import render_to_json_response
|
|
|
|
from ..lib import check_if_domain_exists
|
|
from ..models import (
|
|
Domain, DomainAlias, Mailbox, Alias, Quota
|
|
)
|
|
|
|
DOMAIN_TYPES = [
|
|
("domain", _("Domain")),
|
|
]
|
|
DOMAIN_TYPES += events.raiseQueryEvent("ExtraDomainTypes")
|
|
|
|
|
|
class DomainFormGeneral(forms.ModelForm, DynamicForm):
|
|
|
|
"""A form to create/edit a domain."""
|
|
|
|
type = forms.ChoiceField(
|
|
label=ugettext_lazy("Type"), choices=DOMAIN_TYPES
|
|
)
|
|
quota = forms.IntegerField(
|
|
label=ugettext_lazy("Quota"),
|
|
required=False,
|
|
help_text=ugettext_lazy(
|
|
"Default quota in MB applied to mailboxes. Leave empty to use the "
|
|
"default value."
|
|
)
|
|
)
|
|
aliases = DomainNameField(
|
|
label=ugettext_lazy("Alias(es)"),
|
|
required=False,
|
|
help_text=ugettext_lazy(
|
|
"Alias(es) of this domain. Indicate only one name per input, "
|
|
"press ENTER to add a new input."
|
|
)
|
|
)
|
|
|
|
class Meta:
|
|
model = Domain
|
|
fields = ("name", "type", "quota", "aliases", "enabled")
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.oldname = None
|
|
if "instance" in kwargs:
|
|
self.oldname = kwargs["instance"].name
|
|
super(DomainFormGeneral, self).__init__(*args, **kwargs)
|
|
|
|
self.field_widths = {
|
|
"quota": 3
|
|
}
|
|
|
|
if len(args) and isinstance(args[0], QueryDict):
|
|
self._load_from_qdict(args[0], "aliases", DomainNameField)
|
|
elif "instance" in kwargs:
|
|
d = kwargs["instance"]
|
|
for pos, dalias in enumerate(d.domainalias_set.all()):
|
|
name = "aliases_%d" % (pos + 1)
|
|
self._create_field(forms.CharField, name, dalias.name, 3)
|
|
|
|
def clean_quota(self):
|
|
if self.cleaned_data['quota'] is None:
|
|
return int(parameters.get_admin('DEFAULT_DOMAIN_QUOTA'))
|
|
if self.cleaned_data['quota'] < 0:
|
|
raise forms.ValidationError(_("Must be a positive integer"))
|
|
return self.cleaned_data['quota']
|
|
|
|
def clean(self):
|
|
"""Custom fields validation.
|
|
|
|
We want to prevent duplicate names between domains and domain
|
|
aliases. Extensions have the possibility to declare other
|
|
objects (see *CheckDomainName* event).
|
|
|
|
The validation way is not very smart...
|
|
"""
|
|
cleaned_data = super(DomainFormGeneral, self).clean()
|
|
if self._errors:
|
|
return cleaned_data
|
|
name = cleaned_data["name"]
|
|
label = check_if_domain_exists(
|
|
name, [(DomainAlias, _('domain alias'))])
|
|
if label is not None:
|
|
self.add_error(
|
|
"name", _("A %s with this name already exists")
|
|
% unicode(label)
|
|
)
|
|
for k in cleaned_data.keys():
|
|
if not k.startswith("aliases"):
|
|
continue
|
|
if cleaned_data[k] == "":
|
|
del cleaned_data[k]
|
|
continue
|
|
if cleaned_data[k] == name:
|
|
self._errors[k] = self.error_class(
|
|
[_("A %s with this name already exists") % _("domain")]
|
|
)
|
|
del cleaned_data[k]
|
|
continue
|
|
label = check_if_domain_exists(
|
|
cleaned_data[k], [(Domain, _("domain"))])
|
|
if label is not None:
|
|
self.add_error(
|
|
k, _("A %s with this name already exists")
|
|
% unicode(label)
|
|
)
|
|
return cleaned_data
|
|
|
|
def update_mailbox_quotas(self, domain):
|
|
"""Update all quota records associated to this domain.
|
|
|
|
This method must be called only when a domain gets renamed. As
|
|
the primary key used for a quota is an email address, rename a
|
|
domain will change all associated email addresses, so it will
|
|
change the primary keys used for quotas. The consequence is we
|
|
can't issue regular UPDATE queries using the .save() method of
|
|
a Quota instance (it will trigger an INSERT as the primary key
|
|
has changed).
|
|
|
|
So, we use this ugly hack to bypass this behaviour. It is not
|
|
perfomant at all as it will generate one query per quota
|
|
record to update.
|
|
"""
|
|
for q in Quota.objects.filter(username__contains="@%s" % self.oldname):
|
|
username = q.username.replace(
|
|
'@%s' % self.oldname, '@%s' % domain.name)
|
|
Quota.objects.create(
|
|
username=username, bytes=q.bytes, messages=q.messages)
|
|
q.delete()
|
|
|
|
def save(self, user, commit=True, domalias_post_create=False):
|
|
"""Custom save method
|
|
|
|
Updating a domain may have consequences on other objects
|
|
(domain alias, mailbox, quota). The most tricky part concerns
|
|
quotas update.
|
|
|
|
"""
|
|
d = super(DomainFormGeneral, self).save(commit=False)
|
|
if commit:
|
|
old_mail_homes = None
|
|
if self.oldname is not None and d.name != self.oldname:
|
|
d.name = self.oldname
|
|
old_mail_homes = \
|
|
dict((mb.id, mb.mail_home) for mb in d.mailbox_set.all())
|
|
d.name = self.cleaned_data['name']
|
|
d.save()
|
|
Mailbox.objects.filter(domain=d, use_domain_quota=True) \
|
|
.update(quota=d.quota)
|
|
aliases = []
|
|
for k, v in self.cleaned_data.iteritems():
|
|
if not k.startswith("aliases"):
|
|
continue
|
|
if v in ["", None]:
|
|
continue
|
|
aliases.append(v)
|
|
for dalias in d.domainalias_set.all():
|
|
if dalias.name not in aliases:
|
|
dalias.delete()
|
|
else:
|
|
aliases.remove(dalias.name)
|
|
if aliases:
|
|
events.raiseEvent(
|
|
"CanCreate", user, "domain_aliases", len(aliases))
|
|
for alias in aliases:
|
|
try:
|
|
d.domainalias_set.get(name=alias)
|
|
except DomainAlias.DoesNotExist:
|
|
pass
|
|
else:
|
|
continue
|
|
al = DomainAlias(name=alias, target=d, enabled=d.enabled)
|
|
al.save(creator=user) if domalias_post_create else al.save()
|
|
|
|
if old_mail_homes is not None:
|
|
self.update_mailbox_quotas(d)
|
|
for mb in d.mailbox_set.all():
|
|
mb.rename_dir(old_mail_homes[mb.id])
|
|
|
|
return d
|
|
|
|
|
|
class DomainFormOptions(forms.Form):
|
|
|
|
"""A form containing options for domain creation."""
|
|
|
|
create_dom_admin = YesNoField(
|
|
label=ugettext_lazy("Create a domain administrator"),
|
|
initial="no",
|
|
help_text=ugettext_lazy(
|
|
"Automatically create an administrator for this domain"
|
|
)
|
|
)
|
|
|
|
dom_admin_username = forms.CharField(
|
|
label=ugettext_lazy("Name"),
|
|
initial="admin",
|
|
help_text=ugettext_lazy(
|
|
"The administrator's name. Don't include the domain's name here, "
|
|
"it will be automatically appended."
|
|
),
|
|
required=False
|
|
)
|
|
|
|
create_aliases = YesNoField(
|
|
label=ugettext_lazy("Create aliases"),
|
|
initial="yes",
|
|
help_text=ugettext_lazy(
|
|
"Automatically create standard aliases for this domain"
|
|
),
|
|
required=False
|
|
)
|
|
|
|
def __init__(self, user, *args, **kwargs):
|
|
super(DomainFormOptions, self).__init__(*args, **kwargs)
|
|
result = events.raiseQueryEvent('UserCanSetRole', user, 'DomainAdmins')
|
|
if False in result:
|
|
self.fields = {}
|
|
return
|
|
if args:
|
|
if args[0].get("create_dom_admin", "no") == "yes":
|
|
self.fields["dom_admin_username"].required = True
|
|
self.fields["create_aliases"].required = True
|
|
|
|
def clean_dom_admin_username(self):
|
|
"""Ensure admin username is an email address."""
|
|
if '@' in self.cleaned_data["dom_admin_username"]:
|
|
raise forms.ValidationError(_("Invalid format"))
|
|
return self.cleaned_data["dom_admin_username"]
|
|
|
|
def save(self, *args, **kwargs):
|
|
if not self.fields:
|
|
return
|
|
if self.cleaned_data["create_dom_admin"] == "no":
|
|
return
|
|
user = kwargs.pop("user")
|
|
domain = kwargs.pop("domain")
|
|
username = "%s@%s" % (
|
|
self.cleaned_data["dom_admin_username"], domain.name)
|
|
try:
|
|
da = User.objects.get(username=username)
|
|
except User.DoesNotExist:
|
|
pass
|
|
else:
|
|
raise Conflict(_("User '%s' already exists" % username))
|
|
events.raiseEvent("CanCreate", user, "mailboxes")
|
|
da = User(username=username, email=username, is_active=True)
|
|
da.set_password("password")
|
|
da.save()
|
|
da.set_role("DomainAdmins")
|
|
da.post_create(user)
|
|
|
|
mb = Mailbox(
|
|
address=self.cleaned_data["dom_admin_username"], domain=domain,
|
|
user=da, use_domain_quota=True
|
|
)
|
|
mb.set_quota(
|
|
override_rules=user.has_perm("admin.change_domain"))
|
|
mb.save(creator=user)
|
|
|
|
if domain.type == "domain" and \
|
|
self.cleaned_data["create_aliases"] == "yes":
|
|
events.raiseEvent("CanCreate", user, "mailbox_aliases")
|
|
alias = Alias(
|
|
address="postmaster@{}".format(domain.name),
|
|
domain=domain, enabled=True
|
|
)
|
|
alias.save()
|
|
alias.set_recipients([mb.full_address])
|
|
alias.post_create(user)
|
|
|
|
domain.add_admin(da)
|
|
|
|
|
|
class DomainForm(TabForms):
|
|
|
|
"""Domain edition form."""
|
|
|
|
template_name = "admin/editdomainform.html"
|
|
|
|
def __init__(self, request, *args, **kwargs):
|
|
self.user = request.user
|
|
self.forms = []
|
|
self.domain = None
|
|
if self.user.has_perm("admin.change_domain"):
|
|
self.forms.append({
|
|
"id": "general",
|
|
"title": _("General"),
|
|
"formtpl": "admin/domain_general_form.html",
|
|
"cls": DomainFormGeneral,
|
|
"mandatory": True
|
|
})
|
|
|
|
cbargs = [self.user]
|
|
if "instances" in kwargs:
|
|
self.domain = kwargs["instances"]["general"]
|
|
cbargs += [self.domain]
|
|
self.forms += events.raiseQueryEvent("ExtraDomainForm", *cbargs)
|
|
if not self.forms:
|
|
self.active_id = "admins"
|
|
super(DomainForm, self).__init__(request, *args, **kwargs)
|
|
|
|
def extra_context(self, context):
|
|
domadmins = [u for u in self.domain.admins
|
|
if self.request.user.can_access(u) and not u.is_superuser]
|
|
if not self.request.user.is_superuser:
|
|
domadmins = [u for u in domadmins if u.group == "DomainAdmins"]
|
|
context.update({
|
|
"title": self.domain.name,
|
|
"action": reverse(
|
|
"admin:domain_change", args=[self.domain.pk]),
|
|
"formid": "domform",
|
|
"domain": self.domain,
|
|
"domadmins": domadmins
|
|
})
|
|
|
|
def is_valid(self):
|
|
"""Custom validation.
|
|
|
|
We just save the current name before it is potentially
|
|
modified.
|
|
|
|
"""
|
|
if "general" in self.instances:
|
|
self.instances["general"].oldname = self.instances["general"].name
|
|
return super(DomainForm, self).is_valid()
|
|
|
|
def save(self):
|
|
"""Custom save method.
|
|
|
|
As forms interact with each other, it is easier to make custom
|
|
code to save them.
|
|
"""
|
|
if not self.forms:
|
|
return
|
|
first_form = self.forms[0]["instance"]
|
|
options = {}
|
|
if isinstance(first_form, DomainFormGeneral):
|
|
options["domalias_post_create"] = True
|
|
first_form.save(self.request.user, **options)
|
|
for f in self.forms[1:]:
|
|
f["instance"].save(self.request.user)
|
|
|
|
def done(self):
|
|
if "general" in self.instances:
|
|
events.raiseEvent("DomainModified", self.instances["general"])
|
|
return render_to_json_response(_("Domain modified"))
|
|
|
|
|
|
class DomainWizard(WizardForm):
|
|
|
|
"""Domain creation wizard."""
|
|
|
|
def __init__(self, request):
|
|
super(DomainWizard, self).__init__(request)
|
|
self.add_step(
|
|
WizardStep(
|
|
"general", DomainFormGeneral, _("General"),
|
|
"admin/domain_general_form.html"
|
|
)
|
|
)
|
|
steps = events.raiseQueryEvent("ExtraDomainWizardSteps")
|
|
for step in steps:
|
|
self.add_step(step)
|
|
self.add_step(
|
|
WizardStep(
|
|
"options", DomainFormOptions, _("Options"),
|
|
"admin/domain_options_form.html",
|
|
[self.request.user]
|
|
)
|
|
)
|
|
|
|
def extra_context(self, context):
|
|
context.update({
|
|
"title": _("New domain"),
|
|
"action": reverse("admin:domain_add"),
|
|
"formid": "domform"
|
|
})
|
|
|
|
def done(self):
|
|
genform = self.first_step.form
|
|
domain = genform.save(self.request.user)
|
|
domain.post_create(self.request.user)
|
|
for step in self.steps[1:]:
|
|
if not step.check_access(self):
|
|
continue
|
|
try:
|
|
step.form.save(user=self.request.user, domain=domain)
|
|
except ModoboaException:
|
|
from django.db import transaction
|
|
transaction.rollback()
|
|
raise
|
|
return render_to_json_response(_("Domain created"))
|