mirror of
https://github.com/jwinterm/modoboa.git
synced 2026-10-17 05:41:25 +02:00
399 lines
13 KiB
Python
399 lines
13 KiB
Python
"""Models related to domains management."""
|
|
|
|
import datetime
|
|
|
|
from reversion import revisions as reversion
|
|
|
|
from django.core.management import call_command
|
|
from django.db import models
|
|
from django.utils import timezone
|
|
from django.utils.encoding import force_str, smart_str
|
|
from django.utils.functional import cached_property
|
|
from django.utils.translation import gettext as _, gettext_lazy
|
|
|
|
import django_rq
|
|
|
|
from modoboa.core import signals as core_signals
|
|
from modoboa.core.models import User
|
|
from modoboa.lib.exceptions import BadRequest, Conflict
|
|
from modoboa.parameters import tools as param_tools
|
|
|
|
from .. import constants
|
|
from .base import AdminObject
|
|
from . import mixins
|
|
|
|
|
|
class Domain(mixins.MessageLimitMixin, AdminObject):
|
|
"""Mail domain."""
|
|
|
|
name = models.CharField(
|
|
gettext_lazy("name"),
|
|
max_length=253,
|
|
unique=True,
|
|
help_text=gettext_lazy("The domain name"),
|
|
)
|
|
quota = models.PositiveIntegerField(
|
|
default=0,
|
|
)
|
|
default_mailbox_quota = models.PositiveIntegerField(
|
|
verbose_name=gettext_lazy("Default mailbox quota"), default=0
|
|
)
|
|
message_limit = models.PositiveIntegerField(
|
|
gettext_lazy("Message sending limit"),
|
|
null=True,
|
|
blank=True,
|
|
help_text=gettext_lazy("Number of messages this domain can send per day"),
|
|
)
|
|
enabled = models.BooleanField(
|
|
gettext_lazy("enabled"),
|
|
help_text=gettext_lazy("Check to activate this domain"),
|
|
default=True,
|
|
)
|
|
type = models.CharField(default="domain", max_length=20) # NOQA:A003
|
|
enable_dns_checks = models.BooleanField(
|
|
gettext_lazy("Enable DNS checks"),
|
|
default=True,
|
|
help_text=gettext_lazy("Check to enable DNS checks for this domain"),
|
|
)
|
|
last_dns_check_execution = models.DateTimeField(null=True, blank=True)
|
|
|
|
transport = models.OneToOneField(
|
|
"transport.Transport", null=True, on_delete=models.SET_NULL
|
|
)
|
|
|
|
enable_dkim = models.BooleanField(
|
|
gettext_lazy("Enable DKIM signing"),
|
|
help_text=gettext_lazy(
|
|
"If you activate this feature, a DKIM key will be "
|
|
"generated for this domain."
|
|
),
|
|
default=False,
|
|
)
|
|
dkim_key_selector = models.CharField(max_length=30, default="modoboa")
|
|
dkim_key_length = models.PositiveIntegerField(
|
|
gettext_lazy("Key length"),
|
|
choices=constants.DKIM_KEY_LENGTHS,
|
|
blank=True,
|
|
null=True,
|
|
)
|
|
dkim_public_key = models.TextField(blank=True)
|
|
dkim_private_key_path = models.CharField(max_length=254, blank=True)
|
|
|
|
class Meta:
|
|
ordering = ["name"]
|
|
app_label = "admin"
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
"""Save name for further use."""
|
|
super().__init__(*args, **kwargs)
|
|
self.old_mail_homes = None
|
|
self.oldname = self.name
|
|
self.old_dkim_key_length = self.dkim_key_length
|
|
|
|
@property
|
|
def domainalias_count(self) -> int:
|
|
return self.domainalias_set.count()
|
|
|
|
@property
|
|
def mailbox_count(self) -> int:
|
|
return self.mailbox_set.count()
|
|
|
|
@property
|
|
def mbalias_count(self) -> int:
|
|
return self.alias_set.filter(internal=False).count()
|
|
|
|
@property
|
|
def identities_count(self) -> int:
|
|
"""Total number of identities in this domain."""
|
|
return self.mailbox_set.count() + self.alias_set.filter(internal=False).count()
|
|
|
|
@property
|
|
def opened_alarms_count(self) -> int:
|
|
"""Number of alarms currently opened for this domain."""
|
|
return self.alarms.opened().count()
|
|
|
|
@property
|
|
def admins(self):
|
|
"""Return the domain administrators of this domain.
|
|
|
|
:return: a list of User objects
|
|
"""
|
|
return User.objects.filter(
|
|
is_superuser=False,
|
|
objectaccess__content_type__model="domain",
|
|
objectaccess__object_id=self.pk,
|
|
)
|
|
|
|
@property
|
|
def aliases(self):
|
|
return self.domainalias_set
|
|
|
|
@property
|
|
def uses_a_reserved_tld(self):
|
|
"""Does this domain use a reserved TLD."""
|
|
tld = self.name.split(".", 1)[-1]
|
|
return tld in constants.RESERVED_TLD
|
|
|
|
@property
|
|
def just_created(self):
|
|
"""Return true if the domain was created in the latest 24h."""
|
|
now = timezone.now()
|
|
delta = datetime.timedelta(days=1)
|
|
return self.creation + delta > now
|
|
|
|
def awaiting_checks(self):
|
|
"""Return true if the domain has no valid MX record and was created
|
|
in the latest 24h."""
|
|
if (not self.mxrecord_set.has_valids()) and self.just_created:
|
|
return True
|
|
return False
|
|
|
|
@property
|
|
def dns_global_status(self) -> str:
|
|
"""Return global DNS status."""
|
|
if not self.enable_dns_checks or self.uses_a_reserved_tld:
|
|
return "disabled"
|
|
elif self.awaiting_checks():
|
|
return "pending"
|
|
config = dict(param_tools.get_global_parameters("admin"))
|
|
errors = []
|
|
if config["enable_mx_checks"] and not self.mxrecord_set.has_valids():
|
|
errors.append("mx")
|
|
if (
|
|
config["enable_dnsbl_checks"]
|
|
and self.dnsblresult_set.blacklisted().exists()
|
|
):
|
|
errors.append("dnsbl")
|
|
if config["enable_spf_checks"]:
|
|
if self.spf_record is None or not self.spf_record.is_valid:
|
|
errors.append("spf")
|
|
if self.dkim_record is None or not self.dkim_record.is_valid:
|
|
errors.append("dkim")
|
|
if self.dmarc_record is None or not self.dmarc_record.is_valid:
|
|
errors.append("dmarc")
|
|
if config["enable_autoconfig_checks"]:
|
|
if self.autoconfig_record is None:
|
|
errors.append("autoconfig")
|
|
if self.autodiscover_record is None:
|
|
errors.append("autodiscover")
|
|
if len(errors) == 0:
|
|
return "ok"
|
|
return "critical"
|
|
|
|
@property
|
|
def spf_record(self):
|
|
"""Return SPF record."""
|
|
return self.dnsrecord_set.filter(type="spf").first()
|
|
|
|
@property
|
|
def dkim_record(self):
|
|
"""Return DKIM record."""
|
|
return self.dnsrecord_set.filter(type="dkim").first()
|
|
|
|
@property
|
|
def dmarc_record(self):
|
|
"""Return DMARC record."""
|
|
return self.dnsrecord_set.filter(type="dmarc").first()
|
|
|
|
@property
|
|
def autoconfig_record(self):
|
|
"""Return autoconfig record."""
|
|
return self.dnsrecord_set.filter(type="autoconfig").first()
|
|
|
|
@property
|
|
def autodiscover_record(self):
|
|
"""Return autodiscover record."""
|
|
return self.dnsrecord_set.filter(type="autodiscover").first()
|
|
|
|
@cached_property
|
|
def allocated_quota(self) -> int:
|
|
"""Return current quota allocation."""
|
|
if not self.quota:
|
|
return 0
|
|
if not self.mailbox_set.exists():
|
|
return 0
|
|
return self.mailbox_set.aggregate(total=models.Sum("quota"))["total"]
|
|
|
|
@cached_property
|
|
def allocated_quota_in_percent(self):
|
|
"""Return allocated quota in percent."""
|
|
if not self.allocated_quota:
|
|
return 0
|
|
return int(self.allocated_quota / float(self.quota) * 100)
|
|
|
|
@cached_property
|
|
def used_quota(self):
|
|
"""Return current quota usage."""
|
|
from .mailbox import Quota
|
|
|
|
if not self.quota:
|
|
return 0
|
|
if not self.mailbox_set.exists():
|
|
return 0
|
|
return int(Quota.objects.get_domain_usage(self) / 1048576)
|
|
|
|
@cached_property
|
|
def used_quota_in_percent(self):
|
|
"""Return used quota in percent."""
|
|
if not self.allocated_quota:
|
|
return 0
|
|
return int(self.used_quota / float(self.quota) * 100)
|
|
|
|
@property
|
|
def message_counter_key(self):
|
|
"""Return the key used to store messages count."""
|
|
return self.name
|
|
|
|
def add_admin(self, account):
|
|
"""Add a new administrator to this domain.
|
|
|
|
:param User account: the administrator
|
|
"""
|
|
from modoboa.lib.permissions import grant_access_to_object
|
|
|
|
# Check if domain's limit for domain admins is not reached yet
|
|
core_signals.can_create_object.send(
|
|
sender=self.__class__, context=self, object_type="domain_admins"
|
|
)
|
|
grant_access_to_object(account, self)
|
|
for mb in self.mailbox_set.all():
|
|
if mb.user.has_perm("admin.add_domain"):
|
|
continue
|
|
grant_access_to_object(account, mb)
|
|
grant_access_to_object(account, mb.user)
|
|
for al in self.alias_set.filter(internal=False):
|
|
grant_access_to_object(account, al)
|
|
|
|
def remove_admin(self, account):
|
|
"""Remove an administrator of this domain.
|
|
|
|
:param User account: administrator to remove
|
|
"""
|
|
from modoboa.lib.permissions import ungrant_access_to_object
|
|
|
|
ungrant_access_to_object(self, account)
|
|
for mb in self.mailbox_set.all():
|
|
if mb.user.has_perm("admin.add_domain"):
|
|
continue
|
|
ungrant_access_to_object(mb, account)
|
|
ungrant_access_to_object(mb.user, account)
|
|
for al in self.alias_set.all():
|
|
ungrant_access_to_object(al, account)
|
|
|
|
def save(self, *args, **kwargs):
|
|
"""Store current data if domain is renamed."""
|
|
# We check that the instance exists to use m2m relationship
|
|
if self.pk and self.oldname != self.name:
|
|
self.old_mail_homes = {mb.id: mb.mail_home for mb in self.mailbox_set.all()}
|
|
if self.old_dkim_key_length != self.dkim_key_length:
|
|
self.dkim_public_key = ""
|
|
self.dkim_private_key_path = ""
|
|
super().save(*args, **kwargs)
|
|
|
|
def delete(self, fromuser, keepdir=False):
|
|
"""Custom delete method."""
|
|
from modoboa.lib.permissions import ungrant_access_to_objects
|
|
from .mailbox import Quota
|
|
|
|
if self.domainalias_set.count():
|
|
ungrant_access_to_objects(self.domainalias_set.all())
|
|
if self.alias_set.count():
|
|
ungrant_access_to_objects(self.alias_set.all())
|
|
if param_tools.get_global_parameter("auto_account_removal"):
|
|
User.objects.filter(mailbox__domain=self).delete()
|
|
elif self.mailbox_set.count():
|
|
Quota.objects.filter(username__contains=f"@{self.name}").delete()
|
|
ungrant_access_to_objects(self.mailbox_set.all())
|
|
super().delete()
|
|
|
|
def __str__(self):
|
|
return smart_str(self.name)
|
|
|
|
def generate_dkim_key(self):
|
|
"""Launch domain key creation."""
|
|
queue = django_rq.get_queue("dkim")
|
|
queue.enqueue(call_command, "modo", "manage_dkim_keys", f"--domain={self.name}")
|
|
|
|
def from_csv(self, user, row):
|
|
"""Create a new domain from a CSV entry.
|
|
|
|
The expected fields order is the following::
|
|
|
|
"domain", name, quota, default_mailbox_quota, enabled
|
|
|
|
:param ``core.User`` user: user creating the domain
|
|
:param str row: a list containing domain's definition
|
|
"""
|
|
from .. import lib
|
|
|
|
if len(row) < 5:
|
|
raise BadRequest(_("Invalid line"))
|
|
self.name = row[1].strip().lower()
|
|
if Domain.objects.filter(name=self.name).exists():
|
|
raise Conflict
|
|
domains_must_have_authorized_mx = param_tools.get_global_parameter(
|
|
"domains_must_have_authorized_mx"
|
|
)
|
|
if domains_must_have_authorized_mx and not user.is_superuser:
|
|
if not lib.domain_has_authorized_mx(self.name):
|
|
raise BadRequest(
|
|
_("{}: no authorized MX record found for domain").format(self.name)
|
|
)
|
|
try:
|
|
self.quota = int(row[2].strip())
|
|
except ValueError:
|
|
raise BadRequest(
|
|
_("{}: invalid quota value for domain").format(self.name)
|
|
) from None
|
|
try:
|
|
self.default_mailbox_quota = int(row[3].strip())
|
|
except ValueError:
|
|
raise BadRequest(
|
|
_("{}: invalid default mailbox quota value for domain").format(
|
|
self.name
|
|
)
|
|
) from None
|
|
if self.quota != 0 and self.default_mailbox_quota > self.quota:
|
|
raise BadRequest(
|
|
_(
|
|
"{}: default mailbox quota cannot be greater than domain " "quota"
|
|
).format(self.name)
|
|
)
|
|
self.enabled = row[4].strip().lower() in ["true", "1", "yes", "y"]
|
|
core_signals.can_create_object.send(
|
|
sender=self.__class__, context=user, klass=Domain, instance=self
|
|
)
|
|
self.save(creator=user)
|
|
|
|
def to_csv_rows(self):
|
|
"""Return a row to include in a CSV file."""
|
|
result = [
|
|
[
|
|
"domain",
|
|
force_str(self.name),
|
|
self.quota,
|
|
self.default_mailbox_quota,
|
|
self.enabled,
|
|
]
|
|
]
|
|
for dalias in self.domainalias_set.all():
|
|
result.append(dalias.to_csv_row())
|
|
return result
|
|
|
|
def to_csv(self, csvwriter):
|
|
"""Export domain and domain aliases to CSV format."""
|
|
for row in self.to_csv_rows():
|
|
csvwriter.writerow(row)
|
|
|
|
def post_create(self, creator):
|
|
"""Post creation actions.
|
|
|
|
:param ``User`` creator: user whos created this domain
|
|
"""
|
|
super().post_create(creator)
|
|
for domalias in self.domainalias_set.all():
|
|
domalias.post_create(creator)
|
|
|
|
|
|
reversion.register(Domain)
|