app/soc/logic/cleaning.py
author Lennard de Rijk <ljvderijk@gmail.com>
Thu, 12 Feb 2009 23:06:14 +0000
changeset 1288 4ef7de6c2b7a
parent 1287 9b18d612510a
child 1307 091a21cf3627
permissions -rw-r--r--
Returning None instead of the empty to fix a bug on melange-demo instance. 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
#
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
     3
# Copyright 2008 the Melange authors.
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
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    33
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
    34
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
    35
from soc.logic.models import user as user_logic
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    36
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    37
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
    38
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
    39
    '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
    40
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
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    42
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
    43
  """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
    44
  """
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    45
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    46
  def decorator(fun):
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    47
    """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
    48
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    49
    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
    50
    """
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    51
    from functools import wraps
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
    @wraps(fun)
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    54
    def wrapper(self):
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    55
      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
    56
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    57
      if not field_content:
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    58
        # 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
    59
        return None
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    60
      else:
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    61
        # field has contents
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    62
        return fun(self)
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    63
    return wrapper
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
  return decorator
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    66
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    67
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
    68
def clean_link_id(field_name):
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    69
  """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
    70
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    71
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    72
  @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
    73
  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
    74
    # 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
    75
    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
    76
    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
    77
      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
    78
    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
    79
  return wrapper
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    80
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    81
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    82
def clean_scope_path(field_name):
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    83
  """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
    84
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    85
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    86
  @check_field_is_empty(field_name)
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    87
  def wrapper(self):
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    88
    # convert to lowercase for user comfort
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    89
    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
    90
    if not validate.isScopePathFormatValid(scope_path):
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    91
      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
    92
    return scope_path
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    93
  return wrapper
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    94
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
    95
1039
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
    96
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
    97
  """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
    98
     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
    99
  """
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   100
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   101
  @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
   102
  def wrapper(self):
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   103
    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
   104
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   105
    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
   106
      return agrees_to_tos
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   107
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   108
    # 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
   109
    if agrees_to_tos:
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   110
      return True
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   111
    
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   112
    # 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
   113
    raise forms.ValidationError(
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   114
        '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
   115
        ' on this site.')
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   116
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   117
  return wrapper
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   118
1143
b07b7d5b3e27 Fix missing dots and blank lines to soc.logic modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1088
diff changeset
   119
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   120
def clean_existing_user(field_name):
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   121
  """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
   122
  """
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   123
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   124
  @check_field_is_empty(field_name)
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   125
  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
   126
    link_id = clean_link_id(field_name)(self)
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   127
  
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   128
    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
   129
        unique=True)
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   130
  
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   131
    if not user_entity:
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   132
      # 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
   133
      raise forms.ValidationError("This user does not exist.")
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   134
  
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   135
    return user_entity
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   136
  return wrapped
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   137
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   138
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   139
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
   140
  """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
   141
     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
   142
  """ 
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   143
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   144
  @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
   145
  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
   146
    link_id = clean_link_id(field_name)(self)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   147
  
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   148
    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
   149
        unique=True)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   150
  
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   151
    if user_entity:
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   152
      # user exists already
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   153
      raise forms.ValidationError("There is already a user with this link id.")
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   154
  
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   155
    return link_id
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   156
  return wrapped
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   157
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   158
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
   159
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
   160
  """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
   161
     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
   162
  """
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
   163
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   164
  @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
   165
  def wrapped(self):
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
   166
    
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
   167
    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
   168
    user_entity = clean_user_field(self)
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
   169
    
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
   170
    current_user_entity = user_logic.logic.getForCurrentAccount()
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
   171
    
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
   172
    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
   173
      # users are equal
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   174
      raise forms.ValidationError("You cannot enter yourself here.")
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
   175
    
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
   176
    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
   177
  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
   178
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   179
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   180
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
   181
  """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
   182
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   183
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   184
  @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
   185
  def wrapped(self):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   186
    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
   187
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   188
    # 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
   189
    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
   190
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   191
    return user_account
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   192
  return wrapped
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   193
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   194
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   195
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
   196
  """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
   197
     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
   198
  """ 
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   199
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   200
  @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
   201
  def wrapped(self):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   202
    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
   203
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   204
    # 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
   205
    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
   206
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   207
    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
   208
    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
   209
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   210
    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
   211
      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
   212
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   213
    return user_account
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   214
  return wrapped
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   215
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   216
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   217
def clean_feed_url(self):
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   218
  feed_url = self.cleaned_data.get('feed_url')
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   219
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   220
  if feed_url == '':
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   221
    # 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
   222
    return None
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   223
  
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   224
  if not validate.isFeedURLValid(feed_url):
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   225
    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
   226
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   227
  return feed_url
898
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   228
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   229
898
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   230
def clean_url(field_name):
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   231
  """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
   232
  """
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   233
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   234
  @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
   235
  def wrapped(self):
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   236
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   237
    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
   238
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   239
    # 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
   240
    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
   241
  return wrapped
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   242
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   243
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   244
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
   245
  """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
   246
  
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   247
  Raises ValidationError if:
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   248
    -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
   249
    -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
   250
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   251
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   252
  def wrapper(self):
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   253
    cleaned_data = self.cleaned_data
1242
c5ca70606850 Handle GAE account normalization
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1217
diff changeset
   254
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   255
    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
   256
    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
   257
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   258
    # 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
   259
    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
   260
      # 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
   261
      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
   262
      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
   263
1285
d54f2d80f46e Fixed comment and typo in cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1242
diff changeset
   264
      # if it's not the user's current account
1242
c5ca70606850 Handle GAE account normalization
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1217
diff changeset
   265
      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
   266
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   267
        # 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
   268
        fields = {'account': user_account}
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   269
        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
   270
            unique=True)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   271
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   272
        # 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
   273
        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
   274
          # 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
   275
          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
   276
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   277
    return cleaned_data
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   278
  return wrapper
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   279
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
   280
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   281
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
   282
                       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
   283
  """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
   284
  
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   285
    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
   286
    -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
   287
    -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
   288
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   289
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
   290
  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
   291
      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
   292
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
   293
      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
   294
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   295
      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
   296
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   297
      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
   298
        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
   299
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   300
        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
   301
        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
   302
          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
   303
2e88261aba72 Added validate_new_group to cleaning and removed clean_new_club_link_id.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1143
diff changeset
   304
        # 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
   305
        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
   306
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
   307
        # 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
   308
        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
   309
aeabe6bed55b Reverted r1819 and making an application will now reserve the link_id indefinitely.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1205
diff changeset
   310
        # 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
   311
        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
   312
            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
   313
          # 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
   314
          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
   315
          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
   316
          # 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
   317
          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
   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
        # 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
   320
        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
   321
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
        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
   323
          # 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
   324
          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
   325
          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
   326
          # 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
   327
          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
   328
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
      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
   330
  return wrapper