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

Skia's avatar
Skia committed
34 35 36 37 38 39 40 41 42 43 44 45 46 47
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

48
class User(AbstractBaseUser):
Skia's avatar
Skia committed
49 50
    """
    Defines the base user class, useable in every app
Skia's avatar
Skia committed
51

Skia's avatar
Skia committed
52 53 54
    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
55

56
    Added field: nick_name, date_of_birth
Skia's avatar
Skia committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
    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
78
    date_of_birth = models.DateField(_('date of birth'), blank=True, null=True)
Skia's avatar
Skia committed
79 80 81 82 83 84 85 86 87 88 89 90 91 92
    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
93
    date_joined = models.DateField(_('date joined'), auto_now_add=True)
94 95 96 97 98 99 100 101
    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
102 103 104 105

    objects = UserManager()

    USERNAME_FIELD = 'username'
Skia's avatar
Skia committed
106
    # REQUIRED_FIELDS = ['email']
Skia's avatar
Skia committed
107

108 109 110 111 112 113
    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
114 115 116 117 118 119
    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
120
    def __str__(self):
Skia's avatar
Skia committed
121
        return self.username
Skia's avatar
Skia committed
122

Skia's avatar
Skia committed
123 124 125
    def to_dict(self):
        return self.__dict__

Skia's avatar
Skia committed
126 127
    def is_in_group(self, group_name):
        """If the user is in the group passed in argument (as string)"""
Skia's avatar
Skia committed
128
        if group_name == settings.SITH_GROUPS['public']['name']:
Skia's avatar
Skia committed
129
            return True
Skia's avatar
Skia committed
130
        if group_name == settings.SITH_MAIN_MEMBERS_GROUP: # We check the subscription if asked
Skia's avatar
Skia committed
131
            if 'subscription' in settings.INSTALLED_APPS:
132
                from subscription.models import Subscriber
Skia's avatar
Skia committed
133 134 135 136 137
                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
138
            else:
Skia's avatar
Skia committed
139
                return False
Skia's avatar
Skia committed
140
        if group_name[-6:] == settings.SITH_BOARD_SUFFIX:
Skia's avatar
Skia committed
141
            if 'club' in settings.INSTALLED_APPS:
Skia's avatar
Skia committed
142 143 144
                from club.models import Club
                name = group_name[:-6]
                c = Club.objects.filter(unix_name=name).first()
Skia's avatar
Skia committed
145 146 147 148 149
                mem = c.get_membership_for(self)
                if mem:
                    return mem.role >= 2
                return False
            else:
Skia's avatar
Skia committed
150
                return False
Skia's avatar
Skia committed
151 152
        if group_name == settings.SITH_GROUPS['root']['name'] and self.is_superuser:
            return True
Skia's avatar
Skia committed
153 154
        return self.groups.filter(name=group_name).exists()

Skia's avatar
Skia committed
155 156 157 158 159 160 161 162
    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
163 164 165 166 167 168 169 170 171 172 173
    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
174 175 176 177 178 179 180 181 182
    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
183 184 185 186 187 188 189 190 191 192 193 194
    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
195 196 197 198
        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
199 200 201 202 203 204 205 206
        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
207

Skia's avatar
Skia committed
208 209 210 211
    def is_owner(self, obj):
        """
        Determine if the object is owned by the user
        """
Skia's avatar
Skia committed
212 213
        if hasattr(obj, "is_owned_by") and obj.is_owned_by(self):
            return True
Skia's avatar
Skia committed
214
        if hasattr(obj, "owner_group") and self.is_in_group(obj.owner_group.name):
Skia's avatar
Skia committed
215
            return True
Skia's avatar
Skia committed
216 217
        if self.is_superuser or self.is_in_group(settings.SITH_GROUPS['root']['name']):
            return True
Skia's avatar
Skia committed
218 219 220 221 222 223 224 225
        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
226 227
        if hasattr(obj, "edit_groups"):
            for g in obj.edit_groups.all():
Skia's avatar
Skia committed
228
                if self.is_in_group(g.name):
229
                    return True
230 231
        if isinstance(obj, User) and obj == self:
            return True
Skia's avatar
Skia committed
232 233
        if hasattr(obj, "can_be_edited_by") and obj.can_be_edited_by(self):
            return True
Skia's avatar
Skia committed
234 235 236 237 238 239 240 241
        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
242 243
        if hasattr(obj, "view_groups"):
            for g in obj.view_groups.all():
Skia's avatar
Skia committed
244
                if self.is_in_group(g.name):
245
                    return True
Skia's avatar
Skia committed
246 247
        if hasattr(obj, "can_be_viewed_by") and obj.can_be_viewed_by(self):
            return True
Skia's avatar
Skia committed
248 249
        return False

Skia's avatar
Skia committed
250
    def can_be_edited_by(self, user):
Skia's avatar
Skia committed
251
        return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP) or user.is_in_group(settings.SITH_GROUPS['root']['name'])
Skia's avatar
Skia committed
252 253


254 255 256 257
class AnonymousUser(AuthAnonymousUser):
    def __init__(self, request):
        super(AnonymousUser, self).__init__()

258 259 260 261 262 263 264 265
    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

266 267 268 269 270 271 272
    def is_owner(self, obj):
        return False

    def can_edit(self, obj):
        return False

    def can_view(self, obj):
Skia's avatar
Skia committed
273 274 275
        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):
276 277 278
            return True
        return False

279 280 281
    def get_display_name(self):
        return _("Visitor")

282 283 284 285 286 287 288 289
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
290 291 292 293 294 295 296 297 298 299 300 301
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
302
class Page(models.Model):
Skia's avatar
Skia committed
303 304 305 306 307 308 309
    """
    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()

310
    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
311 312
    query, but don't rely on it when playing with a Page object, use get_full_name() instead!
    """
Skia's avatar
Skia committed
313
    name = models.CharField(_('page name'), max_length=30, blank=False)
Skia's avatar
Skia committed
314
    parent = models.ForeignKey('self', related_name="children", null=True, blank=True, on_delete=models.SET_NULL)
Skia's avatar
Skia committed
315 316
    # 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!
317
    _full_name = models.CharField(_('page name'), max_length=255, blank=True)
318
    owner_group = models.ForeignKey(Group, related_name="owned_page",
Skia's avatar
Skia committed
319
                                    default=settings.SITH_GROUPS['root']['id'])
Skia's avatar
Skia committed
320 321
    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
322
    lock_mutex = {}
Skia's avatar
Skia committed
323

Skia's avatar
Skia committed
324

Skia's avatar
Skia committed
325
    class Meta:
326
        unique_together = ('name', 'parent')
Skia's avatar
Skia committed
327
        permissions = (
328 329
            ("change_prop_page", "Can change the page's properties (groups, ...)"),
            ("view_page", "Can view the page"),
Skia's avatar
Skia committed
330 331
        )

332 333
    @staticmethod
    def get_page_by_full_name(name):
Skia's avatar
Skia committed
334 335 336
        """
        Quicker to get a page with that method rather than building the request every time
        """
337
        return Page.objects.filter(_full_name=name).first()
338 339 340 341 342 343

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

    def clean(self):
        """
Skia's avatar
Skia committed
344
        Cleans up only the name for the moment, but this can be used to make any treatment before saving the object
345 346 347
        """
        if '/' in self.name:
            self.name = self.name.split('/')[-1]
348
        if Page.objects.exclude(pk=self.pk).filter(_full_name=self.get_full_name()).exists():
Skia's avatar
Skia committed
349 350 351 352
            raise ValidationError(
                _('Duplicate page'),
                code='duplicate',
            )
353
        super(Page, self).clean()
Skia's avatar
Skia committed
354 355 356 357 358 359 360 361 362 363 364 365 366 367
        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

368
    def save(self, *args, **kwargs):
Skia's avatar
Skia committed
369 370 371 372 373
        """
        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")
374
        self.full_clean()
375
        # This reset the _full_name just before saving to maintain a coherent field quicker for queries than the
Skia's avatar
Skia committed
376
        # recursive method
Skia's avatar
Skia committed
377
        # It also update all the children to maintain correct names
378
        self._full_name = self.get_full_name()
Skia's avatar
Skia committed
379 380
        for c in self.children.all():
            c.save()
381
        super(Page, self).save(*args, **kwargs)
Skia's avatar
Skia committed
382 383 384 385 386 387 388 389 390 391 392
        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
393
        if (timezone.now()-Page.lock_mutex[self.pk]['time']) > timedelta(minutes=5):
Skia's avatar
Skia committed
394 395 396 397 398 399 400 401 402 403 404 405 406
            # 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
407
        # print("Locking page")
Skia's avatar
Skia committed
408 409 410 411 412 413 414 415 416 417 418 419

    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
420
        # print("Unlocking page")
Skia's avatar
Skia committed
421 422 423 424 425 426 427 428

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

430 431 432 433
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
434
        return reverse('core:page', kwargs={'page_name': self._full_name})
435

Skia's avatar
Skia committed
436
    def __str__(self):
437 438 439
        return self.get_full_name()

    def get_full_name(self):
Skia's avatar
Skia committed
440 441 442 443 444
        """
        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
445 446 447
        if self.parent is None:
            return self.name
        return '/'.join([self.parent.get_full_name(), self.name])
Skia's avatar
Skia committed
448 449

    def get_display_name(self):
Skia's avatar
Skia committed
450 451 452 453
        try:
            return self.revisions.last().title
        except:
            return self.name
Skia's avatar
Skia committed
454

455
class PageRev(models.Model):
Skia's avatar
Skia committed
456 457 458 459 460 461 462
    """
    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
463
    revision = models.IntegerField(_("revision"))
464 465 466 467 468 469 470 471 472 473 474 475 476
    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
        """
477
        return reverse('core:page', kwargs={'page_name': self.page._full_name})
478 479 480 481

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

482 483 484
    def __getattribute__(self, attr):
        if attr == "owner_group":
            return self.page.owner_group
Skia's avatar
Skia committed
485 486 487 488
        elif attr == "edit_groups":
            return self.page.edit_groups
        elif attr == "view_groups":
            return self.page.view_groups
Skia's avatar
Skia committed
489 490
        elif attr == "unset_lock":
            return self.page.unset_lock
491 492 493
        else:
            return object.__getattribute__(self, attr)

Skia's avatar
Skia committed
494
    def save(self, *args, **kwargs):
Skia's avatar
Skia committed
495 496
        if self.revision is None:
            self.revision = self.page.revisions.all().count() + 1
Skia's avatar
Skia committed
497 498 499
        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()
500