/usr/share/pyshared/Editra/src/plugin.py is in editra 0.6.58-1.
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 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 | ###############################################################################
# Name: plugin.py #
# Purpose: Plugin system architecture #
# Author: Cody Precord <cprecord@editra.org> #
# Copyright: (c) 2007 Cody Precord <staff@editra.org> #
# Licence: wxWindows Licence #
###############################################################################
#
# Some of the code in this document was derived from trac's plugin architecture
#
# Copyright (C) 2003-2006 Edgewall Software
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
# 3. The name of the author may not be used to endorse or promote
# products derived from this software without specific prior
# written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
# GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
This module provides the core functionality of the plugin system for Editra.
Its design is influenced by the system used in the web based project management
software Trac (trac.edgewall.org). To create a plugin plugin class must derive
from Plugin and in the class definintion it must state which Interface it
Implements. Interfaces are defined throughout various locations in the core
Editra code. The interface defines the contract that the plugin needs to
conform to.
Plugins consist of python egg files that can be created with the use of the
setuptools package.
There are some issues I dont like with how this is currently working that I
hope to find a work around for in later revisions. Namely I dont like the fact
that the plugins are loaded and kept in memory even when they are not activated.
Although the footprint of the non activated plugin class members being held in
memory is not likely to be very large.
@summary: Plugin interface and mananger implementation
"""
__author__ = "Cody Precord <cprecord@editra.org>"
__svnid__ = "$Id: plugin.py 61940 2009-09-16 01:04:03Z CJP $"
__revision__ = "$Revision: 61940 $"
#--------------------------------------------------------------------------#
# Dependancies
import os
import sys
import shutil
import wx
# Editra Libraries
import ed_glob
from ed_txt import EncodeString
import util
from profiler import CalcVersionValue, Profile_Get, Profile_Set
# Try to use the system version of pkg_resources if available else fall
# back to the bundled version. Mostly for binary versions of Editra.
try:
import pkg_resources
except ImportError:
try:
from extern import pkg_resources
except ImportError:
pkg_resources = None
#--------------------------------------------------------------------------#
# Globals
ENTRYPOINT = 'Editra.plugins'
PLUGIN_CONFIG = "plugin.cfg"
_implements = []
_ = wx.GetTranslation
#--------------------------------------------------------------------------#
class Interface(object):
"""Base class for defining interfaces. Interface classes are
used to define the method/contract from which the plugin must
conform to.
"""
pass
#-----------------------------------------------------------------------------#
class ExtensionPoint(property):
"""Declares what L{Interface} a plugin is extending"""
def __init__(self, interface):
"""Initializes the extension point
@param interface: interface object that the extension point extends
"""
property.__init__(self, self.Extensions)
self.interface = interface
def __repr__(self):
"""@return: string representation of the object"""
return '<ExtensionPoint %s>' % self.interface.__name__
def Extensions(self, component):
"""The exensions that extend this extention point
@param component: The component to get the exensions for
@return: a list of plugins that declare to impliment the
given extension point.
"""
component = wx.GetApp().GetPluginManager()
extensions = PluginMeta._registry.get(self.interface, [])
return filter(None, [component[cls] for cls in extensions])
#-----------------------------------------------------------------------------#
class PluginMeta(type):
"""Acts as the registration point for plugin entrypoint objects.
It makes sure that only a single instance of any particular entry
point is active at one time per plugin manager.
"""
_plugins = list()
_registry = dict()
def __new__(mcs, name, bases, d):
"""Initialize the MetaClass
@param mcs: Class instance
@param name: Name of object
@param bases: Plugin base classes
@param d: Items dictionary
"""
d['_implements'] = _implements[:]
del _implements[:]
new_obj = type.__new__(mcs, name, bases, d)
if name == 'Plugin':
return new_obj
init = d.get("__init__")
if not init:
for init in [b.__init__._original for b in new_obj.mro()
if issubclass(b, Plugin) and '__init__' in b.__dict__]:
break
PluginMeta._plugins.append(new_obj)
for interface in d.get('_implements', []):
PluginMeta._registry.setdefault(interface, []).append(new_obj)
for base in [base for base in bases if hasattr(base, '_implements')]:
for interface in base._implements:
PluginMeta._registry.setdefault(interface, []).append(new_obj)
return new_obj
#-----------------------------------------------------------------------------#
class Plugin(object):
"""Base class for all plugin type objects"""
__metaclass__ = PluginMeta
__name__ = 'EdPlugin'
def __new__(cls, pluginmgr):
"""Only one instance of each plugin is allowed to exist
per manager. If an instance of this plugin has already be
initialized, that instance will be returned. If not this will
initialize a new instance of the plugin.
@keyword mgr: Plugin Manager instance
@return: a new class object or an existing instance if one
exists.
"""
# Case for a pluginmanager being managed by a plugin manager
if issubclass(cls, PluginManager):
self = super(Plugin, cls).__new__(cls)
self.pluginmgr = self
return self
plugins = pluginmgr.GetPlugins()
self = plugins.get(cls)
# Check if it is a default plugin
if self is None:
defaults = pluginmgr.GetDefaultPlugins()
self = defaults.get(cls)
if self is None:
self = super(Plugin, cls).__new__(cls)
self.pluginmgr = pluginmgr
return self
def GetMinVersion(self):
"""Override in subclasses to return the minimum version of Editra that
the plugin is compatible with. By default it will return the current
version of Editra.
@return: version str
"""
return ed_glob.VERSION
def InstallHook(self):
"""Override in subclasses to allow the plugin to be loaded
dynamically.
@return: None
"""
pass
def IsInstalled(self):
"""Return whether the plugins L{InstallHook} method has been called
or not already.
@return: bool
"""
return False
#-----------------------------------------------------------------------------#
class PluginConfigObject(object):
"""Plugin configuration object. Plugins that wish to provide a
configuration panel should implement a subclass of this object
in their __init__ module. The __init__ module must also have a
function 'GetConfigObject' that returns an instance of this
class.
"""
def GetConfigPanel(self, parent):
"""Get the configuration panel for this plugin
@param parent: parent window for the panel
@return: wxPanel
"""
raise NotImplementedError
def GetBitmap(self):
"""Get the 32x32 bitmap to show in the config dialog
@return: wx.Bitmap
@note: Optional if not implemented default icon will be used
"""
return wx.NullBitmap
def GetLabel(self):
"""Get the display label for the configuration
@return: string
"""
raise NotImplementedError
#-----------------------------------------------------------------------------#
class PluginData(object):
"""A storage class for representing data about a Plugin
@see: L{Plugin}
"""
def __init__(self, name=u'', descript=u'', author=u'', ver=u''):
"""Create the plugin data object
@keyword name: Name of the plugin
@keyword descript: Short description of plugin
@keyword author: Who made the plugin
@keyword ver: Version of the plugin
@type ver: string
"""
object.__init__(self)
# Attributes
self._name = name
self._description = descript
self._author = author
self._version = ver
self._enabled = False
self._installed = True
self._inst = None
self._cls = None
self._distro = None
@property
def Distribution(self):
"""Distrobution object"""
return self.GetDist()
@property
def Class(self):
"""Class Reference"""
return self.GetClass()
def Enable(self, enable=True):
"""Enable the plugin
@param enable: bool
"""
self._enabled = enabled
def GetAuthor(self):
"""@return: Author of the plugin"""
return self._author
def GetClass(self):
"""@return class object of the plugin"""
return self._cls
def GetDescription(self):
"""@return: Plugins description string"""
return self._description
def GetDist(self):
"""Return the dist object associated with this plugin
@return: Distribution
"""
return self._distro
def GetInstance(self):
"""Get the plugin instance
@return: Plugin
"""
return self._inst
def GetName(self):
"""@return: Plugin's name string"""
return self._name
def GetVersion(self):
"""@return: Plugin's version string"""
return self._version
@property
def Instance(self):
"""Plugin Instance"""
return self.GetInstance()
def IsEnabled(self):
"""Is the plugin enabled
@return: bool
"""
return self._enabled
@property
def Module(self):
"""Plugin Module Reference"""
return getattr(self.GetInstance(), '__module__', None)
def SetAuthor(self, author):
"""Sets the author attribute
@param author: New Authors name string
@postcondition: Author attribute is set to new value
"""
if not isinstance(author, basestring):
try:
author = str(author)
except (ValueError, TypeError):
author = u''
self._author = author
def SetClass(self, cls):
"""Set the class used to create this plugins instance
@param cls: class
"""
self._cls = cls
def SetDescription(self, descript):
"""@return: Plugins description string"""
if not isinstance(descript, basestring):
try:
descript = str(descript)
except (ValueError, TypeError):
descript = u''
self._description = descript
def SetDist(self, distro):
"""Set the distribution object
@param dist: Distribution
"""
self._distro = distro
def SetInstance(self, inst):
"""Set the plugin instance
@param inst: Plugin instance
"""
self._inst = inst
def SetName(self, name):
"""Sets the plugins name string
@param name: String to name plugin with
@postcondition: Plugins name string is set
"""
if not isinstance(name, basestring):
try:
name = str(name)
except (ValueError, TypeError):
name = u''
self._name = name
def SetVersion(self, ver):
"""Sets the version attribute of the plugin.
@param ver: Version string
@postcondition: Plugins version attribute is set to new value
"""
if not isinstance(ver, basestring):
try:
ver = str(ver)
except (ValueError, TypeError):
ver = u''
self._version = ver
#-----------------------------------------------------------------------------#
def Implements(*interfaces):
"""Used by L{Plugin}s to declare the interface that they
implment/extend.
@param interfaces: list of interfaces the plugin implements
"""
_implements.extend(interfaces)
#--------------------------------------------------------------------------#
class PluginManager(object):
"""The PluginManger keeps track of the active plugins. It
also provides an interface into loading and unloading plugins.
@status: Allows for dynamic loading of plugins but most can not
be called/used until the editor has been restarted.
@todo: Allow loaded but inactive plugins to be initiated without
needing to restart the editor.
"""
def __init__(self):
"""Initializes a PluginManager object.
@postcondition: Plugin manager and plugins are initialized
"""
object.__init__(self)
self.LOG = wx.GetApp().GetLog()
self.RemoveUninstalled()
self._config = self.LoadPluginConfig() # Enabled/Disabled Plugins
self._pi_path = list(set([ed_glob.CONFIG['PLUGIN_DIR'],
ed_glob.CONFIG['SYS_PLUGIN_DIR']]))
sys.path.extend(self._pi_path)
self._env = self.CreateEnvironment(self._pi_path)
# TODO: Combine enabled into pdata
self._pdata = dict() # Plugin data
self._defaults = dict() # Default plugins
self._enabled = dict() # Set of enabled plugins
self._loaded = list() # List of
self._obsolete = dict() # Obsolete plugins list
self.InitPlugins(self._env)
self.RefreshConfig()
# Enable/Disable plugins based on config data
self.UpdateConfig()
def __contains__(self, cobj):
"""Returns True if a plugin is currently loaded and being
managed by this manager.
@param cobj: object to look for in loaded plugins
"""
return cobj in [obj.GetClass() for obj in self._pdata]
def __getitem__(self, cls):
"""Gets and returns the instance of given class if it has
already been activated.
@param cls: class object to get from metaregistery
@return: returns either None or the intialiazed class object
"""
nspace = cls.__module__ + "." + cls.__name__
if nspace in ed_glob.DEFAULT_PLUGINS:
self._enabled[cls] = True
if cls not in self._enabled:
self._enabled[cls] = False # If its a new plugin disable by default
if not self._enabled[cls]:
return None
# plugin = self._plugins.get(cls)
plugin = None
pdata = self._pdata.get(cls, None)
if pdata is not None:
plugin = pdata.GetInstance()
else:
# Check defaults
plugin = self._defaults.get(cls, None)
# Plugin not instantiated yet
if plugin is None:
if cls not in PluginMeta._plugins:
self.LOG("[pluginmgr][err] %s Not Registered" % cls.__name__)
try:
plugin = cls(self)
except (AttributeError, TypeError), msg:
self.LOG("[pluginmgr][err] Unable in initialize plugin")
self.LOG("[pluginmgr][err] %s" % str(msg))
return plugin
#---- End Private Members ----#
#---- Public Class Functions ----#
def AppendPath(self, path):
"""Append a path to the environment path for the plugin manager
to look for plugins on. The path is only added to the environment
in order for it to be used you must call RefreshEnvironment afterwards
to re-initialize the running environment.
@param path: path to append to environment
@return: True if path was successfully added or False otherwise
"""
if os.path.exists(path):
if path not in self._pi_path:
self._pi_path.append(path)
return True
else:
return False
def CallPluginOnce(self, plugin):
"""Makes a call to initialize a given plugin
@status: currently not implemented
"""
pass
def CreateEnvironment(self, path):
"""Creates the environment based on the passed
in path list
@param path: path(s) to scan for extension points
@type path: list of path strings
@note: pkgutils does not like Unicode! only send encoded strings
"""
if pkg_resources != None:
path = [ EncodeString(pname, sys.getfilesystemencoding())
for pname in path ]
try:
env = pkg_resources.Environment(path)
except UnicodeDecodeError, msg:
self.LOG("[pluginmgr][err] %s" % msg)
else:
self.LOG("[pluginmgr][warn] setuptools is not installed")
env = dict()
return env
def DisablePlugin(self, plugin):
"""Disables a named plugin. Is a convenience function for
EnablePlugin(plugin, False).
@param plugin: plugin to disable
@precondition: plugin must be managed by this manager instance
@postcondition: plugin is disabled and will not be activated on
next reload.
"""
self.EnablePlugin(plugin, False)
def EnablePlugin(self, plugin, enable=True):
"""Enables a named plugin.
@param plugin: plugin to enable/disable (case insensitive)
@param enable: should plugin be enabled or disabled
@precondition: plugin must be managed by this manager instance
@postcondition: plugin is added to activate list for activation on
next program start.
"""
for name in self._config:
if name.lower() == plugin.lower():
plugin = name
break
self._config[plugin] = enable
for cls in self._enabled:
if cls.__module__ == plugin:
self._enabled[cls] = enable
def GetConfig(self):
"""Returns a dictionary of plugins and there configuration
state.
@return: the mapped set of available plugins
@rtype: dict
"""
self.RefreshConfig()
return self._config
def GetDefaultPlugins(self):
"""Get the loaded default plugins
@return: dict(cls=instance)
"""
return self._defaults
def GetEnvironment(self):
"""Returns the evironment that the plugin manager is currently
running with.
@return: the managers environment
"""
return self._env
def GetIncompatible(self):
"""Get the list of loaded plugins that are incompatible with the
current running version of Editra.
return: dict(name=module)
"""
return self._obsolete
def GetPlugins(self):
"""Returns a the dictionary of plugins managed by this manager
@return: all plugins managed by this manger
@rtype: dict
"""
plugins = dict()
for pdata in self._pdata.values():
plugins[pdata.GetClass()] = pdata.GetInstance()
return plugins
def GetPluginDistro(self, pname):
"""Get the distrobution object for a given plugin name
@param pname: plugin name
@return: Distrobution
"""
for pdata in self._pdata.values():
if pname.lower() == pdata.GetName().lower():
return pdata.GetDist()
else:
return None
def GetPluginDistros(self):
"""Get the plugin distrobution objects
@return: dict(name=Distrobution)
"""
distros = dict()
for name, pdata in self._pdata:
distros[name] = pdata.GetDist()
return distros
def InitPlugins(self, env):
"""Initializes the plugins that are contained in the given
environment. After calling this the list of available plugins
can be obtained by calling GetPlugins.
@note: plugins must emit the ENTRY_POINT defined in this file in order
to be recognized and initialized.
@postcondition: all plugins in the environment are initialized
"""
if pkg_resources == None:
return
pkg_env = env
tmploaded = [ name.lower() for name in self._loaded ]
for name in pkg_env:
self.LOG("[pluginmgr][info] Found plugin: %s" % name)
if name.lower() in tmploaded:
self.LOG("[pluginmgr][info] %s is already loaded" % name)
continue
egg = pkg_env[name][0] # egg is of type Distrobution
egg.activate()
editra_version = CalcVersionValue(ed_glob.VERSION)
for name in egg.get_entry_map(ENTRYPOINT):
try:
# Only load a given entrypoint once
if name not in self._loaded:
entry_point = egg.get_entry_info(ENTRYPOINT, name)
cls = entry_point.load()
self._loaded.append(name)
else:
self.LOG("[pluginmgr][info] Skip reloading: %s" % name)
continue
except Exception, msg:
self.LOG("[pluginmgr][err] Couldn't Load %s: %s" % (name, msg))
else:
try:
# Only initialize plugins that haven't already been
# initialized
if cls not in self._pdata:
self.LOG("[pluginmgr][info] Creating Instance of %s" % name)
instance = cls(self)
minv = CalcVersionValue(instance.GetMinVersion())
if minv <= editra_version:
mod = instance.__module__
desc = getattr(mod, '__doc__', _("No Description Available"))
auth = getattr(mod, '__author__', _("Unknown"))
pdata = PluginData(egg.project_name,
desc.strip(),
auth.strip(),
egg.version)
pdata.SetDist(egg)
pdata.SetInstance(instance)
pdata.SetClass(cls)
self._pdata[cls] = pdata
self.LOG("[pluginmgr][info] Cached Plugin: %s" % egg.project_name)
else:
# Save plugins that are not compatible with
# this version to use for notifications.
self._obsolete[name] = cls.__module__
else:
self.LOG("[pluginmgr][info] Skip re-init of %s" % cls)
finally:
pass
# Activate all default plugins
for d_pi in ed_glob.DEFAULT_PLUGINS:
obj = d_pi.split(".")
mod = ".".join(obj[:-1])
entry = __import__(mod, globals(), globals(), ['__name__'])
if hasattr(entry, obj[-1]) and entry not in self._defaults:
entry = getattr(entry, obj[-1])
self._defaults[entry] = entry(self)
return True
def LoadPluginByName(self, name):
"""Loads a named plugin.
@status: currently not implemented
"""
raise NotImplementedError
def LoadPluginConfig(self):
"""Loads the plugin config file for the current user if
it exists. The configuration file contains which plugins
are active and which ones are not.
@return: configuration dictionary
"""
config = dict()
reader = util.GetFileReader(os.path.join(ed_glob.CONFIG['CONFIG_DIR'],
PLUGIN_CONFIG))
if reader == -1:
self.LOG("[pluginmgr][err] Failed to read plugin config file")
return config
reading = True
for line in reader.readlines():
data = line.strip()
if len(data) and data[0] == u"#":
continue
data = data.split(u"=")
if len(data) == 2:
config[data[0].strip()] = data[1].strip().lower() == u"true"
else:
continue
reader.close()
return config
def RefreshConfig(self):
"""Refreshes the config data comparing the loadable
plugins against the config data and removing any entries
that dont exist in both from the configuration data.
@postcondition: entries that could not be loaded or do not
exist any longer are removed from the config
"""
plugins = [ plugin.GetInstance().__module__
for plugin in self._pdata.values() ]
config = dict()
for item in self._config:
if item in plugins:
config[item] = self._config[item]
self._config = config
def RefreshEnvironment(self):
"""Refreshes the current environment to include any
plugins that may have been added since init.
@postcondition: environment is refreshed
"""
self._env = self.CreateEnvironment(self._pi_path)
def ReInit(self):
"""Reinitializes the plugin environment and all plugins
in the environment as well as the configuration data.
@postcondition: the manager is reinitialized to reflect
any configuration or environment changes
that may have occured.
"""
self.RefreshEnvironment()
self.InitPlugins(self.GetEnvironment())
self.RefreshConfig()
self.UpdateConfig()
def RemoveUninstalled(self):
"""Remove all uninstalled plugins
@todo: need error reporting and handling file permissions
@todo: handle multiple older versions that are installed
@todo: handle when installed in multiple locations
"""
plist = Profile_Get('UNINSTALL_PLUGINS', default=list())
for path in list(plist):
try:
if os.path.isdir(path):
shutil.rmtree(path)
else:
os.remove(path)
except OSError:
# TODO: don't delete from list, so it can be kept to report
# removal errors to user.
if not os.path.exists(path):
plist.remove(path)
continue
else:
self.LOG("[pluginmgr][info] Uninstalled: %s" % path)
plist.remove(path)
Profile_Set('UNINSTALL_PLUGINS', plist)
def UnloadPluginByName(self, name):
"""Unloads a named plugin.
@status: currently not implemented
"""
raise NotImplementedError
def UpdateConfig(self):
"""Updates the in memory config data to recognize
any plugins that may have been added or initialzed
by a call to InitPlugins.
@postcondition: plugins are enabled or disabled based
on the configuration data.
"""
for pdata in self._pdata.values():
plugin = pdata.GetClass()
if self._config.get(plugin.__module__):
self._enabled[plugin] = True
else:
self._config[plugin.__module__] = False
self._enabled[plugin] = False
def WritePluginConfig(self):
"""Writes out the plugin config.
@postcondition: the configuration data is saved to disk
"""
writer = util.GetFileWriter(os.path.join(ed_glob.CONFIG['CONFIG_DIR'],
PLUGIN_CONFIG))
if writer == -1:
self.LOG("[pluginmgr][err] Failed to write plugin config")
return
writer.write("# Editra %s Plugin Config\n#\n" % ed_glob.VERSION)
for item in self._config:
writer.write("%s=%s\n" % (item, str(self._config[item])))
writer.write("\n# EOF\n")
writer.close()
return
|