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
# Author: Matt Giuca, Nick Chadwick
20
'''AJAX backend for the tutorial application.'''
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.
26
from storm.locals import Store
30
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
31
Offering, Subject, Semester, User, WorksheetExercise
32
import ivle.worksheet.utils
33
import ivle.webapp.tutorial.test
34
from ivle.webapp.base.rest import (JSONRESTView, named_operation,
36
from ivle.webapp.errors import NotFound
51
from ivle import console
55
import ivle.webapp.tutorial.test # XXX: Really .test, not real test.
57
from ivle.webapp.base.rest import JSONRESTView
59
from ivle.webapp.base.rest import named_operation
61
# If True, getattempts or getattempt will allow browsing of inactive/disabled
62
# attempts. If False, will not allow this.
63
HISTORY_ALLOW_INACTIVE = False
39
65
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
41
68
class AttemptsRESTView(JSONRESTView):
42
'''REST view of a user's attempts at an exercise.'''
44
@require_permission('edit')
70
Class to return a list of attempts for a given exercise, or add an Attempt
45
72
def GET(self, req):
46
73
"""Handles a GET Attempts action."""
47
attempts = req.store.find(ExerciseAttempt,
48
ExerciseAttempt.ws_ex_id == self.context.worksheet_exercise.id,
49
ExerciseAttempt.user_id == self.context.user.id)
74
exercise = ivle.database.Exercise.get_by_name(req.store,
76
user = ivle.database.User.get_by_login(req.store, self.username)
78
attempts = ivle.worksheet.get_exercise_attempts(req.store, user,
79
exercise, allow_inactive=HISTORY_ALLOW_INACTIVE)
50
80
# attempts is a list of ExerciseAttempt objects. Convert to dictionaries
51
81
time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
52
82
attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
58
@require_permission('edit')
59
87
def PUT(self, req, data):
60
""" Tests the given submission """
88
''' Tests the given submission '''
89
exercisefile = util.open_exercise_file(self.exercise)
90
if exercisefile is None:
91
req.throw_error(req.HTTP_NOT_FOUND,
92
"The exercise was not found.")
61
94
# Start a console to run the tests on
62
jail_path = os.path.join(req.config['paths']['jails']['mounts'],
95
jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
64
96
working_dir = os.path.join("/home", req.user.login)
65
cons = ivle.console.Console(req.config, req.user.unixid, jail_path,
97
cons = console.Console(req.user.unixid, jail_path, working_dir)
68
99
# Parse the file into a exercise object using the test suite
69
100
exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
70
self.context.worksheet_exercise.exercise, cons)
72
104
# Run the test cases. Get the result back as a JSONable object.
76
108
# Close the console
111
# Get the Exercise from the database
112
exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
79
114
attempt = ivle.database.ExerciseAttempt(user=req.user,
80
worksheet_exercise = self.context.worksheet_exercise,
81
date = datetime.datetime.now(),
82
complete = test_results['passed'],
83
text = unicode(data['code'])
116
date=datetime.datetime.now(),
117
complete=test_results['passed'],
119
text=unicode(data['code']))
86
121
req.store.add(attempt)
88
123
# Query the DB to get an updated score on whether or not this problem
89
124
# has EVER been completed (may be different from "passed", if it has
90
125
# been completed before), and the total number of attempts.
91
completed, attempts = ivle.worksheet.utils.get_exercise_status(
92
req.store, req.user, self.context.worksheet_exercise)
126
completed, attempts = ivle.worksheet.get_exercise_status(req.store,
93
128
test_results["completed"] = completed
94
129
test_results["attempts"] = attempts
96
131
return test_results
99
134
class AttemptRESTView(JSONRESTView):
100
'''REST view of an exercise attempt.'''
102
@require_permission('view')
136
View used to extract the data of a specified attempt
103
139
def GET(self, req):
104
return {'code': self.context.text}
107
class WorksheetExerciseRESTView(JSONRESTView):
108
'''REST view of a worksheet exercise.'''
110
@named_operation('view')
140
# Get an actual date object, rather than a string
141
date = datetime.datetime.strptime(self.date, TIMESTAMP_FORMAT)
143
exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
144
attempt = ivle.worksheet.get_exercise_attempt(req.store, req.user,
145
exercise, as_of=date, allow_inactive=HISTORY_ALLOW_INACTIVE)
146
if attempt is not None:
147
attempt = attempt.text
148
# attempt may be None; will write "null"
149
return {'code': attempt}
151
class ExerciseRESTView(JSONRESTView):
153
Handles a save action. This saves the user's code without executing it.
111
156
def save(self, req, text):
112
# Find the appropriate WorksheetExercise to save to. If its not found,
113
# the user is submitting against a non-existant worksheet/exercise
115
old_save = req.store.find(ExerciseSave,
116
ExerciseSave.ws_ex_id == self.context.id,
117
ExerciseSave.user == req.user).one()
119
#Overwrite the old, or create a new if there isn't one
121
new_save = ExerciseSave()
122
req.store.add(new_save)
126
new_save.worksheet_exercise = self.context
127
new_save.user = req.user
128
new_save.text = unicode(text)
129
new_save.date = datetime.datetime.now()
131
return {"result": "ok"}
134
# Note that this is the view of an existing worksheet. Creation is handled
135
# by OfferingRESTView (as offerings have worksheets)
136
class WorksheetRESTView(JSONRESTView):
137
"""View used to update a worksheet."""
139
@named_operation('edit')
140
def save(self, req, name, assessable, data, format):
141
"""Takes worksheet data and saves it."""
142
self.context.name = unicode(name)
143
self.context.assessable = self.convert_bool(assessable)
144
self.context.data = unicode(data)
145
self.context.format = unicode(format)
146
ivle.worksheet.utils.update_exerciselist(self.context)
148
return {"result": "ok"}
150
class WorksheetsRESTView(JSONRESTView):
151
"""View used to update and create Worksheets."""
153
@named_operation('edit')
154
def add_worksheet(self, req, identifier, name, assessable, data, format):
155
"""Takes worksheet data and adds it."""
157
new_worksheet = Worksheet()
158
new_worksheet.seq_no = self.context.worksheets.count()
159
# Setting new_worksheet.offering implicitly adds new_worksheet,
160
# hence worksheets.count MUST be called above it
161
new_worksheet.offering = self.context
162
new_worksheet.identifier = unicode(identifier)
163
new_worksheet.name = unicode(name)
164
new_worksheet.assessable = self.convert_bool(assessable)
165
new_worksheet.data = unicode(data)
166
new_worksheet.format = unicode(format)
168
# This call is added for clarity, as the worksheet is implicitly added.
169
req.store.add(new_worksheet)
171
ivle.worksheet.utils.update_exerciselist(new_worksheet)
173
return {"result": "ok"}
175
@named_operation('edit')
176
def move_up(self, req, worksheetid):
177
"""Takes a list of worksheet-seq_no pairs and updates their
178
corresponding Worksheet objects to match."""
180
worksheet_below = req.store.find(Worksheet,
181
Worksheet.offering_id == self.context.id,
182
Worksheet.identifier == unicode(worksheetid)).one()
183
if worksheet_below is None:
184
raise NotFound('worksheet_below')
185
worksheet_above = req.store.find(Worksheet,
186
Worksheet.offering_id == self.context.id,
187
Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
188
if worksheet_above is None:
189
raise NotFound('worksheet_above')
191
worksheet_below.seq_no = worksheet_below.seq_no - 1
192
worksheet_above.seq_no = worksheet_above.seq_no + 1
194
return {'result': 'ok'}
196
@named_operation('edit')
197
def move_down(self, req, worksheetid):
198
"""Takes a list of worksheet-seq_no pairs and updates their
199
corresponding Worksheet objects to match."""
201
worksheet_above = req.store.find(Worksheet,
202
Worksheet.offering_id == self.context.id,
203
Worksheet.identifier == unicode(worksheetid)).one()
204
if worksheet_above is None:
205
raise NotFound('worksheet_below')
206
worksheet_below = req.store.find(Worksheet,
207
Worksheet.offering_id == self.context.id,
208
Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
209
if worksheet_below is None:
210
raise NotFound('worksheet_above')
212
worksheet_below.seq_no = worksheet_below.seq_no - 1
213
worksheet_above.seq_no = worksheet_above.seq_no + 1
215
return {'result': 'ok'}
157
# Need to open JUST so we know this is a real exercise.
158
# (This avoids users submitting code for bogus exercises).
159
exercisefile = util.open_exercise_file(self.exercise)
160
if exercisefile is None:
161
req.throw_error(req.HTTP_NOT_FOUND,
162
"The exercise was not found.")
165
exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
166
ivle.worksheet.save_exercise(req.store, req.user, exercise,
167
unicode(text), datetime.datetime.now())
169
return {"result": "ok"}
added
removed
ivle/webapp/tutorial/service.py
