source: main/waeup.kofa/trunk/src/waeup/kofa/permissions.txt @ 12692

Last change on this file since 12692 was 12439, checked in by Henrik Bettermann, 10 years ago

Adjust tests.

File size: 3.1 KB
Line 
1Kofa permissions and roles
2**************************
3
4Permissions and roles used in a Kofa portal.
5
6.. :doctest:
7.. :layer: waeup.kofa.testing.KofaUnitTestLayer
8
9Convenience functions
10=====================
11
12:mod:`waeup.kofa` offers some convenience functions to handle security
13roles.
14
15:func:`get_all_roles`
16---------------------
17
18Gives us all roles defined in Kofa. We get tuples of
19kind
20
21  ``(<ROLE-NAME>, <ROLE>)``
22
23where ``<ROLE-NAME>`` is the name under which a role was registered
24with the ZCA (a string) and ``<ROLE>`` is the real role object.
25
26    >>> from waeup.kofa.permissions import get_all_roles
27    >>> get_all_roles()
28    <generator object...at 0x...>
29
30    >>> sorted(list(get_all_roles()))
31    [(u'waeup.ACManager', <waeup.kofa.permissions.ACManager object at 0x...]
32
33:func:`get_waeup_roles`
34-----------------------
35
36Gives us all roles, except the Kofa specific roles. We can get a list
37with or without local roles:
38
39    >>> from waeup.kofa.permissions import get_waeup_roles
40    >>> len(list(get_waeup_roles()))
41    24
42
43    >>> len(list(get_waeup_roles(also_local=True)))
44    45
45
46
47:func:`get_waeup_role_names`
48----------------------------
49
50We can get all role names defined in Kofa (except 'local'
51roles that are meant not to be assigned globally):
52
53    >>> from waeup.kofa.permissions import get_waeup_role_names
54    >>> list(get_waeup_role_names())
55    [u'waeup.ACManager',
56     u'waeup.AcademicsManager',
57     u'waeup.AcademicsOfficer',
58     u'waeup.AccommodationOfficer',
59     u'waeup.Applicant',
60     u'waeup.ApplicationsManager',
61     u'waeup.ApplicationsOfficer',
62     u'waeup.BursaryOfficer',
63     u'waeup.DataCenterManager',
64     u'waeup.DocumentsManager',
65     u'waeup.DocumentsOfficer',
66     u'waeup.ExportManager',
67     u'waeup.ImportManager',
68     u'waeup.PortalManager',
69     u'waeup.Student',
70     u'waeup.StudentImpersonator',
71     u'waeup.StudentsClearanceOfficer',
72     u'waeup.StudentsCourseAdviser',
73     u'waeup.StudentsManager',
74     u'waeup.StudentsOfficer',
75     u'waeup.TranscriptOfficer',
76     u'waeup.UsersManager',
77     u'waeup.WorkflowManager',
78     u'waeup.xmlrpcusers1']
79
80:func:`get_users_with_local_roles`
81----------------------------------
82
83We can get all users and their roles for a certain context
84object. This even works for objects that cannot have local roles as
85they are not stored in the ZODB:
86
87    >>> from waeup.kofa.permissions import get_users_with_local_roles
88    >>> mycontext = object()
89    >>> people_and_roles = get_users_with_local_roles(mycontext)
90    >>> people_and_roles
91    <generator object...at 0x...>
92
93In this case, the result is empty:
94
95    >>> people_and_roles = list(people_and_roles)
96    >>> people_and_roles
97    []
98
99:func:`get_users_with_role`
100---------------------------
101
102We can get all users with a specific role for a certain context
103object:
104
105    >>> from waeup.kofa.permissions import get_users_with_role
106    >>> mycontext = object()
107    >>> people = get_users_with_role('waeup.portalManager', mycontext)
108    >>> people
109    <generator object...at 0x...>
110
111In this case, the result is empty:
112
113    >>> people = list(people)
114    >>> people
115    []
Note: See TracBrowser for help on using the repository browser.