← 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-02-11 05:27:24 UTC
  • Revision ID: grantw@unimelb.edu.au-20100211052724-171m0779yqzn1y1x
Add a setup.cfg with nose settings. You can now run the suite with 'IVLECONF=. nosetests'.

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