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
# "action". One of the tutorialservice actions.
31
# "exercise" - The path to a exercise file (including the .xml extension),
32
# relative to the subjects base directory.
33
# action "save" or "test" (POST only):
34
# "code" - Full text of the student's code being submitted.
35
# action "getattempts": No arguments. Returns a list of
36
# {'date': 'formatted_date', 'complete': bool} dicts.
37
# action "getattempt":
38
# "date" - Formatted date. Gets most recent attempt before (and including)
40
# Returns JSON string containing code, or null.
42
# Returns a JSON response string indicating the results.
18
# Author: Matt Giuca, Nick Chadwick
20
'''AJAX backend for the tutorial application.'''
49
from ivle import (db, util, console)
29
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
30
Offering, Subject, Semester, WorksheetExercise
51
import test # XXX: Really .test, not real test.
33
import ivle.webapp.tutorial.test
35
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
37
from ivle.webapp.errors import NotFound
53
39
# If True, getattempts or getattempt will allow browsing of inactive/disabled
54
40
# attempts. If False, will not allow this.
55
41
HISTORY_ALLOW_INACTIVE = False
58
"""Handler for Ajax backend TutorialService app."""
59
# Set request attributes
60
req.write_html_head_foot = False # No HTML
63
req.throw_error(req.HTTP_BAD_REQUEST)
64
fields = req.get_fieldstorage()
65
act = fields.getfirst('action')
66
exercise = fields.getfirst('exercise')
67
if act is None or exercise is None:
68
req.throw_error(req.HTTP_BAD_REQUEST)
70
exercise = exercise.value
72
if act == 'save' or act == 'test':
74
if req.method != 'POST':
75
req.throw_error(req.HTTP_BAD_REQUEST)
77
code = fields.getfirst('code')
79
req.throw_error(req.HTTP_BAD_REQUEST)
83
handle_save(req, exercise, code, fields)
85
handle_test(req, exercise, code, fields)
86
elif act == 'getattempts':
87
handle_getattempts(req, exercise)
88
elif act == 'getattempt':
89
date = fields.getfirst('date')
91
req.throw_error(req.HTTP_BAD_REQUEST)
93
# Convert into a struct_time
94
# The time *should* be in the same format as the DB (since it should
95
# be bounced back to us from the getattempts output). Assume this.
97
date = time.strptime(date, db.TIMESTAMP_FORMAT)
99
# Date was not in correct format
100
req.throw_error(req.HTTP_BAD_REQUEST)
101
handle_getattempt(req, exercise, date)
103
req.throw_error(req.HTTP_BAD_REQUEST)
105
def handle_save(req, exercise, code, fields):
106
"""Handles a save action. This saves the user's code without executing it.
108
# Need to open JUST so we know this is a real exercise.
109
# (This avoids users submitting code for bogus exercises).
110
exercisefile = util.open_exercise_file(exercise)
111
if exercisefile is None:
112
req.throw_error(req.HTTP_NOT_FOUND,
113
"The exercise was not found.")
116
req.write('{"result": "ok"}')
121
conn.write_problem_save(
122
login = req.user.login,
123
exercisename = exercise,
124
date = time.localtime(),
129
def handle_test(req, exercise, code, fields):
130
"""Handles a test action."""
132
exercisefile = util.open_exercise_file(exercise)
133
if exercisefile is None:
134
req.throw_error(req.HTTP_NOT_FOUND,
135
"The exercise was not found.")
137
# Start a console to run the tests on
138
jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
139
working_dir = os.path.join("/home", req.user.login)
140
cons = console.Console(req.user.unixid, jail_path, working_dir)
142
# Parse the file into a exercise object using the test suite
143
exercise_obj = test.parse_exercise_file(exercisefile, cons)
146
# Run the test cases. Get the result back as a JSONable object.
148
test_results = exercise_obj.run_tests(code)
155
conn.insert_problem_attempt(
156
login = req.user.login,
157
exercisename = exercise,
158
date = time.localtime(),
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(),
159
107
complete = test_results['passed'],
108
text = unicode(data['code'])
111
req.store.add(attempt)
162
113
# Query the DB to get an updated score on whether or not this problem
163
114
# has EVER been completed (may be different from "passed", if it has
164
115
# been completed before), and the total number of attempts.
165
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)
167
118
test_results["completed"] = completed
168
119
test_results["attempts"] = attempts
170
req.write(cjson.encode(test_results))
174
def handle_getattempts(req, exercise):
175
"""Handles a getattempts action."""
178
attempts = conn.get_problem_attempts(
179
login=req.user.login,
180
exercisename=exercise,
181
allow_inactive=HISTORY_ALLOW_INACTIVE)
182
req.write(cjson.encode(attempts))
186
def handle_getattempt(req, exercise, date):
187
"""Handles a getattempts action. Date is a struct_time."""
190
attempt = conn.get_problem_attempt(
191
login=req.user.login,
192
exercisename=exercise,
194
allow_inactive=HISTORY_ALLOW_INACTIVE)
195
# attempt may be None; will write "null"
196
req.write(cjson.encode({'code': attempt}))
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"}
213
# Note that this is the view of an existing worksheet. Creation is handled
214
# by OfferingRESTView (as offerings have worksheets)
215
class WorksheetRESTView(JSONRESTView):
216
"""View used to update a worksheet."""
218
def get_permissions(self, user):
219
# XXX: Do it properly.
220
# XXX: Lecturers should be allowed to add worksheets Only to subjects
221
# under their control
230
def __init__(self, req, **kwargs):
232
self.worksheet = kwargs['worksheet']
233
self.subject = kwargs['subject']
234
self.year = kwargs['year']
235
self.semester = kwargs['semester']
237
self.context = req.store.find(Worksheet,
238
Worksheet.identifier == self.worksheet,
239
Worksheet.offering_id == Offering.id,
240
Offering.subject_id == Subject.id,
241
Subject.code == self.subject,
242
Offering.semester_id == Semester.id,
243
Semester.year == self.year,
244
Semester.semester == self.semester).one()
246
if self.context is None:
249
@named_operation('save')
250
def save(self, req, name, assessable, data, format):
251
"""Takes worksheet data and saves it."""
252
self.context.name = unicode(name)
253
self.context.assessable = self.convert_bool(assessable)
254
self.context.data = unicode(data)
255
self.context.format = unicode(format)
256
ivle.worksheet.update_exerciselist(self.context)
258
return {"result": "ok"}
260
class WorksheetsRESTView(JSONRESTView):
261
"""View used to update and create Worksheets."""
263
def get_permissions(self, user):
264
# XXX: Do it properly.
265
# XXX: Lecturers should be allowed to add worksheets Only to subjects
266
# under their control
275
def __init__(self, req, **kwargs):
277
self.subject = kwargs['subject']
278
self.year = kwargs['year']
279
self.semester = kwargs['semester']
281
self.context = req.store.find(Offering,
282
Offering.subject_id == Subject.id,
283
Subject.code == self.subject,
284
Offering.semester_id == Semester.id,
285
Semester.year == self.year,
286
Semester.semester == self.semester).one()
288
if self.context is None:
291
@named_operation('edit')
292
def add_worksheet(self, req, identifier, name, assessable, data, format):
293
"""Takes worksheet data and adds it."""
295
new_worksheet = Worksheet()
296
new_worksheet.seq_no = self.context.worksheets.count()
297
# Setting new_worksheet.offering implicitly adds new_worksheet,
298
# hence worksheets.count MUST be called above it
299
new_worksheet.offering = self.context
300
new_worksheet.identifier = unicode(identifier)
301
new_worksheet.name = unicode(name)
302
new_worksheet.assessable = self.convert_bool(assessable)
303
new_worksheet.data = unicode(data)
304
new_worksheet.format = unicode(format)
306
# This call is added for clarity, as the worksheet is implicitly added.
307
req.store.add(new_worksheet)
309
ivle.worksheet.update_exerciselist(new_worksheet)
311
return {"result": "ok"}
313
@named_operation('edit')
314
def move_up(self, req, worksheetid):
315
"""Takes a list of worksheet-seq_no pairs and updates their
316
corresponding Worksheet objects to match."""
318
worksheet_below = req.store.find(Worksheet,
319
Worksheet.offering_id == self.context.id,
320
Worksheet.identifier == unicode(worksheetid)).one()
321
if worksheet_below is None:
322
raise NotFound('worksheet_below')
323
worksheet_above = req.store.find(Worksheet,
324
Worksheet.offering_id == self.context.id,
325
Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
326
if worksheet_above is None:
327
raise NotFound('worksheet_above')
329
worksheet_below.seq_no = worksheet_below.seq_no - 1
330
worksheet_above.seq_no = worksheet_above.seq_no + 1
332
return {'result': 'ok'}
334
@named_operation('edit')
335
def move_down(self, req, worksheetid):
336
"""Takes a list of worksheet-seq_no pairs and updates their
337
corresponding Worksheet objects to match."""
339
worksheet_above = req.store.find(Worksheet,
340
Worksheet.offering_id == self.context.id,
341
Worksheet.identifier == unicode(worksheetid)).one()
342
if worksheet_above is None:
343
raise NotFound('worksheet_below')
344
worksheet_below = req.store.find(Worksheet,
345
Worksheet.offering_id == self.context.id,
346
Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
347
if worksheet_below is None:
348
raise NotFound('worksheet_above')
350
worksheet_below.seq_no = worksheet_below.seq_no - 1
351
worksheet_above.seq_no = worksheet_above.seq_no + 1
353
return {'result': 'ok'}
added
removed
ivle/webapp/tutorial/service.py
