← 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: David Coles
  • Date: 2009-08-02 08:57:44 UTC
  • mto: (1294.2.119 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: coles.david@gmail.com-20090802085744-ig0mr5fcm29ngibv
Show drop down icon for breadcrumbs with a sub-menu.

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 os
23
 
import pwd
24
 
import httplib
25
 
import urllib
 
27
import socket
26
28
 
27
29
import cjson
28
 
 
29
 
from common import (util, studpath)
30
 
import conf
31
 
 
32
 
trampoline_path = os.path.join(conf.ivle_install_dir, "bin/trampoline")
33
 
python_path = "/usr/bin/python"                     # Within jail
34
 
console_dir = "/opt/ivle/console"                   # Within jail
35
 
console_path = "/opt/ivle/console/python-console"   # Within jail
36
 
 
37
 
def handle(req):
38
 
    """Handler for the Console Service AJAX backend application."""
39
 
    if len(req.path) > 0 and req.path[-1] == os.sep:
40
 
        path = req.path[:-1]
41
 
    else:
42
 
        path = req.path
43
 
    # The path determines which "command" we are receiving
44
 
    if req.path == "start":
45
 
        handle_start(req)
46
 
    elif req.path == "chat":
47
 
        handle_chat(req)
48
 
    else:
49
 
        req.throw_error(req.HTTP_BAD_REQUEST)
50
 
 
51
 
def handle_start(req):
52
 
    jail_path = os.path.join(conf.jail_base, req.username)
53
 
    working_dir = os.path.join("/home", req.username)   # Within jail
54
 
 
55
 
    # Get the UID of the logged-in user
56
 
    try:
57
 
        (_,_,uid,_,_,_,_) = pwd.getpwnam(req.username)
58
 
    except KeyError:
59
 
        # The user does not exist. This should have already failed the
60
 
        # previous test.
61
 
        req.throw_error(req.HTTP_INTERNAL_SERVER_ERROR)
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 = req.hostname
69
 
 
70
 
    # Find an available port on the server.
71
 
    # TODO
72
 
    port = 1025
73
 
 
74
 
    # Create magic
75
 
    # TODO
76
 
    magic = "xyzzy"
77
 
 
78
 
    # Start the console server (port, magic)
79
 
    # trampoline usage: tramp uid jail_dir working_dir script_path args
80
 
    # console usage:    python-console port magic
81
 
    # TODO: Cleanup (don't use os.system)
82
 
    # TODO: Pass working_dir as argument, let console cd to it
83
 
    # Use "&" to run as a background process
84
 
    cmd = ' '.join([trampoline_path, str(uid), jail_path, console_dir,
85
 
        python_path, console_path, str(port), str(magic), "&"])
86
 
    #req.write(cmd + '\n')
87
 
    os.system(cmd)
88
 
 
89
 
    # Return port, magic
90
 
    req.write(cjson.encode({"host": host, "port": port, "magic": magic}))
91
 
 
92
 
def handle_chat(req):
93
 
    # The request *should* have the following four fields:
94
 
    # host, port: Host and port where the console server apparently lives
95
 
    # digest, text: Fields to pass along to the console server
96
 
    # It simply acts as a proxy to the console server
97
 
    if req.method != "POST":
98
 
        req.throw_error(req.HTTP_BAD_REQUEST)
99
 
    fields = req.get_fieldstorage()
100
 
    try:
101
 
        host = fields.getfirst("host").value
102
 
        port = fields.getfirst("port").value
103
 
        digest = fields.getfirst("digest").value
104
 
    except AttributeError:
105
 
        # Any of the getfirsts returned None
106
 
        req.throw_error(req.HTTP_BAD_REQUEST)
107
 
    # If text is None, it was probably just an empty line
108
 
    try:
109
 
        text = fields.getfirst("text").value
110
 
    except AttributeError:
111
 
        text = ""
112
 
 
113
 
    # Open an HTTP connection
114
 
    url = ("http://" + urllib.quote(host) + ":" + urllib.quote(port)
115
 
            + "/chat");
116
 
    body = ("digest=" + urllib.quote(digest)
117
 
            + "&text=" + urllib.quote(text))
118
 
    headers = {"Content-Type": "application/x-www-form-urlencoded"}
119
 
    try:
120
 
        conn = httplib.HTTPConnection(host, port)
121
 
    except:
122
 
        req.throw_error(req.HTTP_BAD_REQUEST)
123
 
    conn.request("POST", url, body, headers)
124
 
 
125
 
    response = conn.getresponse()
126
 
    
127
 
    req.status = response.status
128
 
    # NOTE: Ignoring arbitrary headers returned by the server
129
 
    # Probably not necessary to proxy them
130
 
    req.content_type = response.getheader("Content-Type", "text/plain")
131
 
    req.write(response.read())
132
 
    conn.close()
 
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")}