Page MenuHomePhorge
Files F117878887

__init__.py
No OneTemporary
Actions

Authored By
Unknown
Size
9 KB
Referenced Files
None
Subscribers
None

__init__.py
View Options

# -*- coding: utf-8 -*-
# Copyright 2010-2012 Kolab Systems AG (http://www.kolabsys.com)
#
# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 3 or, at your option, any later version
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Library General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
import logging
import os
import pdb
import sys
import traceback
import pykolab
from pykolab.translate import _
log = pykolab.getLogger('pykolab.plugins')
conf = pykolab.getConf()
class KolabPlugins(object):
"""
Detects, loads and interfaces with plugins for different
Kolab components.
"""
def __init__(self):
"""
Searches the plugin directory for plugins, and loads
them into a list.
"""
self.plugins = {}
for plugin_path in [
os.path.dirname(__file__),
'/usr/share/pykolab/plugins',
'./pykolab/plugins'
]:
if os.path.isdir(plugin_path):
for plugin in os.listdir(plugin_path):
if os.path.isdir('%s/%s/' % (plugin_path,plugin,)):
self.plugins[plugin] = False
self.check_plugins()
def check_plugins(self):
"""
Checks all plugins in self.plugins and sets the values to
True (loadable) or False -- not enabled, not installed or
not loadable.
"""
for plugin in self.plugins:
try:
exec("from pykolab.plugins import %s" % (plugin))
self.plugins[plugin] = True
self.load_plugins(plugins=[plugin])
except ImportError, e:
log.error(_("ImportError for plugin %s: %s") % (plugin,e))
traceback.print_exc()
self.plugins[plugin] = False
except RuntimeError, e:
log.error( _("RuntimeError for plugin %s: %s") % (plugin,e))
traceback.print_exc()
self.plugins[plugin] = False
except Exception, e:
log.error(_("Plugin %s failed to load (%s: %s)") % (plugin, e.__class__, e))
traceback.print_exc()
except:
traceback.print_exc()
def load_plugins(self, plugins=[]):
"""
Loads plugins specified by a list of plugins or loads them all
"""
if len(plugins) < 1:
plugins = self.plugins.keys()
for plugin in plugins:
if self.plugins[plugin]:
try:
exec("self.%s = %s.Kolab%s()" % (plugin,plugin,plugin.capitalize()))
except:
# TODO: A little better verbosity please!
traceback.print_exc()
def set_defaults(self, defaults, plugins=[]):
"""
Test for a function set_defaults() in all available and loaded plugins and execute plugin.set_defaults()
"""
if len(plugins) < 1:
plugins = self.plugins.keys()
for plugin in plugins:
if not self.plugins[plugin]:
continue
if not hasattr(self,plugin):
continue
if hasattr(getattr(self,plugin),"set_defaults"):
try:
getattr(self,plugin).set_defaults(defaults)
except TypeError, e:
log.error(_("Cannot set defaults for plugin %s: %s") % (plugin,e))
except RuntimeError, e:
log.error(_("Cannot set defaults for plugin %s: %s") % (plugin,e))
except:
log.error(_("Cannot set defaults for plugin %s: Unknown Error") % (plugin))
else:
log.debug(_("Not setting defaults for plugin %s: No function 'set_defaults()'") % plugin, level=5)
def set_runtime(self, runtime, plugins=[]):
"""
Set runtime variables from plugins, like 'i_did_all_this'
"""
if len(plugins) < 1:
plugins = self.plugins.keys()
for plugin in plugins:
if not self.plugins[plugin]:
continue
if not hasattr(self,plugin):
continue
if hasattr(getattr(self,plugin),"set_runtime"):
try:
getattr(self,plugin).set_runtime(runtime)
except RuntimeError, e:
log.error(_("Cannot set runtime for plugin %s: %s") % (plugin,e))
else:
log.debug(_("Not setting runtime for plugin %s: No function 'set_runtime()'") % (plugin), level=5)
def add_options(self, parser, plugins=[]):
"""
Add options specified in a plugin to parser. Takes a list of plugin names or does them all
"""
if len(plugins) < 1:
plugins = self.plugins.keys()
for plugin in plugins:
if not self.plugins[plugin]:
continue
if not hasattr(self,plugin):
continue
if hasattr(getattr(self,plugin),"add_options"):
try:
exec("self.%s.add_options(parser)" % plugin)
except RuntimeError, e:
log.error(_("Cannot add options for plugin %s: %s") % (plugin,e))
except TypeError, e:
log.error(_("Cannot add options for plugin %s: %s") % (plugin,e))
else:
log.debug(_("Not adding options for plugin %s: No function 'add_options()'") % plugin, level=5)
def check_options(self, plugins=[]):
"""
Executes plugin.check_plugins() for all enabled plugins or the list of plugin names specified.
"""
if len(plugins) < 1:
plugins = self.plugins.keys()
for plugin in plugins:
if not self.plugins[plugin]:
continue
if not hasattr(self,plugin):
continue
if hasattr(getattr(self,plugin),"check_options"):
try:
exec("self.%s.check_options()" % plugin)
except AttributeError, e:
log.error(_("Cannot check options for plugin %s: %s") % (plugin,e))
else:
log.debug(_("Not checking options for plugin %s: No function 'check_options()'") % (plugin), level=5)
def plugin_check_setting(self, func, option, val, plugins=[]):
"""
Checks one setting specified by 'option' against the 'val' it is passed by all plugins or by the list of plugins specified
"""
if len(plugins) < 1:
plugins = self.plugins.keys()
for plugin in plugins:
if not self.plugins[plugin]:
continue
if not hasattr(self,plugin):
continue
if hasattr(getattr(self,plugin),"%s_%s" % (func,option)):
exec("retval = getattr(self,plugin).%s_%s(val)" % (func,option))
return retval
return False
def exec_hook(self, hook, plugins=[], kw={}, args=()):
"""Execute a hook"""
retval = None
if len(plugins) < 1:
plugins = self.plugins.keys()
for plugin in plugins:
if not self.plugins[plugin]:
continue
if not hasattr(self,plugin):
continue
if hasattr(getattr(self,plugin),hook):
try:
log.debug(_("Executing hook %s for plugin %s") % (hook,plugin), level=8)
#print "retval = self.%s.%s(%r, %r)" % (plugin,hook, args, kw)
exec("retval = self.%s.%s(*args, **kw)" % (plugin,hook))
except TypeError, e:
log.error(_("Cannot execute hook %s for plugin %s: %s") % (hook,plugin,e))
except AttributeError, e:
log.error(_("Cannot execute hook %s for plugin %s: %s") % (hook,plugin,e))
return retval
def return_true_boolean_from_plugins(self, bool, plugins=[]):
"""Given the name of a boolean, walks all specified plugins, or all available plugins, and returns True if a plugin has it set to true"""
if len(plugins) < 1:
plugins = self.plugins.keys()
retval = False
for plugin in plugins:
if not self.plugins[plugin]:
continue
if not hasattr(self,plugin):
continue
if hasattr(getattr(self,plugin),bool):
try:
exec("boolval = self.%s.%s" % (plugin,bool))
except AttributeError, e:
pass
else:
boolval = None
if boolval: retval = True
return retval

File Metadata

Mime Type
text/x-script.python
Expires
Sun, Apr 5, 10:37 PM (2 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a2/75/bc7f77a02e244429ae04b2555074
Default Alt Text
__init__.py (9 KB)

Event Timeline