← 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

Port the tos app to the new framework, and fix ivle.webapp.help's reference
to it.

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