models.py 8.35 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 django.core.urlresolvers import reverse
8
from datetime import datetime
Skia's avatar
Skia committed
9

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

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

18
    Added field: nick_name, date_of_birth
Skia's avatar
Skia committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
    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
40
    date_of_birth = models.DateTimeField(_('date of birth'))
Skia's avatar
Skia committed
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
    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
60
    REQUIRED_FIELDS = ['email', 'first_name', 'last_name', 'date_of_birth']
Skia's avatar
Skia committed
61
62
63
64

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

Skia's avatar
Skia committed
66
67
68
69
70
71
    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
72
    def __str__(self):
Skia's avatar
Skia committed
73
74
        return self.username

Skia's avatar
Skia committed
75
76
77
78
79
80
81
82
83
84
85
    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
86
87
88
89
90
91
92
93
94
95
96
    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
97
98
99
100
101
102
103
104
105
    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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
    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
127

Skia's avatar
Skia committed
128

Skia's avatar
Skia committed
129
class Page(models.Model):
Skia's avatar
Skia committed
130
131
132
133
134
135
136
137
138
139
    """
    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
140
    name = models.CharField(_('page name'), max_length=30, blank=False)
Skia's avatar
Skia committed
141
# TODO: move title and content to PageRev class with a OneToOne field
Skia's avatar
Skia committed
142
    title = models.CharField(_("page title"), max_length=255, blank=True)
Skia's avatar
Skia committed
143
144
145
    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
146
    parent = models.ForeignKey('self', related_name="children", null=True, blank=True, on_delete=models.SET_NULL)
Skia's avatar
Skia committed
147
148
149
    # 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
150

Skia's avatar
Skia committed
151
152
153
154
    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
155
    class Meta:
156
        unique_together = ('name', 'parent')
Skia's avatar
Skia committed
157
        permissions = (
Skia's avatar
Skia committed
158
            #("can_edit", "Can edit the page"),
159
            ("can_view", "Can view the page"),
Skia's avatar
Skia committed
160
161
        )

162
163
    @staticmethod
    def get_page_by_full_name(name):
Skia's avatar
Skia committed
164
165
166
167
        """
        Quicker to get a page with that method rather than building the request every time
        """
        return Page.objects.filter(full_name=name).first()
168
169
170
171
172
173

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

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

198
199
    def save(self, *args, **kwargs):
        self.full_clean()
Skia's avatar
Skia committed
200
201
        # 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
202
        # It also update all the children to maintain correct names
Skia's avatar
Skia committed
203
        self.full_name = self.get_full_name()
Skia's avatar
Skia committed
204
205
        for c in self.children.all():
            c.save()
206
207
        super(Page, self).save(*args, **kwargs)

208
209
210
211
212
213
    def get_absolute_url(self):
        """
        This is needed for black magic powered UpdateView's children
        """
        return reverse('core:page', kwargs={'page_name': self.full_name})

Skia's avatar
Skia committed
214
    def __str__(self):
215
216
217
        return self.get_full_name()

    def get_full_name(self):
Skia's avatar
Skia committed
218
219
220
221
222
        """
        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
223
224
225
        if self.parent is None:
            return self.name
        return '/'.join([self.parent.get_full_name(), self.name])
Skia's avatar
Skia committed
226
227

    def get_display_name(self):
Skia's avatar
Skia committed
228
        return self.get_full_name()
Skia's avatar
Skia committed
229