1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 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
18
# Author: Matt Giuca, Nick Chadwick
20
'''AJAX backend for the tutorial application.'''
29
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
30
Offering, Subject, Semester, WorksheetExercise
33
import ivle.webapp.tutorial.test
35
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
37
from ivle.webapp.errors import NotFound
39
# If True, getattempts or getattempt will allow browsing of inactive/disabled
40
# attempts. If False, will not allow this.
41
HISTORY_ALLOW_INACTIVE = False
43
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
45
class AttemptsRESTView(JSONRESTView):
46
'''REST view of a user's attempts at an exercise.'''
48
def __init__(self, req, subject, year, semester, worksheet,
50
self.user = ivle.database.User.get_by_login(req.store, username)
54
self.worksheet_exercise = req.store.find(WorksheetExercise,
55
WorksheetExercise.exercise_id == exercise,
56
WorksheetExercise.worksheet_id == Worksheet.id,
57
Worksheet.offering_id == Offering.id,
58
Offering.subject_id == Subject.id,
59
Subject.code == subject,
60
Offering.semester_id == Semester.id,
61
Semester.year == year,
62
Semester.semester == semester).one()
64
self.context = self.user # XXX: Not quite right.
66
@require_permission('edit')
68
"""Handles a GET Attempts action."""
69
attempts = req.store.find(ExerciseAttempt,
70
ExerciseAttempt.ws_ex_id == self.worksheet_exercise.id,
71
ExerciseAttempt.user_id == self.user.id)
72
# attempts is a list of ExerciseAttempt objects. Convert to dictionaries
73
time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
74
attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
80
@require_permission('edit')
81
def PUT(self, req, data):
82
""" Tests the given submission """
83
exercise = req.store.find(Exercise,
84
Exercise.id == self.worksheet_exercise.exercise_id).one()
88
# Start a console to run the tests on
89
jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
90
working_dir = os.path.join("/home", req.user.login)
91
cons = ivle.console.Console(req.user.unixid, jail_path, working_dir)
93
# Parse the file into a exercise object using the test suite
94
exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
97
# Run the test cases. Get the result back as a JSONable object.
99
test_results = exercise_obj.run_tests(data['code'])
104
attempt = ivle.database.ExerciseAttempt(user=req.user,
105
worksheet_exercise = self.worksheet_exercise,
106
date = datetime.datetime.now(),
107
complete = test_results['passed'],
108
text = unicode(data['code'])
111
req.store.add(attempt)
113
# Query the DB to get an updated score on whether or not this problem
114
# has EVER been completed (may be different from "passed", if it has
115
# been completed before), and the total number of attempts.
116
completed, attempts = ivle.worksheet.get_exercise_status(req.store,
117
req.user, self.worksheet_exercise)
118
test_results["completed"] = completed
119
test_results["attempts"] = attempts
124
class AttemptRESTView(JSONRESTView):
125
'''REST view of an exercise attempt.'''
127
def __init__(self, req, subject, year, semester, worksheet, exercise,
129
# TODO: Find exercise within worksheet.
130
user = ivle.database.User.get_by_login(req.store, username)
135
# date = datetime.datetime.strptime(date, TIMESTAMP_FORMAT)
139
worksheet_exercise = req.store.find(WorksheetExercise,
140
WorksheetExercise.exercise_id == exercise,
141
WorksheetExercise.worksheet_id == Worksheet.id,
142
Worksheet.identifier == worksheet,
143
Worksheet.offering_id == Offering.id,
144
Offering.subject_id == Subject.id,
145
Subject.code == subject,
146
Offering.semester_id == Semester.id,
147
Semester.year == year,
148
Semester.semester == semester).one()
150
attempt = req.store.find(ExerciseAttempt,
151
ExerciseAttempt.user_id == user.id,
152
ExerciseAttempt.ws_ex_id == worksheet_exercise.id,
153
ExerciseAttempt.date == date
159
self.context = attempt
161
@require_permission('view')
163
return {'code': self.context.text}
166
class ExerciseRESTView(JSONRESTView):
167
'''REST view of an exercise.'''
169
def get_permissions(self, user):
170
# XXX: Do it properly.
171
# XXX: Does any user have the ability to save as themselves?
172
# XXX: Does a user EVER have permission to save as another user?
178
@named_operation('save')
179
def save(self, req, text):
180
# Find the appropriate WorksheetExercise to save to. If its not found,
181
# the user is submitting against a non-existant worksheet/exercise
182
worksheet_exercise = req.store.find(WorksheetExercise,
183
WorksheetExercise.exercise_id == self.exercise,
184
WorksheetExercise.worksheet_id == Worksheet.id,
185
Worksheet.offering_id == Offering.id,
186
Offering.subject_id == Subject.id,
187
Subject.code == self.subject,
188
Offering.semester_id == Semester.id,
189
Semester.year == self.year,
190
Semester.semester == self.semester).one()
192
if worksheet_exercise is None:
195
old_save = req.store.find(ExerciseSave,
196
ExerciseSave.ws_ex_id == worksheet_exercise.id,
197
ExerciseSave.user == req.user).one()
199
#Overwrite the old, or create a new if there isn't one
201
new_save = ExerciseSave()
202
req.store.add(new_save)
206
new_save.worksheet_exercise = worksheet_exercise
207
new_save.user = req.user
208
new_save.text = unicode(text)
209
new_save.date = datetime.datetime.now()
211
return {"result": "ok"}
214
def generate_exerciselist(worksheet, req, worksheetdata):
215
"""Runs through the worksheetstream, generating the appropriate
216
WorksheetExercises, and de-activating the old ones."""
218
# Turns the worksheet into an xml stream, and then finds all the
219
# exercise nodes in the stream.
220
worksheetdata = genshi.XML(worksheetdata)
221
for kind, data, pos in worksheetdata:
222
if kind is genshi.core.START:
223
# Data is a tuple of tag name and a list of name->value tuples
224
if data[0] == 'exercise':
230
if attr[0] == 'optional':
231
optional = attr[1] == 'true'
233
exercises.append((src, optional))
235
# Set all current worksheet_exercises to be inactive
236
db_worksheet_exercises = req.store.find(WorksheetExercise,
237
WorksheetExercise.worksheet_id == worksheet.id)
238
for worksheet_exercise in db_worksheet_exercises:
239
worksheet_exercise.active = False
241
for exerciseid, optional in exercises:
242
worksheet_exercise = req.store.find(WorksheetExercise,
243
WorksheetExercise.worksheet_id == worksheet.id,
244
Exercise.id == WorksheetExercise.exercise_id,
245
Exercise.id == exerciseid).one()
246
if worksheet_exercise is None:
247
exercise = req.store.find(Exercise,
248
Exercise.id == exerciseid
252
worksheet_exercise = WorksheetExercise()
253
worksheet_exercise.worksheet_id = worksheet.id
254
worksheet_exercise.exercise_id = exercise.id
255
req.store.add(worksheet_exercise)
256
worksheet_exercise.active = True
257
worksheet_exercise.seq_no = ex_num
258
worksheet_exercise.optional = optional
261
# Note that this is the view of an existing worksheet. Creation is handled
262
# by OfferingRESTView (as offerings have worksheets)
263
class WorksheetRESTView(JSONRESTView):
264
"""View used to update a worksheet."""
266
def get_permissions(self, user):
267
# XXX: Do it properly.
268
# XXX: Lecturers should be allowed to add worksheets Only to subjects
269
# under their control
271
if user.rolenm == 'admin':
278
def __init__(self, req, **kwargs):
280
self.worksheet = kwargs['worksheet']
281
self.subject = kwargs['subject']
282
self.year = kwargs['year']
283
self.semester = kwargs['semester']
285
self.context = req.store.find(Worksheet,
286
Worksheet.identifier == self.worksheet,
287
Worksheet.offering_id == Offering.id,
288
Offering.subject_id == Subject.id,
289
Subject.code == self.subject,
290
Offering.semester_id == Semester.id,
291
Semester.year == self.year,
292
Semester.semester == self.semester).one()
294
if self.context is None:
297
@named_operation('save')
298
def save(self, req, name, assessable, data, format):
299
"""Takes worksheet data and saves it."""
300
self.generate_exerciselist(self.context, req, data)
302
self.context.name = unicode(name)
303
self.context.assessable = self.convert_bool(assessable)
304
self.context.data = unicode(data)
306
return {"result": "ok"}
308
class WorksheetsRESTView(JSONRESTView):
309
"""View used to update and create Worksheets."""
311
def get_permissions(self, user):
312
# XXX: Do it properly.
313
# XXX: Lecturers should be allowed to add worksheets Only to subjects
314
# under their control
316
if user.rolenm == 'admin':
317
return set(['add_worksheet', 'set_sequence'])
323
def __init__(self, req, **kwargs):
325
self.subject = kwargs['subject']
326
self.year = kwargs['year']
327
self.semester = kwargs['semester']
329
self.context = req.store.find(Offering,
330
Offering.subject_id == Subject.id,
331
Subject.code == self.subject,
332
Offering.semester_id == Semester.id,
333
Semester.year == self.year,
334
Semester.semester == self.semester).one()
336
if self.context is None:
339
@named_operation('add_worksheet')
340
def add_worksheet(self, req, identifier, name, assessable, data, format):
341
"""Takes worksheet data and adds it."""
343
new_worksheet = Worksheet()
344
new_worksheet.seq_no = self.context.worksheets.count()
345
# Setting new_worksheet.offering implicitly adds new_worksheet,
346
# hence worksheets.count MUST be called above it
347
new_worksheet.offering = self.context
348
new_worksheet.identifier = unicode(identifier)
349
new_worksheet.name = unicode(name)
350
new_worksheet.assessable = self.convert_bool(assessable)
351
new_worksheet.data = unicode(data)
352
new_worksheet.format = unicode(format)
354
# This call is added for clarity, as the worksheet is implicitly added.
355
req.store.add(new_worksheet)
357
generate_exerciselist(new_worksheet, req, data)
359
return {"result": "ok"}
361
@named_operation('set_sequence')
362
def seq_sequence(self, req, worksheet_list):
363
"""Takes a list of worksheet-seq_no pairs and updates their
364
corresponding Worksheet objects to match."""
366
for worksheetid, seq_no in worksheet_list:
367
worksheet = req.store.find(Worksheet,
368
Worksheet.offering_id == self.context.id,
369
Worksheet.identifier == worksheetid).one()
370
if worksheet is None:
371
raise NotFound(worksheet)
372
worksheet.seq_no = seq_no
374
return {'result': 'ok'}
added
removed
ivle/webapp/tutorial/service.py
