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
18
# Module: TutorialService
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.
28
# The arguments determine what is to be done on this file.
30
# "action". One of the tutorialservice actions.
31
# "exercise" - The path to a exercise file (including the .xml extension),
32
# relative to the subjects base directory.
33
# action "save" or "test" (POST only):
34
# "code" - Full text of the student's code being submitted.
35
# action "getattempts": No arguments. Returns a list of
36
# {'date': 'formatted_date', 'complete': bool} dicts.
37
# action "getattempt":
38
# "date" - Formatted date. Gets most recent attempt before (and including)
40
# Returns JSON string containing code, or null.
42
# Returns a JSON response string indicating the results.
18
# Author: Matt Giuca, Nick Chadwick
20
'''AJAX backend for the tutorial application.'''
49
from common import (db, util)
30
import ivle.webapp.tutorial.test
32
from ivle.webapp.base.rest import JSONRESTView, named_operation
53
34
# If True, getattempts or getattempt will allow browsing of inactive/disabled
54
35
# attempts. If False, will not allow this.
55
36
HISTORY_ALLOW_INACTIVE = False
58
"""Handler for Ajax backend TutorialService app."""
59
# Set request attributes
60
req.write_html_head_foot = False # No HTML
63
req.throw_error(req.HTTP_BAD_REQUEST)
64
fields = req.get_fieldstorage()
65
act = fields.getfirst('action')
66
exercise = fields.getfirst('exercise')
67
if act is None or exercise is None:
68
req.throw_error(req.HTTP_BAD_REQUEST)
70
exercise = exercise.value
72
if act == 'save' or act == 'test':
74
if req.method != 'POST':
75
req.throw_error(req.HTTP_BAD_REQUEST)
77
code = fields.getfirst('code')
79
req.throw_error(req.HTTP_BAD_REQUEST)
83
handle_save(req, exercise, code, fields)
85
handle_test(req, exercise, code, fields)
86
elif act == 'getattempts':
87
handle_getattempts(req, exercise)
88
elif act == 'getattempt':
89
date = fields.getfirst('date')
91
req.throw_error(req.HTTP_BAD_REQUEST)
93
# Convert into a struct_time
94
# The time *should* be in the same format as the DB (since it should
95
# be bounced back to us from the getattempts output). Assume this.
97
date = time.strptime(date, db.TIMESTAMP_FORMAT)
99
# Date was not in correct format
100
req.throw_error(req.HTTP_BAD_REQUEST)
101
handle_getattempt(req, exercise, date)
103
req.throw_error(req.HTTP_BAD_REQUEST)
105
def handle_save(req, exercise, code, fields):
106
"""Handles a save action. This saves the user's code without executing it.
108
# Need to open JUST so we know this is a real exercise.
109
# (This avoids users submitting code for bogus exercises).
110
exercisefile = util.open_exercise_file(exercise)
111
if exercisefile is None:
112
req.throw_error(req.HTTP_NOT_FOUND,
113
"The exercise was not found.")
116
req.write('{"result": "ok"}')
121
conn.write_problem_save(
122
login = req.user.login,
123
exercisename = exercise,
124
date = time.localtime(),
129
def handle_test(req, exercise, code, fields):
130
"""Handles a test action."""
132
exercisefile = util.open_exercise_file(exercise)
133
if exercisefile is None:
134
req.throw_error(req.HTTP_NOT_FOUND,
135
"The exercise was not found.")
137
# Parse the file into a exercise object using the test suite
138
exercise_obj = test.parse_exercise_file(exercisefile)
140
# Run the test cases. Get the result back as a JSONable object.
142
test_results = exercise_obj.run_tests(code)
146
conn.insert_problem_attempt(
147
login = req.user.login,
148
exercisename = exercise,
149
date = time.localtime(),
150
complete = test_results['passed'],
38
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
41
class AttemptsRESTView(JSONRESTView):
42
'''REST view of a user's attempts at an exercise.'''
44
"""Handles a GET Attempts action."""
45
exercise = ivle.database.Exercise.get_by_name(req.store,
47
user = ivle.database.User.get_by_login(req.store, self.username)
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}
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.")
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)
71
# Parse the file into a exercise object using the test suite
72
exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
76
# Run the test cases. Get the result back as a JSONable object.
78
test_results = exercise_obj.run_tests(data['code'])
83
# Get the Exercise from the database
84
exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
86
attempt = ivle.database.ExerciseAttempt(user=req.user,
88
date=datetime.datetime.now(),
89
complete=test_results['passed'],
91
text=unicode(data['code']))
93
req.store.add(attempt)
153
95
# Query the DB to get an updated score on whether or not this problem
154
96
# has EVER been completed (may be different from "passed", if it has
155
97
# been completed before), and the total number of attempts.
156
completed, attempts = conn.get_problem_status(req.user.login,
98
completed, attempts = ivle.worksheet.get_exercise_status(req.store,
158
100
test_results["completed"] = completed
159
101
test_results["attempts"] = attempts
161
req.write(cjson.encode(test_results))
165
def handle_getattempts(req, exercise):
166
"""Handles a getattempts action."""
169
attempts = conn.get_problem_attempts(
170
login=req.user.login,
171
exercisename=exercise,
172
allow_inactive=HISTORY_ALLOW_INACTIVE)
173
req.write(cjson.encode(attempts))
177
def handle_getattempt(req, exercise, date):
178
"""Handles a getattempts action. Date is a struct_time."""
181
attempt = conn.get_problem_attempt(
182
login=req.user.login,
183
exercisename=exercise,
185
allow_inactive=HISTORY_ALLOW_INACTIVE)
106
class AttemptRESTView(JSONRESTView):
107
'''REST view of an exercise attempt.'''
110
# Get an actual date object, rather than a string
111
date = datetime.datetime.strptime(self.date, TIMESTAMP_FORMAT)
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
186
118
# attempt may be None; will write "null"
187
req.write(cjson.encode(attempt))
119
return {'code': attempt}
122
class ExerciseRESTView(JSONRESTView):
123
'''REST view of an exercise.'''
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.")
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"}
added
removed
ivle/webapp/tutorial/service.py
