models.py 15.2 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

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

20

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

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
    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)

49

50
51
52
class Member(models.Model):
    """This class describes a member"""

53
54
55
    objects = models.Manager()
    active_members = ActiveMemberManager()

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

61
    user = models.OneToOneField(
62
63
64
65
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
    )

66
67
68
69
70
71
72
73
74
75
76
    # ----- Registration information -----

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

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

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

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

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

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

112
113
114
115
    @property
    def membership_set(self):
        return self.user.membership_set

116
117
118
119
120
121
    def has_been_member(self):
        return self.membership_set.filter(type='member').count() > 0

    def has_been_honorary_member(self):
        return self.membership_set.filter(type='honorary').count() > 0

122
123
124
125
126
127
128
129
130
    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')
131

132
133
134
    @classmethod
    def all_with_membership(cls, membership_type, prefetch=None):
        return [x for x in cls.objects.all().prefetch_related(prefetch)
135
136
                if x.current_membership and
                x.current_membership.type == membership_type]
137

138
139
140
141
142
    # ---- Address information -----

    address_street = models.CharField(
        max_length=100,
        validators=[validators.RegexValidator(
Thom Wiggers's avatar
Thom Wiggers committed
143
            regex=r'^.+ \d+.*',
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
            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
170
        max_length=20,
171
172
173
174
        verbose_name=_('Phone number'),
        help_text=_('Enter a phone number so Thalia may reach you'),
        validators=[validators.RegexValidator(
            regex=r'^\+?\d+$',
175
            message=_('Please enter a valid phone number'),
176
177
178
179
180
        )],
        null=True,
        blank=True,
    )

181
    # ---- Emergency contact ----
182

183
184
185
186
    emergency_contact = models.CharField(
        max_length=255,
        verbose_name=_('Emergency contact name'),
        help_text=_('Who should we contact in case of emergencies'),
187
188
189
190
        null=True,
        blank=True,
    )

191
    emergency_contact_phone_number = models.CharField(
Thom Wiggers's avatar
Thom Wiggers committed
192
        max_length=20,
193
194
        verbose_name=_('Emergency contact phone number'),
        help_text=_('The phone number for the emergency contact'),
195
196
        validators=[validators.RegexValidator(
            regex=r'^\+?\d+$',
197
            message=_('Please enter a valid phone number'),
198
199
200
201
202
203
204
205
206
207
208
209
        )],
        null=True,
        blank=True,
    )

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

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

210
211
212
    show_birthday = models.BooleanField(
        verbose_name=_('Display birthday'),
        help_text=_(
213
            'Show your birthday to other members on your profile page and '
214
215
216
217
            'in the birthday calendar'),
        default=True,
    )

218
219
220
221
222
223
224
225
226
227
228
    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'),
229
        blank=True,
230
231
232
233
234
235
236
237
        null=True,
    )

    initials = models.CharField(
        max_length=20,
        verbose_name=_('Initials'),
        blank=True,
        null=True,
238
239
240
241
242
243
244
245
246
    )

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

247
248
249
250
251
    display_name_preference = models.CharField(
        max_length=10,
        verbose_name=_('How to display name'),
        choices=(('full', _('Show full name')),
                 ('nickname', _('Show only nickname')),
252
                 ('firstname', _('Show only first name')),
253
254
255
256
257
258
                 ('initials', _('Show initials and last name')),
                 ('fullnick', _("Show name like \"John 'nickname' Doe\"")),
                 ('nicklast', _("Show nickname and last name"))),
        default='full',
    )

259
    photo = models.ImageField(
260
        verbose_name=_('Photo'),
261
262
263
264
265
        upload_to='public/avatars/',
        null=True,
        blank=True,
    )

266
267
268
269
270
271
272
273
274
275
276
277
    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):
278
279
280
        return ((self.event_permissions == 'all' or
                self.event_permissions == 'no_drinks') and
                self.current_membership is not None)
281

282
283
284
285
    # --- Communication preference ----

    language = models.CharField(
        verbose_name=_('Preferred language'),
286
        help_text=_('Preferred language for e.g. newsletters'),
287
288
289
290
291
292
293
294
295
296
297
298
        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
299
300
301
302
303
304
    receive_newsletter = models.BooleanField(
        verbose_name=_('Receive newsletter'),
        help_text=_("Receive the Thalia Newsletter"),
        default=True,
    )

305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
    # --- 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'),
320
321
322
        help_text=_('Bank account for direct debit'),
        include_countries=IBAN_SEPA_COUNTRIES,
        blank=True,
323
    )
324

325
326
327
    class Meta:
        ordering = ('user__first_name', 'user__last_name')

328
329
    def display_name(self):
        pref = self.display_name_preference
330
        if pref == 'nickname' and self.nickname is not None:
331
            return self.nickname
332
333
        if pref == 'firstname':
            return self.user.first_name
334
        elif pref == 'initials':
335
336
337
338
            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:
339
340
341
342
343
344
345
            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
346
            return self.get_full_name() or self.user.username
347
    display_name.short_description = _('Display name')
348

349
350
    def short_display_name(self):
        pref = self.display_name_preference
351
352
        if (self.nickname is not None and
                (pref == 'nickname' or pref == 'nicklast')):
353
354
            return self.nickname
        elif pref == 'initials':
355
356
357
            if self.initials:
                return '{} {}'.format(self.initials, self.user.last_name)
            return self.user.last_name
358
359
360
361
        else:
            return self.user.first_name
        return

Thom Wiggers's avatar
Thom Wiggers committed
362
363
364
    def get_full_name(self):
        return self.user.get_full_name()

365
366
367
368
369
370
371
372
    def get_committees(self):
        return Committee.unfiltered_objects.filter(
            Q(committeemembership__member=self) &
            (
                Q(committeemembership__until=None) |
                Q(committeemembership__until__gt=timezone.now())
            )).exclude(active=False)

373
    def get_absolute_url(self):
374
        return reverse('members:profile', args=[str(self.user.pk)])
375

376
377
378
379
380
381
382
383
384
385
386
    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)

387
    def __str__(self):
Thom Wiggers's avatar
Thom Wiggers committed
388
        return '{} ({})'.format(self.get_full_name(), self.user.username)
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
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):
431
        return not self.until or self.until > timezone.now().date()
432
433


434
435
436
437
438
439
440
441
442
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
443
444
445
446
447


def gen_stats_member_type(member_types):
    total = dict()
    for member_type in member_types:
448
449
450
451
452
453
        total[member_type] = (Membership
                              .objects
                              .filter(since__lte=date.today())
                              .filter(Q(until__isnull=True) |
                                      Q(until__gt=date.today()))
                              .filter(type=member_type)
Thom Wiggers's avatar
Thom Wiggers committed
454
455
456
457
458
459
460
461
462
463
464
                              .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
465
    current_year = datetime_to_lectureyear(date.today())
Thom Wiggers's avatar
Thom Wiggers committed
466
467
468
469

    for i in range(5):
        new = dict()
        for member_type in member_types:
470
471
472
473
474
475
476
477
478
            new[member_type] = (
                Membership
                .objects
                .filter(user__member__starting_year=current_year - i)
                .filter(since__lte=date.today())
                .filter(Q(until__isnull=True) |
                        Q(until__gt=date.today()))
                .filter(type=member_type)
                .count())
Thom Wiggers's avatar
Thom Wiggers committed
479
480
481
482
483
        stats_year.append(new)

    # Add multi year members
    new = dict()
    for member_type in member_types:
484
485
486
487
488
489
490
491
492
        new[member_type] = (
            Membership
            .objects
            .filter(user__member__starting_year__lt=current_year - 4)
            .filter(since__lte=date.today())
            .filter(Q(until__isnull=True) |
                    Q(until__gt=date.today()))
            .filter(type=member_type)
            .count())
Thom Wiggers's avatar
Thom Wiggers committed
493
494
495
    stats_year.append(new)

    return stats_year