models.py 35.5 KB
Newer Older
Skia's avatar
Skia committed
1
from django.db import models
2
from django.core.mail import send_mail
Skia's avatar
Skia committed
3
from django.contrib.auth.models import AbstractBaseUser, PermissionsMixin, UserManager, Group as AuthGroup, GroupManager as AuthGroupManager, AnonymousUser as AuthAnonymousUser
Skia's avatar
Skia committed
4
5
from django.utils.translation import ugettext_lazy as _
from django.utils import timezone
6
7
from django.core import validators
from django.core.exceptions import ValidationError
8
from django.core.urlresolvers import reverse
9
from django.conf import settings
Skia's avatar
Skia committed
10
from django.db import transaction
11
12
from django.contrib.staticfiles.storage import staticfiles_storage
from django.utils.html import escape
13
14
from django.utils.functional import cached_property

Skia's avatar
Skia committed
15
16
from phonenumber_field.modelfields import PhoneNumberField

17
from datetime import datetime, timedelta, date
Skia's avatar
Skia committed
18

Skia's avatar
Skia committed
19
20
import unicodedata

Skia's avatar
Skia committed
21
22
23
24
25
26
27
28
class RealGroupManager(AuthGroupManager):
    def get_queryset(self):
        return super(RealGroupManager, self).get_queryset().filter(is_meta=False)

class MetaGroupManager(AuthGroupManager):
    def get_queryset(self):
        return super(MetaGroupManager, self).get_queryset().filter(is_meta=True)

Skia's avatar
Skia committed
29
class Group(AuthGroup):
Skia's avatar
Skia committed
30
31
32
33
34
    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
35
    description = models.CharField(_('description'), max_length=60)
Skia's avatar
Skia committed
36
37
38
39
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
Skia's avatar
Skia committed
40
        return reverse('core:group_list')
Skia's avatar
Skia committed
41

Skia's avatar
Skia committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
class MetaGroup(Group):
    objects = MetaGroupManager()
    class Meta:
        proxy = True

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

class RealGroup(Group):
    objects = RealGroupManager()
    class Meta:
        proxy = True

56
57
58
59
60
61
62
63
64
def validate_promo(value):
    start_year = settings.SITH_SCHOOL_START_YEAR
    delta = (date.today()+timedelta(days=180)).year - start_year
    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},
        )

65
class User(AbstractBaseUser):
Skia's avatar
Skia committed
66
67
    """
    Defines the base user class, useable in every app
Skia's avatar
Skia committed
68

Skia's avatar
Skia committed
69
70
71
    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
72

73
    Added field: nick_name, date_of_birth
Skia's avatar
Skia committed
74
75
76
77
78
79
    Required fields: email, first_name, last_name, date_of_birth
    """
    username = models.CharField(
        _('username'),
        max_length=254,
        unique=True,
Skia's avatar
Skia committed
80
        help_text=_('Required. 254 characters or fewer. Letters, digits and ./+/-/_ only.'),
Skia's avatar
Skia committed
81
82
        validators=[
            validators.RegexValidator(
Skia's avatar
Skia committed
83
                r'^[\w.+-]+$',
Skia's avatar
Skia committed
84
                _('Enter a valid username. This value may contain only '
Skia's avatar
Skia committed
85
                  'letters, numbers ' 'and ./+/-/_ characters.')
Skia's avatar
Skia committed
86
87
88
89
90
91
            ),
        ],
        error_messages={
            'unique': _("A user with that username already exists."),
        },
    )
Skia's avatar
Skia committed
92
93
    first_name = models.CharField(_('first name'), max_length=64)
    last_name = models.CharField(_('last name'), max_length=64)
Skia's avatar
Skia committed
94
    email = models.EmailField(_('email address'), unique=True)
Skia's avatar
Skia committed
95
    date_of_birth = models.DateField(_('date of birth'), blank=True, null=True)
Skia's avatar
Skia committed
96
    nick_name = models.CharField(_('nick name'), max_length=64, null=True, blank=True)
Skia's avatar
Skia committed
97
98
99
100
101
102
103
104
105
106
107
108
109
    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
110
    date_joined = models.DateField(_('date joined'), auto_now_add=True)
111
    last_update = models.DateTimeField(_('last update'), auto_now=True)
112
113
114
115
116
117
118
119
    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
120
121
    home = models.OneToOneField('SithFile', related_name='home_of', verbose_name=_("home"), null=True, blank=True,
            on_delete=models.SET_NULL)
Skia's avatar
Skia committed
122
123
124
125
126
127
    profile_pict = models.OneToOneField('SithFile', related_name='profile_of', verbose_name=_("profile"), null=True,
            blank=True, on_delete=models.SET_NULL)
    avatar_pict = models.OneToOneField('SithFile', related_name='avatar_of', verbose_name=_("avatar"), null=True,
            blank=True, on_delete=models.SET_NULL)
    scrub_pict = models.OneToOneField('SithFile', related_name='scrub_of', verbose_name=_("scrub"), null=True,
            blank=True, on_delete=models.SET_NULL)
128
129
130
131
132
133
134
135
136
137
    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")),
Skia's avatar
Skia committed
138
        ], default="-")
139
140
141
142
143
144
145
146
    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")),
Skia's avatar
Skia committed
147
        ], blank=True, default="")
Skia's avatar
Skia committed
148
149
    department = models.CharField(_("department"), max_length=15, choices=settings.SITH_PROFILE_DEPARTMENTS,
            default="NA", blank=True)
Skia's avatar
Skia committed
150
151
152
153
    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="")
154
    promo = models.IntegerField(_("promo"), validators=[validate_promo], null=True, blank=True)
Skia's avatar
Skia committed
155
156
157
158
159
160
    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
161
    is_subscriber_viewable = models.BooleanField(_("is subscriber viewable"), default=True)
Skia's avatar
Skia committed
162
    godfathers = models.ManyToManyField('User', related_name='godchildren', blank=True)
Skia's avatar
Skia committed
163
164
165
166

    objects = UserManager()

    USERNAME_FIELD = 'username'
Skia's avatar
Skia committed
167
    # REQUIRED_FIELDS = ['email']
Skia's avatar
Skia committed
168

169
170
171
172
173
174
    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
175
176
177
178
179
180
    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
181
    def __str__(self):
Skia's avatar
Skia committed
182
        return self.get_display_name()
Skia's avatar
Skia committed
183

Skia's avatar
Skia committed
184
185
186
    def to_dict(self):
        return self.__dict__

187
    @cached_property
188
189
190
    def was_subscribed(self):
        return self.subscriptions.exists()

191
    @cached_property
Skia's avatar
Skia committed
192
193
194
195
    def is_subscribed(self):
        s = self.subscriptions.last()
        return s.is_valid_now() if s is not None else False

Skia's avatar
Skia committed
196
    def is_in_group(self, group_name):
Skia's avatar
Skia committed
197
        """If the user is in the group passed in argument (as string or by id)"""
Skia's avatar
Skia committed
198
        group_id = 0
Skia's avatar
Skia committed
199
        g = None
Skia's avatar
Skia committed
200
201
        if isinstance(group_name, int): # Handle the case where group_name is an ID
            g = Group.objects.filter(id=group_name).first()
Skia's avatar
Skia committed
202
203
204
205
206
207
208
        else:
            g = Group.objects.filter(name=group_name).first()
        if g:
            group_name = g.name
            group_id = g.id
        else:
            return False
Skia's avatar
Skia committed
209
        if group_id == settings.SITH_GROUP_PUBLIC_ID:
Skia's avatar
Skia committed
210
            return True
211
        if group_id == settings.SITH_GROUP_SUBSCRIBERS_ID:
212
            return self.is_subscribed
213
        if group_id == settings.SITH_GROUP_OLD_SUBSCRIBERS_ID:
214
            return self.was_subscribed
Skia's avatar
Skia committed
215
        if group_name == settings.SITH_MAIN_MEMBERS_GROUP: # We check the subscription if asked
216
            return self.is_subscribed
Skia's avatar
Skia committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
        if group_name[-len(settings.SITH_BOARD_SUFFIX):] == settings.SITH_BOARD_SUFFIX:
            from club.models import Club
            name = group_name[:-len(settings.SITH_BOARD_SUFFIX)]
            c = Club.objects.filter(unix_name=name).first()
            mem = c.get_membership_for(self)
            if mem:
                return mem.role > settings.SITH_MAXIMUM_FREE_ROLE
            return False
        if group_name[-len(settings.SITH_MEMBER_SUFFIX):] == settings.SITH_MEMBER_SUFFIX:
            from club.models import Club
            name = group_name[:-len(settings.SITH_MEMBER_SUFFIX)]
            c = Club.objects.filter(unix_name=name).first()
            mem = c.get_membership_for(self)
            if mem:
                return True
            return False
Skia's avatar
Skia committed
233
        if group_id == settings.SITH_GROUP_ROOT_ID and self.is_superuser:
Skia's avatar
Skia committed
234
            return True
Skia's avatar
Skia committed
235
236
        return self.groups.filter(name=group_name).exists()

237
    @cached_property
Skia's avatar
Skia committed
238
    def is_root(self):
Skia's avatar
Skia committed
239
        return self.is_superuser or self.groups.filter(id=settings.SITH_GROUP_ROOT_ID).exists()
Skia's avatar
Skia committed
240

241
    @cached_property
Sli's avatar
Sli committed
242
    def is_board_member(self):
243
        from club.models import Club
Sli's avatar
Sli committed
244
245
        return Club.objects.filter(unix_name=settings.SITH_MAIN_CLUB['unix_name']).first().get_membership_for(self)

246
    @cached_property
Sli's avatar
Sli committed
247
    def is_launderette_manager(self):
Sli's avatar
Sli committed
248
249
        from club.models import Club
        return Club.objects.filter(unix_name=settings.SITH_LAUNDERETTE_MANAGER['unix_name']).first().get_membership_for(self)
250

251
    @cached_property
252
    def is_banned_alcohol(self):
Skia's avatar
Skia committed
253
        return self.is_in_group(settings.SITH_GROUP_BANNED_ALCOHOL_ID)
254

255
    @cached_property
256
    def is_banned_counter(self):
Skia's avatar
Skia committed
257
        return self.is_in_group(settings.SITH_GROUP_BANNED_COUNTER_ID)
258

Skia's avatar
Skia committed
259
    def save(self, *args, **kwargs):
260
        create = False
Skia's avatar
Skia committed
261
262
263
        with transaction.atomic():
            if self.id:
                old = User.objects.filter(id=self.id).first()
Skia's avatar
Skia committed
264
                if old and old.username != self.username:
Skia's avatar
Skia committed
265
                    self._change_username(self.username)
266
267
            else:
                create = True
Skia's avatar
Skia committed
268
            super(User, self).save(*args, **kwargs)
Sli's avatar
Sli committed
269
            if create and settings.IS_OLD_MYSQL_PRESENT: # Create user on the old site: TODO remove me!
270
271
272
273
274
275
276
277
278
279
280
281
282
                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:
                    with open(settings.BASE_DIR+"/user_fail.log", "a") as f:
                        print("FAIL to add user %s (%s %s - %s) to old site" % (self.id, self.first_name, self.last_name,
                            self.email), file=f)
                        print("Reason: %s" % (repr(e)), file=f)
                    db.rollback()
Skia's avatar
Skia committed
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301

    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
302
303
304
305
306
307
308
309
    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
310
311
312
313
314
315
316
317
318
    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
319
320
321
        if self.nick_name:
            return self.nick_name
        return self.first_name + " " + self.last_name
Skia's avatar
Skia committed
322

Skia's avatar
Skia committed
323
324
325
326
327
    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
328
329
        if self.nick_name:
            return "%s (%s)" % (self.get_full_name(), self.nick_name)
Skia's avatar
Skia committed
330
331
        return self.get_full_name()

332
333
334
335
    def get_age(self):
        """
        Returns the age
        """
Sli's avatar
Sli committed
336
337
338
        today = timezone.now()
        born = self.date_of_birth
        return today.year - born.year - ((today.month, today.day) < (born.month, born.day))
339

Skia's avatar
Skia committed
340
341
342
343
    def email_user(self, subject, message, from_email=None, **kwargs):
        """
        Sends an email to this User.
        """
344
345
        if from_email is None:
            from_email = settings.DEFAULT_FROM_EMAIL
Skia's avatar
Skia committed
346
347
348
349
350
351
352
353
        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
354
355
356
357
        def remove_accents(data):
            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
358
359
360
361
362
363
364
365
        un_set = [u.username for u in User.objects.all()]
        if user_name in un_set:
            i = 1
            while user_name+str(i) in un_set:
                i += 1
            user_name += str(i)
        self.username = user_name
        return user_name
Skia's avatar
Skia committed
366

Skia's avatar
Skia committed
367
368
369
370
    def is_owner(self, obj):
        """
        Determine if the object is owned by the user
        """
Skia's avatar
Skia committed
371
372
        if hasattr(obj, "is_owned_by") and obj.is_owned_by(self):
            return True
Skia's avatar
Skia committed
373
        if hasattr(obj, "owner_group") and self.is_in_group(obj.owner_group.name):
Skia's avatar
Skia committed
374
            return True
Skia's avatar
Skia committed
375
        if self.is_superuser or self.is_in_group(settings.SITH_GROUP_ROOT_ID):
Skia's avatar
Skia committed
376
            return True
Skia's avatar
Skia committed
377
378
379
380
381
382
        return False

    def can_edit(self, obj):
        """
        Determine if the object can be edited by the user
        """
Skia's avatar
Skia committed
383
        if hasattr(obj, "can_be_edited_by") and obj.can_be_edited_by(self):
Skia's avatar
Skia committed
384
            return True
Skia's avatar
Skia committed
385
386
        if hasattr(obj, "edit_groups"):
            for g in obj.edit_groups.all():
Skia's avatar
Skia committed
387
                if self.is_in_group(g.name):
388
                    return True
389
390
        if isinstance(obj, User) and obj == self:
            return True
Skia's avatar
Skia committed
391
        if self.is_owner(obj):
Skia's avatar
Skia committed
392
            return True
Skia's avatar
Skia committed
393
394
395
396
397
398
        return False

    def can_view(self, obj):
        """
        Determine if the object can be viewed by the user
        """
Skia's avatar
Skia committed
399
        if hasattr(obj, "can_be_viewed_by") and obj.can_be_viewed_by(self):
Skia's avatar
Skia committed
400
            return True
Skia's avatar
Skia committed
401
402
        if hasattr(obj, "view_groups"):
            for g in obj.view_groups.all():
Skia's avatar
Skia committed
403
                if self.is_in_group(g.name):
404
                    return True
Skia's avatar
Skia committed
405
        if self.can_edit(obj):
Skia's avatar
Skia committed
406
            return True
Skia's avatar
Skia committed
407
408
        return False

Skia's avatar
Skia committed
409
    def can_be_edited_by(self, user):
Skia's avatar
Skia committed
410
        return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP) or user.is_root
Skia's avatar
Skia committed
411

Skia's avatar
Skia committed
412
    def can_be_viewed_by(self, user):
Skia's avatar
Skia committed
413
        return (user.was_subscribed and self.is_subscriber_viewable) or user.is_root
Skia's avatar
Skia committed
414

415
416
417
418
419
420
421
422
423
    def get_mini_item(self):
        return """
    <div class="mini_profile_link" >
    <span>
    <img src="%s" alt="%s" />
    </span>
    <em>%s</em>
    </a>
    """ % (
424
            self.profile_pict.get_download_url() if self.profile_pict else staticfiles_storage.url("core/img/unknown.jpg"),
425
            _("Profile"),
426
            escape(self.get_display_name()),
427
428
            )

429
    @cached_property
Skia's avatar
Skia committed
430
431
    def subscribed(self):
        return self.is_in_group(settings.SITH_MAIN_MEMBERS_GROUP)
Skia's avatar
Skia committed
432

433
    @cached_property
Skia's avatar
Skia committed
434
435
436
437
438
439
440
441
442
    def forum_infos(self):
        try:
            return self._forum_infos
        except:
            from forum.models import ForumUserInfo
            infos = ForumUserInfo(user=self)
            infos.save()
            return infos

443
444
445
446
class AnonymousUser(AuthAnonymousUser):
    def __init__(self, request):
        super(AnonymousUser, self).__init__()

Skia's avatar
Skia committed
447
448
449
    def was_subscribed(self):
        return False

Skia's avatar
Skia committed
450
451
452
453
    @property
    def subscribed(self):
        return False

Skia's avatar
Skia committed
454
455
456
457
    @property
    def is_root(self):
        return False

458
459
460
461
462
463
464
465
    @property
    def is_board_member(self):
        return False

    @property
    def is_launderette_manager(self):
        return False

466
467
468
469
470
471
472
473
    @property
    def is_banned_alcohol(self):
        return False

    @property
    def is_banned_conuter(self):
        return False

474
475
476
477
    def is_in_group(self, group_name):
        """
        The anonymous user is only the public group
        """
Skia's avatar
Skia committed
478
479
480
481
482
483
484
485
486
        group_id = 0
        if isinstance(group_name, int): # Handle the case where group_name is an ID
            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:
487
488
489
            return True
        return False

490
491
492
493
494
495
496
    def is_owner(self, obj):
        return False

    def can_edit(self, obj):
        return False

    def can_view(self, obj):
Skia's avatar
Skia committed
497
        if hasattr(obj, 'view_groups') and obj.view_groups.filter(id=settings.SITH_GROUP_PUBLIC_ID).exists():
Skia's avatar
Skia committed
498
499
            return True
        if hasattr(obj, 'can_be_viewed_by') and obj.can_be_viewed_by(self):
500
501
502
            return True
        return False

503
504
505
    def get_display_name(self):
        return _("Visitor")

506
507
class Preferences(models.Model):
    user = models.OneToOneField(User, related_name="preferences")
Skia's avatar
Skia committed
508
509
510
511
512
    receive_weekmail = models.BooleanField(
        _('do you want to receive the weekmail'),
        default=False,
        # help_text=_('Do you want to receive the weekmail?'),
    )
513
514
515
516
517
518
    show_my_stats = models.BooleanField(
        _('define if we show a users stats'),
        default=False,
        help_text=_('Show your account statistics to others'),
    )

Skia's avatar
Skia committed
519
520
521
522
523
524
    def get_display_name(self):
        return self.user.get_display_name()

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

Skia's avatar
Skia committed
525
def get_directory(instance, filename):
Skia's avatar
Skia committed
526
    return '.{0}/{1}'.format(instance.get_parent_path(), filename)
Skia's avatar
Skia committed
527

Skia's avatar
Skia committed
528
529
530
531
532
533
def get_compressed_directory(instance, filename):
    return '.{0}/compressed/{1}'.format(instance.get_parent_path(), filename)

def get_thumbnail_directory(instance, filename):
    return '.{0}/thumbnail/{1}'.format(instance.get_parent_path(), filename)

Skia's avatar
Skia committed
534
class SithFile(models.Model):
Skia's avatar
Skia committed
535
    name = models.CharField(_('file name'), max_length=256, blank=False)
Skia's avatar
Skia committed
536
    parent = models.ForeignKey('self', related_name="children", verbose_name=_("parent"), null=True, blank=True)
Skia's avatar
Skia committed
537
538
539
    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
540
541
542
543
544
545
    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
546
    date = models.DateTimeField(_('date'), default=timezone.now)
Skia's avatar
Skia committed
547
    is_moderated = models.BooleanField(_("is moderated"), default=False)
Skia's avatar
Skia committed
548
    moderator = models.ForeignKey(User, related_name="moderated_files", verbose_name=_("owner"), null=True, blank=True)
549
    asked_for_removal = models.BooleanField(_("asked for removal"), default=False)
Skia's avatar
Skia committed
550
    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
551
552
553
554
555

    class Meta:
        verbose_name = _("file")

    def is_owned_by(self, user):
Skia's avatar
Skia committed
556
557
        if hasattr(self, 'profile_of') and user.is_in_group(settings.SITH_MAIN_BOARD_GROUP):
            return True
Skia's avatar
Skia committed
558
        if user.is_in_group(settings.SITH_GROUP_COM_ADMIN_ID):
Skia's avatar
Skia committed
559
            return True
Skia's avatar
Skia committed
560
561
        if self.is_in_sas and user.is_in_group(settings.SITH_GROUP_SAS_ADMIN_ID):
            return True
Skia's avatar
Skia committed
562
563
        return user.id == self.owner.id

564
565
566
567
568
569
570
571
572
    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
573
574
575
576
    def delete(self):
        for c in self.children.all():
            c.delete()
        self.file.delete()
Skia's avatar
Skia committed
577
578
579
580
        if self.compressed:
            self.compressed.delete()
        if self.thumbnail:
            self.thumbnail.delete()
Skia's avatar
Skia committed
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
        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
609
610
611
612
613
614
615
616
            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
617
618
619
620
621
            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):
622
623
        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
624
625
626
627
628
629
630
        copy_rights = False
        if self.id is None:
            copy_rights = True
        super(SithFile, self).save(*args, **kwargs)
        if copy_rights:
            self.copy_rights()

631
632
633
634
635
636
637
638
    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
639
640
641
642
643
644
645
    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
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
    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)
                shutil.rmtree(settings.MEDIA_ROOT + old_file_name)
            else:
                self.file.save(name=self.name, content=self.file)
                os.remove(settings.MEDIA_ROOT + old_file_name)

Skia's avatar
Skia committed
667
668
669
670
    def __getattribute__(self, attr):
        if attr == "is_file":
            return not self.is_folder
        else:
Skia's avatar
Skia committed
671
            return super(SithFile, self).__getattribute__(attr)
Skia's avatar
Skia committed
672

673
    @cached_property
Skia's avatar
Skia committed
674
675
676
677
    def as_picture(self):
        from sas.models import Picture
        return Picture.objects.filter(id=self.id).first()

678
    @cached_property
679
680
681
682
    def as_album(self):
        from sas.models import Album
        return Album.objects.filter(id=self.id).first()

Skia's avatar
Skia committed
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
    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
698
        return '/' + '/'.join([p.name for p in self.get_parent_list()[::-1]])
Skia's avatar
Skia committed
699

Skia's avatar
Skia committed
700
701
702
    def get_full_path(self):
        return self.get_parent_path() + '/' + self.name

Skia's avatar
Skia committed
703
704
705
    def get_display_name(self):
        return self.name

706
707
708
    def get_download_url(self):
        return reverse('core:download', kwargs={'file_id': self.id})

Skia's avatar
Skia committed
709
710
711
    def __str__(self):
        return self.get_parent_path() + "/" + self.name

Skia's avatar
Skia committed
712
713
714
715
716
717
718
719
720
721
722
723
class LockError(Exception):
    """There was a lock error on the object"""
    pass

class AlreadyLocked(LockError):
    """The object is already locked"""
    pass

class NotLocked(LockError):
    """The object is not locked"""
    pass

Skia's avatar
Skia committed
724
class Page(models.Model):
Skia's avatar
Skia committed
725
726
727
728
729
730
731
    """
    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()

732
    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
733
734
    query, but don't rely on it when playing with a Page object, use get_full_name() instead!
    """
Skia's avatar
Skia committed
735
736
737
738
739
740
741
742
743
    name = models.CharField(_('page unix name'), max_length=30,
            validators=[
                validators.RegexValidator(
                    r'^[\w.+-]+$',
                    _('Enter a valid page name. This value may contain only '
                      'letters, numbers ' 'and ./+/-/_ characters.')
                ),
            ],
            blank=False)
Skia's avatar
Skia committed
744
    parent = models.ForeignKey('self', related_name="children", verbose_name=_("parent"), null=True, blank=True, on_delete=models.SET_NULL)
Skia's avatar
Skia committed
745
746
    # 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!
747
    _full_name = models.CharField(_('page name'), max_length=255, blank=True)
Skia's avatar
Skia committed
748
    owner_group = models.ForeignKey(Group, related_name="owned_page", verbose_name=_("owner group"),
Skia's avatar
Skia committed
749
                                    default=settings.SITH_GROUP_ROOT_ID)
Skia's avatar
Skia committed
750
751
    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
752
753
    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
754

Skia's avatar
Skia committed
755
    class Meta:
756
        unique_together = ('name', 'parent')
Skia's avatar
Skia committed
757
        permissions = (
758
759
            ("change_prop_page", "Can change the page's properties (groups, ...)"),
            ("view_page", "Can view the page"),
Skia's avatar
Skia committed
760
761
        )

762
763
    @staticmethod
    def get_page_by_full_name(name):
Skia's avatar
Skia committed
764
765
766
        """
        Quicker to get a page with that method rather than building the request every time
        """
767
        return Page.objects.filter(_full_name=name).first()
768
769
770
771
772
773

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

    def clean(self):
        """
Skia's avatar
Skia committed
774
        Cleans up only the name for the moment, but this can be used to make any treatment before saving the object
775
776
777
        """
        if '/' in self.name:
            self.name = self.name.split('/')[-1]
778
        if Page.objects.exclude(pk=self.pk).filter(_full_name=self.get_full_name()).exists():
Skia's avatar
Skia committed
779
780
781
782
            raise ValidationError(
                _('Duplicate page'),
                code='duplicate',
            )
783
        super(Page, self).clean()
Skia's avatar
Skia committed
784
785
786
787
788
789
790
791
792
793
794
795
796
797
        if self.parent is not None and self in self.get_parent_list():
            raise ValidationError(
                _('Loop in page tree'),
                code='loop',
            )

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

798
    def save(self, *args, **kwargs):
Skia's avatar
Skia committed
799
800
801
        """
        Performs some needed actions before and after saving a page in database
        """
Skia's avatar
Skia committed
802
803
804
        locked = kwargs.pop('force_lock', False)
        if not locked: locked = self.is_locked()
        if not locked:
Skia's avatar
Skia committed
805
            raise NotLocked("The page is not locked and thus can not be saved")
806
        self.full_clean()
Skia's avatar
Skia committed
807
808
        if not self.id:
            super(Page, self).save(*args, **kwargs) # Save a first time to correctly set _full_name
809
        # This reset the _full_name just before saving to maintain a coherent field quicker for queries than the
Skia's avatar
Skia committed
810
        # recursive method
Skia's avatar
Skia committed
811
        # It also update all the children to maintain correct names
812
        self._full_name = self.get_full_name()
Skia's avatar
Skia committed
813
814
        for c in self.children.all():
            c.save()
815
        super(Page, self).save(*args, **kwargs)
Skia's avatar
Skia committed
816
817
818
819
820
821
822
823
        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
824
        if self.lock_timeout and (timezone.now() - self.lock_timeout > timedelta(minutes=5)):
Skia's avatar
Skia committed
825
826
            # print("Lock timed out")
            self.unset_lock()
Skia's avatar
Skia committed
827
        return self.lock_user and self.lock_timeout and (timezone.now() - self.lock_timeout < timedelta(minutes=5))
Skia's avatar
Skia committed
828
829
830
831
832

    def set_lock(self, user):
        """
        Sets a lock on the current page or raise an AlreadyLocked exception
        """
Skia's avatar
Skia committed
833
        if self.is_locked() and self.get_lock() != user:
Skia's avatar
Skia committed
834
            raise AlreadyLocked("The page is already locked by someone else")
Skia's avatar
Skia committed
835
836
837
        self.lock_user = user
        self.lock_timeout = timezone.now()
        super(Page, self).save()
Skia's avatar
Skia committed
838
        # print("Locking page")
Skia's avatar
Skia committed
839
840
841
842
843
844
845
846
847
848
849

    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)

    def unset_lock(self):
        """Always try to unlock, even if there is no lock"""
Skia's avatar
Skia committed
850
851
852
        self.lock_user = None
        self.lock_timeout = None
        super(Page, self).save()
Skia's avatar
Skia committed
853
        # print("Unlocking page")
Skia's avatar
Skia committed
854
855
856
857
858

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

863
864
865
866
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
867
        return reverse('core:page', kwargs={'page_name': self._full_name})
868

Skia's avatar
Skia committed
869
    def __str__(self):
870
871
872
        return self.get_full_name()

    def get_full_name(self):
Skia's avatar
Skia committed
873
874
875
876
877
        """
        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
878
879
880
        if self.parent is None:
            return self.name
        return '/'.join([self.parent.get_full_name(), self.name])
Skia's avatar
Skia committed
881
882

    def get_display_name(self):
Skia's avatar
Skia committed
883
884
885
886
        try:
            return self.revisions.last().title
        except:
            return self.name
Skia's avatar
Skia committed
887

888
class PageRev(models.Model):
Skia's avatar
Skia committed
889
890
891
892
893
894
895
    """
    This is the true content of the page.
    Each page object has a revisions field that is a list of PageRev, ordered by date.
    my_page.revisions.last() gives the PageRev object that is the most up-to-date, and thus,
    is the real content of the page.
    The content is in PageRev.title and PageRev.content .
    """
Skia's avatar
Skia committed
896
    revision = models.IntegerField(_("revision"))
897
898
899
900
901
902
903
904
905
906
907
908
909
    title = models.CharField(_("page title"), max_length=255, blank=True)
    content = models.TextField(_("page content"), blank=True)
    date = models.DateTimeField(_('date'), auto_now=True)
    author = models.ForeignKey(User, related_name='page_rev')
    page = models.ForeignKey(Page, related_name='revisions')

    class Meta:
        ordering = ['date',]

    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
910
        return reverse('core:page', kwargs={'page_name': self.page._full_name})
911
912
913
914

    def __str__(self):
        return str(self.__dict__)

915
916
917
    def __getattribute__(self, attr):
        if attr == "owner_group":
            return self.page.owner_group
Skia's avatar
Skia committed
918
919
920
921
        elif attr == "edit_groups":
            return self.page.edit_groups
        elif attr == "view_groups":
            return self.page.view_groups
Skia's avatar
Skia committed
922
923
        elif attr == "unset_lock":
            return self.page.unset_lock
924
925
926
        else:
            return object.__getattribute__(self, attr)

Skia's avatar
Skia committed
927
    def save(self, *args, **kwargs):
Skia's avatar
Skia committed
928
929
        if self.revision is None:
            self.revision = self.page.revisions.all().count() + 1
Skia's avatar
Skia committed
930
931
932
        super(PageRev, self).save(*args, **kwargs)
        # Don't forget to unlock, otherwise, people will have to wait for the page's timeout
        self.page.unset_lock()
933

Skia's avatar
Skia committed
934
935
936
class Notification(models.Model):
    user = models.ForeignKey(User, related_name='notifications')
    url = models.CharField(_("url"), max_length=255)
Skia's avatar
Skia committed
937
938
    param = models.CharField(_("param"), max_length=128, default="")
    type = models.CharField(_("type"), max_length=32, choices=settings.SITH_NOTIFICATIONS, default="GENERIC")
Skia's avatar
Skia committed
939
    date = models.DateTimeField(_('date'), default=timezone.now)
Skia's avatar
Skia committed
940
    viewed = models.BooleanField(_('viewed'), default=False)
Skia's avatar
Skia committed
941

Skia's avatar
Skia committed
942
943
944
945
    def __str__(self):
        if self.param:
            return self.get_type_display() % self.param
        return self.get_type_display()
Skia's avatar
Skia committed
946