Sith/club/models.py

464 lines
15 KiB
Python
Raw Normal View History

# -*- coding:utf-8 -*
#
# Copyright 2016,2017
# - Skia <skia@libskia.so>
2017-08-16 22:07:19 +00:00
# - Sli <antoine@bartuccio.fr>
#
# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
# http://ae.utbm.fr.
#
# This program is free software; you can redistribute it and/or modify it under
# the terms of the GNU General Public License a published by the Free Software
# Foundation; either version 3 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 Sofware Foundation, Inc., 59 Temple
# Place - Suite 330, Boston, MA 02111-1307, USA.
#
#
from django.db import models
from django.core import validators
from django.conf import settings
from django.utils.translation import ugettext_lazy as _
2017-08-21 17:53:17 +00:00
from django.core.exceptions import ValidationError, ObjectDoesNotExist
2017-06-12 06:54:48 +00:00
from django.db import transaction
from django.core.urlresolvers import reverse
2016-09-02 19:21:57 +00:00
from django.utils import timezone
2017-08-22 20:39:12 +00:00
from django.core.validators import RegexValidator, validate_email
2017-09-19 14:27:48 +00:00
from django.utils.functional import cached_property
2017-09-12 19:10:32 +00:00
from core.models import User, MetaGroup, Group, SithFile, RealGroup, Notification, Page
2017-06-12 06:54:48 +00:00
# Create your models here.
2017-09-12 19:10:32 +00:00
class Club(models.Model):
"""
The Club class, made as a tree to allow nice tidy organization
"""
2018-10-04 19:29:19 +00:00
2017-05-20 10:36:18 +00:00
id = models.AutoField(primary_key=True, db_index=True)
2018-10-04 19:29:19 +00:00
name = models.CharField(_("name"), max_length=64)
parent = models.ForeignKey("Club", related_name="children", null=True, blank=True)
unix_name = models.CharField(
_("unix name"),
max_length=30,
unique=True,
validators=[
validators.RegexValidator(
r"^[a-z0-9][a-z0-9._-]*[a-z0-9]$",
_(
"Enter a valid unix name. This value may contain only "
"letters, numbers ./-/_ characters."
),
)
],
error_messages={"unique": _("A club with that unix name already exists.")},
)
logo = models.ImageField(
upload_to="club_logos", verbose_name=_("logo"), null=True, blank=True
)
is_active = models.BooleanField(_("is active"), default=True)
short_description = models.CharField(
_("short description"), max_length=1000, default="", blank=True, null=True
2017-06-12 06:54:48 +00:00
)
2018-10-04 19:29:19 +00:00
address = models.CharField(_("address"), max_length=254)
# This function prevents generating migration upon settings change
2018-10-04 19:29:19 +00:00
def get_default_owner_group():
return settings.SITH_GROUP_ROOT_ID
owner_group = models.ForeignKey(
Group, related_name="owned_club", default=get_default_owner_group
)
edit_groups = models.ManyToManyField(
Group, related_name="editable_club", blank=True
)
view_groups = models.ManyToManyField(
Group, related_name="viewable_club", blank=True
)
home = models.OneToOneField(
SithFile,
related_name="home_of_club",
verbose_name=_("home"),
null=True,
blank=True,
on_delete=models.SET_NULL,
)
2017-09-12 19:10:32 +00:00
page = models.OneToOneField(Page, related_name="club", blank=True, null=True)
class Meta:
2018-10-04 19:29:19 +00:00
ordering = ["name", "unix_name"]
2017-09-19 14:27:48 +00:00
@cached_property
def president(self):
2018-10-04 19:29:19 +00:00
return self.members.filter(
role=settings.SITH_CLUB_ROLES_ID["President"], end_date=None
).first()
2017-09-19 14:27:48 +00:00
def check_loop(self):
"""Raise a validation error when a loop is found within the parent list"""
objs = []
cur = self
while cur.parent is not None:
if cur in objs:
2018-10-04 19:29:19 +00:00
raise ValidationError(_("You can not make loops in clubs"))
objs.append(cur)
cur = cur.parent
def clean(self):
self.check_loop()
2016-08-10 14:23:12 +00:00
def _change_unixname(self, new_name):
c = Club.objects.filter(unix_name=new_name).first()
if c is None:
if self.home:
self.home.name = new_name
self.home.save()
else:
raise ValidationError(_("A club with that unix_name already exists"))
def make_home(self):
if not self.home:
home_root = SithFile.objects.filter(parent=None, name="clubs").first()
root = User.objects.filter(username="root").first()
if home_root and root:
home = SithFile(parent=home_root, name=self.unix_name, owner=root)
home.save()
self.home = home
self.save()
2017-09-12 19:10:32 +00:00
def make_page(self):
2017-09-13 09:20:55 +00:00
root = User.objects.filter(username="root").first()
2017-09-12 19:10:32 +00:00
if not self.page:
club_root = Page.objects.filter(name=settings.SITH_CLUB_ROOT_PAGE).first()
if root and club_root:
public = Group.objects.filter(id=settings.SITH_GROUP_PUBLIC_ID).first()
p = Page(name=self.unix_name)
p.parent = club_root
2017-09-19 12:48:56 +00:00
p.save(force_lock=True)
2017-09-12 19:10:32 +00:00
if public:
p.view_groups.add(public)
2017-09-19 12:48:56 +00:00
p.save(force_lock=True)
2017-09-13 14:51:34 +00:00
if self.parent and self.parent.page:
p.parent = self.parent.page
2017-09-12 19:10:32 +00:00
self.page = p
self.save()
2017-09-13 09:20:55 +00:00
elif self.page and self.page.name != self.unix_name:
self.page.unset_lock()
self.page.name = self.unix_name
2017-09-19 12:48:56 +00:00
self.page.save(force_lock=True)
2018-10-04 19:29:19 +00:00
elif (
self.page
and self.parent
and self.parent.page
and self.page.parent != self.parent.page
):
2017-09-13 14:51:34 +00:00
self.page.unset_lock()
self.page.parent = self.parent.page
2017-09-19 12:48:56 +00:00
self.page.save(force_lock=True)
2017-09-12 19:10:32 +00:00
2016-08-10 14:23:12 +00:00
def save(self, *args, **kwargs):
with transaction.atomic():
creation = False
2016-08-13 14:08:02 +00:00
old = Club.objects.filter(id=self.id).first()
if not old:
2016-08-10 14:23:12 +00:00
creation = True
else:
if old.unix_name != self.unix_name:
self._change_unixname(self.unix_name)
super(Club, self).save(*args, **kwargs)
if creation:
2017-06-12 06:54:48 +00:00
board = MetaGroup(name=self.unix_name + settings.SITH_BOARD_SUFFIX)
2016-08-10 14:23:12 +00:00
board.save()
2017-06-12 06:54:48 +00:00
member = MetaGroup(name=self.unix_name + settings.SITH_MEMBER_SUFFIX)
2016-08-10 14:23:12 +00:00
member.save()
2018-10-04 19:29:19 +00:00
subscribers = Group.objects.filter(
name=settings.SITH_MAIN_MEMBERS_GROUP
).first()
2016-08-10 14:23:12 +00:00
self.make_home()
self.home.edit_groups = [board]
self.home.view_groups = [member, subscribers]
self.home.save()
2017-09-13 09:20:55 +00:00
self.make_page()
2016-03-29 10:45:10 +00:00
def __str__(self):
return self.name
def get_absolute_url(self):
2018-10-04 19:29:19 +00:00
return reverse("club:club_view", kwargs={"club_id": self.id})
2016-08-07 18:10:50 +00:00
def get_display_name(self):
return self.name
2016-02-05 15:59:42 +00:00
def is_owned_by(self, user):
"""
Method to see if that object can be super edited by the given user
"""
2016-09-02 19:21:57 +00:00
return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP)
2016-02-05 15:59:42 +00:00
2017-09-29 15:18:06 +00:00
def get_full_logo_url(self):
return "https://%s%s" % (settings.SITH_URL, self.logo.url)
2016-02-05 15:59:42 +00:00
def can_be_edited_by(self, user):
"""
Method to see if that object can be edited by the given user
"""
return self.has_rights_in_club(user)
2016-02-05 15:59:42 +00:00
def can_be_viewed_by(self, user):
"""
Method to see if that object can be seen by the given user
"""
2016-12-10 00:58:30 +00:00
sub = User.objects.filter(pk=user.pk).first()
2016-02-05 15:59:42 +00:00
if sub is None:
return False
return sub.was_subscribed
2016-02-05 15:59:42 +00:00
2017-05-20 10:36:18 +00:00
_memberships = {}
2017-06-12 06:54:48 +00:00
2016-02-05 15:59:42 +00:00
def get_membership_for(self, user):
"""
Returns the current membership the given user
"""
2017-05-20 10:36:18 +00:00
try:
return Club._memberships[self.id][user.id]
except:
m = self.members.filter(user=user.id).filter(end_date=None).first()
try:
Club._memberships[self.id][user.id] = m
except:
Club._memberships[self.id] = {}
Club._memberships[self.id][user.id] = m
return m
2016-02-05 15:59:42 +00:00
def has_rights_in_club(self, user):
m = self.get_membership_for(user)
return m is not None and m.role > settings.SITH_MAXIMUM_FREE_ROLE
2017-06-12 06:54:48 +00:00
class Membership(models.Model):
"""
The Membership class makes the connection between User and Clubs
Both Users and Clubs can have many Membership objects:
- a user can be a member of many clubs at a time
- a club can have many members at a time too
A User is currently member of all the Clubs where its Membership has an end_date set to null/None.
Otherwise, it's a past membership kept because it can be very useful to see who was in which Club in the past.
"""
2018-10-04 19:29:19 +00:00
user = models.ForeignKey(
User,
verbose_name=_("user"),
related_name="memberships",
null=False,
blank=False,
)
club = models.ForeignKey(
Club, verbose_name=_("club"), related_name="members", null=False, blank=False
)
start_date = models.DateField(_("start date"), default=timezone.now)
end_date = models.DateField(_("end date"), null=True, blank=True)
role = models.IntegerField(
_("role"),
choices=sorted(settings.SITH_CLUB_ROLES.items()),
default=sorted(settings.SITH_CLUB_ROLES.items())[0][0],
)
description = models.CharField(
_("description"), max_length=128, null=False, blank=True
)
def __str__(self):
2018-10-04 19:29:19 +00:00
return (
self.club.name
+ " - "
+ self.user.username
+ " - "
+ str(settings.SITH_CLUB_ROLES[self.role])
+ str(" - " + str(_("past member")) if self.end_date is not None else "")
2017-06-12 06:54:48 +00:00
)
2016-09-02 19:21:57 +00:00
def is_owned_by(self, user):
"""
Method to see if that object can be super edited by the given user
"""
return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP)
2019-04-24 16:17:03 +00:00
def can_be_edited_by(self, user, membership=None):
2016-09-02 19:21:57 +00:00
"""
Method to see if that object can be edited by the given user
"""
2016-09-15 09:06:51 +00:00
if user.memberships:
2019-04-24 16:17:03 +00:00
if membership: # This is for optimisation purpose
ms = membership
else:
ms = user.memberships.filter(club=self.club, end_date=None).first()
2018-10-04 19:29:19 +00:00
return (ms and ms.role >= self.role) or user.is_in_group(
settings.SITH_MAIN_BOARD_GROUP
)
2016-09-02 19:21:57 +00:00
return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP)
2016-02-04 07:59:03 +00:00
def get_absolute_url(self):
2018-10-04 19:29:19 +00:00
return reverse("club:club_members", kwargs={"club_id": self.club.id})
2017-08-16 22:07:19 +00:00
class Mailing(models.Model):
"""
This class correspond to a mailing list
2017-08-17 18:55:20 +00:00
Remember that mailing lists should be validated by UTBM
2017-08-16 22:07:19 +00:00
"""
2018-10-04 19:29:19 +00:00
club = models.ForeignKey(
Club, verbose_name=_("Club"), related_name="mailings", null=False, blank=False
)
email = models.CharField(
_("Email address"),
unique=True,
null=False,
blank=False,
max_length=256,
validators=[
RegexValidator(
validate_email.user_regex,
_("Enter a valid address. Only the root of the address is needed."),
)
],
)
is_moderated = models.BooleanField(_("is moderated"), default=False)
moderator = models.ForeignKey(
User, related_name="moderated_mailings", verbose_name=_("moderator"), null=True
)
2017-08-16 22:07:19 +00:00
2017-08-17 19:46:13 +00:00
def clean(self):
2017-08-21 17:53:17 +00:00
if self.can_moderate(self.moderator):
self.is_moderated = True
else:
self.moderator = None
super(Mailing, self).clean()
2017-08-22 20:39:12 +00:00
@property
def email_full(self):
2018-10-04 19:29:19 +00:00
return self.email + "@" + settings.SITH_MAILING_DOMAIN
2017-08-22 20:39:12 +00:00
2017-08-21 17:53:17 +00:00
def can_moderate(self, user):
return user.is_root or user.is_in_group(settings.SITH_GROUP_COM_ADMIN_ID)
2017-08-17 19:46:13 +00:00
2017-08-16 22:07:19 +00:00
def is_owned_by(self, user):
2018-10-04 19:29:19 +00:00
return (
user.is_in_group(self)
or user.is_root
or user.is_in_group(settings.SITH_GROUP_COM_ADMIN_ID)
)
2017-08-16 22:07:19 +00:00
2017-08-17 18:55:20 +00:00
def can_view(self, user):
return self.club.has_rights_in_club(user)
2017-12-22 11:06:23 +00:00
def can_be_edited_by(self, user):
return self.club.has_rights_in_club(user)
2017-08-17 18:55:20 +00:00
def delete(self):
for sub in self.subscriptions.all():
sub.delete()
super(Mailing, self).delete()
2017-08-16 22:07:19 +00:00
2017-08-17 19:46:13 +00:00
def fetch_format(self):
2018-10-04 19:29:19 +00:00
resp = self.email + ": "
2017-08-17 19:46:13 +00:00
for sub in self.subscriptions.all():
resp += sub.fetch_format()
return resp
2017-08-21 17:53:17 +00:00
def save(self):
if not self.is_moderated:
2018-10-04 19:29:19 +00:00
for user in (
RealGroup.objects.filter(id=settings.SITH_GROUP_COM_ADMIN_ID)
.first()
.users.all()
):
if not user.notifications.filter(
type="MAILING_MODERATION", viewed=False
).exists():
Notification(
user=user,
url=reverse("com:mailing_admin"),
type="MAILING_MODERATION",
).save()
2017-08-21 17:53:17 +00:00
super(Mailing, self).save()
2017-08-16 22:07:19 +00:00
def __str__(self):
2017-08-22 20:39:12 +00:00
return "%s - %s" % (self.club, self.email_full)
2017-08-16 22:07:19 +00:00
class MailingSubscription(models.Model):
"""
2017-08-17 18:55:20 +00:00
This class makes the link between user and mailing list
2017-08-16 22:07:19 +00:00
"""
2018-10-04 19:29:19 +00:00
mailing = models.ForeignKey(
Mailing,
verbose_name=_("Mailing"),
related_name="subscriptions",
null=False,
blank=False,
)
user = models.ForeignKey(
User,
verbose_name=_("User"),
related_name="mailing_subscriptions",
null=True,
blank=True,
)
email = models.EmailField(_("Email address"), blank=False, null=False)
2017-08-17 18:55:20 +00:00
class Meta:
2018-10-04 19:29:19 +00:00
unique_together = (("user", "email", "mailing"),)
2017-08-17 18:55:20 +00:00
def clean(self):
if not self.user and not self.email:
raise ValidationError(_("At least user or email is required"))
2017-08-21 17:53:17 +00:00
try:
if self.user and not self.email:
self.email = self.user.email
2018-10-04 19:29:19 +00:00
if MailingSubscription.objects.filter(
mailing=self.mailing, email=self.email
).exists():
raise ValidationError(
_("This email is already suscribed in this mailing")
)
2017-08-21 17:53:17 +00:00
except ObjectDoesNotExist:
pass
2017-08-17 18:55:20 +00:00
super(MailingSubscription, self).clean()
2017-08-16 22:07:19 +00:00
def is_owned_by(self, user):
2018-10-04 19:29:19 +00:00
return (
self.mailing.club.has_rights_in_club(user)
or user.is_root
or self.user.is_in_group(settings.SITH_GROUP_COM_ADMIN_ID)
)
2017-08-16 22:07:19 +00:00
def can_be_edited_by(self, user):
2018-10-04 19:29:19 +00:00
return self.user is not None and user.id == self.user.id
2017-08-17 18:55:20 +00:00
@property
def get_email(self):
if self.user and not self.email:
return self.user.email
return self.email
2017-08-17 19:46:13 +00:00
def fetch_format(self):
2018-10-04 19:29:19 +00:00
return self.get_email + " "
2017-08-17 19:46:13 +00:00
2017-08-17 18:55:20 +00:00
def __str__(self):
if self.user:
user = str(self.user)
else:
user = _("Unregistered user")
return "(%s) - %s : %s" % (self.mailing, user, self.email)