← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: William Grant
  • Date: 2009-04-28 06:18:14 UTC
  • Revision ID: grantw@unimelb.edu.au-20090428061814-fiqynzwcmtk3dokn
Replace ivle.util.unmake_path with specialisations in Request and CGIRequest.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/tutorial/service.py
19
19
 
20
20
'''AJAX backend for the tutorial application.'''
21
21
 
 
22
import os
22
23
import datetime
23
 
 
24
24
import genshi
25
 
from storm.locals import Store
26
25
 
 
26
import ivle.util
 
27
import ivle.console
27
28
import ivle.database
28
29
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
29
 
                          Offering, Subject, Semester, User, WorksheetExercise
 
30
                          Offering, Subject, Semester, WorksheetExercise
30
31
import ivle.worksheet.utils
 
32
import ivle.conf
 
33
import ivle.webapp.tutorial.test
31
34
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
32
35
                                   require_permission)
33
36
from ivle.webapp.errors import NotFound
34
37
 
 
38
# If True, getattempts or getattempt will allow browsing of inactive/disabled
 
39
# attempts. If False, will not allow this.
 
40
HISTORY_ALLOW_INACTIVE = False
35
41
 
36
42
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
37
43
 
38
 
 
39
44
class AttemptsRESTView(JSONRESTView):
40
45
    '''REST view of a user's attempts at an exercise.'''
 
46
    
 
47
    def __init__(self, req, subject, year, semester, worksheet, 
 
48
                                                exercise, username):
 
49
        self.user = ivle.database.User.get_by_login(req.store, username)
 
50
        if self.user is None:
 
51
            raise NotFound()
 
52
        
 
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()
 
63
        
 
64
        self.context = self.user # XXX: Not quite right.
41
65
 
42
66
    @require_permission('edit')
43
67
    def GET(self, req):
44
68
        """Handles a GET Attempts action."""
45
69
        attempts = req.store.find(ExerciseAttempt, 
46
 
                ExerciseAttempt.ws_ex_id == self.context.worksheet_exercise.id,
47
 
                ExerciseAttempt.user_id == self.context.user.id)
 
70
                ExerciseAttempt.ws_ex_id == self.worksheet_exercise.id,
 
71
                ExerciseAttempt.user_id == self.user.id)
48
72
        # attempts is a list of ExerciseAttempt objects. Convert to dictionaries
49
73
        time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
50
74
        attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
56
80
    @require_permission('edit')
57
81
    def PUT(self, req, data):
58
82
        """ Tests the given submission """
59
 
        test_results = ivle.worksheet.utils.test_exercise_submission(
60
 
            req.config, req.user, self.context.worksheet_exercise.exercise,
61
 
            data['code'])
 
83
        exercise = req.store.find(Exercise, 
 
84
            Exercise.id == self.worksheet_exercise.exercise_id).one()
 
85
        if exercise is None:
 
86
            raise NotFound()
 
87
 
 
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)
 
92
 
 
93
        # Parse the file into a exercise object using the test suite
 
94
        exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
 
95
                                                            exercise, cons)
 
96
 
 
97
        # Run the test cases. Get the result back as a JSONable object.
 
98
        # Return it.
 
99
        test_results = exercise_obj.run_tests(data['code'])
 
100
 
 
101
        # Close the console
 
102
        cons.close()
62
103
 
63
104
        attempt = ivle.database.ExerciseAttempt(user=req.user,
64
 
            worksheet_exercise = self.context.worksheet_exercise,
 
105
            worksheet_exercise = self.worksheet_exercise,
65
106
            date = datetime.datetime.now(),
66
107
            complete = test_results['passed'],
67
108
            text = unicode(data['code'])
73
114
        # has EVER been completed (may be different from "passed", if it has
74
115
        # been completed before), and the total number of attempts.
75
116
        completed, attempts = ivle.worksheet.utils.get_exercise_status(
76
 
                req.store, req.user, self.context.worksheet_exercise)
 
117
                req.store, req.user, self.worksheet_exercise)
77
118
        test_results["completed"] = completed
78
119
        test_results["attempts"] = attempts
79
120
 
83
124
class AttemptRESTView(JSONRESTView):
84
125
    '''REST view of an exercise attempt.'''
85
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
        # 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)
 
147
 
 
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()
 
158
            
 
159
        attempt = ivle.worksheet.utils.get_exercise_attempt(req.store, user,
 
160
                        worksheet_exercise, as_of=date,
 
161
                        allow_inactive=HISTORY_ALLOW_INACTIVE) 
 
162
 
 
163
        if attempt is None:
 
164
            raise NotFound()
 
165
 
 
166
        self.context = attempt
 
167
 
86
168
    @require_permission('view')
87
169
    def GET(self, req):
88
170
        return {'code': self.context.text}
91
173
class WorksheetExerciseRESTView(JSONRESTView):
92
174
    '''REST view of a worksheet exercise.'''
93
175
 
 
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()
 
186
        
 
187
        if self.context is None:
 
188
            raise NotFound()
 
189
 
94
190
    @named_operation('view')
95
191
    def save(self, req, text):
96
192
        # Find the appropriate WorksheetExercise to save to. If its not found,
115
211
        return {"result": "ok"}
116
212
 
117
213
 
 
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."""
 
218
 
 
219
    def __init__(self, req, **kwargs):
 
220
    
 
221
        self.worksheet = kwargs['worksheet']
 
222
        self.subject = kwargs['subject']
 
223
        self.year = kwargs['year']
 
224
        self.semester = kwargs['semester']
 
225
    
 
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()
 
234
        
 
235
        if self.context is None:
 
236
            raise NotFound()
 
237
    
 
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)
 
246
        
 
247
        return {"result": "ok"}
 
248
 
118
249
class WorksheetsRESTView(JSONRESTView):
119
250
    """View used to update and create Worksheets."""
120
 
 
121
 
    @named_operation('edit_worksheets')
 
251
    
 
252
    def __init__(self, req, **kwargs):
 
253
    
 
254
        self.subject = kwargs['subject']
 
255
        self.year = kwargs['year']
 
256
        self.semester = kwargs['semester']
 
257
    
 
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()
 
264
        
 
265
        if self.context is None:
 
266
            raise NotFound()
 
267
 
 
268
    @named_operation('edit')
 
269
    def add_worksheet(self, req, identifier, name, assessable, data, format):
 
270
        """Takes worksheet data and adds it."""
 
271
        
 
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)
 
282
        
 
283
        # This call is added for clarity, as the worksheet is implicitly added.        
 
284
        req.store.add(new_worksheet)
 
285
 
 
286
        ivle.worksheet.utils.update_exerciselist(new_worksheet)
 
287
 
 
288
        return {"result": "ok"}
 
289
 
 
290
    @named_operation('edit')
122
291
    def move_up(self, req, worksheetid):
123
292
        """Takes a list of worksheet-seq_no pairs and updates their 
124
293
        corresponding Worksheet objects to match."""
139
308
        
140
309
        return {'result': 'ok'}
141
310
 
142
 
    @named_operation('edit_worksheets')
 
311
    @named_operation('edit')
143
312
    def move_down(self, req, worksheetid):
144
313
        """Takes a list of worksheet-seq_no pairs and updates their 
145
314
        corresponding Worksheet objects to match."""