← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ivle/webapp/console/service.py

Fixed an oversight in the tutorial code which was printing <worksheet>
and <exercise> tags into the output

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/console/service.py
26
26
import os
27
27
import socket
28
28
 
29
 
try:
30
 
    import json
31
 
except ImportError:
32
 
    import simplejson as json
33
 
 
 
29
import cjson
34
30
import errno
35
31
 
36
32
import ivle.console
37
33
import ivle.chat
38
 
from ivle.webapp.base.rest import JSONRESTView, write_operation
39
 
from ivle.webapp.errors import BadRequest
 
34
import ivle.conf
 
35
from ivle.webapp.base.rest import JSONRESTView, named_operation
40
36
 
41
37
# XXX: Should be RPC view, with actions in URL?
42
38
class ConsoleServiceRESTView(JSONRESTView):
43
39
    '''An RPC interface to a Python console.'''
44
 
    def get_permissions(self, user, config):
45
 
        if user is not None:
46
 
            return set(['use'])
47
 
        else:
48
 
            return set()
49
 
 
50
 
    @write_operation('use')
 
40
    @named_operation
51
41
    def start(self, req, cwd=''):
52
42
        working_dir = os.path.join("/home", req.user.login, cwd)
53
43
 
 
44
        uid = req.user.unixid
 
45
 
54
46
        # Start the server
55
 
        jail_path = os.path.join(req.config['paths']['jails']['mounts'],
56
 
                                 req.user.login)
57
 
        cons = ivle.console.Console(req.config, req.user, jail_path,
58
 
                working_dir)
 
47
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
48
        cons = ivle.console.Console(uid, jail_path, working_dir)
59
49
 
60
50
        # Assemble the key and return it. Yes, it is double-encoded.
61
 
        return {'key': json.dumps({"host": cons.host,
62
 
                                   "port": cons.port,
63
 
                                   "magic": cons.magic}).encode('hex')}
 
51
        return {'key': cjson.encode({"host": cons.host,
 
52
                                     "port": cons.port,
 
53
                                     "magic": cons.magic}).encode('hex')}
64
54
 
65
 
    @write_operation('use')
66
 
    def chat(self, req, key, text='', cwd='', kind="chat"):
 
55
    @named_operation
 
56
    def chat(self, req, key, text='', kind="chat"):
67
57
        # The request *should* have the following four fields:
68
58
        # key: Hex JSON dict of host and port where the console server lives,
69
59
        # and the secret to use to digitally sign the communication with the
72
62
        # It simply acts as a proxy to the console server
73
63
 
74
64
        try:
75
 
            keydict = json.loads(key.decode('hex'))
 
65
            keydict = cjson.decode(key.decode('hex'))
76
66
            host = keydict['host']
77
67
            port = keydict['port']
78
68
            magic = keydict['magic']
79
69
        except KeyError:
80
70
            raise BadRequest("Invalid console key.")
81
71
 
82
 
        jail_path = os.path.join(req.config['paths']['jails']['mounts'],
83
 
                                 req.user.login)
84
 
        # Within Jail
85
 
        working_dir = os.path.join("/home", req.user.login, cwd)
86
 
 
87
 
        # XXX: JSONRESTView should do this for us.
88
 
        text = text.decode('utf-8')
 
72
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
73
        working_dir = os.path.join("/home", req.user.login)   # Within jail
 
74
        uid = req.user.unixid
89
75
 
90
76
        msg = {'cmd':kind, 'text':text}
91
77
        try:
 
78
            json_response = ivle.chat.chat(host, port, msg, magic,decode=False)
 
79
 
 
80
            # Snoop the response from python-console to check that it's valid
92
81
            try:
93
 
                json_response = ivle.chat.chat(host, port, msg, magic,decode=False)
94
 
                # Snoop the response from python-console to check that it's valid
95
 
                response = json.loads(json_response)
96
 
            except (ValueError, ivle.chat.ProtocolError):
 
82
                response = cjson.decode(json_response)
 
83
            except cjson.DecodeError:
97
84
                # Could not decode the reply from the python-console server
98
85
                response = {"terminate":
99
 
                    "Communication lost"}
 
86
                    "Communication to console process lost"}
100
87
            if "terminate" in response:
101
 
                response = restart_console(req.config, req.user, jail_path,
102
 
                    working_dir, response["terminate"])
 
88
                response = restart_console(uid, jail_path, working_dir,
 
89
                    response["terminate"])
103
90
        except socket.error, (enumber, estring):
104
91
            if enumber == errno.ECONNREFUSED:
105
92
                # Timeout: Restart the session
106
 
                response = restart_console(req.config, req.user, jail_path,
107
 
                    working_dir,
108
 
                    "Timed out due to inactivity")
 
93
                response = restart_console(uid, jail_path, working_dir,
 
94
                    "The IVLE console has timed out due to inactivity")
109
95
            elif enumber == errno.ECONNRESET:
110
96
                # Communication issue: Restart the session
111
 
                response = restart_console(req.config, req.user, jail_path,
112
 
                    working_dir,
113
 
                    "Connection reset")
 
97
                response = restart_console(uid, jail_path, working_dir,
 
98
                    "Connection with the console has been reset")
114
99
            else:
115
100
                # Some other error - probably serious
116
101
                raise socket.error, (enumber, estring)
117
102
        return response
118
103
 
119
104
 
120
 
def restart_console(config, user, jail_path, working_dir, reason):
 
105
def restart_console(uid, jail_path, working_dir, reason):
121
106
    """Tells the client that it must be issued a new console since the old 
122
107
    console is no longer availible. The client must accept the new key.
123
108
    Returns the JSON response to be given to the client.
124
109
    """
125
110
    # Start a new console server console
126
 
    cons = ivle.console.Console(config, user, jail_path, working_dir)
 
111
    cons = ivle.console.Console(uid, jail_path, working_dir)
127
112
 
128
113
    # Make a JSON object to tell the browser to restart its console client
129
 
    new_key = json.dumps(
 
114
    new_key = cjson.encode(
130
115
        {"host": cons.host, "port": cons.port, "magic": cons.magic})
131
116
 
132
117
    return {"restart": reason, "key": new_key.encode("hex")}