~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: 2010-02-23 08:55:42 UTC
  • mto: This revision was merged to the branch mainline in revision 1674.
  • Revision ID: grantw@unimelb.edu.au-20100223085542-r8xw14bxxoraza51
Permit underscores in all names.

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
 
20
20
'''AJAX backend for the tutorial application.'''
21
21
 
22
 
import os
23
22
import datetime
 
23
 
24
24
import genshi
 
25
from storm.locals import Store
25
26
 
26
 
import ivle.util
27
 
import ivle.console
28
27
import ivle.database
29
28
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
30
 
                          Offering, Subject, Semester, WorksheetExercise
31
 
import ivle.worksheet
32
 
import ivle.conf
33
 
import ivle.webapp.tutorial.test
34
 
 
 
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
38
34
 
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
42
35
 
43
36
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
44
37
 
 
38
 
45
39
class AttemptsRESTView(JSONRESTView):
46
40
    '''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
41
 
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}
80
56
    @require_permission('edit')
81
57
    def PUT(self, req, data):
82
58
        """ 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()
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()
 
59
        test_results = ivle.worksheet.utils.test_exercise_submission(
 
60
            req.config, req.user, self.context.worksheet_exercise.exercise,
 
61
            data['code'])
103
62
 
104
63
        attempt = ivle.database.ExerciseAttempt(user=req.user,
105
 
            worksheet_exercise = self.worksheet_exercise,
 
64
            worksheet_exercise = self.context.worksheet_exercise,
106
65
            date = datetime.datetime.now(),
107
66
            complete = test_results['passed'],
108
67
            text = unicode(data['code'])
113
72
        # Query the DB to get an updated score on whether or not this problem
114
73
        # has EVER been completed (may be different from "passed", if it has
115
74
        # 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)
 
75
        completed, attempts = ivle.worksheet.utils.get_exercise_status(
 
76
                req.store, req.user, self.context.worksheet_exercise)
118
77
        test_results["completed"] = completed
119
78
        test_results["attempts"] = attempts
120
79
 
124
83
class AttemptRESTView(JSONRESTView):
125
84
    '''REST view of an exercise attempt.'''
126
85
 
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
86
    @require_permission('view')
160
87
    def GET(self, req):
161
88
        return {'code': self.context.text}
162
89
 
163
90
 
164
 
class ExerciseRESTView(JSONRESTView):
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')
 
91
class WorksheetExerciseRESTView(JSONRESTView):
 
92
    '''REST view of a worksheet exercise.'''
 
93
 
 
94
    @named_operation('view')
177
95
    def save(self, req, text):
178
96
        # Find the appropriate WorksheetExercise to save to. If its not found,
179
97
        # 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
98
 
193
99
        old_save = req.store.find(ExerciseSave,
194
 
            ExerciseSave.ws_ex_id == worksheet_exercise.id,
 
100
            ExerciseSave.ws_ex_id == self.context.id,
195
101
            ExerciseSave.user == req.user).one()
196
102
        
197
103
        #Overwrite the old, or create a new if there isn't one
201
107
        else:
202
108
            new_save = old_save
203
109
        
204
 
        new_save.worksheet_exercise = worksheet_exercise
 
110
        new_save.worksheet_exercise = self.context
205
111
        new_save.user = req.user
206
112
        new_save.text = unicode(text)
207
113
        new_save.date = datetime.datetime.now()
209
115
        return {"result": "ok"}
210
116
 
211
117
 
212
 
 
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."""
217
 
 
218
 
    def get_permissions(self, user):
219
 
        # XXX: Do it properly.
220
 
        # XXX: Lecturers should be allowed to add worksheets Only to subjects
221
 
        #      under their control
222
 
        if user is not None:
223
 
            if user.admin:
224
 
                return set(['save'])
225
 
            else:
226
 
                return set()
227
 
        else:
228
 
            return set()    
229
 
 
230
 
    def __init__(self, req, **kwargs):
231
 
    
232
 
        self.worksheet = kwargs['worksheet']
233
 
        self.subject = kwargs['subject']
234
 
        self.year = kwargs['year']
235
 
        self.semester = kwargs['semester']
236
 
    
237
 
        self.context = req.store.find(Worksheet,
238
 
            Worksheet.identifier == self.worksheet,
239
 
            Worksheet.offering_id == Offering.id,
240
 
            Offering.subject_id == Subject.id,
241
 
            Subject.code == self.subject,
242
 
            Offering.semester_id == Semester.id,
243
 
            Semester.year == self.year,
244
 
            Semester.semester == self.semester).one()
245
 
        
246
 
        if self.context is None:
247
 
            raise NotFound()
248
 
    
249
 
    @named_operation('save')
250
 
    def save(self, req, name, assessable, data, format):
251
 
        """Takes worksheet data and saves it."""
252
 
        self.context.name = unicode(name)
253
 
        self.context.assessable = self.convert_bool(assessable)
254
 
        self.context.data = unicode(data)
255
 
        self.context.format = unicode(format)
256
 
        ivle.worksheet.update_exerciselist(self.context)
257
 
        
258
 
        return {"result": "ok"}
259
 
 
260
118
class WorksheetsRESTView(JSONRESTView):
261
119
    """View used to update and create Worksheets."""
262
 
    
263
 
    def get_permissions(self, user):
264
 
        # XXX: Do it properly.
265
 
        # XXX: Lecturers should be allowed to add worksheets Only to subjects
266
 
        #      under their control
267
 
        if user is not None:
268
 
            if user.admin:
269
 
                return set(['edit'])
270
 
            else:
271
 
                return set()
272
 
        else:
273
 
            return set()
274
 
 
275
 
    def __init__(self, req, **kwargs):
276
 
    
277
 
        self.subject = kwargs['subject']
278
 
        self.year = kwargs['year']
279
 
        self.semester = kwargs['semester']
280
 
    
281
 
        self.context = req.store.find(Offering,
282
 
            Offering.subject_id == Subject.id,
283
 
            Subject.code == self.subject,
284
 
            Offering.semester_id == Semester.id,
285
 
            Semester.year == self.year,
286
 
            Semester.semester == self.semester).one()
287
 
        
288
 
        if self.context is None:
289
 
            raise NotFound()
290
 
 
291
 
    @named_operation('edit')
292
 
    def add_worksheet(self, req, identifier, name, assessable, data, format):
293
 
        """Takes worksheet data and adds it."""
294
 
        
295
 
        new_worksheet = Worksheet()
296
 
        new_worksheet.seq_no = self.context.worksheets.count()
297
 
        # Setting new_worksheet.offering implicitly adds new_worksheet,
298
 
        # hence worksheets.count MUST be called above it
299
 
        new_worksheet.offering = self.context
300
 
        new_worksheet.identifier = unicode(identifier)
301
 
        new_worksheet.name = unicode(name)
302
 
        new_worksheet.assessable = self.convert_bool(assessable)
303
 
        new_worksheet.data = unicode(data)
304
 
        new_worksheet.format = unicode(format)
305
 
        
306
 
        # This call is added for clarity, as the worksheet is implicitly added.        
307
 
        req.store.add(new_worksheet)
308
 
        
309
 
        ivle.worksheet.update_exerciselist(new_worksheet)
310
 
        
311
 
        return {"result": "ok"}
312
 
 
313
 
    @named_operation('edit')
 
120
 
 
121
    @named_operation('edit_worksheets')
314
122
    def move_up(self, req, worksheetid):
315
123
        """Takes a list of worksheet-seq_no pairs and updates their 
316
124
        corresponding Worksheet objects to match."""
331
139
        
332
140
        return {'result': 'ok'}
333
141
 
334
 
    @named_operation('edit')
 
142
    @named_operation('edit_worksheets')
335
143
    def move_down(self, req, worksheetid):
336
144
        """Takes a list of worksheet-seq_no pairs and updates their 
337
145
        corresponding Worksheet objects to match."""