models.py 19.9 KB
Newer Older
1
import logging
2
import operator
3
import os
4
import uuid
5
from PIL import Image
6
from datetime import timedelta
7
from django.conf import settings
8
from django.contrib.auth.models import User, UserManager
9
from django.core import validators
10
from django.core.exceptions import ValidationError
11
from django.db import models
12
from django.db.models import Q
13
from django.urls import reverse
14
from django.utils import timezone
15
from django.utils.translation import pgettext_lazy, gettext_lazy as _
16
from functools import reduce
17
18
19
from localflavor.generic.countries.sepa import IBAN_SEPA_COUNTRIES
from localflavor.generic.models import IBANField

20
from activemembers.models import MemberGroup, MemberGroupMembership
21

Thom Wiggers's avatar
Thom Wiggers committed
22
23
24
logger = logging.getLogger(__name__)


25
26
27
28
29
30
31
32
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):
Thom Wiggers's avatar
Thom Wiggers committed
33
    """Get all active members, i.e. who have a committee membership"""
34

35
    def get_queryset(self):
Thom Wiggers's avatar
Thom Wiggers committed
36
        """Select all committee members"""
37
        active_memberships = (MemberGroupMembership
38
                              .active_memberships
39
                              .filter(group__board=None))
40
41

        return (super().get_queryset()
42
                .filter(membergroupmembership__in=active_memberships)
43
44
45
46
47
48
                .distinct())


class CurrentMemberManager(MemberManager):
    """Get all members with an active membership"""

49
    def get_queryset(self):
Thom Wiggers's avatar
Thom Wiggers committed
50
51
52
        """
        Select all members who have a current membership
        """
53
        return (super().get_queryset()
54
55
56
                .exclude(membership=None)
                .filter(Q(membership__until__isnull=True) |
                        Q(membership__until__gt=timezone.now().date()))
57
                .distinct())
58

59
    def with_birthdays_in_range(self, from_date, to_date):
Thom Wiggers's avatar
Thom Wiggers committed
60
61
62
63
64
65
66
67
68
69
70
71
        """
        Select all who are currently a Thalia member and have a
        birthday within the specified range

        :param from_date: the start of the range (inclusive)
        :param to_date: the end of the range (inclusive)
        :paramtype from_date: datetime
        :paramtype to_date: datetime

        :return: the filtered queryset
        :rtype: Queryset
        """
72
73
        queryset = (self.get_queryset()
                        .filter(profile__birthday__lte=to_date))
74
75
76
77
78
79
80
81
82

        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 = [
83
84
            {"profile__birthday__month": d.month,
             "profile__birthday__day": d.day}
85
86
87
88
89
90
91
            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)

92

93
94
95
96
class Member(User):
    class Meta:
        proxy = True
        ordering = ('first_name', 'last_name')
97
98
99
        permissions = (
            ('sentry_access', _("Access the Sentry backend")),
        )
100

101
    objects = MemberManager()
102
    current_members = CurrentMemberManager()
103
104
    active_members = ActiveMemberManager()

105
106
    def __str__(self):
        return '{} ({})'.format(self.get_full_name(), self.username)
107

108
109
    @property
    def current_membership(self):
Thom Wiggers's avatar
Thom Wiggers committed
110
111
112
113
114
115
        """
        The currently active membership of the user. None if not active.

        :return: the currently active membership or None
        :rtype: Membership or None
        """
116
117
118
119
        membership = self.latest_membership
        if membership and not membership.is_active():
            return None
        return membership
120

121
122
    @property
    def latest_membership(self):
Thom Wiggers's avatar
Thom Wiggers committed
123
        """Get the most recent membership of this user"""
124
125
126
127
        if not self.membership_set.exists():
            return None
        return self.membership_set.latest('since')

128
129
    @property
    def earliest_membership(self):
Thom Wiggers's avatar
Thom Wiggers committed
130
        """Get the earliest membership of this user"""
131
132
133
134
        if not self.membership_set.exists():
            return None
        return self.membership_set.earliest('since')

135
    def has_been_member(self):
Thom Wiggers's avatar
Thom Wiggers committed
136
        """Has this user ever been a member?"""
137
138
139
        return self.membership_set.filter(type='member').count() > 0

    def has_been_honorary_member(self):
Thom Wiggers's avatar
Thom Wiggers committed
140
        """Has this user ever been an honorary member?"""
141
142
        return self.membership_set.filter(type='honorary').count() > 0

143
    def has_active_membership(self):
144
145
146
147
148
        """Is this member currently active

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

150
    # Special properties for admin site
151
152
153
    has_active_membership.boolean = True
    has_active_membership.short_description = \
        _('Is this user currently active')
154

155
    @classmethod
156
    def all_with_membership(cls, membership_type):
Thom Wiggers's avatar
Thom Wiggers committed
157
158
159
160
161
162
163
        """
        Get all users who have a specific membership.

        :param membership_type: The membership to select by
        :return: List of users
        :rtype: [Member]
        """
164
        return [x for x in cls.objects.all()
165
166
                if x.current_membership and
                x.current_membership.type == membership_type]
167

168
169
    @property
    def can_attend_events(self):
Thom Wiggers's avatar
Thom Wiggers committed
170
        """May this user attend events"""
171
172
173
174
175
176
177
178
        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):
Thom Wiggers's avatar
Thom Wiggers committed
179
        """Get the committees this user is a member of"""
180
        return MemberGroup.unfiltered_objects.filter(
181
            Q(membergroupmembership__member=self) &
182
            (
183
184
                Q(membergroupmembership__until=None) |
                Q(membergroupmembership__until__gt=timezone.now())
185
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
            )).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,
    )

233
234
235
236
237
    # ---- Address information -----

    address_street = models.CharField(
        max_length=100,
        validators=[validators.RegexValidator(
Thom Wiggers's avatar
Thom Wiggers committed
238
            regex=r'^.+ \d+.*',
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
            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
265
        max_length=20,
266
267
268
269
        verbose_name=_('Phone number'),
        help_text=_('Enter a phone number so Thalia may reach you'),
        validators=[validators.RegexValidator(
            regex=r'^\+?\d+$',
270
            message=_('Please enter a valid phone number'),
271
272
273
274
275
        )],
        null=True,
        blank=True,
    )

276
    # ---- Emergency contact ----
277

278
279
280
281
    emergency_contact = models.CharField(
        max_length=255,
        verbose_name=_('Emergency contact name'),
        help_text=_('Who should we contact in case of emergencies'),
282
283
284
285
        null=True,
        blank=True,
    )

286
    emergency_contact_phone_number = models.CharField(
Thom Wiggers's avatar
Thom Wiggers committed
287
        max_length=20,
288
289
        verbose_name=_('Emergency contact phone number'),
        help_text=_('The phone number for the emergency contact'),
290
291
        validators=[validators.RegexValidator(
            regex=r'^\+?\d+$',
292
            message=_('Please enter a valid phone number'),
293
294
295
296
297
298
299
300
301
302
303
304
        )],
        null=True,
        blank=True,
    )

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

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

305
306
307
    show_birthday = models.BooleanField(
        verbose_name=_('Display birthday'),
        help_text=_(
308
            'Show your birthday to other members on your profile page and '
309
310
311
312
            'in the birthday calendar'),
        default=True,
    )

313
314
315
316
317
318
319
320
321
322
323
    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'),
324
        blank=True,
325
        null=True,
326
        max_length=4096,
327
328
329
330
331
332
333
    )

    initials = models.CharField(
        max_length=20,
        verbose_name=_('Initials'),
        blank=True,
        null=True,
334
335
336
337
338
339
340
341
342
    )

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

343
344
345
346
347
    display_name_preference = models.CharField(
        max_length=10,
        verbose_name=_('How to display name'),
        choices=(('full', _('Show full name')),
                 ('nickname', _('Show only nickname')),
348
                 ('firstname', _('Show only first name')),
349
350
351
352
353
354
                 ('initials', _('Show initials and last name')),
                 ('fullnick', _("Show name like \"John 'nickname' Doe\"")),
                 ('nicklast', _("Show nickname and last name"))),
        default='full',
    )

355
    photo = models.ImageField(
356
        verbose_name=_('Photo'),
357
358
359
360
361
        upload_to='public/avatars/',
        null=True,
        blank=True,
    )

362
363
364
365
366
367
368
369
370
371
    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',
    )

372
373
374
375
    # --- Communication preference ----

    language = models.CharField(
        verbose_name=_('Preferred language'),
376
        help_text=_('Preferred language for e.g. newsletters'),
377
378
379
380
381
382
383
384
        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"
385
                    " partners."),
386
387
388
        default=True,
    )

Sébastiaan Versteeg's avatar
Sébastiaan Versteeg committed
389
390
391
392
393
394
    receive_newsletter = models.BooleanField(
        verbose_name=_('Receive newsletter'),
        help_text=_("Receive the Thalia Newsletter"),
        default=True,
    )

395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
    # --- 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'),
410
411
412
        help_text=_('Bank account for direct debit'),
        include_countries=IBAN_SEPA_COUNTRIES,
        blank=True,
413
    )
414
415
416

    def display_name(self):
        pref = self.display_name_preference
417
        if pref == 'nickname' and self.nickname is not None:
418
            return self.nickname
419
        elif pref == 'firstname':
420
            return self.user.first_name
421
        elif pref == 'initials':
422
423
424
425
            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:
426
427
428
            return "{} '{}' {}".format(self.user.first_name,
                                       self.nickname,
                                       self.user.last_name)
429
        elif pref == 'nicklast' and self.nickname is not None:
430
431
432
            return "'{}' {}".format(self.nickname,
                                    self.user.last_name)
        else:
433
            return self.user.get_full_name() or self.user.username
434
    display_name.short_description = _('Display name')
435

436
437
    def short_display_name(self):
        pref = self.display_name_preference
438
439
        if (self.nickname is not None and
                (pref == 'nickname' or pref == 'nicklast')):
440
441
            return self.nickname
        elif pref == 'initials':
442
443
444
            if self.initials:
                return '{} {}'.format(self.initials, self.user.last_name)
            return self.user.last_name
445
446
447
        else:
            return self.user.first_name

448
    def __init__(self, *args, **kwargs):
449
        super().__init__(*args, **kwargs)
450
451
452
453
454
        if self.photo:
            self._orig_image = self.photo.path
        else:
            self._orig_image = ""

455
456
457
    def clean(self):
        super().clean()
        errors = {}
458

459
460
461
462
463
464
        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')})
465
466
467
468
469
470
471

        if self.birthday and self.birthday > timezone.now().date():
            errors.update(
                {'birthday': _('A birthday cannot be in the future.')})

        if errors:
            raise ValidationError(errors)
472

473
    def save(self, *args, **kwargs):
Sébastiaan Versteeg's avatar
Sébastiaan Versteeg committed
474
        super().save(*args, **kwargs)
475
476
477
478
479
480
481
482
483

        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:
484
485
            image_path = self.photo.path
            image = Image.open(image_path)
Thom Wiggers's avatar
Thom Wiggers committed
486
487
488
            image_path, _ext = os.path.splitext(image_path)
            image_path = "{}.jpg".format(image_path)

489
            # Image.thumbnail does not upscale an image that is smaller
Thom Wiggers's avatar
Thom Wiggers committed
490
            logger.debug("Converting image %s", image_path)
491
            image.thumbnail(settings.PHOTO_UPLOAD_SIZE, Image.ANTIALIAS)
Thom Wiggers's avatar
Thom Wiggers committed
492
493
494
495
            image.convert("RGB").save(image_path, "JPEG")
            image_name, _ext = os.path.splitext(self.photo.name)
            self.photo.name = "{}.jpg".format(image_name)
            super().save(*args, **kwargs)
496
497

            try:
Thom Wiggers's avatar
Thom Wiggers committed
498
499
500
                if self._orig_image:
                    logger.info("deleting", self._orig_image)
                    os.remove(self._orig_image)
501
502
            except FileNotFoundError:
                pass
503
            self._orig_image = self.photo.path
Thom Wiggers's avatar
Thom Wiggers committed
504
505
        else:
            logging.warning("We already had this image")
506

507
    def __str__(self):
508
        return _("Profile for {}").format(self.user)
509
510


511
512
class Membership(models.Model):

513
514
515
516
    MEMBER = 'member'
    SUPPORTER = 'supporter'
    HONORARY = 'honorary'

517
    MEMBERSHIP_TYPES = (
518
519
520
        (MEMBER, _('Member')),
        (SUPPORTER, _('Supporter')),
        (HONORARY, _('Honorary Member')))
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546

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

    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,
    )

547
548
549
550
551
552
553
554
555
556
    def __str__(self):
        s = _("Membership of type {} for {} ({}) starting {}").format(
                self.get_type_display(), self.user.get_full_name(),
                self.user.username, self.since,
            )
        if self.until is not None:
            s += pgettext_lazy("Membership until x", " until {}").format(
                    self.until)
        return s

557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
    def clean(self):
        super().clean()

        errors = {}
        if self.until and (not self.since or self.until < self.since):
            raise ValidationError(
                {'until': _("End date can't be before start date")})

        if self.since is not None:
            memberships = self.user.membership_set.all()
            for membership in memberships:
                if membership.pk == self.pk:
                    continue
                if ((membership.until is None and (
                    self.until is None or self.until > membership.since)) or
                    (self.until is None and self.since < membership.until) or
                    (self.until and membership.until and
                     self.since < membership.until and
                     self.until > membership.since)):
                    errors.update({
                        'since': _('A membership already '
                                   'exists for that period'),
                        'until': _('A membership already '
                                   'exists for that period')})

        if errors:
            raise ValidationError(errors)

585
    def is_active(self):
586
        return not self.until or self.until > timezone.now().date()
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613


class EmailChange(models.Model):
    created_at = models.DateTimeField(_('created at'), default=timezone.now)

    member = models.ForeignKey(
        'members.Member',
        on_delete=models.CASCADE,
        verbose_name=_('member'),
    )

    email = models.EmailField(_('email'), max_length=254)

    verify_key = models.UUIDField(unique=True, default=uuid.uuid4,
                                  editable=False)
    confirm_key = models.UUIDField(unique=True, default=uuid.uuid4,
                                   editable=False)

    verified = models.BooleanField(
        _('verified'), default=False,
        help_text=_('the new email address is valid')
    )
    confirmed = models.BooleanField(
        _('confirmed'), default=False,
        help_text=_('the old email address was checked')
    )

614
615
616
617
618
619
620
621
622
623
    def __str__(self):
        return _(
            "Email change request for {} to {} "
            "created at {} "
            "(confirmed: {}, verified: {})."
        ).format(
            self.member, self.email, self.created_at, self.confirmed,
            self.verified
        )

624
625
626
627
628
629
630
631
632
633
    @property
    def completed(self):
        return self.verified and self.confirmed

    def clean(self):
        super().clean()

        if self.email == self.member.email:
            raise ValidationError(
                {'email': _("Please enter a new email address.")})