← 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

ivle.webapp.console.service: Port www/apps/consoleservice to new framework.
    consoleservice now lives under /console/service, and actions are taken
    in the "ivle.op" query argument, not as the last segment of the path.
    Otherwise the interface is identical.
www/apps/console/console.js: Update to new consoleservice interface.

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 cStringIO
23
27
import md5
28
32
import uuid
29
33
 
30
34
import cjson
 
35
import errno
31
36
 
32
37
from ivle import (util, studpath, chat, console)
33
38
import ivle.conf
34
 
import errno
 
39
from ivle.webapp.base.views import JSONRESTView, named_operation
 
40
 
 
41
# XXX: Should be RPC view, with actions in URL?
 
42
class ConsoleServiceRESTView(JSONRESTView):
 
43
    '''An RPC interface to a Python console.'''
 
44
    @named_operation
 
45
    def start(self, req, cwd=''):
 
46
        working_dir = os.path.join("/home", req.user.login, cwd)
 
47
 
 
48
        uid = req.user.unixid
 
49
 
 
50
        # Start the server
 
51
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
52
        cons = console.Console(uid, jail_path, working_dir)
 
53
 
 
54
        # Assemble the key and return it. Yes, it is double-encoded.
 
55
        return {'key': cjson.encode({"host": cons.host,
 
56
                                     "port": cons.port,
 
57
                                     "magic": cons.magic}).encode('hex')}
 
58
 
 
59
    @named_operation
 
60
    def chat(self, req, key, text='', kind="chat"):
 
61
        # The request *should* have the following four fields:
 
62
        # key: Hex JSON dict of host and port where the console server lives,
 
63
        # and the secret to use to digitally sign the communication with the
 
64
        # console server.
 
65
        # text: Fields to pass along to the console server
 
66
        # It simply acts as a proxy to the console server
 
67
 
 
68
        try:
 
69
            keydict = cjson.decode(key.decode('hex'))
 
70
            host = keydict['host']
 
71
            port = keydict['port']
 
72
            magic = keydict['magic']
 
73
        except KeyError:
 
74
            raise BadRequest("Invalid console key.")
 
75
 
 
76
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
77
        working_dir = os.path.join("/home", req.user.login)   # Within jail
 
78
        uid = req.user.unixid
 
79
 
 
80
        msg = {'cmd':kind, 'text':text}
 
81
        try:
 
82
            json_response = chat.chat(host, port, msg, magic, decode = False)
 
83
 
 
84
            # Snoop the response from python-console to check that it's valid
 
85
            try:
 
86
                response = cjson.decode(json_response)
 
87
            except cjson.DecodeError:
 
88
                # Could not decode the reply from the python-console server
 
89
                response = {"terminate":
 
90
                    "Communication to console process lost"}
 
91
            if "terminate" in response:
 
92
                response = restart_console(uid, jail_path, working_dir,
 
93
                    response["terminate"])
 
94
        except socket.error, (enumber, estring):
 
95
            if enumber == errno.ECONNREFUSED:
 
96
                # Timeout: Restart the session
 
97
                response = restart_console(uid, jail_path, working_dir,
 
98
                    "The IVLE console has timed out due to inactivity")
 
99
            elif enumber == errno.ECONNRESET:
 
100
                # Communication issue: Restart the session
 
101
                response = restart_console(uid, jail_path, working_dir,
 
102
                    "Connection with the console has been reset")
 
103
            else:
 
104
                # Some other error - probably serious
 
105
                raise socket.error, (enumber, estring)
 
106
        return response
35
107
 
36
108
def handle(req):
37
109
    """Handler for the Console Service AJAX backend application."""
57
129
    else:
58
130
        req.throw_error(req.HTTP_BAD_REQUEST)
59
131
 
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")
140
 
        else:
141
 
            # Some other error - probably serious
142
 
            raise socket.error, (enumber, estring)
143
 
 
144
 
    req.content_type = "text/plain"
145
 
    req.write(response)
 
132
 
146
133
 
147
134
def restart_console(uid, jail_path, working_dir, reason):
148
135
    """Tells the client that it must be issued a new console since the old