← 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-12-06 10:18:20 UTC
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: grantw@unimelb.edu.au-20091206101820-d1oogsihfruowjfq
Unbreak project(set) traversals.

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
 
27
import socket
24
28
 
25
29
import cjson
26
 
 
27
 
from common import (util, studpath)
28
 
import conf
29
 
 
30
 
trampoline_path = os.path.join(conf.ivle_install_dir, "bin/trampoline")
31
 
python_path = "/usr/bin/python"                     # Within jail
32
 
console_dir = "/opt/ivle/console"                   # Within jail
33
 
console_path = "/opt/ivle/console/python-console"   # Within jail
34
 
 
35
 
def handle(req):
36
 
    """Handler for the Console Service AJAX backend application."""
37
 
    if len(req.path) > 0 and req.path[-1] == os.sep:
38
 
        path = req.path[:-1]
39
 
    else:
40
 
        path = req.path
41
 
    # The path determines which "command" we are receiving
42
 
    if req.path == "start":
43
 
        handle_start(req)
44
 
    elif req.path == "chat":
45
 
        handle_chat(req)
46
 
    else:
47
 
        req.throw_error(req.HTTP_BAD_REQUEST)
48
 
 
49
 
def handle_start(req):
50
 
    jail_path = os.path.join(conf.jail_base, req.username)
51
 
    working_dir = os.path.join("/home", req.username)   # Within jail
52
 
 
53
 
    # Get the UID of the logged-in user
54
 
    try:
55
 
        (_,_,uid,_,_,_,_) = pwd.getpwnam(req.username)
56
 
    except KeyError:
57
 
        # The user does not exist. This should have already failed the
58
 
        # previous test.
59
 
        req.throw_error(req.HTTP_INTERNAL_SERVER_ERROR)
60
 
 
61
 
    # Set request attributes
62
 
    req.content_type = "text/plain"
63
 
    req.write_html_head_foot = False
64
 
 
65
 
    # TODO: Figure out the host name the console server is running on.
66
 
    host = req.hostname
67
 
 
68
 
    # Find an available port on the server.
69
 
    # TODO
70
 
    port = 1025
71
 
 
72
 
    # Create magic
73
 
    # TODO
74
 
    magic = "xyzzy"
75
 
 
76
 
    # Start the console server (port, magic)
77
 
    # trampoline usage: tramp uid jail_dir working_dir script_path args
78
 
    # console usage:    python-console port magic
79
 
    # TODO: Cleanup (don't use os.system)
80
 
    # TODO: Pass working_dir as argument, let console cd to it
81
 
    # Use "&" to run as a background process
82
 
    cmd = ' '.join([trampoline_path, str(uid), jail_path, console_dir,
83
 
        python_path, console_path, str(port), str(magic), "&"])
84
 
    #req.write(cmd + '\n')
85
 
    os.system(cmd)
86
 
 
87
 
    # Return port, magic
88
 
    req.write(cjson.encode({"host": host, "port": port, "magic": magic}))
89
 
 
90
 
def handle_chat(req):
91
 
    req.throw_error(req.HTTP_NOT_IMPLEMENTED)
 
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")}