20
20
'''AJAX backend for the tutorial application.'''
25
from storm.locals import Store
28
27
import ivle.database
29
28
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
30
Offering, Subject, Semester, WorksheetExercise
33
import ivle.webapp.tutorial.test
29
Offering, Subject, Semester, User, WorksheetExercise
30
import ivle.worksheet.utils
35
31
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
36
32
require_permission)
37
33
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
36
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
45
39
class AttemptsRESTView(JSONRESTView):
46
40
'''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
42
@require_permission('edit')
67
43
def GET(self, req):
68
44
"""Handles a GET Attempts action."""
69
45
attempts = req.store.find(ExerciseAttempt,
70
ExerciseAttempt.ws_ex_id == self.worksheet_exercise.id,
71
ExerciseAttempt.user_id == self.user.id)
46
ExerciseAttempt.ws_ex_id == self.context.worksheet_exercise.id,
47
ExerciseAttempt.user_id == self.context.user.id)
72
48
# attempts is a list of ExerciseAttempt objects. Convert to dictionaries
73
49
time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
74
50
attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
124
83
class AttemptRESTView(JSONRESTView):
125
84
'''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
86
@require_permission('view')
162
87
def GET(self, req):
163
88
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')
91
class WorksheetExerciseRESTView(JSONRESTView):
92
'''REST view of a worksheet exercise.'''
94
@named_operation('view')
179
95
def save(self, req, text):
180
96
# Find the appropriate WorksheetExercise to save to. If its not found,
181
97
# 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
99
old_save = req.store.find(ExerciseSave,
196
ExerciseSave.ws_ex_id == worksheet_exercise.id,
100
ExerciseSave.ws_ex_id == self.context.id,
197
101
ExerciseSave.user == req.user).one()
199
103
#Overwrite the old, or create a new if there isn't one
211
115
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
self.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)
306
return {"result": "ok"}
308
118
class WorksheetsRESTView(JSONRESTView):
309
119
"""View used to update and create Worksheets."""
311
def get_permissions(self, user):
312
# XXX: Do it properly.
313
# XXX: Lecturers should be allowed to add worksheets Only to subjects
314
# under their control
316
if user.rolenm == 'admin':
317
return set(['add_worksheet', 'set_sequence'])
323
def __init__(self, req, **kwargs):
325
self.subject = kwargs['subject']
326
self.year = kwargs['year']
327
self.semester = kwargs['semester']
329
self.context = req.store.find(Offering,
330
Offering.subject_id == Subject.id,
331
Subject.code == self.subject,
332
Offering.semester_id == Semester.id,
333
Semester.year == self.year,
334
Semester.semester == self.semester).one()
336
if self.context is None:
339
@named_operation('add_worksheet')
340
def add_worksheet(self, req, identifier, name, assessable, data, format):
341
"""Takes worksheet data and adds it."""
343
new_worksheet = Worksheet()
344
new_worksheet.seq_no = self.context.worksheets.count()
345
# Setting new_worksheet.offering implicitly adds new_worksheet,
346
# hence worksheets.count MUST be called above it
347
new_worksheet.offering = self.context
348
new_worksheet.identifier = unicode(identifier)
349
new_worksheet.name = unicode(name)
350
new_worksheet.assessable = self.convert_bool(assessable)
351
new_worksheet.data = unicode(data)
352
new_worksheet.format = unicode(format)
354
# This call is added for clarity, as the worksheet is implicitly added.
355
req.store.add(new_worksheet)
357
generate_exerciselist(new_worksheet, req, data)
359
return {"result": "ok"}
361
@named_operation('set_sequence')
362
def seq_sequence(self, req, worksheet_list):
363
"""Takes a list of worksheet-seq_no pairs and updates their
364
corresponding Worksheet objects to match."""
366
for worksheetid, seq_no in worksheet_list:
367
worksheet = req.store.find(Worksheet,
368
Worksheet.offering_id == self.context.id,
369
Worksheet.identifier == worksheetid).one()
370
if worksheet is None:
371
raise NotFound(worksheet)
372
worksheet.seq_no = seq_no
121
@named_operation('edit_worksheets')
122
def move_up(self, req, worksheetid):
123
"""Takes a list of worksheet-seq_no pairs and updates their
124
corresponding Worksheet objects to match."""
126
worksheet_below = req.store.find(Worksheet,
127
Worksheet.offering_id == self.context.id,
128
Worksheet.identifier == unicode(worksheetid)).one()
129
if worksheet_below is None:
130
raise NotFound('worksheet_below')
131
worksheet_above = req.store.find(Worksheet,
132
Worksheet.offering_id == self.context.id,
133
Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
134
if worksheet_above is None:
135
raise NotFound('worksheet_above')
137
worksheet_below.seq_no = worksheet_below.seq_no - 1
138
worksheet_above.seq_no = worksheet_above.seq_no + 1
140
return {'result': 'ok'}
142
@named_operation('edit_worksheets')
143
def move_down(self, req, worksheetid):
144
"""Takes a list of worksheet-seq_no pairs and updates their
145
corresponding Worksheet objects to match."""
147
worksheet_above = req.store.find(Worksheet,
148
Worksheet.offering_id == self.context.id,
149
Worksheet.identifier == unicode(worksheetid)).one()
150
if worksheet_above is None:
151
raise NotFound('worksheet_below')
152
worksheet_below = req.store.find(Worksheet,
153
Worksheet.offering_id == self.context.id,
154
Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
155
if worksheet_below is None:
156
raise NotFound('worksheet_above')
158
worksheet_below.seq_no = worksheet_below.seq_no - 1
159
worksheet_above.seq_no = worksheet_above.seq_no + 1
374
161
return {'result': 'ok'}