1
# IVLE - Informatics Virtual Learning Environment
2
# Copyright (C) 2007-2009 The University of Melbourne
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.
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.
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
18
# Author: Matt Giuca, Nick Chadwick
20
'''AJAX backend for the tutorial application.'''
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
39
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
41
class AttemptsRESTView(JSONRESTView):
42
'''REST view of a user's attempts at an exercise.'''
44
@require_permission('edit')
46
"""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)
50
# attempts is a list of ExerciseAttempt objects. Convert to dictionaries
51
time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
52
attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
58
@require_permission('edit')
59
def PUT(self, req, data):
60
""" Tests the given submission """
61
# Start a console to run the tests on
62
jail_path = os.path.join(req.config['paths']['jails']['mounts'],
64
working_dir = os.path.join("/home", req.user.login)
65
cons = ivle.console.Console(req.config, req.user.unixid, jail_path,
68
# Parse the file into a exercise object using the test suite
69
exercise_obj = ivle.webapp.tutorial.test.parse_exercise_file(
70
self.context.worksheet_exercise.exercise, cons)
72
# Run the test cases. Get the result back as a JSONable object.
74
test_results = exercise_obj.run_tests(data['code'])
79
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'])
86
req.store.add(attempt)
88
# Query the DB to get an updated score on whether or not this problem
89
# has EVER been completed (may be different from "passed", if it has
90
# 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)
93
test_results["completed"] = completed
94
test_results["attempts"] = attempts
99
class AttemptRESTView(JSONRESTView):
100
'''REST view of an exercise attempt.'''
102
@require_permission('view')
104
return {'code': self.context.text}
107
class WorksheetExerciseRESTView(JSONRESTView):
108
'''REST view of a worksheet exercise.'''
110
@named_operation('view')
111
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'}