← 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

  • Committer: William Grant
  • Date: 2010-07-30 01:16:11 UTC
  • Revision ID: grantw@unimelb.edu.au-20100730011611-ik9hj6yueeh6gc9h
Set version to 1.0.2rc1.

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