/usr/lib/python3/dist-packages/ginga/gw/PluginManager.py is in python3-ginga 2.6.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 | #
# PluginManager.py -- Simple class to manage plugins.
#
# This is open-source software licensed under a BSD license.
# Please see the file LICENSE.txt for details.
#
import sys
import threading
import traceback
from ginga.gw import Widgets
from ginga.misc import Bunch, Callback
from ginga.util.six.moves import filter
class PluginManagerError(Exception):
pass
class PluginManager(Callback.Callbacks):
"""
A PluginManager manages the start and stop of plugins.
"""
def __init__(self, logger, fitsview, ds, mm):
super(PluginManager, self).__init__()
self.logger = logger
self.fv = fitsview
self.ds = ds
self.mm = mm
self.lock = threading.RLock()
self.plugin = Bunch.caselessDict()
self.active = {}
self.focus = set([])
self.exclusive = set([])
for name in ('activate-plugin', 'deactivate-plugin',
'focus-plugin', 'unfocus-plugin'):
self.enable_callback(name)
def loadPlugin(self, name, spec, chinfo=None):
try:
module = self.mm.getModule(spec.module)
className = spec.get('klass', spec.module)
klass = getattr(module, className)
if chinfo is None:
# global plug in
obj = klass(self.fv)
fitsimage = None
else:
# local plugin
fitsimage = chinfo.fitsimage
obj = klass(self.fv, fitsimage)
# Prepare configuration for module. This becomes the pInfo
# object referred to in later code.
opname = name.lower()
self.plugin[opname] = Bunch.Bunch(klass=klass, obj=obj,
widget=None, name=name,
is_toplevel=False,
spec=spec,
fitsimage=fitsimage,
chinfo=chinfo)
self.logger.info("Plugin '%s' loaded." % name)
except Exception as e:
self.logger.error("Failed to load plugin '%s': %s" % (
name, str(e)))
#raise PluginManagerError(e)
def reloadPlugin(self, plname, chinfo=None):
pInfo = self.getPluginInfo(plname)
return self.loadPlugin(pInfo.name, pInfo.spec, chinfo=chinfo)
def has_plugin(self, plname):
plname = plname.lower()
return plname in self.plugin
def getPluginInfo(self, plname):
plname = plname.lower()
pInfo = self.plugin[plname]
return pInfo
def getPlugin(self, name):
pInfo = self.getPluginInfo(name)
return pInfo.obj
def getNames(self):
return list(self.plugin.keys())
def deactivate_focused(self):
names = self.get_focus()
for name in names:
self.deactivate(name)
def get_active(self):
return list(self.active.keys())
def is_active(self, key):
lname = key.lower()
return lname in self.get_active()
def get_focus(self):
return list(self.focus)
def has_focus(self, name):
lname = name.lower()
names = self.get_focus()
return lname in names
def get_info(self, name):
lname = name.lower()
return self.active[lname]
def activate(self, pInfo, exclusive=True):
name = pInfo.tabname
lname = pInfo.name.lower()
if lname not in self.active:
bnch = Bunch.Bunch(pInfo=pInfo, lblname=None, widget=None,
exclusive=exclusive)
if pInfo.chinfo is not None:
# local plugin
tup = name.split(':')
bnch.lblname = ' ' + tup[0] + ':\n' + tup[1] + ' '
self.make_callback('activate-plugin', bnch)
else:
# global plugin
bnch.exclusive = False
self.active[lname] = bnch
if bnch.exclusive:
self.exclusive.add(lname)
def deactivate(self, name):
self.logger.debug("deactivating %s" % (name))
lname = name.lower()
if lname in self.focus:
self.clear_focus(lname)
if lname in self.active:
self.logger.debug("removing from task bar: %s" % (lname))
bnch = self.active[lname]
self.make_callback('deactivate-plugin', bnch)
del self.active[lname]
try:
self.stop_plugin(bnch.pInfo)
except Exception as e:
self.logger.error("Error deactivating plugin: %s" % (str(e)))
# TODO: log traceback
# Set focus to another plugin if one is running
active = list(self.active.keys())
if len(active) > 0:
name = active[0]
self.logger.debug("focusing: %s" % (name))
self.set_focus(name)
def set_focus(self, name):
self.logger.debug("Focusing plugin '%s'" % (name))
lname = name.lower()
bnch = self.active[lname]
if bnch.exclusive:
self.logger.debug("focus=%s exclusive=%s" % (
self.focus, self.exclusive))
defocus = list(filter(lambda x: x in self.exclusive, self.focus))
self.logger.debug("defocus: %s" % (str(defocus)))
for xname in defocus:
self.clear_focus(xname)
pInfo = bnch.pInfo
# If this is a local plugin, raise the channel associated with the
# plug in
if pInfo.chinfo is not None:
itab = pInfo.chinfo.name
self.logger.debug("raising channel tab %s" % (itab))
self.ds.raise_tab(itab)
self.logger.debug("resuming plugin %s" % (name))
pInfo.obj.resume()
self.make_callback('focus-plugin', bnch)
self.focus.add(lname)
if pInfo.widget is not None:
self.logger.debug("raising plugin tab %s" % (pInfo.tabname))
if pInfo.is_toplevel:
pInfo.widget.raise_()
else:
self.ds.raise_tab(pInfo.tabname)
def clear_focus(self, name):
self.logger.debug("Unfocusing plugin '%s'" % (name))
lname = name.lower()
bnch = self.active[lname]
pInfo = bnch.pInfo
try:
self.focus.remove(lname)
if pInfo.chinfo is not None:
bnch.pInfo.obj.pause()
self.make_callback('unfocus-plugin', bnch)
except:
pass
def start_plugin(self, chname, opname, alreadyOpenOk=False):
return self.start_plugin_future(chname, opname, None,
alreadyOpenOk=alreadyOpenOk)
def start_plugin_future(self, chname, opname, future,
alreadyOpenOk=True):
try:
pInfo = self.getPluginInfo(opname)
except KeyError:
self.fv.show_error("No plugin information for plugin '%s'" % (
opname))
return
if chname is not None:
# local plugin
plname = chname.upper() + ': ' + pInfo.name
else:
# global plugin
plname = pInfo.name
lname = pInfo.name.lower()
if lname in self.active:
if alreadyOpenOk:
self.set_focus(pInfo.name)
return
raise PluginManagerError("Plugin %s is already active." % (
plname))
# Raise tab with GUI
pInfo.tabname = pInfo.spec.get('tab', plname)
vbox = None
had_error = False
try:
if hasattr(pInfo.obj, 'build_gui'):
vbox = Widgets.VBox()
in_ws = pInfo.spec.ws
if in_ws.startswith('in:'):
# TODO: how to set this size appropriately
# Which plugins are actually using this attribute?
vbox.size = (400, 900)
else:
# attach size of workspace to container so plugin
# can plan for how to configure itself
wd, ht = self.ds.get_ws_size(in_ws)
vbox.size = (wd, ht)
if future:
pInfo.obj.build_gui(vbox, future=future)
else:
pInfo.obj.build_gui(vbox)
except Exception as e:
errstr = "Plugin UI failed to initialize: %s" % (
str(e))
self.logger.error(errstr)
try:
(type, value, tb) = sys.exc_info()
tb_str = "".join(traceback.format_tb(tb))
self.logger.error("Traceback:\n%s" % (tb_str))
except Exception as e:
tb_str = "Traceback information unavailable."
self.logger.error(tb_str)
self.plugin_build_error(vbox, errstr + '\n' + tb_str)
#raise PluginManagerError(e)
if not had_error:
try:
if future:
pInfo.obj.start(future=future)
else:
pInfo.obj.start()
except Exception as e:
had_error = True
errstr = "Plugin failed to start correctly: %s" % (
str(e))
self.logger.error(errstr)
try:
(type, value, tb) = sys.exc_info()
tb_str = "".join(traceback.format_tb(tb))
self.logger.error("Traceback:\n%s" % (tb_str))
except Exception as e:
tb_str = "Traceback information unavailable."
self.logger.error(tb_str)
self.plugin_build_error(vbox, errstr + '\n' + tb_str)
#raise PluginManagerError(e)
if vbox is not None:
self.finish_gui(pInfo, vbox)
self.activate(pInfo)
self.set_focus(pInfo.name)
else:
# If this is a local plugin, raise the channel associated with the
# plug in
if pInfo.chinfo is not None:
itab = pInfo.chinfo.name
self.ds.raise_tab(itab)
def stop_plugin(self, pInfo):
self.logger.debug("stopping plugin %s" % (str(pInfo)))
wasError = False
e = None
try:
pInfo.obj.stop()
except Exception as e:
wasError = True
self.logger.error("Plugin failed to stop correctly: %s" % (
str(e)))
try:
(type, value, tb) = sys.exc_info()
tb_str = "".join(traceback.format_tb(tb))
self.logger.error("Traceback:\n%s" % (tb_str))
except Exception:
self.logger.error("Traceback information unavailable.")
if pInfo.widget is not None:
self.dispose_gui(pInfo)
self.ds.remove_tab(pInfo.tabname)
if wasError:
raise PluginManagerError(e)
def plugin_build_error(self, box, text):
textw = Widgets.TextArea(editable=False, wrap=True)
textw.append_text(text)
box.add_widget(textw, stretch=1)
def finish_gui(self, pInfo, vbox):
# add container to workspace
# TODO: how to figure out the appropriate size for top-levels?
wd, ht = vbox.get_size()
try:
in_ws = pInfo.spec.ws
if in_ws == 'in:toplevel':
topw = vbox.get_app().make_window()
topw.add_callback('close',
lambda *args: self.deactivate(pInfo.name))
topw.resize(wd, ht)
topw.set_widget(vbox)
pInfo.widget = topw
pInfo.is_toplevel = True
topw.show()
elif in_ws == 'in:dialog':
dialog = Widgets.Dialog(title=pInfo.name,
flags=0,
buttons=[],
parent=self.fv.w.root)
dialog.resize(wd, ht)
box = dialog.get_content_area()
box.add_widget(vbox, stretch=1)
pInfo.widget = dialog
pInfo.is_toplevel = True
# TODO: need to add callback to remove from Desktop
# dialog list?
self.ds.show_dialog(dialog)
else:
self.ds.add_tab(in_ws, vbox, 2, pInfo.tabname, pInfo.tabname)
ws_w = self.ds.get_nb(in_ws)
ws_w.add_callback('page-switch', self.tab_switched_cb)
pInfo.widget = vbox
pInfo.is_toplevel = False
except Exception as e:
self.fv.show_error("Error finishing plugin UI for '%s': %s" % (
pInfo.name, str(e)))
def tab_switched_cb(self, tab_w, widget):
# A tab in a workspace in which we started a plugin has been
# raised. Check for this widget and focus the plugin
title = widget.extdata.get('tab_title', None)
if title is not None:
# is this a local plugin tab?
if ':' in title:
chname, plname = title.split(':')
plname = plname.strip()
try:
info = self.get_info(plname)
except KeyError:
# no
return
pInfo = info.pInfo
# important: make sure channel matches ours!
if pInfo.tabname == title:
if self.is_active(pInfo.name):
if not self.has_focus(pInfo.name):
self.set_focus(pInfo.name)
elif pInfo.chinfo is not None:
# raise the channel associated with the plugin
itab = pInfo.chinfo.name
self.ds.raise_tab(itab)
def dispose_gui(self, pInfo):
self.logger.debug("disposing of gui")
vbox = pInfo.widget
pInfo.widget = None
vbox.hide()
vbox.delete()
#END
|