← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/webapp/base/forms.py

  • Committer: William Grant
  • Date: 2010-02-24 07:22:43 UTC
  • Revision ID: grantw@unimelb.edu.au-20100224072243-xq5w2we8iuoteen1
Reword and reformat the tour a bit.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/base/forms.py
 
1
# IVLE
 
2
# Copyright (C) 2010 The University of Melbourne
 
3
#
 
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.
 
8
#
 
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.
 
13
#
 
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
 
17
 
 
18
import re
 
19
 
 
20
import formencode
 
21
import formencode.validators
 
22
from genshi.filters import HTMLFormFiller
 
23
 
 
24
from ivle.webapp.base.xhtml import XHTMLView
 
25
 
 
26
 
 
27
class BaseFormView(XHTMLView):
 
28
    """A base form view."""
 
29
 
 
30
    @property
 
31
    def validator(self):
 
32
        """The FormEncode validator to use.
 
33
 
 
34
        The request will be passed in as state, after potentially being
 
35
        modified by populate_state().
 
36
        """
 
37
        raise NotImplementedError()
 
38
 
 
39
    def populate_state(self, state):
 
40
        """Populate the state given to the FormEncode validator.
 
41
 
 
42
        Subclasses can override this and set additional attributes.
 
43
        """
 
44
        pass
 
45
 
 
46
    def get_return_url(self, obj):
 
47
        """Return the URL to which the completed form should redirect.
 
48
 
 
49
        By default this will redirect to the saved object.
 
50
        """
 
51
        return self.req.publisher.generate(obj)
 
52
 
 
53
    def get_default_data(self, req):
 
54
        """Return a dict mapping field names to default form values.
 
55
 
 
56
        For an edit form, this should return the object's existing data.
 
57
        For a creation form, this should probably return an empty dict.
 
58
 
 
59
        This must be overridden by subclasses.
 
60
        """
 
61
        raise NotImplementedError()
 
62
 
 
63
    def save_object(self, req, data):
 
64
        """Take the validated form data and turn it into an object.
 
65
 
 
66
        The object must then be returned.
 
67
 
 
68
        For an edit form, this should just overwrite data on an existing
 
69
        object.
 
70
        For a creation form, this should create a new object with the given
 
71
        data and add it to the request's store.
 
72
        """
 
73
        raise NotImplementedError()
 
74
 
 
75
    def filter(self, stream, ctx):
 
76
        return stream | HTMLFormFiller(data=ctx['data'])
 
77
 
 
78
    def populate(self, req, ctx):
 
79
        if req.method == 'POST':
 
80
            data = dict(req.get_fieldstorage())
 
81
            try:
 
82
                self.populate_state(req)
 
83
                data = self.validator.to_python(data, state=req)
 
84
 
 
85
                obj = self.save_object(req, data)
 
86
 
 
87
                req.store.commit()
 
88
                req.throw_redirect(self.get_return_url(obj))
 
89
            except formencode.Invalid, e:
 
90
                error_value = e.msg
 
91
                errors = e.unpack_errors()
 
92
        else:
 
93
            data = self.get_default_data(req)
 
94
            error_value = None
 
95
            errors = {}
 
96
 
 
97
        if errors:
 
98
            req.store.rollback()
 
99
 
 
100
        ctx['req'] = req
 
101
        ctx['context'] = self.context
 
102
        ctx['data'] = data or {}
 
103
        ctx['errors'] = errors
 
104
        # If all of the fields validated, set the global form error.
 
105
        if isinstance(errors, basestring):
 
106
            ctx['error_value'] = errors
 
107
 
 
108
 
 
109
VALID_URL_NAME = re.compile(r'^[a-z0-9][a-z0-9_\+\.\-]*$')
 
110
 
 
111
 
 
112
class URLNameValidator(formencode.validators.UnicodeString):
 
113
    def validate_python(self, value, state):
 
114
        super(URLNameValidator, self).validate_python(value, state)
 
115
        if not VALID_URL_NAME.match(value):
 
116
            raise formencode.Invalid(
 
117
                'Must consist of a lowercase alphanumeric character followed '
 
118
                'by any number of lowercase alphanumerics, ., +, - or _.',
 
119
                value, state)