← 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

Began moving tutorialservice over to webapp.

Note that this breaks worksheets for the time being

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/tutorial/service.py
54
54
import ivle.conf
55
55
import test # XXX: Really .test, not real test.
56
56
 
 
57
from ivle.webapp.base.rest import JSONRESTView
 
58
import ivle.database
 
59
from ivle.webapp.base.rest import named_operation
 
60
 
57
61
# If True, getattempts or getattempt will allow browsing of inactive/disabled
58
62
# attempts. If False, will not allow this.
59
63
HISTORY_ALLOW_INACTIVE = False
61
65
TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S'
62
66
 
63
67
 
64
 
def handle(req):
65
 
    """Handler for Ajax backend TutorialService app."""
66
 
    # Set request attributes
67
 
    req.write_html_head_foot = False     # No HTML
68
 
 
69
 
    if req.path != "":
70
 
        req.throw_error(req.HTTP_BAD_REQUEST)
71
 
    fields = req.get_fieldstorage()
72
 
    act = fields.getfirst('action')
73
 
    exercise = fields.getfirst('exercise')
74
 
    if act is None or exercise is None:
75
 
        req.throw_error(req.HTTP_BAD_REQUEST)
76
 
    act = act.value
77
 
    exercise = exercise.value
78
 
 
79
 
    if act == 'save' or act == 'test':
80
 
        # Must be POST
81
 
        if req.method != 'POST':
82
 
            req.throw_error(req.HTTP_BAD_REQUEST)
83
 
 
84
 
        code = fields.getfirst('code')
85
 
        if code is None:
86
 
            req.throw_error(req.HTTP_BAD_REQUEST)
87
 
        code = code.value
88
 
 
89
 
        if act == 'save':
90
 
            handle_save(req, exercise, code, fields)
91
 
        else:   # act == "test"
92
 
            handle_test(req, exercise, code, fields)
93
 
    elif act == 'getattempts':
94
 
        handle_getattempts(req, exercise)
95
 
    elif act == 'getattempt':
96
 
        date = fields.getfirst('date')
97
 
        if date is None:
98
 
            req.throw_error(req.HTTP_BAD_REQUEST)
99
 
        date = date.value
100
 
        # Convert into a struct_time
101
 
        # The time *should* be in the same format as the DB (since it should
102
 
        # be bounced back to us from the getattempts output). Assume this.
103
 
        try:
104
 
            date = datetime.datetime.strptime(date, TIMESTAMP_FORMAT)
105
 
        except ValueError:
106
 
            # Date was not in correct format
107
 
            req.throw_error(req.HTTP_BAD_REQUEST)
108
 
        handle_getattempt(req, exercise, date)
109
 
    else:
110
 
        req.throw_error(req.HTTP_BAD_REQUEST)
111
 
 
112
 
def handle_save(req, exercisename, code, fields):
113
 
    """Handles a save action. This saves the user's code without executing it.
114
 
    """
115
 
    # Need to open JUST so we know this is a real exercise.
116
 
    # (This avoids users submitting code for bogus exercises).
117
 
    exercisefile = util.open_exercise_file(exercisename)
118
 
    if exercisefile is None:
119
 
        req.throw_error(req.HTTP_NOT_FOUND,
120
 
            "The exercise was not found.")
121
 
    exercisefile.close()
122
 
 
123
 
    exercise = ivle.database.Exercise.get_by_name(req.store, exercisename)
124
 
    ivle.worksheet.save_exercise(req.store, req.user, exercise,
125
 
                                 unicode(code), datetime.datetime.now())
126
 
    req.store.commit()
127
 
 
128
 
    req.write('{"result": "ok"}')
129
 
 
130
 
 
131
 
def handle_test(req, exercisesrc, code, fields):
132
 
    """Handles a test action."""
133
 
 
134
 
    exercisefile = util.open_exercise_file(exercisesrc)
135
 
    if exercisefile is None:
136
 
        req.throw_error(req.HTTP_NOT_FOUND,
137
 
            "The exercise was not found.")
138
 
 
139
 
    # Start a console to run the tests on
140
 
    jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
141
 
    working_dir = os.path.join("/home", req.user.login)
142
 
    cons = console.Console(req.user.unixid, jail_path, working_dir)
143
 
 
144
 
    # Parse the file into a exercise object using the test suite
145
 
    exercise_obj = test.parse_exercise_file(exercisefile, cons)
146
 
    exercisefile.close()
147
 
 
148
 
    # Run the test cases. Get the result back as a JSONable object.
149
 
    # Return it.
150
 
    test_results = exercise_obj.run_tests(code)
151
 
 
152
 
    # Close the console
153
 
    cons.close()
154
 
 
155
 
    # Get the Exercise from the database
156
 
    exercise = ivle.database.Exercise.get_by_name(req.store, exercisesrc)
157
 
 
158
 
    attempt = ivle.database.ExerciseAttempt(user=req.user,
159
 
                                            exercise=exercise,
160
 
                                            date=datetime.datetime.now(),
161
 
                                            complete=test_results['passed'],
162
 
                                            text=unicode(code)) # XXX
163
 
 
164
 
    req.store.add(attempt)
165
 
    req.store.commit()
166
 
    # Query the DB to get an updated score on whether or not this problem
167
 
    # has EVER been completed (may be different from "passed", if it has
168
 
    # been completed before), and the total number of attempts.
169
 
    completed, attempts = ivle.worksheet.get_exercise_status(req.store,
170
 
        req.user, exercise)
171
 
    test_results["completed"] = completed
172
 
    test_results["attempts"] = attempts
173
 
 
174
 
    req.write(cjson.encode(test_results))
175
 
 
176
 
def handle_getattempts(req, exercisename):
177
 
    """Handles a getattempts action."""
178
 
    exercise = ivle.database.Exercise.get_by_name(req.store, exercisename)
179
 
    attempts = ivle.worksheet.get_exercise_attempts(req.store, req.user,
180
 
        exercise, allow_inactive=HISTORY_ALLOW_INACTIVE)
181
 
    # attempts is a list of ExerciseAttempt objects. Convert to dictionaries.
182
 
    time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
183
 
    attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
 
68
class AttemptsRESTView(JSONRESTView):
 
69
    '''
 
70
    Class to return a list of attempts for a given exercise, or add an Attempt
 
71
    '''
 
72
    def GET(self, req):
 
73
        """Handles a GET Attempts action."""
 
74
        exercise = ivle.database.Exercise.get_by_name(req.store, 
 
75
                                                        self.exercise)
 
76
        user = ivle.database.User.get_by_login(req.store, self.username)
 
77
 
 
78
        attempts = ivle.worksheet.get_exercise_attempts(req.store, user,
 
79
                            exercise, allow_inactive=HISTORY_ALLOW_INACTIVE)
 
80
        # attempts is a list of ExerciseAttempt objects. Convert to dictionaries
 
81
        time_fmt = lambda dt: datetime.datetime.strftime(dt, TIMESTAMP_FORMAT)
 
82
        attempts = [{'date': time_fmt(a.date), 'complete': a.complete}
184
83
                for a in attempts]
185
 
    req.write(cjson.encode(attempts))
186
 
 
187
 
def handle_getattempt(req, exercisename, date):
188
 
    """Handles a getattempts action. Date is a datetime.datetime."""
189
 
    exercise = ivle.database.Exercise.get_by_name(req.store, exercisename)
190
 
    attempt = ivle.worksheet.get_exercise_attempt(req.store, req.user,
191
 
        exercise, as_of=date, allow_inactive=HISTORY_ALLOW_INACTIVE)
192
 
    if attempt is not None:
193
 
        attempt = attempt.text
194
 
    # attempt may be None; will write "null"
195
 
    req.write(cjson.encode({'code': attempt}))
 
84
        attempts.append(self.exercise)
 
85
        
 
86
        return attempts
 
87
        
 
88
    def PUT(self, req, data):
 
89
        
 
90
        exercisefile = util.open_exercise_file(self.exercise)
 
91
        if exercisefile is None:
 
92
            req.throw_error(req.HTTP_NOT_FOUND,
 
93
                "The exercise was not found.")
 
94
 
 
95
        # Start a console to run the tests on
 
96
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
97
        working_dir = os.path.join("/home", req.user.login)
 
98
        cons = console.Console(req.user.unixid, jail_path, working_dir)
 
99
 
 
100
        # Parse the file into a exercise object using the test suite
 
101
        exercise_obj = test.parse_exercise_file(exercisefile, cons)
 
102
        exercisefile.close()
 
103
 
 
104
        # Run the test cases. Get the result back as a JSONable object.
 
105
        # Return it.
 
106
        test_results = exercise_obj.run_tests(code)
 
107
 
 
108
        # Close the console
 
109
        cons.close()
 
110
 
 
111
        # Get the Exercise from the database
 
112
        exercise = ivle.database.Exercise.get_by_name(req.store, exercisesrc)
 
113
 
 
114
        attempt = ivle.database.ExerciseAttempt(user=req.user,
 
115
                                                exercise=exercise,
 
116
                                                date=datetime.datetime.now(),
 
117
                                                complete=test_results['passed'],
 
118
                                                text=unicode(code)) # XXX
 
119
 
 
120
        req.store.add(attempt)
 
121
        req.store.commit()
 
122
        # Query the DB to get an updated score on whether or not this problem
 
123
        # has EVER been completed (may be different from "passed", if it has
 
124
        # been completed before), and the total number of attempts.
 
125
        completed, attempts = ivle.worksheet.get_exercise_status(req.store,
 
126
            req.user, exercise)
 
127
        test_results["completed"] = completed
 
128
        test_results["attempts"] = attempts
 
129
 
 
130
        return test_results
 
131
        
 
132
 
 
133
class AttemptRESTView(JSONRESTView):
 
134
    '''
 
135
    View used to extract the data of a specified attempt
 
136
    '''
 
137
    
 
138
    def GET(self, req):
 
139
        # Get an actual date object, rather than a string
 
140
        date = datetime.datetime.strptime(self.date, TIMESTAMP_FORMAT)
 
141
        
 
142
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
 
143
        attempt = ivle.worksheet.get_exercise_attempt(req.store, req.user,
 
144
            exercise, as_of=date, allow_inactive=HISTORY_ALLOW_INACTIVE)
 
145
        if attempt is not None:
 
146
            attempt = attempt.text
 
147
        # attempt may be None; will write "null"
 
148
        return {'code': attempt}
 
149
        
 
150
class ExerciseRESTView(JSONRESTView):
 
151
    '''
 
152
    Handles a save action. This saves the user's code without executing it.
 
153
    '''
 
154
    @named_operation
 
155
    def save(self, req, user, text):    
 
156
        # Need to open JUST so we know this is a real exercise.
 
157
        # (This avoids users submitting code for bogus exercises).
 
158
        exercisefile = util.open_exercise_file(self.exercise)
 
159
        if exercisefile is None:
 
160
            req.throw_error(req.HTTP_NOT_FOUND,
 
161
                "The exercise was not found.")
 
162
        exercisefile.close()
 
163
 
 
164
        exercise = ivle.database.Exercise.get_by_name(req.store, self.exercise)
 
165
        ivle.worksheet.save_exercise(req.store, req.user, exercise,
 
166
                                     unicode(code), datetime.datetime.now())
 
167
        req.store.commit()
 
168
        return {"result": "ok"}