models.py 16.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
from PIL import Image
21
import os
22

23

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

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

52

53
54
55
class Member(models.Model):
    """This class describes a member"""

56
57
58
    objects = models.Manager()
    active_members = ActiveMemberManager()

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

64
    user = models.OneToOneField(
65
66
67
68
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
    )

69
70
71
72
73
74
75
76
77
78
79
    # ----- Registration information -----

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

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

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

96
97
98
99
100
101
    @property
    def current_membership(self):
        membership = self.latest_membership
        if membership and not membership.is_active():
            return None
        return membership
102

103
104
105
106
107
108
    @property
    def latest_membership(self):
        if not self.membership_set.exists():
            return None
        return self.membership_set.latest('since')

109
110
111
112
113
114
    @property
    def earliest_membership(self):
        if not self.membership_set.exists():
            return None
        return self.membership_set.earliest('since')

115
116
117
118
    @property
    def membership_set(self):
        return self.user.membership_set

119
120
121
122
123
124
    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

125
126
127
128
129
130
131
132
133
    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')
134

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

141
142
143
144
145
    # ---- Address information -----

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

184
    # ---- Emergency contact ----
185

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

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

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

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

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

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

    initials = models.CharField(
        max_length=20,
        verbose_name=_('Initials'),
        blank=True,
        null=True,
241
242
243
244
245
246
247
248
249
    )

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

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

262
    photo = models.ImageField(
263
        verbose_name=_('Photo'),
264
265
266
267
268
        upload_to='public/avatars/',
        null=True,
        blank=True,
    )

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

285
286
287
288
    # --- Communication preference ----

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

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

328
329
330
    class Meta:
        ordering = ('user__first_name', 'user__last_name')

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

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

Thom Wiggers's avatar
Thom Wiggers committed
365
366
367
    def get_full_name(self):
        return self.user.get_full_name()

368
369
370
371
372
373
374
375
    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)

376
    def get_absolute_url(self):
377
        return reverse('members:profile', args=[str(self.user.pk)])
378

379
    def __init__(self, *args, **kwargs):
380
        super().__init__(*args, **kwargs)
381
382
383
384
385
        if self.photo:
            self._orig_image = self.photo.path
        else:
            self._orig_image = ""

386
387
388
389
390
391
392
393
394
395
396
    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)

397
    def save(self, *args, **kwargs):
398
399
400
401
402
403
404
405
406
407
        super().save(args, kwargs)

        if self._orig_image and not self.photo:
            try:
                os.remove(self._orig_image)
            except FileNotFoundError:
                pass
            self._orig_image = ''

        elif self.photo and self._orig_image != self.photo.path:
408
409
410
411
412
            image_path = self.photo.path
            image = Image.open(image_path)
            # Image.thumbnail does not upscale an image that is smaller
            image.thumbnail(settings.PHOTO_UPLOAD_SIZE, Image.ANTIALIAS)
            image.save(image_path, "JPEG")
413
414
415
416
417

            try:
                os.remove(self._orig_image)
            except FileNotFoundError:
                pass
418
419
            self._orig_image = self.photo.path

420
    def __str__(self):
Thom Wiggers's avatar
Thom Wiggers committed
421
        return '{} ({})'.format(self.get_full_name(), self.user.username)
422
423


424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
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):
464
        return not self.until or self.until > timezone.now().date()
465
466


467
468
469
470
471
472
473
474
475
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
476
477
478
479
480


def gen_stats_member_type(member_types):
    total = dict()
    for member_type in member_types:
481
482
483
484
485
486
        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
487
488
489
490
491
492
493
494
495
496
497
                              .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
498
    current_year = datetime_to_lectureyear(date.today())
Thom Wiggers's avatar
Thom Wiggers committed
499
500
501
502

    for i in range(5):
        new = dict()
        for member_type in member_types:
503
504
505
506
507
508
509
510
511
            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
512
513
514
515
516
        stats_year.append(new)

    # Add multi year members
    new = dict()
    for member_type in member_types:
517
518
519
520
521
522
523
524
525
        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
526
527
528
    stats_year.append(new)

    return stats_year