2
# Copyright (C) 2010 The University of Melbourne
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22
import formencode.validators
23
from genshi.filters import HTMLFormFiller
25
from ivle.webapp.base.xhtml import XHTMLView
28
class BaseFormView(XHTMLView):
29
"""A base form view."""
33
"""The FormEncode validator to use.
35
The request will be passed in as state, after potentially being
36
modified by populate_state().
38
raise NotImplementedError()
40
def populate_state(self, state):
41
"""Populate the state given to the FormEncode validator.
43
Subclasses can override this and set additional attributes.
47
def get_return_url(self, obj):
48
"""Return the URL to which the completed form should redirect.
50
By default this will redirect to the saved object.
52
return self.req.publisher.generate(obj)
54
def get_default_data(self, req):
55
"""Return a dict mapping field names to default form values.
57
For an edit form, this should return the object's existing data.
58
For a creation form, this should probably return an empty dict.
60
This must be overridden by subclasses.
62
raise NotImplementedError()
64
def save_object(self, req, data):
65
"""Take the validated form data and turn it into an object.
67
The object must then be returned.
69
For an edit form, this should just overwrite data on an existing
71
For a creation form, this should create a new object with the given
72
data and add it to the request's store.
74
raise NotImplementedError()
76
def filter(self, stream, ctx):
77
return stream | HTMLFormFiller(data=ctx['data'])
79
def populate(self, req, ctx):
80
if req.method == 'POST':
81
data = dict(req.get_fieldstorage())
83
self.populate_state(req)
84
data = self.validator.to_python(data, state=req)
86
obj = self.save_object(req, data)
89
req.throw_redirect(self.get_return_url(obj))
90
except formencode.Invalid, e:
92
errors = e.unpack_errors()
94
data = self.get_default_data(req)
102
ctx['context'] = self.context
103
ctx['data'] = data or {}
104
ctx['errors'] = errors
105
# If all of the fields validated, set the global form error.
106
if isinstance(errors, basestring):
107
ctx['error_value'] = errors
110
VALID_URL_NAME = re.compile(r'^[a-z0-9][a-z0-9_\+\.\-]*$')
113
class URLNameValidator(formencode.validators.UnicodeString):
114
def validate_python(self, value, state):
115
super(URLNameValidator, self).validate_python(value, state)
116
if not VALID_URL_NAME.match(value):
117
raise formencode.Invalid(
118
'Must consist of a lowercase alphanumeric character followed '
119
'by any number of lowercase alphanumerics, ., +, - or _.',
122
class DateTimeValidator(formencode.validators.FancyValidator):
123
"""Accepts a date/time in YYYY-MM-DD HH:MM:SS format. Converts to a
124
datetime.datetime object."""
125
def _to_python(self, value, state):
126
"""Validate and convert."""
128
return datetime.datetime.strptime(value, "%Y-%m-%d %H:%M:%S")
129
except ValueError, e:
130
raise formencode.Invalid("Must be a timestamp in "
131
"YYYY-MM-DD HH:MM:SS format", value, state)
132
def _from_python(self, value, state):
134
return value.strftime("%Y-%m-%d %H:%M:%S")
135
except AttributeError:
136
raise formencode.Invalid("Must be a datetime.datetime object")
added
removed
ivle/webapp/base/forms.py
