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.'''
52
from ivle import console
53
28
import ivle.database
29
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
30
Offering, Subject, Semester, WorksheetExercise
31
import ivle.worksheet.utils
56
import test # XXX: Really .test, not real test.
33
import ivle.webapp.tutorial.test
34
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
36
from ivle.webapp.errors import NotFound
58
38
# If True, getattempts or getattempt will allow browsing of inactive/disabled
59
39
# attempts. If False, will not allow this.
60
40
HISTORY_ALLOW_INACTIVE = False
63
"""Handler for Ajax backend TutorialService app."""
64
# Set request attributes
65
req.write_html_head_foot = False # No HTML
68
req.throw_error(req.HTTP_BAD_REQUEST)
69
fields = req.get_fieldstorage()
70
act = fields.getfirst('action')
71
exercise = fields.getfirst('exercise')
72
if act is None or exercise is None:
73
req.throw_error(req.HTTP_BAD_REQUEST)
75
exercise = exercise.value
77
if act == 'save' or act == 'test':
79
if req.method != 'POST':
80
req.throw_error(req.HTTP_BAD_REQUEST)
82
code = fields.getfirst('code')
84
req.throw_error(req.HTTP_BAD_REQUEST)
88
handle_save(req, exercise, code, fields)
90
handle_test(req, exercise, code, fields)
91
elif act == 'getattempts':
92
handle_getattempts(req, exercise)
93
elif act == 'getattempt':
94
date = fields.getfirst('date')
96
req.throw_error(req.HTTP_BAD_REQUEST)
98
# Convert into a struct_time
99
# The time *should* be in the same format as the DB (since it should
100
# be bounced back to us from the getattempts output). Assume this.
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.short_name == 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)
102
date = datetime.datetime.strptime(date, db.TIMESTAMP_FORMAT)
135
date = datetime.datetime.strptime(date, TIMESTAMP_FORMAT)
103
136
except ValueError:
104
# Date was not in correct format
105
req.throw_error(req.HTTP_BAD_REQUEST)
106
handle_getattempt(req, exercise, date)
108
req.throw_error(req.HTTP_BAD_REQUEST)
110
def handle_save(req, exercise, code, fields):
111
"""Handles a save action. This saves the user's code without executing it.
113
# Need to open JUST so we know this is a real exercise.
114
# (This avoids users submitting code for bogus exercises).
115
exercisefile = util.open_exercise_file(exercise)
116
if exercisefile is None:
117
req.throw_error(req.HTTP_NOT_FOUND,
118
"The exercise was not found.")
121
req.write('{"result": "ok"}')
126
conn.write_problem_save(
128
exercisename = exercise,
129
date = time.localtime(),
134
def handle_test(req, exercisesrc, code, fields):
135
"""Handles a test action."""
137
exercisefile = util.open_exercise_file(exercisesrc)
138
if exercisefile is None:
139
req.throw_error(req.HTTP_NOT_FOUND,
140
"The exercise was not found.")
142
# Start a console to run the tests on
143
jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
144
working_dir = os.path.join("/home", req.user.login)
145
cons = console.Console(req.user.unixid, jail_path, working_dir)
147
# Parse the file into a exercise object using the test suite
148
exercise_obj = test.parse_exercise_file(exercisefile, cons)
151
# Run the test cases. Get the result back as a JSONable object.
153
test_results = exercise_obj.run_tests(code)
158
# Get the Exercise from the database
159
exercise = ivle.database.Exercise.get_by_name(req.store, exercisesrc)
163
conn.insert_problem_attempt(
165
exercisename = exercisesrc,
166
date = time.localtime(),
167
complete = test_results['passed'],
172
# Query the DB to get an updated score on whether or not this problem
173
# has EVER been completed (may be different from "passed", if it has
174
# been completed before), and the total number of attempts.
175
completed, attempts = ivle.worksheet.get_exercise_status(req.store,
177
test_results["completed"] = completed
178
test_results["attempts"] = attempts
180
req.write(cjson.encode(test_results))
182
def handle_getattempts(req, exercisename):
183
"""Handles a getattempts action."""
184
exercise = ivle.database.Exercise.get_by_name(req.store, exercisename)
185
attempts = ivle.worksheet.get_exercise_attempts(req.store, req.user,
186
exercise, allow_inactive=HISTORY_ALLOW_INACTIVE)
187
# attempts is a list of ExerciseAttempt objects. Convert to dictionaries.
188
time_fmt = lambda dt: datetime.datetime.strftime(dt, db.TIMESTAMP_FORMAT)
189
attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
191
req.write(cjson.encode(attempts))
193
def handle_getattempt(req, exercisename, date):
194
"""Handles a getattempts action. Date is a datetime.datetime."""
196
exercise = ivle.database.Exercise.get_by_name(req.store, exercisename)
197
attempt = ivle.worksheet.get_exercise_attempt(req.store, req.user,
198
exercise, as_of=date, allow_inactive=HISTORY_ALLOW_INACTIVE)
199
if attempt is not None:
200
attempt = attempt.text
201
# attempt may be None; will write "null"
202
req.write(cjson.encode({'code': attempt}))
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
