8
0
Fork 0
mirror of https://gitlab2.federez.net/re2o/re2o synced 2024-11-22 19:33:11 +00:00
re2o/users/models.py

1976 lines
68 KiB
Python
Raw Normal View History

# -*- mode: python; coding: utf-8 -*-
2017-10-14 18:18:12 +00:00
# Re2o est un logiciel d'administration développé initiallement au rezometz.
# Il se veut agnostique au réseau considéré, de manière à être installable
# en quelques clics.
2017-01-15 23:01:18 +00:00
#
# Copyright © 2017 Gabriel Détraz
# Copyright © 2017 Goulven Kermarec
# Copyright © 2017 Augustin Lemesle
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
2017-10-14 18:18:12 +00:00
"""
Models de l'application users.
On défini ici des models django classiques:
- users, qui hérite de l'abstract base user de django. Permet de définit
un utilisateur du site (login, passwd, chambre, adresse, etc)
- les whiteslist
- les bannissements
- les établissements d'enseignement (school)
- les droits (right et listright)
- les utilisateurs de service (pour connexion automatique)
On défini aussi des models qui héritent de django-ldapdb :
- ldapuser
- ldapgroup
- ldapserviceuser
Ces utilisateurs ldap sont synchronisés à partir des objets
models sql classiques. Seuls certains champs essentiels sont
dupliqués.
"""
2017-01-15 23:01:18 +00:00
from __future__ import unicode_literals
2017-10-14 18:18:12 +00:00
import re
import uuid
import datetime
import sys
2017-10-14 18:18:12 +00:00
2016-06-30 01:39:07 +00:00
from django.db import models
from django.db.models import Q
from django import forms
2018-08-10 22:13:27 +00:00
from django.forms import ValidationError
from django.db.models.signals import post_save, post_delete, m2m_changed
from django.dispatch import receiver
from django.utils.functional import cached_property
2017-10-14 18:18:12 +00:00
from django.template import Context, loader
from django.core.mail import send_mail
from django.core.urlresolvers import reverse
2017-10-14 18:18:12 +00:00
from django.db import transaction
from django.utils import timezone
from django.contrib.auth.models import (
AbstractBaseUser,
BaseUserManager,
PermissionsMixin,
Group
)
2017-10-14 18:18:12 +00:00
from django.core.validators import RegexValidator
import traceback
2018-08-15 17:15:26 +00:00
from django.utils.translation import ugettext_lazy as _
from reversion import revisions as reversion
import ldapdb.models
import ldapdb.models.fields
2018-04-14 15:35:07 +00:00
from re2o.settings import LDAP, GID_RANGES, UID_RANGES
from re2o.login import hashNT
from re2o.field_permissions import FieldPermissionModelMixin
from re2o.mixins import AclMixin, RevMixin
2018-11-15 16:14:51 +00:00
from re2o.base import smtp_check
2016-06-30 01:39:07 +00:00
2017-06-26 17:23:01 +00:00
from cotisations.models import Cotisation, Facture, Paiement, Vente
from machines.models import Domain, Interface, Machine, regen
2017-10-14 18:18:12 +00:00
from preferences.models import GeneralOption, AssoOption, OptionalUser
from preferences.models import OptionalMachine, MailMessageOption
2017-10-04 15:53:30 +00:00
2017-10-14 18:18:12 +00:00
# Utilitaires généraux
2017-10-04 15:53:30 +00:00
def linux_user_check(login):
2016-07-06 00:56:30 +00:00
""" Validation du pseudo pour respecter les contraintes unix"""
2018-12-27 19:46:33 +00:00
UNIX_LOGIN_PATTERN = re.compile("^[a-z][a-z0-9-]*[$]?$")
return UNIX_LOGIN_PATTERN.match(login)
def linux_user_validator(login):
2017-10-14 18:18:12 +00:00
""" Retourne une erreur de validation si le login ne respecte
2017-10-04 15:53:30 +00:00
pas les contraintes unix (maj, min, chiffres ou tiret)"""
if not linux_user_check(login):
2018-07-30 15:00:41 +00:00
raise forms.ValidationError(
2018-08-15 17:15:26 +00:00
_("The username '%(label)s' contains forbidden characters."),
2017-10-14 18:18:12 +00:00
params={'label': login},
2016-07-06 00:56:30 +00:00
)
2016-10-12 10:24:01 +00:00
def get_fresh_user_uid():
2017-10-04 15:53:30 +00:00
""" Renvoie le plus petit uid non pris. Fonction très paresseuse """
2017-10-14 18:18:12 +00:00
uids = list(range(
int(min(UID_RANGES['users'])),
int(max(UID_RANGES['users']))
))
2016-12-18 09:52:20 +00:00
try:
used_uids = list(User.objects.values_list('uid_number', flat=True))
2016-12-18 09:52:20 +00:00
except:
used_uids = []
2017-10-14 18:18:12 +00:00
free_uids = [id for id in uids if id not in used_uids]
2016-10-12 10:24:01 +00:00
return min(free_uids)
2017-10-14 18:18:12 +00:00
2016-10-12 10:24:01 +00:00
def get_fresh_gid():
2017-10-04 15:53:30 +00:00
""" Renvoie le plus petit gid libre """
2017-10-14 18:18:12 +00:00
gids = list(range(
int(min(GID_RANGES['posix'])),
int(max(GID_RANGES['posix']))
))
used_gids = list(ListRight.objects.values_list('gid', flat=True))
2017-10-14 18:18:12 +00:00
free_gids = [id for id in gids if id not in used_gids]
2016-10-12 10:24:01 +00:00
return min(free_gids)
2017-10-14 18:18:12 +00:00
class UserManager(BaseUserManager):
2017-10-14 18:18:12 +00:00
"""User manager basique de django"""
2017-10-14 18:18:12 +00:00
def _create_user(
self,
pseudo,
surname,
2018-07-30 15:00:41 +00:00
email,
2017-10-14 18:18:12 +00:00
password=None,
su=False
):
if not pseudo:
2018-08-15 17:15:26 +00:00
raise ValueError(_("Users must have an username."))
if not linux_user_check(pseudo):
2018-08-15 17:15:26 +00:00
raise ValueError(_("Username should only contain [a-z0-9-]."))
2018-01-21 16:40:00 +00:00
user = Adherent(
pseudo=pseudo,
surname=surname,
2018-01-21 16:40:00 +00:00
name=surname,
2018-08-05 21:01:42 +00:00
email=self.normalize_email(email),
)
user.set_password(password)
if su:
2018-04-14 01:25:05 +00:00
user.is_superuser = True
user.save(using=self._db)
return user
2018-07-30 15:00:41 +00:00
def create_user(self, pseudo, surname, email, password=None):
"""
Creates and saves a User with the given pseudo, name, surname, email,
and password.
"""
2018-07-30 15:00:41 +00:00
return self._create_user(pseudo, surname, email, password, False)
2018-07-30 15:00:41 +00:00
def create_superuser(self, pseudo, surname, email, password):
"""
Creates and saves a superuser with the given pseudo, name, surname,
email, and password.
"""
2018-07-30 15:00:41 +00:00
return self._create_user(pseudo, surname, email, password, True)
2018-04-14 01:25:05 +00:00
class User(RevMixin, FieldPermissionModelMixin, AbstractBaseUser,
PermissionsMixin, AclMixin):
2017-10-04 15:53:30 +00:00
""" Definition de l'utilisateur de base.
Champs principaux : name, surnname, pseudo, email, room, password
Herite du django BaseUser et du système d'auth django"""
2018-08-15 17:15:26 +00:00
2016-06-30 01:39:07 +00:00
STATE_ACTIVE = 0
2016-10-18 15:11:45 +00:00
STATE_DISABLED = 1
STATE_ARCHIVE = 2
STATE_NOT_YET_ACTIVE = 3
2019-03-17 02:00:28 +00:00
STATE_FULL_ARCHIVE = 4
2016-06-30 01:39:07 +00:00
STATES = (
2019-01-08 23:40:59 +00:00
(0, _("Active")),
(1, _("Disabled")),
(2, _("Archived")),
(3, _("Not yet active")),
2019-03-17 02:00:28 +00:00
(4, _("Full Archived")),
2017-10-14 18:18:12 +00:00
)
2016-06-30 01:39:07 +00:00
surname = models.CharField(max_length=255)
2017-10-14 18:18:12 +00:00
pseudo = models.CharField(
max_length=32,
unique=True,
2018-08-15 17:15:26 +00:00
help_text=_("Must only contain letters, numerals or dashes."),
2018-08-10 22:13:27 +00:00
validators=[linux_user_validator]
2017-10-14 18:18:12 +00:00
)
email = models.EmailField(
blank=True,
null=True,
2018-08-15 17:15:26 +00:00
help_text=_("External email address allowing us to contact you.")
)
2018-07-30 15:00:41 +00:00
local_email_redirect = models.BooleanField(
2018-06-29 14:36:04 +00:00
default=False,
2018-08-15 17:15:26 +00:00
help_text=_("Enable redirection of the local email messages to the"
" main email address.")
2018-06-29 14:36:04 +00:00
)
2018-07-30 15:00:41 +00:00
local_email_enabled = models.BooleanField(
2018-06-29 14:36:04 +00:00
default=False,
2018-08-15 17:15:26 +00:00
help_text=_("Enable the local email account.")
2018-06-29 14:36:04 +00:00
)
2017-10-14 18:18:12 +00:00
school = models.ForeignKey(
'School',
on_delete=models.PROTECT,
null=True,
blank=True
)
shell = models.ForeignKey(
'ListShell',
on_delete=models.PROTECT,
null=True,
blank=True
)
comment = models.CharField(
2018-08-15 17:15:26 +00:00
help_text=_("Comment, school year"),
2017-10-14 18:18:12 +00:00
max_length=255,
blank=True
)
2016-06-30 01:39:07 +00:00
pwd_ntlm = models.CharField(max_length=255)
state = models.IntegerField(choices=STATES, default=STATE_NOT_YET_ACTIVE)
registered = models.DateTimeField(auto_now_add=True)
2017-06-25 02:12:21 +00:00
telephone = models.CharField(max_length=15, blank=True, null=True)
uid_number = models.PositiveIntegerField(
default=get_fresh_user_uid,
unique=True
)
2018-04-14 01:25:05 +00:00
rezo_rez_uid = models.PositiveIntegerField(
unique=True,
blank=True,
null=True
)
2016-06-30 01:39:07 +00:00
USERNAME_FIELD = 'pseudo'
2018-07-30 15:00:41 +00:00
REQUIRED_FIELDS = ['surname', 'email']
objects = UserManager()
2017-12-31 19:53:38 +00:00
class Meta:
permissions = (
2018-04-14 01:25:05 +00:00
("change_user_password",
2018-08-15 17:15:26 +00:00
_("Can change the password of a user")),
("change_user_state", _("Can edit the state of a user")),
("change_user_force", _("Can force the move")),
("change_user_shell", _("Can edit the shell of a user")),
2018-04-14 01:25:05 +00:00
("change_user_groups",
2018-08-15 17:15:26 +00:00
_("Can edit the groups of rights of a user (critical"
" permission)")),
2018-04-14 01:25:05 +00:00
("change_all_users",
2018-08-15 17:15:26 +00:00
_("Can edit all users, including those with rights.")),
2018-04-14 01:25:05 +00:00
("view_user",
2018-08-15 17:15:26 +00:00
_("Can view a user object")),
2017-12-31 19:53:38 +00:00
)
2018-08-15 17:15:26 +00:00
verbose_name = _("user (member or club)")
verbose_name_plural = _("users (members or clubs)")
2018-07-30 15:00:41 +00:00
@cached_property
def name(self):
"""Si il s'agit d'un adhérent, on renvoie le prénom"""
if self.is_class_adherent:
return self.adherent.name
else:
return ''
@cached_property
def room(self):
"""Alias vers room """
if self.is_class_adherent:
return self.adherent.room
elif self.is_class_club:
return self.club.room
else:
2018-08-15 17:15:26 +00:00
raise NotImplementedError(_("Unknown type."))
@cached_property
def get_mail_addresses(self):
if self.local_email_enabled:
return self.emailaddress_set.all()
return None
@cached_property
def get_mail(self):
"""Return the mail address choosen by the user"""
if not OptionalUser.get_cached_value('local_email_accounts_enabled') or not self.local_email_enabled or self.local_email_redirect:
return str(self.email)
else:
2018-08-10 22:13:27 +00:00
return str(self.emailaddress_set.get(local_part=self.pseudo.lower()))
@cached_property
def class_name(self):
"""Renvoie si il s'agit d'un adhérent ou d'un club"""
if hasattr(self, 'adherent'):
2018-08-15 17:15:26 +00:00
return _("Member")
elif hasattr(self, 'club'):
2018-08-15 17:15:26 +00:00
return _("Club")
else:
2018-08-15 17:15:26 +00:00
raise NotImplementedError(_("Unknown type."))
@cached_property
def gid_number(self):
"""renvoie le gid par défaut des users"""
return int(LDAP['user_gid'])
@cached_property
def is_class_club(self):
2018-04-14 23:16:49 +00:00
""" Returns True if the object is a Club (subclassing User) """
# TODO : change to isinstance (cleaner)
return hasattr(self, 'club')
@cached_property
def is_class_adherent(self):
2018-04-14 23:16:49 +00:00
""" Returns True if the object is a Adherent (subclassing User) """
# TODO : change to isinstance (cleaner)
return hasattr(self, 'adherent')
@property
def is_active(self):
2017-10-04 15:53:30 +00:00
""" Renvoie si l'user est à l'état actif"""
return self.state == self.STATE_ACTIVE or self.state == self.STATE_NOT_YET_ACTIVE
def set_active(self):
2019-03-17 02:00:28 +00:00
"""Enable this user if he subscribed successfully one time before
Reenable it if it was archived
Do nothing if disabed"""
if self.state == self.STATE_NOT_YET_ACTIVE:
if self.facture_set.filter(valid=True).filter(Q(vente__type_cotisation='All') | Q(vente__type_cotisation='Adhesion')).exists() or OptionalUser.get_cached_value('all_users_active'):
self.state = self.STATE_ACTIVE
self.save()
2019-03-17 02:00:28 +00:00
if self.state == self.STATE_ARCHIVE or self.state == self.STATE_FULL_ARCHIVE:
self.state = self.STATE_ACTIVE
self.unarchive()
self.save()
@property
def is_staff(self):
2017-10-04 15:53:30 +00:00
""" Fonction de base django, renvoie si l'user est admin"""
return self.is_admin
@property
def is_admin(self):
2017-10-04 15:53:30 +00:00
""" Renvoie si l'user est admin"""
2018-04-14 01:25:05 +00:00
admin, _ = Group.objects.get_or_create(name="admin")
return self.is_superuser or admin in self.groups.all()
def get_full_name(self):
2017-10-04 15:53:30 +00:00
""" Renvoie le nom complet de l'user formaté nom/prénom"""
name = self.name
if name:
2019-01-08 23:40:59 +00:00
return "%s %s" % (name, self.surname)
else:
return self.surname
def get_short_name(self):
2017-10-04 15:53:30 +00:00
""" Renvoie seulement le nom"""
return self.surname
2018-08-04 21:13:01 +00:00
@cached_property
def gid(self):
"""return the default gid of user"""
return LDAP['user_gid']
2018-03-24 20:19:52 +00:00
@property
def get_shell(self):
""" A utiliser de préférence, prend le shell par défaut
si il n'est pas défini"""
return self.shell or OptionalUser.get_cached_value('shell_default')
@cached_property
def home_directory(self):
return '/home/' + self.pseudo
2018-07-19 18:46:12 +00:00
@cached_property
def get_shadow_expire(self):
"""Return the shadow_expire value for the user"""
if self.state == self.STATE_DISABLED:
return str(0)
else:
return None
def end_adhesion(self):
2017-10-04 15:53:30 +00:00
""" Renvoie la date de fin d'adhésion d'un user. Examine les objets
cotisation"""
2017-10-14 18:18:12 +00:00
date_max = Cotisation.objects.filter(
vente__in=Vente.objects.filter(
facture__in=Facture.objects.filter(
user=self
).exclude(valid=False)
)
2017-10-28 03:12:18 +00:00
).filter(
Q(type_cotisation='All') | Q(type_cotisation='Adhesion')
).aggregate(models.Max('date_end'))['date_end__max']
return date_max
def end_connexion(self):
""" Renvoie la date de fin de connexion d'un user. Examine les objets
cotisation"""
date_max = Cotisation.objects.filter(
vente__in=Vente.objects.filter(
facture__in=Facture.objects.filter(
user=self
).exclude(valid=False)
)
).filter(
Q(type_cotisation='All') | Q(type_cotisation='Connexion')
2017-10-14 18:18:12 +00:00
).aggregate(models.Max('date_end'))['date_end__max']
return date_max
def is_adherent(self):
2017-10-14 18:18:12 +00:00
""" Renvoie True si l'user est adhérent : si
self.end_adhesion()>now"""
2017-07-18 01:49:36 +00:00
end = self.end_adhesion()
if not end:
return False
2018-01-10 20:20:54 +00:00
elif end < timezone.now():
return False
else:
return True
2017-10-28 03:12:18 +00:00
def is_connected(self):
""" Renvoie True si l'user est adhérent : si
self.end_adhesion()>now et end_connexion>now"""
end = self.end_connexion()
if not end:
return False
2018-01-10 20:20:54 +00:00
elif end < timezone.now():
2017-10-28 03:12:18 +00:00
return False
else:
return self.is_adherent()
def end_ban(self):
""" Renvoie la date de fin de ban d'un user, False sinon """
2017-10-14 18:18:12 +00:00
date_max = Ban.objects.filter(
user=self
).aggregate(models.Max('date_end'))['date_end__max']
return date_max
def end_whitelist(self):
""" Renvoie la date de fin de whitelist d'un user, False sinon """
2017-10-14 18:18:12 +00:00
date_max = Whitelist.objects.filter(
user=self
).aggregate(models.Max('date_end'))['date_end__max']
return date_max
def is_ban(self):
""" Renvoie si un user est banni ou non """
end = self.end_ban()
if not end:
return False
2018-01-10 20:20:54 +00:00
elif end < timezone.now():
return False
else:
return True
def is_whitelisted(self):
""" Renvoie si un user est whitelisté ou non """
end = self.end_whitelist()
if not end:
return False
2018-01-10 20:20:54 +00:00
elif end < timezone.now():
return False
else:
return True
def has_access(self):
""" Renvoie si un utilisateur a accès à internet """
2018-04-14 01:25:05 +00:00
return (self.state == User.STATE_ACTIVE and
not self.is_ban() and
(self.is_connected() or self.is_whitelisted())) \
or self == AssoOption.get_cached_value('utilisateur_asso')
def end_access(self):
""" Renvoie la date de fin normale d'accès (adhésion ou whiteliste)"""
2017-10-28 03:12:18 +00:00
if not self.end_connexion():
if not self.end_whitelist():
return None
else:
return self.end_whitelist()
else:
if not self.end_whitelist():
2017-10-28 03:12:18 +00:00
return self.end_connexion()
2017-10-14 18:18:12 +00:00
else:
return max(self.end_connexion(), self.end_whitelist())
2017-06-26 17:23:01 +00:00
@cached_property
def solde(self):
""" Renvoie le solde d'un user.
2017-10-04 15:53:30 +00:00
Somme les crédits de solde et retire les débit payés par solde"""
2018-07-05 13:21:51 +00:00
solde_objects = Paiement.objects.filter(is_balance=True)
somme_debit = Vente.objects.filter(
facture__in=Facture.objects.filter(
user=self,
paiement__in=solde_objects,
valid=True
)
).aggregate(
total=models.Sum(
models.F('prix')*models.F('number'),
2018-09-26 11:16:22 +00:00
output_field=models.DecimalField()
)
)['total'] or 0
somme_credit = Vente.objects.filter(
facture__in=Facture.objects.filter(user=self, valid=True),
2019-01-08 23:40:59 +00:00
name='solde'
).aggregate(
total=models.Sum(
models.F('prix')*models.F('number'),
2018-09-26 11:16:22 +00:00
output_field=models.DecimalField()
)
)['total'] or 0
return somme_credit - somme_debit
2017-06-26 17:23:01 +00:00
@classmethod
def users_interfaces(cls, users, active=True, all_interfaces=False):
2017-10-14 18:18:12 +00:00
""" Renvoie toutes les interfaces dont les machines appartiennent à
self. Par defaut ne prend que les interfaces actives"""
2019-03-17 02:00:28 +00:00
if all_interfaces:
return Interface.objects.filter(
machine__in=Machine.objects.filter(user__in=users)
2019-03-17 02:00:28 +00:00
).select_related('domain__extension')
else:
return Interface.objects.filter(
machine__in=Machine.objects.filter(user__in=users, active=active)
2019-03-17 02:00:28 +00:00
).select_related('domain__extension')
def user_interfaces(self, active=True, all_interfaces=False):
""" Renvoie toutes les interfaces dont les machines appartiennent à
self. Par defaut ne prend que les interfaces actives"""
return self.users_interfaces([self], active=active, all_interfaces=all_interfaces)
def assign_ips(self):
""" Assign une ipv4 aux machines d'un user """
interfaces = self.user_interfaces()
with transaction.atomic(), reversion.create_revision():
Interface.mass_assign_ipv4(interfaces)
reversion.set_comment(_("IPv4 assigning"))
def unassign_ips(self):
2017-10-04 15:53:30 +00:00
""" Désassigne les ipv4 aux machines de l'user"""
interfaces = self.user_interfaces()
with transaction.atomic(), reversion.create_revision():
Interface.mass_unassign_ipv4(interfaces)
reversion.set_comment(_("IPv4 unassigning"))
@classmethod
def mass_unassign_ips(cls, users_list):
interfaces = cls.users_interfaces(users_list)
with transaction.atomic(), reversion.create_revision():
Interface.mass_unassign_ipv4(interfaces)
reversion.set_comment(_("IPv4 assigning"))
@classmethod
def mass_disable_email(cls, queryset_users):
"""Disable email account and redirection"""
queryset_users.update(local_email_enabled=False)
queryset_users.update(local_email_redirect=False)
@classmethod
def mass_delete_data(cls, queryset_users):
"""This users will be completely archived, so only keep mandatory data"""
cls.mass_disable_email(queryset_users)
Machine.mass_delete(Machine.objects.filter(user__in=queryset_users))
cls.ldap_delete_users(queryset_users)
def disable_email(self):
"""Disable email account and redirection"""
self.local_email_enabled=False
self.local_email_redirect=False
2019-03-17 02:00:28 +00:00
def delete_data(self):
"""This user will be completely archived, so only keep mandatory data"""
self.disable_email()
self.machine_set.all().delete()
@classmethod
def mass_archive(cls, users_list):
"""Mass Archive several users, take a queryset
Copy Queryset to avoid eval problem with queryset update"""
#Force eval of queryset
bool(users_list)
users_list = users_list.all()
cls.mass_unassign_ips(users_list)
users_list.update(state=User.STATE_ARCHIVE)
@classmethod
def mass_full_archive(cls, users_list):
"""Mass Archive several users, take a queryset
Copy Queryset to avoid eval problem with queryset update"""
#Force eval of queryset
bool(users_list)
users_list = users_list.all()
cls.mass_unassign_ips(users_list)
cls.mass_delete_data(users_list)
users_list.update(state=User.STATE_FULL_ARCHIVE)
2019-03-17 02:00:28 +00:00
def archive(self):
2018-07-20 10:57:54 +00:00
""" Filling the user; no more active"""
self.unassign_ips()
2019-03-17 02:00:28 +00:00
def full_archive(self):
"""Full Archive = Archive + Service access complete deletion"""
self.archive()
self.delete_data()
self.ldap_del()
def unarchive(self):
2018-07-20 10:57:54 +00:00
"""Unfilling the user"""
self.assign_ips()
2019-03-17 02:00:28 +00:00
self.ldap_sync()
2018-07-19 18:37:01 +00:00
def state_sync(self):
"""Archive, or unarchive, if the user was not active/or archived before"""
2019-03-17 02:00:28 +00:00
if self.__original_state != self.STATE_ACTIVE and self.state == self.STATE_ACTIVE:
2018-07-19 18:37:01 +00:00
self.unarchive()
elif self.__original_state != self.STATE_ARCHIVE and self.state == self.STATE_ARCHIVE:
self.archive()
2019-03-17 02:00:28 +00:00
elif self.__original_state != self.STATE_FULL_ARCHIVE and self.state == self.STATE_FULL_ARCHIVE:
self.full_archive()
2018-04-14 01:25:05 +00:00
def ldap_sync(self, base=True, access_refresh=True, mac_refresh=True,
group_refresh=False):
2017-10-14 18:18:12 +00:00
""" Synchronisation du ldap. Synchronise dans le ldap les attributs de
self
Options : base : synchronise tous les attributs de base - nom, prenom,
mail, password, shell, home
access_refresh : synchronise le dialup_access notant si l'user a accès
aux services
mac_refresh : synchronise les machines de l'user
group_refresh : synchronise les group de l'user
Si l'instance n'existe pas, on crée le ldapuser correspondant"""
2019-03-17 02:00:28 +00:00
if sys.version_info[0] >= 3 and (self.state == self.STATE_ACTIVE or self.state == self.STATE_ARCHIVE or self.state == self.STATE_DISABLED):
self.refresh_from_db()
try:
user_ldap = LdapUser.objects.get(uidNumber=self.uid_number)
except LdapUser.DoesNotExist:
2018-08-31 11:35:33 +00:00
user_ldap = LdapUser(uidNumber=self.uid_number)
base = True
access_refresh = True
mac_refresh = True
if base:
user_ldap.name = self.pseudo
user_ldap.sn = self.pseudo
user_ldap.dialupAccess = str(self.has_access())
user_ldap.home_directory = self.home_directory
user_ldap.mail = self.get_mail
user_ldap.given_name = self.surname.lower() + '_'\
+ self.name.lower()[:3]
user_ldap.gid = LDAP['user_gid']
if '{SSHA}' in self.password or '{SMD5}' in self.password:
# We remove the extra $ added at import from ldap
user_ldap.user_password = self.password[:6] + \
self.password[7:]
elif '{crypt}' in self.password:
# depending on the length, we need to remove or not a $
if len(self.password) == 41:
user_ldap.user_password = self.password
else:
user_ldap.user_password = self.password[:7] + \
self.password[8:]
user_ldap.sambat_nt_password = self.pwd_ntlm.upper()
if self.get_shell:
user_ldap.login_shell = str(self.get_shell)
user_ldap.shadowexpire = self.get_shadow_expire
if access_refresh:
user_ldap.dialupAccess = str(self.has_access())
if mac_refresh:
user_ldap.macs = [str(mac) for mac in Interface.objects.filter(
machine__user=self
).values_list('mac_address', flat=True).distinct()]
if group_refresh:
# Need to refresh all groups because we don't know which groups
# were updated during edition of groups and the user may no longer
# be part of the updated group (case of group removal)
for group in Group.objects.all():
if hasattr(group, 'listright'):
group.listright.ldap_sync()
user_ldap.save()
def ldap_del(self):
2017-10-04 15:53:30 +00:00
""" Supprime la version ldap de l'user"""
try:
user_ldap = LdapUser.objects.get(name=self.pseudo)
user_ldap.delete()
except LdapUser.DoesNotExist:
pass
@classmethod
def ldap_delete_users(cls, queryset_users):
"""Delete multiple users in ldap"""
LdapUser.objects.filter(name__in=list(queryset_users.values_list('pseudo', flat=True)))
def notif_inscription(self):
""" Prend en argument un objet user, envoie un mail de bienvenue """
2017-10-14 18:18:12 +00:00
template = loader.get_template('users/email_welcome')
mailmessageoptions, _created = MailMessageOption\
.objects.get_or_create()
context = Context({
'nom': self.get_full_name(),
2018-01-31 02:27:59 +00:00
'asso_name': AssoOption.get_cached_value('name'),
'asso_email': AssoOption.get_cached_value('contact'),
2017-10-14 18:18:12 +00:00
'welcome_mail_fr': mailmessageoptions.welcome_mail_fr,
'welcome_mail_en': mailmessageoptions.welcome_mail_en,
'pseudo': self.pseudo,
})
2018-04-03 02:58:00 +00:00
send_mail(
'Bienvenue au %(name)s / Welcome to %(name)s' % {
'name': AssoOption.get_cached_value('name')
},
2018-04-03 02:58:00 +00:00
'',
GeneralOption.get_cached_value('email_from'),
[self.email],
html_message=template.render(context)
)
return
def reset_passwd_mail(self, request):
2017-10-14 18:18:12 +00:00
""" Prend en argument un request, envoie un mail de
réinitialisation de mot de pass """
req = Request()
req.type = Request.PASSWD
req.user = self
req.save()
2017-10-14 18:18:12 +00:00
template = loader.get_template('users/email_passwd_request')
context = {
'name': req.user.get_full_name(),
2018-01-31 02:27:59 +00:00
'asso': AssoOption.get_cached_value('name'),
'asso_mail': AssoOption.get_cached_value('contact'),
'site_name': GeneralOption.get_cached_value('site_name'),
'url': request.build_absolute_uri(
2018-04-14 01:25:05 +00:00
reverse('users:process', kwargs={'token': req.token})
),
'expire_in': str(
GeneralOption.get_cached_value('req_expire_hrs')
2019-01-08 23:40:59 +00:00
) + ' hours',
2018-04-14 01:25:05 +00:00
}
2018-04-03 02:58:00 +00:00
send_mail(
2018-04-14 01:25:05 +00:00
'Changement de mot de passe du %(name)s / Password renewal for '
'%(name)s' % {'name': AssoOption.get_cached_value('name')},
2018-04-03 02:58:00 +00:00
template.render(context),
GeneralOption.get_cached_value('email_from'),
[req.user.email],
fail_silently=False
)
return
2017-09-14 16:15:14 +00:00
def autoregister_machine(self, mac_address, nas_type):
2017-10-14 18:18:12 +00:00
""" Fonction appellée par freeradius. Enregistre la mac pour
une machine inconnue sur le compte de l'user"""
2018-12-30 23:13:01 +00:00
allowed, _message = Machine.can_create(self, self.id)
if not allowed:
2018-08-15 17:15:26 +00:00
return False, _("Maximum number of registered machines reached.")
2017-09-14 16:15:14 +00:00
if not nas_type:
2018-08-15 17:15:26 +00:00
return False, _("Re2o doesn't know wich machine type to assign.")
2017-09-14 16:15:14 +00:00
machine_type_cible = nas_type.machine_type
try:
machine_parent = Machine()
machine_parent.user = self
interface_cible = Interface()
interface_cible.mac_address = mac_address
interface_cible.type = machine_type_cible
interface_cible.clean()
machine_parent.clean()
domain = Domain()
domain.name = self.get_next_domain_name()
domain.interface_parent = interface_cible
domain.clean()
2017-09-11 01:37:01 +00:00
machine_parent.save()
interface_cible.machine = machine_parent
interface_cible.save()
domain.interface_parent = interface_cible
domain.clean()
domain.save()
2017-10-25 23:59:05 +00:00
self.notif_auto_newmachine(interface_cible)
2017-10-14 18:18:12 +00:00
except Exception as error:
return False, traceback.format_exc()
2019-01-08 23:40:59 +00:00
return interface_cible, _("OK")
2017-10-25 23:59:05 +00:00
def notif_auto_newmachine(self, interface):
"""Notification mail lorsque une machine est automatiquement
ajoutée par le radius"""
template = loader.get_template('users/email_auto_newmachine')
context = Context({
'nom': self.get_full_name(),
2018-04-14 01:25:05 +00:00
'mac_address': interface.mac_address,
2018-01-31 02:27:59 +00:00
'asso_name': AssoOption.get_cached_value('name'),
2018-04-14 01:25:05 +00:00
'interface_name': interface.domain,
2018-01-31 02:27:59 +00:00
'asso_email': AssoOption.get_cached_value('contact'),
2017-10-25 23:59:05 +00:00
'pseudo': self.pseudo,
})
send_mail(
"Ajout automatique d'une machine / New machine autoregistered",
'',
GeneralOption.get_cached_value('email_from'),
2017-10-25 23:59:05 +00:00
[self.email],
html_message=template.render(context)
)
return
def set_password(self, password):
2017-10-14 18:18:12 +00:00
""" A utiliser de préférence, set le password en hash courrant et
2017-10-04 15:53:30 +00:00
dans la version ntlm"""
super().set_password(password)
self.pwd_ntlm = hashNT(password)
return
@cached_property
2018-08-01 11:06:25 +00:00
def email_address(self):
2018-07-30 15:00:41 +00:00
if (OptionalUser.get_cached_value('local_email_accounts_enabled')
and self.local_email_enabled):
2018-08-01 11:06:25 +00:00
return self.emailaddress_set.all()
return EMailAddress.objects.none()
def get_next_domain_name(self):
"""Look for an available name for a new interface for
this user by trying "pseudo0", "pseudo1", "pseudo2", ...
2017-10-14 18:18:12 +00:00
Recherche un nom disponible, pour une machine. Doit-être
unique, concatène le nom, le pseudo et le numero de machine
"""
def simple_pseudo():
2017-10-14 18:18:12 +00:00
"""Renvoie le pseudo sans underscore (compat dns)"""
return self.pseudo.replace('_', '-').lower()
2017-10-14 18:18:12 +00:00
def composed_pseudo(name):
"""Renvoie le resultat de simplepseudo et rajoute le nom"""
return simple_pseudo() + str(name)
num = 0
2017-10-14 18:18:12 +00:00
while Domain.objects.filter(name=composed_pseudo(num)):
num += 1
return composed_pseudo(num)
2018-04-14 23:16:49 +00:00
def can_edit(self, user_request, *_args, **_kwargs):
"""Check if a user can edit a user object.
:param self: The user which is to be edited.
:param user_request: The user who requests to edit self.
:return: a message and a boolean which is True if self is a club and
2018-04-14 01:25:05 +00:00
user_request one of its member, or if user_request is self, or if
user_request has the 'cableur' right.
"""
if self.is_class_club and user_request.is_class_adherent:
2018-04-14 01:25:05 +00:00
if (self == user_request or
user_request.has_perm('users.change_user') or
user_request.adherent in self.club.administrators.all()):
return True, None
else:
2018-08-15 17:15:26 +00:00
return False, _("You don't have the right to edit this club.")
else:
if self == user_request:
return True, None
elif user_request.has_perm('users.change_all_users'):
return True, None
elif user_request.has_perm('users.change_user'):
if self.groups.filter(listright__critical=True):
2018-08-15 17:15:26 +00:00
return False, (_("User with critical rights, can't be"
" edited."))
elif self == AssoOption.get_cached_value('utilisateur_asso'):
2018-08-15 17:15:26 +00:00
return False, (_("Impossible to edit the organisation's"
" user without the 'change_all_users'"
" right."))
else:
return True, None
elif user_request.has_perm('users.change_all_users'):
return True, None
else:
2018-08-15 17:15:26 +00:00
return False, (_("You don't have the right to edit another"
" user."))
2018-04-14 23:16:49 +00:00
def can_change_password(self, user_request, *_args, **_kwargs):
"""Check if a user can change a user's password
:param self: The user which is to be edited
:param user_request: The user who request to edit self
:returns: a message and a boolean which is True if self is a club
and user_request one of it's admins, or if user_request is self,
or if user_request has the right to change other's password
"""
if self.is_class_club and user_request.is_class_adherent:
2018-04-14 01:25:05 +00:00
if (self == user_request or
user_request.has_perm('users.change_user_password') or
user_request.adherent in self.club.administrators.all()):
return True, None
else:
2018-08-15 17:15:26 +00:00
return False, _("You don't have the right to edit this club.")
else:
2018-04-14 01:25:05 +00:00
if (self == user_request or
user_request.has_perm('users.change_user_groups')):
# Peut éditer les groupes d'un user,
# c'est un privilège élevé, True
return True, None
2018-04-14 01:25:05 +00:00
elif (user_request.has_perm('users.change_user') and
not self.groups.all()):
return True, None
else:
2018-08-15 17:15:26 +00:00
return False, (_("You don't have the right to edit another"
" user."))
2018-04-14 23:16:49 +00:00
def check_selfpasswd(self, user_request, *_args, **_kwargs):
""" Returns (True, None) if user_request is self, else returns
(False, None)
"""
return user_request == self, None
def can_change_room(self, user_request, *_args, **_kwargs):
""" Check if a user can change a room
:param user_request: The user who request
:returns: a message and a boolean which is True if the user has
the right to change a state
"""
if not ((self.pk == user_request.pk and OptionalUser.get_cached_value('self_change_room'))
or user_request.has_perm('users.change_user')):
return False, _("Permission required to change the room.")
else:
return True, None
2017-12-29 18:43:44 +00:00
@staticmethod
2018-04-14 23:16:49 +00:00
def can_change_state(user_request, *_args, **_kwargs):
""" Check if a user can change a state
:param user_request: The user who request
:returns: a message and a boolean which is True if the user has
the right to change a state
"""
2018-04-14 01:25:05 +00:00
return (
user_request.has_perm('users.change_user_state'),
2018-08-15 17:15:26 +00:00
_("Permission required to change the state.")
2018-04-14 01:25:05 +00:00
)
2018-08-13 17:36:57 +00:00
def can_change_shell(self, user_request, *_args, **_kwargs):
2018-04-14 23:16:49 +00:00
""" Check if a user can change a shell
:param user_request: The user who request
:returns: a message and a boolean which is True if the user has
the right to change a shell
"""
if not ((self.pk == user_request.pk and OptionalUser.get_cached_value('self_change_shell'))
2018-08-13 17:36:57 +00:00
or user_request.has_perm('users.change_user_shell')):
2018-08-15 17:15:26 +00:00
return False, _("Permission required to change the shell.")
2018-08-13 17:36:57 +00:00
else:
return True, None
@staticmethod
2018-07-30 15:00:41 +00:00
def can_change_local_email_redirect(user_request, *_args, **_kwargs):
""" Check if a user can change local_email_redirect.
:param user_request: The user who request
:returns: a message and a boolean which is True if the user has
the right to change a redirection
"""
return (
2018-07-30 15:00:41 +00:00
OptionalUser.get_cached_value('local_email_accounts_enabled'),
2018-08-15 17:15:26 +00:00
_("Local email accounts must be enabled.")
)
@staticmethod
2018-07-30 15:00:41 +00:00
def can_change_local_email_enabled(user_request, *_args, **_kwargs):
2018-08-15 17:15:26 +00:00
""" Check if a user can change internal address.
:param user_request: The user who request
:returns: a message and a boolean which is True if the user has
the right to change internal address
"""
return (
2018-07-30 15:00:41 +00:00
OptionalUser.get_cached_value('local_email_accounts_enabled'),
2018-08-15 17:15:26 +00:00
_("Local email accounts must be enabled.")
2018-07-30 15:00:41 +00:00
)
2017-12-29 18:43:44 +00:00
@staticmethod
2018-04-14 23:16:49 +00:00
def can_change_force(user_request, *_args, **_kwargs):
""" Check if a user can change a force
:param user_request: The user who request
:returns: a message and a boolean which is True if the user has
the right to change a force
"""
2018-04-14 01:25:05 +00:00
return (
user_request.has_perm('users.change_user_force'),
2018-08-15 17:15:26 +00:00
_("Permission required to force the move.")
2018-04-14 01:25:05 +00:00
)
2017-12-31 19:53:38 +00:00
@staticmethod
2018-04-14 23:16:49 +00:00
def can_change_groups(user_request, *_args, **_kwargs):
""" Check if a user can change a group
:param user_request: The user who request
:returns: a message and a boolean which is True if the user has
the right to change a group
"""
2018-04-14 01:25:05 +00:00
return (
user_request.has_perm('users.change_user_groups'),
2018-08-15 17:15:26 +00:00
_("Permission required to edit the user's groups of rights.")
2018-04-14 01:25:05 +00:00
)
2018-05-03 12:22:52 +00:00
@staticmethod
def can_change_is_superuser(user_request, *_args, **_kwargs):
""" Check if an user can change a is_superuser flag
:param user_request: The user who request
:returns: a message and a boolean which is True if permission is granted.
"""
return (
user_request.is_superuser,
2018-08-15 17:15:26 +00:00
_("'superuser' right required to edit the superuser flag.")
2018-05-03 12:22:52 +00:00
)
2018-04-14 23:16:49 +00:00
def can_view(self, user_request, *_args, **_kwargs):
"""Check if an user can view an user object.
:param self: The targeted user.
:param user_request: The user who ask for viewing the target.
:return: A boolean telling if the acces is granted and an explanation
2018-04-14 01:25:05 +00:00
text
"""
if self.is_class_club and user_request.is_class_adherent:
2018-04-14 01:25:05 +00:00
if (self == user_request or
user_request.has_perm('users.view_user') or
user_request.adherent in self.club.administrators.all() or
user_request.adherent in self.club.members.all()):
return True, None
else:
2018-08-15 17:15:26 +00:00
return False, _("You don't have the right to view this club.")
else:
2018-04-14 01:25:05 +00:00
if (self == user_request or
user_request.has_perm('users.view_user')):
return True, None
else:
2018-08-15 17:15:26 +00:00
return False, (_("You don't have the right to view another"
" user."))
2018-04-14 23:16:49 +00:00
@staticmethod
def can_view_all(user_request, *_args, **_kwargs):
"""Check if an user can access to the list of every user objects
:param user_request: The user who wants to view the list.
2018-04-14 01:25:05 +00:00
:return: True if the user can view the list and an explanation
message.
"""
2018-04-14 01:25:05 +00:00
return (
user_request.has_perm('users.view_user'),
2018-08-15 17:15:26 +00:00
_("You don't have the right to view the list of users.")
2018-04-14 01:25:05 +00:00
)
2018-04-14 23:16:49 +00:00
def can_delete(self, user_request, *_args, **_kwargs):
"""Check if an user can delete an user object.
:param self: The user who is to be deleted.
:param user_request: The user who requests deletion.
2018-04-14 01:25:05 +00:00
:return: True if user_request has the right 'bureau', and a
message.
"""
2018-04-14 01:25:05 +00:00
return (
user_request.has_perm('users.delete_user'),
2018-08-15 17:15:26 +00:00
_("You don't have the right to delete this user.")
2018-04-14 01:25:05 +00:00
)
def __init__(self, *args, **kwargs):
super(User, self).__init__(*args, **kwargs)
self.field_permissions = {
2018-04-14 01:25:05 +00:00
'shell': self.can_change_shell,
'force': self.can_change_force,
'selfpasswd': self.check_selfpasswd,
2018-07-30 15:00:41 +00:00
'local_email_redirect': self.can_change_local_email_redirect,
'local_email_enabled': self.can_change_local_email_enabled,
'room': self.can_change_room,
}
2018-07-19 18:37:01 +00:00
self.__original_state = self.state
def clean(self, *args, **kwargs):
"""Check if this pseudo is already used by any mailalias.
Better than raising an error in post-save and catching it"""
2018-08-01 11:06:25 +00:00
if (EMailAddress.objects
.filter(local_part=self.pseudo.lower()).exclude(user_id=self.id)
):
2019-01-08 23:40:59 +00:00
raise ValidationError(_("This username is already used."))
2019-03-17 02:00:28 +00:00
if not self.local_email_enabled and not self.email and not (self.state == self.STATE_FULL_ARCHIVE):
raise ValidationError(_("There is neither a local email address nor an external"
2018-08-15 17:15:26 +00:00
" email address for this user.")
)
if self.local_email_redirect and not self.email:
raise ValidationError(_("You can't redirect your local emails if no external email"
" address has been set.")
)
def __str__(self):
return self.pseudo
2016-06-30 01:39:07 +00:00
2018-07-30 15:00:41 +00:00
class Adherent(User):
2018-04-14 23:16:49 +00:00
""" A class representing a member (it's a user with special
informations) """
2018-08-15 17:15:26 +00:00
name = models.CharField(max_length=255)
room = models.OneToOneField(
'topologie.Room',
on_delete=models.PROTECT,
blank=True,
null=True
)
2018-08-11 01:58:03 +00:00
gpg_fingerprint = models.CharField(
max_length=49,
2018-08-11 01:58:03 +00:00
blank=True,
null=True,
)
class Meta(User.Meta):
2018-08-15 17:15:26 +00:00
verbose_name = _("member")
verbose_name_plural = _("members")
def format_gpgfp(self):
"""Format gpg finger print as AAAA BBBB... from a string AAAABBBB...."""
self.gpg_fingerprint = ' '.join([self.gpg_fingerprint[i:i + 4] for i in range(0, len(self.gpg_fingerprint), 4)])
def validate_gpgfp(self):
"""Validate from raw entry if is it a valid gpg fp"""
if self.gpg_fingerprint:
gpg_fingerprint = self.gpg_fingerprint.replace(' ', '').upper()
2018-12-28 22:23:05 +00:00
if not re.match("^[0-9A-F]{40}$", gpg_fingerprint):
2019-01-08 23:40:59 +00:00
raise ValidationError(_("A GPG fingerprint must contain 40 hexadecimal characters"))
self.gpg_fingerprint = gpg_fingerprint
2018-04-14 23:16:49 +00:00
@classmethod
def get_instance(cls, adherentid, *_args, **_kwargs):
"""Try to find an instance of `Adherent` with the given id.
:param adherentid: The id of the adherent we are looking for.
:return: An adherent.
"""
2018-04-14 23:16:49 +00:00
return cls.objects.get(pk=adherentid)
2018-04-14 23:16:49 +00:00
@staticmethod
def can_create(user_request, *_args, **_kwargs):
"""Check if an user can create an user object.
:param user_request: The user who wants to create a user object.
:return: a message and a boolean which is True if the user can create
2018-04-14 01:25:05 +00:00
a user or if the `options.all_can_create` is set.
"""
2018-04-14 01:25:05 +00:00
if (not user_request.is_authenticated and
not OptionalUser.get_cached_value('self_adhesion')):
return False, None
else:
2018-04-14 01:25:05 +00:00
if (OptionalUser.get_cached_value('all_can_create_adherent') or
OptionalUser.get_cached_value('self_adhesion')):
return True, None
else:
2018-04-14 01:25:05 +00:00
return (
user_request.has_perm('users.add_user'),
2018-08-15 17:15:26 +00:00
_("You don't have the right to create a user.")
2018-04-14 01:25:05 +00:00
)
def clean(self, *args, **kwargs):
"""Format the GPG fingerprint"""
super(Adherent, self).clean(*args, **kwargs)
if self.gpg_fingerprint:
self.validate_gpgfp()
self.format_gpgfp()
class Club(User):
2018-04-14 23:16:49 +00:00
""" A class representing a club (it is considered as a user
with special informations) """
2018-08-15 17:15:26 +00:00
room = models.ForeignKey(
'topologie.Room',
on_delete=models.PROTECT,
blank=True,
null=True
)
administrators = models.ManyToManyField(
blank=True,
to='users.Adherent',
related_name='club_administrator'
)
members = models.ManyToManyField(
blank=True,
to='users.Adherent',
related_name='club_members'
)
mailing = models.BooleanField(
2018-04-14 01:25:05 +00:00
default=False
)
class Meta(User.Meta):
2018-08-15 17:15:26 +00:00
verbose_name = _("club")
verbose_name_plural = _("clubs")
2018-04-14 23:16:49 +00:00
@staticmethod
def can_create(user_request, *_args, **_kwargs):
"""Check if an user can create an user object.
:param user_request: The user who wants to create a user object.
:return: a message and a boolean which is True if the user can create
2018-04-14 01:25:05 +00:00
an user or if the `options.all_can_create` is set.
"""
if not user_request.is_authenticated:
return False, None
else:
if OptionalUser.get_cached_value('all_can_create_club'):
return True, None
else:
2018-04-14 01:25:05 +00:00
return (
user_request.has_perm('users.add_user'),
2018-08-15 17:15:26 +00:00
_("You don't have the right to create a club.")
2018-04-14 01:25:05 +00:00
)
2018-04-14 23:16:49 +00:00
@staticmethod
def can_view_all(user_request, *_args, **_kwargs):
2017-12-28 15:10:34 +00:00
"""Check if an user can access to the list of every user objects
:param user_request: The user who wants to view the list.
2018-04-14 01:25:05 +00:00
:return: True if the user can view the list and an explanation
message.
2017-12-28 15:10:34 +00:00
"""
2017-12-31 19:53:38 +00:00
if user_request.has_perm('users.view_user'):
2017-12-28 15:10:34 +00:00
return True, None
2018-04-14 01:25:05 +00:00
if (hasattr(user_request, 'is_class_adherent') and
user_request.is_class_adherent):
if (user_request.adherent.club_administrator.all() or
user_request.adherent.club_members.all()):
2017-12-28 15:10:34 +00:00
return True, None
2018-08-15 17:15:26 +00:00
return False, _("You don't have the right to view the list of users.")
2017-12-28 15:10:34 +00:00
2018-04-14 23:16:49 +00:00
@classmethod
def get_instance(cls, clubid, *_args, **_kwargs):
"""Try to find an instance of `Club` with the given id.
:param clubid: The id of the adherent we are looking for.
:return: A club.
"""
2018-04-14 23:16:49 +00:00
return cls.objects.get(pk=clubid)
2017-10-26 22:37:16 +00:00
@receiver(post_save, sender=Adherent)
@receiver(post_save, sender=Club)
@receiver(post_save, sender=User)
2018-04-15 01:00:05 +00:00
def user_post_save(**kwargs):
2017-10-04 15:53:30 +00:00
""" Synchronisation post_save : envoie le mail de bienvenue si creation
Synchronise le pseudo, en créant un alias mail correspondant
2017-10-04 15:53:30 +00:00
Synchronise le ldap"""
2018-06-22 21:41:15 +00:00
is_created = kwargs['created']
2016-11-20 15:53:59 +00:00
user = kwargs['instance']
EMailAddress.objects.get_or_create(
local_part=user.pseudo.lower(), user=user)
2018-06-22 21:41:15 +00:00
if is_created:
user.notif_inscription()
2018-07-19 18:37:01 +00:00
user.state_sync()
2018-04-14 01:25:05 +00:00
user.ldap_sync(
base=True,
access_refresh=True,
mac_refresh=False,
group_refresh=True
)
2017-09-14 18:03:28 +00:00
regen('mailing')
2017-10-14 18:18:12 +00:00
@receiver(m2m_changed, sender=User.groups.through)
def user_group_relation_changed(**kwargs):
action = kwargs['action']
if action in ('post_add', 'post_remove', 'post_clear'):
user = kwargs['instance']
user.ldap_sync(base=False,
access_refresh=False,
mac_refresh=False,
group_refresh=True)
2017-10-26 22:37:16 +00:00
@receiver(post_delete, sender=Adherent)
@receiver(post_delete, sender=Club)
@receiver(post_delete, sender=User)
2018-04-15 01:00:05 +00:00
def user_post_delete(**kwargs):
2017-10-14 18:18:12 +00:00
"""Post delete d'un user, on supprime son instance ldap"""
user = kwargs['instance']
2016-11-20 15:53:59 +00:00
user.ldap_del()
2017-09-14 18:03:28 +00:00
regen('mailing')
2018-04-14 01:25:05 +00:00
class ServiceUser(RevMixin, AclMixin, AbstractBaseUser):
2017-10-04 15:53:30 +00:00
""" Classe des users daemons, règle leurs accès au ldap"""
2017-06-18 12:59:53 +00:00
readonly = 'readonly'
ACCESS = (
2017-10-14 18:18:12 +00:00
('auth', 'auth'),
('readonly', 'readonly'),
('usermgmt', 'usermgmt'),
)
2017-06-18 12:59:53 +00:00
2017-10-14 18:18:12 +00:00
pseudo = models.CharField(
max_length=32,
unique=True,
2018-08-15 17:15:26 +00:00
help_text=_("Must only contain letters, numerals or dashes."),
2017-10-14 18:18:12 +00:00
validators=[linux_user_validator]
)
access_group = models.CharField(
choices=ACCESS,
default=readonly,
max_length=32
)
comment = models.CharField(
2018-08-15 17:15:26 +00:00
help_text=_("Comment"),
2017-10-14 18:18:12 +00:00
max_length=255,
blank=True
)
2016-07-31 01:36:54 +00:00
USERNAME_FIELD = 'pseudo'
objects = UserManager()
2017-12-31 19:53:38 +00:00
class Meta:
permissions = (
2018-08-15 17:15:26 +00:00
("view_serviceuser", _("Can view a service user object")),
2017-12-31 19:53:38 +00:00
)
2018-08-15 17:15:26 +00:00
verbose_name = _("service user")
verbose_name_plural = _("service users")
2017-12-31 19:53:38 +00:00
2018-04-14 23:16:49 +00:00
def get_full_name(self):
""" Renvoie le nom complet du serviceUser formaté nom/prénom"""
2018-08-15 17:15:26 +00:00
return _("Service user <{name}>").format(name=self.pseudo)
2018-04-14 23:16:49 +00:00
def get_short_name(self):
""" Renvoie seulement le nom"""
return self.pseudo
2016-07-31 01:36:54 +00:00
def ldap_sync(self):
2017-10-04 15:53:30 +00:00
""" Synchronisation du ServiceUser dans sa version ldap"""
2016-07-31 01:36:54 +00:00
try:
user_ldap = LdapServiceUser.objects.get(name=self.pseudo)
except LdapServiceUser.DoesNotExist:
user_ldap = LdapServiceUser(name=self.pseudo)
2017-06-18 12:59:53 +00:00
user_ldap.user_password = self.password[:6] + self.password[7:]
2016-07-31 01:36:54 +00:00
user_ldap.save()
2017-06-18 12:59:53 +00:00
self.serviceuser_group_sync()
2016-07-31 01:36:54 +00:00
def ldap_del(self):
2017-10-14 18:18:12 +00:00
"""Suppression de l'instance ldap d'un service user"""
2016-07-31 01:36:54 +00:00
try:
user_ldap = LdapServiceUser.objects.get(name=self.pseudo)
user_ldap.delete()
except LdapUser.DoesNotExist:
pass
2017-06-18 12:59:53 +00:00
self.serviceuser_group_sync()
def serviceuser_group_sync(self):
2017-10-14 18:18:12 +00:00
"""Synchronise le groupe et les droits de groupe dans le ldap"""
2017-06-18 12:59:53 +00:00
try:
group = LdapServiceUserGroup.objects.get(name=self.access_group)
except:
group = LdapServiceUserGroup(name=self.access_group)
2017-10-14 18:18:12 +00:00
group.members = list(LdapServiceUser.objects.filter(
name__in=[user.pseudo for user in ServiceUser.objects.filter(
access_group=self.access_group
)]).values_list('dn', flat=True))
2017-06-18 12:59:53 +00:00
group.save()
2016-07-31 01:36:54 +00:00
def __str__(self):
return self.pseudo
2017-10-14 18:18:12 +00:00
2018-04-14 01:25:05 +00:00
2016-07-31 01:36:54 +00:00
@receiver(post_save, sender=ServiceUser)
2018-04-15 01:00:05 +00:00
def service_user_post_save(**kwargs):
2017-10-04 15:53:30 +00:00
""" Synchronise un service user ldap après modification django"""
2016-07-31 01:36:54 +00:00
service_user = kwargs['instance']
2017-06-18 12:59:53 +00:00
service_user.ldap_sync()
2016-07-31 01:36:54 +00:00
2017-10-14 18:18:12 +00:00
2016-07-31 01:36:54 +00:00
@receiver(post_delete, sender=ServiceUser)
2018-04-15 01:00:05 +00:00
def service_user_post_delete(**kwargs):
2017-10-04 15:53:30 +00:00
""" Supprime un service user ldap après suppression django"""
2016-07-31 01:36:54 +00:00
service_user = kwargs['instance']
2017-06-18 12:59:53 +00:00
service_user.ldap_del()
2016-07-31 01:36:54 +00:00
2017-10-14 18:18:12 +00:00
class School(RevMixin, AclMixin, models.Model):
2017-10-04 15:53:30 +00:00
""" Etablissement d'enseignement"""
2016-06-30 01:39:07 +00:00
name = models.CharField(max_length=255)
2017-12-31 19:53:38 +00:00
class Meta:
permissions = (
2018-08-15 17:15:26 +00:00
("view_school", _("Can view a school object")),
2017-12-31 19:53:38 +00:00
)
2018-08-15 17:15:26 +00:00
verbose_name = _("school")
verbose_name_plural = _("schools")
2017-12-31 19:53:38 +00:00
def __str__(self):
return self.name
class ListRight(RevMixin, AclMixin, Group):
2017-10-14 18:18:12 +00:00
""" Ensemble des droits existants. Chaque droit crée un groupe
ldap synchronisé, avec gid.
2017-10-04 15:53:30 +00:00
Permet de gérer facilement les accès serveurs et autres
2017-10-14 18:18:12 +00:00
La clef de recherche est le gid, pour cette raison
il n'est plus modifiable après creation"""
unix_name = models.CharField(
2017-10-14 18:18:12 +00:00
max_length=255,
unique=True,
validators=[RegexValidator(
'^[a-z]+$',
2018-08-15 17:15:26 +00:00
message=(_("UNIX groups can only contain lower case letters."))
2017-10-14 18:18:12 +00:00
)]
)
gid = models.PositiveIntegerField(unique=True, null=True)
critical = models.BooleanField(default=False)
2017-10-14 18:18:12 +00:00
details = models.CharField(
2018-08-15 17:15:26 +00:00
help_text=_("Description"),
2017-10-14 18:18:12 +00:00
max_length=255,
blank=True
)
2017-12-31 19:53:38 +00:00
class Meta:
permissions = (
2018-08-15 17:15:26 +00:00
("view_listright", _("Can view a group of rights object")),
2017-12-31 19:53:38 +00:00
)
2018-08-15 17:15:26 +00:00
verbose_name = _("group of rights")
verbose_name_plural = _("groups of rights")
2017-12-31 19:53:38 +00:00
def __str__(self):
return self.name
def ldap_sync(self):
2017-10-14 18:18:12 +00:00
"""Sychronise les groups ldap avec le model listright coté django"""
try:
group_ldap = LdapUserGroup.objects.get(gid=self.gid)
except LdapUserGroup.DoesNotExist:
group_ldap = LdapUserGroup(gid=self.gid)
group_ldap.name = self.unix_name
2017-12-31 16:11:19 +00:00
group_ldap.members = [user.pseudo for user
in self.user_set.all()]
group_ldap.save()
def ldap_del(self):
2017-10-14 18:18:12 +00:00
"""Supprime un groupe ldap"""
try:
group_ldap = LdapUserGroup.objects.get(gid=self.gid)
group_ldap.delete()
except LdapUserGroup.DoesNotExist:
pass
2017-10-14 18:18:12 +00:00
@receiver(post_save, sender=ListRight)
2018-04-15 01:00:05 +00:00
def listright_post_save(**kwargs):
2017-10-04 15:53:30 +00:00
""" Synchronise le droit ldap quand il est modifié"""
right = kwargs['instance']
2016-11-20 15:53:59 +00:00
right.ldap_sync()
2017-10-14 18:18:12 +00:00
@receiver(post_delete, sender=ListRight)
2018-04-15 01:00:05 +00:00
def listright_post_delete(**kwargs):
2017-10-14 18:18:12 +00:00
"""Suppression d'un groupe ldap après suppression coté django"""
right = kwargs['instance']
2016-11-20 15:53:59 +00:00
right.ldap_del()
2017-10-14 18:18:12 +00:00
class ListShell(RevMixin, AclMixin, models.Model):
2017-10-14 18:18:12 +00:00
"""Un shell possible. Pas de check si ce shell existe, les
admin sont des grands"""
shell = models.CharField(max_length=255, unique=True)
class Meta:
permissions = (
2018-08-15 17:15:26 +00:00
("view_listshell", _("Can view a shell object")),
)
2018-08-15 17:15:26 +00:00
verbose_name = _("shell")
verbose_name_plural = _("shells")
2018-03-22 00:38:16 +00:00
def get_pretty_name(self):
"""Return the canonical name of the shell"""
return self.shell.split("/")[-1]
def __str__(self):
return self.shell
2017-10-14 18:18:12 +00:00
class Ban(RevMixin, AclMixin, models.Model):
2017-10-04 15:53:30 +00:00
""" Bannissement. Actuellement a un effet tout ou rien.
Gagnerait à être granulaire"""
2017-03-06 01:28:16 +00:00
STATE_HARD = 0
STATE_SOFT = 1
STATE_BRIDAGE = 2
STATES = (
2018-08-15 17:15:26 +00:00
(0, _("HARD (no access)")),
(1, _("SOFT (local access only)")),
(2, _("RESTRICTED (speed limitation)")),
2017-10-14 18:18:12 +00:00
)
2017-03-06 01:28:16 +00:00
2016-07-02 19:57:31 +00:00
user = models.ForeignKey('User', on_delete=models.PROTECT)
raison = models.CharField(max_length=255)
date_start = models.DateTimeField(auto_now_add=True)
date_end = models.DateTimeField()
2017-10-14 18:18:12 +00:00
state = models.IntegerField(choices=STATES, default=STATE_HARD)
2016-07-02 19:57:31 +00:00
2017-12-31 19:53:38 +00:00
class Meta:
permissions = (
2018-08-15 17:15:26 +00:00
("view_ban", _("Can view a ban object")),
2017-12-31 19:53:38 +00:00
)
2018-08-15 17:15:26 +00:00
verbose_name = _("ban")
verbose_name_plural = _("bans")
2017-12-31 19:53:38 +00:00
def notif_ban(self):
""" Prend en argument un objet ban, envoie un mail de notification """
2017-10-14 18:18:12 +00:00
template = loader.get_template('users/email_ban_notif')
context = Context({
'name': self.user.get_full_name(),
'raison': self.raison,
'date_end': self.date_end,
2018-01-31 02:27:59 +00:00
'asso_name': AssoOption.get_cached_value('name'),
})
2018-04-03 02:58:00 +00:00
send_mail(
2019-01-08 23:40:59 +00:00
'Déconnexion disciplinaire / Disciplinary disconnection',
2018-04-03 02:58:00 +00:00
template.render(context),
GeneralOption.get_cached_value('email_from'),
[self.user.email],
fail_silently=False
)
return
2017-09-19 02:45:33 +00:00
def is_active(self):
2017-10-14 18:18:12 +00:00
"""Ce ban est-il actif?"""
2018-01-10 20:20:54 +00:00
return self.date_end > timezone.now()
2017-09-19 02:45:33 +00:00
2018-04-14 23:16:49 +00:00
def can_view(self, user_request, *_args, **_kwargs):
"""Check if an user can view a Ban object.
:param self: The targeted object.
:param user_request: The user who ask for viewing the target.
:return: A boolean telling if the acces is granted and an explanation
text
"""
2018-04-14 01:25:05 +00:00
if (not user_request.has_perm('users.view_ban') and
self.user != user_request):
2018-08-15 17:15:26 +00:00
return False, (_("You don't have the right to view bans other"
" than yours."))
else:
return True, None
2016-07-02 19:57:31 +00:00
def __str__(self):
return str(self.user) + ' ' + str(self.raison)
2017-10-14 18:18:12 +00:00
2016-11-20 15:53:59 +00:00
@receiver(post_save, sender=Ban)
2018-04-15 01:00:05 +00:00
def ban_post_save(**kwargs):
2017-10-04 15:53:30 +00:00
""" Regeneration de tous les services après modification d'un ban"""
2016-11-20 15:53:59 +00:00
ban = kwargs['instance']
is_created = kwargs['created']
2016-11-20 15:53:59 +00:00
user = ban.user
user.ldap_sync(base=False, access_refresh=True, mac_refresh=False)
2017-09-14 18:03:28 +00:00
regen('mailing')
if is_created:
ban.notif_ban()
regen('dhcp')
regen('mac_ip_list')
if user.has_access():
regen('dhcp')
regen('mac_ip_list')
2016-11-20 15:53:59 +00:00
2017-10-14 18:18:12 +00:00
2016-11-20 15:53:59 +00:00
@receiver(post_delete, sender=Ban)
2018-04-15 01:00:05 +00:00
def ban_post_delete(**kwargs):
2017-10-04 15:53:30 +00:00
""" Regen de tous les services après suppression d'un ban"""
2016-11-20 15:53:59 +00:00
user = kwargs['instance'].user
user.ldap_sync(base=False, access_refresh=True, mac_refresh=False)
2017-09-14 18:03:28 +00:00
regen('mailing')
regen('dhcp')
regen('mac_ip_list')
2017-10-14 18:18:12 +00:00
class Whitelist(RevMixin, AclMixin, models.Model):
2017-10-14 18:18:12 +00:00
"""Accès à titre gracieux. L'utilisateur ne paye pas; se voit
accorder un accès internet pour une durée défini. Moins
fort qu'un ban quel qu'il soit"""
2016-07-04 18:04:11 +00:00
user = models.ForeignKey('User', on_delete=models.PROTECT)
raison = models.CharField(max_length=255)
date_start = models.DateTimeField(auto_now_add=True)
date_end = models.DateTimeField()
2016-07-04 18:04:11 +00:00
2017-12-31 19:53:38 +00:00
class Meta:
permissions = (
2018-08-15 17:15:26 +00:00
("view_whitelist", _("Can view a whitelist object")),
2017-12-31 19:53:38 +00:00
)
2018-08-15 17:15:26 +00:00
verbose_name = _("whitelist (free of charge access)")
verbose_name_plural = _("whitelists (free of charge access)")
2017-12-31 19:53:38 +00:00
2017-09-19 02:45:33 +00:00
def is_active(self):
2018-04-14 23:16:49 +00:00
""" Is this whitelisting active ? """
2018-01-10 20:20:54 +00:00
return self.date_end > timezone.now()
2017-09-19 02:45:33 +00:00
2018-04-14 23:16:49 +00:00
def can_view(self, user_request, *_args, **_kwargs):
"""Check if an user can view a Whitelist object.
:param self: The targeted object.
:param user_request: The user who ask for viewing the target.
:return: A boolean telling if the acces is granted and an explanation
text
"""
2018-04-14 01:25:05 +00:00
if (not user_request.has_perm('users.view_whitelist') and
self.user != user_request):
2018-08-15 17:15:26 +00:00
return False, (_("You don't have the right to view whitelists"
" other than yours."))
else:
return True, None
2016-07-04 18:04:11 +00:00
def __str__(self):
return str(self.user) + ' ' + str(self.raison)
2017-10-14 18:18:12 +00:00
2016-11-20 15:53:59 +00:00
@receiver(post_save, sender=Whitelist)
2018-04-15 01:00:05 +00:00
def whitelist_post_save(**kwargs):
2017-10-14 18:18:12 +00:00
"""Après modification d'une whitelist, on synchronise les services
et on lui permet d'avoir internet"""
2016-11-20 15:53:59 +00:00
whitelist = kwargs['instance']
user = whitelist.user
user.ldap_sync(base=False, access_refresh=True, mac_refresh=False)
is_created = kwargs['created']
2017-09-14 18:03:28 +00:00
regen('mailing')
if is_created:
regen('dhcp')
regen('mac_ip_list')
if user.has_access():
regen('dhcp')
regen('mac_ip_list')
2016-11-20 15:53:59 +00:00
2017-10-14 18:18:12 +00:00
2016-11-20 15:53:59 +00:00
@receiver(post_delete, sender=Whitelist)
2018-04-15 01:00:05 +00:00
def whitelist_post_delete(**kwargs):
2017-10-14 18:18:12 +00:00
"""Après suppression d'une whitelist, on supprime l'accès internet
en forçant la régénration"""
2016-11-20 15:53:59 +00:00
user = kwargs['instance'].user
user.ldap_sync(base=False, access_refresh=True, mac_refresh=False)
2017-09-14 18:03:28 +00:00
regen('mailing')
regen('dhcp')
regen('mac_ip_list')
2016-11-20 15:53:59 +00:00
2017-10-14 18:18:12 +00:00
class Request(models.Model):
2017-10-04 15:53:30 +00:00
""" Objet request, générant une url unique de validation.
2017-10-14 18:18:12 +00:00
Utilisé par exemple pour la generation du mot de passe et
2017-10-04 15:53:30 +00:00
sa réinitialisation"""
PASSWD = 'PW'
EMAIL = 'EM'
TYPE_CHOICES = (
2018-08-15 17:15:26 +00:00
(PASSWD, _("Password")),
(EMAIL, _("Email address")),
)
type = models.CharField(max_length=2, choices=TYPE_CHOICES)
token = models.CharField(max_length=32)
user = models.ForeignKey('User', on_delete=models.CASCADE)
created_at = models.DateTimeField(auto_now_add=True, editable=False)
expires_at = models.DateTimeField()
def save(self):
if not self.expires_at:
2018-04-14 01:25:05 +00:00
self.expires_at = (timezone.now() +
datetime.timedelta(
hours=GeneralOption.get_cached_value(
'req_expire_hrs'
)
))
if not self.token:
self.token = str(uuid.uuid4()).replace('-', '') # remove hyphens
super(Request, self).save()
2017-10-14 18:18:12 +00:00
class LdapUser(ldapdb.models.Model):
"""
Class for representing an LDAP user entry.
"""
# LDAP meta-data
base_dn = LDAP['base_user_dn']
2017-10-14 18:18:12 +00:00
object_classes = ['inetOrgPerson', 'top', 'posixAccount',
'sambaSamAccount', 'radiusprofile',
'shadowAccount']
# attributes
gid = ldapdb.models.fields.IntegerField(db_column='gidNumber')
2017-10-14 18:18:12 +00:00
name = ldapdb.models.fields.CharField(
db_column='cn',
max_length=200,
primary_key=True
)
uid = ldapdb.models.fields.CharField(db_column='uid', max_length=200)
2017-10-14 18:18:12 +00:00
uidNumber = ldapdb.models.fields.IntegerField(
db_column='uidNumber',
unique=True
)
sn = ldapdb.models.fields.CharField(db_column='sn', max_length=200)
2017-10-14 18:18:12 +00:00
login_shell = ldapdb.models.fields.CharField(
db_column='loginShell',
max_length=200,
blank=True,
null=True
)
mail = ldapdb.models.fields.CharField(db_column='mail', max_length=200)
given_name = ldapdb.models.fields.CharField(
db_column='givenName',
max_length=200
)
home_directory = ldapdb.models.fields.CharField(
db_column='homeDirectory',
max_length=200
)
display_name = ldapdb.models.fields.CharField(
db_column='displayName',
max_length=200,
blank=True,
null=True
)
dialupAccess = ldapdb.models.fields.CharField(db_column='dialupAccess')
2017-10-14 18:18:12 +00:00
sambaSID = ldapdb.models.fields.IntegerField(
db_column='sambaSID',
unique=True
)
user_password = ldapdb.models.fields.CharField(
db_column='userPassword',
max_length=200,
blank=True,
null=True
)
sambat_nt_password = ldapdb.models.fields.CharField(
db_column='sambaNTPassword',
max_length=200,
blank=True,
null=True
)
macs = ldapdb.models.fields.ListField(
db_column='radiusCallingStationId',
max_length=200,
blank=True,
null=True
)
shadowexpire = ldapdb.models.fields.CharField(
db_column='shadowExpire',
blank=True,
null=True
)
def __str__(self):
return self.name
def __unicode__(self):
return self.name
def save(self, *args, **kwargs):
self.sn = self.name
self.uid = self.name
self.sambaSID = self.uidNumber
super(LdapUser, self).save(*args, **kwargs)
2017-10-14 18:18:12 +00:00
class LdapUserGroup(ldapdb.models.Model):
"""
2017-10-14 18:18:12 +00:00
Class for representing an LDAP group entry.
Un groupe ldap
"""
# LDAP meta-data
base_dn = LDAP['base_usergroup_dn']
object_classes = ['posixGroup']
# attributes
gid = ldapdb.models.fields.IntegerField(db_column='gidNumber')
2018-04-14 01:25:05 +00:00
members = ldapdb.models.fields.ListField(
db_column='memberUid',
blank=True
)
2017-10-14 18:18:12 +00:00
name = ldapdb.models.fields.CharField(
db_column='cn',
max_length=200,
primary_key=True
)
def __str__(self):
return self.name
2017-10-14 18:18:12 +00:00
2016-07-31 01:36:54 +00:00
class LdapServiceUser(ldapdb.models.Model):
"""
Class for representing an LDAP userservice entry.
2017-10-14 18:18:12 +00:00
Un user de service coté ldap
2016-07-31 01:36:54 +00:00
"""
# LDAP meta-data
base_dn = LDAP['base_userservice_dn']
2017-10-14 18:18:12 +00:00
object_classes = ['applicationProcess', 'simpleSecurityObject']
2016-07-31 01:36:54 +00:00
# attributes
2017-10-14 18:18:12 +00:00
name = ldapdb.models.fields.CharField(
db_column='cn',
max_length=200,
primary_key=True
)
user_password = ldapdb.models.fields.CharField(
db_column='userPassword',
max_length=200,
blank=True,
null=True
)
2016-07-31 01:36:54 +00:00
2017-06-18 12:59:53 +00:00
def __str__(self):
return self.name
2017-10-14 18:18:12 +00:00
2017-06-18 12:59:53 +00:00
class LdapServiceUserGroup(ldapdb.models.Model):
"""
Class for representing an LDAP userservice entry.
2017-10-14 18:18:12 +00:00
Un group user de service coté ldap. Dans userservicegroupdn
(voir dans settings_local.py)
2017-06-18 12:59:53 +00:00
"""
# LDAP meta-data
base_dn = LDAP['base_userservicegroup_dn']
object_classes = ['groupOfNames']
# attributes
2017-10-14 18:18:12 +00:00
name = ldapdb.models.fields.CharField(
db_column='cn',
max_length=200,
primary_key=True
)
members = ldapdb.models.fields.ListField(
db_column='member',
blank=True
)
2017-06-18 12:59:53 +00:00
def __str__(self):
return self.name
2018-08-01 11:06:25 +00:00
class EMailAddress(RevMixin, AclMixin, models.Model):
2018-07-30 15:00:41 +00:00
"""Defines a local email account for a user
"""
2018-06-29 14:36:04 +00:00
user = models.ForeignKey(
User,
on_delete=models.CASCADE,
2018-08-15 17:15:26 +00:00
help_text=_("User of the local email account")
)
2018-07-30 15:00:41 +00:00
local_part = models.CharField(
unique=True,
2018-06-30 01:22:46 +00:00
max_length=128,
2018-08-15 17:15:26 +00:00
help_text=_("Local part of the email address")
)
2018-07-30 15:00:41 +00:00
class Meta:
permissions = (
2018-08-15 17:15:26 +00:00
("view_emailaddress", _("Can view a local email account object")),
2018-07-30 15:00:41 +00:00
)
2018-08-15 17:15:26 +00:00
verbose_name = _("local email account")
verbose_name_plural = _("local email accounts")
2018-07-30 15:00:41 +00:00
def __str__(self):
return str(self.local_part) + OptionalUser.get_cached_value('local_email_domain')
2018-07-30 15:00:41 +00:00
@cached_property
def complete_email_address(self):
return str(self.local_part) + OptionalUser.get_cached_value('local_email_domain')
2018-06-30 12:46:35 +00:00
@staticmethod
def can_create(user_request, userid, *_args, **_kwargs):
2018-08-01 11:06:25 +00:00
"""Check if a user can create a `EMailAddress` object.
2018-06-30 12:46:35 +00:00
2018-07-30 15:00:41 +00:00
Args:
user_request: The user who wants to create the object.
userid: The id of the user to whom the account is to be created
Returns:
a message and a boolean which is True if the user can create
a local email account.
2018-06-30 12:46:35 +00:00
"""
2018-08-01 11:06:25 +00:00
if user_request.has_perm('users.add_emailaddress'):
2018-07-30 15:00:41 +00:00
return True, None
if not OptionalUser.get_cached_value('local_email_accounts_enabled'):
2018-08-15 17:15:26 +00:00
return False, _("The local email accounts are not enabled.")
2018-07-30 15:00:41 +00:00
if int(user_request.id) != int(userid):
2018-08-15 17:15:26 +00:00
return False, _("You don't have the right to add a local email"
" account to another user.")
2018-08-01 11:06:25 +00:00
elif user_request.email_address.count() >= OptionalUser.get_cached_value('max_email_address'):
2018-08-15 17:15:26 +00:00
return False, _("You reached the limit of {} local email accounts.").format(
2018-08-01 11:06:25 +00:00
OptionalUser.get_cached_value('max_email_address')
2018-07-30 15:00:41 +00:00
)
2018-06-30 12:46:35 +00:00
return True, None
def can_view(self, user_request, *_args, **_kwargs):
2018-07-30 15:00:41 +00:00
"""Check if a user can view the local email account
2018-07-30 15:00:41 +00:00
Args:
user_request: The user who wants to view the object.
Returns:
a message and a boolean which is True if the user can see
the local email account.
"""
2018-08-01 11:06:25 +00:00
if user_request.has_perm('users.view_emailaddress'):
return True, None
2018-07-30 15:00:41 +00:00
if not OptionalUser.get_cached_value('local_email_accounts_enabled'):
2018-08-15 17:15:26 +00:00
return False, _("The local email accounts are not enabled.")
2018-07-30 15:00:41 +00:00
if user_request == self.user:
return True, None
2018-08-15 17:15:26 +00:00
return False, _("You don't have the right to edit another user's local"
" email account.")
2018-07-30 15:00:41 +00:00
def can_delete(self, user_request, *_args, **_kwargs):
2018-07-30 15:00:41 +00:00
"""Check if a user can delete the alias
Args:
user_request: The user who wants to delete the object.
2018-07-30 15:00:41 +00:00
Returns:
a message and a boolean which is True if the user can delete
the local email account.
"""
2018-08-10 22:13:27 +00:00
if self.local_part == self.user.pseudo.lower():
2018-08-15 17:15:26 +00:00
return False, _("You can't delete a local email account whose"
" local part is the same as the username.")
if user_request.has_perm('users.delete_emailaddress'):
return True, None
2018-07-30 15:00:41 +00:00
if not OptionalUser.get_cached_value('local_email_accounts_enabled'):
2018-08-15 17:15:26 +00:00
return False, _("The local email accounts are not enabled.")
2018-07-30 15:00:41 +00:00
if user_request == self.user:
return True, None
2018-08-15 17:15:26 +00:00
return False, _("You don't have the right to delete another user's"
" local email account")
def can_edit(self, user_request, *_args, **_kwargs):
2018-07-30 15:00:41 +00:00
"""Check if a user can edit the alias
Args:
user_request: The user who wants to edit the object.
2018-07-30 15:00:41 +00:00
Returns:
a message and a boolean which is True if the user can edit
the local email account.
"""
2018-08-10 22:13:27 +00:00
if self.local_part == self.user.pseudo.lower():
2018-08-15 17:15:26 +00:00
return False, _("You can't edit a local email account whose local"
" part is the same as the username.")
2018-08-01 11:06:25 +00:00
if user_request.has_perm('users.change_emailaddress'):
return True, None
2018-07-30 15:00:41 +00:00
if not OptionalUser.get_cached_value('local_email_accounts_enabled'):
2018-08-15 17:15:26 +00:00
return False, _("The local email accounts are not enabled.")
2018-07-30 15:00:41 +00:00
if user_request == self.user:
return True, None
2018-08-15 17:15:26 +00:00
return False, _("You don't have the right to edit another user's local"
" email account.")
2018-06-29 15:45:21 +00:00
def clean(self, *args, **kwargs):
self.local_part = self.local_part.lower()
2018-11-15 16:14:51 +00:00
if "@" in self.local_part or "+" in self.local_part:
raise ValidationError(_("The local part must not contain @ or +."))
result, reason = smtp_check(self.local_part)
if result:
raise ValidationError(reason)
2018-08-01 11:06:25 +00:00
super(EMailAddress, self).clean(*args, **kwargs)