← 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

ivle-config now sets appropriate permissions (www-data:, 600) on any config
file that it creates.

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
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave
 
29
import ivle.worksheet
 
30
import ivle.conf
 
31
import ivle.webapp.tutorial.test
 
32
 
 
33
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
 
34
                                   require_permission)
 
35
from ivle.webapp.errors import NotFound
 
36
 
 
37
# If True, getattempts or getattempt will allow browsing of inactive/disabled
 
38
# attempts. If False, will not allow this.
 
39
HISTORY_ALLOW_INACTIVE = False
 
40
 
 
41
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
 
42
 
 
43
 
 
44
class AttemptsRESTView(JSONRESTView):
 
45
    '''REST view of a user's attempts at an exercise.'''
 
46
    def __init__(self, req, subject, year, semester, worksheet, 
 
47
                                                exercise, username):
 
48
        self.user = ivle.database.User.get_by_login(req.store, username)
 
49
        if self.user is None:
 
50
            raise NotFound()
 
51
        self.exercise = exercise
 
52
        
 
53
        self.context = self.user # XXX: Not quite right.
 
54
 
 
55
    @require_permission('edit')
 
56
    def GET(self, req):
 
57
        """Handles a GET Attempts action."""
 
58
        exercise = req.store.find(Exercise, Exercise.id == self.exercise).one()
 
59
 
 
60
        attempts = req.store.find(ExerciseAttempt, 
 
61
                ExerciseAttempt.exercise_id == exercise.id,
 
62
                ExerciseAttempt.user_id == self.user.id)
 
63
        # attempts is a list of ExerciseAttempt objects. Convert to dictionaries
 
64
        time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
 
65
        attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
 
66
                for a in attempts]
 
67
 
 
68
        return attempts
 
69
 
 
70
 
 
71
    @require_permission('edit')
 
72
    def PUT(self, req, data):
 
73
        """ Tests the given submission """
 
74
        exercise = req.store.find(Exercise, Exercise.id == self.exercise).one()
 
75
        if exercise is None:
 
76
            raise NotFound()
 
77
 
 
78
        # Start a console to run the tests on
 
79
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
80
        working_dir = os.path.join("/home", req.user.login)
 
81
        cons = ivle.console.Console(req.user.unixid, jail_path, working_dir)
 
82
 
 
83
        # Parse the file into a exercise object using the test suite
 
84
        exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
 
85
                                                            exercise, cons)
 
86
 
 
87
        # Run the test cases. Get the result back as a JSONable object.
 
88
        # Return it.
 
89
        test_results = exercise_obj.run_tests(data['code'])
 
90
 
 
91
        # Close the console
 
92
        cons.close()
 
93
 
 
94
        attempt = ivle.database.ExerciseAttempt(user=req.user,
 
95
                                                exercise=exercise,
 
96
                                                date=datetime.datetime.now(),
 
97
                                                complete=test_results['passed'],
 
98
                                                # XXX
 
99
                                                text=unicode(data['code']))
 
100
 
 
101
        req.store.add(attempt)
 
102
 
 
103
        # Query the DB to get an updated score on whether or not this problem
 
104
        # has EVER been completed (may be different from "passed", if it has
 
105
        # been completed before), and the total number of attempts.
 
106
        completed, attempts = ivle.worksheet.get_exercise_status(req.store,
 
107
            req.user, exercise)
 
108
        test_results["completed"] = completed
 
109
        test_results["attempts"] = attempts
 
110
 
 
111
        return test_results
 
112
 
 
113
 
 
114
class AttemptRESTView(JSONRESTView):
 
115
    '''REST view of an exercise attempt.'''
 
116
 
 
117
    def __init__(self, req, subject, worksheet, exercise, username, date):
 
118
        # TODO: Find exercise within worksheet.
 
119
        user = ivle.database.User.get_by_login(req.store, username)
 
120
        if user is None:
 
121
            raise NotFound()
 
122
 
 
123
        try:
 
124
            date = datetime.datetime.strptime(date, TIMESTAMP_FORMAT)
 
125
        except ValueError:
 
126
            raise NotFound()
 
127
 
 
128
        exercise = ivle.database.Exercise.get_by_name(req.store, exercise)
 
129
        attempt = ivle.worksheet.get_exercise_attempt(req.store, user,
 
130
            exercise, as_of=date, allow_inactive=HISTORY_ALLOW_INACTIVE)
 
131
 
 
132
        if attempt is None:
 
133
            raise NotFound()
 
134
 
 
135
        self.context = attempt
 
136
 
 
137
    @require_permission('view')
 
138
    def GET(self, req):
 
139
        return {'code': self.context.text}
 
140
 
 
141
 
 
142
class ExerciseRESTView(JSONRESTView):
 
143
    '''REST view of an exercise.'''
 
144
 
 
145
    def get_permissions(self, user):
 
146
        # XXX: Do it properly.
 
147
        if user is not None:
 
148
            return set(['save'])
 
149
        else:
 
150
            return set()
 
151
 
 
152
    @named_operation('save')
 
153
    def save(self, req, text):
 
154
        # Need to open JUST so we know this is a real exercise.
 
155
        # (This avoids users submitting code for bogus exercises).
 
156
        exercise = req.store.find(Exercise,
 
157
            Exercise.id == self.exercise).one()
 
158
        ivle.worksheet.save_exercise(req.store, req.user, exercise,
 
159
                                     unicode(text), datetime.datetime.now())
 
160
        return {"result": "ok"}