← 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-24 07:22:43 UTC
  • Revision ID: grantw@unimelb.edu.au-20100224072243-xq5w2we8iuoteen1
Reword and reformat the tour a bit.

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 ivle import (util, studpath, chat, console)
33
 
import ivle.conf
34
30
import errno
35
31
 
36
 
def handle(req):
37
 
    """Handler for the Console Service AJAX backend application."""
38
 
    if len(req.path) > 0 and req.path[-1] == os.sep:
39
 
        path = req.path[:-1]
40
 
    else:
41
 
        path = req.path
42
 
    # The path determines which "command" we are receiving
43
 
    if req.path == "start":
44
 
        handle_start(req)
45
 
    elif req.path == "interrupt":
46
 
        handle_chat(req, kind='interrupt')
47
 
    elif req.path == "restart":
48
 
        handle_chat(req, kind='terminate')
49
 
    elif req.path == "chat":
50
 
        handle_chat(req)
51
 
    elif req.path == "block":
52
 
        handle_chat(req, kind="block")
53
 
    elif req.path == "flush":
54
 
        handle_chat(req, kind="flush")
55
 
    elif req.path == "inspect":
56
 
        handle_chat(req, kind="inspect")
57
 
    else:
58
 
        req.throw_error(req.HTTP_BAD_REQUEST)
59
 
 
60
 
def handle_start(req):
61
 
    # Changes the state on the server - must be POST
62
 
    if req.method != "POST":
63
 
        req.throw_error(req.HTTP_BAD_REQUEST)
64
 
    
65
 
    # See if we have been given extra params
66
 
    fields = req.get_fieldstorage()
67
 
    try:
68
 
        startdir = fields.getfirst("startdir").value
69
 
        working_dir = os.path.join("/home", req.user.login, startdir)
70
 
    except AttributeError:
71
 
        working_dir = os.path.join("/home", req.user.login)
72
 
 
73
 
    # Get the UID of the logged-in user
74
 
    uid = req.user.unixid
75
 
 
76
 
    # Set request attributes
77
 
    req.content_type = "text/plain"
78
 
    req.write_html_head_foot = False
79
 
 
80
 
    # Start the server
81
 
    jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
82
 
    cons = console.Console(uid, jail_path, working_dir)
83
 
 
84
 
    # Assemble the key and return it.
85
 
    key = cjson.encode(
86
 
        {"host": cons.host, "port": cons.port, "magic": cons.magic})
87
 
    req.write(cjson.encode({"key": key.encode("hex")}))
88
 
 
89
 
def handle_chat(req, kind = "chat"):
90
 
    # The request *should* have the following four fields:
91
 
    # host, port, magic: Host and port where the console server lives,
92
 
    # and the secret to use to digitally sign the communication with the
93
 
    # console server.
94
 
    # text: Fields to pass along to the console server
95
 
    # It simply acts as a proxy to the console server
96
 
    if req.method != "POST":
97
 
        req.throw_error(req.HTTP_BAD_REQUEST)
98
 
    jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
99
 
    working_dir = os.path.join("/home", req.user.login)   # Within jail
100
 
    uid = req.user.unixid
101
 
    fields = req.get_fieldstorage()
102
 
    try:
103
 
        key = cjson.decode(fields.getfirst("key").value.decode("hex"))
104
 
        host = key['host']
105
 
        port = key['port']
106
 
        magic = key['magic']
107
 
    except AttributeError:
108
 
        # Any of the getfirsts returned None
109
 
        req.throw_error(req.HTTP_BAD_REQUEST)
110
 
    # If text is None, it was probably just an empty line
111
 
    try:
112
 
        text = fields.getfirst("text").value.decode('utf-8')
113
 
    except AttributeError:
114
 
        text = ""
115
 
 
116
 
    msg = {'cmd':kind, 'text':text}
117
 
    try:
118
 
        response = chat.chat(host, port, msg, magic, decode = False)
119
 
        
120
 
        # Snoop the response from python-console to check that it's valid
121
 
        try:
122
 
            decoded_response = cjson.decode(response)
123
 
        except cjson.DecodeError:
124
 
            # Could not decode the reply from the python-console server
125
 
            decoded_response = {"terminate":
126
 
                "Communication to console process lost"}
127
 
        if "terminate" in decoded_response:
128
 
            response = restart_console(uid, jail_path, working_dir,
129
 
                decoded_response["terminate"])
130
 
 
131
 
    except socket.error, (enumber, estring):
132
 
        if enumber == errno.ECONNREFUSED:
133
 
            # Timeout: Restart the session
134
 
            response = restart_console(uid, jail_path, working_dir,
135
 
                "The IVLE console has timed out due to inactivity")
136
 
        elif enumber == errno.ECONNRESET:
137
 
            # Communication issue: Restart the session
138
 
            response = restart_console(uid, jail_path, working_dir,
139
 
                "Connection with the console has been reset")
 
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, config):
 
41
        if user is not None:
 
42
            return set(['use'])
140
43
        else:
141
 
            # Some other error - probably serious
142
 
            raise socket.error, (enumber, estring)
143
 
 
144
 
    req.content_type = "text/plain"
145
 
    req.write(response)
146
 
 
147
 
def restart_console(uid, jail_path, working_dir, reason):
 
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
            try:
 
91
                json_response = ivle.chat.chat(host, port, msg, magic,decode=False)
 
92
                # Snoop the response from python-console to check that it's valid
 
93
                response = cjson.decode(json_response)
 
94
            except (cjson.DecodeError, ivle.chat.ProtocolError):
 
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):
148
119
    """Tells the client that it must be issued a new console since the old 
149
120
    console is no longer availible. The client must accept the new key.
150
121
    Returns the JSON response to be given to the client.
151
122
    """
152
123
    # Start a new console server console
153
 
    cons = console.Console(uid, jail_path, working_dir)
 
124
    cons = ivle.console.Console(config, uid, jail_path, working_dir)
154
125
 
155
126
    # Make a JSON object to tell the browser to restart its console client
156
127
    new_key = cjson.encode(
157
128
        {"host": cons.host, "port": cons.port, "magic": cons.magic})
158
 
    json_restart = {
159
 
        "restart": reason,
160
 
        "key": new_key.encode("hex"),
161
 
    }
162
 
    
163
 
    return cjson.encode(json_restart)
 
129
 
 
130
    return {"restart": reason, "key": new_key.encode("hex")}