← 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

Replaced Python config files (conf.py) with new config files system, using
    configobj (INI-file style config files).

setup.py config now produces ./etc/ivle.conf, a new-style config file.
ivle/conf/conf.py is now part of the IVLE source code. It reads the new config
file and provides the same legacy interface, so all of IVLE still functions,
including setup.py config.

Added /etc to the source tree (config files will be stored here).
Added configobj as a dependency in doc/setup/install_proc.txt.

setup.py install copies ./etc/ivle.conf into /etc/ivle/ivle.conf.

Removed boilerplate code generation from setup/configure.py (that code is now
part of ivle/conf/conf.py which is now in the source tree).

Show diffs side-by-side

added added

removed removed

Lines of Context:
ivle/webapp/console/service.py
31
31
 
32
32
import ivle.console
33
33
import ivle.chat
 
34
import ivle.conf
34
35
from ivle.webapp.base.rest import JSONRESTView, named_operation
35
36
from ivle.webapp.errors import BadRequest
36
37
 
37
38
# XXX: Should be RPC view, with actions in URL?
38
39
class ConsoleServiceRESTView(JSONRESTView):
39
40
    '''An RPC interface to a Python console.'''
40
 
    def get_permissions(self, user):
41
 
        if user is not None:
42
 
            return set(['use'])
43
 
        else:
44
 
            return set()
45
 
 
46
 
    @named_operation('use')
 
41
    @named_operation
47
42
    def start(self, req, cwd=''):
48
43
        working_dir = os.path.join("/home", req.user.login, cwd)
49
44
 
50
45
        uid = req.user.unixid
51
46
 
52
47
        # 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)
 
48
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
49
        cons = ivle.console.Console(uid, jail_path, working_dir)
56
50
 
57
51
        # Assemble the key and return it. Yes, it is double-encoded.
58
52
        return {'key': cjson.encode({"host": cons.host,
59
53
                                     "port": cons.port,
60
54
                                     "magic": cons.magic}).encode('hex')}
61
55
 
62
 
    @named_operation('use')
63
 
    def chat(self, req, key, text='', cwd='', kind="chat"):
 
56
    @named_operation
 
57
    def chat(self, req, key, text='', kind="chat"):
64
58
        # The request *should* have the following four fields:
65
59
        # key: Hex JSON dict of host and port where the console server lives,
66
60
        # and the secret to use to digitally sign the communication with the
76
70
        except KeyError:
77
71
            raise BadRequest("Invalid console key.")
78
72
 
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)
 
73
        jail_path = os.path.join(ivle.conf.jail_base, req.user.login)
 
74
        working_dir = os.path.join("/home", req.user.login)   # Within jail
83
75
        uid = req.user.unixid
84
76
 
85
 
        # XXX: JSONRESTView should do this for us.
86
 
        text = text.decode('utf-8')
87
 
 
88
77
        msg = {'cmd':kind, 'text':text}
89
78
        try:
90
79
            json_response = ivle.chat.chat(host, port, msg, magic,decode=False)
97
86
                response = {"terminate":
98
87
                    "Communication to console process lost"}
99
88
            if "terminate" in response:
100
 
                response = restart_console(req.config, uid, jail_path,
101
 
                    working_dir, response["terminate"])
 
89
                response = restart_console(uid, jail_path, working_dir,
 
90
                    response["terminate"])
102
91
        except socket.error, (enumber, estring):
103
92
            if enumber == errno.ECONNREFUSED:
104
93
                # Timeout: Restart the session
105
 
                response = restart_console(req.config, uid, jail_path,
106
 
                    working_dir,
 
94
                response = restart_console(uid, jail_path, working_dir,
107
95
                    "The IVLE console has timed out due to inactivity")
108
96
            elif enumber == errno.ECONNRESET:
109
97
                # Communication issue: Restart the session
110
 
                response = restart_console(req.config, uid, jail_path,
111
 
                    working_dir,
 
98
                response = restart_console(uid, jail_path, working_dir,
112
99
                    "Connection with the console has been reset")
113
100
            else:
114
101
                # Some other error - probably serious
116
103
        return response
117
104
 
118
105
 
119
 
def restart_console(config, uid, jail_path, working_dir, reason):
 
106
def restart_console(uid, jail_path, working_dir, reason):
120
107
    """Tells the client that it must be issued a new console since the old 
121
108
    console is no longer availible. The client must accept the new key.
122
109
    Returns the JSON response to be given to the client.
123
110
    """
124
111
    # Start a new console server console
125
 
    cons = ivle.console.Console(config, uid, jail_path, working_dir)
 
112
    cons = ivle.console.Console(uid, jail_path, working_dir)
126
113
 
127
114
    # Make a JSON object to tell the browser to restart its console client
128
115
    new_key = cjson.encode(