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

14
from datetime import datetime, timedelta, date
Skia's avatar
Skia committed
15

Skia's avatar
Skia committed
16
17
import unicodedata

Skia's avatar
Skia committed
18
19
20
21
22
23
24
25
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
26
class Group(AuthGroup):
Skia's avatar
Skia committed
27
28
29
30
31
    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
32
    description = models.CharField(_('description'), max_length=60)
Skia's avatar
Skia committed
33
34
35
36
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
Skia's avatar
Skia committed
37
        return reverse('core:group_list')
Skia's avatar
Skia committed
38

Skia's avatar
Skia committed
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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

53
54
55
56
57
58
59
60
61
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},
        )

62
class User(AbstractBaseUser):
Skia's avatar
Skia committed
63
64
    """
    Defines the base user class, useable in every app
Skia's avatar
Skia committed
65

Skia's avatar
Skia committed
66
67
68
    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
69

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

    objects = UserManager()

    USERNAME_FIELD = 'username'
Skia's avatar
Skia committed
175
    # REQUIRED_FIELDS = ['email']
Skia's avatar
Skia committed
176

177
178
179
180
181
182
    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
183
184
185
186
187
188
    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
189
    def __str__(self):
Skia's avatar
Skia committed
190
        return self.username
Skia's avatar
Skia committed
191

Skia's avatar
Skia committed
192
193
194
    def to_dict(self):
        return self.__dict__

Skia's avatar
Skia committed
195
196
    def is_in_group(self, group_name):
        """If the user is in the group passed in argument (as string)"""
Skia's avatar
Skia committed
197
        if group_name == settings.SITH_GROUPS['public']['name']:
Skia's avatar
Skia committed
198
            return True
Skia's avatar
Skia committed
199
        if group_name == settings.SITH_MAIN_MEMBERS_GROUP: # We check the subscription if asked
Skia's avatar
Skia committed
200
            if 'subscription' in settings.INSTALLED_APPS:
201
                from subscription.models import Subscriber
Skia's avatar
Skia committed
202
203
204
205
206
                s = Subscriber.objects.filter(pk=self.pk).first()
                if s is not None and s.is_subscribed():
                    return True
                else:
                    return False
Skia's avatar
Skia committed
207
            else:
Skia's avatar
Skia committed
208
                return False
Skia's avatar
Skia committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
        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
225
226
        if group_name == settings.SITH_GROUPS['root']['name'] and self.is_superuser:
            return True
Skia's avatar
Skia committed
227
228
        return self.groups.filter(name=group_name).exists()

Skia's avatar
Skia committed
229
    @property
Skia's avatar
Skia committed
230
231
232
    def is_root(self):
        return self.is_superuser or self.groups.filter(name=settings.SITH_GROUPS['root']['name']).exists()

Skia's avatar
Skia committed
233
    def save(self, *args, **kwargs):
234
        create = False
Skia's avatar
Skia committed
235
236
237
        with transaction.atomic():
            if self.id:
                old = User.objects.filter(id=self.id).first()
Skia's avatar
Skia committed
238
                if old and old.username != self.username:
Skia's avatar
Skia committed
239
                    self._change_username(self.username)
240
241
            else:
                create = True
Skia's avatar
Skia committed
242
            super(User, self).save(*args, **kwargs)
Sli's avatar
Sli committed
243
            if create and settings.IS_OLD_MYSQL_PRESENT: # Create user on the old site: TODO remove me!
244
245
246
247
248
249
250
251
252
253
254
255
256
                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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275

    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
276
277
278
279
280
281
282
283
    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
284
285
286
287
288
289
290
291
292
293
294
    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."
        return self.first_name

Skia's avatar
Skia committed
295
296
297
298
299
    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
300
301
        if self.nick_name:
            return "%s (%s)" % (self.get_full_name(), self.nick_name)
Skia's avatar
Skia committed
302
303
        return self.get_full_name()

304
305
306
307
    def get_age(self):
        """
        Returns the age
        """
Sli's avatar
Sli committed
308
309
310
        today = timezone.now()
        born = self.date_of_birth
        return today.year - born.year - ((today.month, today.day) < (born.month, born.day))
311

Skia's avatar
Skia committed
312
313
314
315
316
317
318
319
320
321
322
323
    def email_user(self, subject, message, from_email=None, **kwargs):
        """
        Sends an email to this User.
        """
        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
324
325
326
327
        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
328
329
330
331
332
333
334
335
        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
336

Skia's avatar
Skia committed
337
338
339
340
    def is_owner(self, obj):
        """
        Determine if the object is owned by the user
        """
Skia's avatar
Skia committed
341
342
        if hasattr(obj, "is_owned_by") and obj.is_owned_by(self):
            return True
Skia's avatar
Skia committed
343
        if hasattr(obj, "owner_group") and self.is_in_group(obj.owner_group.name):
Skia's avatar
Skia committed
344
            return True
Skia's avatar
Skia committed
345
346
        if self.is_superuser or self.is_in_group(settings.SITH_GROUPS['root']['name']):
            return True
Skia's avatar
Skia committed
347
348
349
350
351
352
353
354
        return False

    def can_edit(self, obj):
        """
        Determine if the object can be edited by the user
        """
        if self.is_owner(obj):
            return True
Skia's avatar
Skia committed
355
356
        if hasattr(obj, "edit_groups"):
            for g in obj.edit_groups.all():
Skia's avatar
Skia committed
357
                if self.is_in_group(g.name):
358
                    return True
359
360
        if isinstance(obj, User) and obj == self:
            return True
Skia's avatar
Skia committed
361
362
        if hasattr(obj, "can_be_edited_by") and obj.can_be_edited_by(self):
            return True
Skia's avatar
Skia committed
363
364
365
366
367
368
369
370
        return False

    def can_view(self, obj):
        """
        Determine if the object can be viewed by the user
        """
        if self.can_edit(obj):
            return True
Skia's avatar
Skia committed
371
372
        if hasattr(obj, "view_groups"):
            for g in obj.view_groups.all():
Skia's avatar
Skia committed
373
                if self.is_in_group(g.name):
374
                    return True
Skia's avatar
Skia committed
375
376
        if hasattr(obj, "can_be_viewed_by") and obj.can_be_viewed_by(self):
            return True
Skia's avatar
Skia committed
377
378
        return False

Skia's avatar
Skia committed
379
    def can_be_edited_by(self, user):
Skia's avatar
Skia committed
380
        return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP) or user.is_root
Skia's avatar
Skia committed
381

Skia's avatar
Skia committed
382
383
384
    def can_be_viewed_by(self, user):
        return (user.is_in_group(settings.SITH_MAIN_MEMBERS_GROUP) and self.is_subscriber_viewable) or user.is_root

385
386
387
388
389
390
391
392
393
    def get_mini_item(self):
        return """
    <div class="mini_profile_link" >
    <span>
    <img src="%s" alt="%s" />
    </span>
    <em>%s</em>
    </a>
    """ % (
394
            self.profile_pict.get_download_url() if self.profile_pict else staticfiles_storage.url("core/img/unknown.jpg"),
395
            _("Profile"),
396
            escape(self.get_display_name()),
397
398
            )

Skia's avatar
Skia committed
399
400
401
    @property
    def subscribed(self):
        return self.is_in_group(settings.SITH_MAIN_MEMBERS_GROUP)
Skia's avatar
Skia committed
402

403
404
405
406
class AnonymousUser(AuthAnonymousUser):
    def __init__(self, request):
        super(AnonymousUser, self).__init__()

Skia's avatar
Skia committed
407
408
409
410
    @property
    def subscribed(self):
        return False

Skia's avatar
Skia committed
411
412
413
414
    @property
    def is_root(self):
        return False

415
416
417
418
419
420
421
422
    def is_in_group(self, group_name):
        """
        The anonymous user is only the public group
        """
        if group_name == settings.SITH_GROUPS['public']['name']:
            return True
        return False

423
424
425
426
427
428
429
    def is_owner(self, obj):
        return False

    def can_edit(self, obj):
        return False

    def can_view(self, obj):
Skia's avatar
Skia committed
430
431
432
        if hasattr(obj, 'view_groups') and obj.view_groups.filter(pk=settings.SITH_GROUPS['public']['id']).exists():
            return True
        if hasattr(obj, 'can_be_viewed_by') and obj.can_be_viewed_by(self):
433
434
435
            return True
        return False

436
437
438
    def get_display_name(self):
        return _("Visitor")

439
440
441
442
443
444
445
446
class Preferences(models.Model):
    user = models.OneToOneField(User, related_name="preferences")
    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
447
448
449
450
def get_directory(instance, filename):
    return './{0}/{1}'.format(instance.get_parent_path(), filename)

class SithFile(models.Model):
Skia's avatar
Skia committed
451
    name = models.CharField(_('file name'), max_length=256, blank=False)
Skia's avatar
Skia committed
452
453
454
455
456
457
458
459
460
461
462
463
464
465
    parent = models.ForeignKey('self', related_name="children", verbose_name=_("parent"), null=True, blank=True)
    file = models.FileField(upload_to=get_directory, verbose_name=_("file"), null=True, blank=True)
    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)
    date = models.DateTimeField(_('date'), auto_now=True)

    class Meta:
        verbose_name = _("file")

    def is_owned_by(self, user):
Skia's avatar
Skia committed
466
467
        if hasattr(self, 'profile_of') and user.is_in_group(settings.SITH_MAIN_BOARD_GROUP):
            return True
Skia's avatar
Skia committed
468
469
        return user.id == self.owner.id

470
471
472
473
474
475
476
477
478
    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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
    def delete(self):
        for c in self.children.all():
            c.delete()
        self.file.delete()
        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:
            try:
                self.file.delete()
            except: pass
            self.file = None
            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):
        copy_rights = False
        if self.id is None:
            copy_rights = True
        super(SithFile, self).save(*args, **kwargs)
        if copy_rights:
            self.copy_rights()

    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()

    def __getattribute__(self, attr):
        if attr == "is_file":
            return not self.is_folder
        else:
Skia's avatar
Skia committed
538
            return super(SithFile, self).__getattribute__(attr)
Skia's avatar
Skia committed
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559

    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):
        return '/'.join([p.name for p in self.get_parent_list()])

    def get_display_name(self):
        return self.name

560
561
562
    def get_download_url(self):
        return reverse('core:download', kwargs={'file_id': self.id})

Skia's avatar
Skia committed
563
564
565
566
567
568
569
570
571
572
573
574
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
575
class Page(models.Model):
Skia's avatar
Skia committed
576
577
578
579
580
581
582
    """
    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()

583
    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
584
585
    query, but don't rely on it when playing with a Page object, use get_full_name() instead!
    """
Skia's avatar
Skia committed
586
    name = models.CharField(_('page name'), max_length=30, blank=False)
Skia's avatar
Skia committed
587
    parent = models.ForeignKey('self', related_name="children", verbose_name=_("parent"), null=True, blank=True, on_delete=models.SET_NULL)
Skia's avatar
Skia committed
588
589
    # 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!
590
    _full_name = models.CharField(_('page name'), max_length=255, blank=True)
Skia's avatar
Skia committed
591
    owner_group = models.ForeignKey(Group, related_name="owned_page", verbose_name=_("owner group"),
Skia's avatar
Skia committed
592
                                    default=settings.SITH_GROUPS['root']['id'])
Skia's avatar
Skia committed
593
594
    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
595
    lock_mutex = {}
Skia's avatar
Skia committed
596

Skia's avatar
Skia committed
597
    class Meta:
598
        unique_together = ('name', 'parent')
Skia's avatar
Skia committed
599
        permissions = (
600
601
            ("change_prop_page", "Can change the page's properties (groups, ...)"),
            ("view_page", "Can view the page"),
Skia's avatar
Skia committed
602
603
        )

604
605
    @staticmethod
    def get_page_by_full_name(name):
Skia's avatar
Skia committed
606
607
608
        """
        Quicker to get a page with that method rather than building the request every time
        """
609
        return Page.objects.filter(_full_name=name).first()
610
611
612
613
614
615

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

    def clean(self):
        """
Skia's avatar
Skia committed
616
        Cleans up only the name for the moment, but this can be used to make any treatment before saving the object
617
618
619
        """
        if '/' in self.name:
            self.name = self.name.split('/')[-1]
620
        if Page.objects.exclude(pk=self.pk).filter(_full_name=self.get_full_name()).exists():
Skia's avatar
Skia committed
621
622
623
624
            raise ValidationError(
                _('Duplicate page'),
                code='duplicate',
            )
625
        super(Page, self).clean()
Skia's avatar
Skia committed
626
627
628
629
630
631
632
633
634
635
636
637
638
639
        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

640
    def save(self, *args, **kwargs):
Skia's avatar
Skia committed
641
642
643
644
645
        """
        Performs some needed actions before and after saving a page in database
        """
        if not self.is_locked():
            raise NotLocked("The page is not locked and thus can not be saved")
646
        self.full_clean()
647
        # This reset the _full_name just before saving to maintain a coherent field quicker for queries than the
Skia's avatar
Skia committed
648
        # recursive method
Skia's avatar
Skia committed
649
        # It also update all the children to maintain correct names
650
        self._full_name = self.get_full_name()
Skia's avatar
Skia committed
651
652
        for c in self.children.all():
            c.save()
653
        super(Page, self).save(*args, **kwargs)
Skia's avatar
Skia committed
654
655
656
657
658
659
660
661
662
663
664
        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
        """
        if self.pk not in Page.lock_mutex.keys():
            # print("Page mutex does not exists")
            return False
Skia's avatar
Skia committed
665
        if (timezone.now()-Page.lock_mutex[self.pk]['time']) > timedelta(minutes=5):
Skia's avatar
Skia committed
666
667
668
669
670
671
672
673
674
675
676
677
678
            # print("Lock timed out")
            self.unset_lock()
            return False
        return True

    def set_lock(self, user):
        """
        Sets a lock on the current page or raise an AlreadyLocked exception
        """
        if self.is_locked() and self.get_lock()['user'] != user:
            raise AlreadyLocked("The page is already locked by someone else")
        Page.lock_mutex[self.pk] = {'user': user,
                                    'time': timezone.now()}
Skia's avatar
Skia committed
679
        # print("Locking page")
Skia's avatar
Skia committed
680
681
682
683
684
685
686
687
688
689
690
691

    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"""
        Page.lock_mutex.pop(self.pk, None)
Skia's avatar
Skia committed
692
        # print("Unlocking page")
Skia's avatar
Skia committed
693
694
695
696
697
698
699
700

    def get_lock(self):
        """
        Returns the page's mutex containing the time and the user in a dict
        """
        if self.is_locked():
            return Page.lock_mutex[self.pk]
        raise NotLocked("The page is not locked and thus can not return its mutex")
701

702
703
704
705
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
706
        return reverse('core:page', kwargs={'page_name': self._full_name})
707

Skia's avatar
Skia committed
708
    def __str__(self):
709
710
711
        return self.get_full_name()

    def get_full_name(self):
Skia's avatar
Skia committed
712
713
714
715
716
        """
        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
717
718
719
        if self.parent is None:
            return self.name
        return '/'.join([self.parent.get_full_name(), self.name])
Skia's avatar
Skia committed
720
721

    def get_display_name(self):
Skia's avatar
Skia committed
722
723
724
725
        try:
            return self.revisions.last().title
        except:
            return self.name
Skia's avatar
Skia committed
726

727
class PageRev(models.Model):
Skia's avatar
Skia committed
728
729
730
731
732
733
734
    """
    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
735
    revision = models.IntegerField(_("revision"))
736
737
738
739
740
741
742
743
744
745
746
747
748
    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
        """
749
        return reverse('core:page', kwargs={'page_name': self.page._full_name})
750
751
752
753

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

754
755
756
    def __getattribute__(self, attr):
        if attr == "owner_group":
            return self.page.owner_group
Skia's avatar
Skia committed
757
758
759
760
        elif attr == "edit_groups":
            return self.page.edit_groups
        elif attr == "view_groups":
            return self.page.view_groups
Skia's avatar
Skia committed
761
762
        elif attr == "unset_lock":
            return self.page.unset_lock
763
764
765
        else:
            return object.__getattribute__(self, attr)

Skia's avatar
Skia committed
766
    def save(self, *args, **kwargs):
Skia's avatar
Skia committed
767
768
        if self.revision is None:
            self.revision = self.page.revisions.all().count() + 1
Skia's avatar
Skia committed
769
770
771
        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()
772