app/soc/views/helper/access.py
author Pawel Solyga <Pawel.Solyga@gmail.com>
Tue, 07 Apr 2009 12:31:12 +0000
changeset 2116 68d7679a2af2
parent 2112 9a2c9354468c
child 2145 ea919c2dfe41
permissions -rw-r--r--
Add pylint: disable-msg=W0706 to soc.views.helper.access module. Patch by: Pawel Solyga Reviewed by: to-be-reviewed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     1
#!/usr/bin/python2.5
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     2
#
1308
35b75ffcbb37 Partially reverted "Update the copyright notice for 2009."
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1307
diff changeset
     3
# Copyright 2008 the Melange authors.
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     4
#
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     5
# Licensed under the Apache License, Version 2.0 (the "License");
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     6
# you may not use this file except in compliance with the License.
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     7
# You may obtain a copy of the License at
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     8
#
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     9
#   http://www.apache.org/licenses/LICENSE-2.0
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    10
#
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    11
# Unless required by applicable law or agreed to in writing, software
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    12
# distributed under the License is distributed on an "AS IS" BASIS,
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    13
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    14
# See the License for the specific language governing permissions and
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    15
# limitations under the License.
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    16
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    17
"""Access control helper.
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    18
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    19
The functions in this module can be used to check access control
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    20
related requirements. When the specified required conditions are not
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    21
met, an exception is raised. This exception contains a views that
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    22
either prompts for authentication, or informs the user that they
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    23
do not meet the required criteria.
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    24
"""
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    25
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    26
__authors__ = [
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    27
  '"Todd Larsen" <tlarsen@google.com>',
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    28
  '"Sverre Rabbelier" <sverre@rabbelier.nl>',
726
ba3d399ec9be Added Notifications.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 720
diff changeset
    29
  '"Lennard de Rijk" <ljvderijk@gmail.com>',
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    30
  '"Pawel Solyga" <pawel.solyga@gmail.com>',
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    31
  ]
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    32
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    33
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
    34
from google.appengine.api import memcache
315
c4f1a07ee340 Add missing blank lines between imports in access.py module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 309
diff changeset
    35
970
8b5611d5b053 Use ugettext instead of ugettext_lazy
Sverre Rabbelier <srabbelier@gmail.com>
parents: 965
diff changeset
    36
from django.utils.translation import ugettext
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    37
720
9eb2522dfa83 Make it possible to invite another Host as Host
Sverre Rabbelier <srabbelier@gmail.com>
parents: 714
diff changeset
    38
from soc.logic import dicts
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
    39
from soc.logic import rights as rights_logic
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
    40
from soc.logic.helper import timeline as timeline_helper
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
    41
from soc.logic.models.club_admin import logic as club_admin_logic
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
    42
from soc.logic.models.club_member import logic as club_member_logic
1115
0a723ff3d27c Cleanups in base.Logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1107
diff changeset
    43
from soc.logic.models.document import logic as document_logic
887
b8c1a6bc913e Take advantage of new "from ... import ... as ..." rules in the style guide.
Todd Larsen <tlarsen@google.com>
parents: 884
diff changeset
    44
from soc.logic.models.host import logic as host_logic
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
    45
from soc.logic.models.mentor import logic as mentor_logic
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
    46
from soc.logic.models.org_admin import logic as org_admin_logic
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
    47
from soc.logic.models.organization import logic as org_logic
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
    48
from soc.logic.models.program import logic as program_logic
887
b8c1a6bc913e Take advantage of new "from ... import ... as ..." rules in the style guide.
Todd Larsen <tlarsen@google.com>
parents: 884
diff changeset
    49
from soc.logic.models.request import logic as request_logic
979
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
    50
from soc.logic.models.role import logic as role_logic
891
3d40190f35b6 Move getToSLink() to soc.views.helper.redirects.getToSRedirect().
Todd Larsen <tlarsen@google.com>
parents: 890
diff changeset
    51
from soc.logic.models.site import logic as site_logic
1445
c2e09f7d62d9 Forgotten import
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1444
diff changeset
    52
from soc.logic.models.sponsor import logic as sponsor_logic
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
    53
from soc.logic.models.student import logic as student_logic
2112
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
    54
from soc.logic.models.student_project import logic as student_project_logic
1466
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
    55
from soc.logic.models.student_proposal import logic as student_proposal_logic
1142
da2487767ef4 Fix missing dot and wrong import sorting in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1135
diff changeset
    56
from soc.logic.models.timeline import logic as timeline_logic
887
b8c1a6bc913e Take advantage of new "from ... import ... as ..." rules in the style guide.
Todd Larsen <tlarsen@google.com>
parents: 884
diff changeset
    57
from soc.logic.models.user import logic as user_logic
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
    58
from soc.views.helper import redirects
543
280a1ac6bcc1 Merge soc/logic/out_of_band.py into soc/views/out_of_band.py. Merge
Todd Larsen <tlarsen@google.com>
parents: 525
diff changeset
    59
from soc.views import out_of_band
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    60
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    61
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
    62
DEF_NO_USER_LOGIN_MSG = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    63
    'Please create <a href="/user/create_profile">User Profile</a>'
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    64
    ' in order to view this page.')
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    65
970
8b5611d5b053 Use ugettext instead of ugettext_lazy
Sverre Rabbelier <srabbelier@gmail.com>
parents: 965
diff changeset
    66
DEF_AGREE_TO_TOS_MSG_FMT = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    67
    'You must agree to the <a href="%(tos_link)s">site-wide Terms of'
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    68
    ' Service</a> in your <a href="/user/edit_profile">User Profile</a>'
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    69
    ' in order to view this page.')
888
a75ae24f04cb Add checkAgreesToSiteToS() (partially implemented until circular import fixed).
Todd Larsen <tlarsen@google.com>
parents: 887
diff changeset
    70
970
8b5611d5b053 Use ugettext instead of ugettext_lazy
Sverre Rabbelier <srabbelier@gmail.com>
parents: 965
diff changeset
    71
DEF_DEV_LOGOUT_LOGIN_MSG_FMT = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    72
    'Please <a href="%%(sign_out)s">sign out</a>'
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    73
    ' and <a href="%%(sign_in)s">sign in</a>'
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    74
    ' again as %(role)s to view this page.')
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    75
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
    76
DEF_NEED_MEMBERSHIP_MSG_FMT = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    77
    'You need to be in the %(status)s group to %(action)s'
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    78
    ' documents in the %(prefix)s prefix.')
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
    79
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
    80
DEF_NEED_ROLE_MSG = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    81
    'You do not have the required role.')
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
    82
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
    83
DEF_NOT_YOUR_ENTITY_MSG = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    84
    'This entity does not belong to you.')
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
    85
1435
e9a2b1e87b1a Added support for having a format string as scope_path filter
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1388
diff changeset
    86
DEF_NO_ACTIVE_ENTITY_MSG = ugettext(
e9a2b1e87b1a Added support for having a format string as scope_path filter
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1388
diff changeset
    87
    'There is no such active entity.')
e9a2b1e87b1a Added support for having a format string as scope_path filter
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1388
diff changeset
    88
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
    89
DEF_NO_ACTIVE_GROUP_MSG = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    90
    'There is no such active group.')
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    91
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    92
DEF_NO_ACTIVE_ROLE_MSG = ugettext(
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    93
    'There is no such active role.')
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
    94
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
    95
DEF_ALREADY_PARTICIPATING_MSG = ugettext(
1832
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
    96
    'You cannot become a Student because you are already participating '
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
    97
    'in this program.')
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
    98
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
    99
DEF_ALREADY_STUDENT_ROLE_MSG = ugettext(
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
   100
    'You cannot become a Mentor or Organization Admin because you already are '
1832
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
   101
    'a Student in this program.')
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
   102
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
   103
DEF_NO_ACTIVE_PROGRAM_MSG = ugettext(
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
   104
    'There is no such active program.')
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   105
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   106
DEF_NO_REQUEST_MSG = ugettext(
1870
ea7019607df2 Verbiage fix in ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1832
diff changeset
   107
    'There is no accepted request that would allow you to visit this page. '
ea7019607df2 Verbiage fix in ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1832
diff changeset
   108
    'Perhaps you already accepted this request?')
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
   109
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
   110
DEF_NO_APPLICATION_MSG = ugettext(
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
   111
    'There is no application that would allow you to visit this page.')
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   112
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   113
DEF_NEED_PICK_ARGS_MSG = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
   114
    'The "continue" and "field" args are not both present.')
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   115
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   116
DEF_REVIEW_COMPLETED_MSG = ugettext('This Application can not be reviewed '
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   117
    'anymore (it has been completed or rejected).')
1201
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   118
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   119
DEF_REQUEST_COMPLETED_MSG = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
   120
    'This request cannot be accepted (it is either completed or denied).')
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   121
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   122
DEF_SCOPE_INACTIVE_MSG = ugettext(
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
   123
    'The scope for this request is not active.')
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   124
1466
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
   125
DEF_SIGN_UP_AS_STUDENT_MSG = ugettext(
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
   126
    'You need to sign up as a Student first.')
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
   127
1995
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
   128
DEF_MAX_PROPOSALS_REACHED = ugettext(
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
   129
    'You have reached the maximum number of Proposals allowed '
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
   130
    'for this program.')
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
   131
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   132
DEF_NO_LIST_ACCESS_MSG = ugettext('You do not have the required rights to '
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   133
    'list documents for this scope and prefix.')
1318
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
   134
970
8b5611d5b053 Use ugettext instead of ugettext_lazy
Sverre Rabbelier <srabbelier@gmail.com>
parents: 965
diff changeset
   135
DEF_PAGE_DENIED_MSG = ugettext(
1350
c822368a60b1 Add missing dots in messages in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1334
diff changeset
   136
    'Access to this page has been restricted.')
508
2b90baceac88 Add a access.deny and access.allow method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 481
diff changeset
   137
1305
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
   138
DEF_PREFIX_NOT_IN_ARGS_MSG = ugettext(
1350
c822368a60b1 Add missing dots in messages in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1334
diff changeset
   139
    'A required GET url argument ("prefix") was not specified.')
1305
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
   140
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   141
DEF_PAGE_INACTIVE_MSG = ugettext(
1350
c822368a60b1 Add missing dots in messages in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1334
diff changeset
   142
    'This page is inactive at this time.')
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   143
970
8b5611d5b053 Use ugettext instead of ugettext_lazy
Sverre Rabbelier <srabbelier@gmail.com>
parents: 965
diff changeset
   144
DEF_LOGOUT_MSG_FMT = ugettext(
1350
c822368a60b1 Add missing dots in messages in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1334
diff changeset
   145
    'Please <a href="%(sign_out)s">sign out</a> in order to view this page.')
590
37735d97b541 Created a seperate module for editSelf things
Sverre Rabbelier <srabbelier@gmail.com>
parents: 543
diff changeset
   146
979
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   147
DEF_GROUP_NOT_FOUND_MSG = ugettext(
1350
c822368a60b1 Add missing dots in messages in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1334
diff changeset
   148
    'The requested Group can not be found.')
979
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   149
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   150
DEF_USER_ACCOUNT_INVALID_MSG_FMT = ugettext(
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   151
    'The <b><i>%(email)s</i></b> account cannot be used with this site, for'
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   152
    ' one or more of the following reasons:'
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   153
    '<ul>'
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   154
    ' <li>the account is invalid</li>'
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   155
    ' <li>the account is already attached to a User profile and cannot be'
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   156
    ' used to create another one</li>'
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   157
    ' <li>the account is a former account that cannot be used again</li>'
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   158
    '</ul>')
508
2b90baceac88 Add a access.deny and access.allow method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 481
diff changeset
   159
1201
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   160
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   161
def allowSidebar(fun):
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   162
  """Decorator that allows access if the sidebar is calling.
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   163
  """
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   164
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   165
  from functools import wraps
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   166
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   167
  @wraps(fun)
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   168
  def wrapper(self, django_args, *args, **kwargs):
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   169
    """Decorator wrapper method.
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   170
    """
1201
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   171
    if django_args.get('SIDEBAR_CALLING'):
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   172
      return
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   173
    return fun(self, django_args, *args, **kwargs)
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   174
  return wrapper
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   175
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
   176
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   177
def denySidebar(fun):
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   178
  """Decorator that denies access if the sidebar is calling.
612
3cca81b1e5a1 Moved checkAccess and getCleanedFields into access and forms
Sverre Rabbelier <srabbelier@gmail.com>
parents: 590
diff changeset
   179
  """
3cca81b1e5a1 Moved checkAccess and getCleanedFields into access and forms
Sverre Rabbelier <srabbelier@gmail.com>
parents: 590
diff changeset
   180
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   181
  from functools import wraps
508
2b90baceac88 Add a access.deny and access.allow method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 481
diff changeset
   182
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   183
  @wraps(fun)
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   184
  def wrapper(self, django_args, *args, **kwargs):
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   185
    """Decorator wrapper method.
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   186
    """
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   187
    if django_args.get('SIDEBAR_CALLING'):
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   188
      raise out_of_band.Error("Sidebar Calling")
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   189
    return fun(self, django_args, *args, **kwargs)
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   190
  return wrapper
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   191
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   192
1073
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   193
def allowIfCheckPasses(checker_name):
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   194
  """Returns a decorator that allows access if the specified checker passes.
1016
15a2f644725f Create a decorator for allowDeveloper
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1012
diff changeset
   195
  """
15a2f644725f Create a decorator for allowDeveloper
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1012
diff changeset
   196
15a2f644725f Create a decorator for allowDeveloper
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1012
diff changeset
   197
  from functools import wraps
15a2f644725f Create a decorator for allowDeveloper
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1012
diff changeset
   198
1073
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   199
  def decorator(fun):
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   200
    """Decorator that allows access if the current user is a Developer.
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   201
    """
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   202
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   203
    @wraps(fun)
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   204
    def wrapper(self, django_args=None, *args, **kwargs):
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   205
      """Decorator wrapper method.
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   206
      """
1073
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   207
      try:
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   208
        # if the check passes we allow access regardless
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   209
        return self.doCheck(checker_name, django_args, [])
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   210
      except out_of_band.Error:
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   211
        # otherwise we run the original check
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   212
        return fun(self, django_args, *args, **kwargs)
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   213
    return wrapper
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   214
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   215
  return decorator
feea88d0e1d8 Factor out the allowIfCheckPasses logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1068
diff changeset
   216
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   217
# pylint: disable-msg=C0103
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   218
allowDeveloper = allowIfCheckPasses('checkIsDeveloper') 
1016
15a2f644725f Create a decorator for allowDeveloper
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1012
diff changeset
   219
15a2f644725f Create a decorator for allowDeveloper
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1012
diff changeset
   220
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   221
class Checker(object):
590
37735d97b541 Created a seperate module for editSelf things
Sverre Rabbelier <srabbelier@gmail.com>
parents: 543
diff changeset
   222
  """
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   223
  The __setitem__() and __getitem__() methods are overloaded to DTRT
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   224
  when adding new access rights, and retrieving them, so use these
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   225
  rather then modifying rights directly if so desired.
888
a75ae24f04cb Add checkAgreesToSiteToS() (partially implemented until circular import fixed).
Todd Larsen <tlarsen@google.com>
parents: 887
diff changeset
   226
  """
972
43018f61b481 Remove the request and arg parameter from the checkAccess call
Sverre Rabbelier <srabbelier@gmail.com>
parents: 970
diff changeset
   227
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   228
  MEMBERSHIP = {
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   229
    'anyone': 'allow',
1248
f318538394d9 Rename checkHasActiveRole to checkHasActiveRoleForScope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1239
diff changeset
   230
    'club_admin': ('checkHasActiveRoleForScope', club_admin_logic),
f318538394d9 Rename checkHasActiveRole to checkHasActiveRoleForScope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1239
diff changeset
   231
    'club_member': ('checkHasActiveRoleForScope', club_member_logic),
1444
b97cfeb423f4 Make use of the new checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1443
diff changeset
   232
    'host': ('checkHasDocumentAccess', [host_logic, 'sponsor']),
b97cfeb423f4 Make use of the new checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1443
diff changeset
   233
    'org_admin': ('checkHasDocumentAccess', [org_admin_logic, 'org']),
b97cfeb423f4 Make use of the new checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1443
diff changeset
   234
    'org_mentor': ('checkHasDocumentAccess', [mentor_logic, 'org']),
b97cfeb423f4 Make use of the new checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1443
diff changeset
   235
    'org_student': ('checkHasDocumentAccess', [student_logic, 'org']),
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   236
    'user': 'checkIsUser',
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   237
    'user_self': ('checkIsUserSelf', 'scope_path'),
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   238
    }
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   239
1442
8eec34007e80 Specify how to walk the scope up to another scope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1441
diff changeset
   240
  #: the depths of various scopes to other scopes
8eec34007e80 Specify how to walk the scope up to another scope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1441
diff changeset
   241
  # the 0 entries are not used, and are for clarity purposes only
8eec34007e80 Specify how to walk the scope up to another scope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1441
diff changeset
   242
  SCOPE_DEPTH = {
1528
abbdf42ab322 Allow to do 'checkHasActiveRole' checks for document access
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1525
diff changeset
   243
      'site': None,
1442
8eec34007e80 Specify how to walk the scope up to another scope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1441
diff changeset
   244
      'sponsor': (sponsor_logic, {'sponsor': 0}),
8eec34007e80 Specify how to walk the scope up to another scope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1441
diff changeset
   245
      'program': (program_logic, {'sponsor': 1, 'program': 0}),
8eec34007e80 Specify how to walk the scope up to another scope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1441
diff changeset
   246
      'org': (org_logic, {'sponsor': 2, 'program': 1, 'org': 0}),
8eec34007e80 Specify how to walk the scope up to another scope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1441
diff changeset
   247
      }
8eec34007e80 Specify how to walk the scope up to another scope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1441
diff changeset
   248
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   249
  def __init__(self, params):
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   250
    """Adopts base.rights as rights if base is set.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   251
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   252
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   253
    base = params.get('rights') if params else None
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   254
    self.rights = base.rights if base else {}
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   255
    self.id = None
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   256
    self.user = None
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   257
1226
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   258
  def normalizeChecker(self, checker):
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   259
    """Normalizes the checker to a pre-defined format.
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   260
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   261
    The result is guaranteed to be a list of 2-tuples, the first element is a
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   262
    checker (iff there is an checker with the specified name), the second
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   263
    element is a list of arguments that should be passed to the checker when
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   264
    calling it in addition to the standard django_args.
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   265
    """
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   266
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   267
    # Be nice an repack so that it is always a list with tuples
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   268
    if isinstance(checker, tuple):
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   269
      name, arg = checker
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   270
      return (name, (arg if isinstance(arg, list) else [arg]))
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   271
    else:
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   272
      return (checker, [])
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   273
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   274
  def __setitem__(self, key, value):
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   275
    """Sets a value only if no old value exists.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   276
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   277
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   278
    oldvalue = self.rights.get(key)
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   279
    self.rights[key] = oldvalue if oldvalue else value
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   280
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   281
  def __getitem__(self, key):
1226
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   282
    """Retrieves and normalizes the right checkers.
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   283
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   284
1226
a671f0d63562 Fix broken document access checks
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1223
diff changeset
   285
    return [self.normalizeChecker(i) for i in self.rights.get(key, [])]
888
a75ae24f04cb Add checkAgreesToSiteToS() (partially implemented until circular import fixed).
Todd Larsen <tlarsen@google.com>
parents: 887
diff changeset
   286
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   287
  def key(self, checker_name):
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   288
    """Returns the key for the specified checker for the current user.
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   289
    """
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   290
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   291
    return "%s.%s" % (self.id, checker_name)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   292
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   293
  def put(self, checker_name, value):
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   294
    """Puts the result for the specified checker in the cache.
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   295
    """
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   296
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   297
    retention = 30
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   298
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   299
    memcache_key = self.key(checker_name)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   300
    memcache.add(memcache_key, value, retention)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   301
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   302
  def get(self, checker_name):
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   303
    """Retrieves the result for the specified checker from cache.
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   304
    """
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   305
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   306
    memcache_key = self.key(checker_name)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   307
    return memcache.get(memcache_key)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   308
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   309
  def doCheck(self, checker_name, django_args, args):
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   310
    """Runs the specified checker with the specified arguments.
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   311
    """
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   312
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   313
    checker = getattr(self, checker_name)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   314
    checker(django_args, *args)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   315
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   316
  def doCachedCheck(self, checker_name, django_args, args):
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   317
    """Retrieves from cache or runs the specified checker.
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   318
    """
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   319
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   320
    cached = self.get(checker_name)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   321
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   322
    if cached is None:
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   323
      try:
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   324
        self.doCheck(checker_name, django_args, args)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   325
        self.put(checker_name, True)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   326
        return
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   327
      except out_of_band.Error, exception:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   328
        self.put(checker_name, exception)
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   329
        raise
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   330
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   331
    if cached is True:
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   332
      return
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   333
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   334
    # re-raise the cached exception
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   335
    raise cached
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   336
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   337
  def check(self, use_cache, checker_name, django_args, args):
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   338
    """Runs the checker, optionally using the cache.
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   339
    """
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   340
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   341
    if use_cache:
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   342
      self.doCachedCheck(checker_name, django_args, args)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   343
    else:
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   344
      self.doCheck(checker_name, django_args, args)
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   345
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   346
  def setCurrentUser(self, id, user):
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   347
    """Sets up everything for the current user.
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   348
    """
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   349
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   350
    self.id = id
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   351
    self.user = user
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   352
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   353
  def checkAccess(self, access_type, django_args):
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   354
    """Runs all the defined checks for the specified type.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   355
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   356
    Args:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   357
      access_type: the type of request (such as 'list' or 'edit')
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   358
      rights: a dictionary containing access check functions
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   359
      django_args: a dictionary with django's arguments
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   360
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   361
    Rights usage:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   362
      The rights dictionary is used to check if the current user is allowed
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   363
      to view the page specified. The functions defined in this dictionary
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   364
      are always called with the provided django_args dictionary as argument. On any
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   365
      request, regardless of what type, the functions in the 'any_access' value
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   366
      are called. If the specified type is not in the rights dictionary, all
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   367
      the functions in the 'unspecified' value are called. When the specified
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   368
      type _is_ in the rights dictionary, all the functions in that access_type's
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   369
      value are called.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   370
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   371
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   372
    use_cache = django_args.get('SIDEBAR_CALLING')
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   373
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   374
    # Call each access checker
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   375
    for checker_name, args in self['any_access']:
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   376
      self.check(use_cache, checker_name, django_args, args)
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   377
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   378
    if access_type not in self.rights:
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   379
      # No checks defined, so do the 'generic' checks and bail out
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   380
      for checker_name, args in self['unspecified']:
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   381
        self.check(use_cache, checker_name, django_args, args)
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   382
      return
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   383
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   384
    for checker_name, args in self[access_type]:
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   385
      self.check(use_cache, checker_name, django_args, args)
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   386
1300
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   387
  def hasMembership(self, roles, django_args):
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   388
    """Checks whether the user has access to any of the specified roles.
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   389
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   390
    Makes use of self.MEMBERSHIP, which defines checkers specific to
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   391
    document access, as such this method should only be used when checking
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   392
    document access.
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   393
1300
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   394
    Args:
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   395
      roles: a list of roles to check
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   396
      django_args: the django args that should be passed to doCheck
1300
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   397
    """
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   398
1315
7c58f5cdd5b8 Developers have all roles
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1309
diff changeset
   399
    try:
7c58f5cdd5b8 Developers have all roles
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1309
diff changeset
   400
      # we need to check manually, as we must return True!
7c58f5cdd5b8 Developers have all roles
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1309
diff changeset
   401
      self.checkIsDeveloper(django_args)
7c58f5cdd5b8 Developers have all roles
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1309
diff changeset
   402
      return True
7c58f5cdd5b8 Developers have all roles
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1309
diff changeset
   403
    except out_of_band.Error:
7c58f5cdd5b8 Developers have all roles
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1309
diff changeset
   404
      pass
7c58f5cdd5b8 Developers have all roles
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1309
diff changeset
   405
1300
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   406
    for role in roles:
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   407
      try:
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   408
        checker_name, args = self.normalizeChecker(self.MEMBERSHIP[role])
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   409
        self.doCheck(checker_name, django_args, args)
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   410
        # the check passed, we can stop now
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   411
        return True
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   412
      except out_of_band.Error:
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   413
        continue
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   414
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   415
    return False
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   416
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   417
  @allowDeveloper
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   418
  def checkMembership(self, action, prefix, status, django_args):
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   419
    """Checks whether the user has access to the specified status.
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   420
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   421
    Args:
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   422
      action: the action that was performed (e.g., 'read')
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   423
      prefix: the prefix, determines what access set is used
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   424
      status: the access status (e.g., 'public')
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   425
      django_args: the django args to pass on to the checkers
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   426
    """
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   427
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   428
    checker = rights_logic.Checker(prefix)
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   429
    roles = checker.getMembership(status)
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   430
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   431
    message_fmt = DEF_NEED_MEMBERSHIP_MSG_FMT % {
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   432
        'action': action,
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   433
        'prefix': prefix,
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   434
        'status': status,
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   435
        }
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   436
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   437
    # try to see if they belong to any of the roles, if not, raise an
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   438
    # access violation for the specified action, prefix and status.
1300
a89d673771eb Factor out the hasMembership method from checkMembership
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1265
diff changeset
   439
    if not self.hasMembership(roles, django_args):
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   440
      raise out_of_band.AccessViolation(message_fmt)
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   441
1486
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   442
  def checkHasAny(self, django_args, checks):
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   443
    """Checks if any of the checks passes.
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   444
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   445
    If none of the specified checks passes, the exception that the first of the
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   446
    checks raised is reraised.
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   447
    """
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   448
2101
d6250eac3ab0 Fixed bug introduced by fixing a pylint error
Sverre Rabbelier <srabbelier@gmail.com>
parents: 2077
diff changeset
   449
    first = None
1486
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   450
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   451
    for checker_name, args in checks:
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   452
      try:
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   453
        self.doCheck(checker_name, django_args, args)
1488
4b7cec48e26c Brown paper bag fix
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1486
diff changeset
   454
        # one check passed, all is well
4b7cec48e26c Brown paper bag fix
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1486
diff changeset
   455
        return
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   456
      except out_of_band.Error, exception:
1486
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   457
        # store the first esception
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   458
        first = first if first else exception
1486
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   459
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   460
    # none passed, re-raise the first exception
2116
68d7679a2af2 Add pylint: disable-msg=W0706 to soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2112
diff changeset
   461
    # pylint: disable-msg=W0706
1486
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   462
    raise first
c417a4188e73 Added a checkHasAny method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1481
diff changeset
   463
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   464
  def allow(self, django_args):
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   465
    """Never raises an alternate HTTP response.  (an access no-op, basically).
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   466
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   467
    Args:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   468
      django_args: a dictionary with django's arguments
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   469
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   470
888
a75ae24f04cb Add checkAgreesToSiteToS() (partially implemented until circular import fixed).
Todd Larsen <tlarsen@google.com>
parents: 887
diff changeset
   471
    return
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   472
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   473
  def deny(self, django_args=None):
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   474
    """Always raises an alternate HTTP response.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   475
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   476
    Args:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   477
      django_args: a dictionary with django's arguments
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   478
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   479
    Raises:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   480
      always raises AccessViolationResponse if called
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   481
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   482
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   483
    context = django_args.get('context', {})
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   484
    context['title'] = 'Access denied'
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   485
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   486
    raise out_of_band.AccessViolation(DEF_PAGE_DENIED_MSG, context=context)
888
a75ae24f04cb Add checkAgreesToSiteToS() (partially implemented until circular import fixed).
Todd Larsen <tlarsen@google.com>
parents: 887
diff changeset
   487
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   488
  def checkIsLoggedIn(self, django_args=None):
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   489
    """Raises an alternate HTTP response if Google Account is not logged in.
888
a75ae24f04cb Add checkAgreesToSiteToS() (partially implemented until circular import fixed).
Todd Larsen <tlarsen@google.com>
parents: 887
diff changeset
   490
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   491
    Args:
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   492
      django_args: a dictionary with django's arguments, not used
888
a75ae24f04cb Add checkAgreesToSiteToS() (partially implemented until circular import fixed).
Todd Larsen <tlarsen@google.com>
parents: 887
diff changeset
   493
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   494
    Raises:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   495
      AccessViolationResponse:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   496
      * if no Google Account is even logged in
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   497
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   498
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   499
    if self.id:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   500
      return
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   501
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   502
    raise out_of_band.LoginRequest()
888
a75ae24f04cb Add checkAgreesToSiteToS() (partially implemented until circular import fixed).
Todd Larsen <tlarsen@google.com>
parents: 887
diff changeset
   503
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   504
  def checkNotLoggedIn(self, django_args=None):
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   505
    """Raises an alternate HTTP response if Google Account is logged in.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   506
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   507
    Args:
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   508
      django_args: a dictionary with django's arguments, not used
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   509
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   510
    Raises:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   511
      AccessViolationResponse:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   512
      * if a Google Account is currently logged in
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   513
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   514
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   515
    if not self.id:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   516
      return
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   517
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   518
    raise out_of_band.LoginRequest(message_fmt=DEF_LOGOUT_MSG_FMT)
888
a75ae24f04cb Add checkAgreesToSiteToS() (partially implemented until circular import fixed).
Todd Larsen <tlarsen@google.com>
parents: 887
diff changeset
   519
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   520
  def checkIsUser(self, django_args=None):
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   521
    """Raises an alternate HTTP response if Google Account has no User entity.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   522
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   523
    Args:
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   524
      django_args: a dictionary with django's arguments, not used
895
e70ffd079438 Even developers need to agree to the terms of service for Melange
Sverre Rabbelier <srabbelier@gmail.com>
parents: 892
diff changeset
   525
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   526
    Raises:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   527
      AccessViolationResponse:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   528
      * if no User exists for the logged-in Google Account, or
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   529
      * if no Google Account is logged in at all
1012
73f0b61f2d9d Fold checkAgreesToSiteToS into checkIsUser
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1007
diff changeset
   530
      * if User has not agreed to the site-wide ToS, if one exists
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   531
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   532
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   533
    self.checkIsLoggedIn()
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   534
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   535
    if not self.user:
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   536
      raise out_of_band.LoginRequest(message_fmt=DEF_NO_USER_LOGIN_MSG)
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   537
1017
6ad4fdb48840 Cache access checks and disable sidebar caching
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1016
diff changeset
   538
    if user_logic.agreesToSiteToS(self.user):
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   539
      return
293
1edd01373e71 Add an access control module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   540
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   541
    # Would not reach this point of site-wide ToS did not exist, since
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   542
    # agreesToSiteToS() call above always returns True if no ToS is in effect.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   543
    login_msg_fmt = DEF_AGREE_TO_TOS_MSG_FMT % {
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   544
        'tos_link': redirects.getToSRedirect(site_logic.getSingleton())}
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   545
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   546
    raise out_of_band.LoginRequest(message_fmt=login_msg_fmt)
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   547
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   548
  @allowDeveloper
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   549
  def checkIsHost(self, django_args=None):
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   550
    """Checks whether the current user has a role entity.
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   551
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   552
    Args:
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   553
      django_args: the keyword args from django, not used
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   554
    """
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   555
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   556
    if not django_args:
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   557
      django_args = {}
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   558
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   559
    return self.checkHasActiveRole(django_args, host_logic)
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   560
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   561
  @allowDeveloper
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   562
  def checkIsUserSelf(self, django_args, field_name):
1142
da2487767ef4 Fix missing dot and wrong import sorting in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1135
diff changeset
   563
    """Checks whether the specified user is the logged in user.
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   564
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   565
    Args:
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   566
      django_args: the keyword args from django, only field_name is used
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   567
    """
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   568
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   569
    self.checkIsUser()
1198
3318f8d00691 Added some extra isUser checks to make sure that you have to accept the ToS before you can do anything concerning requests.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1192
diff changeset
   570
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   571
    if not field_name in django_args:
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   572
      self.deny()
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   573
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   574
    if self.user.link_id == django_args[field_name]:
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   575
      return
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   576
1177
53c802c2a2e2 More access related fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1176
diff changeset
   577
    raise out_of_band.AccessViolation(DEF_NOT_YOUR_ENTITY_MSG)
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   578
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   579
  def checkIsUnusedAccount(self, django_args=None):
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   580
    """Raises an alternate HTTP response if Google Account has a User entity.
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   581
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   582
    Args:
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   583
      django_args: a dictionary with django's arguments, not used
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   584
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   585
    Raises:
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   586
      AccessViolationResponse:
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   587
      * if a User exists for the logged-in Google Account, or
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   588
      * if a User has this Gooogle Account in their formerAccounts list
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   589
    """
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   590
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   591
    self.checkIsLoggedIn()
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   592
1716
a387bb7a39d4 Fixes banned people being able to create a new user entity.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1633
diff changeset
   593
    fields = {'account': self.id}
a387bb7a39d4 Fixes banned people being able to create a new user entity.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1633
diff changeset
   594
    user_entity = user_logic.getForFields(fields, unique=True)
a387bb7a39d4 Fixes banned people being able to create a new user entity.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1633
diff changeset
   595
a387bb7a39d4 Fixes banned people being able to create a new user entity.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1633
diff changeset
   596
    if not user_entity and not user_logic.isFormerAccount(self.id):
1048
0fe0cb8f7253 Changed access.py to comply more with the style of the module.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1043
diff changeset
   597
      # this account has not been used yet
0fe0cb8f7253 Changed access.py to comply more with the style of the module.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1043
diff changeset
   598
      return
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   599
1048
0fe0cb8f7253 Changed access.py to comply more with the style of the module.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1043
diff changeset
   600
    message_fmt = DEF_USER_ACCOUNT_INVALID_MSG_FMT % {
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   601
        'email' : self.id.email()
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   602
        }
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   603
1048
0fe0cb8f7253 Changed access.py to comply more with the style of the module.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1043
diff changeset
   604
    raise out_of_band.LoginRequest(message_fmt=message_fmt)
0fe0cb8f7253 Changed access.py to comply more with the style of the module.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1043
diff changeset
   605
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   606
  def checkHasUserEntity(self, django_args=None):
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   607
    """Raises an alternate HTTP response if Google Account has no User entity.
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   608
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   609
    Args:
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   610
      django_args: a dictionary with django's arguments
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   611
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   612
    Raises:
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   613
      AccessViolationResponse:
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   614
      * if no User exists for the logged-in Google Account, or
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   615
      * if no Google Account is logged in at all
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   616
    """
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   617
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   618
    self.checkIsLoggedIn()
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   619
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   620
    if self.user:
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   621
      return
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   622
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   623
    raise out_of_band.LoginRequest(message_fmt=DEF_NO_USER_LOGIN_MSG)
1043
5e15994b2033 Redone the user's profile page.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1037
diff changeset
   624
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   625
  def checkIsDeveloper(self, django_args=None):
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   626
    """Raises an alternate HTTP response if Google Account is not a Developer.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   627
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   628
    Args:
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   629
      django_args: a dictionary with django's arguments, not used
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   630
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   631
    Raises:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   632
      AccessViolationResponse:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   633
      * if User is not a Developer, or
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   634
      * if no User exists for the logged-in Google Account, or
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   635
      * if no Google Account is logged in at all
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   636
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   637
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   638
    self.checkIsUser()
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   639
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   640
    if user_logic.isDeveloper(account=self.id, user=self.user):
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   641
      return
979
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   642
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   643
    login_message_fmt = DEF_DEV_LOGOUT_LOGIN_MSG_FMT % {
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   644
        'role': 'a Site Developer ',
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   645
        }
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   646
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   647
    raise out_of_band.LoginRequest(message_fmt=login_message_fmt)
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   648
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   649
  @allowDeveloper
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   650
  @denySidebar
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   651
  def _checkIsActive(self, django_args, logic, fields):
1435
e9a2b1e87b1a Added support for having a format string as scope_path filter
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1388
diff changeset
   652
    """Raises an alternate HTTP response if the entity is not active.
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   653
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   654
    Args:
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   655
      django_args: a dictionary with django's arguments
1435
e9a2b1e87b1a Added support for having a format string as scope_path filter
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1388
diff changeset
   656
      logic: the logic that should be used to look up the entity
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   657
      fields: the name of the fields that should be copied verbatim
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   658
              from the django_args as filter
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   659
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   660
    Raises:
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   661
      AccessViolationResponse:
1438
e484f9acf999 Updated comments in access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1435
diff changeset
   662
      * if no entity is found
e484f9acf999 Updated comments in access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1435
diff changeset
   663
      * if the entity status is not active
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   664
    """
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   665
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   666
    self.checkIsUser()
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   667
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   668
    fields = dicts.filter(django_args, fields)
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   669
    fields['status'] = 'active'
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   670
1179
427d2ec42823 Rewrite getForFields to use GQL instead of the Query API
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1177
diff changeset
   671
    entity = logic.getForFields(fields, unique=True)
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   672
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   673
    if entity:
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   674
      return
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   675
1435
e9a2b1e87b1a Added support for having a format string as scope_path filter
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1388
diff changeset
   676
    raise out_of_band.AccessViolation(message_fmt=DEF_NO_ACTIVE_ENTITY_MSG)
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   677
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   678
  def checkGroupIsActiveForScopeAndLinkId(self, django_args, logic):
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   679
    """Checks that the specified group is active.
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   680
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   681
    Only group where both the link_id and the scope_path match the value
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   682
    of the link_id and the scope_path from the django_args are considered.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   683
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   684
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   685
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   686
      logic: the logic that should be used to look up the entity
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   687
    """
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   688
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   689
    fields = ['scope_path', 'link_id']
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   690
    self._checkIsActive(django_args, logic, fields)
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   691
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   692
  def checkGroupIsActiveForLinkId(self, django_args, logic):
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   693
    """Checks that the specified group is active.
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   694
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   695
    Only group where the link_id matches the value of the link_id
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   696
    from the django_args are considered.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   697
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   698
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   699
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   700
      logic: the logic that should be used to look up the entity
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   701
    """
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   702
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   703
    self._checkIsActive(django_args, logic, ['link_id'])
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   704
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   705
  def checkHasActiveRole(self, django_args, logic):
1203
38225f2ad3a6 Renamed checkHasRole to checkHasActiveRole.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1201
diff changeset
   706
    """Checks that the user has the specified active role.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   707
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   708
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   709
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   710
      logic: the logic that should be used to look up the entity
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   711
    """
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   712
1555
cba45797f4b9 Do not modify django_args directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1554
diff changeset
   713
    django_args = django_args.copy()
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   714
    django_args['user'] = self.user
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   715
    self._checkIsActive(django_args, logic, ['user'])
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   716
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   717
  def _checkHasActiveRoleFor(self, django_args, logic, field_name):
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   718
    """Checks that the user has the specified active role.
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   719
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   720
    Only roles where the field as specified by field_name matches the
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   721
    scope_path from the django_args are considered.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   722
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   723
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   724
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   725
      logic: the logic that should be used to look up the entity
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   726
    """
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   727
1554
163c879d1ffe Fixed a brown paper bag bug in _checkHasActiveRoleFor
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1538
diff changeset
   728
    fields = [field_name, 'user']
1555
cba45797f4b9 Do not modify django_args directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1554
diff changeset
   729
    django_args = django_args.copy()
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   730
    django_args['user'] = self.user
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   731
    self._checkIsActive(django_args, logic, fields)
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   732
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   733
  def checkHasActiveRoleForKeyFieldsAsScope(self, django_args, logic):
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   734
    """Checks that the user has the specified active role.
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   735
    
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   736
    Args:
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   737
      django_args: a dictionary with django's arguments
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
   738
      logic: the logic that should be used to look up the entity
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   739
    """
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   740
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   741
    key_fields = "%(scope_path)s/%(link_id)s" % django_args
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   742
    new_args = {'scope_path': key_fields}
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   743
    self._checkHasActiveRoleFor(new_args, logic, 'scope_path')
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   744
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   745
  def checkHasActiveRoleForScope(self, django_args, logic):
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   746
    """Checks that the user has the specified active role.
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   747
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   748
    Only roles where the scope_path matches the scope_path from the
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   749
    django_args are considered.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   750
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   751
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   752
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   753
      logic: the logic that should be used to look up the entity
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   754
    """
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   755
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   756
    self._checkHasActiveRoleFor(django_args, logic, 'scope_path')
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   757
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   758
  def checkHasActiveRoleForLinkId(self, django_args, logic):
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   759
    """Checks that the user has the specified active role.
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   760
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   761
    Only roles where the link_id matches the link_id from the
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   762
    django_args are considered.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   763
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   764
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   765
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   766
      logic: the logic that should be used to look up the entity
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   767
    """
1557
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   768
1525
fe906cdbf0e9 Remove direct uses of checkIsActive, replace with helper methods
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1524
diff changeset
   769
    self._checkHasActiveRoleFor(django_args, logic, 'link_id')
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   770
1557
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   771
  def checkHasActiveRoleForLinkIdAsScope(self, django_args, logic):
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   772
    """Checks that the user has the specified active role.
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   773
1558
5ff25327371e Fixed a comment typo
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1557
diff changeset
   774
    Only roles where the scope_path matches the link_id from the
1557
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   775
    django_args are considered.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   776
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   777
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   778
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   779
      logic: the logic that should be used to look up the entity
1557
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   780
    """
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   781
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   782
    django_args = django_args.copy()
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   783
    django_args['scope_path'] = django_args['link_id']
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   784
    self._checkHasActiveRoleFor(django_args, logic, 'scope_path')
9e32e6258319 Properly fixed host access now
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1555
diff changeset
   785
1443
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   786
  def checkHasDocumentAccess(self, django_args, logic, target_scope):
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   787
    """Checks that the user has access to the specified document scope.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   788
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   789
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   790
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   791
      logic: the logic that should be used to look up the entity
1443
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   792
    """
1577
b0bb5c8b5f78 Fix bug in checkDocumentPick of soc.views.helper.access module, which cause KeyError exceptions in document picker.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1559
diff changeset
   793
    
1443
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   794
    prefix = django_args['prefix']
1528
abbdf42ab322 Allow to do 'checkHasActiveRole' checks for document access
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1525
diff changeset
   795
    if self.SCOPE_DEPTH.get(prefix):
abbdf42ab322 Allow to do 'checkHasActiveRole' checks for document access
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1525
diff changeset
   796
      scope_logic, depths = self.SCOPE_DEPTH[prefix]
abbdf42ab322 Allow to do 'checkHasActiveRole' checks for document access
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1525
diff changeset
   797
    else:
abbdf42ab322 Allow to do 'checkHasActiveRole' checks for document access
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1525
diff changeset
   798
      return self.checkHasActiveRole(django_args, logic)
abbdf42ab322 Allow to do 'checkHasActiveRole' checks for document access
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1525
diff changeset
   799
1443
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   800
    depth = depths.get(target_scope, 0)
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   801
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   802
    # nothing to do
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   803
    if not (scope_logic and depth):
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   804
      return self.checkHasActiveRoleForScope(django_args, logic)
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   805
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   806
    # we don't want to modify the original django args
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   807
    django_args = django_args.copy()
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   808
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   809
    entity = scope_logic.getFromKeyName(django_args['scope_path'])
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   810
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   811
    # cannot have access to the specified scope if it is invalid
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   812
    if not entity:
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   813
      raise out_of_band.AccessViolation(message_fmt=DEF_NO_ACTIVE_ENTITY_MSG)
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   814
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   815
    # walk up the scope to where we need to be
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   816
    for _ in range(depth):
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   817
      entity = entity.scope
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   818
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   819
    django_args['scope_path'] = entity.key().name()
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   820
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   821
    self.checkHasActiveRoleForScope(django_args, logic)
8ce8314d1c8f Added a checkHasDocumentAccess method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1442
diff changeset
   822
1189
14357ec13647 More access related fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1184
diff changeset
   823
  def checkSeeded(self, django_args, checker_name, *args):
14357ec13647 More access related fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1184
diff changeset
   824
    """Wrapper to update the django_args with the contens of seed first.
14357ec13647 More access related fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1184
diff changeset
   825
    """
14357ec13647 More access related fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1184
diff changeset
   826
14357ec13647 More access related fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1184
diff changeset
   827
    django_args.update(django_args.get('seed', {}))
14357ec13647 More access related fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1184
diff changeset
   828
    self.doCheck(checker_name, django_args, args)
14357ec13647 More access related fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1184
diff changeset
   829
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   830
  def checkCanMakeRequestToGroup(self, django_args, group_logic):
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   831
    """Raises an alternate HTTP response if the specified group is not in an
1085
0afbdd0905ef Renamed state to status where appropriate.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1080
diff changeset
   832
    active status.
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   833
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   834
    Args:
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   835
      django_args: a dictionary with django's arguments
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   836
      group_logic: Logic module for the type of group which the request is for
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   837
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   838
1198
3318f8d00691 Added some extra isUser checks to make sure that you have to accept the ToS before you can do anything concerning requests.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1192
diff changeset
   839
    self.checkIsUser(django_args)
3318f8d00691 Added some extra isUser checks to make sure that you have to accept the ToS before you can do anything concerning requests.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1192
diff changeset
   840
979
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   841
    group_entity = role_logic.getGroupEntityFromScopePath(
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   842
        group_logic.logic, django_args['scope_path'])
979
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   843
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   844
    if not group_entity:
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   845
      raise out_of_band.Error(DEF_GROUP_NOT_FOUND_MSG, status=404)
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   846
1085
0afbdd0905ef Renamed state to status where appropriate.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1080
diff changeset
   847
    if group_entity.status != 'active':
1198
3318f8d00691 Added some extra isUser checks to make sure that you have to accept the ToS before you can do anything concerning requests.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1192
diff changeset
   848
      # tell the user that this group is not active
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   849
      raise out_of_band.AccessViolation(message_fmt=DEF_NO_ACTIVE_GROUP_MSG)
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   850
979
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   851
    return
789e70941055 Added checkCanMakeRequestToGroup to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 974
diff changeset
   852
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   853
  def checkCanCreateFromRequest(self, django_args, role_name):
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   854
    """Raises an alternate HTTP response if the specified request does not exist
1085
0afbdd0905ef Renamed state to status where appropriate.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1080
diff changeset
   855
       or if it's status is not group_accepted. Also when the group this request
0afbdd0905ef Renamed state to status where appropriate.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1080
diff changeset
   856
       is from is in an inactive or invalid status access will be denied.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   857
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   858
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   859
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   860
      role_name: name of the role
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   861
    """
972
43018f61b481 Remove the request and arg parameter from the checkAccess call
Sverre Rabbelier <srabbelier@gmail.com>
parents: 970
diff changeset
   862
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   863
    self.checkIsUserSelf(django_args, 'link_id')
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
   864
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   865
    fields = {
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   866
        'link_id': django_args['link_id'],
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   867
        'scope_path': django_args['scope_path'],
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   868
        'role': role_name,
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   869
        'status': 'group_accepted',
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   870
        }
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
   871
1176
c211191e7d81 Fixed access related bugs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1163
diff changeset
   872
    entity = request_logic.getForFields(fields, unique=True)
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
   873
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   874
    if entity and (entity.scope.status not in ['invalid', 'inactive']):
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   875
      return
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
   876
1177
53c802c2a2e2 More access related fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1176
diff changeset
   877
    raise out_of_band.AccessViolation(message_fmt=DEF_NO_REQUEST_MSG)
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
   878
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   879
  def checkIsMyGroupAcceptedRequest(self, django_args):
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   880
    """Checks whether the user can accept the specified request.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   881
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   882
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   883
      django_args: a dictionary with django's arguments
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   884
    """
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   885
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   886
    self.checkCanCreateFromRequest(django_args, django_args['role'])
972
43018f61b481 Remove the request and arg parameter from the checkAccess call
Sverre Rabbelier <srabbelier@gmail.com>
parents: 970
diff changeset
   887
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   888
  def checkCanProcessRequest(self, django_args, role_name):
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   889
    """Raises an alternate HTTP response if the specified request does not exist
1085
0afbdd0905ef Renamed state to status where appropriate.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1080
diff changeset
   890
       or if it's status is completed or denied. Also Raises an alternate HTTP response
1061
09c243461de8 Redone access checks concerning groups to deal with the state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1048
diff changeset
   891
       whenever the group in the request is not active.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   892
       
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   893
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   894
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   895
      role_name: name of the role
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   896
    """
948
bd956f419ad9 Add missing blank lines and remove unused checkIsInvited function from soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 943
diff changeset
   897
1198
3318f8d00691 Added some extra isUser checks to make sure that you have to accept the ToS before you can do anything concerning requests.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1192
diff changeset
   898
    self.checkIsUser(django_args)
3318f8d00691 Added some extra isUser checks to make sure that you have to accept the ToS before you can do anything concerning requests.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1192
diff changeset
   899
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   900
    fields = {
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   901
        'link_id': django_args['link_id'],
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   902
        'scope_path': django_args['scope_path'],
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   903
        'role': role_name,
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   904
        }
960
129efa976d6d Added checkCanProcessRequest in access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 958
diff changeset
   905
1115
0a723ff3d27c Cleanups in base.Logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1107
diff changeset
   906
    request_entity = request_logic.getFromKeyFieldsOr404(fields)
960
129efa976d6d Added checkCanProcessRequest in access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 958
diff changeset
   907
1085
0afbdd0905ef Renamed state to status where appropriate.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1080
diff changeset
   908
    if request_entity.status in ['completed', 'denied']:
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   909
      raise out_of_band.AccessViolation(message_fmt=DEF_REQUEST_COMPLETED_MSG)
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
   910
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   911
    if request_entity.scope.status == 'active':
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   912
      return
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
   913
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
   914
    raise out_of_band.AccessViolation(message_fmt=DEF_SCOPE_INACTIVE_MSG)
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   915
1218
569a3fe9cb88 Cleaned up getKeyNameFromFields in Logic base.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1203
diff changeset
   916
  @allowDeveloper
1074
94bc2a9ae103 Properly check if a program is active
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1073
diff changeset
   917
  @denySidebar
94bc2a9ae103 Properly check if a program is active
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1073
diff changeset
   918
  def checkIsHostForProgram(self, django_args):
94bc2a9ae103 Properly check if a program is active
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1073
diff changeset
   919
    """Checks if the user is a host for the specified program.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   920
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   921
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   922
      django_args: a dictionary with django's arguments
1074
94bc2a9ae103 Properly check if a program is active
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1073
diff changeset
   923
    """
94bc2a9ae103 Properly check if a program is active
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1073
diff changeset
   924
1218
569a3fe9cb88 Cleaned up getKeyNameFromFields in Logic base.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1203
diff changeset
   925
    program = program_logic.getFromKeyFields(django_args)
1074
94bc2a9ae103 Properly check if a program is active
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1073
diff changeset
   926
1107
a878188e225c Added status to program.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1085
diff changeset
   927
    if not program or program.status == 'invalid':
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
   928
      raise out_of_band.AccessViolation(message_fmt=DEF_NO_ACTIVE_PROGRAM_MSG)
1074
94bc2a9ae103 Properly check if a program is active
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1073
diff changeset
   929
1107
a878188e225c Added status to program.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1085
diff changeset
   930
    new_args = {'scope_path': program.scope_path }
1248
f318538394d9 Rename checkHasActiveRole to checkHasActiveRoleForScope
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1239
diff changeset
   931
    self.checkHasActiveRoleForScope(new_args, host_logic)
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
   932
1200
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
   933
  @allowDeveloper
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   934
  @denySidebar
1250
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   935
  def checkIsHostForProgramInScope(self, django_args):
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   936
    """Checks if the user is a host for the specified program.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   937
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   938
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   939
      django_args: a dictionary with django's arguments
1250
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   940
    """
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   941
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   942
    program = program_logic.getFromKeyName(django_args['scope_path'])
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   943
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   944
    if not program or program.status == 'invalid':
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   945
      raise out_of_band.AccessViolation(message_fmt=DEF_NO_ACTIVE_PROGRAM_MSG)
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   946
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   947
    django_args = {'scope_path': program.scope_path}
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   948
    self.checkHasActiveRoleForScope(django_args, host_logic)
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   949
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   950
  @allowDeveloper
b06e6e014658 Fixed access checkers for orgs
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1248
diff changeset
   951
  @denySidebar
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   952
  def checkIsActivePeriod(self, django_args, period_name, key_name_arg):
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   953
    """Checks if the given period is active for the given program.
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
   954
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   955
    Args:
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   956
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
   957
      period_name: the name of the period which is checked
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   958
      key_name_arg: the entry in django_args that specifies the given program
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   959
        keyname. If none is given the key_name is constructed from django_args
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   960
        itself.
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   961
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   962
    Raises:
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   963
      AccessViolationResponse:
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   964
      * if no active Program is found
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   965
      * if the period is not active
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   966
    """
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   967
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   968
    if key_name_arg and key_name_arg in django_args:
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   969
      key_name = django_args[key_name_arg]
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   970
    else:
1334
5009b63c247a Fixed a bug in access.py where a non-existing variable would have been called.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1318
diff changeset
   971
      key_name = program_logic.getKeyNameFromFields(django_args)
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   972
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   973
    program_entity = program_logic.getFromKeyName(key_name)
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   974
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   975
    if not program_entity or (
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   976
        program_entity.status in ['inactive', 'invalid']):
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   977
      raise out_of_band.AccessViolation(message_fmt=DEF_SCOPE_INACTIVE_MSG)
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   978
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   979
    if timeline_helper.isActivePeriod(program_entity.timeline, period_name):
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   980
      return
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   981
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   982
    raise out_of_band.AccessViolation(message_fmt=DEF_PAGE_INACTIVE_MSG)
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
   983
1922
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   984
  @allowDeveloper
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   985
  @denySidebar
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   986
  def checkisAfterEvent(self, django_args, event_name, key_name_arg):
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   987
    """Checks if the given event has taken place for the given program.
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   988
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   989
    Args:
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   990
      django_args: a dictionary with django's arguments
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   991
      event_name: the name of the event which is checked
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   992
      key_name_arg: the entry in django_args that specifies the given program
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   993
        keyname. If none is given the key_name is constructed from django_args
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   994
        itself.
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   995
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   996
    Raises:
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   997
      AccessViolationResponse:
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   998
      * if no active Program is found
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
   999
      * if the event has not taken place yet
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1000
    """
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1001
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1002
    if key_name_arg and key_name_arg in django_args:
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1003
      key_name = django_args[key_name_arg]
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1004
    else:
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1005
      key_name = program_logic.getKeyNameFromFields(django_args)
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1006
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1007
    program_entity = program_logic.getFromKeyName(key_name)
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1008
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1009
    if not program_entity or (
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1010
        program_entity.status in ['inactive', 'invalid']):
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1011
      raise out_of_band.AccessViolation(message_fmt=DEF_SCOPE_INACTIVE_MSG)
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1012
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1013
    if timeline_helper.isAfterEvent(program_entity.timeline, event_name):
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1014
      return
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1015
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1016
    raise out_of_band.AccessViolation(message_fmt=DEF_PAGE_INACTIVE_MSG)
800ec7253cf4 Added new access method that can check if a given event has taken place already.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1876
diff changeset
  1017
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
  1018
  def checkCanCreateOrgApp(self, django_args, period_name):
1237
b5bf2aa0f3f9 Added missing comment in access.py and removed excessive whitespace.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1232
diff changeset
  1019
    """Checks to see if the program in the scope_path is accepting org apps
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1020
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1021
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1022
      django_args: a dictionary with django's arguments
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1023
      period_name: the name of the period which is checked
1237
b5bf2aa0f3f9 Added missing comment in access.py and removed excessive whitespace.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1232
diff changeset
  1024
    """
b5bf2aa0f3f9 Added missing comment in access.py and removed excessive whitespace.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1232
diff changeset
  1025
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
  1026
    if 'seed' in django_args:
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
  1027
      return self.checkIsActivePeriod(django_args['seed'],
1223
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
  1028
          period_name, 'scope_path')
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
  1029
    else:
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
  1030
      return
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
  1031
aca77e2cc8f7 Added new access checks to deal with timeline for programs.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1218
diff changeset
  1032
  @allowDeveloper
1200
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1033
  def checkCanEditGroupApp(self, django_args, group_app_logic):
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1034
    """Checks if the group_app in args is valid to be edited by 
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1035
       the current user.
1200
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1036
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1037
    Args:
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1038
      django_args: a dictionary with django's arguments
1200
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1039
      group_app_logic: A logic instance for the Group Application
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1040
    """
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1041
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1042
    self.checkIsUser(django_args)
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1043
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1044
    fields = {
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1045
        'link_id': django_args['link_id'],
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1046
        'applicant': self.user,
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1047
        'status' : ['needs review', 'rejected']
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1048
        }
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1049
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1050
    if 'scope_path' in django_args:
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1051
      fields['scope_path'] = django_args['scope_path']
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1052
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1053
    entity = group_app_logic.getForFields(fields)
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1054
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1055
    if entity:
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1056
      return
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1057
1876
a77d4cdcc052 Allow backup admins to edit org application
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1870
diff changeset
  1058
    del fields['applicant']
a77d4cdcc052 Allow backup admins to edit org application
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1870
diff changeset
  1059
    fields['backup_admin'] = self.user
a77d4cdcc052 Allow backup admins to edit org application
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1870
diff changeset
  1060
a77d4cdcc052 Allow backup admins to edit org application
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1870
diff changeset
  1061
    entity = group_app_logic.getForFields(fields)
a77d4cdcc052 Allow backup admins to edit org application
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1870
diff changeset
  1062
a77d4cdcc052 Allow backup admins to edit org application
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1870
diff changeset
  1063
    if entity:
a77d4cdcc052 Allow backup admins to edit org application
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1870
diff changeset
  1064
      return
a77d4cdcc052 Allow backup admins to edit org application
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1870
diff changeset
  1065
1200
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1066
    raise out_of_band.AccessViolation(message_fmt=DEF_NOT_YOUR_ENTITY_MSG)
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1067
1201
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1068
  @allowSidebar
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1069
  def checkCanReviewGroupApp(self, django_args, group_app_logic):
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1070
    """Checks if the group_app in args is valid to be reviewed.
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1071
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1072
    Args:
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1073
      django_args: a dictionary with django's arguments
1201
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1074
      group_app_logic: A logic instance for the Group Application
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1075
    """
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1076
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1077
    if 'link_id' not in django_args:
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1078
      # calling review overview, so we can't check a specified entity
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1079
      return
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1080
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1081
    fields = {
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1082
        'link_id': django_args['link_id'],
1538
b1ab0ec9c950 Changed access checks for group applications to allow reviewing of rejected applications.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1529
diff changeset
  1083
        'status': ['needs review', 'accepted', 'rejected', 'ignored',
b1ab0ec9c950 Changed access checks for group applications to allow reviewing of rejected applications.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1529
diff changeset
  1084
            'pre-accepted', 'pre-rejected']
1201
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1085
        }
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1086
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1087
    if 'scope_path' in django_args:
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1088
      fields['scope_path'] = django_args['scope_path']
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1089
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1090
    entity = group_app_logic.getForFields(fields)
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1091
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1092
    if entity:
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1093
      return
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1094
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1095
    raise out_of_band.AccessViolation(message_fmt=DEF_REVIEW_COMPLETED_MSG)
0a4c1af700a0 Added checkCanReviewGroupApp to acces.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1200
diff changeset
  1096
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1097
  @allowDeveloper
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1098
  def checkIsApplicationAccepted(self, django_args, app_logic):
1782
501ffd646d1e checkIsApplicationAccepted now properly checks if the application is really from the applying user.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1776
diff changeset
  1099
    """Returns an alternate HTTP response if Google Account has no accepted
501ffd646d1e checkIsApplicationAccepted now properly checks if the application is really from the applying user.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1776
diff changeset
  1100
       Group Application entity for the specified arguments.
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1101
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1102
    Args:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1103
      django_args: a dictionary with django's arguments
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1104
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1105
     Raises:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1106
       AccessViolationResponse: if the required authorization is not met
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1107
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1108
    Returns:
1782
501ffd646d1e checkIsApplicationAccepted now properly checks if the application is really from the applying user.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1776
diff changeset
  1109
      None if the Accepted Group App exists for the specified program, or a subclass
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1110
      of django.http.HttpResponse which contains the alternate response
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1111
      should be returned by the calling view.
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1112
    """
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1113
1012
73f0b61f2d9d Fold checkAgreesToSiteToS into checkIsUser
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1007
diff changeset
  1114
    self.checkIsUser(django_args)
814
25ffebd9fa8f Implement the checkIsClubAppAccepted function
Sverre Rabbelier <srabbelier@gmail.com>
parents: 802
diff changeset
  1115
1782
501ffd646d1e checkIsApplicationAccepted now properly checks if the application is really from the applying user.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1776
diff changeset
  1116
    application = app_logic.getFromKeyFieldsOr404(django_args)
814
25ffebd9fa8f Implement the checkIsClubAppAccepted function
Sverre Rabbelier <srabbelier@gmail.com>
parents: 802
diff changeset
  1117
1782
501ffd646d1e checkIsApplicationAccepted now properly checks if the application is really from the applying user.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1776
diff changeset
  1118
    # check if the application is accepted and the applicant is the current user
501ffd646d1e checkIsApplicationAccepted now properly checks if the application is really from the applying user.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1776
diff changeset
  1119
    if (application.applicant.key() == self.user.key()) and (
501ffd646d1e checkIsApplicationAccepted now properly checks if the application is really from the applying user.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1776
diff changeset
  1120
        application.status == 'accepted'):
884
ded4850776c8 Changed checkIsClubAppAccepted into a more generic checkIsApplicationAccepted.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 882
diff changeset
  1121
      return
814
25ffebd9fa8f Implement the checkIsClubAppAccepted function
Sverre Rabbelier <srabbelier@gmail.com>
parents: 802
diff changeset
  1122
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
  1123
    raise out_of_band.AccessViolation(message_fmt=DEF_NO_APPLICATION_MSG)
726
ba3d399ec9be Added Notifications.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 720
diff changeset
  1124
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1125
  def checkIsNotParticipatingInProgramInScope(self, django_args):
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1126
    """Checks if the current user has no roles for the given 
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1127
       program in django_args.
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1128
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1129
    Args:
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1130
      django_args: a dictionary with django's arguments
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1131
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1132
     Raises:
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1133
       AccessViolationResponse: if the current user has a student, mentor or
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1134
                                org admin role for the given program.
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1135
    """
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1136
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1137
    if not django_args.get('scope_path'):
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1138
      raise out_of_band.AccessViolation(message_fmt=DEF_PAGE_DENIED_MSG)
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1139
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
  1140
    program_entity = program_logic.getFromKeyNameOr404(
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
  1141
        django_args['scope_path'])
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1142
    user_entity = user_logic.getForCurrentAccount()
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1143
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1144
    filter = {'user': user_entity,
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1145
              'scope': program_entity,
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1146
              'status': 'active'}
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1147
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1148
    # check if the current user is already a student for this program
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1149
    student_role = student_logic.getForFields(filter, unique=True)
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1150
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1151
    if student_role:
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1152
      raise out_of_band.AccessViolation(
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1153
          message_fmt=DEF_ALREADY_PARTICIPATING_MSG)
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1154
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1155
    # fill the role_list with all the mentor and org admin roles for this user
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
  1156
    # role_list = []
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1157
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1158
    filter = {'user': user_entity,
1832
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1159
              'program': program_entity,
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1160
              'status': 'active'}
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1161
1832
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1162
    mentor_role = mentor_logic.getForFields(filter, unique=True)
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1163
    if mentor_role:
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1164
      # the current user has a role for the given program
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1165
      raise out_of_band.AccessViolation(
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1166
            message_fmt=DEF_ALREADY_PARTICIPATING_MSG)
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1167
1832
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1168
    org_admin_role = org_admin_logic.getForFields(filter, unique=True)
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1169
    if org_admin_role:
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1170
      # the current user has a role for the given program
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1171
      raise out_of_band.AccessViolation(
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1172
            message_fmt=DEF_ALREADY_PARTICIPATING_MSG)
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1173
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1174
    # no roles found, access granted
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1175
    return
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1176
1559
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1177
  def checkIsNotStudentForProgramInScope(self, django_args):
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1178
    """Checks if the current user is not a student for the given
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1179
       program in django_args.
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1180
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1181
    Args:
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1182
      django_args: a dictionary with django's arguments
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1183
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1184
     Raises:
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1185
       AccessViolationResponse: if the current user has a student
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1186
                                role for the given program.
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1187
    """
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1188
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1189
    if django_args.get('seed'):
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1190
      key_name = django_args['seed']['scope_path']
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1191
    else:
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1192
      key_name = django_args['scope_path']
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1193
1776
f86b0fe5f4d9 Replace getFromKeyName with getFromKeyNameOr404 where appropriate in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1716
diff changeset
  1194
    program_entity = program_logic.getFromKeyNameOr404(key_name)
1559
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1195
    user_entity = user_logic.getForCurrentAccount()
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1196
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1197
    filter = {'user': user_entity,
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1198
              'scope': program_entity,
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1199
              'status': 'active'}
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1200
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1201
    # check if the current user is already a student for this program
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1202
    student_role = student_logic.getForFields(filter, unique=True)
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1203
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1204
    if student_role:
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1205
      raise out_of_band.AccessViolation(
1832
5ded837037e7 Fixed checkIsNotParticipatingInProgramInScope to just query for the given program instead of iterating over a list.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1782
diff changeset
  1206
          message_fmt=DEF_ALREADY_STUDENT_ROLE_MSG)
1559
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1207
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1208
    return
283046e54c01 Fixed issue 205.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1558
diff changeset
  1209
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1210
  def checkIsNotStudentForProgramOfOrg(self, django_args):
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1211
    """Checks if the current user has no active Student role for the program
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1212
       that the organization in the scope_path is participating in.
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1213
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1214
    Args:
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1215
      django_args: a dictionary with django's arguments
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1216
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1217
     Raises:
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1218
       AccessViolationResponse: if the current user is a student for the
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1219
                                program the organization is in.
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1220
    """
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1221
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1222
    if not django_args.get('scope_path'):
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1223
      raise out_of_band.AccessViolation(message_fmt=DEF_PAGE_DENIED_MSG)
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1224
1776
f86b0fe5f4d9 Replace getFromKeyName with getFromKeyNameOr404 where appropriate in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1716
diff changeset
  1225
    org_entity = org_logic.getFromKeyNameOr404(django_args['scope_path'])
1375
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1226
    user_entity = user_logic.getForCurrentAccount()
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1227
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1228
    filter = {'scope': org_entity.scope,
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1229
              'user': user_entity,
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1230
              'status': 'active'}
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1231
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1232
    student_role = student_logic.getForFields(filter=filter, unique=True)
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1233
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1234
    if student_role:
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1235
      raise out_of_band.AccessViolation(
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1236
          message_fmt=DEF_ALREADY_STUDENT_ROLE_MSG)
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1237
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1238
    return
edcb2add6934 Added new access methods.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1366
diff changeset
  1239
1466
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1240
  @allowDeveloper
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1241
  def checkRoleAndStatusForStudentProposal(self, django_args, allowed_roles,
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1242
                                           role_status, proposal_status):
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1243
    """Checks if the current user has access to the given proposal.
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1244
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1245
    Args:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1246
      django_args: a dictionary with django's arguments
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1247
      allowed_roles: list with names for the roles allowed to pass access check
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1248
      role_status: list with states allowed for the role
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1249
      proposal_status: a list with states allowed for the proposal
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1250
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1251
     Raises:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1252
       AccessViolationResponse:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1253
         - If there is no proposal found
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1254
         - If the proposal is not in one of the required states.
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1255
         - If the user does not have any ofe the required roles
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1256
    """
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1257
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1258
    self.checkIsUser(django_args)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1259
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1260
    # bail out with 404 if no proposal is found
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1261
    proposal_entity = student_proposal_logic.getFromKeyFieldsOr404(django_args)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1262
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1263
    if not proposal_entity.status in proposal_status:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1264
      # this proposal can not be accessed at the moment
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1265
      raise out_of_band.AccessViolation(
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1266
          message_fmt=DEF_NO_ACTIVE_ENTITY_MSG)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1267
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1268
    user_entity = self.user
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1269
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1270
    if 'proposer' in allowed_roles:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1271
      # check if this proposal belongs to the current user
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1272
      student_entity = proposal_entity.scope
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1273
      if (user_entity.key() == student_entity.user.key()) and (
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1274
          student_entity.status in role_status):
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1275
        return
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1276
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1277
    filter = {'user': user_entity,
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1278
        'status': role_status}
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1279
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1280
    if 'host' in allowed_roles:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1281
      # check if the current user is a host for this proposal's program
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1282
      filter['scope'] =  proposal_entity.program
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1283
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1284
      if host_logic.getForFields(filter, unique=True):
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1285
        return
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1286
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1287
    if 'org_admin' in allowed_roles:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1288
      # check if the current user is an admin for this proposal's org
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1289
      filter['scope'] = proposal_entity.org
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1290
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1291
      if org_admin_logic.getForFields(filter, unique=True):
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1292
        return
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1293
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1294
    if 'mentor' in allowed_roles:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1295
      # check if the current user is a mentor for this proposal's org
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1296
      filter['scope'] = proposal_entity.org
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1297
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1298
      if mentor_logic.getForFields(filter, unique=True):
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1299
        return
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1300
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1301
    # no roles found, access denied
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1302
    raise out_of_band.AccessViolation(
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1303
        message_fmt=DEF_NEED_ROLE_MSG)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1304
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1305
  @allowDeveloper
1995
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1306
  def checkCanStudentPropose(self, django_args, key_location, check_limit):
1466
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1307
    """Checks if the program for this student accepts proposals.
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1308
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1309
    Args:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1310
      django_args: a dictionary with django's arguments
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
  1311
      key_location: the key for django_args in which the key_name
1466
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1312
                    from the student is stored
1995
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1313
      check_limit: iff true checks if the student reached the apps_tasks_limit
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1314
                   for the given program.
1466
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1315
    """
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1316
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1317
    self.checkIsUser(django_args)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1318
1529
0800753ebc6a Fixed a bug in student access check
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1528
diff changeset
  1319
    if django_args.get('seed'):
1466
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1320
      key_name = django_args['seed'][key_location]
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1321
    else:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1322
      key_name = django_args[key_location]
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1323
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1324
    student_entity = student_logic.getFromKeyName(key_name)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1325
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1326
    if not student_entity or student_entity.status == 'invalid':
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1327
      raise out_of_band.AccessViolation(
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1328
        message_fmt=DEF_SIGN_UP_AS_STUDENT_MSG)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1329
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1330
    program_entity = student_entity.scope
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1331
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1332
    if not timeline_helper.isActivePeriod(program_entity.timeline,
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1333
                                          'student_signup'):
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1334
      raise out_of_band.AccessViolation(message_fmt=DEF_PAGE_INACTIVE_MSG)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1335
1995
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1336
    if check_limit:
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1337
      # count all studentproposals by the student
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1338
      fields = {'scope': student_entity}
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1339
      proposal_query = student_proposal_logic.getQueryForFields(fields)
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1340
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1341
      if proposal_query.count() >= program_entity.apps_tasks_limit:
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1342
        # too many proposals access denied
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1343
        raise out_of_band.AccessViolation(message_fmt=DEF_MAX_PROPOSALS_REACHED)
768f533d91e3 Added check to prevent students from submitting more proposals then allowed by the program settings.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1922
diff changeset
  1344
1466
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1345
    return
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1346
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1347
  @allowDeveloper
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1348
  def checkIsStudent(self, django_args, key_location, status):
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1349
    """Checks if the current user is the given student.
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1350
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1351
    Args:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1352
      django_args: a dictionary with django's arguments
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
  1353
      key_location: the key for django_args in which the key_name
1466
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1354
                    from the student is stored
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1355
      status: the allowed status for the student
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1356
    """
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1357
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1358
    self.checkIsUser(django_args)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1359
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1360
    if 'seed' in django_args:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1361
      key_name = django_args['seed'][key_location]
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1362
    else:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1363
      key_name = django_args[key_location]
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1364
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1365
    student_entity = student_logic.getFromKeyName(key_name)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1366
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1367
    if not student_entity or student_entity.status not in status:
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1368
      raise out_of_band.AccessViolation(
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1369
        message_fmt=DEF_SIGN_UP_AS_STUDENT_MSG)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1370
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1371
    if student_entity.user.key() != self.user.key():
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1372
      # this is not the page for the current user
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1373
      self.deny(django_args)
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1374
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1375
    return
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1376
bfcec687b362 Added several access checks for student proposals.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1445
diff changeset
  1377
  @allowDeveloper
2112
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1378
  def checkIsMyStudentProject(self, django_args):
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1379
    """Checks whether the project belongs to the current user.
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1380
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1381
    Args:
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1382
      django_args: a dictionary with django's arguments
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1383
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1384
     Raises:
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1385
       AccessViolationResponse:
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1386
         - If there is no project found
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1387
         - If the project does not belong to the current user
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1388
    """
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1389
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1390
    self.checkIsUser()
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1391
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1392
    project_entity = student_project_logic.getFromKeyFieldsOr404(django_args)
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1393
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1394
    if project_entity.student.user.key() != self.user.key():
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1395
      raise out_of_band.AccessViolation(
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1396
          message_fmt=DEF_NOT_YOUR_ENTITY_MSG)
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1397
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1398
    return
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1399
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1400
  @allowDeveloper
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1401
  def checkStudentProjectHasStatus(self, django_args, allowed_status):
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1402
    """Checks whether the Project has one of the given statusses.
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1403
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1404
    Args:
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1405
      django_args: a dictionary with django's arguments
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1406
      allowed_status: list with the allowed statusses for the entity
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1407
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1408
     Raises:
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1409
       AccessViolationResponse:
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1410
         - If there is no project found
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1411
         - If the project is not in the requested status
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1412
    """
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1413
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1414
    project_entity = student_project_logic.getFromKeyFieldsOr404(django_args)
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1415
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1416
    if not project_entity.status in allowed_status:
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1417
      raise out_of_band.AccessViolation(
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1418
          message_fmt=DEF_NO_ACTIVE_ENTITY_MSG)
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1419
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1420
    return
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1421
9a2c9354468c Added 2 new access checks to deal with StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2101
diff changeset
  1422
  @allowDeveloper
1180
6290c9e49848 Fixed club_app
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1179
diff changeset
  1423
  def checkIsMyEntity(self, django_args, logic,
6290c9e49848 Fixed club_app
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1179
diff changeset
  1424
                      field_name='user', user=False):
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1425
    """Checks whether the entity belongs to the user.
1481
0ccf92d073e8 Add missing comment to checkIsMyEntity
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1475
diff changeset
  1426
0ccf92d073e8 Add missing comment to checkIsMyEntity
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1475
diff changeset
  1427
    Args:
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1428
      django_args: a dictionary with django's arguments
1481
0ccf92d073e8 Add missing comment to checkIsMyEntity
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1475
diff changeset
  1429
      logic: the logic that should be used to fetch the entity
0ccf92d073e8 Add missing comment to checkIsMyEntity
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1475
diff changeset
  1430
      field_name: the name of the field the entity uses to store it's owner
2020
df3552deba66 Clarified docstring in access.py and changed edit access checks for role views.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1995
diff changeset
  1431
      user: true iff the entity stores the user's reference, false iff keyname
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1432
    """
791
30da180c4bca Added the club_app view, logic and model
Sverre Rabbelier <srabbelier@gmail.com>
parents: 746
diff changeset
  1433
1012
73f0b61f2d9d Fold checkAgreesToSiteToS into checkIsUser
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1007
diff changeset
  1434
    self.checkIsUser(django_args)
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1435
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1436
    fields = {
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1437
        'link_id': django_args['link_id'],
1180
6290c9e49848 Fixed club_app
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1179
diff changeset
  1438
        field_name: self.user if user else self.user.key().name()
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1439
        }
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1440
1200
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1441
    if 'scope_path' in django_args:
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1442
      fields['scope_path'] = django_args['scope_path']
e68fd70ba076 Added checkCanEditGroupApp to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1198
diff changeset
  1443
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1444
    entity = logic.getForFields(fields)
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
  1445
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1446
    if entity:
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1447
      return
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
  1448
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1449
    raise out_of_band.AccessViolation(message_fmt=DEF_NOT_YOUR_ENTITY_MSG)
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1450
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1451
  @allowDeveloper
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1452
  @denySidebar
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
  1453
  def checkIsAllowedToManageRole(self, django_args, logic_for_role, 
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
  1454
      manage_role_logic):
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1455
    """Returns an alternate HTTP response if the user is not allowed to manage
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
  1456
       the role given in args.
1068
8a06ebff014e Changed docstring for checkIsAllowedToManageRole.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1066
diff changeset
  1457
8a06ebff014e Changed docstring for checkIsAllowedToManageRole.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1066
diff changeset
  1458
     Args:
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1459
       django_args: a dictionary with django's arguments
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
  1460
       logic_for_role: determines the logic for the role in args.
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
  1461
       manage_role_logic: determines the logic for the role which is allowed
1068
8a06ebff014e Changed docstring for checkIsAllowedToManageRole.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1066
diff changeset
  1462
           to manage this role.
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1463
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1464
     Raises:
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1465
       AccessViolationResponse: if the required authorization is not met
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1466
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1467
    Returns:
1068
8a06ebff014e Changed docstring for checkIsAllowedToManageRole.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1066
diff changeset
  1468
      None if the given role is active and belongs to the current user.
1524
30ada09bdc6f Make django_args optional where appropriate and whitespace fixes
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1505
diff changeset
  1469
      None if the current User has an active role (from manage_role_logic)
1068
8a06ebff014e Changed docstring for checkIsAllowedToManageRole.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1066
diff changeset
  1470
           that belongs to the same scope as the role that needs to be managed
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1471
    """
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1472
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1473
    try:
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1474
      # check if it is my role the user's own role
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
  1475
      self.checkHasActiveRoleForScope(django_args, logic_for_role)
2032
b881417db09e Added missing return to manage access check.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2020
diff changeset
  1476
      return
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1477
    except out_of_band.Error:
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1478
      pass
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1479
2077
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
  1480
    # apparently it's not the user's role so check 
fd2e83a297c7 Style fixes, add missing docstring, fix some wrong calls to super classes and removal of unused imports in soc.views.helper.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2032
diff changeset
  1481
    # if managing this role is allowed
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1482
    fields = {
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1483
        'link_id': django_args['link_id'],
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1484
        'scope_path': django_args['scope_path'],
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1485
        }
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1486
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
  1487
    role_entity = role_logic.getFromKeyFieldsOr404(fields)
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
  1488
    if role_entity.status != 'active':
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
  1489
      raise out_of_band.AccessViolation(message_fmt=DEF_NO_ACTIVE_ROLE_MSG)
914
6ec8dd2a73b3 Added various access methods in preperation for the new request system.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 895
diff changeset
  1490
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1491
    fields = {
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1492
        'link_id': self.user.link_id,
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1493
        'scope_path': django_args['scope_path'],
1142
da2487767ef4 Fix missing dot and wrong import sorting in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1135
diff changeset
  1494
        'status': 'active'
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1495
        }
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1496
1184
bd9c6101d41d Use .logic in checkIsAllowedToManageRole at the caller
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1180
diff changeset
  1497
    manage_entity = manage_role_logic.getForFields(fields, unique=True)
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1498
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1499
    if not manage_entity:
1239
065e5bcf90f0 Stylefixes in access.py and removal of self.deny calls
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1237
diff changeset
  1500
      raise out_of_band.AccessViolation(message_fmt=DEF_NOT_YOUR_ENTITY_MSG)
1066
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1501
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1502
    return
b22750a2b04a Added checkIsAllowedToManageRole to access.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1061
diff changeset
  1503
1265
cecb2b35f805 Added allowsidebar to checkIsDocumentReadable.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1263
diff changeset
  1504
  @allowSidebar
1115
0a723ff3d27c Cleanups in base.Logic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1107
diff changeset
  1505
  @allowDeveloper
1496
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1506
  def checkIsDocumentReadable(self, django_args, key_name_field=None):
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1507
    """Checks whether a document is readable.
699
4e8eefe95748 Add and use a placeholder for checkIsDocumentPublic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 639
diff changeset
  1508
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1509
    Args:
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1510
      django_args: a dictionary with django's arguments
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1511
      key_name_field: key name field
1007
3b66772d21a5 Major refactor of the access module
Sverre Rabbelier <srabbelier@gmail.com>
parents: 999
diff changeset
  1512
    """
699
4e8eefe95748 Add and use a placeholder for checkIsDocumentPublic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 639
diff changeset
  1513
1496
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1514
    if key_name_field:
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1515
      key_name = django_args[key_name_field]
1776
f86b0fe5f4d9 Replace getFromKeyName with getFromKeyNameOr404 where appropriate in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1716
diff changeset
  1516
      document = document_logic.getFromKeyNameOr404(key_name)
1496
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1517
    else:
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1518
      document = document_logic.getFromKeyFieldsOr404(django_args)
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1519
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1520
    self.checkMembership('read', document.prefix,
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1521
                         document.read_access, django_args)
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1522
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1523
  @denySidebar
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1524
  @allowDeveloper
1496
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1525
  def checkIsDocumentWritable(self, django_args, key_name_field=None):
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1526
    """Checks whether a document is writable.
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1527
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1528
    Args:
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1529
      django_args: a dictionary with django's arguments
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1530
      key_name_field: key name field
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1531
    """
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1532
1496
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1533
    if key_name_field:
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1534
      key_name = django_args[key_name_field]
1776
f86b0fe5f4d9 Replace getFromKeyName with getFromKeyNameOr404 where appropriate in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1716
diff changeset
  1535
      document = document_logic.getFromKeyNameOr404(key_name)
1496
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1536
    else:
da531df1d92e Allow the document lookup to be done by key name
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1488
diff changeset
  1537
      document = document_logic.getFromKeyFieldsOr404(django_args)
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1538
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1539
    self.checkMembership('write', document.prefix,
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1540
                         document.write_access, django_args)
1074
94bc2a9ae103 Properly check if a program is active
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1073
diff changeset
  1541
1305
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1542
  @allowDeveloper
1318
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1543
  def checkDocumentList(self, django_args):
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1544
    """Checks whether the user is allowed to list documents.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1545
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1546
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1547
      django_args: a dictionary with django's arguments
1318
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1548
    """
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1549
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1550
    filter = django_args['filter']
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1551
    prefix = filter['prefix']
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1552
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1553
    checker = rights_logic.Checker(prefix)
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1554
    roles = checker.getMembership('list')
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1555
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1556
    if not self.hasMembership(roles, filter):
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1557
      raise out_of_band.AccessViolation(message_fmt=DEF_NO_LIST_ACCESS_MSG)
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1558
3f41f33a4ad2 Add custom access check for document listing
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1315
diff changeset
  1559
  @allowDeveloper
1305
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1560
  def checkDocumentPick(self, django_args):
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1561
    """Checks whether the user has access to the specified pick url.
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1562
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1563
    Will update the 'read_access' field of django_args['GET'].
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1564
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1565
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1566
      django_args: a dictionary with django's arguments
1305
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1567
    """
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1568
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1569
    get_args = django_args['GET']
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1570
    # make mutable in order to inject the proper read_access filter
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1571
    mutable = get_args._mutable
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1572
    get_args._mutable = True
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1573
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1574
    if 'prefix' not in get_args:
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1575
      raise out_of_band.AccessViolation(message_fmt=DEF_PREFIX_NOT_IN_ARGS_MSG)
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1576
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1577
    prefix = get_args['prefix']
1577
b0bb5c8b5f78 Fix bug in checkDocumentPick of soc.views.helper.access module, which cause KeyError exceptions in document picker.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1559
diff changeset
  1578
    django_args['prefix'] = prefix
1606
6f7e5a566d9a Fix the KeyError: 'scope_path' error in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1577
diff changeset
  1579
    django_args['scope_path'] = get_args['scope_path']
1305
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1580
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1581
    checker = rights_logic.Checker(prefix)
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1582
    memberships = checker.getMemberships()
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1583
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1584
    roles = []
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1585
    for key, value in memberships.iteritems():
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1586
      if self.hasMembership(value, django_args):
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1587
        roles.append(key)
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1588
1309
ba51a0cd311d Fix a bug if you have no roles at all
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
  1589
    if not roles:
ba51a0cd311d Fix a bug if you have no roles at all
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
  1590
      roles = ['deny']
ba51a0cd311d Fix a bug if you have no roles at all
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
  1591
1305
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1592
    get_args.setlist('read_access', roles)
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1593
    get_args._mutable = mutable
9567bb475d6d Do access checks on the pick url for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1300
diff changeset
  1594
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1595
  def checkCanEditTimeline(self, django_args):
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1596
    """Checks whether this program's timeline may be edited.
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1597
    
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1598
    Args:
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1599
      django_args: a dictionary with django's arguments
1135
24d695060863 Hook up the ACL system for documents.
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1122
diff changeset
  1600
    """
1633
6b65707f4248 Remove unused imports, style and too long lines fixes, remove unused variables, rename too short variable names, fix docstrings in soc.views.helper.access module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1606
diff changeset
  1601
    
1475
22b63ab59b27 Make timeline a Linkable
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1466
diff changeset
  1602
    time_line_keyname = timeline_logic.getKeyFieldsFromFields(django_args)
1107
a878188e225c Added status to program.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1085
diff changeset
  1603
    timeline_entity = timeline_logic.getFromKeyName(time_line_keyname)
a878188e225c Added status to program.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1085
diff changeset
  1604
a878188e225c Added status to program.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1085
diff changeset
  1605
    if not timeline_entity:
a878188e225c Added status to program.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1085
diff changeset
  1606
      # timeline does not exists so deny
a878188e225c Added status to program.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1085
diff changeset
  1607
      self.deny(django_args)
a878188e225c Added status to program.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1085
diff changeset
  1608
1475
22b63ab59b27 Make timeline a Linkable
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1466
diff changeset
  1609
    fields = program_logic.getKeyFieldsFromFields(django_args)
1163
d8c50be19232 Cleaned up access.py
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1142
diff changeset
  1610
    self.checkIsHostForProgram(fields)