← Back to branch summary

~azzar1/unity/add-show-desktop-key

« back to all changes in this revision

Viewing changes to lib/common/console.py

  • Committer: William Grant
  • Date: 2009-07-04 11:36:12 UTC
  • mto: (1294.4.2 ui-the-third)
  • mto: This revision was merged to the branch mainline in revision 1353.
  • Revision ID: grantw@unimelb.edu.au-20090704113612-x67yyuyjbzjv23yl
Implement default deep views.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/common/console.py
1
 
# IVLE
2
 
# Copyright (C) 2007-2008 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
 
# Module: Console
19
 
# Author: Matt Giuca, Tom Conway, David Coles (refactor)
20
 
# Date: 13/8/2008
21
 
 
22
 
# Mainly refactored out of consoleservice
23
 
 
24
 
import cPickle
25
 
import md5
26
 
import os
27
 
import random
28
 
import socket
29
 
import uuid
30
 
 
31
 
import cjson
32
 
 
33
 
import conf
34
 
from common import chat
35
 
 
36
 
trampoline_path = os.path.join(conf.ivle_install_dir, "bin/trampoline")
37
 
trampoline_path = os.path.join(conf.ivle_install_dir, "bin/trampoline")
38
 
python_path = "/usr/bin/python"                     # Within jail
39
 
console_dir = "/opt/ivle/scripts"                   # Within jail
40
 
console_path = "/opt/ivle/scripts/python-console"   # Within jail
41
 
 
42
 
class ConsoleError(Exception):
43
 
    """ The console failed in some way. This is bad. """
44
 
    def __init__(self, value):
45
 
        self.value = value
46
 
    def __str__(self):
47
 
        return repr(self.value)
48
 
 
49
 
class ConsoleException(Exception):
50
 
    """ The code being exectuted on the console returned an exception. 
51
 
    """
52
 
    def __init__(self, value):
53
 
        self.value = value
54
 
    def __str__(self):
55
 
        return repr(self.value)
56
 
 
57
 
class Console(object):
58
 
    """ Provides a nice python interface to the console
59
 
    """
60
 
    def __init__(self, uid, jail_path, working_dir):
61
 
        """Starts up a console service for user uid, inside chroot jail 
62
 
        jail_path with work directory of working_dir
63
 
        """
64
 
        self.uid = uid
65
 
        self.jail_path = jail_path
66
 
        self.working_dir = working_dir
67
 
        self.restart()
68
 
 
69
 
    def restart(self):
70
 
        # TODO: Check if we are already running a console. If we are shut it 
71
 
        # down first.
72
 
 
73
 
        # TODO: Figure out the host name the console server is running on.
74
 
        self.host = socket.gethostname()
75
 
 
76
 
        # Create magic
77
 
        # TODO
78
 
        self.magic = md5.new(uuid.uuid4().bytes).digest().encode('hex')
79
 
 
80
 
        # Try to find a free port on the server.
81
 
        # Just try some random ports in the range [3000,8000)
82
 
        # until we either succeed, or give up. If you think this
83
 
        # sounds risky, it isn't:
84
 
        # For N ports (e.g. 5000) with k (e.g. 100) in use, the
85
 
        # probability of failing to find a free port in t (e.g. 5) tries
86
 
        # is (k / N) ** t (e.g. 3.2*10e-9).
87
 
 
88
 
        tries = 0
89
 
        while tries < 5:
90
 
            self.port = int(random.uniform(3000, 8000))
91
 
 
92
 
            # Start the console server (port, magic)
93
 
            # trampoline usage: tramp uid jail_dir working_dir script_path args
94
 
            # console usage:    python-console port magic
95
 
            cmd = ' '.join([trampoline_path, str(self.uid), self.jail_path,
96
 
                            console_dir, python_path, console_path,
97
 
                            str(self.port), str(self.magic), 
98
 
                            self.working_dir])
99
 
 
100
 
            res = os.system(cmd)
101
 
 
102
 
            if res == 0:
103
 
                # success
104
 
                break;
105
 
 
106
 
            tries += 1
107
 
 
108
 
        # If we can't start the console after 5 attemps (can't find a free port 
109
 
        # during random probing, syntax errors, segfaults) throw an exception.
110
 
        if tries == 5:
111
 
            raise ConsoleError("Unable to start console service!")
112
 
 
113
 
    def __chat(self, cmd, args):
114
 
        """ A wrapper around chat.chat to comunicate directly with the 
115
 
        console.
116
 
        """
117
 
        try:
118
 
            response = chat.chat(self.host, self.port,
119
 
                {'cmd': cmd, 'text': args}, self.magic)
120
 
        except socket.error, (enumber, estring):
121
 
            if enumber == errno.ECONNREFUSED:
122
 
                # Timeout
123
 
                raise ConsoleError(
124
 
                    "The IVLE console has timed out due to inactivity")
125
 
            else:
126
 
                # Some other error - probably serious
127
 
                raise socket.error, (enumber, estring)
128
 
        except cjson.DecodeError:
129
 
            # Couldn't decode the JSON
130
 
            raise ConsoleError(
131
 
                "Communication to console process lost")
132
 
 
133
 
        # Look for user errors
134
 
        if 'exc' in response:
135
 
            raise ConsoleException(response['exc'])
136
 
        
137
 
        return response
138
 
 
139
 
    def chat(self, code=''):
140
 
        """ Executes a partial block of code """
141
 
        return self.__chat('chat', code)
142
 
 
143
 
    def block(self, code):
144
 
        """ Executes a block of code and returns the output """
145
 
        block = self.__chat('block', code)
146
 
        if 'output' in block:
147
 
            return block['output']
148
 
        elif 'okay' in block:
149
 
            return
150
 
        else:
151
 
            raise ConsoleException("Bad response from console: %s"%str(block))
152
 
 
153
 
    def flush(self, globs=None):
154
 
        """ Resets the consoles globals() to the default and optionally augment 
155
 
        them with a dictionary simple globals. (Must be able to be pickled)
156
 
        """
157
 
        # Pickle the globals
158
 
        pickled_globs = {}
159
 
        if globs is not None:
160
 
            for g in globs:
161
 
                pickled_globs[g] = cPickle.dumps(globs[g])
162
 
 
163
 
        flush = self.__chat('flush', pickled_globs)
164
 
        if 'response' in flush and flush['response'] == 'okay':
165
 
            return
166
 
        else:
167
 
            raise ConsoleError("Bad response from console: %s"%str(flush))
168
 
 
169
 
    def call(self, function, *args, **kwargs):
170
 
        """ Calls a function in the python console """
171
 
        call_args = {
172
 
            'function': function,
173
 
            'args': args,
174
 
            'kwargs': kwargs}
175
 
        response = self.__chat('call', call_args)
176
 
        if 'output' in response:
177
 
            return response['output']
178
 
        else:
179
 
            raise ConsoleError(
180
 
                "Bad response from console: %s"%str(response))
181
 
 
182
 
    def inspect(self, code=''):
183
 
        """ Runs a block of code in the python console returning a dictionary 
184
 
        summary of the evaluation. Currently this includes the values of 
185
 
        stdout, stderr, simple global varibles.
186
 
        If an exception was thrown then this dictionary also includes a 
187
 
        exception dictionary containg a traceback string and the exception 
188
 
        except.
189
 
        """
190
 
        inspection = self.__chat('inspect', code)
191
 
       
192
 
        # Unpickle the globals
193
 
        for g in inspection['globals']:
194
 
            inspection['globals'][g] = cPickle.loads(inspection['globals'][g])
195
 
        
196
 
        # Unpickle any exceptions
197
 
        if 'exception' in inspection:
198
 
            inspection['exception']['except'] = \
199
 
                cPickle.loads(inspection['exception']['except'])
200
 
 
201
 
        return inspection
202
 
    
203