← 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

ivle.webapp.console.service: Port www/apps/consoleservice to new framework.
    consoleservice now lives under /console/service, and actions are taken
    in the "ivle.op" query argument, not as the last segment of the path.
    Otherwise the interface is identical.
www/apps/console/console.js: Update to new consoleservice interface.

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