def __init__(self):
self._plugin_manager = PluginValidator()
self._plugins_path = os.path.join(settings.BASEDIR, 'wstore')
self._plugins_path = os.path.join(self._plugins_path, 'asset_manager')
self._plugins_path = os.path.join(self._plugins_path,
'resource_plugins')
self._plugins_path = os.path.join(self._plugins_path, 'plugins')
self._plugins_module = 'wstore.asset_manager.resource_plugins.plugins.'
def test_plugin_info_validation(self,
name,
plugin_info,
validation_msg=None):
plugin_manager = PluginValidator()
reason = plugin_manager.validate_plugin_info(plugin_info)
self.assertEquals(reason, validation_msg)
def __init__(self):
self._plugin_manager = PluginValidator()
self._plugins_path = os.path.join(settings.BASEDIR, 'wstore')
self._plugins_path = os.path.join(self._plugins_path, 'asset_manager')
self._plugins_path = os.path.join(self._plugins_path, 'resource_plugins')
self._plugins_path = os.path.join(self._plugins_path, 'plugins')
self._plugins_module = 'wstore.asset_manager.resource_plugins.plugins.'
def test_plugin_info_validation(self, name, plugin_info, validation_msg=None):
plugin_manager = PluginValidator()
reason = plugin_manager.validate_plugin_info(plugin_info)
self.assertEquals(reason, validation_msg)
class PluginLoader():
_plugin_manager = None
_plugins_path = None
_plugins_module = None
def __init__(self):
self._plugin_manager = PluginValidator()
self._plugins_path = os.path.join(settings.BASEDIR, 'wstore')
self._plugins_path = os.path.join(self._plugins_path, 'asset_manager')
self._plugins_path = os.path.join(self._plugins_path, 'resource_plugins')
self._plugins_path = os.path.join(self._plugins_path, 'plugins')
self._plugins_module = 'wstore.asset_manager.resource_plugins.plugins.'
@installPluginRollback
def install_plugin(self, path, logger=None):
# Validate package file
if not zipfile.is_zipfile(path):
raise PluginError('Invalid package format: Not a zip file')
# Uncompress plugin file
with zipfile.ZipFile(path, 'r') as z:
# Validate that the file package.json exists
if 'package.json' not in z.namelist():
raise PluginError('Missing package.json file')
# Read package metainfo
json_file = z.read('package.json')
try:
json_info = json.loads(json_file)
except:
raise PluginError('Invalid format in package.json file. JSON cannot be parsed')
# Create a directory for the plugin
# Validate plugin info
validation = self._plugin_manager.validate_plugin_info(json_info)
# Create plugin id
plugin_id = json_info['name'].lower().replace(' ', '-')
if len(ResourcePlugin.objects.filter(plugin_id=plugin_id)) > 0:
raise PluginError('A plugin with the same id (' + plugin_id + ') already exists')
if validation is not None:
raise PluginError('Invalid format in package.json file. ' + validation)
# Check if the directory already exists
plugin_path = os.path.join(self._plugins_path, plugin_id)
# Create the directory
os.mkdir(plugin_path)
if logger is not None:
logger.log_action('PATH', plugin_path)
# Extract files
z.extractall(plugin_path)
# Create a __init__.py file if needed
open(os.path.join(plugin_path, '__init__.py'), 'a').close()
# Validate plugin main class
module = self._plugins_module + plugin_id + '.' + json_info['module']
module_class_name = module.split('.')[-1]
module_package = module.partition('.' + module_class_name)[0]
module_class = getattr(__import__(module_package, globals(), locals(), [module_class_name], -1), module_class_name)
if Plugin not in module_class.__bases__:
raise PluginError('No Plugin implementation has been found')
# Save plugin model
ResourcePlugin.objects.create(
plugin_id=plugin_id,
name=json_info['name'],
version=json_info['version'],
author=json_info['author'],
module=module,
formats=json_info['formats'],
media_types=json_info.get('media_types', []),
form=json_info.get('form', {}),
overrides=json_info.get('overrides', [])
)
return plugin_id
def uninstall_plugin(self, plugin_id):
"""
Removes a plugin from the system including model and files
"""
# Get plugin model
try:
plugin_model = ResourcePlugin.objects.get(plugin_id=plugin_id)
except:
raise ObjectDoesNotExist('The plugin ' + plugin_id + ' is not registered')
name = plugin_model.name
# Check if the plugin is in use
resources = Resource.objects.filter(resource_type=name)
if len(resources) > 0:
raise PermissionDenied('The plugin ' + plugin_id + ' is being used in some resources')
# Remove plugin files
plugin_path = os.path.join(self._plugins_path, plugin_id)
rmtree(plugin_path)
# Remove model
plugin_model.delete()
class PluginLoader(object):
_plugin_manager = None
_plugins_path = None
_plugins_module = None
def __init__(self):
self._plugin_manager = PluginValidator()
self._plugins_path = os.path.join(settings.BASEDIR, 'wstore')
self._plugins_path = os.path.join(self._plugins_path, 'asset_manager')
self._plugins_path = os.path.join(self._plugins_path,
'resource_plugins')
self._plugins_path = os.path.join(self._plugins_path, 'plugins')
self._plugins_module = 'wstore.asset_manager.resource_plugins.plugins.'
def _get_plugin_module(self, module, plugin_id):
module_class_name = module.split('.')[-1]
module_package = module.partition('.' + module_class_name)[0]
return getattr(
__import__(module_package, globals(), locals(),
[module_class_name], 0), module_class_name)
@installPluginRollback
def install_plugin(self, path, logger=None):
# Validate package file
if not zipfile.is_zipfile(path):
raise PluginError('Invalid package format: Not a zip file')
# Uncompress plugin file
with zipfile.ZipFile(path, 'r') as z:
# Validate that the file package.json exists
if 'package.json' not in z.namelist():
raise PluginError('Missing package.json file')
# Read package metainfo
json_file = z.read('package.json')
try:
json_info = json.loads(json_file)
except:
raise PluginError(
'Invalid format in package.json file. JSON cannot be parsed'
)
# Create a directory for the plugin
# Validate plugin info
validation = self._plugin_manager.validate_plugin_info(json_info)
if validation is not None:
raise PluginError('Invalid format in package.json file. ' +
validation)
# Create plugin id
plugin_id = json_info['name'].lower().replace(' ', '-')
if len(ResourcePlugin.objects.filter(plugin_id=plugin_id)) > 0:
raise PluginError('A plugin with the same id (' + plugin_id +
') already exists')
# Check if the directory already exists
plugin_path = os.path.join(self._plugins_path, plugin_id)
# Create the directory
os.mkdir(plugin_path)
if logger is not None:
logger.log_action('PATH', plugin_path)
# Extract files
z.extractall(plugin_path)
# Create a __init__.py file if needed
open(os.path.join(plugin_path, '__init__.py'), 'a').close()
# Validate plugin main class
module = self._plugins_module + plugin_id + '.' + json_info['module']
module_class = self._get_plugin_module(module, plugin_id)
if Plugin not in module_class.__bases__:
raise PluginError('No Plugin implementation has been found')
# Check accounting implementations
if json_info.get('pull_accounting', False) and \
('get_pending_accounting' not in module_class.__dict__ or 'get_usage_specs' not in module_class.__dict__):
raise PluginError(
'If pull accounting is true, methods get_pending_accounting and get_usage_specs must be implemented'
)
if not json_info.get('pull_accounting', False) and \
('get_pending_accounting' in module_class.__dict__ or 'get_usage_specs' in module_class.__dict__):
raise PluginError(
'If pull accounting is false, methods get_pending_accounting and get_usage_specs must not be implemented'
)
# Save plugin model
plugin_model = ResourcePlugin.objects.create(
plugin_id=plugin_id,
name=json_info['name'],
version=json_info['version'],
author=json_info['author'],
module=module,
formats=json_info['formats'],
media_types=json_info.get('media_types', []),
form=json_info.get('form', {}),
form_order=json_info.get('form_order', []),
overrides=json_info.get('overrides', []),
pull_accounting=json_info.get('pull_accounting', False))
logger.log_action('MODEL', plugin_model)
# Configure usage specifications if needed
if plugin_model.pull_accounting:
module_class(plugin_model).configure_usage_spec()
return plugin_id
def uninstall_plugin(self, plugin_id):
"""
Removes a plugin from the system including model and files
"""
# Get plugin model
try:
plugin_model = ResourcePlugin.objects.get(plugin_id=plugin_id)
except:
raise ObjectDoesNotExist('The plugin ' + plugin_id +
' is not registered')
name = plugin_model.name
# Check if the plugin is in use
resources = Resource.objects.filter(resource_type=name)
if len(resources) > 0:
raise PermissionDenied('The plugin ' + plugin_id +
' is being used in some resources')
if plugin_model.pull_accounting:
module_class = self._get_plugin_module(plugin_model.module,
plugin_id)
plugin = module_class(plugin_model)
plugin.remove_usage_specs()
# Remove plugin files
plugin_path = os.path.join(self._plugins_path, plugin_id)
rmtree(plugin_path)
# Remove model
plugin_model.delete()
