← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/webapp/admin/subject.py

  • Committer: William Grant
  • Date: 2009-04-28 07:22:03 UTC
  • Revision ID: grantw@unimelb.edu.au-20090428072203-j5ratziusj3kv4tq
Allow template string interpolation in the config.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/admin/subject.py
 
1
# IVLE
 
2
# Copyright (C) 2007-2008 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
# App: subjects
 
19
# Author: Matt Giuca
 
20
# Date: 29/2/2008
 
21
 
 
22
# This is an IVLE application.
 
23
# A sample / testing application for IVLE.
 
24
 
 
25
import os
 
26
import urllib
 
27
import cgi
 
28
 
 
29
from storm.locals import Desc
 
30
from genshi.filters import HTMLFormFiller
 
31
import formencode
 
32
 
 
33
from ivle.webapp.base.xhtml import XHTMLView
 
34
from ivle.webapp.base.plugins import ViewPlugin, MediaPlugin
 
35
from ivle.webapp.errors import NotFound
 
36
from ivle.database import Subject, Semester, Offering, Enrolment, User
 
37
 
 
38
 
 
39
class SubjectsView(XHTMLView):
 
40
    '''The view of the list of subjects.'''
 
41
    template = 'subjects.html'
 
42
    tab = 'subjects'
 
43
 
 
44
    def authorize(self, req):
 
45
        return req.user is not None
 
46
 
 
47
    def populate(self, req, ctx):
 
48
        ctx['user'] = req.user
 
49
        ctx['semesters'] = []
 
50
        for semester in req.store.find(Semester).order_by(Desc(Semester.year),
 
51
                                                     Desc(Semester.semester)):
 
52
            enrolments = semester.enrolments.find(user=req.user)
 
53
            if enrolments.count():
 
54
                ctx['semesters'].append((semester, enrolments))
 
55
 
 
56
 
 
57
class UserValidator(formencode.FancyValidator):
 
58
    """A FormEncode validator that turns a username into a user.
 
59
 
 
60
    The state must have a 'store' attribute, which is the Storm store
 
61
    to use."""
 
62
    def _to_python(self, value, state):
 
63
        user = User.get_by_login(state.store, value)
 
64
        if user:
 
65
            return user
 
66
        else:
 
67
            raise formencode.Invalid('User does not exist', value, state)
 
68
 
 
69
 
 
70
class NoEnrolmentValidator(formencode.FancyValidator):
 
71
    """A FormEncode validator that ensures absence of an enrolment.
 
72
 
 
73
    The state must have an 'offering' attribute.
 
74
    """
 
75
    def _to_python(self, value, state):
 
76
        if state.offering.get_enrolment(value):
 
77
            raise formencode.Invalid('User already enrolled', value, state)
 
78
        return value
 
79
 
 
80
 
 
81
class EnrolSchema(formencode.Schema):
 
82
    user = formencode.All(NoEnrolmentValidator(), UserValidator())
 
83
 
 
84
 
 
85
class EnrolView(XHTMLView):
 
86
    """A form to enrol a user in an offering."""
 
87
    template = 'enrol.html'
 
88
    tab = 'subjects'
 
89
    permission = 'edit'
 
90
 
 
91
    def __init__(self, req, subject, year, semester):
 
92
        """Find the given offering by subject, year and semester."""
 
93
        self.context = req.store.find(Offering,
 
94
            Offering.subject_id == Subject.id,
 
95
            Subject.short_name == subject,
 
96
            Offering.semester_id == Semester.id,
 
97
            Semester.year == year,
 
98
            Semester.semester == semester).one()
 
99
 
 
100
        if not self.context:
 
101
            raise NotFound()
 
102
 
 
103
    def filter(self, stream, ctx):
 
104
        return stream | HTMLFormFiller(data=ctx['data'])
 
105
 
 
106
    def populate(self, req, ctx):
 
107
        if req.method == 'POST':
 
108
            data = dict(req.get_fieldstorage())
 
109
            try:
 
110
                validator = EnrolSchema()
 
111
                req.offering = self.context # XXX: Getting into state.
 
112
                data = validator.to_python(data, state=req)
 
113
                self.context.enrol(data['user'])
 
114
                req.store.commit()
 
115
                req.throw_redirect(req.uri)
 
116
            except formencode.Invalid, e:
 
117
                errors = e.unpack_errors()
 
118
        else:
 
119
            data = {}
 
120
            errors = {}
 
121
 
 
122
        ctx['data'] = data or {}
 
123
        ctx['offering'] = self.context
 
124
        ctx['errors'] = errors
 
125
 
 
126
 
 
127
class Plugin(ViewPlugin, MediaPlugin):
 
128
    urls = [
 
129
        ('subjects/', SubjectsView),
 
130
        ('subjects/:subject/:year/:semester/+enrolments/+new', EnrolView),
 
131
    ]
 
132
 
 
133
    tabs = [
 
134
        ('subjects', 'Subjects',
 
135
         'View subject content and complete worksheets',
 
136
         'subjects.png', 'subjects', 5)
 
137
    ]
 
138
 
 
139
    media = 'subject-media'