models.py 16.3 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, UserManager
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 PIL import Image
21
import os
22

23

24
25
26
27
28
29
30
31
class MemberManager(UserManager):
    """Get all members, i.e. all users with a profile."""

    def get_queryset(self):
        return super().get_queryset().exclude(profile=None)


class ActiveMemberManager(MemberManager):
32
    """Get all active members"""
33

34
35
    def get_queryset(self):
        return (super().get_queryset()
36
37
38
                .exclude(membership=None)
                .filter(Q(membership__until__isnull=True) |
                        Q(membership__until__gt=timezone.now().date()))
39
                .distinct())
40

41
    def with_birthdays_in_range(self, from_date, to_date):
42
43
        queryset = (self.get_queryset()
                        .filter(profile__birthday__lte=to_date))
44
45
46
47
48
49
50
51
52

        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 = [
53
54
            {"profile__birthday__month": d.month,
             "profile__birthday__day": d.day}
55
56
57
58
59
60
61
            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)

62

63
64
65
66
class Member(User):
    class Meta:
        proxy = True
        ordering = ('first_name', 'last_name')
67

68
    objects = MemberManager()
69
70
    active_members = ActiveMemberManager()

71
72
    def __str__(self):
        return '{} ({})'.format(self.get_full_name(), self.username)
73

74
75
76
77
78
79
    @property
    def current_membership(self):
        membership = self.latest_membership
        if membership and not membership.is_active():
            return None
        return membership
80

81
82
83
84
85
86
    @property
    def latest_membership(self):
        if not self.membership_set.exists():
            return None
        return self.membership_set.latest('since')

87
88
89
90
91
92
    @property
    def earliest_membership(self):
        if not self.membership_set.exists():
            return None
        return self.membership_set.earliest('since')

93
94
95
96
97
98
    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

99
    def has_active_membership(self):
100
101
102
103
104
        """Is this member currently active

        Tested by checking if the expiration date has passed.
        """
        return self.current_membership is not None
105

106
    # Special properties for admin site
107
108
109
    has_active_membership.boolean = True
    has_active_membership.short_description = \
        _('Is this user currently active')
110

111
112
113
    @classmethod
    def all_with_membership(cls, membership_type, prefetch=None):
        return [x for x in cls.objects.all().prefetch_related(prefetch)
114
115
                if x.current_membership and
                x.current_membership.type == membership_type]
116

117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
    @property
    def can_attend_events(self):
        if not self.profile:
            return False

        return ((self.profile.event_permissions == 'all' or
                self.profile.event_permissions == 'no_drinks') and
                self.current_membership is not None)

    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)

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


class Profile(models.Model):
    """This class holds extra information about a member"""

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

    # Preferably this would have been a foreign key to Member instead,
    # but the UserAdmin requires that this is a foreign key to User.
    user = models.OneToOneField(
        settings.AUTH_USER_MODEL,
        on_delete=models.CASCADE,
    )

    # ----- Registration information -----

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

    student_number = models.CharField(
        verbose_name=_('Student number'),
        max_length=8,
        validators=[validators.RegexValidator(
            regex=r'(s\d{7}|[ezu]\d{6,7})',
            message=_('Enter a valid student- or e/z/u-number.'))],
        blank=True,
        null=True,
    )

    starting_year = models.IntegerField(
        verbose_name=_('Starting year'),
        help_text=_('The year this member started studying.'),
        blank=True,
        null=True,
    )

180
181
182
183
184
    # ---- Address information -----

    address_street = models.CharField(
        max_length=100,
        validators=[validators.RegexValidator(
Thom Wiggers's avatar
Thom Wiggers committed
185
            regex=r'^.+ \d+.*',
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
            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
212
        max_length=20,
213
214
215
216
        verbose_name=_('Phone number'),
        help_text=_('Enter a phone number so Thalia may reach you'),
        validators=[validators.RegexValidator(
            regex=r'^\+?\d+$',
217
            message=_('Please enter a valid phone number'),
218
219
220
221
222
        )],
        null=True,
        blank=True,
    )

223
    # ---- Emergency contact ----
224

225
226
227
228
    emergency_contact = models.CharField(
        max_length=255,
        verbose_name=_('Emergency contact name'),
        help_text=_('Who should we contact in case of emergencies'),
229
230
231
232
        null=True,
        blank=True,
    )

233
    emergency_contact_phone_number = models.CharField(
Thom Wiggers's avatar
Thom Wiggers committed
234
        max_length=20,
235
236
        verbose_name=_('Emergency contact phone number'),
        help_text=_('The phone number for the emergency contact'),
237
238
        validators=[validators.RegexValidator(
            regex=r'^\+?\d+$',
239
            message=_('Please enter a valid phone number'),
240
241
242
243
244
245
246
247
248
249
250
251
        )],
        null=True,
        blank=True,
    )

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

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

252
253
254
    show_birthday = models.BooleanField(
        verbose_name=_('Display birthday'),
        help_text=_(
255
            'Show your birthday to other members on your profile page and '
256
257
258
259
            'in the birthday calendar'),
        default=True,
    )

260
261
262
263
264
265
266
267
268
269
270
    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'),
271
        blank=True,
272
273
274
275
276
277
278
279
        null=True,
    )

    initials = models.CharField(
        max_length=20,
        verbose_name=_('Initials'),
        blank=True,
        null=True,
280
281
282
283
284
285
286
287
288
    )

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

289
290
291
292
293
    display_name_preference = models.CharField(
        max_length=10,
        verbose_name=_('How to display name'),
        choices=(('full', _('Show full name')),
                 ('nickname', _('Show only nickname')),
294
                 ('firstname', _('Show only first name')),
295
296
297
298
299
300
                 ('initials', _('Show initials and last name')),
                 ('fullnick', _("Show name like \"John 'nickname' Doe\"")),
                 ('nicklast', _("Show nickname and last name"))),
        default='full',
    )

301
    photo = models.ImageField(
302
        verbose_name=_('Photo'),
303
304
305
306
307
        upload_to='public/avatars/',
        null=True,
        blank=True,
    )

308
309
310
311
312
313
314
315
316
317
    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',
    )

318
319
320
321
    # --- Communication preference ----

    language = models.CharField(
        verbose_name=_('Preferred language'),
322
        help_text=_('Preferred language for e.g. newsletters'),
323
324
325
326
327
328
329
330
331
332
333
334
        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
335
336
337
338
339
340
    receive_newsletter = models.BooleanField(
        verbose_name=_('Receive newsletter'),
        help_text=_("Receive the Thalia Newsletter"),
        default=True,
    )

341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
    # --- 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'),
356
357
358
        help_text=_('Bank account for direct debit'),
        include_countries=IBAN_SEPA_COUNTRIES,
        blank=True,
359
    )
360
361
362

    def display_name(self):
        pref = self.display_name_preference
363
        if pref == 'nickname' and self.nickname is not None:
364
            return self.nickname
365
366
        if pref == 'firstname':
            return self.user.first_name
367
        elif pref == 'initials':
368
369
370
371
            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:
372
373
374
375
376
377
378
            return "{} '{}' {}".format(self.user.first_name,
                                       self.nickname,
                                       self.user.last_name)
        elif pref == 'nicklast':
            return "'{}' {}".format(self.nickname,
                                    self.user.last_name)
        else:
379
            return self.user.get_full_name() or self.user.username
380
    display_name.short_description = _('Display name')
381

382
383
    def short_display_name(self):
        pref = self.display_name_preference
384
385
        if (self.nickname is not None and
                (pref == 'nickname' or pref == 'nicklast')):
386
387
            return self.nickname
        elif pref == 'initials':
388
389
390
            if self.initials:
                return '{} {}'.format(self.initials, self.user.last_name)
            return self.user.last_name
391
392
393
394
        else:
            return self.user.first_name
        return

395
    def __init__(self, *args, **kwargs):
396
        super().__init__(*args, **kwargs)
397
398
399
400
401
        if self.photo:
            self._orig_image = self.photo.path
        else:
            self._orig_image = ""

402
403
404
405
406
407
408
409
410
411
412
    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)

413
    def save(self, *args, **kwargs):
Sébastiaan Versteeg's avatar
Sébastiaan Versteeg committed
414
        super().save(*args, **kwargs)
415
416
417
418
419
420
421
422
423

        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:
424
425
426
427
428
            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")
429
430
431
432
433

            try:
                os.remove(self._orig_image)
            except FileNotFoundError:
                pass
434
435
            self._orig_image = self.photo.path

436
    def __str__(self):
437
        return str(self.user)
438
439


440
441
class Membership(models.Model):

442
443
444
445
    MEMBER = 'member'
    SUPPORTER = 'supporter'
    HONORARY = 'honorary'

446
    MEMBERSHIP_TYPES = (
447
448
449
        (MEMBER, _('Member')),
        (SUPPORTER, _('Supporter')),
        (HONORARY, _('Honorary Member')))
450
451
452
453
454
455
456
457

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

    # Preferably this would have been a foreign key to Member instead,
458
    # but the UserAdmin requires that this is a foreign key to User.
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
    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,
    )

    def is_active(self):
479
        return not self.until or self.until > timezone.now().date()
480
481


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

    for i in range(5):
        new = dict()
        for member_type in member_types:
507
508
509
            new[member_type] = (
                Membership
                .objects
510
                .filter(user__profile__starting_year=current_year - i)
511
512
513
514
515
                .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
516
517
518
519
520
        stats_year.append(new)

    # Add multi year members
    new = dict()
    for member_type in member_types:
521
522
523
        new[member_type] = (
            Membership
            .objects
524
            .filter(user__profile__starting_year__lt=current_year - 4)
525
526
527
528
529
            .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
530
531
532
    stats_year.append(new)

    return stats_year