Completed
Pull Request — master (#17)
by Camille
03:15 queued 15s
created

User.is_group_member()   A

Complexity

Conditions 2

Size

Total Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 1
CRAP Score 2.5
Metric Value
cc 2
dl 0
loc 7
ccs 1
cts 2
cp 0.5
crap 2.5
rs 9.4285
1
from django.db import models
2
from django.contrib.auth.models import AbstractBaseUser, BaseUserManager
3
from dry_rest_permissions.generics import allow_staff_or_superuser
4
5
from sigma_core.models.group import Group
6
7
class UserManager(BaseUserManager):
8
    # TODO: Determine whether 'memberships' fields needs to be retrieved every time or not...
9
    # def get_queryset(self):
10
    #     return super(UserManager, self).get_queryset().prefetch_related('memberships', 'invited_to_groups')
11
12
    def create_user(self, email, lastname, firstname, password=None):
13
        """
14
        Creates and saves a User with the given email, lastname, firstname and password
15
        TODO - Generate a unique username.
16
        """
17
        if not email:
18
            raise ValueError('Users must have an email address')
19
20
        # username = email # TODO - Generate unique username
21
22
        user = self.model(
23
            email=self.normalize_email(email),
24
            lastname=lastname,
25
            firstname=firstname
26
        )
27
28
        user.set_password(password)
29
        user.save()
30
        return user
31
32
    def create_superuser(self, email, lastname, firstname, password):
33
        """
34
        Creates and saves a superuser with the given email, lastname, firstname and password.
35
        """
36
        user = self.create_user(email, lastname, firstname, password)
37
        user.is_superuser = True
38
        user.is_staff = True
39
        user.save()
40
        return user
41
42
43
class User(AbstractBaseUser):
44
    """
45
    User are identified by their email. Lastname and firstname are required.
46
    """
47
    email = models.EmailField(max_length=254, unique=True)
48
    lastname = models.CharField(max_length=255)
49
    firstname = models.CharField(max_length=128)
50
    # username = models.CharField(max_length=128, unique=True) # TODO - Add unique username for frontend URLs
51
    phone = models.CharField(max_length=20, blank=True)
52
53
    is_active = models.BooleanField(default=True)
54
    last_modified = models.DateTimeField(auto_now=True)
55
    join_date = models.DateTimeField(auto_now_add=True)
56
57
    is_superuser = models.BooleanField(default=False)
58
    is_staff = models.BooleanField(default=False)
59
60
    objects = UserManager()
61
62
    invited_to_groups = models.ManyToManyField(Group, blank=True, related_name="invited_users");
63
64
    # Related fields:
65 1
    #   - memberships (model UserGroup)
66
67
    USERNAME_FIELD = 'email'
68
    REQUIRED_FIELDS = ['lastname', 'firstname']
69
70
    def __str__(self):
71
        return self.email
72
73
    def get_full_name(self):
74
        return "{} {}".format(self.lastname, self.firstname)
75
76
    def get_short_name(self):
77
        return self.email
78
79
    def is_sigma_admin(self):
80
        return self.is_staff or self.is_superuser
81
82
    def is_group_member(self, g):
83
        from sigma_core.models.group_member import GroupMember
84 1
        try:
85
            mem = self.memberships.get(group=g)
86
        except GroupMember.DoesNotExist:
87
            return False
88
        return mem.is_accepted()
89
90
    def can_invite(self, group):
91 1
        from sigma_core.models.group_member import GroupMember
92
        try:
93
            mem = self.memberships.get(group=group)
94
        except GroupMember.DoesNotExist:
95
            return False
96
        return mem.perm_rank >= group.req_rank_invite
97
98
    def can_accept_join_requests(self, group):
99 1
        from sigma_core.models.group_member import GroupMember
100
        try:
101
            mem = self.memberships.get(group=group)
102
        except GroupMember.DoesNotExist:
103
            return False
104
        return mem.perm_rank >= group.req_rank_accept_join_requests
105
106
    def can_modify_group_infos(self, group):
107 1
        from sigma_core.models.group_member import GroupMember
108
        try:
109
            mem = self.memberships.get(group=group)
110
        except GroupMember.DoesNotExist:
111
            return False
112
        return mem.perm_rank >= group.req_rank_modify_group_infos
113 1
114
115
    # Perms for admin site
116
    def has_perm(self, perm, obj=None):
117
        return True
118
119
    def has_module_perms(self, app_label):
120 1
        return True
121
122
    # Permissions
123
    @staticmethod
124
    def has_read_permission(request):
125
        """
126
        Only authenticated users can retrieve an users list.
127
        """
128
        return True
129
130
    def has_object_read_permission(self, request):
131
        """
132
        Only authenticated users can retrieve an user.
133
        """
134
        return True
135
136
    @staticmethod
137
    def has_write_permission(request):
138
        """
139
        Everybody can edit or create users, but with certain restraints specified in below functions.
140
        By the way, everybody can change one's password or reset it.
141
        """
142
        return True
143
144
    @staticmethod
145
    @allow_staff_or_superuser
146
    def has_create_permission(request):
147
        """
148
        Only Sigma admins can create users.
149
        """
150
        return False
151
152
    def has_object_write_permission(self, request):
153
        """
154
        Nobody has all write permissions on an user (especially, nobody can delete an user).
155
        """
156
        return False
157
158
    @allow_staff_or_superuser
159
    def has_object_update_permission(self, request):
160
        """
161
        Only Sigma admin and oneself can edit an user.
162
        """
163
        return request.user.id == self.id
164