~azzar1/unity/add-show-desktop-key

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# IVLE - Informatics Virtual Learning Environment
# Copyright (C) 2007-2008 The University of Melbourne
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

# Module: TutorialService
# Author: Matt Giuca
# Date:   25/1/2008

# Provides the AJAX backend for the tutorial application.
# This allows several actions to be performed on the code the student has
# typed into one of the exercise boxes.

# Calling syntax
# Path must be empty.
# The arguments determine what is to be done on this file.

# "action". One of the tutorialservice actions.
# "exercise" - The path to a exercise file (including the .xml extension),
#              relative to the subjects base directory.
# action "save" or "test" (POST only):
#   "code" - Full text of the student's code being submitted.
# action "getattempts": No arguments. Returns a list of
#   {'date': 'formatted_date', 'complete': bool} dicts.
# action "getattempt":
#   "date" - Formatted date. Gets most recent attempt before (and including)
#   that date.
#   Returns JSON string containing code, or null.

# Returns a JSON response string indicating the results.

import os
import time

import cjson

from ivle import (db, util, console)
import ivle.conf
import test # XXX: Really .test, not real test.

# If True, getattempts or getattempt will allow browsing of inactive/disabled
# attempts. If False, will not allow this.
HISTORY_ALLOW_INACTIVE = False

def handle(req):
    """Handler for Ajax backend TutorialService app."""
    # Set request attributes
    req.write_html_head_foot = False     # No HTML

    if req.path != "":
        req.throw_error(req.HTTP_BAD_REQUEST)
    fields = req.get_fieldstorage()
    act = fields.getfirst('action')
    exercise = fields.getfirst('exercise')
    if act is None or exercise is None:
        req.throw_error(req.HTTP_BAD_REQUEST)
    act = act.value
    exercise = exercise.value

    if act == 'save' or act == 'test':
        # Must be POST
        if req.method != 'POST':
            req.throw_error(req.HTTP_BAD_REQUEST)

        code = fields.getfirst('code')
        if code is None:
            req.throw_error(req.HTTP_BAD_REQUEST)
        code = code.value

        if act == 'save':
            handle_save(req, exercise, code, fields)
        else:   # act == "test"
            handle_test(req, exercise, code, fields)
    elif act == 'getattempts':
        handle_getattempts(req, exercise)
    elif act == 'getattempt':
        date = fields.getfirst('date')
        if date is None:
            req.throw_error(req.HTTP_BAD_REQUEST)
        date = date.value
        # Convert into a struct_time
        # The time *should* be in the same format as the DB (since it should
        # be bounced back to us from the getattempts output). Assume this.
        try:
            date = time.strptime(date, db.TIMESTAMP_FORMAT)
        except ValueError:
            # Date was not in correct format
            req.throw_error(req.HTTP_BAD_REQUEST)
        handle_getattempt(req, exercise, date)
    else:
        req.throw_error(req.HTTP_BAD_REQUEST)

def handle_save(req, exercise, code, fields):
    """Handles a save action. This saves the user's code without executing it.
    """
    # Need to open JUST so we know this is a real exercise.
    # (This avoids users submitting code for bogus exercises).
    exercisefile = util.open_exercise_file(exercise)
    if exercisefile is None:
        req.throw_error(req.HTTP_NOT_FOUND,
            "The exercise was not found.")
    exercisefile.close()

    req.write('{"result": "ok"}')

    conn = db.DB()

    try:
        conn.write_problem_save(
            login = req.user.login,
            exercisename = exercise,
            date = time.localtime(),
            text = code)
    finally:
        conn.close()

def handle_test(req, exercise, code, fields):
    """Handles a test action."""

    exercisefile = util.open_exercise_file(exercise)
    if exercisefile is None:
        req.throw_error(req.HTTP_NOT_FOUND,
            "The exercise was not found.")

    # Start a console to run the tests on
    jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
    working_dir = os.path.join("/home", req.user.login)
    cons = console.Console(req.user.unixid, jail_path, working_dir)

    # Parse the file into a exercise object using the test suite
    exercise_obj = test.parse_exercise_file(exercisefile, cons)
    exercisefile.close()

    # Run the test cases. Get the result back as a JSONable object.
    # Return it.
    test_results = exercise_obj.run_tests(code)

    # Close the console
    cons.close()

    conn = db.DB()
    try:
        conn.insert_problem_attempt(
            login = req.user.login,
            exercisename = exercise,
            date = time.localtime(),
            complete = test_results['passed'],
            attempt = code)

        # Query the DB to get an updated score on whether or not this problem
        # has EVER been completed (may be different from "passed", if it has
        # been completed before), and the total number of attempts.
        completed, attempts = conn.get_problem_status(req.user.login,
            exercise)
        test_results["completed"] = completed
        test_results["attempts"] = attempts

        req.write(cjson.encode(test_results))
    finally:
        conn.close()

def handle_getattempts(req, exercise):
    """Handles a getattempts action."""
    conn = db.DB()
    try:
        attempts = conn.get_problem_attempts(
            login=req.user.login,
            exercisename=exercise,
            allow_inactive=HISTORY_ALLOW_INACTIVE)
        req.write(cjson.encode(attempts))
    finally:
        conn.close()

def handle_getattempt(req, exercise, date):
    """Handles a getattempts action. Date is a struct_time."""
    conn = db.DB()
    try:
        attempt = conn.get_problem_attempt(
            login=req.user.login,
            exercisename=exercise,
            as_of=date,
            allow_inactive=HISTORY_ALLOW_INACTIVE)
        # attempt may be None; will write "null"
        req.write(cjson.encode({'code': attempt}))
    finally:
        conn.close()