← 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

  • Committer: William Grant
  • Date: 2010-07-20 04:52:31 UTC
  • mto: This revision was merged to the branch mainline in revision 1826.
  • Revision ID: grantw@unimelb.edu.au-20100720045231-8ia3uk8nao8zdq1i
Replace cjson with json, or simplejson if json is not available (Python <2.6)

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 exercise boxes.
25
 
 
26
 
# Calling syntax
27
 
# Path must be empty.
28
 
# The arguments determine what is to be done on this file.
29
 
 
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)
39
 
#   that date.
40
 
#   Returns JSON string containing code, or null.
41
 
 
42
 
# Returns a JSON response string indicating the results.
43
 
 
44
 
import os
45
 
import time
46
 
 
47
 
import cjson
48
 
 
49
 
from common import (db, util)
50
 
import test
51
 
import conf
52
 
 
53
 
# If True, getattempts or getattempt will allow browsing of inactive/disabled
54
 
# attempts. If False, will not allow this.
55
 
HISTORY_ALLOW_INACTIVE = False
56
 
 
57
 
def handle(req):
58
 
    """Handler for Ajax backend TutorialService app."""
59
 
    # Set request attributes
60
 
    req.write_html_head_foot = False     # No HTML
61
 
 
62
 
    if req.path != "":
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)
69
 
    act = act.value
70
 
    exercise = exercise.value
71
 
 
72
 
    if act == 'save' or act == 'test':
73
 
        # Must be POST
74
 
        if req.method != 'POST':
75
 
            req.throw_error(req.HTTP_BAD_REQUEST)
76
 
 
77
 
        code = fields.getfirst('code')
78
 
        if code is None:
79
 
            req.throw_error(req.HTTP_BAD_REQUEST)
80
 
        code = code.value
81
 
 
82
 
        if act == 'save':
83
 
            handle_save(req, exercise, code, fields)
84
 
        else:   # act == "test"
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')
90
 
        if date is None:
91
 
            req.throw_error(req.HTTP_BAD_REQUEST)
92
 
        date = date.value
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.
96
 
        try:
97
 
            date = time.strptime(date, db.TIMESTAMP_FORMAT)
98
 
        except ValueError:
99
 
            # Date was not in correct format
100
 
            req.throw_error(req.HTTP_BAD_REQUEST)
101
 
        handle_getattempt(req, exercise, date)
102
 
    else:
103
 
        req.throw_error(req.HTTP_BAD_REQUEST)
104
 
 
105
 
def handle_save(req, exercise, code, fields):
106
 
    """Handles a save action. This saves the user's code without executing it.
107
 
    """
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.")
114
 
    exercisefile.close()
115
 
 
116
 
    req.write('{"result": "ok"}')
117
 
 
118
 
    conn = db.DB()
119
 
 
120
 
    try:
121
 
        conn.write_problem_save(
122
 
            login = req.user.login,
123
 
            exercisename = exercise,
124
 
            date = time.localtime(),
125
 
            text = code)
126
 
    finally:
127
 
        conn.close()
128
 
 
129
 
def handle_test(req, exercise, code, fields):
130
 
    """Handles a test action."""
131
 
 
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.")
136
 
 
137
 
    # Parse the file into a exercise object using the test suite
138
 
    exercise_obj = test.parse_exercise_file(exercisefile)
139
 
    exercisefile.close()
140
 
    # Run the test cases. Get the result back as a JSONable object.
141
 
    # Return it.
142
 
    test_results = exercise_obj.run_tests(code)
143
 
 
144
 
    conn = db.DB()
145
 
    try:
146
 
        conn.insert_problem_attempt(
147
 
            login = req.user.login,
148
 
            exercisename = exercise,
149
 
            date = time.localtime(),
 
18
# Author: Matt Giuca, Nick Chadwick
 
19
 
 
20
'''AJAX backend for the tutorial application.'''
 
21
 
 
22
import datetime
 
23
 
 
24
import genshi
 
25
from storm.locals import Store
 
26
 
 
27
import ivle.database
 
28
from ivle.database import Exercise, ExerciseAttempt, ExerciseSave, Worksheet, \
 
29
                          Offering, Subject, Semester, User, WorksheetExercise
 
30
import ivle.worksheet.utils
 
31
from ivle.webapp.base.rest import (JSONRESTView, write_operation,
 
32
                                   require_permission)
 
33
from ivle.webapp.errors import NotFound
 
34
 
 
35
 
 
36
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
 
37
 
 
38
 
 
39
class AttemptsRESTView(JSONRESTView):
 
40
    '''REST view of a user's attempts at an exercise.'''
 
41
 
 
42
    @require_permission('edit')
 
43
    def GET(self, req):
 
44
        """Handles a GET Attempts action."""
 
45
        attempts = req.store.find(ExerciseAttempt, 
 
46
                ExerciseAttempt.ws_ex_id == self.context.worksheet_exercise.id,
 
47
                ExerciseAttempt.user_id == self.context.user.id)
 
48
        # attempts is a list of ExerciseAttempt objects. Convert to dictionaries
 
49
        time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
 
50
        attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
 
51
                for a in attempts]
 
52
 
 
53
        return attempts
 
54
 
 
55
 
 
56
    @require_permission('edit')
 
57
    def PUT(self, req, data):
 
58
        """ Tests the given submission """
 
59
        test_results = ivle.worksheet.utils.test_exercise_submission(
 
60
            req.config, req.user, self.context.worksheet_exercise.exercise,
 
61
            data['code'])
 
62
 
 
63
        attempt = ivle.database.ExerciseAttempt(user=req.user,
 
64
            worksheet_exercise = self.context.worksheet_exercise,
 
65
            date = datetime.datetime.now(),
150
66
            complete = test_results['passed'],
151
 
            attempt = code)
 
67
            text = unicode(data['code'])
 
68
        )
 
69
 
 
70
        req.store.add(attempt)
152
71
 
153
72
        # Query the DB to get an updated score on whether or not this problem
154
73
        # has EVER been completed (may be different from "passed", if it has
155
74
        # been completed before), and the total number of attempts.
156
 
        completed, attempts = conn.get_problem_status(req.user.login,
157
 
            exercise)
 
75
        completed, attempts = ivle.worksheet.utils.get_exercise_status(
 
76
                req.store, req.user, self.context.worksheet_exercise)
158
77
        test_results["completed"] = completed
159
78
        test_results["attempts"] = attempts
160
79
 
161
 
        req.write(cjson.encode(test_results))
162
 
    finally:
163
 
        conn.close()
164
 
 
165
 
def handle_getattempts(req, exercise):
166
 
    """Handles a getattempts action."""
167
 
    conn = db.DB()
168
 
    try:
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))
174
 
    finally:
175
 
        conn.close()
176
 
 
177
 
def handle_getattempt(req, exercise, date):
178
 
    """Handles a getattempts action. Date is a struct_time."""
179
 
    conn = db.DB()
180
 
    try:
181
 
        attempt = conn.get_problem_attempt(
182
 
            login=req.user.login,
183
 
            exercisename=exercise,
184
 
            as_of=date,
185
 
            allow_inactive=HISTORY_ALLOW_INACTIVE)
186
 
        # attempt may be None; will write "null"
187
 
        req.write(cjson.encode(attempt))
188
 
    finally:
189
 
        conn.close()
 
80
        return test_results
 
81
 
 
82
 
 
83
class AttemptRESTView(JSONRESTView):
 
84
    '''REST view of an exercise attempt.'''
 
85
 
 
86
    @require_permission('view')
 
87
    def GET(self, req):
 
88
        return {'code': self.context.text}
 
89
 
 
90
 
 
91
class WorksheetExerciseRESTView(JSONRESTView):
 
92
    '''REST view of a worksheet exercise.'''
 
93
 
 
94
    @write_operation('view')
 
95
    def save(self, req, text):
 
96
        # Find the appropriate WorksheetExercise to save to. If its not found,
 
97
        # the user is submitting against a non-existant worksheet/exercise
 
98
 
 
99
        old_save = req.store.find(ExerciseSave,
 
100
            ExerciseSave.ws_ex_id == self.context.id,
 
101
            ExerciseSave.user == req.user).one()
 
102
        
 
103
        #Overwrite the old, or create a new if there isn't one
 
104
        if old_save is None:
 
105
            new_save = ExerciseSave()
 
106
            req.store.add(new_save)
 
107
        else:
 
108
            new_save = old_save
 
109
        
 
110
        new_save.worksheet_exercise = self.context
 
111
        new_save.user = req.user
 
112
        new_save.text = unicode(text)
 
113
        new_save.date = datetime.datetime.now()
 
114
 
 
115
        return {"result": "ok"}
 
116
 
 
117
 
 
118
class WorksheetsRESTView(JSONRESTView):
 
119
    """View used to update and create Worksheets."""
 
120
 
 
121
    @write_operation('edit_worksheets')
 
122
    def move_up(self, req, worksheetid):
 
123
        """Takes a list of worksheet-seq_no pairs and updates their 
 
124
        corresponding Worksheet objects to match."""
 
125
        
 
126
        worksheet_below = req.store.find(Worksheet,
 
127
            Worksheet.offering_id == self.context.id,
 
128
            Worksheet.identifier == unicode(worksheetid)).one()
 
129
        if worksheet_below is None:
 
130
            raise NotFound('worksheet_below')
 
131
        worksheet_above = req.store.find(Worksheet,
 
132
            Worksheet.offering_id == self.context.id,
 
133
            Worksheet.seq_no == (worksheet_below.seq_no - 1)).one()
 
134
        if worksheet_above is None:
 
135
            raise NotFound('worksheet_above')
 
136
 
 
137
        worksheet_below.seq_no = worksheet_below.seq_no - 1
 
138
        worksheet_above.seq_no = worksheet_above.seq_no + 1
 
139
        
 
140
        return {'result': 'ok'}
 
141
 
 
142
    @write_operation('edit_worksheets')
 
143
    def move_down(self, req, worksheetid):
 
144
        """Takes a list of worksheet-seq_no pairs and updates their 
 
145
        corresponding Worksheet objects to match."""
 
146
        
 
147
        worksheet_above = req.store.find(Worksheet,
 
148
            Worksheet.offering_id == self.context.id,
 
149
            Worksheet.identifier == unicode(worksheetid)).one()
 
150
        if worksheet_above is None:
 
151
            raise NotFound('worksheet_below')
 
152
        worksheet_below = req.store.find(Worksheet,
 
153
            Worksheet.offering_id == self.context.id,
 
154
            Worksheet.seq_no == (worksheet_above.seq_no + 1)).one()
 
155
        if worksheet_below is None:
 
156
            raise NotFound('worksheet_above')
 
157
 
 
158
        worksheet_below.seq_no = worksheet_below.seq_no - 1
 
159
        worksheet_above.seq_no = worksheet_above.seq_no + 1
 
160
        
 
161
        return {'result': 'ok'}