← 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: David Coles
  • Date: 2009-11-27 05:34:33 UTC
  • mto: This revision was merged to the branch mainline in revision 1322.
  • Revision ID: coles.david@gmail.com-20091127053433-8ki9nm6xrkogxq67
Added diagram of system architecture

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/tutorial/service.py
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
 
# "exercise" - The path to a exercise file (including the .xml extension),
31
 
#    relative to the subjects base directory.
32
 
# "code" - Full text of the student's code being submitted.
33
 
# "action". May be "test". (More to come).
34
 
 
35
 
# Returns a JSON response string indicating the results.
 
18
# Author: Matt Giuca, Nick Chadwick
 
19
 
 
20
'''AJAX backend for the tutorial application.'''
36
21
 
37
22
import os
38
 
import time
39
 
 
40
 
import cjson
41
 
 
42
 
from common import (db, util)
43
 
import test
44
 
import conf
45
 
 
46
 
def handle(req):
47
 
    """Handler for Ajax backend TutorialService app."""
48
 
    # Set request attributes
49
 
    req.write_html_head_foot = False     # No HTML
50
 
 
51
 
    if req.path != "":
52
 
        req.throw_error(req.HTTP_BAD_REQUEST)
53
 
    # Get all the arguments, if POST.
54
 
    # Ignore arguments if not POST, since we aren't allowed to cause
55
 
    # side-effects on the server.
56
 
    fields = req.get_fieldstorage()
57
 
    act = fields.getfirst('action')
58
 
    exercise = fields.getfirst('exercise')
59
 
    code = fields.getfirst('code')
60
 
 
61
 
    if exercise == None or code == None or act == None:
62
 
        req.throw_error(req.HTTP_BAD_REQUEST)
63
 
    act = act.value
64
 
    exercise = exercise.value
65
 
    code = code.value
66
 
 
67
 
    if act == "save":
68
 
        handle_save(req, exercise, code, fields)
69
 
    elif act == "test":
70
 
        handle_test(req, exercise, code, fields)
71
 
    elif act == "run":
72
 
        handle_run(req, exercise, code, fields)
73
 
    else:
74
 
        req.throw_error(req.HTTP_BAD_REQUEST)
75
 
 
76
 
def handle_save(req, exercise, code, fields):
77
 
    """Handles a save action. This saves the user's code without executing it.
78
 
    """
79
 
    # Need to open JUST so we know this is a real exercise.
80
 
    # (This avoids users submitting code for bogus exercises).
81
 
    exercisefile = util.open_exercise_file(exercise)
82
 
    if exercisefile is None:
83
 
        req.throw_error(req.HTTP_NOT_FOUND,
84
 
            "The exercise was not found.")
85
 
    exercisefile.close()
86
 
 
87
 
    req.write('{"result": "ok"}')
88
 
 
89
 
    conn = db.DB()
90
 
 
91
 
    try:
92
 
        conn.write_problem_save(
93
 
            login = req.user.login,
94
 
            exercisename = exercise,
95
 
            date = time.localtime(),
96
 
            text = code)
97
 
    finally:
98
 
        conn.close()
99
 
 
100
 
def handle_test(req, exercise, code, fields):
101
 
    """Handles a test action."""
102
 
 
103
 
    exercisefile = util.open_exercise_file(exercise)
104
 
    if exercisefile is None:
105
 
        req.throw_error(req.HTTP_NOT_FOUND,
106
 
            "The exercise was not found.")
107
 
 
108
 
    # Parse the file into a exercise object using the test suite
109
 
    exercise_obj = test.parse_exercise_file(exercisefile)
110
 
    exercisefile.close()
111
 
    # Run the test cases. Get the result back as a JSONable object.
112
 
    # Return it.
113
 
    test_results = exercise_obj.run_tests(code)
114
 
 
115
 
    conn = db.DB()
116
 
    try:
117
 
        conn.insert_problem_attempt(
118
 
            login = req.user.login,
119
 
            exercisename = exercise,
120
 
            date = time.localtime(),
 
23
import datetime
 
24
import genshi
 
25
 
 
26
import ivle.console
 
27
import ivle.database
 
28
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
 
29
                          Offering, Subject, Semester, WorksheetExercise
 
30
import ivle.worksheet.utils
 
31
import ivle.webapp.tutorial.test
 
32
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
 
33
                                   require_permission)
 
34
from ivle.webapp.errors import NotFound
 
35
 
 
36
# If True, getattempts or getattempt will allow browsing of inactive/disabled
 
37
# attempts. If False, will not allow this.
 
38
HISTORY_ALLOW_INACTIVE = False
 
39
 
 
40
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
 
41
 
 
42
class AttemptsRESTView(JSONRESTView):
 
43
    '''REST view of a user's attempts at an exercise.'''
 
44
    
 
45
    def __init__(self, req, subject, year, semester, worksheet, 
 
46
                                                exercise, username):
 
47
        self.user = ivle.database.User.get_by_login(req.store, username)
 
48
        if self.user is None:
 
49
            raise NotFound()
 
50
        
 
51
        self.worksheet_exercise = req.store.find(WorksheetExercise,
 
52
            WorksheetExercise.exercise_id == unicode(exercise),
 
53
            WorksheetExercise.worksheet_id == Worksheet.id,
 
54
            Worksheet.offering_id == Offering.id,
 
55
            Worksheet.identifier == unicode(worksheet),
 
56
            Offering.subject_id == Subject.id,
 
57
            Subject.short_name == subject,
 
58
            Offering.semester_id == Semester.id,
 
59
            Semester.year == year,
 
60
            Semester.semester == semester).one()
 
61
        
 
62
        self.context = self.user # XXX: Not quite right.
 
63
 
 
64
    @require_permission('edit')
 
65
    def GET(self, req):
 
66
        """Handles a GET Attempts action."""
 
67
        attempts = req.store.find(ExerciseAttempt, 
 
68
                ExerciseAttempt.ws_ex_id == self.worksheet_exercise.id,
 
69
                ExerciseAttempt.user_id == self.user.id)
 
70
        # attempts is a list of ExerciseAttempt objects. Convert to dictionaries
 
71
        time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
 
72
        attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
 
73
                for a in attempts]
 
74
 
 
75
        return attempts
 
76
 
 
77
 
 
78
    @require_permission('edit')
 
79
    def PUT(self, req, data):
 
80
        """ Tests the given submission """
 
81
        exercise = req.store.find(Exercise, 
 
82
            Exercise.id == self.worksheet_exercise.exercise_id).one()
 
83
        if exercise is None:
 
84
            raise NotFound()
 
85
 
 
86
        # Start a console to run the tests on
 
87
        jail_path = os.path.join(req.config['paths']['jails']['mounts'],
 
88
                                 req.user.login)
 
89
        working_dir = os.path.join("/home", req.user.login)
 
90
        cons = ivle.console.Console(req.config, req.user.unixid, jail_path,
 
91
                                    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()
 
103
 
 
104
        attempt = ivle.database.ExerciseAttempt(user=req.user,
 
105
            worksheet_exercise = self.worksheet_exercise,
 
106
            date = datetime.datetime.now(),
121
107
            complete = test_results['passed'],
122
 
            attempt = code)
 
108
            text = unicode(data['code'])
 
109
        )
 
110
 
 
111
        req.store.add(attempt)
123
112
 
124
113
        # Query the DB to get an updated score on whether or not this problem
125
114
        # has EVER been completed (may be different from "passed", if it has
126
115
        # been completed before), and the total number of attempts.
127
 
        completed, attempts = conn.get_problem_status(req.user.login,
128
 
            exercise)
 
116
        completed, attempts = ivle.worksheet.utils.get_exercise_status(
 
117
                req.store, req.user, self.worksheet_exercise)
129
118
        test_results["completed"] = completed
130
119
        test_results["attempts"] = attempts
131
120
 
132
 
        req.write(cjson.encode(test_results))
133
 
    finally:
134
 
        conn.close()
135
 
 
136
 
def handle_run(req, exercise, code, fields):
137
 
    """Handles a run action."""
138
 
    # Extremely makeshift.
139
 
    # For now, just echo the code back
140
 
    output = code
141
 
    out_json = {"stdout": output}
142
 
    req.write(cjson.encode(out_json))
 
121
        return test_results
 
122
 
 
123
 
 
124
class AttemptRESTView(JSONRESTView):
 
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
        # 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
 
 
168
    @require_permission('view')
 
169
    def GET(self, req):
 
170
        return {'code': self.context.text}
 
171
 
 
172
 
 
173
class WorksheetExerciseRESTView(JSONRESTView):
 
174
    '''REST view of a worksheet exercise.'''
 
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
 
 
190
    @named_operation('view')
 
191
    def save(self, req, text):
 
192
        # Find the appropriate WorksheetExercise to save to. If its not found,
 
193
        # the user is submitting against a non-existant worksheet/exercise
 
194
 
 
195
        old_save = req.store.find(ExerciseSave,
 
196
            ExerciseSave.ws_ex_id == self.context.id,
 
197
            ExerciseSave.user == req.user).one()
 
198
        
 
199
        #Overwrite the old, or create a new if there isn't one
 
200
        if old_save is None:
 
201
            new_save = ExerciseSave()
 
202
            req.store.add(new_save)
 
203
        else:
 
204
            new_save = old_save
 
205
        
 
206
        new_save.worksheet_exercise = self.context
 
207
        new_save.user = req.user
 
208
        new_save.text = unicode(text)
 
209
        new_save.date = datetime.datetime.now()
 
210
 
 
211
        return {"result": "ok"}
 
212
 
 
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
 
 
249
class WorksheetsRESTView(JSONRESTView):
 
250
    """View used to update and create 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')
 
291
    def move_up(self, req, worksheetid):
 
292
        """Takes a list of worksheet-seq_no pairs and updates their 
 
293
        corresponding Worksheet objects to match."""
 
294
        
 
295
        worksheet_below = req.store.find(Worksheet,
 
296
            Worksheet.offering_id == self.context.id,
 
297
            Worksheet.identifier == unicode(worksheetid)).one()
 
298
        if worksheet_below is None:
 
299
            raise NotFound('worksheet_below')
 
300
        worksheet_above = req.store.find(Worksheet,
 
301
            Worksheet.offering_id == self.context.id,
 
302
            Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
 
303
        if worksheet_above is None:
 
304
            raise NotFound('worksheet_above')
 
305
 
 
306
        worksheet_below.seq_no = worksheet_below.seq_no - 1
 
307
        worksheet_above.seq_no = worksheet_above.seq_no + 1
 
308
        
 
309
        return {'result': 'ok'}
 
310
 
 
311
    @named_operation('edit')
 
312
    def move_down(self, req, worksheetid):
 
313
        """Takes a list of worksheet-seq_no pairs and updates their 
 
314
        corresponding Worksheet objects to match."""
 
315
        
 
316
        worksheet_above = req.store.find(Worksheet,
 
317
            Worksheet.offering_id == self.context.id,
 
318
            Worksheet.identifier == unicode(worksheetid)).one()
 
319
        if worksheet_above is None:
 
320
            raise NotFound('worksheet_below')
 
321
        worksheet_below = req.store.find(Worksheet,
 
322
            Worksheet.offering_id == self.context.id,
 
323
            Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
 
324
        if worksheet_below is None:
 
325
            raise NotFound('worksheet_above')
 
326
 
 
327
        worksheet_below.seq_no = worksheet_below.seq_no - 1
 
328
        worksheet_above.seq_no = worksheet_above.seq_no + 1
 
329
        
 
330
        return {'result': 'ok'}