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
31
import ivle.worksheet.utils
33
import ivle.webapp.tutorial.test
34
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
36
from ivle.webapp.errors import NotFound
38
# If True, getattempts or getattempt will allow browsing of inactive/disabled
39
# attempts. If False, will not allow this.
40
HISTORY_ALLOW_INACTIVE = False
42
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
44
class AttemptsRESTView(JSONRESTView):
45
'''REST view of a user's attempts at an exercise.'''
47
def __init__(self, req, subject, year, semester, worksheet,
49
self.user = ivle.database.User.get_by_login(req.store, username)
53
self.worksheet_exercise = req.store.find(WorksheetExercise,
54
WorksheetExercise.exercise_id == unicode(exercise),
55
WorksheetExercise.worksheet_id == Worksheet.id,
56
Worksheet.offering_id == Offering.id,
57
Worksheet.identifier == unicode(worksheet),
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.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.code == 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 an exercise.'''
176
def get_permissions(self, user):
177
# XXX: Do it properly.
178
# XXX: Does any user have the ability to save as themselves?
179
# XXX: Does a user EVER have permission to save as another user?
185
@named_operation('save')
186
def save(self, req, text):
187
# Find the appropriate WorksheetExercise to save to. If its not found,
188
# the user is submitting against a non-existant worksheet/exercise
189
worksheet_exercise = req.store.find(WorksheetExercise,
190
WorksheetExercise.exercise_id == self.exercise,
191
WorksheetExercise.worksheet_id == Worksheet.id,
192
Worksheet.offering_id == Offering.id,
193
Offering.subject_id == Subject.id,
194
Subject.code == self.subject,
195
Offering.semester_id == Semester.id,
196
Semester.year == self.year,
197
Semester.semester == self.semester).one()
199
if worksheet_exercise is None:
202
old_save = req.store.find(ExerciseSave,
203
ExerciseSave.ws_ex_id == worksheet_exercise.id,
204
ExerciseSave.user == req.user).one()
206
#Overwrite the old, or create a new if there isn't one
208
new_save = ExerciseSave()
209
req.store.add(new_save)
213
new_save.worksheet_exercise = worksheet_exercise
214
new_save.user = req.user
215
new_save.text = unicode(text)
216
new_save.date = datetime.datetime.now()
218
return {"result": "ok"}
222
# Note that this is the view of an existing worksheet. Creation is handled
223
# by OfferingRESTView (as offerings have worksheets)
224
class WorksheetRESTView(JSONRESTView):
225
"""View used to update a worksheet."""
227
def get_permissions(self, user):
228
# XXX: Do it properly.
229
# XXX: Lecturers should be allowed to add worksheets Only to subjects
230
# under their control
239
def __init__(self, req, **kwargs):
241
self.worksheet = kwargs['worksheet']
242
self.subject = kwargs['subject']
243
self.year = kwargs['year']
244
self.semester = kwargs['semester']
246
self.context = req.store.find(Worksheet,
247
Worksheet.identifier == self.worksheet,
248
Worksheet.offering_id == Offering.id,
249
Offering.subject_id == Subject.id,
250
Subject.code == self.subject,
251
Offering.semester_id == Semester.id,
252
Semester.year == self.year,
253
Semester.semester == self.semester).one()
255
if self.context is None:
258
@named_operation('save')
259
def save(self, req, name, assessable, data, format):
260
"""Takes worksheet data and saves it."""
261
self.context.name = unicode(name)
262
self.context.assessable = self.convert_bool(assessable)
263
self.context.data = unicode(data)
264
self.context.format = unicode(format)
265
ivle.worksheet.utils.update_exerciselist(self.context)
267
return {"result": "ok"}
269
class WorksheetsRESTView(JSONRESTView):
270
"""View used to update and create Worksheets."""
272
def get_permissions(self, user):
273
# XXX: Do it properly.
274
# XXX: Lecturers should be allowed to add worksheets Only to subjects
275
# under their control
284
def __init__(self, req, **kwargs):
286
self.subject = kwargs['subject']
287
self.year = kwargs['year']
288
self.semester = kwargs['semester']
290
self.context = req.store.find(Offering,
291
Offering.subject_id == Subject.id,
292
Subject.code == self.subject,
293
Offering.semester_id == Semester.id,
294
Semester.year == self.year,
295
Semester.semester == self.semester).one()
297
if self.context is None:
300
@named_operation('edit')
301
def add_worksheet(self, req, identifier, name, assessable, data, format):
302
"""Takes worksheet data and adds it."""
304
new_worksheet = Worksheet()
305
new_worksheet.seq_no = self.context.worksheets.count()
306
# Setting new_worksheet.offering implicitly adds new_worksheet,
307
# hence worksheets.count MUST be called above it
308
new_worksheet.offering = self.context
309
new_worksheet.identifier = unicode(identifier)
310
new_worksheet.name = unicode(name)
311
new_worksheet.assessable = self.convert_bool(assessable)
312
new_worksheet.data = unicode(data)
313
new_worksheet.format = unicode(format)
315
# This call is added for clarity, as the worksheet is implicitly added.
316
req.store.add(new_worksheet)
318
ivle.worksheet.utils.update_exerciselist(new_worksheet)
320
return {"result": "ok"}
322
@named_operation('edit')
323
def move_up(self, req, worksheetid):
324
"""Takes a list of worksheet-seq_no pairs and updates their
325
corresponding Worksheet objects to match."""
327
worksheet_below = req.store.find(Worksheet,
328
Worksheet.offering_id == self.context.id,
329
Worksheet.identifier == unicode(worksheetid)).one()
330
if worksheet_below is None:
331
raise NotFound('worksheet_below')
332
worksheet_above = req.store.find(Worksheet,
333
Worksheet.offering_id == self.context.id,
334
Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
335
if worksheet_above is None:
336
raise NotFound('worksheet_above')
338
worksheet_below.seq_no = worksheet_below.seq_no - 1
339
worksheet_above.seq_no = worksheet_above.seq_no + 1
341
return {'result': 'ok'}
343
@named_operation('edit')
344
def move_down(self, req, worksheetid):
345
"""Takes a list of worksheet-seq_no pairs and updates their
346
corresponding Worksheet objects to match."""
348
worksheet_above = req.store.find(Worksheet,
349
Worksheet.offering_id == self.context.id,
350
Worksheet.identifier == unicode(worksheetid)).one()
351
if worksheet_above is None:
352
raise NotFound('worksheet_below')
353
worksheet_below = req.store.find(Worksheet,
354
Worksheet.offering_id == self.context.id,
355
Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
356
if worksheet_below is None:
357
raise NotFound('worksheet_above')
359
worksheet_below.seq_no = worksheet_below.seq_no - 1
360
worksheet_above.seq_no = worksheet_above.seq_no + 1
362
return {'result': 'ok'}
added
removed
ivle/webapp/tutorial/service.py
