Completed
Pull Request — master (#16)
by
unknown
13:17
created

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