15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
# Module: TutorialService
22
# Provides the AJAX backend for the tutorial application.
23
# This allows several actions to be performed on the code the student has
24
# typed into one of the exercise boxes.
28
# The arguments determine what is to be done on this file.
30
# "exercise" - The path to a exercise file (including the .xml extension),
31
# relative to the subjects base directory.
32
# "code" - Full text of the student's code being submitted.
33
# "action". May be "test". (More to come).
35
# Returns a JSON response string indicating the results.
18
# Author: Matt Giuca, Nick Chadwick
20
'''AJAX backend for the tutorial application.'''
42
from common import (db, util)
47
"""Handler for Ajax backend TutorialService app."""
48
# Set request attributes
49
req.write_html_head_foot = False # No HTML
52
req.throw_error(req.HTTP_BAD_REQUEST)
53
# Get all the arguments, if POST.
54
# Ignore arguments if not POST, since we aren't allowed to cause
55
# side-effects on the server.
56
fields = req.get_fieldstorage()
57
act = fields.getfirst('action')
58
exercise = fields.getfirst('exercise')
59
code = fields.getfirst('code')
61
if exercise == None or code == None or act == None:
62
req.throw_error(req.HTTP_BAD_REQUEST)
64
exercise = exercise.value
68
handle_save(req, exercise, code, fields)
70
handle_test(req, exercise, code, fields)
72
handle_run(req, exercise, code, fields)
74
req.throw_error(req.HTTP_BAD_REQUEST)
76
def handle_save(req, exercise, code, fields):
77
"""Handles a save action. This saves the user's code without executing it.
79
# Need to open JUST so we know this is a real exercise.
80
# (This avoids users submitting code for bogus exercises).
81
exercisefile = util.open_exercise_file(exercise)
82
if exercisefile is None:
83
req.throw_error(req.HTTP_NOT_FOUND,
84
"The exercise was not found.")
87
req.write('{"result": "ok"}')
92
conn.write_problem_save(
93
login = req.user.login,
94
exercisename = exercise,
95
date = time.localtime(),
100
def handle_test(req, exercise, code, fields):
101
"""Handles a test action."""
103
exercisefile = util.open_exercise_file(exercise)
104
if exercisefile is None:
105
req.throw_error(req.HTTP_NOT_FOUND,
106
"The exercise was not found.")
108
# Parse the file into a exercise object using the test suite
109
exercise_obj = test.parse_exercise_file(exercisefile)
111
# Run the test cases. Get the result back as a JSONable object.
113
test_results = exercise_obj.run_tests(code)
117
conn.insert_problem_attempt(
118
login = req.user.login,
119
exercisename = exercise,
120
date = time.localtime(),
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(),
121
107
complete = test_results['passed'],
108
text = unicode(data['code'])
111
req.store.add(attempt)
124
113
# Query the DB to get an updated score on whether or not this problem
125
114
# has EVER been completed (may be different from "passed", if it has
126
115
# been completed before), and the total number of attempts.
127
completed, attempts = conn.get_problem_status(req.user.login,
116
completed, attempts = ivle.worksheet.get_exercise_status(req.store,
117
req.user, self.worksheet_exercise)
129
118
test_results["completed"] = completed
130
119
test_results["attempts"] = attempts
132
req.write(cjson.encode(test_results))
136
def handle_run(req, exercise, code, fields):
137
"""Handles a run action."""
138
# Extremely makeshift.
139
# For now, just echo the code back
141
out_json = {"stdout": output}
142
req.write(cjson.encode(out_json))
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 = ivle.worksheet.get_exercise_attempt(req.store, user,
151
worksheet_exercise, as_of=date,
152
allow_inactive=HISTORY_ALLOW_INACTIVE)
157
self.context = attempt
159
@require_permission('view')
161
return {'code': self.context.text}
164
class ExerciseRESTView(JSONRESTView):
165
'''REST view of an exercise.'''
167
def get_permissions(self, user):
168
# XXX: Do it properly.
169
# XXX: Does any user have the ability to save as themselves?
170
# XXX: Does a user EVER have permission to save as another user?
176
@named_operation('save')
177
def save(self, req, text):
178
# Find the appropriate WorksheetExercise to save to. If its not found,
179
# the user is submitting against a non-existant worksheet/exercise
180
worksheet_exercise = req.store.find(WorksheetExercise,
181
WorksheetExercise.exercise_id == self.exercise,
182
WorksheetExercise.worksheet_id == Worksheet.id,
183
Worksheet.offering_id == Offering.id,
184
Offering.subject_id == Subject.id,
185
Subject.code == self.subject,
186
Offering.semester_id == Semester.id,
187
Semester.year == self.year,
188
Semester.semester == self.semester).one()
190
if worksheet_exercise is None:
193
old_save = req.store.find(ExerciseSave,
194
ExerciseSave.ws_ex_id == worksheet_exercise.id,
195
ExerciseSave.user == req.user).one()
197
#Overwrite the old, or create a new if there isn't one
199
new_save = ExerciseSave()
200
req.store.add(new_save)
204
new_save.worksheet_exercise = worksheet_exercise
205
new_save.user = req.user
206
new_save.text = unicode(text)
207
new_save.date = datetime.datetime.now()
209
return {"result": "ok"}
212
def generate_exerciselist(worksheet, req, worksheetdata):
213
"""Runs through the worksheetstream, generating the appropriate
214
WorksheetExercises, and de-activating the old ones."""
216
# Turns the worksheet into an xml stream, and then finds all the
217
# exercise nodes in the stream.
218
worksheetdata = genshi.XML(worksheetdata)
219
for kind, data, pos in worksheetdata:
220
if kind is genshi.core.START:
221
# Data is a tuple of tag name and a list of name->value tuples
222
if data[0] == 'exercise':
228
if attr[0] == 'optional':
229
optional = attr[1] == 'true'
231
exercises.append((src, optional))
233
# Set all current worksheet_exercises to be inactive
234
db_worksheet_exercises = req.store.find(WorksheetExercise,
235
WorksheetExercise.worksheet_id == worksheet.id)
236
for worksheet_exercise in db_worksheet_exercises:
237
worksheet_exercise.active = False
239
for exerciseid, optional in exercises:
240
worksheet_exercise = req.store.find(WorksheetExercise,
241
WorksheetExercise.worksheet_id == worksheet.id,
242
Exercise.id == WorksheetExercise.exercise_id,
243
Exercise.id == exerciseid).one()
244
if worksheet_exercise is None:
245
exercise = req.store.find(Exercise,
246
Exercise.id == exerciseid
250
worksheet_exercise = WorksheetExercise()
251
worksheet_exercise.worksheet_id = worksheet.id
252
worksheet_exercise.exercise_id = exercise.id
253
req.store.add(worksheet_exercise)
254
worksheet_exercise.active = True
255
worksheet_exercise.seq_no = ex_num
256
worksheet_exercise.optional = optional
259
# Note that this is the view of an existing worksheet. Creation is handled
260
# by OfferingRESTView (as offerings have worksheets)
261
class WorksheetRESTView(JSONRESTView):
262
"""View used to update a worksheet."""
264
def get_permissions(self, user):
265
# XXX: Do it properly.
266
# XXX: Lecturers should be allowed to add worksheets Only to subjects
267
# under their control
269
if user.rolenm == 'admin':
276
def __init__(self, req, **kwargs):
278
self.worksheet = kwargs['worksheet']
279
self.subject = kwargs['subject']
280
self.year = kwargs['year']
281
self.semester = kwargs['semester']
283
self.context = req.store.find(Worksheet,
284
Worksheet.identifier == self.worksheet,
285
Worksheet.offering_id == Offering.id,
286
Offering.subject_id == Subject.id,
287
Subject.code == self.subject,
288
Offering.semester_id == Semester.id,
289
Semester.year == self.year,
290
Semester.semester == self.semester).one()
292
if self.context is None:
295
@named_operation('save')
296
def save(self, req, name, assessable, data, format):
297
"""Takes worksheet data and saves it."""
298
generate_exerciselist(self.context, req, data)
300
self.context.name = unicode(name)
301
self.context.assessable = self.convert_bool(assessable)
302
self.context.data = unicode(data)
303
self.context.format = unicode(format)
305
return {"result": "ok"}
307
class WorksheetsRESTView(JSONRESTView):
308
"""View used to update and create Worksheets."""
310
def get_permissions(self, user):
311
# XXX: Do it properly.
312
# XXX: Lecturers should be allowed to add worksheets Only to subjects
313
# under their control
315
if user.rolenm == 'admin':
322
def __init__(self, req, **kwargs):
324
self.subject = kwargs['subject']
325
self.year = kwargs['year']
326
self.semester = kwargs['semester']
328
self.context = req.store.find(Offering,
329
Offering.subject_id == Subject.id,
330
Subject.code == self.subject,
331
Offering.semester_id == Semester.id,
332
Semester.year == self.year,
333
Semester.semester == self.semester).one()
335
if self.context is None:
338
@named_operation('edit')
339
def add_worksheet(self, req, identifier, name, assessable, data, format):
340
"""Takes worksheet data and adds it."""
342
new_worksheet = Worksheet()
343
new_worksheet.seq_no = self.context.worksheets.count()
344
# Setting new_worksheet.offering implicitly adds new_worksheet,
345
# hence worksheets.count MUST be called above it
346
new_worksheet.offering = self.context
347
new_worksheet.identifier = unicode(identifier)
348
new_worksheet.name = unicode(name)
349
new_worksheet.assessable = self.convert_bool(assessable)
350
new_worksheet.data = unicode(data)
351
new_worksheet.format = unicode(format)
353
# This call is added for clarity, as the worksheet is implicitly added.
354
req.store.add(new_worksheet)
356
generate_exerciselist(new_worksheet, req, data)
358
return {"result": "ok"}
360
@named_operation('edit')
361
def move_up(self, req, worksheetid):
362
"""Takes a list of worksheet-seq_no pairs and updates their
363
corresponding Worksheet objects to match."""
365
worksheet_below = req.store.find(Worksheet,
366
Worksheet.offering_id == self.context.id,
367
Worksheet.identifier == unicode(worksheetid)).one()
368
if worksheet_below is None:
369
raise NotFound('worksheet_below')
370
worksheet_above = req.store.find(Worksheet,
371
Worksheet.offering_id == self.context.id,
372
Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
373
if worksheet_above is None:
374
raise NotFound('worksheet_above')
376
worksheet_below.seq_no = worksheet_below.seq_no - 1
377
worksheet_above.seq_no = worksheet_above.seq_no + 1
379
return {'result': 'ok'}
381
@named_operation('edit')
382
def move_down(self, req, worksheetid):
383
"""Takes a list of worksheet-seq_no pairs and updates their
384
corresponding Worksheet objects to match."""
386
worksheet_above = req.store.find(Worksheet,
387
Worksheet.offering_id == self.context.id,
388
Worksheet.identifier == unicode(worksheetid)).one()
389
if worksheet_above is None:
390
raise NotFound('worksheet_below')
391
worksheet_below = req.store.find(Worksheet,
392
Worksheet.offering_id == self.context.id,
393
Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
394
if worksheet_below is None:
395
raise NotFound('worksheet_above')
397
worksheet_below.seq_no = worksheet_below.seq_no - 1
398
worksheet_above.seq_no = worksheet_above.seq_no + 1
400
return {'result': 'ok'}
added
removed
ivle/webapp/tutorial/service.py
