iwla/iplugin.py
2014-12-03 11:29:05 +01:00

100 lines
3.1 KiB
Python

import importlib
import inspect
import traceback
class IPlugin(object):
def __init__(self, iwla):
self.iwla = iwla
self.requires = []
self.conf_requires = []
self.API_VERSION = 1
self.ANALYSIS_CLASS = 'HTTP'
def isValid(self, analysis_class, api_version):
if analysis_class != self.ANALYSIS_CLASS: return False
# For now there is only version 1
if self.API_VERSION != api_version:
return False
return True
def getRequirements(self):
return self.requires
def getConfRequirements(self):
return self.conf_requires
def load(self):
return True
def hook(self):
pass
def validConfRequirements(conf_requirements, iwla, plugin_path):
for r in conf_requirements:
if iwla.getConfValue(r, None) is None:
print '\'%s\' conf value required for %s' % (r, plugin_path)
return False
return True
def preloadPlugins(plugins, iwla):
cache_plugins = {}
print "==> Preload plugins"
for (root, plugins_filenames) in plugins:
for plugin_filename in plugins_filenames:
plugin_path = root + '.' + plugin_filename
try:
mod = importlib.import_module(plugin_path)
classes = [c for _,c in inspect.getmembers(mod)\
if inspect.isclass(c) and \
issubclass(c, IPlugin) and \
c.__name__ != 'IPlugin'
]
if not classes:
print 'No plugin defined in %s' % (plugin_path)
continue
plugin = classes[0](iwla)
plugin_name = plugin.__class__.__name__
if not plugin.isValid(iwla.ANALYSIS_CLASS, iwla.API_VERSION):
#print 'Plugin not valid %s' % (plugin_filename)
continue
#print 'Load plugin %s' % (plugin_name)
conf_requirements = plugin.getConfRequirements()
if not validConfRequirements(conf_requirements, iwla, plugin_path):
continue
requirements = plugin.getRequirements()
requirement_validated = False
for r in requirements:
for (_,p) in cache_plugins.items():
if p.__class__.__name__ == r:
requirement_validated = True
break
if not requirement_validated:
print 'Missing requirements \'%s\' for plugin %s' % (r, plugin_path)
break
if requirements and not requirement_validated: continue
if not plugin.load():
print 'Plugin %s load failed' % (plugin_path)
continue
print '\tRegister %s' % (plugin_path)
cache_plugins[plugin_path] = plugin
except Exception as e:
print 'Error loading %s => %s' % (plugin_path, e)
traceback.print_exc()
return cache_plugins