models.py 40.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# -*- coding:utf-8 -*
#
# Copyright 2016,2017
# - Skia <skia@libskia.so>
#
# 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.
#
#
24
import importlib
25

Skia's avatar
Skia committed
26
from django.db import models
27
from django.core.mail import send_mail
Skia's avatar
Skia committed
28
from django.contrib.auth.models import AbstractBaseUser, PermissionsMixin, UserManager, Group as AuthGroup, GroupManager as AuthGroupManager, AnonymousUser as AuthAnonymousUser
Skia's avatar
Skia committed
29
30
from django.utils.translation import ugettext_lazy as _
from django.utils import timezone
31
from django.core import validators
Skia's avatar
Skia committed
32
from django.core.exceptions import ValidationError, PermissionDenied
33
from django.core.urlresolvers import reverse
34
from django.conf import settings
Skia's avatar
Skia committed
35
from django.db import transaction
36
37
from django.contrib.staticfiles.storage import staticfiles_storage
from django.utils.html import escape
38
39
from django.utils.functional import cached_property

Sli's avatar
Sli committed
40
41
import os

Skia's avatar
Skia committed
42
43
from phonenumber_field.modelfields import PhoneNumberField

44
from datetime import datetime, timedelta, date
Skia's avatar
Skia committed
45

Skia's avatar
Skia committed
46
47
import unicodedata

Krophil's avatar
Krophil committed
48

Skia's avatar
Skia committed
49
50
51
52
class RealGroupManager(AuthGroupManager):
    def get_queryset(self):
        return super(RealGroupManager, self).get_queryset().filter(is_meta=False)

Krophil's avatar
Krophil committed
53

Skia's avatar
Skia committed
54
55
56
57
class MetaGroupManager(AuthGroupManager):
    def get_queryset(self):
        return super(MetaGroupManager, self).get_queryset().filter(is_meta=True)

Krophil's avatar
Krophil committed
58

Skia's avatar
Skia committed
59
class Group(AuthGroup):
Skia's avatar
Skia committed
60
61
62
63
64
    is_meta = models.BooleanField(
        _('meta group status'),
        default=False,
        help_text=_('Whether a group is a meta group or not'),
    )
Skia's avatar
Skia committed
65
    description = models.CharField(_('description'), max_length=60)
66
67
68
69

    class Meta:
        ordering = ['name']

Skia's avatar
Skia committed
70
71
72
73
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
Skia's avatar
Skia committed
74
        return reverse('core:group_list')
Skia's avatar
Skia committed
75

Krophil's avatar
Krophil committed
76

Skia's avatar
Skia committed
77
78
class MetaGroup(Group):
    objects = MetaGroupManager()
Krophil's avatar
Krophil committed
79

Skia's avatar
Skia committed
80
81
82
83
84
85
86
    class Meta:
        proxy = True

    def __init__(self, *args, **kwargs):
        super(MetaGroup, self).__init__(*args, **kwargs)
        self.is_meta = True

Krophil's avatar
Krophil committed
87

Skia's avatar
Skia committed
88
89
class RealGroup(Group):
    objects = RealGroupManager()
Krophil's avatar
Krophil committed
90

Skia's avatar
Skia committed
91
92
93
    class Meta:
        proxy = True

Krophil's avatar
Krophil committed
94

95
96
def validate_promo(value):
    start_year = settings.SITH_SCHOOL_START_YEAR
Krophil's avatar
Krophil committed
97
    delta = (date.today() + timedelta(days=180)).year - start_year
98
99
100
101
102
103
    if value < 0 or delta < value:
        raise ValidationError(
            _('%(value)s is not a valid promo (between 0 and %(end)s)'),
            params={'value': value, 'end': delta},
        )

Krophil's avatar
Krophil committed
104

105
class User(AbstractBaseUser):
Skia's avatar
Skia committed
106
107
    """
    Defines the base user class, useable in every app
Skia's avatar
Skia committed
108

Skia's avatar
Skia committed
109
110
111
    This is almost the same as the auth module AbstractUser since it inherits from it,
    but some fields are required, and the username is generated automatically with the
    name of the user (see generate_username()).
Skia's avatar
Skia committed
112

113
    Added field: nick_name, date_of_birth
Skia's avatar
Skia committed
114
115
116
117
118
119
    Required fields: email, first_name, last_name, date_of_birth
    """
    username = models.CharField(
        _('username'),
        max_length=254,
        unique=True,
Skia's avatar
Skia committed
120
        help_text=_('Required. 254 characters or fewer. Letters, digits and ./+/-/_ only.'),
Skia's avatar
Skia committed
121
122
        validators=[
            validators.RegexValidator(
Skia's avatar
Skia committed
123
                r'^[\w.+-]+$',
Skia's avatar
Skia committed
124
                _('Enter a valid username. This value may contain only '
Skia's avatar
Skia committed
125
                  'letters, numbers ' 'and ./+/-/_ characters.')
Skia's avatar
Skia committed
126
127
128
129
130
131
            ),
        ],
        error_messages={
            'unique': _("A user with that username already exists."),
        },
    )
Skia's avatar
Skia committed
132
133
    first_name = models.CharField(_('first name'), max_length=64)
    last_name = models.CharField(_('last name'), max_length=64)
Skia's avatar
Skia committed
134
    email = models.EmailField(_('email address'), unique=True)
Skia's avatar
Skia committed
135
    date_of_birth = models.DateField(_('date of birth'), blank=True, null=True)
Skia's avatar
Skia committed
136
    nick_name = models.CharField(_('nick name'), max_length=64, null=True, blank=True)
Skia's avatar
Skia committed
137
138
139
140
141
142
143
144
145
146
147
148
149
    is_staff = models.BooleanField(
        _('staff status'),
        default=False,
        help_text=_('Designates whether the user can log into this admin site.'),
    )
    is_active = models.BooleanField(
        _('active'),
        default=True,
        help_text=_(
            'Designates whether this user should be treated as active. '
            'Unselect this instead of deleting accounts.'
        ),
    )
Skia's avatar
Skia committed
150
    date_joined = models.DateField(_('date joined'), auto_now_add=True)
151
    last_update = models.DateTimeField(_('last update'), auto_now=True)
152
153
154
155
156
157
158
159
    is_superuser = models.BooleanField(
        _('superuser'),
        default=False,
        help_text=_(
            'Designates whether this user is a superuser. '
        ),
    )
    groups = models.ManyToManyField(RealGroup, related_name='users', blank=True)
Skia's avatar
Skia committed
160
    home = models.OneToOneField('SithFile', related_name='home_of', verbose_name=_("home"), null=True, blank=True,
Krophil's avatar
Krophil committed
161
                                on_delete=models.SET_NULL)
Skia's avatar
Skia committed
162
    profile_pict = models.OneToOneField('SithFile', related_name='profile_of', verbose_name=_("profile"), null=True,
Krophil's avatar
Krophil committed
163
                                        blank=True, on_delete=models.SET_NULL)
Skia's avatar
Skia committed
164
    avatar_pict = models.OneToOneField('SithFile', related_name='avatar_of', verbose_name=_("avatar"), null=True,
Krophil's avatar
Krophil committed
165
                                       blank=True, on_delete=models.SET_NULL)
Skia's avatar
Skia committed
166
    scrub_pict = models.OneToOneField('SithFile', related_name='scrub_of', verbose_name=_("scrub"), null=True,
Krophil's avatar
Krophil committed
167
                                      blank=True, on_delete=models.SET_NULL)
168
169
170
171
172
173
174
175
176
177
    sex = models.CharField(_("sex"), max_length=10, choices=[("MAN", _("Man")), ("WOMAN", _("Woman"))], default="MAN")
    tshirt_size = models.CharField(_("tshirt size"), max_length=5, choices=[
        ("-", _("-")),
        ("XS", _("XS")),
        ("S", _("S")),
        ("M", _("M")),
        ("L", _("L")),
        ("XL", _("XL")),
        ("XXL", _("XXL")),
        ("XXXL", _("XXXL")),
Krophil's avatar
Krophil committed
178
    ], default="-")
179
180
181
182
183
184
185
186
    role = models.CharField(_("role"), max_length=15, choices=[
        ("STUDENT", _("Student")),
        ("ADMINISTRATIVE", _("Administrative agent")),
        ("TEACHER", _("Teacher")),
        ("AGENT", _("Agent")),
        ("DOCTOR", _("Doctor")),
        ("FORMER STUDENT", _("Former student")),
        ("SERVICE", _("Service")),
Krophil's avatar
Krophil committed
187
    ], blank=True, default="")
Skia's avatar
Skia committed
188
    department = models.CharField(_("department"), max_length=15, choices=settings.SITH_PROFILE_DEPARTMENTS,
Krophil's avatar
Krophil committed
189
                                  default="NA", blank=True)
Skia's avatar
Skia committed
190
191
192
193
    dpt_option = models.CharField(_("dpt option"), max_length=32, blank=True, default="")
    semester = models.CharField(_("semester"), max_length=5, blank=True, default="")
    quote = models.CharField(_("quote"), max_length=256, blank=True, default="")
    school = models.CharField(_("school"), max_length=80, blank=True, default="")
194
    promo = models.IntegerField(_("promo"), validators=[validate_promo], null=True, blank=True)
Skia's avatar
Skia committed
195
196
197
198
199
200
    forum_signature = models.TextField(_("forum signature"), max_length=256, blank=True, default="")
    second_email = models.EmailField(_('second email address'), null=True, blank=True)
    phone = PhoneNumberField(_("phone"), null=True, blank=True)
    parent_phone = PhoneNumberField(_("parent phone"), null=True, blank=True)
    address = models.CharField(_("address"), max_length=128, blank=True, default="")
    parent_address = models.CharField(_("parent address"), max_length=128, blank=True, default="")
Skia's avatar
Skia committed
201
    is_subscriber_viewable = models.BooleanField(_("is subscriber viewable"), default=True)
Skia's avatar
Skia committed
202
    godfathers = models.ManyToManyField('User', related_name='godchildren', blank=True)
Skia's avatar
Skia committed
203
204
205
206

    objects = UserManager()

    USERNAME_FIELD = 'username'
Skia's avatar
Skia committed
207
    # REQUIRED_FIELDS = ['email']
Skia's avatar
Skia committed
208

209
210
211
212
213
214
    def has_module_perms(self, package_name):
        return self.is_active

    def has_perm(self, perm, obj=None):
        return self.is_active and self.is_superuser

Skia's avatar
Skia committed
215
216
217
218
219
220
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
        return reverse('core:user_profile', kwargs={'user_id': self.pk})

Skia's avatar
Skia committed
221
    def __str__(self):
Skia's avatar
Skia committed
222
        return self.get_display_name()
Skia's avatar
Skia committed
223

Skia's avatar
Skia committed
224
225
226
    def to_dict(self):
        return self.__dict__

227
    @cached_property
228
229
230
    def was_subscribed(self):
        return self.subscriptions.exists()

231
    @cached_property
Skia's avatar
Skia committed
232
    def is_subscribed(self):
233
        s = self.subscriptions.filter(subscription_start__lte=timezone.now()).last()
Skia's avatar
Skia committed
234
235
        return s.is_valid_now() if s is not None else False

Skia's avatar
Skia committed
236
237
238
    _club_memberships = {}
    _group_names = {}
    _group_ids = {}
Krophil's avatar
Krophil committed
239

Skia's avatar
Skia committed
240
    def is_in_group(self, group_name):
Skia's avatar
Skia committed
241
        """If the user is in the group passed in argument (as string or by id)"""
Skia's avatar
Skia committed
242
        group_id = 0
Skia's avatar
Skia committed
243
        g = None
Krophil's avatar
Krophil committed
244
        if isinstance(group_name, int):  # Handle the case where group_name is an ID
Skia's avatar
Skia committed
245
246
247
248
249
            if group_name in User._group_ids.keys():
                g = User._group_ids[group_name]
            else:
                g = Group.objects.filter(id=group_name).first()
                User._group_ids[group_name] = g
Skia's avatar
Skia committed
250
        else:
Skia's avatar
Skia committed
251
252
253
254
255
            if group_name in User._group_names.keys():
                g = User._group_names[group_name]
            else:
                g = Group.objects.filter(name=group_name).first()
                User._group_names[group_name] = g
Skia's avatar
Skia committed
256
257
258
259
260
        if g:
            group_name = g.name
            group_id = g.id
        else:
            return False
Skia's avatar
Skia committed
261
        if group_id == settings.SITH_GROUP_PUBLIC_ID:
Skia's avatar
Skia committed
262
            return True
263
        if group_id == settings.SITH_GROUP_SUBSCRIBERS_ID:
264
            return self.is_subscribed
265
        if group_id == settings.SITH_GROUP_OLD_SUBSCRIBERS_ID:
266
            return self.was_subscribed
Krophil's avatar
Krophil committed
267
        if group_name == settings.SITH_MAIN_MEMBERS_GROUP:  # We check the subscription if asked
268
            return self.is_subscribed
Skia's avatar
Skia committed
269
270
        if group_name[-len(settings.SITH_BOARD_SUFFIX):] == settings.SITH_BOARD_SUFFIX:
            name = group_name[:-len(settings.SITH_BOARD_SUFFIX)]
Skia's avatar
Skia committed
271
272
273
274
275
276
277
            if name in User._club_memberships.keys():
                mem = User._club_memberships[name]
            else:
                from club.models import Club
                c = Club.objects.filter(unix_name=name).first()
                mem = c.get_membership_for(self)
                User._club_memberships[name] = mem
Skia's avatar
Skia committed
278
279
280
281
282
            if mem:
                return mem.role > settings.SITH_MAXIMUM_FREE_ROLE
            return False
        if group_name[-len(settings.SITH_MEMBER_SUFFIX):] == settings.SITH_MEMBER_SUFFIX:
            name = group_name[:-len(settings.SITH_MEMBER_SUFFIX)]
Skia's avatar
Skia committed
283
284
285
286
287
288
289
            if name in User._club_memberships.keys():
                mem = User._club_memberships[name]
            else:
                from club.models import Club
                c = Club.objects.filter(unix_name=name).first()
                mem = c.get_membership_for(self)
                User._club_memberships[name] = mem
Skia's avatar
Skia committed
290
291
292
            if mem:
                return True
            return False
Skia's avatar
Skia committed
293
        if group_id == settings.SITH_GROUP_ROOT_ID and self.is_superuser:
Skia's avatar
Skia committed
294
            return True
Skia's avatar
Skia committed
295
296
        return self.groups.filter(name=group_name).exists()

297
    @cached_property
Skia's avatar
Skia committed
298
    def is_root(self):
Skia's avatar
Skia committed
299
        return self.is_superuser or self.groups.filter(id=settings.SITH_GROUP_ROOT_ID).exists()
Skia's avatar
Skia committed
300

301
    @cached_property
Sli's avatar
Sli committed
302
    def is_board_member(self):
303
        from club.models import Club
304
305
306
307
308
309
310
311
312
        return Club.objects.filter(unix_name=settings.SITH_MAIN_CLUB['unix_name']).first().has_rights_in_club(self)

    @cached_property
    def can_create_subscription(self):
        from club.models import Club
        for club in Club.objects.filter(id__in=settings.SITH_CAN_CREATE_SUBSCRIPTIONS).all():
            if club.has_rights_in_club(self):
                return True
        return False
Sli's avatar
Sli committed
313

314
    @cached_property
Sli's avatar
Sli committed
315
    def is_launderette_manager(self):
Sli's avatar
Sli committed
316
317
        from club.models import Club
        return Club.objects.filter(unix_name=settings.SITH_LAUNDERETTE_MANAGER['unix_name']).first().get_membership_for(self)
318

319
    @cached_property
320
    def is_banned_alcohol(self):
Skia's avatar
Skia committed
321
        return self.is_in_group(settings.SITH_GROUP_BANNED_ALCOHOL_ID)
322

323
    @cached_property
324
    def is_banned_counter(self):
Skia's avatar
Skia committed
325
        return self.is_in_group(settings.SITH_GROUP_BANNED_COUNTER_ID)
326

Skia's avatar
Skia committed
327
    def save(self, *args, **kwargs):
328
        create = False
Skia's avatar
Skia committed
329
330
331
        with transaction.atomic():
            if self.id:
                old = User.objects.filter(id=self.id).first()
Skia's avatar
Skia committed
332
                if old and old.username != self.username:
Skia's avatar
Skia committed
333
                    self._change_username(self.username)
334
335
            else:
                create = True
Skia's avatar
Skia committed
336
            super(User, self).save(*args, **kwargs)
Krophil's avatar
Krophil committed
337
            if create and settings.IS_OLD_MYSQL_PRESENT:  # Create user on the old site: TODO remove me!
338
339
340
341
342
343
344
345
                import MySQLdb
                try:
                    db = MySQLdb.connect(**settings.OLD_MYSQL_INFOS)
                    c = db.cursor()
                    c.execute("""INSERT INTO utilisateurs (id_utilisateur, nom_utl, prenom_utl, email_utl, hash_utl, ae_utl) VALUES
                    (%s, %s, %s, %s, %s, %s)""", (self.id, self.last_name, self.first_name, self.email, "valid", "0"))
                    db.commit()
                except Exception as e:
Krophil's avatar
Krophil committed
346
                    with open(settings.BASE_DIR + "/user_fail.log", "a") as f:
347
                        print("FAIL to add user %s (%s %s - %s) to old site" % (self.id, self.first_name, self.last_name,
Krophil's avatar
Krophil committed
348
                                                                                self.email), file=f)
349
350
                        print("Reason: %s" % (repr(e)), file=f)
                    db.rollback()
Skia's avatar
Skia committed
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369

    def make_home(self):
        if self.home is None:
            home_root = SithFile.objects.filter(parent=None, name="users").first()
            if home_root is not None:
                home = SithFile(parent=home_root, name=self.username, owner=self)
                home.save()
                self.home = home
                self.save()

    def _change_username(self, new_name):
        u = User.objects.filter(username=new_name).first()
        if u is None:
            if self.home:
                self.home.name = new_name
                self.home.save()
        else:
            raise ValidationError(_("A user with that username already exists"))

Skia's avatar
Skia committed
370
371
372
373
374
375
376
377
    def get_profile(self):
        return {
            "last_name": self.last_name,
            "first_name": self.first_name,
            "nick_name": self.nick_name,
            "date_of_birth": self.date_of_birth,
        }

Skia's avatar
Skia committed
378
379
380
381
382
383
384
385
386
    def get_full_name(self):
        """
        Returns the first_name plus the last_name, with a space in between.
        """
        full_name = '%s %s' % (self.first_name, self.last_name)
        return full_name.strip()

    def get_short_name(self):
        "Returns the short name for the user."
Skia's avatar
Skia committed
387
388
389
        if self.nick_name:
            return self.nick_name
        return self.first_name + " " + self.last_name
Skia's avatar
Skia committed
390

Skia's avatar
Skia committed
391
392
393
394
395
    def get_display_name(self):
        """
        Returns the display name of the user.
        A nickname if possible, otherwise, the full name
        """
Skia's avatar
Skia committed
396
397
        if self.nick_name:
            return "%s (%s)" % (self.get_full_name(), self.nick_name)
Skia's avatar
Skia committed
398
399
        return self.get_full_name()

400
401
402
403
    def get_age(self):
        """
        Returns the age
        """
Sli's avatar
Sli committed
404
405
406
        today = timezone.now()
        born = self.date_of_birth
        return today.year - born.year - ((today.month, today.day) < (born.month, born.day))
407

Skia's avatar
Skia committed
408
409
410
411
    def email_user(self, subject, message, from_email=None, **kwargs):
        """
        Sends an email to this User.
        """
412
413
        if from_email is None:
            from_email = settings.DEFAULT_FROM_EMAIL
Skia's avatar
Skia committed
414
415
416
417
418
419
420
421
        send_mail(subject, message, from_email, [self.email], **kwargs)

    def generate_username(self):
        """
        Generates a unique username based on the first and last names.
        For example: Guy Carlier gives gcarlier, and gcarlier1 if the first one exists
        Returns the generated username
        """
Skia's avatar
Skia committed
422
        def remove_accents(data):
Krophil's avatar
Krophil committed
423
424
425
            return ''.join(x for x in unicodedata.normalize('NFKD', data) if
                           unicodedata.category(x)[0] == 'L').lower()
        user_name = remove_accents(self.first_name[0] + self.last_name).encode('ascii', 'ignore').decode('utf-8')
Skia's avatar
Skia committed
426
427
428
        un_set = [u.username for u in User.objects.all()]
        if user_name in un_set:
            i = 1
Krophil's avatar
Krophil committed
429
            while user_name + str(i) in un_set:
Skia's avatar
Skia committed
430
431
432
433
                i += 1
            user_name += str(i)
        self.username = user_name
        return user_name
Skia's avatar
Skia committed
434

Skia's avatar
Skia committed
435
436
437
438
    def is_owner(self, obj):
        """
        Determine if the object is owned by the user
        """
Skia's avatar
Skia committed
439
440
        if hasattr(obj, "is_owned_by") and obj.is_owned_by(self):
            return True
Skia's avatar
Skia committed
441
        if hasattr(obj, "owner_group") and self.is_in_group(obj.owner_group.name):
Skia's avatar
Skia committed
442
            return True
Skia's avatar
Skia committed
443
        if self.is_superuser or self.is_in_group(settings.SITH_GROUP_ROOT_ID):
Skia's avatar
Skia committed
444
            return True
Skia's avatar
Skia committed
445
446
447
448
449
450
        return False

    def can_edit(self, obj):
        """
        Determine if the object can be edited by the user
        """
Skia's avatar
Skia committed
451
        if hasattr(obj, "can_be_edited_by") and obj.can_be_edited_by(self):
Skia's avatar
Skia committed
452
            return True
Skia's avatar
Skia committed
453
454
        if hasattr(obj, "edit_groups"):
            for g in obj.edit_groups.all():
Skia's avatar
Skia committed
455
                if self.is_in_group(g.name):
456
                    return True
457
458
        if isinstance(obj, User) and obj == self:
            return True
Skia's avatar
Skia committed
459
        if self.is_owner(obj):
Skia's avatar
Skia committed
460
            return True
Skia's avatar
Skia committed
461
462
463
464
465
466
        return False

    def can_view(self, obj):
        """
        Determine if the object can be viewed by the user
        """
Skia's avatar
Skia committed
467
        if hasattr(obj, "can_be_viewed_by") and obj.can_be_viewed_by(self):
Skia's avatar
Skia committed
468
            return True
Skia's avatar
Skia committed
469
470
        if hasattr(obj, "view_groups"):
            for g in obj.view_groups.all():
Skia's avatar
Skia committed
471
                if self.is_in_group(g.name):
472
                    return True
Skia's avatar
Skia committed
473
        if self.can_edit(obj):
Skia's avatar
Skia committed
474
            return True
Skia's avatar
Skia committed
475
476
        return False

Skia's avatar
Skia committed
477
    def can_be_edited_by(self, user):
Skia's avatar
Skia committed
478
        return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP) or user.is_root
Skia's avatar
Skia committed
479

Skia's avatar
Skia committed
480
    def can_be_viewed_by(self, user):
Skia's avatar
Skia committed
481
        return (user.was_subscribed and self.is_subscriber_viewable) or user.is_root
Skia's avatar
Skia committed
482

483
484
485
486
487
488
489
490
491
    def get_mini_item(self):
        return """
    <div class="mini_profile_link" >
    <span>
    <img src="%s" alt="%s" />
    </span>
    <em>%s</em>
    </a>
    """ % (
492
            self.profile_pict.get_download_url() if self.profile_pict else staticfiles_storage.url("core/img/unknown.jpg"),
493
            _("Profile"),
494
            escape(self.get_display_name()),
Krophil's avatar
Krophil committed
495
        )
496

497
    @cached_property
Skia's avatar
Skia committed
498
499
    def subscribed(self):
        return self.is_in_group(settings.SITH_MAIN_MEMBERS_GROUP)
Skia's avatar
Skia committed
500

501
502
503
504
505
506
507
508
509
    @cached_property
    def preferences(self):
        try:
            return self._preferences
        except:
            prefs = Preferences(user=self)
            prefs.save()
            return prefs

510
    @cached_property
Skia's avatar
Skia committed
511
512
513
514
515
516
517
518
519
    def forum_infos(self):
        try:
            return self._forum_infos
        except:
            from forum.models import ForumUserInfo
            infos = ForumUserInfo(user=self)
            infos.save()
            return infos

Krophil's avatar
Krophil committed
520

521
522
523
524
class AnonymousUser(AuthAnonymousUser):
    def __init__(self, request):
        super(AnonymousUser, self).__init__()

525
526
527
528
    @property
    def can_create_subscription(self):
        return False

Sli's avatar
Sli committed
529
    @property
Skia's avatar
Skia committed
530
    def was_subscribed(self):
Skia's avatar
Skia committed
531
        return False
Skia's avatar
Skia committed
532

Skia's avatar
Skia committed
533
534
    @property
    def subscribed(self):
Skia's avatar
Skia committed
535
        return False
Skia's avatar
Skia committed
536

Skia's avatar
Skia committed
537
538
    @property
    def is_root(self):
Skia's avatar
Skia committed
539
        return False
Skia's avatar
Skia committed
540

541
542
    @property
    def is_board_member(self):
Skia's avatar
Skia committed
543
        return False
544
545
546

    @property
    def is_launderette_manager(self):
Skia's avatar
Skia committed
547
        return False
548

549
550
    @property
    def is_banned_alcohol(self):
Skia's avatar
Skia committed
551
        return False
Skia's avatar
Skia committed
552
553

    @property
Skia's avatar
Skia committed
554
    def is_banned_counter(self):
Skia's avatar
Skia committed
555
        return False
556

Skia's avatar
Skia committed
557
558
559
560
    @property
    def forum_infos(self):
        raise PermissionDenied

561
562
563
564
    def is_in_group(self, group_name):
        """
        The anonymous user is only the public group
        """
Skia's avatar
Skia committed
565
        group_id = 0
Krophil's avatar
Krophil committed
566
        if isinstance(group_name, int):  # Handle the case where group_name is an ID
Skia's avatar
Skia committed
567
568
569
570
571
572
573
            g = Group.objects.filter(id=group_name).first()
            if g:
                group_name = g.name
                group_id = g.id
            else:
                return False
        if group_id == settings.SITH_GROUP_PUBLIC_ID:
574
575
576
            return True
        return False

577
578
579
580
581
582
583
    def is_owner(self, obj):
        return False

    def can_edit(self, obj):
        return False

    def can_view(self, obj):
Skia's avatar
Skia committed
584
        if hasattr(obj, 'view_groups') and obj.view_groups.filter(id=settings.SITH_GROUP_PUBLIC_ID).exists():
Skia's avatar
Skia committed
585
586
            return True
        if hasattr(obj, 'can_be_viewed_by') and obj.can_be_viewed_by(self):
587
588
589
            return True
        return False

590
591
592
    def get_display_name(self):
        return _("Visitor")

Krophil's avatar
Krophil committed
593

594
class Preferences(models.Model):
595
    user = models.OneToOneField(User, related_name="_preferences")
Skia's avatar
Skia committed
596
597
598
599
    receive_weekmail = models.BooleanField(
        _('do you want to receive the weekmail'),
        default=False,
    )
600
    show_my_stats = models.BooleanField(
601
602
603
604
605
606
607
608
609
        _('show your stats to others'),
        default=False,
    )
    notify_on_click = models.BooleanField(
        _('get a notification for every click'),
        default=False,
    )
    notify_on_refill = models.BooleanField(
        _('get a notification for every refilling'),
610
611
612
        default=False,
    )

Skia's avatar
Skia committed
613
614
615
616
617
618
    def get_display_name(self):
        return self.user.get_display_name()

    def get_absolute_url(self):
        return self.user.get_absolute_url()

Krophil's avatar
Krophil committed
619

Skia's avatar
Skia committed
620
def get_directory(instance, filename):
Skia's avatar
Skia committed
621
    return '.{0}/{1}'.format(instance.get_parent_path(), filename)
Skia's avatar
Skia committed
622

Krophil's avatar
Krophil committed
623

Skia's avatar
Skia committed
624
625
626
def get_compressed_directory(instance, filename):
    return '.{0}/compressed/{1}'.format(instance.get_parent_path(), filename)

Krophil's avatar
Krophil committed
627

Skia's avatar
Skia committed
628
629
630
def get_thumbnail_directory(instance, filename):
    return '.{0}/thumbnail/{1}'.format(instance.get_parent_path(), filename)

Krophil's avatar
Krophil committed
631

Skia's avatar
Skia committed
632
class SithFile(models.Model):
Skia's avatar
Skia committed
633
    name = models.CharField(_('file name'), max_length=256, blank=False)
Skia's avatar
Skia committed
634
    parent = models.ForeignKey('self', related_name="children", verbose_name=_("parent"), null=True, blank=True)
Skia's avatar
Skia committed
635
636
637
    file = models.FileField(upload_to=get_directory, verbose_name=_("file"), max_length=256, null=True, blank=True)
    compressed = models.FileField(upload_to=get_compressed_directory, verbose_name=_("compressed file"), max_length=256, null=True, blank=True)
    thumbnail = models.FileField(upload_to=get_thumbnail_directory, verbose_name=_("thumbnail"), max_length=256, null=True, blank=True)
Skia's avatar
Skia committed
638
639
640
641
642
643
    owner = models.ForeignKey(User, related_name="owned_files", verbose_name=_("owner"))
    edit_groups = models.ManyToManyField(Group, related_name="editable_files", verbose_name=_("edit group"), blank=True)
    view_groups = models.ManyToManyField(Group, related_name="viewable_files", verbose_name=_("view group"), blank=True)
    is_folder = models.BooleanField(_("is folder"), default=True)
    mime_type = models.CharField(_('mime type'), max_length=30)
    size = models.IntegerField(_("size"), default=0)
Skia's avatar
Skia committed
644
    date = models.DateTimeField(_('date'), default=timezone.now)
Skia's avatar
Skia committed
645
    is_moderated = models.BooleanField(_("is moderated"), default=False)
Skia's avatar
Skia committed
646
    moderator = models.ForeignKey(User, related_name="moderated_files", verbose_name=_("owner"), null=True, blank=True)
647
    asked_for_removal = models.BooleanField(_("asked for removal"), default=False)
Krophil's avatar
Krophil committed
648
    is_in_sas = models.BooleanField(_("is in the SAS"), default=False)  # Allows to query this flag, updated at each call to save()
Skia's avatar
Skia committed
649
650
651
652
653

    class Meta:
        verbose_name = _("file")

    def is_owned_by(self, user):
Skia's avatar
Skia committed
654
655
        if hasattr(self, 'profile_of') and user.is_in_group(settings.SITH_MAIN_BOARD_GROUP):
            return True
Skia's avatar
Skia committed
656
        if user.is_in_group(settings.SITH_GROUP_COM_ADMIN_ID):
Skia's avatar
Skia committed
657
            return True
Skia's avatar
Skia committed
658
659
        if self.is_in_sas and user.is_in_group(settings.SITH_GROUP_SAS_ADMIN_ID):
            return True
Skia's avatar
Skia committed
660
661
        return user.id == self.owner.id

662
663
664
665
666
667
668
669
670
    def can_be_viewed_by(self, user):
        if hasattr(self, 'profile_of'):
            return user.can_view(self.profile_of)
        if hasattr(self, 'avatar_of'):
            return user.can_view(self.avatar_of)
        if hasattr(self, 'scrub_of'):
            return user.can_view(self.scrub_of)
        return False

Skia's avatar
Skia committed
671
672
673
674
    def delete(self):
        for c in self.children.all():
            c.delete()
        self.file.delete()
Skia's avatar
Skia committed
675
676
677
678
        if self.compressed:
            self.compressed.delete()
        if self.thumbnail:
            self.thumbnail.delete()
Skia's avatar
Skia committed
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
        return super(SithFile, self).delete()

    def clean(self):
        """
        Cleans up the file
        """
        super(SithFile, self).clean()
        if '/' in self.name:
            raise ValidationError(_("Character '/' not authorized in name"))
        if self == self.parent:
            raise ValidationError(
                _('Loop in folder tree'),
                code='loop',
            )
        if (self == self.parent or (self.parent is not None and self in self.get_parent_list())):
            raise ValidationError(
                _('Loop in folder tree'),
                code='loop',
            )
        if self.parent and self.parent.is_file:
            raise ValidationError(_('You can not make a file be a children of a non folder file'))
        if ((self.parent is None and SithFile.objects.exclude(id=self.id).filter(parent=None, name=self.name).exists()) or
                (self.parent and self.parent.children.exclude(id=self.id).filter(name=self.name).exists())):
            raise ValidationError(
                _('Duplicate file'),
                code='duplicate',
            )
        if self.is_folder:
Skia's avatar
Skia committed
707
708
709
710
711
712
713
714
            if self.file:
                try:
                    import imghdr
                    if imghdr.what(None, self.file.read()) not in ['gif', 'png', 'jpeg']:
                        self.file.delete()
                        self.file = None
                except:
                    self.file = None
Skia's avatar
Skia committed
715
716
717
718
719
            self.mime_type = "inode/directory"
        if self.is_file and (self.file is None or self.file == ""):
            raise ValidationError(_("You must provide a file"))

    def save(self, *args, **kwargs):
720
721
        sas = SithFile.objects.filter(id=settings.SITH_SAS_ROOT_DIR_ID).first()
        self.is_in_sas = sas in self.get_parent_list()
Skia's avatar
Skia committed
722
723
724
725
726
727
        copy_rights = False
        if self.id is None:
            copy_rights = True
        super(SithFile, self).save(*args, **kwargs)
        if copy_rights:
            self.copy_rights()
728
729
730
731
        if self.is_in_sas:
            for u in RealGroup.objects.filter(id=settings.SITH_GROUP_SAS_ADMIN_ID).first().users.all():
                Notification(user=u, url=reverse("sas:moderation"),
                        type="SAS_MODERATION", param="1").save()
Skia's avatar
Skia committed
732

733
734
735
736
737
738
739
740
    def apply_rights_recursively(self, only_folders=False):
        children = self.children.all()
        if only_folders:
            children = children.filter(is_folder=True)
        for c in children:
            c.copy_rights()
            c.apply_rights_recursively(only_folders)

Skia's avatar
Skia committed
741
742
743
744
745
746
747
    def copy_rights(self):
        """Copy, if possible, the rights of the parent folder"""
        if self.parent is not None:
            self.edit_groups = self.parent.edit_groups.all()
            self.view_groups = self.parent.view_groups.all()
            self.save()

Skia's avatar
Skia committed
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
    def move_to(self, parent):
        """Move a file to somewhere else"""
        if not parent.is_folder:
            return
        import shutil
        import os
        with transaction.atomic():
            if self.is_folder:
                old_file_name = self.get_full_path()
            else:
                old_file_name = self.file.name
            self.parent = parent
            self.save()
            if self.is_folder:
                for c in self.children.all():
                    c.move_to(self)
Sli's avatar
Sli committed
764
                shutil.rmtree(os.path.join(settings.MEDIA_ROOT, old_file_name))
Skia's avatar
Skia committed
765
766
            else:
                self.file.save(name=self.name, content=self.file)
Sli's avatar
Sli committed
767
                os.remove(os.path.join(settings.MEDIA_ROOT, old_file_name))
Skia's avatar
Skia committed
768

Skia's avatar
Skia committed
769
770
771
772
    def __getattribute__(self, attr):
        if attr == "is_file":
            return not self.is_folder
        else:
Skia's avatar
Skia committed
773
            return super(SithFile, self).__getattribute__(attr)
Skia's avatar
Skia committed
774

775
    @cached_property
Skia's avatar
Skia committed
776
777
778
779
    def as_picture(self):
        from sas.models import Picture
        return Picture.objects.filter(id=self.id).first()

780
    @cached_property
781
782
783
784
    def as_album(self):
        from sas.models import Album
        return Album.objects.filter(id=self.id).first()

Skia's avatar
Skia committed
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
    def __str__(self):
        if self.is_folder:
            return _("Folder: ") + self.name
        else:
            return _("File: ") + self.name

    def get_parent_list(self):
        l = []
        p = self.parent
        while p is not None:
            l.append(p)
            p = p.parent
        return l

    def get_parent_path(self):
Skia's avatar
Skia committed
800
        return '/' + '/'.join([p.name for p in self.get_parent_list()[::-1]])
Skia's avatar
Skia committed
801

Skia's avatar
Skia committed
802
803
804
    def get_full_path(self):
        return self.get_parent_path() + '/' + self.name

Skia's avatar
Skia committed
805
806
807
    def get_display_name(self):
        return self.name

808
809
810
    def get_download_url(self):
        return reverse('core:download', kwargs={'file_id': self.id})

Skia's avatar
Skia committed
811
812
813
    def __str__(self):
        return self.get_parent_path() + "/" + self.name

Krophil's avatar
Krophil committed
814

Skia's avatar
Skia committed
815
816
817
818
class LockError(Exception):
    """There was a lock error on the object"""
    pass

Krophil's avatar
Krophil committed
819

Skia's avatar
Skia committed
820
821
822
823
class AlreadyLocked(LockError):
    """The object is already locked"""
    pass

Krophil's avatar
Krophil committed
824

Skia's avatar
Skia committed
825
826
827
828
class NotLocked(LockError):
    """The object is not locked"""
    pass

Krophil's avatar
Krophil committed
829

Skia's avatar
Skia committed
830
class Page(models.Model):
Skia's avatar
Skia committed
831
832
833
834
835
836
837
    """
    The page class to build a Wiki
    Each page may have a parent and it's URL is of the form my.site/page/<grd_pa>/<parent>/<mypage>
    It has an ID field, but don't use it, since it's only there for DB part, and because compound primary key is
    awkward!
    Prefere querying pages with Page.get_page_by_full_name()

838
    Be careful with the _full_name attribute: this field may not be valid until you call save(). It's made for fast
Skia's avatar
Skia committed
839
840
    query, but don't rely on it when playing with a Page object, use get_full_name() instead!
    """
Skia's avatar
Skia committed
841
    name = models.CharField(_('page unix name'), max_length=30,
Krophil's avatar
Krophil committed
842
843
                            validators=[
                            validators.RegexValidator(
Sli's avatar
Sli committed
844
                                r'^[a-zA-Z0-9][a-zA-Z0-9._-]*[a-zA-Z0-9]$',
Krophil's avatar
Krophil committed
845
846
847
848
                                _('Enter a valid page name. This value may contain only '
                                  'unaccented letters, numbers ' 'and ./+/-/_ characters.')
                            ), ],
                            blank=False)
Skia's avatar
Skia committed
849
    parent = models.ForeignKey('self', related_name="children", verbose_name=_("parent"), null=True, blank=True, on_delete=models.SET_NULL)
Skia's avatar
Skia committed
850
851
    # Attention: this field may not be valid until you call save(). It's made for fast query, but don't rely on it when
    # playing with a Page object, use get_full_name() instead!
852
    _full_name = models.CharField(_('page name'), max_length=255, blank=True)
Skia's avatar
Skia committed
853
    owner_group = models.ForeignKey(Group, related_name="owned_page", verbose_name=_("owner group"),
Skia's avatar
Skia committed
854
                                    default=settings.SITH_GROUP_ROOT_ID)
Skia's avatar
Skia committed
855
856
    edit_groups = models.ManyToManyField(Group, related_name="editable_page", verbose_name=_("edit group"), blank=True)
    view_groups = models.ManyToManyField(Group, related_name="viewable_page", verbose_name=_("view group"), blank=True)
Skia's avatar
Skia committed
857
858
    lock_user = models.ForeignKey(User, related_name="locked_pages", verbose_name=_("lock user"), blank=True, null=True, default=None)
    lock_timeout = models.DateTimeField(_('lock_timeout'), null=True, blank=True, default=None)
Skia's avatar
Skia committed
859

Skia's avatar
Skia committed
860
    class Meta:
861
        unique_together = ('name', 'parent')
Skia's avatar
Skia committed
862
        permissions = (
863
864
            ("change_prop_page", "Can change the page's properties (groups, ...)"),
            ("view_page", "Can view the page"),
Skia's avatar
Skia committed
865
866
        )

867
868
    @staticmethod
    def get_page_by_full_name(name):
Skia's avatar
Skia committed
869
870
871
        """
        Quicker to get a page with that method rather than building the request every time
        """
872
        return Page.objects.filter(_full_name=name).first()
873
874
875
876
877
878

    def __init__(self, *args, **kwargs):
        super(Page, self).__init__(*args, **kwargs)

    def clean(self):
        """
Skia's avatar
Skia committed
879
        Cleans up only the name for the moment, but this can be used to make any treatment before saving the object
880
881
882
        """
        if '/' in self.name:
            self.name = self.name.split('/')[-1]
883
        if Page.objects.exclude(pk=self.pk).filter(_full_name=self.get_full_name()).exists():
Skia's avatar
Skia committed
884
885
886
887
            raise ValidationError(
                _('Duplicate page'),
                code='duplicate',
            )
888
        super(Page, self).clean()
Skia's avatar
Skia committed
889
890
891
892
893
894
        if self.parent is not None and self in self.get_parent_list():
            raise ValidationError(
                _('Loop in page tree'),
                code='loop',
            )

Sli's avatar
Sli committed
895
896
897
898
899
900
    def can_be_edited_by(self, user):
        if self.is_club_page and self.club.can_be_edited_by(user):
            # Override normal behavior for clubs
            return True
        return False

Skia's avatar
Skia committed
901
902
903
904
905
906
907
908
    def get_parent_list(self):
        l = []
        p = self.parent
        while p is not None:
            l.append(p)
            p = p.parent
        return l

909
    def save(self, *args, **kwargs):
Skia's avatar
Skia committed
910
911
912
        """
        Performs some needed actions before and after saving a page in database
        """
Skia's avatar
Skia committed
913
        locked = kwargs.pop('force_lock', False)
Krophil's avatar
Krophil committed
914
915
        if not locked:
            locked = self.is_locked()
Skia's avatar
Skia committed
916
        if not locked:
Skia's avatar
Skia committed
917
            raise NotLocked("The page is not locked and thus can not be saved")
918
        self.full_clean()
Skia's avatar
Skia committed
919
        if not self.id:
Krophil's avatar
Krophil committed
920
            super(Page, self).save(*args, **kwargs)  # Save a first time to correctly set _full_name
921
        # This reset the _full_name just before saving to maintain a coherent field quicker for queries than the
Skia's avatar
Skia committed
922
        # recursive method
Skia's avatar
Skia committed
923
        # It also update all the children to maintain correct names
924
        self._full_name = self.get_full_name()
Skia's avatar
Skia committed
925
926
        for c in self.children.all():
            c.save()
927
        super(Page, self).save(*args, **kwargs)
Skia's avatar
Skia committed
928
929
930
931
932
933
934
935
        self.unset_lock()

    def is_locked(self):
        """
        Is True if the page is locked, False otherwise
        This is where the timeout is handled, so a locked page for which the timeout is reach will be unlocked and this
        function will return False
        """
Skia's avatar
Skia committed
936
        if self.lock_timeout and (timezone.now() - self.lock_timeout > timedelta(minutes=5)):
Skia's avatar
Skia committed
937
938
            # print("Lock timed out")
            self.unset_lock()
Skia's avatar
Skia committed
939
        return self.lock_user and self.lock_timeout and (timezone.now() - self.lock_timeout < timedelta(minutes=5))
Skia's avatar
Skia committed
940
941
942
943
944

    def set_lock(self, user):
        """
        Sets a lock on the current page or raise an AlreadyLocked exception
        """
Skia's avatar
Skia committed
945
        if self.is_locked() and self.get_lock() != user:
Skia's avatar
Skia committed
946
            raise AlreadyLocked("The page is already locked by someone else")
Skia's avatar
Skia committed
947
948
949
        self.lock_user = user
        self.lock_timeout = timezone.now()
        super(Page, self).save()
Skia's avatar
Skia committed
950
        # print("Locking page")
Skia's avatar
Skia committed
951
952
953
954
955
956
957
958
959

    def set_lock_recursive(self, user):
        """
        Locks recursively all the child pages for editing properties
        """
        for p in self.children.all():
            p.set_lock_recursive(user)
        self.set_lock(user)

960
961
962
963
964
965
966
967
    def unset_lock_recursive(self):
        """
        Unlocks recursively all the child pages
        """
        for p in self.children.all():
            p.unset_lock_recursive()
        self.unset_lock()

Skia's avatar
Skia committed
968
969
    def unset_lock(self):
        """Always try to unlock, even if there is no lock"""
Skia's avatar
Skia committed
970
971
972
        self.lock_user = None
        self.lock_timeout = None
        super(Page, self).save()
Skia's avatar
Skia committed
973
        # print("Unlocking page")
Skia's avatar
Skia committed
974
975
976
977
978

    def get_lock(self):
        """
        Returns the page's mutex containing the time and the user in a dict
        """
Skia's avatar
Skia committed
979
980
981
        if self.lock_user:
            return self.lock_user
        raise NotLocked("The page is not locked and thus can not return its user")
982

983
984
985
986
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
987
        return reverse('core:page', kwargs={'page_name': self._full_name})
988

Skia's avatar
Skia committed
989
    def __str__(self):
990
991
992
        return self.get_full_name()

    def get_full_name(self):
Skia's avatar
Skia committed
993
994
995
996
997
        """
        Computes the real full_name of the page based on its name and its parent's name
        You can and must rely on this function when working on a page object that is not freshly fetched from the DB
        (For example when treating a Page object coming from a form)
        """
Skia's avatar
Skia committed
998
999
1000
        if self.parent is None:
            return self.name
        return '/'.join([self.parent.get_full_name(), self.name])