← 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: 2009-02-24 06:01:52 UTC
  • mfrom: (1099.5.5 new-dispatch)
  • mto: This revision was merged to the branch mainline in revision 1119.
  • Revision ID: grantw@unimelb.edu.au-20090224060152-136r6lj6zc2eaexp
Merge my console and tutorial changes.

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 httplib
24
 
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
 
25
26
import os
26
 
import pwd
27
 
import random
28
27
import socket
29
 
import sys
30
 
import urllib
31
 
import uuid
32
28
 
33
29
import cjson
34
 
 
35
 
from common import (util, studpath, chat)
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/scripts"                   # Within jail
41
 
console_path = "/opt/ivle/scripts/python-console"   # Within jail
42
 
 
43
 
def handle(req):
44
 
    """Handler for the Console Service AJAX backend application."""
45
 
    if len(req.path) > 0 and req.path[-1] == os.sep:
46
 
        path = req.path[:-1]
47
 
    else:
48
 
        path = req.path
49
 
    # The path determines which "command" we are receiving
50
 
    if req.path == "start":
51
 
        handle_start(req)
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.username)
61
 
    working_dir = os.path.join("/home", req.username)   # Within jail
62
 
 
63
 
    # Get the UID of the logged-in user
64
 
    uid = req.get_session()['unixid']
65
 
 
66
 
    # Set request attributes
67
 
    req.content_type = "text/plain"
68
 
    req.write_html_head_foot = False
69
 
 
70
 
    # TODO: Figure out the host name the console server is running on.
71
 
    host = socket.gethostname()
72
 
 
73
 
    # Create magic
74
 
    # TODO
75
 
    magic = md5.new(uuid.uuid4().bytes).digest().encode('hex')
76
 
 
77
 
    # Try to find a free port on the server.
78
 
    # Just try some random ports in the range [3000,8000)
79
 
    # until we either succeed, or give up. If you think this
80
 
    # sounds risky, it isn't:
81
 
    # For N ports (e.g. 5000) with k (e.g. 100) in use, the
82
 
    # probability of failing to find a free port in t (e.g. 5) tries
83
 
    # is (k / N) ** t (e.g. 3.2*10e-9).
84
 
 
85
 
    tries = 0
86
 
    while tries < 5:
87
 
        port = int(random.uniform(3000, 8000))
88
 
 
89
 
        # Start the console server (port, magic)
90
 
        # trampoline usage: tramp uid jail_dir working_dir script_path args
91
 
        # console usage:    python-console port magic
92
 
        # TODO: Pass working_dir as argument, let console cd to it
93
 
        cmd = ' '.join([trampoline_path, str(uid), jail_path,
94
 
                            console_dir, python_path, console_path,
95
 
                            str(port), str(magic)])
96
 
 
97
 
        res = os.system(cmd)
98
 
 
99
 
        if res == 0:
100
 
            # success
101
 
            break;
102
 
 
103
 
        tries += 1
104
 
 
105
 
    if tries == 5:
106
 
        raise Exception, "unable to find a free port!"
107
 
 
108
 
    # Assemble the key and return it.
109
 
    key = cjson.encode({"host": host, "port": port, "magic": magic})
110
 
    req.write(cjson.encode(key.encode("hex")))
111
 
 
112
 
def handle_chat(req, kind = "chat"):
113
 
    # The request *should* have the following four fields:
114
 
    # host, port, magic: Host and port where the console server lives,
115
 
    # and the secret to use to digitally sign the communication with the
116
 
    # console server.
117
 
    # text: Fields to pass along to the console server
118
 
    # It simply acts as a proxy to the console server
119
 
    if req.method != "POST":
120
 
        req.throw_error(req.HTTP_BAD_REQUEST)
121
 
    fields = req.get_fieldstorage()
122
 
    try:
123
 
        key = cjson.decode(fields.getfirst("key").value.decode("hex"))
124
 
        host = key['host']
125
 
        port = key['port']
126
 
        magic = key['magic']
127
 
    except AttributeError:
128
 
        # Any of the getfirsts returned None
129
 
        req.throw_error(req.HTTP_BAD_REQUEST)
130
 
    # If text is None, it was probably just an empty line
131
 
    try:
132
 
        text = fields.getfirst("text").value
133
 
    except AttributeError:
134
 
        text = ""
135
 
 
136
 
    msg = {'cmd':kind, 'text':text}
137
 
    response = chat.chat(host, port, msg, magic, decode = False)
138
 
    req.content_type = "text/plain"
139
 
    req.write(response)
140
 
 
 
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
    def get_permissions(self, user):
 
42
        if user is not None:
 
43
            return set(['use'])
 
44
        else:
 
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.
 
116
    """
 
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")}