app/soc/logic/cleaning.py
author Lennard de Rijk <ljvderijk@gmail.com>
Sat, 21 Feb 2009 11:06:23 +0000
changeset 1425 49d385edb6b4
parent 1395 08dbb5aa1dc9
child 1440 58ac0b3f59ac
permissions -rw-r--r--
Added new cleaning method to validate a student proposal. Patch by: Lennard de Rijk Reviewed by: to-be-reviewed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     1
#!/usr/bin/python2.5
988f8a8cd6de Added a cleaning 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.
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     4
#
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     5
# Licensed under the Apache License, Version 2.0 (the "License");
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     6
# you may not use this file except in compliance with the License.
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     7
# You may obtain a copy of the License at
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     8
#
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     9
#   http://www.apache.org/licenses/LICENSE-2.0
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    10
#
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    11
# Unless required by applicable law or agreed to in writing, software
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    12
# distributed under the License is distributed on an "AS IS" BASIS,
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    13
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    14
# See the License for the specific language governing permissions and
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    15
# limitations under the License.
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    16
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
    17
"""Generic cleaning methods.
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    18
"""
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    19
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    20
__authors__ = [
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    21
    '"Todd Larsen" <tlarsen@google.com>',
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    22
    '"Sverre Rabbelier" <sverre@rabbelier.nl>',
928
df051fc9d7a1 Replaced the boolean properties in soc/models/request.py with a state property.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 905
diff changeset
    23
    '"Lennard de Rijk" <ljvderijk@gmail.com>',
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    24
    ]
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    25
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    26
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
    27
from google.appengine.api import users
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
    28
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    29
from django import forms
1205
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
    30
from django.forms.util import ErrorList
1083
b8018d7a9f23 Moved clean_club_app_link_id to cleaning.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1079
diff changeset
    31
from django.utils.translation import ugettext
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    32
1354
aba2beea6dfa Fix import sorting in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1333
diff changeset
    33
from soc.logic import rights as rights_logic
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    34
from soc.logic import validate
1039
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
    35
from soc.logic.models import site as site_logic
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
    36
from soc.logic.models import user as user_logic
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
    37
from soc.models import document as document_model
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    38
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    39
1205
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
    40
DEF_LINK_ID_IN_USE_MSG = ugettext(
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
    41
    'This link ID is already in use, please specify another one')
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
    42
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
    43
DEF_NO_RIGHTS_FOR_ACL_MSG = ugettext(
1425
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
    44
    'You do not have the required rights for that ACL.')
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
    45
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
    46
DEF_ORGANZIATION_NOT_ACTIVE_MSG = ugettext(
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
    47
    'This organization is not active/existent')
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
    48
1205
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
    49
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    50
def check_field_is_empty(field_name):
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    51
  """Returns decorator that bypasses cleaning for empty fields.
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    52
  """
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    53
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    54
  def decorator(fun):
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    55
    """Decorator that checks if a field is empty if so doesn't do the cleaning.
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    56
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    57
    Note Django will capture errors concerning required fields that are empty.
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    58
    """
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    59
    from functools import wraps
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    60
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    61
    @wraps(fun)
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    62
    def wrapper(self):
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    63
      field_content = self.cleaned_data.get(field_name)
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    64
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    65
      if not field_content:
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    66
        # field has no content so bail out
1288
4ef7de6c2b7a Returning None instead of the empty to fix a bug on melange-demo instance.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1287
diff changeset
    67
        return None
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    68
      else:
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    69
        # field has contents
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    70
        return fun(self)
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    71
    return wrapper
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    72
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    73
  return decorator
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    74
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    75
1395
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    76
def clean_empty_field(field_name):
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    77
  """Incorperates the check_field_is_empty as regular cleaner.
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    78
  """
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    79
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    80
  @check_field_is_empty(field_name)
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    81
  def wrapper(self):
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    82
    return self.cleaned_data.get(field_name)
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    83
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    84
  return wrapper
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    85
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    86
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    87
def clean_link_id(field_name):
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    88
  """Checks if the field_name value is in a valid link ID format.
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    89
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    90
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    91
  @check_field_is_empty(field_name)
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    92
  def wrapper(self):
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    93
    # convert to lowercase for user comfort
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    94
    link_id = self.cleaned_data.get(field_name).lower()
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    95
    if not validate.isLinkIdFormatValid(link_id):
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    96
      raise forms.ValidationError("This link ID is in wrong format.")
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    97
    return link_id
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    98
  return wrapper
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    99
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   100
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   101
def clean_scope_path(field_name):
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   102
  """Checks if the field_name value is in a valid scope path format.
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   103
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   104
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   105
  @check_field_is_empty(field_name)
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   106
  def wrapper(self):
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   107
    # convert to lowercase for user comfort
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   108
    scope_path = self.cleaned_data.get(field_name).lower()
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   109
    if not validate.isScopePathFormatValid(scope_path):
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   110
      raise forms.ValidationError("This scope path is in wrong format.")
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   111
    return scope_path
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   112
  return wrapper
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   113
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   114
1039
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   115
def clean_agrees_to_tos(field_name):
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   116
  """Checks if there is a ToS to see if it is allowed to leave 
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   117
     the field_name field false.
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   118
  """
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   119
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   120
  @check_field_is_empty(field_name)
1039
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   121
  def wrapper(self):
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   122
    agrees_to_tos = self.cleaned_data.get(field_name)
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   123
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   124
    if not site_logic.logic.getToS(site_logic.logic.getSingleton()):
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   125
      return agrees_to_tos
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   126
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   127
    # Site settings specify a site-wide ToS, so agreement is *required*
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   128
    if agrees_to_tos:
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   129
      return True
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   130
    
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   131
    # there was no agreement made so raise an error
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   132
    raise forms.ValidationError(
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   133
        'The site-wide Terms of Service must be accepted to participate'
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   134
        ' on this site.')
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   135
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   136
  return wrapper
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   137
1143
b07b7d5b3e27 Fix missing dots and blank lines to soc.logic modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1088
diff changeset
   138
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   139
def clean_existing_user(field_name):
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   140
  """Check if the field_name field is a valid user.
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   141
  """
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   142
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   143
  @check_field_is_empty(field_name)
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   144
  def wrapped(self):
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
   145
    link_id = clean_link_id(field_name)(self)
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   146
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   147
    user_entity = user_logic.logic.getForFields({'link_id': link_id}, 
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   148
        unique=True)
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   149
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   150
    if not user_entity:
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   151
      # user does not exist
837
bc1c951bf3a0 Add missing blank line in soc.views.helper.params module. Fix docstring typo in soc.views.models.role module. Add missing dots at the end of sentences in soc.logic.cleaning and soc.view.models.user_self modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 788
diff changeset
   152
      raise forms.ValidationError("This user does not exist.")
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   153
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   154
    return user_entity
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   155
  return wrapped
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   156
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   157
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   158
def clean_user_is_current(field_name):
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   159
  """Check if the field_name value is a valid link_id and resembles the 
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   160
     current user.
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   161
  """
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   162
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   163
  @check_field_is_empty(field_name)
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   164
  def wrapped(self):
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   165
    link_id = clean_link_id(field_name)(self)
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   166
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   167
    user_entity = user_logic.logic.getForCurrentAccount()
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   168
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   169
    if not user_entity or user_entity.link_id != link_id:
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   170
      # this user is not the current user
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   171
      raise forms.ValidationError("This user is not you.")
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   172
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   173
    return user_entity
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   174
  return wrapped
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   175
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   176
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   177
def clean_user_not_exist(field_name):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   178
  """Check if the field_name value is a valid link_id and a user with the
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   179
     link id does not exist.
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   180
  """ 
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   181
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   182
  @check_field_is_empty(field_name)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   183
  def wrapped(self):
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
   184
    link_id = clean_link_id(field_name)(self)
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   185
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   186
    user_entity = user_logic.logic.getForFields({'link_id': link_id}, 
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   187
        unique=True)
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   188
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   189
    if user_entity:
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   190
      # user exists already
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   191
      raise forms.ValidationError("There is already a user with this link id.")
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   192
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   193
    return link_id
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   194
  return wrapped
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   195
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   196
905
70eb2493a346 Rename clean_existing_user_not_equal_to_current function to clean_users_not_same in soc.logic.cleaning module and fix affected files.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 902
diff changeset
   197
def clean_users_not_same(field_name):
886
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   198
  """Check if the field_name field is a valid user and is not 
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   199
     equal to the current user.
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   200
  """
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   201
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   202
  @check_field_is_empty(field_name)
886
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   203
  def wrapped(self):
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   204
886
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   205
    clean_user_field = clean_existing_user(field_name)
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   206
    user_entity = clean_user_field(self)
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   207
886
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   208
    current_user_entity = user_logic.logic.getForCurrentAccount()
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   209
886
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   210
    if user_entity.key() == current_user_entity.key():
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   211
      # users are equal
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   212
      raise forms.ValidationError("You cannot enter yourself here.")
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   213
886
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   214
    return user_entity
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   215
  return wrapped
f5847f24c56e Added clean_existing_user_not_equal_to_current to clean the backup Administrator field in an application.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 867
diff changeset
   216
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   217
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   218
def clean_user_account(field_name):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   219
  """Returns the User with the given field_name value.
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   220
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   221
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   222
  @check_field_is_empty(field_name)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   223
  def wrapped(self):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   224
    email_adress = self.cleaned_data.get(field_name).lower()
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   225
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   226
    # get the user account for this email
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   227
    user_account = users.User(email_adress)
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   228
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   229
    return user_account
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   230
  return wrapped
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   231
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   232
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   233
def clean_user_account_not_in_use(field_name):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   234
  """Check if the field_name value contains an email 
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   235
     address that hasn't been used for an existing account.
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   236
  """ 
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   237
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   238
  @check_field_is_empty(field_name)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   239
  def wrapped(self):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   240
    email_adress = self.cleaned_data.get(field_name).lower()
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   241
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   242
    # get the user account for this email and check if it's in use
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   243
    user_account = users.User(email_adress)
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   244
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   245
    fields = {'account': user_account}
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   246
    user_entity = user_logic.logic.getForFields(fields, unique=True)
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   247
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   248
    if user_entity or user_logic.logic.isFormerAccount(user_account):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   249
      raise forms.ValidationError("There is already a user with this email adress.")
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   250
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   251
    return user_account
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   252
  return wrapped
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   253
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   254
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   255
def clean_feed_url(self):
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   256
  feed_url = self.cleaned_data.get('feed_url')
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   257
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   258
  if feed_url == '':
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   259
    # feed url not supplied (which is OK), so do not try to validate it
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   260
    return None
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   261
  
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   262
  if not validate.isFeedURLValid(feed_url):
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   263
    raise forms.ValidationError('This URL is not a valid ATOM or RSS feed.')
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   264
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   265
  return feed_url
898
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   266
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   267
898
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   268
def clean_url(field_name):
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   269
  """Clean method for cleaning a field belonging to a LinkProperty.
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   270
  """
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   271
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   272
  @check_field_is_empty(field_name)
898
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   273
  def wrapped(self):
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   274
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   275
    value = self.cleaned_data.get(field_name)
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   276
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   277
    # call the Django URLField cleaning method to properly clean/validate this field
967
be5f5533a07f Changed clean_url to work with dynaform.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 928
diff changeset
   278
    return forms.URLField.clean(self.fields[field_name], value)
898
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   279
  return wrapped
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   280
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   281
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   282
def validate_user_edit(link_id_field, account_field):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   283
  """Clean method for cleaning user edit form.
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   284
  
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   285
  Raises ValidationError if:
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   286
    -Another User has the given email address as account
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   287
    -Another User has the given email address in it's FormerAccounts list
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   288
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   289
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   290
  def wrapper(self):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   291
    cleaned_data = self.cleaned_data
1242
c5ca70606850 Handle GAE account normalization
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1217
diff changeset
   292
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   293
    link_id = cleaned_data.get(link_id_field)
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   294
    user_account = cleaned_data.get(account_field)
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   295
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   296
    # if both fields were valid do this check
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   297
    if link_id and user_account:
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   298
      # get the user from the link_id in the form
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   299
      fields = {'link_id': link_id}
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   300
      user_entity = user_logic.logic.getForFields(fields, unique=True)
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   301
1285
d54f2d80f46e Fixed comment and typo in cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1242
diff changeset
   302
      # if it's not the user's current account
1242
c5ca70606850 Handle GAE account normalization
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1217
diff changeset
   303
      if user_entity.account != user_account:
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   304
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   305
        # get the user having the given account
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   306
        fields = {'account': user_account}
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   307
        user_from_account_entity = user_logic.logic.getForFields(fields, 
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   308
            unique=True)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   309
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   310
        # if there is a user with the given account or it's a former account
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   311
        if user_from_account_entity or user_logic.logic.isFormerAccount(user_account):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   312
          # raise an error because this email address can't be used
1285
d54f2d80f46e Fixed comment and typo in cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1242
diff changeset
   313
          raise forms.ValidationError("There is already a user with this email address.")
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   314
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   315
    return cleaned_data
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   316
  return wrapper
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   317
1205
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   318
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   319
def validate_new_group(link_id_field, scope_path_field, 
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   320
                       group_logic, group_app_logic):
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   321
  """Clean method used to clean the group application or new group form.
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   322
  
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   323
    Raises ValidationError if:
1217
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   324
    -A application with this link id and scope path already exists
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   325
    -A group with this link id and scope path already exists
1205
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   326
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   327
1205
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   328
  def wrapper(self):
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   329
      cleaned_data = self.cleaned_data
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   330
1217
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   331
      fields = {}
1205
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   332
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   333
      link_id = cleaned_data.get(link_id_field)
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   334
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   335
      if link_id:
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   336
        fields['link_id'] = link_id
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   337
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   338
        scope_path = cleaned_data.get(scope_path_field)
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   339
        if scope_path:
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   340
          fields['scope_path'] = scope_path
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   341
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   342
        # get the application
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   343
        group_app_entity = group_app_logic.logic.getForFields(fields, unique=True)
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   344
1217
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   345
        # get the current user
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   346
        user_entity = user_logic.logic.getForCurrentAccount()
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   347
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   348
        # make sure it's not the applicant creating the new group
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   349
        if group_app_entity and (
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   350
            group_app_entity.applicant.key() != user_entity.key()):
1205
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   351
          # add the error message to the link id field
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   352
          self._errors[link_id_field] = ErrorList([DEF_LINK_ID_IN_USE_MSG])
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   353
          del cleaned_data[link_id_field]
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   354
          # return the new cleaned_data
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   355
          return cleaned_data
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   356
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   357
        # check if there is already a group for the given fields
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   358
        group_entity = group_logic.logic.getForFields(fields, unique=True)
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   359
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   360
        if group_entity:
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   361
          # add the error message to the link id field
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   362
          self._errors[link_id_field] = ErrorList([DEF_LINK_ID_IN_USE_MSG])
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   363
          del cleaned_data[link_id_field]
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   364
          # return the new cleaned_data
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   365
          return cleaned_data
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   366
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   367
      return cleaned_data
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   368
  return wrapper
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   369
1425
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   370
def validate_student_proposal(org_field, scope_field,
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   371
                              student_logic, org_logic):
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   372
  """Validates the form of a student proposal.
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   373
  
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   374
  Raises ValidationError if:
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   375
    -The organization link_id does not match an active organization
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   376
    -The hidden scope path is not a valid active student
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   377
  """
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   378
  
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   379
  def wrapper(self):
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   380
    cleaned_data = self.cleaned_data
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   381
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   382
    org_link_id = cleaned_data.get(org_field)
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   383
    scope_path = cleaned_data.get(scope_field)
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   384
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   385
    # only if both fields are valid
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   386
    if org_link_id and scope_path:
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   387
      filter = {'scope_path': scope_path,
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   388
                'status': 'active'}
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   389
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   390
      student_entity = student_logic.logic.getFromKeyName(scope_path)
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   391
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   392
      if not student_entity or student_entity.status != 'active':
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   393
        # raise validation error, access checks should have prevented this
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   394
        raise forms.ValidationError(
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   395
            ugettext("The given student is not valid."))
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   396
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   397
      filter = {'link_id': org_link_id,
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   398
                'scope': student_entity.scope,
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   399
                'status': 'active'}
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   400
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   401
      org_entity = org_logic.logic.getForFields(filter, unique=True)
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   402
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   403
      if not org_entity:
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   404
        #raise validation error, non valid organization entered
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   405
        self._errors['organization'] = ErrorList(
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   406
            [DEF_ORGANZIATION_NOT_ACTIVE_MSG])
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   407
        del cleaned_data['organization']
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   408
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   409
    return cleaned_data
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   410
  return wrapper
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   411
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   412
def validate_document_acl(view):
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   413
  """Validates that the document ACL settings are correct.
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   414
  """
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   415
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   416
  def wrapper(self):
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   417
    cleaned_data = self.cleaned_data
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   418
    read_access = cleaned_data.get('read_access')
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   419
    write_access = cleaned_data.get('write_access')
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   420
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   421
    if not (read_access and write_access and ('prefix' in cleaned_data)):
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   422
      return cleaned_data
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   423
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   424
    if read_access != 'public':
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   425
      ordening = document_model.Document.DOCUMENT_ACCESS
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   426
      if ordening.index(read_access) < ordening.index(write_access):
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   427
        raise forms.ValidationError(
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   428
            "Read access should be less strict than write access.")
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   429
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   430
    validate_access(self, view, 'read_access')
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   431
    validate_access(self, view, 'write_access')
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   432
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   433
    return cleaned_data
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   434
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   435
  return wrapper
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   436
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   437
def validate_access(self, view, field):
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   438
  """Validates that the user has access to the ACL for the specified fields.
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   439
  """
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   440
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   441
  access_level = self.cleaned_data[field]
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   442
  prefix = self.cleaned_data['prefix']
1320
a5913d46e97e Include scope_path as django_args
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1311
diff changeset
   443
  scope_path = self.cleaned_data['scope_path']
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   444
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   445
  params = view.getParams()
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   446
  rights = params['rights']
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   447
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   448
  user = user_logic.logic.getForCurrentAccount()
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   449
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   450
  rights.setCurrentUser(user.account, user)
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   451
  checker = rights_logic.Checker(prefix)
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   452
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   453
  roles = checker.getMembership(access_level)
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   454
1320
a5913d46e97e Include scope_path as django_args
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1311
diff changeset
   455
  if not rights.hasMembership(roles, {'scope_path': scope_path}):
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   456
    self._errors[field] = ErrorList([DEF_NO_RIGHTS_FOR_ACL_MSG])
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   457
    del self.cleaned_data[field]