61
43
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
65
"""Handler for Ajax backend TutorialService app."""
66
# Set request attributes
67
req.write_html_head_foot = False # No HTML
70
req.throw_error(req.HTTP_BAD_REQUEST)
71
fields = req.get_fieldstorage()
72
act = fields.getfirst('action')
73
exercise = fields.getfirst('exercise')
74
if act is None or exercise is None:
75
req.throw_error(req.HTTP_BAD_REQUEST)
77
exercise = exercise.value
79
if act == 'save' or act == 'test':
81
if req.method != 'POST':
82
req.throw_error(req.HTTP_BAD_REQUEST)
84
code = fields.getfirst('code')
86
req.throw_error(req.HTTP_BAD_REQUEST)
90
handle_save(req, exercise, code, fields)
92
handle_test(req, exercise, code, fields)
93
elif act == 'getattempts':
94
handle_getattempts(req, exercise)
95
elif act == 'getattempt':
96
date = fields.getfirst('date')
98
req.throw_error(req.HTTP_BAD_REQUEST)
100
# Convert into a struct_time
101
# The time *should* be in the same format as the DB (since it should
102
# be bounced back to us from the getattempts output). Assume this.
104
date = datetime.datetime.strptime(date, TIMESTAMP_FORMAT)
106
# Date was not in correct format
107
req.throw_error(req.HTTP_BAD_REQUEST)
108
handle_getattempt(req, exercise, date)
110
req.throw_error(req.HTTP_BAD_REQUEST)
112
def handle_save(req, exercisename, code, fields):
113
"""Handles a save action. This saves the user's code without executing it.
115
# Need to open JUST so we know this is a real exercise.
116
# (This avoids users submitting code for bogus exercises).
117
exercisefile = util.open_exercise_file(exercisename)
118
if exercisefile is None:
119
req.throw_error(req.HTTP_NOT_FOUND,
120
"The exercise was not found.")
123
exercise = ivle.database.Exercise.get_by_name(req.store, exercisename)
124
ivle.worksheet.save_exercise(req.store, req.user, exercise,
125
unicode(code), datetime.datetime.now())
128
req.write('{"result": "ok"}')
131
def handle_test(req, exercisesrc, code, fields):
132
"""Handles a test action."""
134
exercisefile = util.open_exercise_file(exercisesrc)
135
if exercisefile is None:
136
req.throw_error(req.HTTP_NOT_FOUND,
137
"The exercise was not found.")
139
# Start a console to run the tests on
140
jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
141
working_dir = os.path.join("/home", req.user.login)
142
cons = console.Console(req.user.unixid, jail_path, working_dir)
144
# Parse the file into a exercise object using the test suite
145
exercise_obj = test.parse_exercise_file(exercisefile, cons)
148
# Run the test cases. Get the result back as a JSONable object.
150
test_results = exercise_obj.run_tests(code)
155
# Get the Exercise from the database
156
exercise = ivle.database.Exercise.get_by_name(req.store, exercisesrc)
158
attempt = ivle.database.ExerciseAttempt(user=req.user,
160
date=datetime.datetime.now(),
161
complete=test_results['passed'],
162
text=unicode(code)) # XXX
164
req.store.add(attempt)
166
# Query the DB to get an updated score on whether or not this problem
167
# has EVER been completed (may be different from "passed", if it has
168
# been completed before), and the total number of attempts.
169
completed, attempts = ivle.worksheet.get_exercise_status(req.store,
171
test_results["completed"] = completed
172
test_results["attempts"] = attempts
174
req.write(cjson.encode(test_results))
176
def handle_getattempts(req, exercisename):
177
"""Handles a getattempts action."""
178
exercise = ivle.database.Exercise.get_by_name(req.store, exercisename)
179
attempts = ivle.worksheet.get_exercise_attempts(req.store, req.user,
180
exercise, allow_inactive=HISTORY_ALLOW_INACTIVE)
181
# attempts is a list of ExerciseAttempt objects. Convert to dictionaries.
182
time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
183
attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
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}
184
75
for a in attempts]
185
req.write(cjson.encode(attempts))
187
def handle_getattempt(req, exercisename, date):
188
"""Handles a getattempts action. Date is a datetime.datetime."""
189
exercise = ivle.database.Exercise.get_by_name(req.store, exercisename)
190
attempt = ivle.worksheet.get_exercise_attempt(req.store, req.user,
191
exercise, as_of=date, allow_inactive=HISTORY_ALLOW_INACTIVE)
192
if attempt is not None:
193
attempt = attempt.text
194
# attempt may be None; will write "null"
195
req.write(cjson.encode({'code': attempt}))
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.get_exercise_status(req.store,
117
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
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 = req.store.find(ExerciseAttempt,
151
ExerciseAttempt.user_id == user.id,
152
ExerciseAttempt.ws_ex_id == worksheet_exercise.id,
153
ExerciseAttempt.date == date
159
self.context = attempt
161
@require_permission('view')
163
return {'code': self.context.text}
166
class ExerciseRESTView(JSONRESTView):
167
'''REST view of an exercise.'''
169
def get_permissions(self, user):
170
# XXX: Do it properly.
171
# XXX: Does any user have the ability to save as themselves?
172
# XXX: Does a user EVER have permission to save as another user?
178
@named_operation('save')
179
def save(self, req, text):
180
# Find the appropriate WorksheetExercise to save to. If its not found,
181
# the user is submitting against a non-existant worksheet/exercise
182
worksheet_exercise = req.store.find(WorksheetExercise,
183
WorksheetExercise.exercise_id == self.exercise,
184
WorksheetExercise.worksheet_id == Worksheet.id,
185
Worksheet.offering_id == Offering.id,
186
Offering.subject_id == Subject.id,
187
Subject.code == self.subject,
188
Offering.semester_id == Semester.id,
189
Semester.year == self.year,
190
Semester.semester == self.semester).one()
192
if worksheet_exercise is None:
195
old_save = req.store.find(ExerciseSave,
196
ExerciseSave.ws_ex_id == worksheet_exercise.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 = worksheet_exercise
207
new_save.user = req.user
208
new_save.text = unicode(text)
209
new_save.date = datetime.datetime.now()
211
return {"result": "ok"}
214
def generate_exerciselist(worksheet, req, worksheetdata):
215
"""Runs through the worksheetstream, generating the appropriate
216
WorksheetExercises, and de-activating the old ones."""
218
# Turns the worksheet into an xml stream, and then finds all the
219
# exercise nodes in the stream.
220
worksheetdata = genshi.XML(worksheetdata)
221
for kind, data, pos in worksheetdata:
222
if kind is genshi.core.START:
223
# Data is a tuple of tag name and a list of name->value tuples
224
if data[0] == 'exercise':
230
if attr[0] == 'optional':
231
optional = attr[1] == 'true'
233
exercises.append((src, optional))
235
# Set all current worksheet_exercises to be inactive
236
db_worksheet_exercises = req.store.find(WorksheetExercise,
237
WorksheetExercise.worksheet_id == worksheet.id)
238
for worksheet_exercise in db_worksheet_exercises:
239
worksheet_exercise.active = False
241
for exerciseid, optional in exercises:
242
worksheet_exercise = req.store.find(WorksheetExercise,
243
WorksheetExercise.worksheet_id == worksheet.id,
244
Exercise.id == WorksheetExercise.exercise_id,
245
Exercise.id == exerciseid).one()
246
if worksheet_exercise is None:
247
exercise = req.store.find(Exercise,
248
Exercise.id == exerciseid
252
worksheet_exercise = WorksheetExercise()
253
worksheet_exercise.worksheet_id = worksheet.id
254
worksheet_exercise.exercise_id = exercise.id
255
req.store.add(worksheet_exercise)
256
worksheet_exercise.active = True
257
worksheet_exercise.seq_no = ex_num
258
worksheet_exercise.optional = optional
261
# Note that this is the view of an existing worksheet. Creation is handled
262
# by OfferingRESTView (as offerings have worksheets)
263
class WorksheetRESTView(JSONRESTView):
264
"""View used to update a worksheet."""
266
def get_permissions(self, user):
267
# XXX: Do it properly.
268
# XXX: Lecturers should be allowed to add worksheets Only to subjects
269
# under their control
271
if user.rolenm == 'admin':
278
def __init__(self, req, **kwargs):
280
self.worksheet = kwargs['worksheet']
281
self.subject = kwargs['subject']
282
self.year = kwargs['year']
283
self.semester = kwargs['semester']
285
self.context = req.store.find(Worksheet,
286
Worksheet.identifier == self.worksheet,
287
Worksheet.offering_id == Offering.id,
288
Offering.subject_id == Subject.id,
289
Subject.code == self.subject,
290
Offering.semester_id == Semester.id,
291
Semester.year == self.year,
292
Semester.semester == self.semester).one()
294
if self.context is None:
297
@named_operation('save')
298
def save(self, req, name, assessable, data, format):
299
"""Takes worksheet data and saves it."""
300
generate_exerciselist(self.context, req, data)
302
self.context.name = unicode(name)
303
self.context.assessable = self.convert_bool(assessable)
304
self.context.data = unicode(data)
305
self.context.format = unicode(format)
307
return {"result": "ok"}
309
class WorksheetsRESTView(JSONRESTView):
310
"""View used to update and create Worksheets."""
312
def get_permissions(self, user):
313
# XXX: Do it properly.
314
# XXX: Lecturers should be allowed to add worksheets Only to subjects
315
# under their control
317
if user.rolenm == 'admin':
324
def __init__(self, req, **kwargs):
326
self.subject = kwargs['subject']
327
self.year = kwargs['year']
328
self.semester = kwargs['semester']
330
self.context = req.store.find(Offering,
331
Offering.subject_id == Subject.id,
332
Subject.code == self.subject,
333
Offering.semester_id == Semester.id,
334
Semester.year == self.year,
335
Semester.semester == self.semester).one()
337
if self.context is None:
340
@named_operation('edit')
341
def add_worksheet(self, req, identifier, name, assessable, data, format):
342
"""Takes worksheet data and adds it."""
344
new_worksheet = Worksheet()
345
new_worksheet.seq_no = self.context.worksheets.count()
346
# Setting new_worksheet.offering implicitly adds new_worksheet,
347
# hence worksheets.count MUST be called above it
348
new_worksheet.offering = self.context
349
new_worksheet.identifier = unicode(identifier)
350
new_worksheet.name = unicode(name)
351
new_worksheet.assessable = self.convert_bool(assessable)
352
new_worksheet.data = unicode(data)
353
new_worksheet.format = unicode(format)
355
# This call is added for clarity, as the worksheet is implicitly added.
356
req.store.add(new_worksheet)
358
generate_exerciselist(new_worksheet, req, data)
360
return {"result": "ok"}
362
@named_operation('edit')
363
def move_up(self, req, worksheetid):
364
"""Takes a list of worksheet-seq_no pairs and updates their
365
corresponding Worksheet objects to match."""
367
worksheet_below = req.store.find(Worksheet,
368
Worksheet.offering_id == self.context.id,
369
Worksheet.identifier == unicode(worksheetid)).one()
370
if worksheet_below is None:
371
raise NotFound('worksheet_below')
372
worksheet_above = req.store.find(Worksheet,
373
Worksheet.offering_id == self.context.id,
374
Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
375
if worksheet_above is None:
376
raise NotFound('worksheet_above')
378
worksheet_below.seq_no = worksheet_below.seq_no - 1
379
worksheet_above.seq_no = worksheet_above.seq_no + 1
381
return {'result': 'ok'}
383
@named_operation('edit')
384
def move_down(self, req, worksheetid):
385
"""Takes a list of worksheet-seq_no pairs and updates their
386
corresponding Worksheet objects to match."""
388
worksheet_above = req.store.find(Worksheet,
389
Worksheet.offering_id == self.context.id,
390
Worksheet.identifier == unicode(worksheetid)).one()
391
if worksheet_above is None:
392
raise NotFound('worksheet_below')
393
worksheet_below = req.store.find(Worksheet,
394
Worksheet.offering_id == self.context.id,
395
Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
396
if worksheet_below is None:
397
raise NotFound('worksheet_above')
399
worksheet_below.seq_no = worksheet_below.seq_no - 1
400
worksheet_above.seq_no = worksheet_above.seq_no + 1
402
return {'result': 'ok'}
added
removed
ivle/webapp/tutorial/service.py
