← 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-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/console/service.py
1
 
# IVLE
2
 
# Copyright (C) 2007-2008 The University of Melbourne
 
1
# IVLE - Informatics Virtual Learning Environment
 
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
 
# App: consoleservice
19
 
# Author: Matt Giuca, Tom Conway
20
 
# Date: 14/1/2008
21
 
 
22
 
import cStringIO
23
 
import md5
 
18
# Author: Matt Giuca, Tom Conway, Will Grant
 
19
 
 
20
'''Python console RPC service.
 
21
 
 
22
Provides an HTTP RPC interface to a Python console process.
 
23
 
 
24
'''
 
25
 
24
26
import os
25
 
import random
26
27
import socket
27
 
import sys
28
 
import uuid
29
 
 
30
 
import cjson
31
 
 
32
 
from common import (util, studpath, chat)
33
 
import conf
 
28
 
 
29
try:
 
30
    import json
 
31
except ImportError:
 
32
    import simplejson as json
 
33
 
34
34
import errno
35
35
 
36
 
trampoline_path = os.path.join(conf.ivle_install_dir, "bin/trampoline")
37
 
python_path = "/usr/bin/python"                     # Within jail
38
 
console_dir = "/opt/ivle/scripts"                   # Within jail
39
 
console_path = "/opt/ivle/scripts/python-console"   # Within jail
40
 
 
41
 
def handle(req):
42
 
    """Handler for the Console Service AJAX backend application."""
43
 
    if len(req.path) > 0 and req.path[-1] == os.sep:
44
 
        path = req.path[:-1]
45
 
    else:
46
 
        path = req.path
47
 
    # The path determines which "command" we are receiving
48
 
    if req.path == "start":
49
 
        handle_start(req)
50
 
    elif req.path == "interrupt":
51
 
        handle_chat(req, kind='interrupt')
52
 
    elif req.path == "restart":
53
 
        handle_chat(req, kind='restart')
54
 
    elif req.path == "chat":
55
 
        handle_chat(req)
56
 
    elif req.path == "block":
57
 
        handle_chat(req, kind="block")
58
 
    else:
59
 
        req.throw_error(req.HTTP_BAD_REQUEST)
60
 
 
61
 
def handle_start(req):
62
 
    # Changes the state on the server - must be POST
63
 
    if req.method != "POST":
64
 
        req.throw_error(req.HTTP_BAD_REQUEST)
65
 
    
66
 
    # See if we have been given extra params
67
 
    fields = req.get_fieldstorage()
68
 
    try:
69
 
        startdir = fields.getfirst("startdir").value
70
 
        working_dir = os.path.join("/home", req.user.login, startdir)
71
 
    except AttributeError:
72
 
        working_dir = os.path.join("/home", req.user.login)
73
 
 
74
 
    # Get the UID of the logged-in user
75
 
    uid = req.user.unixid
76
 
 
77
 
    # Set request attributes
78
 
    req.content_type = "text/plain"
79
 
    req.write_html_head_foot = False
80
 
 
81
 
    # Start the server
82
 
    jail_path = os.path.join(conf.jail_base, req.user.login)
83
 
    (host, port, magic) = start_console(uid, jail_path, working_dir)
84
 
 
85
 
    # Assemble the key and return it.
86
 
    key = cjson.encode({"host": host, "port": port, "magic": magic})
87
 
    req.write(cjson.encode(key.encode("hex")))
88
 
 
89
 
def handle_chat(req, kind = "chat"):
90
 
    # The request *should* have the following four fields:
91
 
    # host, port, magic: Host and port where the console server lives,
92
 
    # and the secret to use to digitally sign the communication with the
93
 
    # console server.
94
 
    # text: Fields to pass along to the console server
95
 
    # It simply acts as a proxy to the console server
96
 
    if req.method != "POST":
97
 
        req.throw_error(req.HTTP_BAD_REQUEST)
98
 
    jail_path = os.path.join(conf.jail_base, req.user.login)
99
 
    working_dir = os.path.join("/home", req.user.login)   # Within jail
100
 
    uid = req.user.unixid
101
 
    fields = req.get_fieldstorage()
102
 
    try:
103
 
        key = cjson.decode(fields.getfirst("key").value.decode("hex"))
104
 
        host = key['host']
105
 
        port = key['port']
106
 
        magic = key['magic']
107
 
    except AttributeError:
108
 
        # Any of the getfirsts returned None
109
 
        req.throw_error(req.HTTP_BAD_REQUEST)
110
 
    # If text is None, it was probably just an empty line
111
 
    try:
112
 
        text = fields.getfirst("text").value.decode('utf-8')
113
 
    except AttributeError:
114
 
        text = ""
115
 
 
116
 
    msg = {'cmd':kind, 'text':text}
117
 
    try:
118
 
        response = chat.chat(host, port, msg, magic, decode = False)
119
 
        
120
 
        # Snoop the response from python-console to check that it's valid
121
 
        try:
122
 
            decoded_response = cjson.decode(response)
123
 
        except cjson.DecodeError:
124
 
            # Could not decode the reply from the python-console server
125
 
            decoded_response = {"restart":
126
 
                "Communication to console process lost"}
127
 
        if "restart" in decoded_response:
128
 
            response = restart_console(uid, jail_path, working_dir,
129
 
                decoded_response["restart"])
130
 
 
131
 
    except socket.error, (enumber, estring):
132
 
        if enumber == errno.ECONNREFUSED:
133
 
            # Timeout: Restart the session
134
 
            response = restart_console(uid, jail_path, working_dir,
135
 
                "The IVLE console has timed out due to inactivity")
 
36
import ivle.console
 
37
import ivle.chat
 
38
from ivle.webapp.base.rest import JSONRESTView, write_operation
 
39
from ivle.webapp.errors import BadRequest
 
40
 
 
41
# XXX: Should be RPC view, with actions in URL?
 
42
class ConsoleServiceRESTView(JSONRESTView):
 
43
    '''An RPC interface to a Python console.'''
 
44
    def get_permissions(self, user, config):
 
45
        if user is not None:
 
46
            return set(['use'])
136
47
        else:
137
 
            # Some other error - probably serious
138
 
            raise socket.error, (enumber, estring)
139
 
 
140
 
    req.content_type = "text/plain"
141
 
    req.write(response)
142
 
 
143
 
def start_console(uid, jail_path, working_dir):
144
 
    """Starts up a console service for user uid, inside chroot jail jail_path 
145
 
    with work directory of working_dir
146
 
    Returns a tupple (host, port, magic)
147
 
    """
148
 
 
149
 
    # TODO: Figure out the host name the console server is running on.
150
 
    host = socket.gethostname()
151
 
 
152
 
    # Create magic
153
 
    # TODO
154
 
    magic = md5.new(uuid.uuid4().bytes).digest().encode('hex')
155
 
 
156
 
    # Try to find a free port on the server.
157
 
    # Just try some random ports in the range [3000,8000)
158
 
    # until we either succeed, or give up. If you think this
159
 
    # sounds risky, it isn't:
160
 
    # For N ports (e.g. 5000) with k (e.g. 100) in use, the
161
 
    # probability of failing to find a free port in t (e.g. 5) tries
162
 
    # is (k / N) ** t (e.g. 3.2*10e-9).
163
 
 
164
 
    tries = 0
165
 
    while tries < 5:
166
 
        port = int(random.uniform(3000, 8000))
167
 
 
168
 
        # Start the console server (port, magic)
169
 
        # trampoline usage: tramp uid jail_dir working_dir script_path args
170
 
        # console usage:    python-console port magic
171
 
        cmd = ' '.join([trampoline_path, str(uid), jail_path,
172
 
                            console_dir, python_path, console_path,
173
 
                            str(port), str(magic), working_dir])
174
 
 
175
 
        res = os.system(cmd)
176
 
 
177
 
        if res == 0:
178
 
            # success
179
 
            break;
180
 
 
181
 
        tries += 1
182
 
 
183
 
    # If we can't start the console after 5 attemps (can't find a free port 
184
 
    # during random probing, syntax errors, segfaults) throw an exception.
185
 
    if tries == 5:
186
 
        raise Exception, "unable to start console service!"
187
 
 
188
 
    return (host, port, magic)
189
 
 
190
 
def restart_console(uid, jail_path, working_dir, reason):
 
48
            return set()
 
49
 
 
50
    @write_operation('use')
 
51
    def start(self, req, cwd=''):
 
52
        working_dir = os.path.join("/home", req.user.login, cwd)
 
53
 
 
54
        # 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)
 
59
 
 
60
        # 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')}
 
64
 
 
65
    @write_operation('use')
 
66
    def chat(self, req, key, text='', cwd='', kind="chat"):
 
67
        # The request *should* have the following four fields:
 
68
        # key: Hex JSON dict of host and port where the console server lives,
 
69
        # and the secret to use to digitally sign the communication with the
 
70
        # console server.
 
71
        # text: Fields to pass along to the console server
 
72
        # It simply acts as a proxy to the console server
 
73
 
 
74
        try:
 
75
            keydict = json.loads(key.decode('hex'))
 
76
            host = keydict['host']
 
77
            port = keydict['port']
 
78
            magic = keydict['magic']
 
79
        except KeyError:
 
80
            raise BadRequest("Invalid console key.")
 
81
 
 
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')
 
89
 
 
90
        msg = {'cmd':kind, 'text':text}
 
91
        try:
 
92
            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):
 
97
                # Could not decode the reply from the python-console server
 
98
                response = {"terminate":
 
99
                    "Communication lost"}
 
100
            if "terminate" in response:
 
101
                response = restart_console(req.config, req.user, jail_path,
 
102
                    working_dir, response["terminate"])
 
103
        except socket.error, (enumber, estring):
 
104
            if enumber == errno.ECONNREFUSED:
 
105
                # Timeout: Restart the session
 
106
                response = restart_console(req.config, req.user, jail_path,
 
107
                    working_dir,
 
108
                    "Timed out due to inactivity")
 
109
            elif enumber == errno.ECONNRESET:
 
110
                # Communication issue: Restart the session
 
111
                response = restart_console(req.config, req.user, jail_path,
 
112
                    working_dir,
 
113
                    "Connection reset")
 
114
            else:
 
115
                # Some other error - probably serious
 
116
                raise socket.error, (enumber, estring)
 
117
        return response
 
118
 
 
119
 
 
120
def restart_console(config, user, jail_path, working_dir, reason):
191
121
    """Tells the client that it must be issued a new console since the old 
192
122
    console is no longer availible. The client must accept the new key.
193
123
    Returns the JSON response to be given to the client.
194
124
    """
195
125
    # Start a new console server console
196
 
    (host, port, magic) = start_console(uid, jail_path, working_dir)
 
126
    cons = ivle.console.Console(config, user, jail_path, working_dir)
197
127
 
198
128
    # Make a JSON object to tell the browser to restart its console client
199
 
    new_key = cjson.encode({"host": host, "port": port, "magic": magic})
200
 
    json_restart = {
201
 
        "restart": reason,
202
 
        "key": new_key.encode("hex"),
203
 
    }
204
 
    
205
 
    return cjson.encode(json_restart)
 
129
    new_key = json.dumps(
 
130
        {"host": cons.host, "port": cons.port, "magic": cons.magic})
206
131
 
 
132
    return {"restart": reason, "key": new_key.encode("hex")}