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

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

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

21
from PIL import Image
22
import os
23

24

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

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

53

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    address_street = models.CharField(
        max_length=100,
        validators=[validators.RegexValidator(
Thom Wiggers's avatar
Thom Wiggers committed
147
            regex=r'^.+ \d+.*',
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
173
            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
174
        max_length=20,
175
176
177
178
        verbose_name=_('Phone number'),
        help_text=_('Enter a phone number so Thalia may reach you'),
        validators=[validators.RegexValidator(
            regex=r'^\+?\d+$',
179
            message=_('Please enter a valid phone number'),
180
181
182
183
184
        )],
        null=True,
        blank=True,
    )

185
    # ---- Emergency contact ----
186

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

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

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

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

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

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

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

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

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

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

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

286
287
288
289
    # --- Communication preference ----

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

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

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

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

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

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

369
370
    def get_committees(self):
        return Committee.unfiltered_objects.filter(
371
            Q(committeemembership__member=self.user) &
372
373
374
375
376
            (
                Q(committeemembership__until=None) |
                Q(committeemembership__until__gt=timezone.now())
            )).exclude(active=False)

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

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

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

398
    def save(self, *args, **kwargs):
399
400
401
402
403
404
405
406
407
408
        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:
409
410
411
412
413
            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")
414
415
416
417
418

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

421
    def __str__(self):
422
        return str(self.user)
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
464
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):
465
        return not self.until or self.until > timezone.now().date()
466
467


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


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

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

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

    return stats_year
530
531
532
533
534
535
536


def str_user(self):
        return '{} ({})'.format(self.get_full_name(), self.username)


User.add_to_class("__str__", str_user)