app/soc/logic/cleaning.py
author Pawel Solyga <Pawel.Solyga@gmail.com>
Tue, 28 Apr 2009 12:47:06 +0200
changeset 2282 47a7eb2704c2
parent 2115 fafd021def7e
child 2327 6c7d0fba105c
permissions -rw-r--r--
Remove E1103 and E1101 errors from ignore list in pylintrc file. We are going to use "# pylint disable-msg=E1103" comments in the source file itself to ignore false-positives. Patch by: Pawel Solyga 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
1446
bcbbcb72429d Use feedparser to sanitize HTML content for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1440
diff changeset
    27
import feedparser
bcbbcb72429d Use feedparser to sanitize HTML content for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1440
diff changeset
    28
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
    29
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
    30
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    31
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
    32
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
    33
from django.utils.translation import ugettext
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    34
1354
aba2beea6dfa Fix import sorting in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1333
diff changeset
    35
from soc.logic import rights as rights_logic
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    36
from soc.logic import validate
1699
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
    37
from soc.logic.models import document as document_logic
1680
fbf8101f6eff Import user and site logic globals directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1621
diff changeset
    38
from soc.logic.models.site import logic as site_logic
fbf8101f6eff Import user and site logic globals directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1621
diff changeset
    39
from soc.logic.models.user import logic as user_logic
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
    40
from soc.models import document as document_model
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    41
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
    42
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
    43
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
    44
    '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
    45
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
    46
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
    47
    '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
    48
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
    49
DEF_ORGANZIATION_NOT_ACTIVE_MSG = ugettext(
1472
27c9ae3f8d8b Textual change in cleaing.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1446
diff changeset
    50
    "This organization is not active or doesn't exist.")
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
    51
1699
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
    52
DEF_NO_SUCH_DOCUMENT_MSG = ugettext(
1768
3177f83c1e50 Typo fix in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1755
diff changeset
    53
    "There is no such document with that link ID under this entity.")
1699
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
    54
2029
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
    55
DEF_MUST_BE_ABOVE_LIMIT_FMT = ugettext(
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
    56
    "Must be at least %d characters, it has %d characters.")
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
    57
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
    58
DEF_MUST_BE_UNDER_LIMIT_FMT = ugettext(
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
    59
    "Must be under %d characters, it has %d characters.")
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
    60
1699
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
    61
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    62
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
    63
  """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
    64
  """
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    65
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    66
  def decorator(fun):
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    67
    """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
    68
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    69
    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
    70
    """
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    71
    from functools import wraps
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
    @wraps(fun)
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    74
    def wrapper(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
    75
      """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
    76
      """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    77
      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
    78
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    79
      if not field_content:
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    80
        # 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
    81
        return None
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    82
      else:
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    83
        # field has contents
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    84
        return fun(self)
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    85
    return wrapper
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    86
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    87
  return decorator
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    88
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
    89
1395
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    90
def clean_empty_field(field_name):
1935
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
    91
  """Incorporates the check_field_is_empty as regular cleaner.
1395
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    92
  """
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    93
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    94
  @check_field_is_empty(field_name)
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    95
  def wrapper(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
    96
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
    97
    """
1395
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    98
    return self.cleaned_data.get(field_name)
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
    99
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
   100
  return wrapper
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
   101
08dbb5aa1dc9 Add a regular 'empty field cleaner'
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1354
diff changeset
   102
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
   103
def clean_link_id(field_name):
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   104
  """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
   105
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   106
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   107
  @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
   108
  def wrapper(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   109
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   110
    """
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
   111
    # 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
   112
    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
   113
    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
   114
      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
   115
    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
   116
  return wrapper
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   117
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   118
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   119
def clean_scope_path(field_name):
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   120
  """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
   121
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   122
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   123
  @check_field_is_empty(field_name)
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   124
  def wrapper(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   125
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   126
    """
1088
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   127
    # convert to lowercase for user comfort
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   128
    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
   129
    if not validate.isScopePathFormatValid(scope_path):
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   130
      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
   131
    return scope_path
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   132
  return wrapper
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   133
7ad48d59da3d Added a clean_scope_path to cleaning
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1085
diff changeset
   134
1039
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   135
def clean_agrees_to_tos(field_name):
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   136
  """Checks if there is a ToS to see if it is allowed to leave
1039
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   137
     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
   138
  """
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   139
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   140
  @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
   141
  def wrapper(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   142
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   143
    """
1039
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   144
    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
   145
1773
ad930f979ed9 Fix typo in soc.logic.cleaning module (site_logic.logic was called instead of just site_logic).
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1768
diff changeset
   146
    if not site_logic.getToS(site_logic.getSingleton()):
1039
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   147
      return agrees_to_tos
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   148
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   149
    # 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
   150
    if agrees_to_tos:
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   151
      return True
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   152
1039
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   153
    # 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
   154
    raise forms.ValidationError(
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   155
        '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
   156
        ' on this site.')
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   157
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   158
  return wrapper
d53b963b1454 Added new clean_agrees_to_tos to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1028
diff changeset
   159
1143
b07b7d5b3e27 Fix missing dots and blank lines to soc.logic modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1088
diff changeset
   160
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   161
def clean_existing_user(field_name):
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   162
  """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
   163
  """
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   164
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   165
  @check_field_is_empty(field_name)
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   166
  def wrapped(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   167
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   168
    """
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
   169
    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
   170
1984
eb02fd5427c5 Use getFromKeyFields instead of getForFields where possible
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1962
diff changeset
   171
    user_entity = user_logic.getFromKeyFields({'link_id': 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
   172
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   173
    if not user_entity:
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   174
      # 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
   175
      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
   176
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   177
    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
   178
  return wrapped
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   179
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   180
1985
4ff03ca639fd Optionally return link_id in clean_user_is_current
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1984
diff changeset
   181
def clean_user_is_current(field_name, as_user=True):
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   182
  """Check if the field_name value is a valid link_id and resembles the
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   183
     current user.
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   184
  """
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   185
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   186
  @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
   187
  def wrapped(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   188
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   189
    """
1333
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   190
    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
   191
1680
fbf8101f6eff Import user and site logic globals directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1621
diff changeset
   192
    user_entity = user_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
   193
c0ff6fc3192e Added clean_user_is_current to cleaning and fixed some indentation.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1320
diff changeset
   194
    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
   195
      # 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
   196
      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
   197
1985
4ff03ca639fd Optionally return link_id in clean_user_is_current
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1984
diff changeset
   198
    return user_entity if as_user else link_id
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   199
  return wrapped
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   200
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   201
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   202
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
   203
  """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
   204
     link id does not exist.
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   205
  """
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   206
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   207
  @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
   208
  def wrapped(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   209
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   210
    """
1079
be1aacb33b0f Changed clean_link_id to be in a wrapper form as well.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1039
diff changeset
   211
    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
   212
1984
eb02fd5427c5 Use getFromKeyFields instead of getForFields where possible
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1962
diff changeset
   213
    user_entity = user_logic.getFromKeyFields({'link_id': 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
   214
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   215
    if user_entity:
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   216
      # user exists already
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   217
      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
   218
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   219
    return link_id
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   220
  return wrapped
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   221
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   222
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
   223
def clean_users_not_same(field_name):
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   224
  """Check if the field_name field is a valid user and is not
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
   225
     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
   226
  """
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
   227
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   228
  @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
   229
  def wrapped(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   230
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   231
    """
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
   232
    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
   233
    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
   234
1680
fbf8101f6eff Import user and site logic globals directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1621
diff changeset
   235
    current_user_entity = user_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
   236
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
   237
    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
   238
      # users are equal
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   239
      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
   240
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
   241
    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
   242
  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
   243
788
892877b7db07 Factored out the clean_existing_user method
Sverre Rabbelier <srabbelier@gmail.com>
parents: 650
diff changeset
   244
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   245
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
   246
  """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
   247
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   248
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   249
  @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
   250
  def wrapped(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   251
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   252
    """
1522
983b126f5aca Always normalize accounts, before even storing them
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1472
diff changeset
   253
    email_adress = self.cleaned_data[field_name]
983b126f5aca Always normalize accounts, before even storing them
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1472
diff changeset
   254
    return users.User(email_adress)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   255
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   256
  return wrapped
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
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   259
def clean_user_account_not_in_use(field_name):
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   260
  """Check if the field_name value contains an email
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   261
     address that hasn't been used for an existing account.
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   262
  """
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   263
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   264
  @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
   265
  def wrapped(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   266
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   267
    """
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   268
    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
   269
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   270
    # 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
   271
    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
   272
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   273
    fields = {'account': user_account}
1680
fbf8101f6eff Import user and site logic globals directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1621
diff changeset
   274
    user_entity = user_logic.getForFields(fields, unique=True)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   275
1680
fbf8101f6eff Import user and site logic globals directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1621
diff changeset
   276
    if user_entity or user_logic.isFormerAccount(user_account):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   277
      raise forms.ValidationError("There is already a user "
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   278
          "with this email adress.")
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   279
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   280
    return user_account
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   281
  return wrapped
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   282
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   283
1722
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   284
def clean_ascii_only(field_name):
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   285
  """Clean method for cleaning a field that may only contain ASCII-characters.
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   286
  """
1962
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   287
1722
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   288
  @check_field_is_empty(field_name)
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   289
  def wrapper(self):
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   290
    """Decorator wrapper method.
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   291
    """
1962
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   292
1722
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   293
    value = self.cleaned_data.get(field_name)
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   294
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   295
    try:
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   296
      # encode to ASCII
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   297
      value = value.encode("ascii")
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   298
    except UnicodeEncodeError:
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   299
      # can not encode as ASCII
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   300
      raise forms.ValidationError("Only ASCII characters are allowed")
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   301
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   302
    return value
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   303
  return wrapper
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   304
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   305
2029
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   306
def clean_content_length(field_name, min_length=0, max_length=500):
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   307
  """Clean method for cleaning a field which must contain at least min and
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   308
     not more then max length characters.
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   309
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   310
  Args:
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   311
    field_name: the name of the field needed cleaning
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   312
    min_length: the minimum amount of allowed characters
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   313
    max_length: the maximum amount of allowed characters
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   314
  """
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   315
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   316
  @check_field_is_empty(field_name)
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   317
  def wrapper(self):
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   318
    """Decorator wrapper method.
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   319
    """
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   320
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   321
    value = self.cleaned_data[field_name]
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   322
    value_length = len(value)
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   323
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   324
    if value_length < min_length:
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   325
      raise forms.ValidationError(DEF_MUST_BE_ABOVE_LIMIT_FMT %(
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   326
          min_length, value_length))
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   327
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   328
    if value_length > max_length:
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   329
      raise forms.ValidationError(DEF_MUST_BE_UNDER_LIMIT_FMT %(
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   330
          max_length, value_length))
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   331
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   332
    return value
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   333
  return wrapper
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   334
1f276091b42a Added clean_content_length method to clean content of a specific size.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2014
diff changeset
   335
1990
fea8bdb43992 Automagically convert '+' to '00' in phone numbers
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1988
diff changeset
   336
def clean_phone_number(field_name):
1962
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   337
  """Clean method for cleaning a field that may only contain numerical values.
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   338
  """
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   339
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   340
  @check_field_is_empty(field_name)
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   341
  def wrapper(self):
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   342
    """Decorator wrapped method.
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   343
    """
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   344
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   345
    value = self.cleaned_data.get(field_name)
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   346
1990
fea8bdb43992 Automagically convert '+' to '00' in phone numbers
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1988
diff changeset
   347
    # allow for a '+' prefix which means '00'
fea8bdb43992 Automagically convert '+' to '00' in phone numbers
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1988
diff changeset
   348
    if value[0] == '+':
fea8bdb43992 Automagically convert '+' to '00' in phone numbers
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1988
diff changeset
   349
      value = '00' + value[1:]
fea8bdb43992 Automagically convert '+' to '00' in phone numbers
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1988
diff changeset
   350
1962
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   351
    if not value.isdigit():
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   352
      raise forms.ValidationError("Only numerical characters are allowed")
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   353
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   354
    return value
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   355
  return wrapper
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   356
7c9e517f2089 Added a numeric_only cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1935
diff changeset
   357
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   358
def clean_feed_url(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   359
  """Clean method for cleaning feed url.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   360
  """
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   361
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   362
  feed_url = self.cleaned_data.get('feed_url')
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   363
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   364
  if feed_url == '':
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   365
    # 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
   366
    return None
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   367
601
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   368
  if not validate.isFeedURLValid(feed_url):
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   369
    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
   370
988f8a8cd6de Added a cleaning module
Sverre Rabbelier <srabbelier@gmail.com>
parents:
diff changeset
   371
  return feed_url
898
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   372
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   373
1682
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   374
def clean_html_content(field_name):
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   375
  """Clean method for cleaning HTML content.
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   376
  """
1682
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   377
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   378
  @check_field_is_empty(field_name)
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   379
  def wrapped(self):
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   380
    """Decorator wrapper method.
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   381
    """
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   382
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   383
    content = self.cleaned_data.get(field_name)
1446
bcbbcb72429d Use feedparser to sanitize HTML content for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1440
diff changeset
   384
1682
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   385
    if user_logic.isDeveloper():
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   386
      return content
1446
bcbbcb72429d Use feedparser to sanitize HTML content for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1440
diff changeset
   387
1682
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   388
    sanitizer = feedparser._HTMLSanitizer('utf-8')
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   389
    sanitizer.feed(content)
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   390
    content = sanitizer.output()
2014
e6d297dcf7aa Add missing utf decode in html cleaner in soc.logic.cleaning module. This should fix all the 500 errors that we got. Remove extra blank line in soc.views.model.document.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1990
diff changeset
   391
    content = content.decode('utf-8')
1682
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   392
    content = content.strip().replace('\r\n', '\n')
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   393
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   394
    return content
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   395
242ca517c340 Make clean_document_content generic
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1681
diff changeset
   396
  return wrapped
1446
bcbbcb72429d Use feedparser to sanitize HTML content for documents
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1440
diff changeset
   397
1722
7f285e96cb17 All address fields for roles and groups can now only use characters that can successfully be converted to ASCII.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1699
diff changeset
   398
898
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   399
def clean_url(field_name):
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   400
  """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
   401
  """
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   402
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   403
  @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
   404
  def wrapped(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   405
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   406
    """
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   407
898
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   408
    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
   409
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   410
    # call the Django URLField cleaning method to
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   411
    # properly clean/validate this field
967
be5f5533a07f Changed clean_url to work with dynaform.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 928
diff changeset
   412
    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
   413
  return wrapped
adf5b7e98dcf Added a cleaning method for a LinkProperty Field.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 886
diff changeset
   414
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   415
1699
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   416
def clean_refs(params, fields):
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   417
  """Cleans all references to make sure they are valid.
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   418
  """
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   419
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   420
  logic = params['logic']
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   421
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   422
  def wrapped(self):
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   423
    """Decorator wrapper method.
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   424
    """
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   425
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   426
    scope_path = logic.getKeyNameFromFields(self.cleaned_data)
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   427
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   428
    key_fields = {
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   429
        'scope_path': scope_path,
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   430
        'prefix': params['document_prefix'],
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   431
        }
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   432
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   433
    for field in fields:
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   434
      link_id = self.cleaned_data.get(field)
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   435
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   436
      if not link_id:
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   437
        continue
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   438
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   439
      key_fields['link_id'] = link_id
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   440
      ref = document_logic.logic.getFromKeyFields(key_fields)
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   441
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   442
      if not ref:
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   443
        self._errors[field] = ErrorList([DEF_NO_SUCH_DOCUMENT_MSG])
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   444
        del self.cleaned_data[field]
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   445
      else:
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   446
        self.cleaned_data['resolved_%s' % field] = ref
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   447
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   448
    return self.cleaned_data
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   449
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   450
  return wrapped
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   451
699f65fbf08a Add a document ref cleaner
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1682
diff changeset
   452
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   453
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
   454
  """Clean method for cleaning user edit form.
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   455
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   456
  Raises ValidationError if:
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   457
    -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
   458
    -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
   459
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   460
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   461
  def wrapper(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   462
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   463
    """
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   464
    cleaned_data = self.cleaned_data
1242
c5ca70606850 Handle GAE account normalization
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1217
diff changeset
   465
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   466
    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
   467
    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
   468
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   469
    # 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
   470
    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
   471
      # get the user from the link_id in the form
1984
eb02fd5427c5 Use getFromKeyFields instead of getForFields where possible
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1962
diff changeset
   472
eb02fd5427c5 Use getFromKeyFields instead of getForFields where possible
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1962
diff changeset
   473
      user_entity = user_logic.getFromKeyFields({'link_id': link_id})
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   474
1285
d54f2d80f46e Fixed comment and typo in cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1242
diff changeset
   475
      # if it's not the user's current account
1242
c5ca70606850 Handle GAE account normalization
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1217
diff changeset
   476
      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
   477
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   478
        # 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
   479
        fields = {'account': user_account}
1680
fbf8101f6eff Import user and site logic globals directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1621
diff changeset
   480
        user_from_account_entity = user_logic.getForFields(fields,
1028
43fdf6739e8d Style fixes in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1013
diff changeset
   481
            unique=True)
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   482
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   483
        # if there is a user with the given account or it's a former account
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   484
        if user_from_account_entity or \
1680
fbf8101f6eff Import user and site logic globals directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1621
diff changeset
   485
            user_logic.isFormerAccount(user_account):
1013
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   486
          # raise an error because this email address can't be used
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   487
          raise forms.ValidationError("There is already a user with "
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   488
              "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
   489
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   490
    return cleaned_data
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   491
  return wrapper
68c52d6b3fb4 Added new clean methods in preparation for new User View.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 967
diff changeset
   492
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
   493
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   494
def validate_new_group(link_id_field, scope_path_field,
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
   495
                       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
   496
  """Clean method used to clean the group application or new group form.
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   497
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
   498
    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
   499
    -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
   500
    -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
   501
  """
1287
9b18d612510a Added check_field_is_empty decorator to cleaning.py.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1285
diff changeset
   502
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
   503
  def wrapper(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   504
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   505
    """
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   506
    cleaned_data = self.cleaned_data
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
   507
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   508
    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
   509
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   510
    link_id = cleaned_data.get(link_id_field)
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
   511
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   512
    if link_id:
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   513
      fields['link_id'] = link_id
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
   514
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   515
      scope_path = cleaned_data.get(scope_path_field)
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   516
      if scope_path:
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   517
        fields['scope_path'] = scope_path
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
   518
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   519
      # get the application
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   520
      group_app_entity = group_app_logic.logic.getForFields(fields, unique=True)
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   521
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   522
      # get the current user
1680
fbf8101f6eff Import user and site logic globals directly
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1621
diff changeset
   523
      user_entity = user_logic.getForCurrentAccount()
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
   524
1755
972c546f0810 Fixed a cleaning bug which allowed a proposal to be recreated by the original proposer.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1722
diff changeset
   525
      # if the proposal has not been accepted or it's not the applicant
972c546f0810 Fixed a cleaning bug which allowed a proposal to be recreated by the original proposer.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1722
diff changeset
   526
      # creating the new group then show link ID in use message
972c546f0810 Fixed a cleaning bug which allowed a proposal to be recreated by the original proposer.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1722
diff changeset
   527
      if group_app_entity and (group_app_entity.status != 'accepted' or (
972c546f0810 Fixed a cleaning bug which allowed a proposal to be recreated by the original proposer.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1722
diff changeset
   528
          group_app_entity.applicant.key() != user_entity.key())):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   529
        # add the error message to the link id field
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   530
        self._errors[link_id_field] = ErrorList([DEF_LINK_ID_IN_USE_MSG])
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   531
        del cleaned_data[link_id_field]
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   532
        # return the new cleaned_data
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   533
        return cleaned_data
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
   534
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   535
      # check if there is already a group for the given fields
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   536
      group_entity = group_logic.logic.getForFields(fields, unique=True)
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
   537
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   538
      if group_entity:
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   539
        # add the error message to the link id field
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   540
        self._errors[link_id_field] = ErrorList([DEF_LINK_ID_IN_USE_MSG])
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   541
        del cleaned_data[link_id_field]
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   542
        # return the new cleaned_data
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   543
        return cleaned_data
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
   544
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   545
    return cleaned_data
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
   546
  return wrapper
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   547
1425
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   548
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
   549
                              student_logic, org_logic):
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   550
  """Validates the form of a student proposal.
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   551
1425
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   552
  Raises ValidationError if:
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   553
    -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
   554
    -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
   555
  """
1681
b0e10552f5c2 Fix some whitespace damadge
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1680
diff changeset
   556
1425
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   557
  def wrapper(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   558
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   559
    """
1425
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   560
    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
   561
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   562
    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
   563
    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
   564
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   565
    # 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
   566
    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
   567
      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
   568
                'status': 'active'}
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   569
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   570
      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
   571
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   572
      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
   573
        # 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
   574
        raise forms.ValidationError(
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   575
            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
   576
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   577
      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
   578
                'scope': student_entity.scope,
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   579
                'status': 'active'}
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   580
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   581
      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
   582
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   583
      if not org_entity:
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   584
        #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
   585
        self._errors['organization'] = ErrorList(
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   586
            [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
   587
        del cleaned_data['organization']
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   588
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   589
    return cleaned_data
49d385edb6b4 Added new cleaning method to validate a student proposal.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1395
diff changeset
   590
  return wrapper
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   591
2115
fafd021def7e Major update to the views concerning StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2073
diff changeset
   592
def validate_student_project(org_field, mentor_field, student_field):
1935
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   593
  """Validates the form of a student proposal.
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   594
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   595
  Args:
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   596
    org_field: Field containing key_name for org
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   597
    mentor_field: Field containing the link_id of the mentor
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   598
    student_field: Field containing the student link_id
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   599
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   600
  Raises ValidationError if:
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   601
    -A valid Organization does not exist for the given keyname
2115
fafd021def7e Major update to the views concerning StudentProjects.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 2073
diff changeset
   602
    -The mentor link_id does not match a mentor for the active organization
1935
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   603
    -The student link_id does not match a student in the org's Program
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   604
  """
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   605
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   606
  def wrapper(self):
2073
6eb9b4652c80 Style fixes and removal of unused imports in soc.logic modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2029
diff changeset
   607
    """Decorator wrapper method.
6eb9b4652c80 Style fixes and removal of unused imports in soc.logic modules.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 2029
diff changeset
   608
    """
1935
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   609
    from soc.logic.models.mentor import logic as mentor_logic
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   610
    from soc.logic.models.organization import logic as org_logic
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   611
    from soc.logic.models.student import logic as student_logic
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   612
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   613
    cleaned_data = self.cleaned_data
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   614
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   615
    org_key_name = cleaned_data.get(org_field)
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   616
    mentor_link_id = cleaned_data.get(mentor_field)
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   617
    student_link_id = cleaned_data.get(student_field)
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   618
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   619
    if not (org_key_name and mentor_link_id and student_link_id):
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   620
      # we can't do the check the other cleaners will pickup empty fields
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   621
      return cleaned_data
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   622
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   623
    org_entity = org_logic.getFromKeyName(org_key_name)
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   624
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   625
    if not org_entity:
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   626
      # show error message
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   627
      raise forms.ValidationError(
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   628
          ugettext("The given Organization is not valid."))
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   629
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   630
    fields = {'link_id': mentor_link_id,
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   631
              'scope': org_entity,
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   632
              'status': 'active'}
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   633
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   634
    mentor_entity = mentor_logic.getForFields(fields, unique=True,)
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   635
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   636
    if not mentor_entity:
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   637
      # show error message
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   638
      raise forms.ValidationError(
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   639
          ugettext("The given Mentor is not valid."))
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   640
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   641
    fields = {'link_id': student_link_id,
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   642
              'scope': org_entity.scope,
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   643
              'status': 'active'}
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   644
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   645
    student_entity = student_logic.getForFields(fields, unique=True)
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   646
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   647
    if not student_entity:
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   648
      #show error message
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   649
      raise forms.ValidationError(
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   650
          ugettext("The given Student is not valid."))
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   651
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   652
    # successfully validated
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   653
    return cleaned_data
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   654
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   655
  return wrapper
99ec4bbd70f5 Added new Student Project cleaning method.
Lennard de Rijk <ljvderijk@gmail.com>
parents: 1773
diff changeset
   656
1988
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   657
def validate_document_acl(view, creating=False):
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   658
  """Validates that the document ACL settings are correct.
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   659
  """
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   660
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   661
  def wrapper(self):
1621
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   662
    """Decorator wrapper method.
106a5a7834d0 Add missing docstrings, fix indentions and too long lines in soc.logic.cleaning module.
Pawel Solyga <Pawel.Solyga@gmail.com>
parents: 1522
diff changeset
   663
    """
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   664
    cleaned_data = self.cleaned_data
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   665
    read_access = cleaned_data.get('read_access')
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   666
    write_access = cleaned_data.get('write_access')
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   667
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   668
    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
   669
      return cleaned_data
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   670
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   671
    if read_access != 'public':
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   672
      ordening = document_model.Document.DOCUMENT_ACCESS
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   673
      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
   674
        raise forms.ValidationError(
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   675
            "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
   676
1988
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   677
    params = view.getParams()
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   678
    rights = params['rights']
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   679
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   680
    user = user_logic.getForCurrentAccount()
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   681
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   682
    rights.setCurrentUser(user.account, user)
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   683
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   684
    prefix = self.cleaned_data['prefix']
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   685
    scope_path = self.cleaned_data['scope_path']
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   686
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   687
    validate_access(self, view, rights, prefix, scope_path, 'read_access')
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   688
    validate_access(self, view, rights, prefix, scope_path, 'write_access')
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   689
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   690
    if creating and not has_access(rights, 'restricted', scope_path, prefix):
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   691
      raise forms.ValidationError(
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   692
          "You do not have the required access to create this document.")
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   693
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   694
    return cleaned_data
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   695
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   696
  return wrapper
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   697
1988
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   698
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   699
def has_access(rights, access_level, scope_path, prefix):
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   700
  """Checks whether the current user has the required access.
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   701
  """
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   702
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   703
  checker = rights_logic.Checker(prefix)
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   704
  roles = checker.getMembership(access_level)
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   705
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   706
  django_args = {
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   707
      'scope_path': scope_path,
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   708
      'prefix': prefix,
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   709
      }
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   710
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   711
  return rights.hasMembership(roles, django_args)
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   712
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   713
def validate_access(self, view, rights, prefix, scope_path, field):
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   714
  """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
   715
  """
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   716
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   717
  access_level = self.cleaned_data[field]
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   718
1988
d826f7aed8f2 Make sure the user has restricted rights to create a new document
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1985
diff changeset
   719
  if not has_access(rights, access_level, scope_path, prefix):
1311
9836cfc0bb31 Add cleaning methods for document ACL
Sverre Rabbelier <srabbelier@gmail.com>
parents: 1308
diff changeset
   720
    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
   721
    del self.cleaned_data[field]