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.'''
28
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
29
Offering, Subject, Semester, WorksheetExercise
30
import ivle.worksheet.utils
31
import ivle.webapp.tutorial.test
32
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
34
from ivle.webapp.errors import NotFound
36
# If True, getattempts or getattempt will allow browsing of inactive/disabled
37
# attempts. If False, will not allow this.
38
HISTORY_ALLOW_INACTIVE = False
40
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
42
class AttemptsRESTView(JSONRESTView):
43
'''REST view of a user's attempts at an exercise.'''
45
def __init__(self, req, subject, year, semester, worksheet,
47
self.user = ivle.database.User.get_by_login(req.store, username)
51
self.worksheet_exercise = req.store.find(WorksheetExercise,
52
WorksheetExercise.exercise_id == unicode(exercise),
53
WorksheetExercise.worksheet_id == Worksheet.id,
54
Worksheet.offering_id == Offering.id,
55
Worksheet.identifier == unicode(worksheet),
56
Offering.subject_id == Subject.id,
57
Subject.short_name == subject,
58
Offering.semester_id == Semester.id,
59
Semester.year == year,
60
Semester.semester == semester).one()
62
self.context = self.user # XXX: Not quite right.
64
@require_permission('edit')
66
"""Handles a GET Attempts action."""
67
attempts = req.store.find(ExerciseAttempt,
68
ExerciseAttempt.ws_ex_id == self.worksheet_exercise.id,
69
ExerciseAttempt.user_id == self.user.id)
70
# attempts is a list of ExerciseAttempt objects. Convert to dictionaries
71
time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
72
attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
78
@require_permission('edit')
79
def PUT(self, req, data):
80
""" Tests the given submission """
81
exercise = req.store.find(Exercise,
82
Exercise.id == self.worksheet_exercise.exercise_id).one()
86
# Start a console to run the tests on
87
jail_path = os.path.join(req.config['paths']['jails']['mounts'],
89
working_dir = os.path.join("/home", req.user.login)
90
cons = ivle.console.Console(req.config, req.user.unixid, jail_path,
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.utils.get_exercise_status(
117
req.store, 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
# XXX Hack around Google Code issue #87
140
# Query from the given date +1 secnod.
141
# Date is in seconds (eg. 3:47:12), while the data is in finer time
142
# (eg. 3:47:12.3625). The query "date <= 3:47:12" will fail because
143
# 3:47:12.3625 is greater. Hence we do the query from +1 second,
144
# "date <= 3:47:13", and it finds the correct submission, UNLESS there
145
# are multiple submissions inside the same second.
146
date += datetime.timedelta(seconds=1)
148
worksheet_exercise = req.store.find(WorksheetExercise,
149
WorksheetExercise.exercise_id == exercise,
150
WorksheetExercise.worksheet_id == Worksheet.id,
151
Worksheet.identifier == worksheet,
152
Worksheet.offering_id == Offering.id,
153
Offering.subject_id == Subject.id,
154
Subject.short_name == subject,
155
Offering.semester_id == Semester.id,
156
Semester.year == year,
157
Semester.semester == semester).one()
159
attempt = ivle.worksheet.utils.get_exercise_attempt(req.store, user,
160
worksheet_exercise, as_of=date,
161
allow_inactive=HISTORY_ALLOW_INACTIVE)
166
self.context = attempt
168
@require_permission('view')
170
return {'code': self.context.text}
173
class WorksheetExerciseRESTView(JSONRESTView):
174
'''REST view of a worksheet exercise.'''
176
def __init__(self, req, subject, year, semester, worksheet, exercise):
177
self.context = req.store.find(WorksheetExercise,
178
WorksheetExercise.exercise_id == exercise,
179
WorksheetExercise.worksheet_id == Worksheet.id,
180
Worksheet.offering_id == Offering.id,
181
Offering.subject_id == Subject.id,
182
Subject.short_name == subject,
183
Offering.semester_id == Semester.id,
184
Semester.year == year,
185
Semester.semester == semester).one()
187
if self.context is None:
190
@named_operation('view')
191
def save(self, req, text):
192
# Find the appropriate WorksheetExercise to save to. If its not found,
193
# the user is submitting against a non-existant worksheet/exercise
195
old_save = req.store.find(ExerciseSave,
196
ExerciseSave.ws_ex_id == self.context.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 = self.context
207
new_save.user = req.user
208
new_save.text = unicode(text)
209
new_save.date = datetime.datetime.now()
211
return {"result": "ok"}
214
# Note that this is the view of an existing worksheet. Creation is handled
215
# by OfferingRESTView (as offerings have worksheets)
216
class WorksheetRESTView(JSONRESTView):
217
"""View used to update a worksheet."""
219
def __init__(self, req, **kwargs):
221
self.worksheet = kwargs['worksheet']
222
self.subject = kwargs['subject']
223
self.year = kwargs['year']
224
self.semester = kwargs['semester']
226
self.context = req.store.find(Worksheet,
227
Worksheet.identifier == self.worksheet,
228
Worksheet.offering_id == Offering.id,
229
Offering.subject_id == Subject.id,
230
Subject.short_name == self.subject,
231
Offering.semester_id == Semester.id,
232
Semester.year == self.year,
233
Semester.semester == self.semester).one()
235
if self.context is None:
238
@named_operation('edit')
239
def save(self, req, name, assessable, data, format):
240
"""Takes worksheet data and saves it."""
241
self.context.name = unicode(name)
242
self.context.assessable = self.convert_bool(assessable)
243
self.context.data = unicode(data)
244
self.context.format = unicode(format)
245
ivle.worksheet.utils.update_exerciselist(self.context)
247
return {"result": "ok"}
249
class WorksheetsRESTView(JSONRESTView):
250
"""View used to update and create Worksheets."""
252
def __init__(self, req, **kwargs):
254
self.subject = kwargs['subject']
255
self.year = kwargs['year']
256
self.semester = kwargs['semester']
258
self.context = req.store.find(Offering,
259
Offering.subject_id == Subject.id,
260
Subject.short_name == self.subject,
261
Offering.semester_id == Semester.id,
262
Semester.year == self.year,
263
Semester.semester == self.semester).one()
265
if self.context is None:
268
@named_operation('edit')
269
def add_worksheet(self, req, identifier, name, assessable, data, format):
270
"""Takes worksheet data and adds it."""
272
new_worksheet = Worksheet()
273
new_worksheet.seq_no = self.context.worksheets.count()
274
# Setting new_worksheet.offering implicitly adds new_worksheet,
275
# hence worksheets.count MUST be called above it
276
new_worksheet.offering = self.context
277
new_worksheet.identifier = unicode(identifier)
278
new_worksheet.name = unicode(name)
279
new_worksheet.assessable = self.convert_bool(assessable)
280
new_worksheet.data = unicode(data)
281
new_worksheet.format = unicode(format)
283
# This call is added for clarity, as the worksheet is implicitly added.
284
req.store.add(new_worksheet)
286
ivle.worksheet.utils.update_exerciselist(new_worksheet)
288
return {"result": "ok"}
290
@named_operation('edit')
291
def move_up(self, req, worksheetid):
292
"""Takes a list of worksheet-seq_no pairs and updates their
293
corresponding Worksheet objects to match."""
295
worksheet_below = req.store.find(Worksheet,
296
Worksheet.offering_id == self.context.id,
297
Worksheet.identifier == unicode(worksheetid)).one()
298
if worksheet_below is None:
299
raise NotFound('worksheet_below')
300
worksheet_above = req.store.find(Worksheet,
301
Worksheet.offering_id == self.context.id,
302
Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
303
if worksheet_above is None:
304
raise NotFound('worksheet_above')
306
worksheet_below.seq_no = worksheet_below.seq_no - 1
307
worksheet_above.seq_no = worksheet_above.seq_no + 1
309
return {'result': 'ok'}
311
@named_operation('edit')
312
def move_down(self, req, worksheetid):
313
"""Takes a list of worksheet-seq_no pairs and updates their
314
corresponding Worksheet objects to match."""
316
worksheet_above = req.store.find(Worksheet,
317
Worksheet.offering_id == self.context.id,
318
Worksheet.identifier == unicode(worksheetid)).one()
319
if worksheet_above is None:
320
raise NotFound('worksheet_below')
321
worksheet_below = req.store.find(Worksheet,
322
Worksheet.offering_id == self.context.id,
323
Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
324
if worksheet_below is None:
325
raise NotFound('worksheet_above')
327
worksheet_below.seq_no = worksheet_below.seq_no - 1
328
worksheet_above.seq_no = worksheet_above.seq_no + 1
330
return {'result': 'ok'}
added
removed
ivle/webapp/tutorial/service.py
