37
37
from ivle.webapp.base.xhtml import XHTMLView
38
38
from ivle.webapp.base.plugins import ViewPlugin, MediaPlugin
39
from ivle.webapp.errors import NotFound
39
from ivle.webapp import ApplicationRoot
41
41
from ivle.database import Subject, Semester, Offering, Enrolment, User,\
42
42
ProjectSet, Project, ProjectSubmission
43
43
from ivle import util
46
from ivle.webapp.admin.projectservice import ProjectSetRESTView,\
46
from ivle.webapp.admin.projectservice import ProjectSetRESTView
48
47
from ivle.webapp.admin.offeringservice import OfferingRESTView
48
from ivle.webapp.admin.publishing import (root_to_subject,
49
subject_to_offering, offering_to_projectset, offering_to_project,
50
subject_url, offering_url, projectset_url, project_url)
51
from ivle.webapp.admin.breadcrumbs import (SubjectBreadcrumb,
52
OfferingBreadcrumb, UserBreadcrumb, ProjectBreadcrumb)
53
from ivle.webapp.groups import GroupsView
54
from ivle.webapp.tutorial import Plugin as TutorialPlugin
51
56
class SubjectsView(XHTMLView):
52
57
'''The view of the list of subjects.'''
61
66
ctx['semesters'] = []
62
67
for semester in req.store.find(Semester).order_by(Desc(Semester.year),
63
68
Desc(Semester.semester)):
64
enrolments = semester.enrolments.find(user=req.user)
65
if enrolments.count():
66
ctx['semesters'].append((semester, enrolments))
70
# For admins, show all subjects in the system
71
offerings = list(semester.offerings.find())
73
offerings = [enrolment.offering for enrolment in
74
semester.enrolments.find(user=req.user)]
76
ctx['semesters'].append((semester, offerings))
79
def format_submission_principal(user, principal):
80
"""Render a list of users to fit in the offering project listing.
82
Given a user and a list of submitters, returns 'solo' if the
83
only submitter is the user, or a string of the form
84
'with A, B and C' if there are any other submitters.
86
If submitters is None, we assume that the list of members could
87
not be determined, so we just return 'group'.
95
display_names = sorted(
96
member.display_name for member in principal.members
97
if member is not user)
99
if len(display_names) == 0:
100
return 'solo (%s)' % principal.name
101
elif len(display_names) == 1:
102
return 'with %s (%s)' % (display_names[0], principal.name)
103
elif len(display_names) > 5:
104
return 'with %d others (%s)' % (len(display_names), principal.name)
106
return 'with %s and %s (%s)' % (', '.join(display_names[:-1]),
107
display_names[-1], principal.name)
110
class OfferingView(XHTMLView):
111
"""The home page of an offering."""
112
template = 'templates/offering.html'
116
def populate(self, req, ctx):
117
# Need the worksheet result styles.
118
self.plugin_styles[TutorialPlugin] = ['tutorial.css']
119
ctx['context'] = self.context
121
ctx['permissions'] = self.context.get_permissions(req.user)
122
ctx['format_submission_principal'] = format_submission_principal
123
ctx['format_datetime'] = ivle.date.make_date_nice
124
ctx['format_datetime_short'] = ivle.date.format_datetime_for_paragraph
125
ctx['OfferingEdit'] = OfferingEdit
127
# As we go, calculate the total score for this subject
128
# (Assessable worksheets only, mandatory problems only)
130
ctx['worksheets'], problems_total, problems_done = (
131
ivle.worksheet.utils.create_list_of_fake_worksheets_and_stats(
132
req.store, req.user, self.context))
134
ctx['exercises_total'] = problems_total
135
ctx['exercises_done'] = problems_done
136
if problems_total > 0:
137
if problems_done >= problems_total:
138
ctx['worksheets_complete_class'] = "complete"
139
elif problems_done > 0:
140
ctx['worksheets_complete_class'] = "semicomplete"
142
ctx['worksheets_complete_class'] = "incomplete"
143
# Calculate the final percentage and mark for the subject
144
(ctx['exercises_pct'], ctx['worksheet_mark'],
145
ctx['worksheet_max_mark']) = (
146
ivle.worksheet.utils.calculate_mark(
147
problems_done, problems_total))
150
class OfferingSchema(formencode.Schema):
151
description = formencode.validators.UnicodeString(
152
if_missing=None, not_empty=False)
153
url = formencode.validators.URL(if_missing=None, not_empty=False)
156
class OfferingEdit(XHTMLView):
157
"""A form to edit an offering's details."""
158
template = 'templates/offering-edit.html'
161
def filter(self, stream, ctx):
162
return stream | HTMLFormFiller(data=ctx['data'])
164
def populate(self, req, ctx):
165
if req.method == 'POST':
166
data = dict(req.get_fieldstorage())
168
validator = OfferingSchema()
169
data = validator.to_python(data, state=req)
171
self.context.url = unicode(data['url']) if data['url'] else None
172
self.context.description = data['description']
174
req.throw_redirect(req.publisher.generate(self.context))
175
except formencode.Invalid, e:
176
errors = e.unpack_errors()
179
'url': self.context.url,
180
'description': self.context.description,
184
ctx['data'] = data or {}
185
ctx['context'] = self.context
186
ctx['errors'] = errors
69
189
class UserValidator(formencode.FancyValidator):
213
class RoleEnrolmentValidator(formencode.FancyValidator):
214
"""A FormEncode validator that checks permission to enrol users with a
217
The state must have an 'offering' attribute.
219
def _to_python(self, value, state):
220
if ("enrol_" + value) not in state.offering.get_permissions(state.user):
221
raise formencode.Invalid('Not allowed to assign users that role',
93
226
class EnrolSchema(formencode.Schema):
94
227
user = formencode.All(NoEnrolmentValidator(), UserValidator())
228
role = formencode.All(formencode.validators.OneOf(
229
["lecturer", "tutor", "student"]),
230
RoleEnrolmentValidator(),
231
formencode.validators.UnicodeString())
234
class EnrolmentsView(XHTMLView):
235
"""A page which displays all users enrolled in an offering."""
236
template = 'templates/enrolments.html'
239
def populate(self, req, ctx):
240
ctx['offering'] = self.context
97
242
class EnrolView(XHTMLView):
98
243
"""A form to enrol a user in an offering."""
99
244
template = 'templates/enrol.html'
103
def __init__(self, req, subject, year, semester):
104
"""Find the given offering by subject, year and semester."""
105
self.context = req.store.find(Offering,
106
Offering.subject_id == Subject.id,
107
Subject.short_name == subject,
108
Offering.semester_id == Semester.id,
109
Semester.year == year,
110
Semester.semester == semester).one()
115
248
def filter(self, stream, ctx):
116
249
return stream | HTMLFormFiller(data=ctx['data'])
140
274
template = 'templates/offering_projects.html'
141
275
permission = 'edit'
144
def __init__(self, req, subject, year, semester):
145
self.context = req.store.find(Offering,
146
Offering.subject_id == Subject.id,
147
Subject.short_name == subject,
148
Offering.semester_id == Semester.id,
149
Semester.year == year,
150
Semester.semester == semester).one()
155
def project_url(self, projectset, project):
156
return "/subjects/%s/%s/%s/+projects/%s" % (
157
self.context.subject.short_name,
158
self.context.semester.year,
159
self.context.semester.semester,
163
def new_project_url(self, projectset):
164
return "/api/subjects/" + self.context.subject.short_name + "/" +\
165
self.context.semester.year + "/" + \
166
self.context.semester.semester + "/+projectsets/" +\
167
str(projectset.id) + "/+projects/+new"
169
278
def populate(self, req, ctx):
170
279
self.plugin_styles[Plugin] = ["project.css"]
171
280
self.plugin_scripts[Plugin] = ["project.js"]
172
282
ctx['offering'] = self.context
173
283
ctx['projectsets'] = []
284
ctx['OfferingRESTView'] = OfferingRESTView
175
286
#Open the projectset Fragment, and render it for inclusion
176
287
#into the ProjectSets page
207
320
permission = "edit"
210
def __init__(self, req, subject, year, semester, project):
211
self.context = req.store.find(Project,
212
Project.short_name == project,
213
Project.project_set_id == ProjectSet.id,
214
ProjectSet.offering_id == Offering.id,
215
Offering.semester_id == Semester.id,
216
Semester.year == year,
217
Semester.semester == semester,
218
Offering.subject_id == Subject.id,
219
Subject.short_name == subject).one()
220
if self.context is None:
223
323
def build_subversion_url(self, svnroot, submission):
224
324
princ = submission.assessed.principal
248
351
ctx['user'] = req.user
250
353
class Plugin(ViewPlugin, MediaPlugin):
252
('subjects/', SubjectsView),
253
('subjects/:subject/:year/:semester/+enrolments/+new', EnrolView),
254
('subjects/:subject/:year/:semester/+projects', OfferingProjectsView),
255
('subjects/:subject/:year/:semester/+projects/:project', ProjectView),
257
('api/subjects/:subject/:year/:semester/+projectsets/+new',
259
('api/subjects/:subject/:year/:semester/+projectsets/:projectset/+projects/+new',
261
('api/subjects/:subject/:year/:semester/+projects/:project',
354
forward_routes = (root_to_subject, subject_to_offering,
355
offering_to_project, offering_to_projectset)
356
reverse_routes = (subject_url, offering_url, projectset_url, project_url)
358
views = [(ApplicationRoot, ('subjects', '+index'), SubjectsView),
359
(Offering, '+index', OfferingView),
360
(Offering, '+edit', OfferingEdit),
361
(Offering, ('+enrolments', '+index'), EnrolmentsView),
362
(Offering, ('+enrolments', '+new'), EnrolView),
363
(Offering, ('+projects', '+index'), OfferingProjectsView),
364
(Project, '+index', ProjectView),
366
(Offering, ('+projectsets', '+new'), OfferingRESTView, 'api'),
367
(ProjectSet, ('+projects', '+new'), ProjectSetRESTView, 'api'),
370
breadcrumbs = {Subject: SubjectBreadcrumb,
371
Offering: OfferingBreadcrumb,
372
User: UserBreadcrumb,
373
Project: ProjectBreadcrumb,
267
377
('subjects', 'Subjects',