← 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: 2009-07-17 22:02:23 UTC
  • Revision ID: me@williamgrant.id.au-20090717220223-9b1j9lm6oyon4xsa
Actually 404 when a matching route is not found.

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
28
 
30
29
import cjson
31
 
 
32
 
from common import (util, studpath, chat)
33
 
import conf
34
 
 
35
 
trampoline_path = os.path.join(conf.ivle_install_dir, "bin/trampoline")
36
 
python_path = "/usr/bin/python"                     # Within jail
37
 
console_dir = "/opt/ivle/scripts"                   # Within jail
38
 
console_path = "/opt/ivle/scripts/python-console"   # Within jail
39
 
 
40
 
def handle(req):
41
 
    """Handler for the Console Service AJAX backend application."""
42
 
    if len(req.path) > 0 and req.path[-1] == os.sep:
43
 
        path = req.path[:-1]
44
 
    else:
45
 
        path = req.path
46
 
    # The path determines which "command" we are receiving
47
 
    if req.path == "start":
48
 
        handle_start(req)
49
 
    elif req.path == "chat":
50
 
        handle_chat(req)
51
 
    elif req.path == "block":
52
 
        handle_chat(req, kind="block")
53
 
    else:
54
 
        req.throw_error(req.HTTP_BAD_REQUEST)
55
 
 
56
 
def handle_start(req):
57
 
    jail_path = os.path.join(conf.jail_base, req.username)
58
 
    working_dir = os.path.join("/home", req.username)   # Within jail
59
 
 
60
 
    # Get the UID of the logged-in user
61
 
    uid = req.get_session()['unixid']
62
 
 
63
 
    # Set request attributes
64
 
    req.content_type = "text/plain"
65
 
    req.write_html_head_foot = False
66
 
 
67
 
    # TODO: Figure out the host name the console server is running on.
68
 
    host = socket.gethostname()
69
 
 
70
 
    # Create magic
71
 
    # TODO
72
 
    magic = md5.new(uuid.uuid4().bytes).digest().encode('hex')
73
 
 
74
 
    # Try to find a free port on the server.
75
 
    # Just try some random ports in the range [3000,8000)
76
 
    # until we either succeed, or give up. If you think this
77
 
    # sounds risky, it isn't:
78
 
    # For N ports (e.g. 5000) with k (e.g. 100) in use, the
79
 
    # probability of failing to find a free port in t (e.g. 5) tries
80
 
    # is (k / N) ** t (e.g. 3.2*10e-9).
81
 
 
82
 
    tries = 0
83
 
    while tries < 5:
84
 
        port = int(random.uniform(3000, 8000))
85
 
 
86
 
        # Start the console server (port, magic)
87
 
        # trampoline usage: tramp uid jail_dir working_dir script_path args
88
 
        # console usage:    python-console port magic
89
 
        # TODO: Pass working_dir as argument, let console cd to it
90
 
        cmd = ' '.join([trampoline_path, str(uid), jail_path,
91
 
                            console_dir, python_path, console_path,
92
 
                            str(port), str(magic)])
93
 
 
94
 
        res = os.system(cmd)
95
 
 
96
 
        if res == 0:
97
 
            # success
98
 
            break;
99
 
 
100
 
        tries += 1
101
 
 
102
 
    if tries == 5:
103
 
        raise Exception, "unable to find a free port!"
104
 
 
105
 
    # Assemble the key and return it.
106
 
    key = cjson.encode({"host": host, "port": port, "magic": magic})
107
 
    req.write(cjson.encode(key.encode("hex")))
108
 
 
109
 
def handle_chat(req, kind = "chat"):
110
 
    # The request *should* have the following four fields:
111
 
    # host, port, magic: Host and port where the console server lives,
112
 
    # and the secret to use to digitally sign the communication with the
113
 
    # console server.
114
 
    # text: Fields to pass along to the console server
115
 
    # It simply acts as a proxy to the console server
116
 
    if req.method != "POST":
117
 
        req.throw_error(req.HTTP_BAD_REQUEST)
118
 
    fields = req.get_fieldstorage()
119
 
    try:
120
 
        key = cjson.decode(fields.getfirst("key").value.decode("hex"))
121
 
        host = key['host']
122
 
        port = key['port']
123
 
        magic = key['magic']
124
 
    except AttributeError:
125
 
        # Any of the getfirsts returned None
126
 
        req.throw_error(req.HTTP_BAD_REQUEST)
127
 
    # If text is None, it was probably just an empty line
128
 
    try:
129
 
        text = fields.getfirst("text").value
130
 
    except AttributeError:
131
 
        text = ""
132
 
 
133
 
    msg = {'cmd':kind, 'text':text}
134
 
    response = chat.chat(host, port, msg, magic, decode = False)
135
 
    req.content_type = "text/plain"
136
 
    req.write(response)
137
 
 
 
30
import errno
 
31
 
 
32
import ivle.console
 
33
import ivle.chat
 
34
from ivle.webapp.base.rest import JSONRESTView, named_operation
 
35
from ivle.webapp.errors import BadRequest
 
36
 
 
37
# XXX: Should be RPC view, with actions in URL?
 
38
class ConsoleServiceRESTView(JSONRESTView):
 
39
    '''An RPC interface to a Python console.'''
 
40
    def get_permissions(self, user):
 
41
        if user is not None:
 
42
            return set(['use'])
 
43
        else:
 
44
            return set()
 
45
 
 
46
    @named_operation('use')
 
47
    def start(self, req, cwd=''):
 
48
        working_dir = os.path.join("/home", req.user.login, cwd)
 
49
 
 
50
        uid = req.user.unixid
 
51
 
 
52
        # Start the server
 
53
        jail_path = os.path.join(req.config['paths']['jails']['mounts'],
 
54
                                 req.user.login)
 
55
        cons = ivle.console.Console(req.config, uid, jail_path, working_dir)
 
56
 
 
57
        # 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
 
 
62
    @named_operation('use')
 
63
    def chat(self, req, key, text='', kind="chat"):
 
64
        # The request *should* have the following four fields:
 
65
        # key: Hex JSON dict of host and port where the console server lives,
 
66
        # and the secret to use to digitally sign the communication with the
 
67
        # console server.
 
68
        # text: Fields to pass along to the console server
 
69
        # It simply acts as a proxy to the console server
 
70
 
 
71
        try:
 
72
            keydict = cjson.decode(key.decode('hex'))
 
73
            host = keydict['host']
 
74
            port = keydict['port']
 
75
            magic = keydict['magic']
 
76
        except KeyError:
 
77
            raise BadRequest("Invalid console key.")
 
78
 
 
79
        jail_path = os.path.join(req.config['paths']['jails']['mounts'],
 
80
                                 req.user.login)
 
81
        working_dir = os.path.join("/home", req.user.login)   # Within jail
 
82
        uid = req.user.unixid
 
83
 
 
84
        # XXX: JSONRESTView should do this for us.
 
85
        text = text.decode('utf-8')
 
86
 
 
87
        msg = {'cmd':kind, 'text':text}
 
88
        try:
 
89
            json_response = ivle.chat.chat(host, port, msg, magic,decode=False)
 
90
 
 
91
            # Snoop the response from python-console to check that it's valid
 
92
            try:
 
93
                response = cjson.decode(json_response)
 
94
            except cjson.DecodeError:
 
95
                # Could not decode the reply from the python-console server
 
96
                response = {"terminate":
 
97
                    "Communication to console process lost"}
 
98
            if "terminate" in response:
 
99
                response = restart_console(req.config, uid, jail_path,
 
100
                    working_dir, response["terminate"])
 
101
        except socket.error, (enumber, estring):
 
102
            if enumber == errno.ECONNREFUSED:
 
103
                # Timeout: Restart the session
 
104
                response = restart_console(req.config, uid, jail_path,
 
105
                    working_dir,
 
106
                    "The IVLE console has timed out due to inactivity")
 
107
            elif enumber == errno.ECONNRESET:
 
108
                # Communication issue: Restart the session
 
109
                response = restart_console(req.config, uid, jail_path,
 
110
                    working_dir,
 
111
                    "Connection with the console has been reset")
 
112
            else:
 
113
                # Some other error - probably serious
 
114
                raise socket.error, (enumber, estring)
 
115
        return response
 
116
 
 
117
 
 
118
def restart_console(config, uid, jail_path, working_dir, reason):
 
119
    """Tells the client that it must be issued a new console since the old 
 
120
    console is no longer availible. The client must accept the new key.
 
121
    Returns the JSON response to be given to the client.
 
122
    """
 
123
    # Start a new console server console
 
124
    cons = ivle.console.Console(config, uid, jail_path, working_dir)
 
125
 
 
126
    # Make a JSON object to tell the browser to restart its console client
 
127
    new_key = cjson.encode(
 
128
        {"host": cons.host, "port": cons.port, "magic": cons.magic})
 
129
 
 
130
    return {"restart": reason, "key": new_key.encode("hex")}