1 | # $Id: permissions.py 15155 2018-09-20 07:04:17Z henrik $ |
---|
2 | # |
---|
3 | # Copyright (C) 2011 Uli Fouquet & Henrik Bettermann |
---|
4 | # This program is free software; you can redistribute it and/or modify |
---|
5 | # it under the terms of the GNU General Public License as published by |
---|
6 | # the Free Software Foundation; either version 2 of the License, or |
---|
7 | # (at your option) any later version. |
---|
8 | # |
---|
9 | # This program is distributed in the hope that it will be useful, |
---|
10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
12 | # GNU General Public License for more details. |
---|
13 | # |
---|
14 | # You should have received a copy of the GNU General Public License |
---|
15 | # along with this program; if not, write to the Free Software |
---|
16 | # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
---|
17 | # |
---|
18 | import grok |
---|
19 | from zope.component import getUtilitiesFor |
---|
20 | from zope.interface import Interface |
---|
21 | from zope.securitypolicy.interfaces import IRole, IPrincipalRoleMap |
---|
22 | from waeup.kofa.interfaces import ILocalRolesAssignable |
---|
23 | |
---|
24 | |
---|
25 | class Public(grok.Permission): |
---|
26 | """The Public or everyone-can-do-this-permission is being applied |
---|
27 | to views/pages that are used by everyone. |
---|
28 | """ |
---|
29 | grok.name('waeup.Public') |
---|
30 | |
---|
31 | |
---|
32 | class Anonymous(grok.Permission): |
---|
33 | """The Anonymous permission is applied to |
---|
34 | views/pages which are dedicated to anonymous users only. |
---|
35 | Logged-in users can't access these views. |
---|
36 | """ |
---|
37 | grok.name('waeup.Anonymous') |
---|
38 | |
---|
39 | |
---|
40 | class Authenticated(grok.Permission): |
---|
41 | """The Authenticated permission is applied to pages |
---|
42 | which can only be used by logged-in users and not by anonymous users. |
---|
43 | """ |
---|
44 | grok.name('waeup.Authenticated') |
---|
45 | |
---|
46 | |
---|
47 | class ViewAcademics(grok.Permission): |
---|
48 | """The ViewAcademics permission is applied to all |
---|
49 | views of the Academic Section. Users with this permission can view but |
---|
50 | not edit content in the Academic Section. |
---|
51 | """ |
---|
52 | grok.name('waeup.viewAcademics') |
---|
53 | |
---|
54 | |
---|
55 | class ManageAcademics(grok.Permission): |
---|
56 | """The ManageAcademics permission is applied to all edit/manage |
---|
57 | pages in the Academic Section. Users who have this permission |
---|
58 | can change/edit context objects. |
---|
59 | """ |
---|
60 | grok.name('waeup.manageAcademics') |
---|
61 | |
---|
62 | |
---|
63 | class ManagePortal(grok.Permission): |
---|
64 | """The ManagePortal permission is used for very few pages |
---|
65 | (e.g. the DatacenterSettings page). Only PortalManagers have this |
---|
66 | permission. It is furthermore used to control delete methods of container |
---|
67 | pages in the Academic Section. The ManageAcademics permission, |
---|
68 | described above, does enable users to edit content but not to |
---|
69 | remove sub-containers, like faculties, departments or certificates. |
---|
70 | Users must have the ManagePortal permission too to remove |
---|
71 | entire containers. |
---|
72 | """ |
---|
73 | grok.name('waeup.managePortal') |
---|
74 | |
---|
75 | |
---|
76 | class ManageUsers(grok.Permission): |
---|
77 | """The ManageUsers permission is a real superuser permission |
---|
78 | and therefore very 'dangerous'. It allows to add, remove or edit |
---|
79 | user accounts. Editing a user account includes the option to assign |
---|
80 | or remove roles. That means that a user with this permission can lock out |
---|
81 | other users by either removing their account or by removing |
---|
82 | permissions. |
---|
83 | """ |
---|
84 | grok.name('waeup.manageUsers') |
---|
85 | |
---|
86 | |
---|
87 | class ShowStudents(grok.Permission): |
---|
88 | """Users with this permission do not neccessarily see the 'Students' tab |
---|
89 | but they can search for students at department, certificate or course |
---|
90 | level. If they additionally have the ExportData permission they can |
---|
91 | export the data as csv files. |
---|
92 | |
---|
93 | Bursary or Department Officers don't have the ExportData |
---|
94 | permission (see Roles section) and are only allowed to export bursary |
---|
95 | or payments overview data respectively. |
---|
96 | """ |
---|
97 | grok.name('waeup.showStudents') |
---|
98 | |
---|
99 | |
---|
100 | class ClearAllStudents(grok.Permission): |
---|
101 | """The ClearAllStudents permission allows to clear all students |
---|
102 | in a department at one sweep. |
---|
103 | """ |
---|
104 | grok.name('waeup.clearAllStudents') |
---|
105 | |
---|
106 | |
---|
107 | class EditScores(grok.Permission): |
---|
108 | """The EditScores permission allows to edit scores in course tickets. |
---|
109 | """ |
---|
110 | grok.name('waeup.editScores') |
---|
111 | |
---|
112 | |
---|
113 | class TriggerTransition(grok.Permission): |
---|
114 | """The TriggerTransition permission allows to trigger workflow transitions |
---|
115 | of student and document objects. |
---|
116 | """ |
---|
117 | grok.name('waeup.triggerTransition') |
---|
118 | |
---|
119 | |
---|
120 | class EditUser(grok.Permission): |
---|
121 | """The EditUser permission is required for editing |
---|
122 | single user accounts. |
---|
123 | """ |
---|
124 | grok.name('waeup.editUser') |
---|
125 | |
---|
126 | |
---|
127 | class ManageDataCenter(grok.Permission): |
---|
128 | """The ManageDataCenter permission allows to access all pages |
---|
129 | in the Data Center and to upload files. It does not automatically |
---|
130 | allow to process uploaded data files. |
---|
131 | """ |
---|
132 | grok.name('waeup.manageDataCenter') |
---|
133 | |
---|
134 | |
---|
135 | class ImportData(grok.Permission): |
---|
136 | """The ImportData permission allows to batch process (import) any kind of |
---|
137 | portal data except for user data. The User Data processor |
---|
138 | requires also the ManageUsers permission. |
---|
139 | """ |
---|
140 | grok.name('waeup.importData') |
---|
141 | |
---|
142 | |
---|
143 | class ExportData(grok.Permission): |
---|
144 | """The ExportData permission allows to export any kind of portal data. |
---|
145 | """ |
---|
146 | grok.name('waeup.exportData') |
---|
147 | |
---|
148 | |
---|
149 | class ExportPaymentsOverview(grok.Permission): |
---|
150 | grok.name('waeup.exportPaymentsOverview') |
---|
151 | |
---|
152 | |
---|
153 | class ExportBursaryData(grok.Permission): |
---|
154 | grok.name('waeup.exportBursaryData') |
---|
155 | |
---|
156 | |
---|
157 | class ManagePortalConfiguration(grok.Permission): |
---|
158 | """The ManagePortalConfiguration permission allows to |
---|
159 | edit global and sessional portal configuration data. |
---|
160 | """ |
---|
161 | grok.name('waeup.managePortalConfiguration') |
---|
162 | |
---|
163 | |
---|
164 | class ManageACBatches(grok.Permission): |
---|
165 | """The ManageACBatches permission allows to view and |
---|
166 | manage accesscodes. |
---|
167 | """ |
---|
168 | grok.name('waeup.manageACBatches') |
---|
169 | |
---|
170 | |
---|
171 | class PutBiometricDataPermission(grok.Permission): |
---|
172 | """This permission allows to upload/change biometric data. |
---|
173 | """ |
---|
174 | grok.name('waeup.putBiometricData') |
---|
175 | |
---|
176 | |
---|
177 | class GetBiometricDataPermission(grok.Permission): |
---|
178 | """This permission allows to read biometric data. |
---|
179 | """ |
---|
180 | grok.name('waeup.getBiometricData') |
---|
181 | |
---|
182 | |
---|
183 | # Local Roles |
---|
184 | |
---|
185 | class ApplicationsManager(grok.Role): |
---|
186 | """The local ApplicationsManager role can be assigned at applicants |
---|
187 | container and at department level. At department level an Applications |
---|
188 | Manager can manage all applicants which desire to study a programme |
---|
189 | offered by the department (1st Choice Course of Study). |
---|
190 | |
---|
191 | At container level (local) Applications Managers gain permissions which |
---|
192 | allow to manage the container and all applicants inside the container. At |
---|
193 | container level the permission set of this local role corresonds with the |
---|
194 | permission set of the same-named global role. |
---|
195 | """ |
---|
196 | grok.name('waeup.local.ApplicationsManager') |
---|
197 | grok.title(u'Applications Manager') |
---|
198 | grok.permissions('waeup.viewAcademics', |
---|
199 | 'waeup.manageApplication', 'waeup.viewApplication', |
---|
200 | 'waeup.payApplicant') |
---|
201 | |
---|
202 | |
---|
203 | class DepartmentOfficer(grok.Role): |
---|
204 | """The local DepartmentOfficer role can be assigned at faculty or |
---|
205 | department level. The role allows to list all student data within the |
---|
206 | faculty/department the local role is assigned. |
---|
207 | """ |
---|
208 | grok.name('waeup.local.DepartmentOfficer') |
---|
209 | grok.title(u'Department Officer') |
---|
210 | grok.permissions('waeup.showStudents', |
---|
211 | 'waeup.viewAcademics', |
---|
212 | 'waeup.exportPaymentsOverview') |
---|
213 | |
---|
214 | |
---|
215 | class DepartmentManager(grok.Role): |
---|
216 | """The local DepartmentManager role can be assigned at faculty or |
---|
217 | department level. The role allows to edit all data within this container. |
---|
218 | It does not automatically allow to remove sub-containers. |
---|
219 | |
---|
220 | Department Managers (Dean of Faculty or Head of Department respectively) |
---|
221 | can also list student data but not access student pages. |
---|
222 | """ |
---|
223 | grok.name('waeup.local.DepartmentManager') |
---|
224 | grok.title(u'Department Manager') |
---|
225 | grok.permissions('waeup.manageAcademics', |
---|
226 | 'waeup.showStudents', |
---|
227 | 'waeup.exportData') |
---|
228 | |
---|
229 | |
---|
230 | class ClearanceOfficer(grok.Role): |
---|
231 | """The local ClearanceOfficer role can be assigned at faculty or |
---|
232 | department level. The role allows to list or export all student |
---|
233 | data within the faculty/department the local role is assigned. |
---|
234 | |
---|
235 | Clearance Officers can furthermore clear all students or reject clearance |
---|
236 | of all students in their faculty/department. They get the |
---|
237 | StudentsClearanceOfficer role for this subset of students. |
---|
238 | """ |
---|
239 | grok.name('waeup.local.ClearanceOfficer') |
---|
240 | grok.title(u'Clearance Officer') |
---|
241 | grok.permissions('waeup.showStudents', |
---|
242 | 'waeup.viewAcademics', |
---|
243 | 'waeup.exportData', |
---|
244 | 'waeup.clearAllStudents') |
---|
245 | |
---|
246 | |
---|
247 | class LocalStudentsManager(grok.Role): |
---|
248 | """The local LocalStudentsManager role can be assigned at faculty or |
---|
249 | department level. The role allows to view all data and to view or export |
---|
250 | all student data within the faculty/department the local role is assigned. |
---|
251 | |
---|
252 | Local Students Managers can furthermore manage data of students |
---|
253 | in their faculty/department. They get the StudentsManager role for |
---|
254 | this subset of students. |
---|
255 | """ |
---|
256 | grok.name('waeup.local.LocalStudentsManager') |
---|
257 | grok.title(u'Students Manager') |
---|
258 | grok.permissions('waeup.showStudents', |
---|
259 | 'waeup.viewAcademics', |
---|
260 | 'waeup.exportData') |
---|
261 | |
---|
262 | |
---|
263 | class LocalWorkflowManager(grok.Role): |
---|
264 | """The local LocalWorkflowManager role can be assigned at faculty level. |
---|
265 | The role allows to view all data and to list or export |
---|
266 | all student data within the faculty the local role is assigned. |
---|
267 | |
---|
268 | Local Workflow Managers can trigger transition of students in their |
---|
269 | faculty/department. They get the WorkflowManager role for |
---|
270 | this subset of students. |
---|
271 | """ |
---|
272 | grok.name('waeup.local.LocalWorkflowManager') |
---|
273 | grok.title(u'Student Workflow Manager') |
---|
274 | grok.permissions('waeup.showStudents', |
---|
275 | 'waeup.viewAcademics', |
---|
276 | 'waeup.exportData') |
---|
277 | |
---|
278 | |
---|
279 | class UGClearanceOfficer(grok.Role): |
---|
280 | """UG Clearance Officers are regular Clearance Officers with restricted |
---|
281 | dynamic permission assignment. They can only access undergraduate |
---|
282 | students. |
---|
283 | """ |
---|
284 | grok.name('waeup.local.UGClearanceOfficer') |
---|
285 | grok.title(u'UG Clearance Officer') |
---|
286 | grok.permissions('waeup.showStudents', |
---|
287 | 'waeup.viewAcademics', |
---|
288 | 'waeup.exportData', |
---|
289 | 'waeup.clearAllStudents') |
---|
290 | |
---|
291 | |
---|
292 | class PGClearanceOfficer(grok.Role): |
---|
293 | """PG Clearance Officers are regular Clearance Officers with restricted |
---|
294 | dynamic permission assignment. They can only access postgraduate |
---|
295 | students. |
---|
296 | """ |
---|
297 | grok.name('waeup.local.PGClearanceOfficer') |
---|
298 | grok.title(u'PG Clearance Officer') |
---|
299 | grok.permissions('waeup.showStudents', |
---|
300 | 'waeup.viewAcademics', |
---|
301 | 'waeup.exportData', |
---|
302 | 'waeup.clearAllStudents') |
---|
303 | |
---|
304 | |
---|
305 | class CourseAdviser100(grok.Role): |
---|
306 | """The local CourseAdviser100 role can be assigned at faculty, |
---|
307 | department or certificate level. The role allows to view all data and |
---|
308 | to list or export all student data within the faculty, department |
---|
309 | or certificate the local role is assigned. |
---|
310 | |
---|
311 | Local Course Advisers can validate or reject course lists of students |
---|
312 | in ther faculty/department/certificate at level 100. |
---|
313 | They get the StudentsCourseAdviser role for this subset of students. |
---|
314 | """ |
---|
315 | grok.name('waeup.local.CourseAdviser100') |
---|
316 | grok.title(u'Course Adviser 100L') |
---|
317 | grok.permissions('waeup.showStudents', |
---|
318 | 'waeup.viewAcademics', |
---|
319 | 'waeup.exportData') |
---|
320 | |
---|
321 | |
---|
322 | class CourseAdviser200(grok.Role): |
---|
323 | """Same as CourseAdviser100 but for level 200. |
---|
324 | """ |
---|
325 | grok.name('waeup.local.CourseAdviser200') |
---|
326 | grok.title(u'Course Adviser 200L') |
---|
327 | grok.permissions('waeup.showStudents', |
---|
328 | 'waeup.viewAcademics', |
---|
329 | 'waeup.exportData') |
---|
330 | |
---|
331 | |
---|
332 | class CourseAdviser300(grok.Role): |
---|
333 | """Same as CourseAdviser100 but for level 300. |
---|
334 | """ |
---|
335 | grok.name('waeup.local.CourseAdviser300') |
---|
336 | grok.title(u'Course Adviser 300L') |
---|
337 | grok.permissions('waeup.showStudents', |
---|
338 | 'waeup.viewAcademics', |
---|
339 | 'waeup.exportData') |
---|
340 | |
---|
341 | |
---|
342 | class CourseAdviser400(grok.Role): |
---|
343 | """Same as CourseAdviser100 but for level 400. |
---|
344 | """ |
---|
345 | grok.name('waeup.local.CourseAdviser400') |
---|
346 | grok.title(u'Course Adviser 400L') |
---|
347 | grok.permissions('waeup.showStudents', |
---|
348 | 'waeup.viewAcademics', |
---|
349 | 'waeup.exportData') |
---|
350 | |
---|
351 | |
---|
352 | class CourseAdviser500(grok.Role): |
---|
353 | """Same as CourseAdviser100 but for level 500. |
---|
354 | """ |
---|
355 | grok.name('waeup.local.CourseAdviser500') |
---|
356 | grok.title(u'Course Adviser 500L') |
---|
357 | grok.permissions('waeup.showStudents', |
---|
358 | 'waeup.viewAcademics', |
---|
359 | 'waeup.exportData') |
---|
360 | |
---|
361 | |
---|
362 | class CourseAdviser600(grok.Role): |
---|
363 | """Same as CourseAdviser100 but for level 600. |
---|
364 | """ |
---|
365 | grok.name('waeup.local.CourseAdviser600') |
---|
366 | grok.title(u'Course Adviser 600L') |
---|
367 | grok.permissions('waeup.showStudents', |
---|
368 | 'waeup.viewAcademics', |
---|
369 | 'waeup.exportData') |
---|
370 | |
---|
371 | |
---|
372 | class CourseAdviser700(grok.Role): |
---|
373 | """Same as CourseAdviser100 but for level 700. |
---|
374 | """ |
---|
375 | grok.name('waeup.local.CourseAdviser700') |
---|
376 | grok.title(u'Course Adviser 700L') |
---|
377 | grok.permissions('waeup.showStudents', |
---|
378 | 'waeup.viewAcademics', |
---|
379 | 'waeup.exportData') |
---|
380 | |
---|
381 | |
---|
382 | class CourseAdviser800(grok.Role): |
---|
383 | """Same as CourseAdviser100 but for level 800. |
---|
384 | """ |
---|
385 | grok.name('waeup.local.CourseAdviser800') |
---|
386 | grok.title(u'Course Adviser 800L') |
---|
387 | grok.permissions('waeup.showStudents', |
---|
388 | 'waeup.viewAcademics', |
---|
389 | 'waeup.exportData') |
---|
390 | |
---|
391 | |
---|
392 | class LocalTranscriptOfficer(grok.Role): |
---|
393 | """The LocalTranscriptOfficer role can be assigned at faculty |
---|
394 | level. The role allows to view, to validate and to |
---|
395 | release student transcripts at faculty level. |
---|
396 | Local Transcript Officers get the TranscriptOfficer role |
---|
397 | for this subset of students. |
---|
398 | """ |
---|
399 | grok.name('waeup.local.TranscriptOfficer') |
---|
400 | grok.title(u'Transcript Officer') |
---|
401 | grok.permissions('waeup.viewAcademics',) |
---|
402 | |
---|
403 | |
---|
404 | class LocalTranscriptSignee(grok.Role): |
---|
405 | """The LocalTranscriptSignee role can be assigned at faculty |
---|
406 | level. The role allows to view and to sign student transcripts |
---|
407 | at faculty level. Local Transcript Signees get the TranscriptSignee role |
---|
408 | for this subset of students. |
---|
409 | """ |
---|
410 | grok.name('waeup.local.TranscriptSignee') |
---|
411 | grok.title(u'Transcript Signee') |
---|
412 | grok.permissions('waeup.viewAcademics',) |
---|
413 | |
---|
414 | |
---|
415 | class Lecturer(grok.Role): |
---|
416 | """The local Lecturer role can be assigned at course level. |
---|
417 | The role allows to export some student |
---|
418 | data within the course the local role is assigned. Lecturers can't access |
---|
419 | student data directly but they can edit the scores in course tickets. |
---|
420 | """ |
---|
421 | grok.name('waeup.local.Lecturer') |
---|
422 | grok.title(u'Lecturer') |
---|
423 | grok.permissions('waeup.editScores', |
---|
424 | 'waeup.viewAcademics', |
---|
425 | 'waeup.exportData') |
---|
426 | |
---|
427 | |
---|
428 | class Owner(grok.Role): |
---|
429 | """Each user 'owns' her/his user object and gains permission to edit |
---|
430 | some of the user attributes. |
---|
431 | """ |
---|
432 | grok.name('waeup.local.Owner') |
---|
433 | grok.title(u'Owner') |
---|
434 | grok.permissions('waeup.editUser') |
---|
435 | |
---|
436 | |
---|
437 | # Site Roles |
---|
438 | class AcademicsOfficer(grok.Role): |
---|
439 | """An Academics Officer can view but not edit data in the |
---|
440 | academic section. |
---|
441 | |
---|
442 | This is the default role which is automatically assigned to all |
---|
443 | officers of the portal. A user with this role can access all display pages |
---|
444 | at faculty, department, course, certificate and certificate course level. |
---|
445 | """ |
---|
446 | grok.name('waeup.AcademicsOfficer') |
---|
447 | grok.title(u'Academics Officer (view only)') |
---|
448 | grok.permissions('waeup.viewAcademics') |
---|
449 | |
---|
450 | |
---|
451 | class AcademicsManager(grok.Role): |
---|
452 | """An Academics Manager can view and edit all data in the |
---|
453 | scademic section, i.e. access all manage pages |
---|
454 | at faculty, department, course, certificate and certificate course level. |
---|
455 | """ |
---|
456 | grok.name('waeup.AcademicsManager') |
---|
457 | grok.title(u'Academics Manager') |
---|
458 | title = u'Academics Manager' |
---|
459 | grok.permissions('waeup.viewAcademics', |
---|
460 | 'waeup.manageAcademics') |
---|
461 | |
---|
462 | |
---|
463 | class ACManager(grok.Role): |
---|
464 | """This is the role for Access Code Managers. |
---|
465 | An AC Manager can view and manage the Accesscodes Section, see |
---|
466 | ManageACBatches permission above. |
---|
467 | """ |
---|
468 | grok.name('waeup.ACManager') |
---|
469 | grok.title(u'Access Code Manager') |
---|
470 | grok.permissions('waeup.manageACBatches') |
---|
471 | |
---|
472 | |
---|
473 | class DataCenterManager(grok.Role): |
---|
474 | """This single-permission role is dedicated to those users |
---|
475 | who are charged with batch processing of portal data. |
---|
476 | A Data Center Manager can access all pages in the Data Center, |
---|
477 | see ManageDataCenter permission above. |
---|
478 | """ |
---|
479 | grok.name('waeup.DataCenterManager') |
---|
480 | grok.title(u'Datacenter Manager') |
---|
481 | grok.permissions('waeup.manageDataCenter') |
---|
482 | |
---|
483 | |
---|
484 | class ImportManager(grok.Role): |
---|
485 | """An Import Manager is a Data Center Manager who is also allowed |
---|
486 | to batch process (import) data. All batch processors (importers) are |
---|
487 | available except for the User Processor. This processor requires the |
---|
488 | Users Manager role too. The ImportManager role includes the |
---|
489 | DataCenterManager role but not vice versa. |
---|
490 | """ |
---|
491 | grok.name('waeup.ImportManager') |
---|
492 | grok.title(u'Import Manager') |
---|
493 | grok.permissions('waeup.manageDataCenter', |
---|
494 | 'waeup.importData') |
---|
495 | |
---|
496 | |
---|
497 | class ExportManager(grok.Role): |
---|
498 | """An Export Manager is a Data Center Manager who is also allowed |
---|
499 | to export all kind of portal data. The ExportManager role includes the |
---|
500 | DataCenterManager role but not vice versa. |
---|
501 | """ |
---|
502 | grok.name('waeup.ExportManager') |
---|
503 | grok.title(u'Export Manager') |
---|
504 | grok.permissions('waeup.manageDataCenter', |
---|
505 | 'waeup.exportData', |
---|
506 | 'waeup.showStudents') |
---|
507 | |
---|
508 | |
---|
509 | class BursaryOfficer(grok.Role): |
---|
510 | """Bursary Officers can export bursary data. They can't access the |
---|
511 | Data Center but see student data export buttons in the Academic Section. |
---|
512 | """ |
---|
513 | grok.name('waeup.BursaryOfficer') |
---|
514 | grok.title(u'Bursary Officer') |
---|
515 | grok.permissions('waeup.showStudents', |
---|
516 | 'waeup.viewAcademics', |
---|
517 | 'waeup.exportBursaryData') |
---|
518 | |
---|
519 | |
---|
520 | class UsersManager(grok.Role): |
---|
521 | """A Users Manager can add, remove or edit |
---|
522 | user accounts, see ManageUsers permission for further information. |
---|
523 | Be very careful with this role. |
---|
524 | """ |
---|
525 | grok.name('waeup.UsersManager') |
---|
526 | grok.title(u'Users Manager') |
---|
527 | grok.permissions('waeup.manageUsers', |
---|
528 | 'waeup.editUser') |
---|
529 | |
---|
530 | |
---|
531 | class WorkflowManager(grok.Role): |
---|
532 | """The Workflow Manager can trigger workflow transitions |
---|
533 | of student and document objects, see TriggerTransition permission |
---|
534 | for further information. |
---|
535 | """ |
---|
536 | grok.name('waeup.WorkflowManager') |
---|
537 | grok.title(u'Workflow Manager') |
---|
538 | grok.permissions('waeup.triggerTransition') |
---|
539 | |
---|
540 | |
---|
541 | class FingerprintReaderDeviceRole(grok.Role): |
---|
542 | """Fingerprint Reader Devices. |
---|
543 | |
---|
544 | Fingerprint readers are remote devices that can store and retrieve |
---|
545 | fingerprint data. |
---|
546 | """ |
---|
547 | grok.name('waeup.FingerprintDevice') |
---|
548 | grok.title(u'Fingerprint Reader') |
---|
549 | grok.permissions( |
---|
550 | 'waeup.getBiometricData', |
---|
551 | 'waeup.putBiometricData', |
---|
552 | ) |
---|
553 | |
---|
554 | |
---|
555 | class PortalManager(grok.Role): |
---|
556 | """The PortalManager role is the maximum set of Kofa permissions |
---|
557 | which are needed to manage the entire portal. This set must not |
---|
558 | be customized. It is recommended to assign this role only |
---|
559 | to a few certified Kofa administrators. |
---|
560 | A less dangerous manager role is the CCOfficer role described below. |
---|
561 | For the most tasks the CCOfficer role is sufficient. |
---|
562 | """ |
---|
563 | grok.name('waeup.PortalManager') |
---|
564 | grok.title(u'Portal Manager') |
---|
565 | grok.permissions('waeup.managePortal', |
---|
566 | 'waeup.manageUsers', |
---|
567 | 'waeup.viewAcademics', 'waeup.manageAcademics', |
---|
568 | 'waeup.manageACBatches', |
---|
569 | 'waeup.manageDataCenter', |
---|
570 | 'waeup.importData', |
---|
571 | 'waeup.exportData', |
---|
572 | 'waeup.viewTranscript', |
---|
573 | 'waeup.processTranscript', |
---|
574 | 'waeup.viewDocuments', 'waeup.manageDocuments', |
---|
575 | 'waeup.managePortalConfiguration', |
---|
576 | 'waeup.viewApplication', |
---|
577 | 'waeup.manageApplication', 'waeup.handleApplication', |
---|
578 | 'waeup.viewApplicantsTab', 'waeup.payApplicant', |
---|
579 | 'waeup.viewApplicationStatistics', |
---|
580 | 'waeup.viewStudent', 'waeup.manageStudent', |
---|
581 | 'waeup.clearStudent', 'waeup.payStudent', |
---|
582 | 'waeup.clearStudentFinancially', # not used in base pkg |
---|
583 | 'waeup.uploadStudentFile', 'waeup.showStudents', |
---|
584 | 'waeup.clearAllStudents', |
---|
585 | 'waeup.createStudents', |
---|
586 | 'waeup.editScores', |
---|
587 | 'waeup.triggerTransition', |
---|
588 | 'waeup.validateStudent', |
---|
589 | 'waeup.viewStudentsContainer', |
---|
590 | 'waeup.handleAccommodation', |
---|
591 | 'waeup.viewHostels', 'waeup.manageHostels', |
---|
592 | 'waeup.editUser', |
---|
593 | 'waeup.loginAsStudent', |
---|
594 | 'waeup.handleReports', |
---|
595 | 'waeup.manageReports', |
---|
596 | 'waeup.manageJobs', |
---|
597 | ) |
---|
598 | |
---|
599 | |
---|
600 | class CCOfficer(grok.Role): |
---|
601 | """The role of the Computer Center Officer is basically a copy |
---|
602 | of the the PortalManager role. Some 'dangerous' permissions are excluded |
---|
603 | by commenting them out (see source code). If officers need to gain more |
---|
604 | access rights than defined in this role, do not hastily switch to the |
---|
605 | PortalManager role but add further manager roles instead. Additional |
---|
606 | roles could be: UsersManager, ACManager, ImportManager, WorkflowManager |
---|
607 | or StudentImpersonator. |
---|
608 | |
---|
609 | CCOfficer is a base class which means that this role is subject to |
---|
610 | customization. It is not used in the ``waeup.kofa`` base package. |
---|
611 | """ |
---|
612 | grok.baseclass() |
---|
613 | grok.name('waeup.CCOfficer') |
---|
614 | grok.title(u'Computer Center Officer') |
---|
615 | grok.permissions( |
---|
616 | # 'waeup.managePortal', |
---|
617 | # 'waeup.manageUsers', |
---|
618 | 'waeup.viewAcademics', |
---|
619 | 'waeup.manageAcademics', |
---|
620 | # 'waeup.manageACBatches', |
---|
621 | 'waeup.manageDataCenter', |
---|
622 | # 'waeup.importData', |
---|
623 | 'waeup.exportData', |
---|
624 | 'waeup.viewTranscript', |
---|
625 | 'waeup.processTranscript', |
---|
626 | 'waeup.viewDocuments', 'waeup.manageDocuments', |
---|
627 | 'waeup.managePortalConfiguration', 'waeup.viewApplication', |
---|
628 | 'waeup.manageApplication', 'waeup.handleApplication', |
---|
629 | 'waeup.viewApplicantsTab', 'waeup.payApplicant', |
---|
630 | 'waeup.viewApplicationStatistics', |
---|
631 | 'waeup.viewStudent', 'waeup.manageStudent', |
---|
632 | 'waeup.clearStudent', 'waeup.payStudent', |
---|
633 | 'waeup.uploadStudentFile', 'waeup.showStudents', |
---|
634 | 'waeup.clearAllStudents', |
---|
635 | # 'waeup.createStudents', |
---|
636 | 'waeup.editScores', |
---|
637 | # 'waeup.triggerTransition', |
---|
638 | 'waeup.validateStudent', |
---|
639 | 'waeup.viewStudentsContainer', |
---|
640 | 'waeup.handleAccommodation', |
---|
641 | 'waeup.viewHostels', 'waeup.manageHostels', |
---|
642 | # 'waeup.editUser', |
---|
643 | # 'waeup.loginAsStudent', |
---|
644 | 'waeup.handleReports', |
---|
645 | 'waeup.manageReports', |
---|
646 | # 'waeup.manageJobs', |
---|
647 | ) |
---|
648 | |
---|
649 | |
---|
650 | def get_all_roles(): |
---|
651 | """Return a list of tuples ``<ROLE-NAME>, <ROLE>``. |
---|
652 | """ |
---|
653 | return getUtilitiesFor(IRole) |
---|
654 | |
---|
655 | |
---|
656 | def get_waeup_roles(also_local=False): |
---|
657 | """Get all Kofa roles. |
---|
658 | |
---|
659 | Kofa roles are ordinary roles whose id by convention starts with |
---|
660 | a ``waeup.`` prefix. |
---|
661 | |
---|
662 | If `also_local` is ``True`` (``False`` by default), also local |
---|
663 | roles are returned. Local Kofa roles are such whose id starts |
---|
664 | with ``waeup.local.`` prefix (this is also a convention). |
---|
665 | |
---|
666 | Returns a generator of the found roles. |
---|
667 | """ |
---|
668 | for name, item in get_all_roles(): |
---|
669 | if not name.startswith('waeup.'): |
---|
670 | # Ignore non-Kofa roles... |
---|
671 | continue |
---|
672 | if not also_local and name.startswith('waeup.local.'): |
---|
673 | # Ignore local roles... |
---|
674 | continue |
---|
675 | yield item |
---|
676 | |
---|
677 | |
---|
678 | def get_waeup_role_names(): |
---|
679 | """Get the ids of all Kofa roles. |
---|
680 | |
---|
681 | See :func:`get_waeup_roles` for what a 'KofaRole' is. |
---|
682 | |
---|
683 | This function returns a sorted list of Kofa role names. |
---|
684 | """ |
---|
685 | return sorted([x.id for x in get_waeup_roles()]) |
---|
686 | |
---|
687 | |
---|
688 | class LocalRolesAssignable(grok.Adapter): |
---|
689 | """Default implementation for `ILocalRolesAssignable`. |
---|
690 | |
---|
691 | This adapter returns a list for dictionaries for objects for which |
---|
692 | we want to know the roles assignable to them locally. |
---|
693 | |
---|
694 | The returned dicts contain a ``name`` and a ``title`` entry which |
---|
695 | give a role (``name``) and a description, for which kind of users |
---|
696 | the permission is meant to be used (``title``). |
---|
697 | |
---|
698 | Having this adapter registered we make sure, that for each normal |
---|
699 | object we get a valid `ILocalRolesAssignable` adapter. |
---|
700 | |
---|
701 | Objects that want to offer certain local roles, can do so by |
---|
702 | setting a (preferably class-) attribute to a list of role ids. |
---|
703 | |
---|
704 | You can also define different adapters for different contexts to |
---|
705 | have different role lookup mechanisms become available. But in |
---|
706 | normal cases it should be sufficient to use this basic adapter. |
---|
707 | """ |
---|
708 | grok.context(Interface) |
---|
709 | grok.provides(ILocalRolesAssignable) |
---|
710 | |
---|
711 | _roles = [] |
---|
712 | |
---|
713 | def __init__(self, context): |
---|
714 | self.context = context |
---|
715 | role_ids = getattr(context, 'local_roles', self._roles) |
---|
716 | self._roles = [(name, role) for name, role in get_all_roles() |
---|
717 | if name in role_ids] |
---|
718 | return |
---|
719 | |
---|
720 | def __call__(self): |
---|
721 | """Get a list of dictionaries containing ``names`` (the roles to |
---|
722 | assign) and ``titles`` (some description of the type of user |
---|
723 | to assign each role to). |
---|
724 | """ |
---|
725 | list_of_dict = [dict( |
---|
726 | name=name, |
---|
727 | title=role.title, |
---|
728 | description=role.description) |
---|
729 | for name, role in self._roles] |
---|
730 | return sorted(list_of_dict, key=lambda x: x['name']) |
---|
731 | |
---|
732 | |
---|
733 | def get_all_users(): |
---|
734 | """Get a list of dictionaries. |
---|
735 | """ |
---|
736 | users = sorted(grok.getSite()['users'].items(), key=lambda x: x[1].title) |
---|
737 | for key, val in users: |
---|
738 | yield(dict(name=key, val=val)) |
---|
739 | |
---|
740 | |
---|
741 | def get_users_with_local_roles(context): |
---|
742 | """Get a list of dicts representing the local roles set for `context`. |
---|
743 | |
---|
744 | Each dict returns `user_name`, `user_title`, `local_role`, |
---|
745 | `local_role_title`, and `setting` for each entry in the local |
---|
746 | roles map of the `context` object. |
---|
747 | """ |
---|
748 | try: |
---|
749 | role_map = IPrincipalRoleMap(context) |
---|
750 | except TypeError: |
---|
751 | # no map no roles. |
---|
752 | raise StopIteration |
---|
753 | for local_role, user_name, setting in role_map.getPrincipalsAndRoles(): |
---|
754 | user = grok.getSite()['users'].get(user_name, None) |
---|
755 | user_title = getattr(user, 'title', user_name) |
---|
756 | local_role_title = getattr( |
---|
757 | dict(get_all_roles()).get(local_role, None), 'title', None) |
---|
758 | yield dict(user_name=user_name, |
---|
759 | user_title=user_title, |
---|
760 | local_role=local_role, |
---|
761 | local_role_title=local_role_title, |
---|
762 | setting=setting) |
---|
763 | |
---|
764 | |
---|
765 | def get_users_with_role(role, context): |
---|
766 | """Get a list of dicts representing the usres who have been granted |
---|
767 | a role for `context`. |
---|
768 | """ |
---|
769 | try: |
---|
770 | role_map = IPrincipalRoleMap(context) |
---|
771 | except TypeError: |
---|
772 | # no map no roles. |
---|
773 | raise StopIteration |
---|
774 | for user_name, setting in role_map.getPrincipalsForRole(role): |
---|
775 | user = grok.getSite()['users'].get(user_name, None) |
---|
776 | user_title = getattr(user, 'title', user_name) |
---|
777 | user_email = getattr(user, 'email', None) |
---|
778 | yield dict(user_name=user_name, |
---|
779 | user_title=user_title, |
---|
780 | user_email=user_email, |
---|
781 | setting=setting) |
---|