Debian Codegraph @

django/contrib/auth/context_processors.py

raw
1 # PermWrapper and PermLookupDict proxy the permissions system into objects that
2 # the template system can understand.
3
4
5 class PermLookupDict:
6 def __init__(self, user, app_label):
7 self.user, self.app_label = user, app_label
8
9 def __repr__(self):
10 return str(self.user.get_all_permissions())
11
12 def __getitem__(self, perm_name):
13 return self.user.has_perm("%s.%s" % (self.app_label, perm_name))
14
15 def __iter__(self):
16 # To fix 'item in perms.someapp' and __getitem__ interaction we need to
17 # define __iter__. See #18979 for details.
18 raise TypeError("PermLookupDict is not iterable.")
19
20 def __bool__(self):
21 return self.user.has_module_perms(self.app_label)
22
23
24 class PermWrapper:
25 def __init__(self, user):
26 self.user = user
27
28 def __repr__(self):
29 return f"{self.__class__.__qualname__}({self.user!r})"
30
31 def __getitem__(self, app_label):
32 return PermLookupDict(self.user, app_label)
33
34 def __iter__(self):
35 # I am large, I contain multitudes.
36 raise TypeError("PermWrapper is not iterable.")
37
38 def __contains__(self, perm_name):
39 """
40 Lookup by "someapp" or "someapp.someperm" in perms.
41 """
42 if "." not in perm_name:
43 # The name refers to module.
44 return bool(self[perm_name])
45 app_label, perm_name = perm_name.split(".", 1)
46 return self[app_label][perm_name]
47
48
49 def auth(request):
50 """
51 Return context variables required by apps that use Django's authentication
52 system.
53
54 If there is no 'user' attribute in the request, use AnonymousUser (from
55 django.contrib.auth).
56 """
57 if hasattr(request, "user"):
58 user = request.user
59 else:
60 from django.contrib.auth.models import AnonymousUser
61
62 user = AnonymousUser()
63
64 return {
65 "user": user,
66 "perms": PermWrapper(user),
67 }