← 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-03 08:18:50 UTC
  • Revision ID: grantw@unimelb.edu.au-20100703081850-ygl8vp5nyznf3dnk
Trailing slashes in URLs can now be detected by views accepting subpaths.

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/console/service.py
 
1
# IVLE - Informatics Virtual Learning Environment
 
2
# Copyright (C) 2007-2009 The University of Melbourne
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
17
 
 
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
 
 
26
import os
 
27
import socket
 
28
 
 
29
import cjson
 
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, config):
 
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
        # Start the server
 
51
        jail_path = os.path.join(req.config['paths']['jails']['mounts'],
 
52
                                 req.user.login)
 
53
        cons = ivle.console.Console(req.config, req.user, jail_path,
 
54
                working_dir)
 
55
 
 
56
        # Assemble the key and return it. Yes, it is double-encoded.
 
57
        return {'key': cjson.encode({"host": cons.host,
 
58
                                     "port": cons.port,
 
59
                                     "magic": cons.magic}).encode('hex')}
 
60
 
 
61
    @named_operation('use')
 
62
    def chat(self, req, key, text='', cwd='', kind="chat"):
 
63
        # The request *should* have the following four fields:
 
64
        # key: Hex JSON dict of host and port where the console server lives,
 
65
        # and the secret to use to digitally sign the communication with the
 
66
        # console server.
 
67
        # text: Fields to pass along to the console server
 
68
        # It simply acts as a proxy to the console server
 
69
 
 
70
        try:
 
71
            keydict = cjson.decode(key.decode('hex'))
 
72
            host = keydict['host']
 
73
            port = keydict['port']
 
74
            magic = keydict['magic']
 
75
        except KeyError:
 
76
            raise BadRequest("Invalid console key.")
 
77
 
 
78
        jail_path = os.path.join(req.config['paths']['jails']['mounts'],
 
79
                                 req.user.login)
 
80
        # Within Jail
 
81
        working_dir = os.path.join("/home", req.user.login, cwd)
 
82
 
 
83
        # XXX: JSONRESTView should do this for us.
 
84
        text = text.decode('utf-8')
 
85
 
 
86
        msg = {'cmd':kind, 'text':text}
 
87
        try:
 
88
            try:
 
89
                json_response = ivle.chat.chat(host, port, msg, magic,decode=False)
 
90
                # Snoop the response from python-console to check that it's valid
 
91
                response = cjson.decode(json_response)
 
92
            except (cjson.DecodeError, ivle.chat.ProtocolError):
 
93
                # Could not decode the reply from the python-console server
 
94
                response = {"terminate":
 
95
                    "Communication lost"}
 
96
            if "terminate" in response:
 
97
                response = restart_console(req.config, req.user, jail_path,
 
98
                    working_dir, response["terminate"])
 
99
        except socket.error, (enumber, estring):
 
100
            if enumber == errno.ECONNREFUSED:
 
101
                # Timeout: Restart the session
 
102
                response = restart_console(req.config, req.user, jail_path,
 
103
                    working_dir,
 
104
                    "Timed out due to inactivity")
 
105
            elif enumber == errno.ECONNRESET:
 
106
                # Communication issue: Restart the session
 
107
                response = restart_console(req.config, req.user, jail_path,
 
108
                    working_dir,
 
109
                    "Connection reset")
 
110
            else:
 
111
                # Some other error - probably serious
 
112
                raise socket.error, (enumber, estring)
 
113
        return response
 
114
 
 
115
 
 
116
def restart_console(config, user, jail_path, working_dir, reason):
 
117
    """Tells the client that it must be issued a new console since the old 
 
118
    console is no longer availible. The client must accept the new key.
 
119
    Returns the JSON response to be given to the client.
 
120
    """
 
121
    # Start a new console server console
 
122
    cons = ivle.console.Console(config, user, jail_path, working_dir)
 
123
 
 
124
    # Make a JSON object to tell the browser to restart its console client
 
125
    new_key = cjson.encode(
 
126
        {"host": cons.host, "port": cons.port, "magic": cons.magic})
 
127
 
 
128
    return {"restart": reason, "key": new_key.encode("hex")}