← 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
 
# "exercise" - The path to a exercise 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.
36
 
 
37
 
import os
38
 
import time
39
 
 
40
 
import cjson
41
 
 
42
 
from common import (db, util)
43
 
import test
44
 
import conf
45
 
 
46
 
def handle(req):
47
 
    """Handler for Ajax backend TutorialService app."""
48
 
    # Set request attributes
49
 
    req.write_html_head_foot = False     # No HTML
50
 
 
51
 
    if req.path != "":
52
 
        req.throw_error(req.HTTP_BAD_REQUEST)
53
 
    # Get all the arguments, if POST.
54
 
    # Ignore arguments if not POST, since we aren't allowed to cause
55
 
    # side-effects on the server.
56
 
    fields = req.get_fieldstorage()
57
 
    act = fields.getfirst('action')
58
 
    exercise = fields.getfirst('exercise')
59
 
    code = fields.getfirst('code')
60
 
 
61
 
    if exercise == None or code == None or act == None:
62
 
        req.throw_error(req.HTTP_BAD_REQUEST)
63
 
    act = act.value
64
 
    exercise = exercise.value
65
 
    code = code.value
66
 
 
67
 
    if act == "save":
68
 
        handle_save(req, exercise, code, fields)
69
 
    elif act == "test":
70
 
        handle_test(req, exercise, code, fields)
71
 
    elif act == "run":
72
 
        handle_run(req, exercise, code, fields)
73
 
    else:
74
 
        req.throw_error(req.HTTP_BAD_REQUEST)
75
 
 
76
 
def handle_save(req, exercise, code, fields):
77
 
    """Handles a save action. This saves the user's code without executing it.
78
 
    """
79
 
    # Need to open JUST so we know this is a real exercise.
80
 
    # (This avoids users submitting code for bogus exercises).
81
 
    exercisefile = util.open_exercise_file(exercise)
82
 
    if exercisefile is None:
83
 
        req.throw_error(req.HTTP_NOT_FOUND,
84
 
            "The exercise was not found.")
85
 
    exercisefile.close()
86
 
 
87
 
    req.write('{"result": "ok"}')
88
 
 
89
 
    conn = db.DB()
90
 
 
91
 
    try:
92
 
        conn.write_problem_save(
93
 
            login = req.user.login,
94
 
            exercisename = exercise,
95
 
            date = time.localtime(),
96
 
            text = code)
97
 
    finally:
98
 
        conn.close()
99
 
 
100
 
def handle_test(req, exercise, code, fields):
101
 
    """Handles a test action."""
102
 
 
103
 
    exercisefile = util.open_exercise_file(exercise)
104
 
    if exercisefile is None:
105
 
        req.throw_error(req.HTTP_NOT_FOUND,
106
 
            "The exercise was not found.")
107
 
 
108
 
    # Parse the file into a exercise object using the test suite
109
 
    exercise_obj = test.parse_exercise_file(exercisefile)
110
 
    exercisefile.close()
111
 
    # Run the test cases. Get the result back as a JSONable object.
112
 
    # Return it.
113
 
    test_results = exercise_obj.run_tests(code)
114
 
 
115
 
    conn = db.DB()
116
 
    try:
117
 
        conn.insert_problem_attempt(
118
 
            login = req.user.login,
119
 
            exercisename = exercise,
120
 
            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(),
121
66
            complete = test_results['passed'],
122
 
            attempt = code)
 
67
            text = unicode(data['code'])
 
68
        )
 
69
 
 
70
        req.store.add(attempt)
123
71
 
124
72
        # Query the DB to get an updated score on whether or not this problem
125
73
        # has EVER been completed (may be different from "passed", if it has
126
74
        # been completed before), and the total number of attempts.
127
 
        completed, attempts = conn.get_problem_status(req.user.login,
128
 
            exercise)
 
75
        completed, attempts = ivle.worksheet.utils.get_exercise_status(
 
76
                req.store, req.user, self.context.worksheet_exercise)
129
77
        test_results["completed"] = completed
130
78
        test_results["attempts"] = attempts
131
79
 
132
 
        req.write(cjson.encode(test_results))
133
 
    finally:
134
 
        conn.close()
135
 
 
136
 
def handle_run(req, exercise, code, fields):
137
 
    """Handles a run action."""
138
 
    # Extremely makeshift.
139
 
    # For now, just echo the code back
140
 
    output = code
141
 
    out_json = {"stdout": output}
142
 
    req.write(cjson.encode(out_json))
 
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'}