← 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-12 03:16:41 UTC
  • Revision ID: grantw@unimelb.edu.au-20100212031641-8gajjv95z7illqa9
Move BaseFormView into ivle.webapp.base.forms.

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 formencode
 
19
from genshi.filters import HTMLFormFiller
 
20
 
 
21
from ivle.webapp.base.xhtml import XHTMLView
 
22
 
 
23
class BaseFormView(XHTMLView):
 
24
    """A base form view."""
 
25
 
 
26
    def filter(self, stream, ctx):
 
27
        return stream | HTMLFormFiller(data=ctx['data'])
 
28
 
 
29
    def populate_state(self, state):
 
30
        pass
 
31
 
 
32
    def get_return_url(self, obj):
 
33
        return self.req.publisher.generate(obj)
 
34
 
 
35
    def get_default_data(self, req):
 
36
        raise NotImplementedError()
 
37
 
 
38
    def save_object(self, req, data):
 
39
        raise NotImplementedError()
 
40
 
 
41
    @property
 
42
    def validator(self):
 
43
        raise NotImplementedError()
 
44
 
 
45
    def populate(self, req, ctx):
 
46
        if req.method == 'POST':
 
47
            data = dict(req.get_fieldstorage())
 
48
            try:
 
49
                self.populate_state(req)
 
50
                data = self.validator.to_python(data, state=req)
 
51
 
 
52
                obj = self.save_object(req, data)
 
53
 
 
54
                req.store.commit()
 
55
                req.throw_redirect(self.get_return_url(obj))
 
56
            except formencode.Invalid, e:
 
57
                error_value = e.msg
 
58
                errors = e.unpack_errors()
 
59
        else:
 
60
            data = self.get_default_data(req)
 
61
            error_value = None
 
62
            errors = {}
 
63
 
 
64
        if errors:
 
65
            req.store.rollback()
 
66
 
 
67
        ctx['req'] = req
 
68
        ctx['context'] = self.context
 
69
        ctx['data'] = data or {}
 
70
        ctx['errors'] = errors
 
71
        # If all of the fields validated, set the global form error.
 
72
        if isinstance(errors, basestring):
 
73
            ctx['error_value'] = errors
 
74
 
 
75