models.py 15.5 KB
Newer Older
Skia's avatar
Skia committed
1
from django.db import models
2
from django.contrib.auth.models import AbstractBaseUser, PermissionsMixin, UserManager, Group as AuthGroup, 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 datetime import datetime, timedelta
Skia's avatar
Skia committed
10

Skia's avatar
Skia committed
11
12
import unicodedata

Skia's avatar
Skia committed
13
14
15
16
17
18
19
class Group(AuthGroup):
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
        return reverse('core:group_edit', kwargs={'group_id': self.pk})

Skia's avatar
Skia committed
20
21
22
class User(AbstractBaseUser, PermissionsMixin):
    """
    Defines the base user class, useable in every app
Skia's avatar
Skia committed
23

Skia's avatar
Skia committed
24
25
26
    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
27

28
    Added field: nick_name, date_of_birth
Skia's avatar
Skia committed
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
    Required fields: email, first_name, last_name, date_of_birth
    """
    username = models.CharField(
        _('username'),
        max_length=254,
        unique=True,
        help_text=_('Required. 254 characters or fewer. Letters, digits and @/./+/-/_ only.'),
        validators=[
            validators.RegexValidator(
                r'^[\w.@+-]+$',
                _('Enter a valid username. This value may contain only '
                  'letters, numbers ' 'and @/./+/-/_ characters.')
            ),
        ],
        error_messages={
            'unique': _("A user with that username already exists."),
        },
    )
    first_name = models.CharField(_('first name'), max_length=30)
    last_name = models.CharField(_('last name'), max_length=30)
    email = models.EmailField(_('email address'), unique=True)
Skia's avatar
Skia committed
50
    date_of_birth = models.DateField(_('date of birth'))
Skia's avatar
Skia committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
    nick_name = models.CharField(max_length=30, blank=True)
    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
65
    date_joined = models.DateField(_('date joined'), auto_now_add=True)
66
67
    owner_group = models.ForeignKey(Group, related_name="owned_user",
                                    default=settings.AE_GROUPS['root']['id'])
Skia's avatar
Skia committed
68
69
    edit_groups = models.ManyToManyField(Group, related_name="editable_user", blank=True)
    view_groups = models.ManyToManyField(Group, related_name="viewable_user", blank=True)
Skia's avatar
Skia committed
70
71
72
73

    objects = UserManager()

    USERNAME_FIELD = 'username'
74
    REQUIRED_FIELDS = ['email', 'date_of_birth']
Skia's avatar
Skia committed
75
76
77
78

    class Meta:
        verbose_name = _('user')
        verbose_name_plural = _('users')
79
80
81
        # Add permissions like this to allow automatic permission validation in is_owner&co
        # model: change_prop_<class_name>
        #        view_<class_name>
82
83
        permissions = (
            ("change_prop_user", "Can change the user's properties (groups, ...)"),
84
            ("view_user", "Can view user's profile"),
85
        )
Skia's avatar
Skia committed
86

Skia's avatar
Skia committed
87
88
89
90
91
92
    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
93
    def __str__(self):
Skia's avatar
Skia committed
94
95
        return self.username

Skia's avatar
Skia committed
96
97
98
    def to_dict(self):
        return self.__dict__

Skia's avatar
Skia committed
99
100
101
102
    def is_in_group(self, group_name):
        """If the user is in the group passed in argument (as string)"""
        return self.groups.filter(name=group_name).exists()

Skia's avatar
Skia committed
103
104
105
106
107
108
109
110
    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
111
112
113
114
115
116
117
118
119
120
121
    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
122
123
124
125
126
127
128
129
130
    def get_display_name(self):
        """
        Returns the display name of the user.
        A nickname if possible, otherwise, the full name
        """
        if self.nick_name != "":
            return self.nick_name
        return self.get_full_name()

Skia's avatar
Skia committed
131
132
133
134
135
136
137
138
139
140
141
142
    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
143
144
145
146
        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
147
148
149
150
151
152
153
154
        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
155

Skia's avatar
Skia committed
156
157
158
159
160
161
    def is_owner(self, obj):
        """
        Determine if the object is owned by the user
        """
        if not hasattr(obj, "owner_group"):
            return False
162
        if (self.is_superuser or self.groups.filter(name=obj.owner_group.name).exists() or
163
164
            self.has_perm(obj.__class__.__module__.split('.')[0]+".change_prop_"+obj.__class__.__name__.lower()) or
            self.groups.filter(id=settings.AE_GROUPS['root']['id']).exists()):
Skia's avatar
Skia committed
165
            return True
Skia's avatar
Skia committed
166
167
        if hasattr(obj, "is_owned_by") and obj.is_owned_by(self):
            return True
Skia's avatar
Skia committed
168
169
170
171
172
173
174
175
        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
176
177
        if hasattr(obj, "edit_groups"):
            for g in obj.edit_groups.all():
178
179
                if self.groups.filter(name=g.name).exists():
                    return True
180
181
        if isinstance(obj, User) and obj == self:
            return True
Skia's avatar
Skia committed
182
183
        if hasattr(obj, "can_be_edited_by") and obj.can_be_edited_by(self):
            return True
184
185
        if self.has_perm(obj.__class__.__module__.split('.')[0]+".change_"+obj.__class__.__name__.lower()):
            return True
Skia's avatar
Skia committed
186
187
188
189
190
191
192
193
        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
194
195
        if hasattr(obj, "view_groups"):
            for g in obj.view_groups.all():
196
197
                if self.groups.filter(name=g.name).exists():
                    return True
Skia's avatar
Skia committed
198
199
        if hasattr(obj, "can_be_viewed_by") and obj.can_be_viewed_by(self):
            return True
200
201
        if self.has_perm(obj.__class__.__module__.split('.')[0]+".view_"+obj.__class__.__name__.lower()):
            return True
Skia's avatar
Skia committed
202
203
        return False

Skia's avatar
Skia committed
204
205
206
207
    def can_be_edited_by(self, user):
        return user.is_in_group(settings.AE_GROUPS['board']['name']) or user.is_in_group(settings.AE_GROUPS['root']['name'])


208
209
210
211
212
213
214
215
216
217
218
class AnonymousUser(AuthAnonymousUser):
    def __init__(self, request):
        super(AnonymousUser, self).__init__()

    def is_owner(self, obj):
        return False

    def can_edit(self, obj):
        return False

    def can_view(self, obj):
Skia's avatar
Skia committed
219
        if obj.view_groups.filter(pk=settings.AE_GROUPS['public']['id']).exists():
220
221
222
            return True
        return False

Skia's avatar
Skia committed
223
224
225
226
227
228
229
230
231
232
233
234
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
235
class Page(models.Model):
Skia's avatar
Skia committed
236
237
238
239
240
241
242
    """
    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()

243
    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
244
245
    query, but don't rely on it when playing with a Page object, use get_full_name() instead!
    """
Skia's avatar
Skia committed
246
    name = models.CharField(_('page name'), max_length=30, blank=False)
Skia's avatar
Skia committed
247
    parent = models.ForeignKey('self', related_name="children", null=True, blank=True, on_delete=models.SET_NULL)
Skia's avatar
Skia committed
248
249
    # 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!
250
    _full_name = models.CharField(_('page name'), max_length=255, blank=True)
251
252
    owner_group = models.ForeignKey(Group, related_name="owned_page",
                                    default=settings.AE_GROUPS['root']['id'])
Skia's avatar
Skia committed
253
254
    edit_groups = models.ManyToManyField(Group, related_name="editable_page", blank=True)
    view_groups = models.ManyToManyField(Group, related_name="viewable_page", blank=True)
Skia's avatar
Skia committed
255
    lock_mutex = {}
Skia's avatar
Skia committed
256

Skia's avatar
Skia committed
257

Skia's avatar
Skia committed
258
    class Meta:
259
        unique_together = ('name', 'parent')
Skia's avatar
Skia committed
260
        permissions = (
261
262
            ("change_prop_page", "Can change the page's properties (groups, ...)"),
            ("view_page", "Can view the page"),
Skia's avatar
Skia committed
263
264
        )

265
266
    @staticmethod
    def get_page_by_full_name(name):
Skia's avatar
Skia committed
267
268
269
        """
        Quicker to get a page with that method rather than building the request every time
        """
270
        return Page.objects.filter(_full_name=name).first()
271
272
273
274
275
276

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

    def clean(self):
        """
Skia's avatar
Skia committed
277
        Cleans up only the name for the moment, but this can be used to make any treatment before saving the object
278
279
280
        """
        if '/' in self.name:
            self.name = self.name.split('/')[-1]
281
        if Page.objects.exclude(pk=self.pk).filter(_full_name=self.get_full_name()).exists():
Skia's avatar
Skia committed
282
283
284
285
            raise ValidationError(
                _('Duplicate page'),
                code='duplicate',
            )
286
        super(Page, self).clean()
Skia's avatar
Skia committed
287
288
289
290
291
292
293
294
295
296
297
298
299
300
        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

301
    def save(self, *args, **kwargs):
Skia's avatar
Skia committed
302
303
304
305
306
        """
        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")
307
        self.full_clean()
308
        # This reset the _full_name just before saving to maintain a coherent field quicker for queries than the
Skia's avatar
Skia committed
309
        # recursive method
Skia's avatar
Skia committed
310
        # It also update all the children to maintain correct names
311
        self._full_name = self.get_full_name()
Skia's avatar
Skia committed
312
313
        for c in self.children.all():
            c.save()
314
        super(Page, self).save(*args, **kwargs)
Skia's avatar
Skia committed
315
316
317
318
319
320
321
322
323
324
325
        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
326
        if (timezone.now()-Page.lock_mutex[self.pk]['time']) > timedelta(minutes=5):
Skia's avatar
Skia committed
327
328
329
330
331
332
333
334
335
336
337
338
339
            # 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
340
        # print("Locking page")
Skia's avatar
Skia committed
341
342
343
344
345
346
347
348
349
350
351
352

    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
353
        # print("Unlocking page")
Skia's avatar
Skia committed
354
355
356
357
358
359
360
361

    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")
362

363
364
365
366
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
367
        return reverse('core:page', kwargs={'page_name': self._full_name})
368

Skia's avatar
Skia committed
369
    def __str__(self):
370
371
372
        return self.get_full_name()

    def get_full_name(self):
Skia's avatar
Skia committed
373
374
375
376
377
        """
        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
378
379
380
        if self.parent is None:
            return self.name
        return '/'.join([self.parent.get_full_name(), self.name])
Skia's avatar
Skia committed
381
382

    def get_display_name(self):
Skia's avatar
Skia committed
383
        return self.get_full_name()
Skia's avatar
Skia committed
384

385
class PageRev(models.Model):
Skia's avatar
Skia committed
386
387
388
389
390
391
392
    """
    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 .
    """
393
394
395
396
397
398
399
400
401
402
403
404
405
    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
        """
406
        return reverse('core:page', kwargs={'page_name': self.page._full_name})
407
408
409
410

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

411
412
413
    def __getattribute__(self, attr):
        if attr == "owner_group":
            return self.page.owner_group
Skia's avatar
Skia committed
414
415
416
417
        elif attr == "edit_groups":
            return self.page.edit_groups
        elif attr == "view_groups":
            return self.page.view_groups
Skia's avatar
Skia committed
418
419
        elif attr == "unset_lock":
            return self.page.unset_lock
420
421
422
        else:
            return object.__getattribute__(self, attr)

Skia's avatar
Skia committed
423
424
425
426
    def save(self, *args, **kwargs):
        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()
427