models.py 14.3 KB
Newer Older
1
2
3
4
5
6
import operator
from datetime import date, timedelta
from functools import reduce

from django.conf import settings
from django.core import validators
7
from django.core.exceptions import ValidationError
8
from django.db import models
9
from django.db.models import Q
10
from django.urls import reverse
11
from django.utils import timezone
12
from django.utils.translation import ugettext_lazy as _
13
14
15
from localflavor.generic.countries.sepa import IBAN_SEPA_COUNTRIES
from localflavor.generic.models import IBANField

tvbussel's avatar
tvbussel committed
16
from utils.snippets import datetime_to_lectureyear
17
18
from utils.validators import validate_file_extension

19

20
21
22
23
class ActiveMemberManager(models.Manager):
    """Get all active members"""
    def get_queryset(self):
        return (super().get_queryset()
24
                .exclude(user__membership=None)
25
26
27
                .filter(Q(user__membership__until__isnull=True) |
                        Q(user__membership__until__gt=timezone.now().date())))

28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
    def with_birthdays_in_range(self, from_date, to_date):
        queryset = self.get_queryset().filter(birthday__lte=to_date)

        if (to_date - from_date).days >= 366:
            # 366 is important to also account for leap years
            # Everyone that's born before to_date has a birthday
            return queryset

        delta = to_date - from_date
        dates = [from_date + timedelta(days=i) for i in range(delta.days + 1)]
        monthdays = [
            {"birthday__month": d.month, "birthday__day": d.day}
            for d in dates
        ]
        # Don't get me started (basically, we are making a giant OR query with
        # all days and months that are in the range)
        query = reduce(operator.or_, [Q(**d) for d in monthdays])
        return queryset.filter(query)

47

48
49
50
class Member(models.Model):
    """This class describes a member"""

51
52
53
    objects = models.Manager()
    active_members = ActiveMemberManager()

54
55
56
57
    # No longer yearly membership as a type, use expiration date instead.
    PROGRAMME_CHOICES = (
        ('computingscience', _('Computing Science')),
        ('informationscience', _('Information Sciences')))
58

59
    user = models.OneToOneField(
60
61
62
63
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
    )

64
65
66
67
68
69
70
71
72
73
74
    # ----- Registration information -----

    programme = models.CharField(
        max_length=20,
        choices=PROGRAMME_CHOICES,
        verbose_name=_('Study programme'),
        blank=True,
        null=True,
    )

    student_number = models.CharField(
75
        verbose_name=_('Student number'),
76
77
78
        max_length=8,
        validators=[validators.RegexValidator(
            regex=r'(s\d{7}|[ezu]\d{6,7})',
WKuipers's avatar
WKuipers committed
79
            message=_('Enter a valid student- or e/z/u-number.'))],
80
81
82
83
        blank=True,
        null=True,
    )

84
85
86
87
88
    starting_year = models.IntegerField(
        verbose_name=_('Starting year'),
        help_text=_('The year this member started studying.'),
        blank=True,
        null=True,
89
90
    )

91
92
93
94
95
96
    @property
    def current_membership(self):
        membership = self.latest_membership
        if membership and not membership.is_active():
            return None
        return membership
97

98
99
100
101
102
103
    @property
    def latest_membership(self):
        if not self.membership_set.exists():
            return None
        return self.membership_set.latest('since')

104
105
106
107
108
109
    @property
    def earliest_membership(self):
        if not self.membership_set.exists():
            return None
        return self.membership_set.earliest('since')

110
111
112
113
114
115
116
117
118
119
120
121
122
    @property
    def membership_set(self):
        return self.user.membership_set

    def is_active(self):
        """Is this member currently active

        Tested by checking if the expiration date has passed.
        """
        return self.current_membership is not None
    # Special properties for admin site
    is_active.boolean = True
    is_active.short_description = _('Is this user currently active')
123

124
125
126
    @classmethod
    def all_with_membership(cls, membership_type, prefetch=None):
        return [x for x in cls.objects.all().prefetch_related(prefetch)
127
128
                if x.current_membership and
                x.current_membership.type == membership_type]
129

130
131
132
133
134
    # ---- Address information -----

    address_street = models.CharField(
        max_length=100,
        validators=[validators.RegexValidator(
Thom Wiggers's avatar
Thom Wiggers committed
135
            regex=r'^.+ \d+.*',
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
            message=_('Include the house number'),
        )],
        verbose_name=_('Street and house number'),
        null=True,
    )

    address_street2 = models.CharField(
        max_length=100,
        verbose_name=_('Second address line'),
        blank=True,
        null=True,
    )

    address_postal_code = models.CharField(
        max_length=10,
        verbose_name=_('Postal code'),
        null=True,
    )

    address_city = models.CharField(
        max_length=40,
        verbose_name=_('City'),
        null=True,
    )

    phone_number = models.CharField(
Thom Wiggers's avatar
Thom Wiggers committed
162
        max_length=20,
163
164
165
166
        verbose_name=_('Phone number'),
        help_text=_('Enter a phone number so Thalia may reach you'),
        validators=[validators.RegexValidator(
            regex=r'^\+?\d+$',
167
            message=_('Please enter a valid phone number'),
168
169
170
171
172
        )],
        null=True,
        blank=True,
    )

173
    # ---- Emergency contact ----
174

175
176
177
178
    emergency_contact = models.CharField(
        max_length=255,
        verbose_name=_('Emergency contact name'),
        help_text=_('Who should we contact in case of emergencies'),
179
180
181
182
        null=True,
        blank=True,
    )

183
    emergency_contact_phone_number = models.CharField(
Thom Wiggers's avatar
Thom Wiggers committed
184
        max_length=20,
185
186
        verbose_name=_('Emergency contact phone number'),
        help_text=_('The phone number for the emergency contact'),
187
188
        validators=[validators.RegexValidator(
            regex=r'^\+?\d+$',
189
            message=_('Please enter a valid phone number'),
190
191
192
193
194
195
196
197
198
199
200
201
        )],
        null=True,
        blank=True,
    )

    # ---- Personal information ------

    birthday = models.DateField(
        verbose_name=_('Birthday'),
        null=True
    )

202
203
204
    show_birthday = models.BooleanField(
        verbose_name=_('Display birthday'),
        help_text=_(
205
            'Show your birthday to other members on your profile page and '
206
207
208
209
            'in the birthday calendar'),
        default=True,
    )

210
211
212
213
214
215
216
217
218
219
220
    website = models.URLField(
        max_length=200,
        verbose_name=_('Website'),
        help_text=_('Website to display on your profile page'),
        blank=True,
        null=True
    )

    profile_description = models.TextField(
        verbose_name=_('Profile text'),
        help_text=_('Text to display on your profile'),
221
        blank=True,
222
223
224
225
226
227
228
229
        null=True,
    )

    initials = models.CharField(
        max_length=20,
        verbose_name=_('Initials'),
        blank=True,
        null=True,
230
231
232
233
234
235
236
237
238
    )

    nickname = models.CharField(
        max_length=30,
        verbose_name=_('Nickname'),
        blank=True,
        null=True,
    )

239
240
241
242
243
    display_name_preference = models.CharField(
        max_length=10,
        verbose_name=_('How to display name'),
        choices=(('full', _('Show full name')),
                 ('nickname', _('Show only nickname')),
244
                 ('firstname', _('Show only first name')),
245
246
247
248
249
250
                 ('initials', _('Show initials and last name')),
                 ('fullnick', _("Show name like \"John 'nickname' Doe\"")),
                 ('nicklast', _("Show nickname and last name"))),
        default='full',
    )

251
    photo = models.ImageField(
252
        verbose_name=_('Photo'),
253
254
255
256
257
        upload_to='public/avatars/',
        null=True,
        blank=True,
    )

258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
    event_permissions = models.CharField(
        max_length=9,
        verbose_name=_('Which events can this member attend'),
        choices=(('all', _('All events')),
                 ('no_events', _('User may not attend events')),
                 ('no_drinks', _('User may not attend drinks')),
                 ('nothing', _('User may not attend anything'))),
        default='all',
    )

    @property
    def can_attend_events(self):
        return (self.event_permissions == 'all' or
                self.event_permissions == 'no_drinks')

273
274
275
276
    # --- Communication preference ----

    language = models.CharField(
        verbose_name=_('Preferred language'),
277
        help_text=_('Preferred language for e.g. newsletters'),
278
279
280
281
282
283
284
285
286
287
288
289
        max_length=5,
        choices=settings.LANGUAGES,
        default='nl',
    )

    receive_optin = models.BooleanField(
        verbose_name=_('Receive opt-in mailings'),
        help_text=_("Receive mailings about vacancies and events from Thalia's"
                    " sponsors."),
        default=True,
    )

Sébastiaan Versteeg's avatar
Sébastiaan Versteeg committed
290
291
292
293
294
295
    receive_newsletter = models.BooleanField(
        verbose_name=_('Receive newsletter'),
        help_text=_("Receive the Thalia Newsletter"),
        default=True,
    )

296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
    # --- Direct debit information ----

    direct_debit_authorized = models.BooleanField(
        choices=((True, _('Yes, I want Thalia to take the membership fees '
                          'from my bank account through direct debit for '
                          'each year.')),
                 (False, _('No, I will pay the contribution myself'))),
        verbose_name=_('Direct debit'),
        help_text=_('Each year, have Thalia take the membership fees from my '
                    'bank account'),
        default=False,
    )

    bank_account = IBANField(
        verbose_name=_('Bank account'),
311
312
313
        help_text=_('Bank account for direct debit'),
        include_countries=IBAN_SEPA_COUNTRIES,
        blank=True,
314
    )
315

316
317
318
    class Meta:
        ordering = ('user__first_name', 'user__last_name')

319
320
    def display_name(self):
        pref = self.display_name_preference
321
        if pref == 'nickname' and self.nickname is not None:
322
            return self.nickname
323
324
        if pref == 'firstname':
            return self.user.first_name
325
        elif pref == 'initials':
326
327
328
329
            if self.initials:
                return '{} {}'.format(self.initials, self.user.last_name)
            return self.user.last_name
        elif pref == 'fullnick' and self.nickname is not None:
330
331
332
333
334
335
336
            return "{} '{}' {}".format(self.user.first_name,
                                       self.nickname,
                                       self.user.last_name)
        elif pref == 'nicklast':
            return "'{}' {}".format(self.nickname,
                                    self.user.last_name)
        else:
Thom Wiggers's avatar
Thom Wiggers committed
337
            return self.get_full_name() or self.user.username
338
    display_name.short_description = _('Display name')
339

340
341
    def short_display_name(self):
        pref = self.display_name_preference
342
343
        if (self.nickname is not None and
                (pref == 'nickname' or pref == 'nicklast')):
344
345
            return self.nickname
        elif pref == 'initials':
346
347
348
            if self.initials:
                return '{} {}'.format(self.initials, self.user.last_name)
            return self.user.last_name
349
350
351
352
        else:
            return self.user.first_name
        return

Thom Wiggers's avatar
Thom Wiggers committed
353
354
355
    def get_full_name(self):
        return self.user.get_full_name()

356
357
358
    def get_absolute_url(self):
        return reverse('members:profile', args=[str(self.pk)])

359
360
361
362
363
364
365
366
367
368
369
    def clean(self):
        super().clean()
        errors = {}
        if self.display_name_preference in ('nickname', 'fullnick',
                                            'nicklast'):
            if not self.nickname:
                errors.update(
                    {'nickname': _('You need to enter a nickname to use it as '
                                   'display name')})
        raise ValidationError(errors)

370
    def __str__(self):
Thom Wiggers's avatar
Thom Wiggers committed
371
        return '{} ({})'.format(self.get_full_name(), self.user.username)
372
373


374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
class Membership(models.Model):

    MEMBERSHIP_TYPES = (
        ('member', _('Member')),
        ('supporter', _('Supporter')),
        ('honorary', _('Honorary Member')))

    type = models.CharField(
        max_length=40,
        choices=MEMBERSHIP_TYPES,
        verbose_name=_('Membership type'),
    )

    # Preferably this would have been a foreign key to Member instead,
    # but Django currently does not support nested inlines in the Admin UI.
    # This is necessary to create an inline in the User form.
    user = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
        verbose_name=_('User'),
    )

    since = models.DateField(
        verbose_name=_("Membership since"),
        help_text=_("The date the member started holding this membership."),
        default=timezone.now
    )

    until = models.DateField(
        verbose_name=_("Membership until"),
        help_text=_("The date the member stops holding this membership."),
        blank=True,
        null=True,
    )

    @property
    def member(self):
        return self.user.member

    def is_active(self):
414
        return not self.until or self.until > timezone.now().date()
415
416


417
418
419
420
421
422
423
424
425
class BecomeAMemberDocument(models.Model):
    name = models.CharField(max_length=200)
    file = models.FileField(
        upload_to='members/',
        validators=[validate_file_extension],
    )

    def __str__(self):
        return self.name
Thom Wiggers's avatar
Thom Wiggers committed
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444


def gen_stats_member_type(member_types):
    total = dict()
    for member_type in member_types:
        total[member_type] = (Member
                              .active_members
                              .filter(user__membership__type=member_type)
                              .count())
    return total


def gen_stats_year(member_types):
    """
    Generate list with 6 entries, where each entry represents the total amount
    of Thalia members in a year. The sixth element contains all the multi-year
    students.
    """
    stats_year = []
tvbussel's avatar
tvbussel committed
445
    current_year = datetime_to_lectureyear(date.today())
Thom Wiggers's avatar
Thom Wiggers committed
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467

    for i in range(5):
        new = dict()
        for member_type in member_types:
            new[member_type] = (Member
                                .active_members
                                .filter(starting_year=current_year - i)
                                .filter(user__membership__type=member_type)
                                .count())
        stats_year.append(new)

    # Add multi year members
    new = dict()
    for member_type in member_types:
        new[member_type] = (Member
                            .active_members
                            .filter(starting_year__lt=current_year - 4)
                            .filter(user__membership__type=member_type)
                            .count())
    stats_year.append(new)

    return stats_year