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 common import (db, util, console)
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
53
36
# If True, getattempts or getattempt will allow browsing of inactive/disabled
54
37
# attempts. If False, will not allow this.
55
38
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(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(),
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.user.unixid, jail_path, working_dir)
92
# Parse the file into a exercise object using the test suite
93
exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
96
# Run the test cases. Get the result back as a JSONable object.
98
test_results = exercise_obj.run_tests(data['code'])
103
attempt = ivle.database.ExerciseAttempt(user=req.user,
104
worksheet_exercise = self.worksheet_exercise,
105
date = datetime.datetime.now(),
159
106
complete = test_results['passed'],
107
text = unicode(data['code'])
110
req.store.add(attempt)
162
112
# Query the DB to get an updated score on whether or not this problem
163
113
# has EVER been completed (may be different from "passed", if it has
164
114
# been completed before), and the total number of attempts.
165
completed, attempts = conn.get_problem_status(req.user.login,
115
completed, attempts = ivle.worksheet.utils.get_exercise_status(
116
req.store, req.user, self.worksheet_exercise)
167
117
test_results["completed"] = completed
168
118
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}))
123
class AttemptRESTView(JSONRESTView):
124
'''REST view of an exercise attempt.'''
126
def __init__(self, req, subject, year, semester, worksheet, exercise,
128
# TODO: Find exercise within worksheet.
129
user = ivle.database.User.get_by_login(req.store, username)
134
date = datetime.datetime.strptime(date, TIMESTAMP_FORMAT)
138
# XXX Hack around Google Code issue #87
139
# Query from the given date +1 secnod.
140
# Date is in seconds (eg. 3:47:12), while the data is in finer time
141
# (eg. 3:47:12.3625). The query "date <= 3:47:12" will fail because
142
# 3:47:12.3625 is greater. Hence we do the query from +1 second,
143
# "date <= 3:47:13", and it finds the correct submission, UNLESS there
144
# are multiple submissions inside the same second.
145
date += datetime.timedelta(seconds=1)
147
worksheet_exercise = req.store.find(WorksheetExercise,
148
WorksheetExercise.exercise_id == exercise,
149
WorksheetExercise.worksheet_id == Worksheet.id,
150
Worksheet.identifier == worksheet,
151
Worksheet.offering_id == Offering.id,
152
Offering.subject_id == Subject.id,
153
Subject.short_name == subject,
154
Offering.semester_id == Semester.id,
155
Semester.year == year,
156
Semester.semester == semester).one()
158
attempt = ivle.worksheet.utils.get_exercise_attempt(req.store, user,
159
worksheet_exercise, as_of=date,
160
allow_inactive=HISTORY_ALLOW_INACTIVE)
165
self.context = attempt
167
@require_permission('view')
169
return {'code': self.context.text}
172
class WorksheetExerciseRESTView(JSONRESTView):
173
'''REST view of a worksheet exercise.'''
175
def __init__(self, req, subject, year, semester, worksheet, exercise):
176
self.context = req.store.find(WorksheetExercise,
177
WorksheetExercise.exercise_id == exercise,
178
WorksheetExercise.worksheet_id == Worksheet.id,
179
Worksheet.offering_id == Offering.id,
180
Offering.subject_id == Subject.id,
181
Subject.short_name == subject,
182
Offering.semester_id == Semester.id,
183
Semester.year == year,
184
Semester.semester == semester).one()
186
if self.context is None:
189
@named_operation('view')
190
def save(self, req, text):
191
# Find the appropriate WorksheetExercise to save to. If its not found,
192
# the user is submitting against a non-existant worksheet/exercise
194
old_save = req.store.find(ExerciseSave,
195
ExerciseSave.ws_ex_id == self.context.id,
196
ExerciseSave.user == req.user).one()
198
#Overwrite the old, or create a new if there isn't one
200
new_save = ExerciseSave()
201
req.store.add(new_save)
205
new_save.worksheet_exercise = self.context
206
new_save.user = req.user
207
new_save.text = unicode(text)
208
new_save.date = datetime.datetime.now()
210
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 __init__(self, req, **kwargs):
220
self.worksheet = kwargs['worksheet']
221
self.subject = kwargs['subject']
222
self.year = kwargs['year']
223
self.semester = kwargs['semester']
225
self.context = req.store.find(Worksheet,
226
Worksheet.identifier == self.worksheet,
227
Worksheet.offering_id == Offering.id,
228
Offering.subject_id == Subject.id,
229
Subject.short_name == self.subject,
230
Offering.semester_id == Semester.id,
231
Semester.year == self.year,
232
Semester.semester == self.semester).one()
234
if self.context is None:
237
@named_operation('edit')
238
def save(self, req, name, assessable, data, format):
239
"""Takes worksheet data and saves it."""
240
self.context.name = unicode(name)
241
self.context.assessable = self.convert_bool(assessable)
242
self.context.data = unicode(data)
243
self.context.format = unicode(format)
244
ivle.worksheet.utils.update_exerciselist(self.context)
246
return {"result": "ok"}
248
class WorksheetsRESTView(JSONRESTView):
249
"""View used to update and create Worksheets."""
251
def __init__(self, req, **kwargs):
253
self.subject = kwargs['subject']
254
self.year = kwargs['year']
255
self.semester = kwargs['semester']
257
self.context = req.store.find(Offering,
258
Offering.subject_id == Subject.id,
259
Subject.short_name == self.subject,
260
Offering.semester_id == Semester.id,
261
Semester.year == self.year,
262
Semester.semester == self.semester).one()
264
if self.context is None:
267
@named_operation('edit')
268
def add_worksheet(self, req, identifier, name, assessable, data, format):
269
"""Takes worksheet data and adds it."""
271
new_worksheet = Worksheet()
272
new_worksheet.seq_no = self.context.worksheets.count()
273
# Setting new_worksheet.offering implicitly adds new_worksheet,
274
# hence worksheets.count MUST be called above it
275
new_worksheet.offering = self.context
276
new_worksheet.identifier = unicode(identifier)
277
new_worksheet.name = unicode(name)
278
new_worksheet.assessable = self.convert_bool(assessable)
279
new_worksheet.data = unicode(data)
280
new_worksheet.format = unicode(format)
282
# This call is added for clarity, as the worksheet is implicitly added.
283
req.store.add(new_worksheet)
285
ivle.worksheet.utils.update_exerciselist(new_worksheet)
287
return {"result": "ok"}
289
@named_operation('edit')
290
def move_up(self, req, worksheetid):
291
"""Takes a list of worksheet-seq_no pairs and updates their
292
corresponding Worksheet objects to match."""
294
worksheet_below = req.store.find(Worksheet,
295
Worksheet.offering_id == self.context.id,
296
Worksheet.identifier == unicode(worksheetid)).one()
297
if worksheet_below is None:
298
raise NotFound('worksheet_below')
299
worksheet_above = req.store.find(Worksheet,
300
Worksheet.offering_id == self.context.id,
301
Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
302
if worksheet_above is None:
303
raise NotFound('worksheet_above')
305
worksheet_below.seq_no = worksheet_below.seq_no - 1
306
worksheet_above.seq_no = worksheet_above.seq_no + 1
308
return {'result': 'ok'}
310
@named_operation('edit')
311
def move_down(self, req, worksheetid):
312
"""Takes a list of worksheet-seq_no pairs and updates their
313
corresponding Worksheet objects to match."""
315
worksheet_above = req.store.find(Worksheet,
316
Worksheet.offering_id == self.context.id,
317
Worksheet.identifier == unicode(worksheetid)).one()
318
if worksheet_above is None:
319
raise NotFound('worksheet_below')
320
worksheet_below = req.store.find(Worksheet,
321
Worksheet.offering_id == self.context.id,
322
Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
323
if worksheet_below is None:
324
raise NotFound('worksheet_above')
326
worksheet_below.seq_no = worksheet_below.seq_no - 1
327
worksheet_above.seq_no = worksheet_above.seq_no + 1
329
return {'result': 'ok'}
added
removed
ivle/webapp/tutorial/service.py
