← 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-07-28 05:06:15 UTC
  • Revision ID: grantw@unimelb.edu.au-20100728050615-uwbxn9frla3pdw8m
Encode content_type when downloading files. cjson made us write bad code.

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
 
 
25
 
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
 
    jail_path = os.path.join(conf.jail_base, req.username)
38
 
    working_dir = os.path.join("/home", req.username)   # Within jail
39
 
 
40
 
    # Get the UID of the logged-in user
41
 
    try:
42
 
        (_,_,uid,_,_,_,_) = pwd.getpwnam(req.username)
43
 
    except KeyError:
44
 
        # The user does not exist. This should have already failed the
45
 
        # previous test.
46
 
        req.throw_error(req.HTTP_INTERNAL_SERVER_ERROR)
47
 
 
48
 
    # Set request attributes
49
 
    req.content_type = "text/plain"
50
 
    req.write_html_head_foot = False
51
 
 
52
 
    # TODO: Figure out the host name the console server is running on.
53
 
    host = req.hostname
54
 
 
55
 
    # Find an available port on the server.
56
 
    # TODO
57
 
    port = 1025
58
 
 
59
 
    # Create magic
60
 
    # TODO
61
 
    magic = "xyzzy"
62
 
 
63
 
    # Start the console server (port, magic)
64
 
    # trampoline usage: tramp uid jail_dir working_dir script_path args
65
 
    # console usage:    python-console port magic
66
 
    # TODO: Cleanup (don't use os.system)
67
 
    # TODO: Pass working_dir as argument, let console cd to it
68
 
    # Use "&" to run as a background process
69
 
    cmd = ' '.join([trampoline_path, str(uid), jail_path, console_dir,
70
 
        python_path, console_path, str(port), str(magic), "&"])
71
 
    #req.write(cmd + '\n')
72
 
    os.system(cmd)
73
 
 
74
 
    # Return port, magic
75
 
    req.write(cjson.encode({"host": host, "port": port, "magic": magic}))
 
27
import socket
 
28
 
 
29
try:
 
30
    import json
 
31
except ImportError:
 
32
    import simplejson as json
 
33
 
 
34
import errno
 
35
 
 
36
import ivle.console
 
37
import ivle.chat
 
38
from ivle.webapp.base.rest import JSONRESTView, write_operation
 
39
from ivle.webapp.errors import BadRequest
 
40
 
 
41
# XXX: Should be RPC view, with actions in URL?
 
42
class ConsoleServiceRESTView(JSONRESTView):
 
43
    '''An RPC interface to a Python console.'''
 
44
    def get_permissions(self, user, config):
 
45
        if user is not None:
 
46
            return set(['use'])
 
47
        else:
 
48
            return set()
 
49
 
 
50
    @write_operation('use')
 
51
    def start(self, req, cwd=''):
 
52
        working_dir = os.path.join("/home", req.user.login, cwd)
 
53
 
 
54
        # Start the server
 
55
        jail_path = os.path.join(req.config['paths']['jails']['mounts'],
 
56
                                 req.user.login)
 
57
        cons = ivle.console.Console(req.config, req.user, jail_path,
 
58
                working_dir)
 
59
 
 
60
        # Assemble the key and return it. Yes, it is double-encoded.
 
61
        return {'key': json.dumps({"host": cons.host,
 
62
                                   "port": cons.port,
 
63
                                   "magic": cons.magic}).encode('hex')}
 
64
 
 
65
    @write_operation('use')
 
66
    def chat(self, req, key, text='', cwd='', kind="chat"):
 
67
        # The request *should* have the following four fields:
 
68
        # key: Hex JSON dict of host and port where the console server lives,
 
69
        # and the secret to use to digitally sign the communication with the
 
70
        # console server.
 
71
        # text: Fields to pass along to the console server
 
72
        # It simply acts as a proxy to the console server
 
73
 
 
74
        try:
 
75
            keydict = json.loads(key.decode('hex'))
 
76
            host = keydict['host']
 
77
            port = keydict['port']
 
78
            magic = keydict['magic']
 
79
        except KeyError:
 
80
            raise BadRequest("Invalid console key.")
 
81
 
 
82
        jail_path = os.path.join(req.config['paths']['jails']['mounts'],
 
83
                                 req.user.login)
 
84
        # Within Jail
 
85
        working_dir = os.path.join("/home", req.user.login, cwd)
 
86
 
 
87
        # XXX: JSONRESTView should do this for us.
 
88
        text = text.decode('utf-8')
 
89
 
 
90
        msg = {'cmd':kind, 'text':text}
 
91
        try:
 
92
            try:
 
93
                json_response = ivle.chat.chat(host, port, msg, magic,decode=False)
 
94
                # Snoop the response from python-console to check that it's valid
 
95
                response = json.loads(json_response)
 
96
            except (ValueError, ivle.chat.ProtocolError):
 
97
                # Could not decode the reply from the python-console server
 
98
                response = {"terminate":
 
99
                    "Communication lost"}
 
100
            if "terminate" in response:
 
101
                response = restart_console(req.config, req.user, jail_path,
 
102
                    working_dir, response["terminate"])
 
103
        except socket.error, (enumber, estring):
 
104
            if enumber == errno.ECONNREFUSED:
 
105
                # Timeout: Restart the session
 
106
                response = restart_console(req.config, req.user, jail_path,
 
107
                    working_dir,
 
108
                    "Timed out due to inactivity")
 
109
            elif enumber == errno.ECONNRESET:
 
110
                # Communication issue: Restart the session
 
111
                response = restart_console(req.config, req.user, jail_path,
 
112
                    working_dir,
 
113
                    "Connection reset")
 
114
            else:
 
115
                # Some other error - probably serious
 
116
                raise socket.error, (enumber, estring)
 
117
        return response
 
118
 
 
119
 
 
120
def restart_console(config, user, jail_path, working_dir, reason):
 
121
    """Tells the client that it must be issued a new console since the old 
 
122
    console is no longer availible. The client must accept the new key.
 
123
    Returns the JSON response to be given to the client.
 
124
    """
 
125
    # Start a new console server console
 
126
    cons = ivle.console.Console(config, user, jail_path, working_dir)
 
127
 
 
128
    # Make a JSON object to tell the browser to restart its console client
 
129
    new_key = json.dumps(
 
130
        {"host": cons.host, "port": cons.port, "magic": cons.magic})
 
131
 
 
132
    return {"restart": reason, "key": new_key.encode("hex")}