← 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: mattgiuca
  • Date: 2008-01-11 00:49:06 UTC
  • Revision ID: svn-v3-trunk0:2b9c9e99-6f39-0410-b283-7f802c844ae2:trunk:172
util: Added buildurl function.

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
 
        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
 
            json_response = ivle.chat.chat(host, port, msg, magic,decode=False)
91
 
 
92
 
            # Snoop the response from python-console to check that it's valid
93
 
            try:
94
 
                response = cjson.decode(json_response)
95
 
            except cjson.DecodeError:
96
 
                # Could not decode the reply from the python-console server
97
 
                response = {"terminate":
98
 
                    "Communication to console process lost"}
99
 
            if "terminate" in response:
100
 
                response = restart_console(req.config, uid, jail_path,
101
 
                    working_dir, response["terminate"])
102
 
        except socket.error, (enumber, estring):
103
 
            if enumber == errno.ECONNREFUSED:
104
 
                # Timeout: Restart the session
105
 
                response = restart_console(req.config, uid, jail_path,
106
 
                    working_dir,
107
 
                    "The IVLE console has timed out due to inactivity")
108
 
            elif enumber == errno.ECONNRESET:
109
 
                # Communication issue: Restart the session
110
 
                response = restart_console(req.config, uid, jail_path,
111
 
                    working_dir,
112
 
                    "Connection with the console has been reset")
113
 
            else:
114
 
                # Some other error - probably serious
115
 
                raise socket.error, (enumber, estring)
116
 
        return response
117
 
 
118
 
 
119
 
def restart_console(config, uid, jail_path, working_dir, reason):
120
 
    """Tells the client that it must be issued a new console since the old 
121
 
    console is no longer availible. The client must accept the new key.
122
 
    Returns the JSON response to be given to the client.
123
 
    """
124
 
    # Start a new console server console
125
 
    cons = ivle.console.Console(config, uid, jail_path, working_dir)
126
 
 
127
 
    # Make a JSON object to tell the browser to restart its console client
128
 
    new_key = cjson.encode(
129
 
        {"host": cons.host, "port": cons.port, "magic": cons.magic})
130
 
 
131
 
    return {"restart": reason, "key": new_key.encode("hex")}