← 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-buildjail now only copies the system's IVLE files if jail/devmode
is True. It defaults to False.

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
30
import errno
35
31
 
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 == "chat":
53
 
        handle_chat(req)
54
 
    elif req.path == "block":
55
 
        handle_chat(req, kind="block")
56
 
    else:
57
 
        req.throw_error(req.HTTP_BAD_REQUEST)
58
 
 
59
 
def handle_start(req):
60
 
    jail_path = os.path.join(conf.jail_base, req.user.login)
61
 
    working_dir = os.path.join("/home", req.user.login)   # Within jail
62
 
 
63
 
    # Get the UID of the logged-in user
64
 
    uid = req.user.unixid
65
 
 
66
 
    # Set request attributes
67
 
    req.content_type = "text/plain"
68
 
    req.write_html_head_foot = False
69
 
 
70
 
    # Start the server
71
 
    (host, port, magic) = start_console(uid, jail_path, working_dir)
72
 
 
73
 
    # Assemble the key and return it.
74
 
    key = cjson.encode({"host": host, "port": port, "magic": magic})
75
 
    req.write(cjson.encode(key.encode("hex")))
76
 
 
77
 
def handle_chat(req, kind = "chat"):
78
 
    # The request *should* have the following four fields:
79
 
    # host, port, magic: Host and port where the console server lives,
80
 
    # and the secret to use to digitally sign the communication with the
81
 
    # console server.
82
 
    # text: Fields to pass along to the console server
83
 
    # It simply acts as a proxy to the console server
84
 
    if req.method != "POST":
85
 
        req.throw_error(req.HTTP_BAD_REQUEST)
86
 
    fields = req.get_fieldstorage()
87
 
    try:
88
 
        key = cjson.decode(fields.getfirst("key").value.decode("hex"))
89
 
        host = key['host']
90
 
        port = key['port']
91
 
        magic = key['magic']
92
 
    except AttributeError:
93
 
        # Any of the getfirsts returned None
94
 
        req.throw_error(req.HTTP_BAD_REQUEST)
95
 
    # If text is None, it was probably just an empty line
96
 
    try:
97
 
        text = fields.getfirst("text").value
98
 
    except AttributeError:
99
 
        text = ""
100
 
 
101
 
    msg = {'cmd':kind, 'text':text}
102
 
    try:
103
 
        response = chat.chat(host, port, msg, magic, decode = False)
104
 
    except socket.error, (enumber, estring):
105
 
        if enumber == errno.ECONNREFUSED:
106
 
            # Timeout: Restart the session
107
 
            jail_path = os.path.join(conf.jail_base, req.user.login)
108
 
            working_dir = os.path.join("/home", req.user.login)   # Within jail
109
 
            
110
 
            # Get the UID of the logged-in user
111
 
            uid = req.user.unixid
112
 
 
113
 
            # Start the console
114
 
            (host, port, magic) = start_console(uid, jail_path, working_dir)
115
 
 
116
 
            # Make a JSON object to tell the browser to restart its console 
117
 
            # client
118
 
            new_key = cjson.encode(
119
 
                {"host": host, "port": port, "magic": magic})
120
 
            json_restart = {
121
 
                "restart": "The IVLE console has timed out due to inactivity",
122
 
                "key": new_key.encode("hex"),
123
 
            }
124
 
            response = cjson.encode(json_restart)
 
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
    def get_permissions(self, user):
 
42
        if user is not None:
 
43
            return set(['use'])
125
44
        else:
126
 
            # Some other error - probably serious
127
 
            raise socket.error, (enumber, estring)
128
 
 
129
 
    req.content_type = "text/plain"
130
 
    req.write(response)
131
 
 
132
 
def start_console(uid, jail_path, working_dir):
133
 
    """Starts up a console service for user uid, inside chroot jail jail_path 
134
 
    with work directory of working_dir
135
 
    Returns a tupple (host, port, magic)
 
45
            return set()
 
46
 
 
47
    @named_operation('use')
 
48
    def start(self, req, cwd=''):
 
49
        working_dir = os.path.join("/home", req.user.login, cwd)
 
50
 
 
51
        uid = req.user.unixid
 
52
 
 
53
        # 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)
 
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(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
 
 
83
        msg = {'cmd':kind, 'text':text}
 
84
        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
            try:
 
89
                response = cjson.decode(json_response)
 
90
            except cjson.DecodeError:
 
91
                # Could not decode the reply from the python-console server
 
92
                response = {"terminate":
 
93
                    "Communication to console process lost"}
 
94
            if "terminate" in response:
 
95
                response = restart_console(uid, jail_path, working_dir,
 
96
                    response["terminate"])
 
97
        except socket.error, (enumber, estring):
 
98
            if enumber == errno.ECONNREFUSED:
 
99
                # Timeout: Restart the session
 
100
                response = restart_console(uid, jail_path, working_dir,
 
101
                    "The IVLE console has timed out due to inactivity")
 
102
            elif enumber == errno.ECONNRESET:
 
103
                # Communication issue: Restart the session
 
104
                response = restart_console(uid, jail_path, working_dir,
 
105
                    "Connection with the console has been reset")
 
106
            else:
 
107
                # Some other error - probably serious
 
108
                raise socket.error, (enumber, estring)
 
109
        return response
 
110
 
 
111
 
 
112
def restart_console(uid, jail_path, working_dir, reason):
 
113
    """Tells the client that it must be issued a new console since the old 
 
114
    console is no longer availible. The client must accept the new key.
 
115
    Returns the JSON response to be given to the client.
136
116
    """
137
 
 
138
 
    # TODO: Figure out the host name the console server is running on.
139
 
    host = socket.gethostname()
140
 
 
141
 
    # Create magic
142
 
    # TODO
143
 
    magic = md5.new(uuid.uuid4().bytes).digest().encode('hex')
144
 
 
145
 
    # Try to find a free port on the server.
146
 
    # Just try some random ports in the range [3000,8000)
147
 
    # until we either succeed, or give up. If you think this
148
 
    # sounds risky, it isn't:
149
 
    # For N ports (e.g. 5000) with k (e.g. 100) in use, the
150
 
    # probability of failing to find a free port in t (e.g. 5) tries
151
 
    # is (k / N) ** t (e.g. 3.2*10e-9).
152
 
 
153
 
    tries = 0
154
 
    while tries < 5:
155
 
        port = int(random.uniform(3000, 8000))
156
 
 
157
 
        # Start the console server (port, magic)
158
 
        # trampoline usage: tramp uid jail_dir working_dir script_path args
159
 
        # console usage:    python-console port magic
160
 
        cmd = ' '.join([trampoline_path, str(uid), jail_path,
161
 
                            console_dir, python_path, console_path,
162
 
                            str(port), str(magic), working_dir])
163
 
 
164
 
        res = os.system(cmd)
165
 
 
166
 
        if res == 0:
167
 
            # success
168
 
            break;
169
 
 
170
 
        tries += 1
171
 
 
172
 
    # If we can't start the console after 5 attemps (can't find a free port 
173
 
    # during random probing, syntax errors, segfaults) throw an exception.
174
 
    if tries == 5:
175
 
        raise Exception, "unable to start console service!"
176
 
 
177
 
    return (host, port, magic)
178
 
 
 
117
    # Start a new console server console
 
118
    cons = ivle.console.Console(uid, jail_path, working_dir)
 
119
 
 
120
    # Make a JSON object to tell the browser to restart its console client
 
121
    new_key = cjson.encode(
 
122
        {"host": cons.host, "port": cons.port, "magic": cons.magic})
 
123
 
 
124
    return {"restart": reason, "key": new_key.encode("hex")}