~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to ivle/webapp/tutorial/service.py

  • Committer: Nick Chadwick
  • Date: 2009-02-23 23:11:26 UTC
  • mto: (1099.1.227 exercise-ui)
  • mto: This revision was merged to the branch mainline in revision 1100.
  • Revision ID: chadnickbok@gmail.com-20090223231126-zfb5wfw8jnxazefl
Fixed database so that lecturers can edit worksheets

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# IVLE - Informatics Virtual Learning Environment
2
 
# Copyright (C) 2007-2008 The University of Melbourne
 
2
# Copyright (C) 2007-2009 The University of Melbourne
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
5
5
# it under the terms of the GNU General Public License as published by
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
17
17
 
18
 
# Module: TutorialService
19
 
# Author: Matt Giuca
20
 
# Date:   25/1/2008
21
 
 
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.
25
 
 
26
 
# Calling syntax
27
 
# Path must be empty.
28
 
# The arguments determine what is to be done on this file.
29
 
 
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)
39
 
#   that date.
40
 
#   Returns JSON string containing code, or null.
41
 
 
42
 
# Returns a JSON response string indicating the results.
 
18
# Author: Matt Giuca, Nick Chadwick
 
19
 
 
20
'''AJAX backend for the tutorial application.'''
43
21
 
44
22
import os
45
 
import time
46
23
import datetime
47
 
 
48
 
import cjson
49
 
 
50
 
from ivle import util
51
 
from ivle import console
 
24
import genshi
 
25
 
 
26
import ivle.util
 
27
import ivle.console
52
28
import ivle.database
 
29
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
 
30
                          Offering, Subject, Semester, WorksheetExercise
53
31
import ivle.worksheet
54
32
import ivle.conf
55
 
import ivle.webapp.tutorial.test # XXX: Really .test, not real test.
 
33
import ivle.webapp.tutorial.test
56
34
 
57
 
from ivle.webapp.base.rest import JSONRESTView
58
 
import ivle.database
59
 
from ivle.webapp.base.rest import named_operation
 
35
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
 
36
                                   require_permission)
 
37
from ivle.webapp.errors import NotFound
60
38
 
61
39
# If True, getattempts or getattempt will allow browsing of inactive/disabled
62
40
# attempts. If False, will not allow this.
64
42
 
65
43
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
66
44
 
67
 
 
68
45
class AttemptsRESTView(JSONRESTView):
69
 
    '''
70
 
    Class to return a list of attempts for a given exercise, or add an Attempt
71
 
    '''
 
46
    '''REST view of a user's attempts at an exercise.'''
 
47
    
 
48
    def __init__(self, req, subject, year, semester, worksheet, 
 
49
                                                exercise, username):
 
50
        self.user = ivle.database.User.get_by_login(req.store, username)
 
51
        if self.user is None:
 
52
            raise NotFound()
 
53
        
 
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()
 
63
        
 
64
        self.context = self.user # XXX: Not quite right.
 
65
 
 
66
    @require_permission('edit')
72
67
    def GET(self, req):
73
68
        """Handles a GET Attempts action."""
74
 
        exercise = ivle.database.Exercise.get_by_name(req.store, 
75
 
                                                        self.exercise)
76
 
        user = ivle.database.User.get_by_login(req.store, self.username)
77
 
 
78
 
        attempts = ivle.worksheet.get_exercise_attempts(req.store, user,
79
 
                            exercise, allow_inactive=HISTORY_ALLOW_INACTIVE)
 
69
        attempts = req.store.find(ExerciseAttempt, 
 
70
                ExerciseAttempt.ws_ex_id == self.worksheet_exercise.id,
 
71
                ExerciseAttempt.user_id == self.user.id)
80
72
        # attempts is a list of ExerciseAttempt objects. Convert to dictionaries
81
73
        time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
82
74
        attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
83
75
                for a in attempts]
84
 
                
 
76
 
85
77
        return attempts
86
 
        
 
78
 
 
79
 
 
80
    @require_permission('edit')
87
81
    def PUT(self, req, data):
88
 
        ''' Tests the given submission '''
89
 
        exercisefile = util.open_exercise_file(self.exercise)
90
 
        if exercisefile is None:
91
 
            req.throw_error(req.HTTP_NOT_FOUND,
92
 
                "The exercise was not found.")
 
82
        """ Tests the given submission """
 
83
        exercise = req.store.find(Exercise, 
 
84
            Exercise.id == self.worksheet_exercise.exercise_id).one()
 
85
        if exercise is None:
 
86
            raise NotFound()
93
87
 
94
88
        # Start a console to run the tests on
95
89
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
96
90
        working_dir = os.path.join("/home", req.user.login)
97
 
        cons = console.Console(req.user.unixid, jail_path, working_dir)
 
91
        cons = ivle.console.Console(req.user.unixid, jail_path, working_dir)
98
92
 
99
93
        # Parse the file into a exercise object using the test suite
100
94
        exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
101
 
                                                            exercisefile, cons)
102
 
        exercisefile.close()
 
95
                                                            exercise, cons)
103
96
 
104
97
        # Run the test cases. Get the result back as a JSONable object.
105
98
        # Return it.
108
101
        # Close the console
109
102
        cons.close()
110
103
 
111
 
        # Get the Exercise from the database
112
 
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
113
 
 
114
104
        attempt = ivle.database.ExerciseAttempt(user=req.user,
115
 
                                                exercise=exercise,
116
 
                                                date=datetime.datetime.now(),
117
 
                                                complete=test_results['passed'],
118
 
                                                # XXX
119
 
                                                text=unicode(data['code']))
 
105
            worksheet_exercise = self.worksheet_exercise,
 
106
            date = datetime.datetime.now(),
 
107
            complete = test_results['passed'],
 
108
            text = unicode(data['code'])
 
109
        )
120
110
 
121
111
        req.store.add(attempt)
122
 
        req.store.commit()
 
112
 
123
113
        # Query the DB to get an updated score on whether or not this problem
124
114
        # has EVER been completed (may be different from "passed", if it has
125
115
        # been completed before), and the total number of attempts.
126
116
        completed, attempts = ivle.worksheet.get_exercise_status(req.store,
127
 
            req.user, exercise)
 
117
            req.user, self.worksheet_exercise)
128
118
        test_results["completed"] = completed
129
119
        test_results["attempts"] = attempts
130
120
 
131
121
        return test_results
132
 
        
 
122
 
133
123
 
134
124
class AttemptRESTView(JSONRESTView):
135
 
    '''
136
 
    View used to extract the data of a specified attempt
137
 
    '''
138
 
    
 
125
    '''REST view of an exercise attempt.'''
 
126
 
 
127
    def __init__(self, req, subject, year, semester, worksheet, exercise, 
 
128
                 username, date):
 
129
        # TODO: Find exercise within worksheet.
 
130
        user = ivle.database.User.get_by_login(req.store, username)
 
131
        if user is None:
 
132
            raise NotFound()
 
133
 
 
134
        try:
 
135
            date = datetime.datetime.strptime(date, TIMESTAMP_FORMAT)
 
136
        except ValueError:
 
137
            raise NotFound()
 
138
 
 
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()
 
149
            
 
150
        attempt = ivle.worksheet.get_exercise_attempt(req.store, user,
 
151
                        worksheet_exercise, as_of=date,
 
152
                        allow_inactive=HISTORY_ALLOW_INACTIVE) 
 
153
 
 
154
        if attempt is None:
 
155
            raise NotFound()
 
156
 
 
157
        self.context = attempt
 
158
 
 
159
    @require_permission('view')
139
160
    def GET(self, req):
140
 
        # Get an actual date object, rather than a string
141
 
        date = datetime.datetime.strptime(self.date, TIMESTAMP_FORMAT)
142
 
        
143
 
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
144
 
        attempt = ivle.worksheet.get_exercise_attempt(req.store, req.user,
145
 
            exercise, as_of=date, allow_inactive=HISTORY_ALLOW_INACTIVE)
146
 
        if attempt is not None:
147
 
            attempt = attempt.text
148
 
        # attempt may be None; will write "null"
149
 
        return {'code': attempt}
150
 
        
 
161
        return {'code': self.context.text}
 
162
 
 
163
 
151
164
class ExerciseRESTView(JSONRESTView):
152
 
    '''
153
 
    Handles a save action. This saves the user's code without executing it.
154
 
    '''
155
 
    @named_operation
 
165
    '''REST view of an exercise.'''
 
166
 
 
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?
 
171
        if user is not None:
 
172
            return set(['save'])
 
173
        else:
 
174
            return set()
 
175
 
 
176
    @named_operation('save')
156
177
    def save(self, req, text):
157
 
        # Need to open JUST so we know this is a real exercise.
158
 
        # (This avoids users submitting code for bogus exercises).
159
 
        exercisefile = util.open_exercise_file(self.exercise)
160
 
        if exercisefile is None:
161
 
            req.throw_error(req.HTTP_NOT_FOUND,
162
 
                "The exercise was not found.")
163
 
        exercisefile.close()
164
 
 
165
 
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
166
 
        ivle.worksheet.save_exercise(req.store, req.user, exercise,
167
 
                                     unicode(text), datetime.datetime.now())
168
 
        req.store.commit()
169
 
        return {"result": "ok"}
 
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()
 
189
        
 
190
        if worksheet_exercise is None:
 
191
            raise NotFound()
 
192
 
 
193
        old_save = req.store.find(ExerciseSave,
 
194
            ExerciseSave.ws_ex_id == worksheet_exercise.id,
 
195
            ExerciseSave.user == req.user).one()
 
196
        
 
197
        #Overwrite the old, or create a new if there isn't one
 
198
        if old_save is None:
 
199
            new_save = ExerciseSave()
 
200
            req.store.add(new_save)
 
201
        else:
 
202
            new_save = old_save
 
203
        
 
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()
 
208
 
 
209
        return {"result": "ok"}
 
210
 
 
211
 
 
212
def generate_exerciselist(worksheet, req, worksheetdata):
 
213
    """Runs through the worksheetstream, generating the appropriate
 
214
    WorksheetExercises, and de-activating the old ones."""
 
215
    exercises = []
 
216
    # Turns the worksheet into an xml stream, and then finds all the 
 
217
    # exercise nodes in the stream.
 
218
    worksheetdata = genshi.XML(worksheetdata)
 
219
    for kind, data, pos in worksheetdata:
 
220
        if kind is genshi.core.START:
 
221
            # Data is a tuple of tag name and a list of name->value tuples
 
222
            if data[0] == 'exercise':
 
223
                src = ""
 
224
                optional = False
 
225
                for attr in data[1]:
 
226
                    if attr[0] == 'src':
 
227
                        src = attr[1]
 
228
                    if attr[0] == 'optional':
 
229
                        optional = attr[1] == 'true'
 
230
                if src != "":
 
231
                    exercises.append((src, optional))
 
232
    ex_num = 0
 
233
    # Set all current worksheet_exercises to be inactive
 
234
    db_worksheet_exercises = req.store.find(WorksheetExercise,
 
235
        WorksheetExercise.worksheet_id == worksheet.id)
 
236
    for worksheet_exercise in db_worksheet_exercises:
 
237
        worksheet_exercise.active = False
 
238
    
 
239
    for exerciseid, optional in exercises:
 
240
        worksheet_exercise = req.store.find(WorksheetExercise,
 
241
            WorksheetExercise.worksheet_id == worksheet.id,
 
242
            Exercise.id == WorksheetExercise.exercise_id,
 
243
            Exercise.id == exerciseid).one()
 
244
        if worksheet_exercise is None:
 
245
            exercise = req.store.find(Exercise,
 
246
                Exercise.id == exerciseid
 
247
            ).one()
 
248
            if exercise is None:
 
249
                raise NotFound()
 
250
            worksheet_exercise = WorksheetExercise()
 
251
            worksheet_exercise.worksheet_id = worksheet.id
 
252
            worksheet_exercise.exercise_id = exercise.id
 
253
            req.store.add(worksheet_exercise)
 
254
        worksheet_exercise.active = True
 
255
        worksheet_exercise.seq_no = ex_num
 
256
        worksheet_exercise.optional = optional
 
257
 
 
258
 
 
259
# Note that this is the view of an existing worksheet. Creation is handled
 
260
# by OfferingRESTView (as offerings have worksheets)
 
261
class WorksheetRESTView(JSONRESTView):
 
262
    """View used to update a worksheet."""
 
263
 
 
264
    def get_permissions(self, user):
 
265
        # XXX: Do it properly.
 
266
        # XXX: Lecturers should be allowed to add worksheets Only to subjects
 
267
        #      under their control
 
268
        if user is not None:
 
269
            if user.rolenm == 'admin':
 
270
                return set(['save'])
 
271
            else:
 
272
                return set()
 
273
        else:
 
274
            return set()    
 
275
 
 
276
    def __init__(self, req, **kwargs):
 
277
    
 
278
        self.worksheet = kwargs['worksheet']
 
279
        self.subject = kwargs['subject']
 
280
        self.year = kwargs['year']
 
281
        self.semester = kwargs['semester']
 
282
    
 
283
        self.context = req.store.find(Worksheet,
 
284
            Worksheet.identifier == self.worksheet,
 
285
            Worksheet.offering_id == Offering.id,
 
286
            Offering.subject_id == Subject.id,
 
287
            Subject.code == self.subject,
 
288
            Offering.semester_id == Semester.id,
 
289
            Semester.year == self.year,
 
290
            Semester.semester == self.semester).one()
 
291
        
 
292
        if self.context is None:
 
293
            raise NotFound()
 
294
    
 
295
    @named_operation('save')
 
296
    def save(self, req, name, assessable, data, format):
 
297
        """Takes worksheet data and saves it."""
 
298
        generate_exerciselist(self.context, req, data)
 
299
        
 
300
        self.context.name = unicode(name)
 
301
        self.context.assessable = self.convert_bool(assessable)
 
302
        self.context.data = unicode(data)
 
303
        self.context.format = unicode(format)
 
304
        
 
305
        return {"result": "ok"}
 
306
 
 
307
class WorksheetsRESTView(JSONRESTView):
 
308
    """View used to update and create Worksheets."""
 
309
    
 
310
    def get_permissions(self, user):
 
311
        # XXX: Do it properly.
 
312
        # XXX: Lecturers should be allowed to add worksheets Only to subjects
 
313
        #      under their control
 
314
        if user is not None:
 
315
            if user.rolenm == 'admin':
 
316
                return set(['edit'])
 
317
            else:
 
318
                return set()
 
319
        else:
 
320
            return set()
 
321
 
 
322
    def __init__(self, req, **kwargs):
 
323
    
 
324
        self.subject = kwargs['subject']
 
325
        self.year = kwargs['year']
 
326
        self.semester = kwargs['semester']
 
327
    
 
328
        self.context = req.store.find(Offering,
 
329
            Offering.subject_id == Subject.id,
 
330
            Subject.code == self.subject,
 
331
            Offering.semester_id == Semester.id,
 
332
            Semester.year == self.year,
 
333
            Semester.semester == self.semester).one()
 
334
        
 
335
        if self.context is None:
 
336
            raise NotFound()
 
337
 
 
338
    @named_operation('edit')
 
339
    def add_worksheet(self, req, identifier, name, assessable, data, format):
 
340
        """Takes worksheet data and adds it."""
 
341
        
 
342
        new_worksheet = Worksheet()
 
343
        new_worksheet.seq_no = self.context.worksheets.count()
 
344
        # Setting new_worksheet.offering implicitly adds new_worksheet,
 
345
        # hence worksheets.count MUST be called above it
 
346
        new_worksheet.offering = self.context
 
347
        new_worksheet.identifier = unicode(identifier)
 
348
        new_worksheet.name = unicode(name)
 
349
        new_worksheet.assessable = self.convert_bool(assessable)
 
350
        new_worksheet.data = unicode(data)
 
351
        new_worksheet.format = unicode(format)
 
352
        
 
353
        # This call is added for clarity, as the worksheet is implicitly added.        
 
354
        req.store.add(new_worksheet)
 
355
        
 
356
        generate_exerciselist(new_worksheet, req, data)
 
357
        
 
358
        return {"result": "ok"}
 
359
 
 
360
    @named_operation('edit')
 
361
    def move_up(self, req, worksheetid):
 
362
        """Takes a list of worksheet-seq_no pairs and updates their 
 
363
        corresponding Worksheet objects to match."""
 
364
        
 
365
        worksheet_below = req.store.find(Worksheet,
 
366
            Worksheet.offering_id == self.context.id,
 
367
            Worksheet.identifier == unicode(worksheetid)).one()
 
368
        if worksheet_below is None:
 
369
            raise NotFound('worksheet_below')
 
370
        worksheet_above = req.store.find(Worksheet,
 
371
            Worksheet.offering_id == self.context.id,
 
372
            Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
 
373
        if worksheet_above is None:
 
374
            raise NotFound('worksheet_above')
 
375
 
 
376
        worksheet_below.seq_no = worksheet_below.seq_no - 1
 
377
        worksheet_above.seq_no = worksheet_above.seq_no + 1
 
378
        
 
379
        return {'result': 'ok'}
 
380
 
 
381
    @named_operation('edit')
 
382
    def move_down(self, req, worksheetid):
 
383
        """Takes a list of worksheet-seq_no pairs and updates their 
 
384
        corresponding Worksheet objects to match."""
 
385
        
 
386
        worksheet_above = req.store.find(Worksheet,
 
387
            Worksheet.offering_id == self.context.id,
 
388
            Worksheet.identifier == unicode(worksheetid)).one()
 
389
        if worksheet_above is None:
 
390
            raise NotFound('worksheet_below')
 
391
        worksheet_below = req.store.find(Worksheet,
 
392
            Worksheet.offering_id == self.context.id,
 
393
            Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
 
394
        if worksheet_below is None:
 
395
            raise NotFound('worksheet_above')
 
396
 
 
397
        worksheet_below.seq_no = worksheet_below.seq_no - 1
 
398
        worksheet_above.seq_no = worksheet_above.seq_no + 1
 
399
        
 
400
        return {'result': 'ok'}