← 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

Direct port of userservice to the new framework.

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 problem boxes.
25
 
 
26
 
# Calling syntax
27
 
# Path must be empty.
28
 
# The arguments determine what is to be done on this file.
29
 
 
30
 
# "problem" - The path to a problem 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
 
 
39
 
import cjson
40
 
 
41
 
import test
42
 
import conf
43
 
 
44
 
def handle(req):
45
 
    """Handler for Ajax backend TutorialService app."""
46
 
    # Set request attributes
47
 
    req.write_html_head_foot = False     # No HTML
48
 
 
49
 
    if req.path != "":
50
 
        req.throw_error(req.HTTP_BAD_REQUEST)
51
 
    # Get all the arguments, if POST.
52
 
    # Ignore arguments if not POST, since we aren't allowed to cause
53
 
    # side-effects on the server.
54
 
    fields = req.get_fieldstorage()
55
 
    act = fields.getfirst('action')
56
 
    problem = fields.getfirst('problem')
57
 
    code = fields.getfirst('code')
58
 
 
59
 
    if problem == None or code == None or act == None:
60
 
        req.throw_error(req.HTTP_BAD_REQUEST)
61
 
    act = act.value
62
 
    problem = problem.value
63
 
    code = code.value
64
 
 
65
 
    if act == "test":
66
 
        handle_test(req, problem, code, fields)
67
 
    elif act == "run":
68
 
        handle_run(req, problem, code, fields)
69
 
    else:
70
 
        req.throw_error(req.HTTP_BAD_REQUEST)
71
 
 
72
 
def handle_test(req, problem, code, fields):
73
 
    """Handles a test action."""
74
 
 
75
 
    # First normalise the path
76
 
    problem = os.path.normpath(problem)
77
 
    # Now if it begins with ".." or separator, then it's illegal
78
 
    if problem.startswith("..") or problem.startswith(os.sep):
79
 
        problemfile = None
80
 
    else:
81
 
        problemfile = os.path.join(conf.problems_base, problem)
82
 
 
83
 
    try:
84
 
        problemfile = open(problemfile)
85
 
    except (TypeError, IOError):    # TypeError if problemfile == None
86
 
        req.throw_error(req.HTTP_NOT_FOUND)
87
 
 
88
 
    # Parse the file into a problem object using the test suite
89
 
    problem_obj = test.parse_tutorial_file(problemfile)
90
 
    problemfile.close()
91
 
    # Run the test cases. Get the result back as a JSONable object.
92
 
    # Return it.
93
 
    test_results = problem_obj.run_tests(code)
94
 
    req.write(cjson.encode(test_results))
95
 
 
96
 
def handle_run(req, problem, code, fields):
97
 
    """Handles a run action."""
98
 
    # Extremely makeshift.
99
 
    # For now, just echo the code back
100
 
    output = code
101
 
    out_json = {"stdout": output}
102
 
    req.write(cjson.encode(out_json))
 
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
                                   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
 
 
43
class AttemptsRESTView(JSONRESTView):
 
44
    '''REST view of a user's attempts at an exercise.'''
 
45
    def __init__(self, req, subject, worksheet, exercise, username):
 
46
        # TODO: Find exercise within worksheet.
 
47
        self.user = ivle.database.User.get_by_login(req.store, username)
 
48
        if self.user is None:
 
49
            raise NotFound()
 
50
        self.exercise = exercise
 
51
        self.context = self.user # XXX: Not quite right.
 
52
 
 
53
    @require_permission('edit')
 
54
    def GET(self, req):
 
55
        """Handles a GET Attempts action."""
 
56
        exercise = ivle.database.Exercise.get_by_name(req.store, 
 
57
                                                        self.exercise)
 
58
 
 
59
        attempts = ivle.worksheet.get_exercise_attempts(req.store, self.user,
 
60
                            exercise, allow_inactive=HISTORY_ALLOW_INACTIVE)
 
61
        # attempts is a list of ExerciseAttempt objects. Convert to dictionaries
 
62
        time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
 
63
        attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
 
64
                for a in attempts]
 
65
 
 
66
        return attempts
 
67
 
 
68
 
 
69
    @require_permission('edit')
 
70
    def PUT(self, req, data):
 
71
        """ Tests the given submission """
 
72
        exercisefile = ivle.util.open_exercise_file(self.exercise)
 
73
        if exercisefile is None:
 
74
            raise NotFound()
 
75
 
 
76
        # Start a console to run the tests on
 
77
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
78
        working_dir = os.path.join("/home", req.user.login)
 
79
        cons = ivle.console.Console(req.user.unixid, jail_path, working_dir)
 
80
 
 
81
        # Parse the file into a exercise object using the test suite
 
82
        exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
 
83
                                                            exercisefile, cons)
 
84
        exercisefile.close()
 
85
 
 
86
        # Run the test cases. Get the result back as a JSONable object.
 
87
        # Return it.
 
88
        test_results = exercise_obj.run_tests(data['code'])
 
89
 
 
90
        # Close the console
 
91
        cons.close()
 
92
 
 
93
        # Get the Exercise from the database
 
94
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
 
95
 
 
96
        attempt = ivle.database.ExerciseAttempt(user=req.user,
 
97
                                                exercise=exercise,
 
98
                                                date=datetime.datetime.now(),
 
99
                                                complete=test_results['passed'],
 
100
                                                # XXX
 
101
                                                text=unicode(data['code']))
 
102
 
 
103
        req.store.add(attempt)
 
104
 
 
105
        # Query the DB to get an updated score on whether or not this problem
 
106
        # has EVER been completed (may be different from "passed", if it has
 
107
        # been completed before), and the total number of attempts.
 
108
        completed, attempts = ivle.worksheet.get_exercise_status(req.store,
 
109
            req.user, exercise)
 
110
        test_results["completed"] = completed
 
111
        test_results["attempts"] = attempts
 
112
 
 
113
        return test_results
 
114
 
 
115
 
 
116
class AttemptRESTView(JSONRESTView):
 
117
    '''REST view of an exercise attempt.'''
 
118
 
 
119
    def __init__(self, req, subject, worksheet, exercise, username, date):
 
120
        # TODO: Find exercise within worksheet.
 
121
        user = ivle.database.User.get_by_login(req.store, username)
 
122
        if user is None:
 
123
            raise NotFound()
 
124
 
 
125
        try:
 
126
            date = datetime.datetime.strptime(date, TIMESTAMP_FORMAT)
 
127
        except ValueError:
 
128
            raise NotFound()
 
129
 
 
130
        exercise = ivle.database.Exercise.get_by_name(req.store, exercise)
 
131
        attempt = ivle.worksheet.get_exercise_attempt(req.store, user,
 
132
            exercise, as_of=date, allow_inactive=HISTORY_ALLOW_INACTIVE)
 
133
 
 
134
        if attempt is None:
 
135
            raise NotFound()
 
136
 
 
137
        self.context = attempt
 
138
 
 
139
    @require_permission('view')
 
140
    def GET(self, req):
 
141
        return {'code': self.context.text}
 
142
 
 
143
 
 
144
class ExerciseRESTView(JSONRESTView):
 
145
    '''REST view of an exercise.'''
 
146
 
 
147
    def get_permissions(self, user):
 
148
        # XXX: Do it properly.
 
149
        if user is not None:
 
150
            return set(['save'])
 
151
        else:
 
152
            return set()
 
153
 
 
154
    @named_operation('save')
 
155
    def save(self, req, text):
 
156
        # Need to open JUST so we know this is a real exercise.
 
157
        # (This avoids users submitting code for bogus exercises).
 
158
        exercisefile = ivle.util.open_exercise_file(self.exercise)
 
159
        if exercisefile is None:
 
160
            raise NotFound()
 
161
        exercisefile.close()
 
162
 
 
163
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
 
164
        ivle.worksheet.save_exercise(req.store, req.user, exercise,
 
165
                                     unicode(text), datetime.datetime.now())
 
166
        return {"result": "ok"}