← 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

Dispatch now generates an index for each plugin type, allowing plugins to
be written which are aware of other plugins, and other plugin types.

All view plugins now subclass from ivle.webapp.base.plugins.ViewPlugin,
as opposed to subclassing BasePlugin directly. This will allow us to
easily re-write console as an OverlayPlugin, and allow future new
plugins types to be created.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/tutorial/service.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2009 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
18
# Author: Matt Giuca, Nick Chadwick
 
19
 
 
20
'''AJAX backend for the tutorial application.'''
 
21
 
 
22
import os
 
23
import datetime
 
24
 
 
25
import ivle.util
 
26
import ivle.console
 
27
import ivle.database
 
28
import ivle.worksheet
 
29
import ivle.conf
 
30
import ivle.webapp.tutorial.test
 
31
 
 
32
from ivle.webapp.base.rest import JSONRESTView, named_operation
 
33
 
 
34
# If True, getattempts or getattempt will allow browsing of inactive/disabled
 
35
# attempts. If False, will not allow this.
 
36
HISTORY_ALLOW_INACTIVE = False
 
37
 
 
38
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
 
39
 
 
40
 
 
41
class AttemptsRESTView(JSONRESTView):
 
42
    '''REST view of a user's attempts at an exercise.'''
 
43
    def GET(self, req):
 
44
        """Handles a GET Attempts action."""
 
45
        exercise = ivle.database.Exercise.get_by_name(req.store, 
 
46
                                                        self.exercise)
 
47
        user = ivle.database.User.get_by_login(req.store, self.username)
 
48
 
 
49
        attempts = ivle.worksheet.get_exercise_attempts(req.store, user,
 
50
                            exercise, allow_inactive=HISTORY_ALLOW_INACTIVE)
 
51
        # attempts is a list of ExerciseAttempt objects. Convert to dictionaries
 
52
        time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
 
53
        attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
 
54
                for a in attempts]
 
55
 
 
56
        return attempts
 
57
 
 
58
 
 
59
    def PUT(self, req, data):
 
60
        ''' Tests the given submission '''
 
61
        exercisefile = ivle.util.open_exercise_file(self.exercise)
 
62
        if exercisefile is None:
 
63
            req.throw_error(req.HTTP_NOT_FOUND,
 
64
                "The exercise was not found.")
 
65
 
 
66
        # Start a console to run the tests on
 
67
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
68
        working_dir = os.path.join("/home", req.user.login)
 
69
        cons = ivle.console.Console(req.user.unixid, jail_path, working_dir)
 
70
 
 
71
        # Parse the file into a exercise object using the test suite
 
72
        exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
 
73
                                                            exercisefile, cons)
 
74
        exercisefile.close()
 
75
 
 
76
        # Run the test cases. Get the result back as a JSONable object.
 
77
        # Return it.
 
78
        test_results = exercise_obj.run_tests(data['code'])
 
79
 
 
80
        # Close the console
 
81
        cons.close()
 
82
 
 
83
        # Get the Exercise from the database
 
84
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
 
85
 
 
86
        attempt = ivle.database.ExerciseAttempt(user=req.user,
 
87
                                                exercise=exercise,
 
88
                                                date=datetime.datetime.now(),
 
89
                                                complete=test_results['passed'],
 
90
                                                # XXX
 
91
                                                text=unicode(data['code']))
 
92
 
 
93
        req.store.add(attempt)
 
94
 
 
95
        # Query the DB to get an updated score on whether or not this problem
 
96
        # has EVER been completed (may be different from "passed", if it has
 
97
        # been completed before), and the total number of attempts.
 
98
        completed, attempts = ivle.worksheet.get_exercise_status(req.store,
 
99
            req.user, exercise)
 
100
        test_results["completed"] = completed
 
101
        test_results["attempts"] = attempts
 
102
 
 
103
        return test_results
 
104
 
 
105
 
 
106
class AttemptRESTView(JSONRESTView):
 
107
    '''REST view of an exercise attempt.'''
 
108
 
 
109
    def GET(self, req):
 
110
        # Get an actual date object, rather than a string
 
111
        date = datetime.datetime.strptime(self.date, TIMESTAMP_FORMAT)
 
112
 
 
113
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
 
114
        attempt = ivle.worksheet.get_exercise_attempt(req.store, req.user,
 
115
            exercise, as_of=date, allow_inactive=HISTORY_ALLOW_INACTIVE)
 
116
        if attempt is not None:
 
117
            attempt = attempt.text
 
118
        # attempt may be None; will write "null"
 
119
        return {'code': attempt}
 
120
 
 
121
 
 
122
class ExerciseRESTView(JSONRESTView):
 
123
    '''REST view of an exercise.'''
 
124
    @named_operation
 
125
    def save(self, req, text):
 
126
        # Need to open JUST so we know this is a real exercise.
 
127
        # (This avoids users submitting code for bogus exercises).
 
128
        exercisefile = ivle.util.open_exercise_file(self.exercise)
 
129
        if exercisefile is None:
 
130
            req.throw_error(req.HTTP_NOT_FOUND,
 
131
                "The exercise was not found.")
 
132
        exercisefile.close()
 
133
 
 
134
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
 
135
        ivle.worksheet.save_exercise(req.store, req.user, exercise,
 
136
                                     unicode(text), datetime.datetime.now())
 
137
        return {"result": "ok"}