models.py 7.92 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
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 datetime import datetime
Skia's avatar
Skia committed
8

Skia's avatar
Skia committed
9 10 11
class User(AbstractBaseUser, PermissionsMixin):
    """
    Defines the base user class, useable in every app
Skia's avatar
Skia committed
12

Skia's avatar
Skia committed
13 14 15
    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
16

17
    Added field: nick_name, date_of_birth
Skia's avatar
Skia committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
    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
39
    date_of_birth = models.DateTimeField(_('date of birth'))
Skia's avatar
Skia committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
    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.'
        ),
    )
    date_joined = models.DateTimeField(_('date joined'), default=timezone.now)

    objects = UserManager()

    USERNAME_FIELD = 'username'
Skia's avatar
Skia committed
59
    REQUIRED_FIELDS = ['email', 'first_name', 'last_name', 'date_of_birth']
Skia's avatar
Skia committed
60 61 62 63

    class Meta:
        verbose_name = _('user')
        verbose_name_plural = _('users')
Skia's avatar
Skia committed
64 65

    def __str__(self):
Skia's avatar
Skia committed
66 67
        return self.username

Skia's avatar
Skia committed
68 69 70 71 72 73 74 75 76 77 78
    def to_dict(self):
        return self.__dict__

    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
79 80 81 82 83 84 85 86 87 88 89
    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
90 91 92 93 94 95 96 97 98
    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
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
    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
        """
        user_name = str(self.first_name[0]+self.last_name).lower()
        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
120

Skia's avatar
Skia committed
121

Skia's avatar
Skia committed
122
class Page(models.Model):
Skia's avatar
Skia committed
123 124 125 126 127 128 129 130 131 132
    """
    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()

    Be careful with the full_name attribute: 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!
    """
Skia's avatar
Skia committed
133
    name = models.CharField(_('page name'), max_length=30, blank=False)
Skia's avatar
Skia committed
134
# TODO: move title and content to PageRev class with a OneToOne field
Skia's avatar
Skia committed
135
    title = models.CharField(_("page title"), max_length=255, blank=True)
Skia's avatar
Skia committed
136 137 138
    content = models.TextField(_("page content"), blank=True)
    revision = models.PositiveIntegerField(_("current revision"), default=1)
    is_locked = models.BooleanField(_("page mutex"), default=False)
Skia's avatar
Skia committed
139
    parent = models.ForeignKey('self', related_name="children", null=True, blank=True, on_delete=models.SET_NULL)
Skia's avatar
Skia committed
140 141 142
    # 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!
    full_name = models.CharField(_('page name'), max_length=255, blank=True)
Skia's avatar
Skia committed
143

Skia's avatar
Skia committed
144 145 146 147
    owner_group = models.ForeignKey(Group, related_name="owned_pages", default=1)
    edit_group = models.ForeignKey(Group, related_name="editable_pages", default=1)
    view_group = models.ForeignKey(Group, related_name="viewable_pages", default=1)

Skia's avatar
Skia committed
148
    class Meta:
149
        unique_together = ('name', 'parent')
Skia's avatar
Skia committed
150
        permissions = (
Skia's avatar
Skia committed
151
            #("can_edit", "Can edit the page"),
152
            ("can_view", "Can view the page"),
Skia's avatar
Skia committed
153 154
        )

155 156
    @staticmethod
    def get_page_by_full_name(name):
Skia's avatar
Skia committed
157 158 159 160
        """
        Quicker to get a page with that method rather than building the request every time
        """
        return Page.objects.filter(full_name=name).first()
161 162 163 164 165 166

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

    def clean(self):
        """
Skia's avatar
Skia committed
167
        Cleans up only the name for the moment, but this can be used to make any treatment before saving the object
168 169 170
        """
        if '/' in self.name:
            self.name = self.name.split('/')[-1]
Skia's avatar
Skia committed
171 172 173 174 175
        if Page.objects.exclude(pk=self.pk).filter(full_name=self.get_full_name()).exists():
            raise ValidationError(
                _('Duplicate page'),
                code='duplicate',
            )
176
        super(Page, self).clean()
Skia's avatar
Skia committed
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
        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


192 193 194

    def save(self, *args, **kwargs):
        self.full_clean()
Skia's avatar
Skia committed
195 196
        # This reset the full_name just before saving to maintain a coherent field quicker for queries than the
        # recursive method
Skia's avatar
Skia committed
197
        # It also update all the children to maintain correct names
Skia's avatar
Skia committed
198
        self.full_name = self.get_full_name()
Skia's avatar
Skia committed
199 200
        for c in self.children.all():
            c.save()
201 202
        super(Page, self).save(*args, **kwargs)

Skia's avatar
Skia committed
203
    def __str__(self):
204 205 206
        return self.get_full_name()

    def get_full_name(self):
Skia's avatar
Skia committed
207 208 209 210 211
        """
        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
212 213 214
        if self.parent is None:
            return self.name
        return '/'.join([self.parent.get_full_name(), self.name])
Skia's avatar
Skia committed
215 216

    def get_display_name(self):
Skia's avatar
Skia committed
217
        return self.get_full_name()
Skia's avatar
Skia committed
218