renamed BackendsLoader to ModulesLoader
This commit is contained in:
Romain Bignon
parent
f0ea8829a2
commit
9f5c9aeebc
9 changed files with 301 additions and 252 deletions
|
|
@ -1,225 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright(C) 2010 Romain Bignon
|
||||
#
|
||||
# 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 of the License.
|
||||
#
|
||||
# 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 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.
|
||||
|
||||
|
||||
from __future__ import with_statement
|
||||
|
||||
from ConfigParser import RawConfigParser
|
||||
import logging
|
||||
from logging import debug, error, exception, warning
|
||||
import os
|
||||
import re
|
||||
import stat
|
||||
|
||||
from weboob.capabilities.base import IBaseCap
|
||||
from weboob.tools.backend import BaseBackend
|
||||
|
||||
|
||||
__all__ = ['Backend', 'BackendsConfig', 'BackendsLoader']
|
||||
|
||||
|
||||
class Backend(object):
|
||||
def __init__(self, package):
|
||||
self.package = package
|
||||
self.klass = None
|
||||
for attrname in dir(self.package):
|
||||
attr = getattr(self.package, attrname)
|
||||
if isinstance(attr, type) and issubclass(attr, BaseBackend) and attr != BaseBackend:
|
||||
self.klass = attr
|
||||
if not self.klass:
|
||||
raise ImportError('%s is not a backend (no BaseBackend class found)' % package)
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
return self.klass.NAME
|
||||
|
||||
@property
|
||||
def maintainer(self):
|
||||
return '%s <%s>' % (self.klass.MAINTAINER, self.klass.EMAIL)
|
||||
|
||||
@property
|
||||
def version(self):
|
||||
return self.klass.VERSION
|
||||
|
||||
@property
|
||||
def description(self):
|
||||
return self.klass.DESCRIPTION
|
||||
|
||||
@property
|
||||
def license(self):
|
||||
return self.klass.LICENSE
|
||||
|
||||
@property
|
||||
def config(self):
|
||||
return self.klass.CONFIG
|
||||
|
||||
@property
|
||||
def website(self):
|
||||
if self.klass.BROWSER and self.klass.BROWSER.DOMAIN:
|
||||
return '%s://%s' % (self.klass.BROWSER.PROTOCOL, self.klass.BROWSER.DOMAIN)
|
||||
else:
|
||||
return None
|
||||
|
||||
@property
|
||||
def icon_path(self):
|
||||
if self.klass.ICON is None:
|
||||
try:
|
||||
import xdg.IconTheme
|
||||
except ImportError:
|
||||
debug(u'Python xdg module was not found. Please install it to read icon files.')
|
||||
else:
|
||||
self.klass.ICON = xdg.IconTheme.getIconPath(self.klass.NAME)
|
||||
return self.klass.ICON
|
||||
|
||||
def iter_caps(self):
|
||||
for cap in self.klass.__bases__:
|
||||
if issubclass(cap, IBaseCap) and cap != IBaseCap:
|
||||
yield cap
|
||||
|
||||
def has_caps(self, *caps):
|
||||
for c in caps:
|
||||
if (isinstance(c, basestring) and c in [cap.__name__ for cap in self.iter_caps()]) or \
|
||||
(type(c) == type and issubclass(self.klass, c)):
|
||||
return True
|
||||
return False
|
||||
|
||||
def create_instance(self, weboob, instance_name, config, storage):
|
||||
backend_instance = self.klass(weboob, instance_name, config, storage)
|
||||
debug(u'Created backend instance "%s" for backend "%s"' % (instance_name, self.name))
|
||||
return backend_instance
|
||||
|
||||
|
||||
class BackendsConfig(object):
|
||||
class WrongPermissions(Exception):
|
||||
pass
|
||||
|
||||
def __init__(self, confpath):
|
||||
self.confpath = confpath
|
||||
try:
|
||||
mode = os.stat(confpath).st_mode
|
||||
except OSError:
|
||||
os.mknod(confpath, 0600)
|
||||
else:
|
||||
if mode & stat.S_IRGRP or mode & stat.S_IROTH:
|
||||
raise self.WrongPermissions(
|
||||
u'Weboob will not start until config file %s is readable by group or other users.' % confpath)
|
||||
|
||||
def iter_backends(self):
|
||||
config = RawConfigParser()
|
||||
config.read(self.confpath)
|
||||
for instance_name in config.sections():
|
||||
params = dict(config.items(instance_name))
|
||||
try:
|
||||
backend_name = params.pop('_backend')
|
||||
except KeyError:
|
||||
try:
|
||||
backend_name = params.pop('_type')
|
||||
logging.warning(u'Please replace _type with _backend in your config file "%s", for backend "%s"' % (
|
||||
self.confpath, backend_name))
|
||||
except KeyError:
|
||||
warning('Missing field "_backend" for configured backend "%s"', instance_name)
|
||||
continue
|
||||
yield instance_name, backend_name, params
|
||||
|
||||
def add_backend(self, instance_name, backend_name, params, edit=False):
|
||||
if not instance_name:
|
||||
raise ValueError(u'Please give a name to the configured backend.')
|
||||
config = RawConfigParser()
|
||||
config.read(self.confpath)
|
||||
if not edit:
|
||||
config.add_section(instance_name)
|
||||
config.set(instance_name, '_backend', backend_name)
|
||||
for key, value in params.iteritems():
|
||||
config.set(instance_name, key, value)
|
||||
with open(self.confpath, 'wb') as f:
|
||||
config.write(f)
|
||||
|
||||
def edit_backend(self, instance_name, backend_name, params):
|
||||
return self.add_backend(instance_name, backend_name, params, True)
|
||||
|
||||
def get_backend(self, instance_name):
|
||||
config = RawConfigParser()
|
||||
config.read(self.confpath)
|
||||
if not config.has_section(instance_name):
|
||||
raise KeyError(u'Configured backend "%s" not found' % instance_name)
|
||||
|
||||
items = dict(config.items(instance_name))
|
||||
|
||||
try:
|
||||
backend_name = items.pop('_backend')
|
||||
except KeyError:
|
||||
try:
|
||||
backend_name = items.pop('_type')
|
||||
logging.warning(u'Please replace _type with _backend in your config file "%s"' % self.confpath)
|
||||
except KeyError:
|
||||
warning('Missing field "_backend" for configured backend "%s"', instance_name)
|
||||
raise KeyError(u'Configured backend "%s" not found' % instance_name)
|
||||
return backend_name, items
|
||||
|
||||
def remove_backend(self, instance_name):
|
||||
config = RawConfigParser()
|
||||
config.read(self.confpath)
|
||||
config.remove_section(instance_name)
|
||||
with open(self.confpath, 'w') as f:
|
||||
config.write(f)
|
||||
|
||||
|
||||
class BackendsLoader(object):
|
||||
def __init__(self):
|
||||
self.loaded = {}
|
||||
|
||||
def get_or_load_backend(self, backend_name):
|
||||
if backend_name not in self.loaded:
|
||||
self.load_backend(backend_name)
|
||||
if backend_name in self.loaded:
|
||||
return self.loaded[backend_name]
|
||||
else:
|
||||
return None
|
||||
|
||||
def iter_existing_backend_names(self):
|
||||
try:
|
||||
import weboob.backends
|
||||
except ImportError:
|
||||
return
|
||||
for path in weboob.backends.__path__:
|
||||
regexp = re.compile('^%s/([\w\d_]+)$' % path)
|
||||
for root, dirs, files in os.walk(path):
|
||||
m = regexp.match(root)
|
||||
if m and '__init__.py' in files:
|
||||
yield m.group(1)
|
||||
|
||||
def load_all(self):
|
||||
for existing_backend_name in self.iter_existing_backend_names():
|
||||
self.load_backend(existing_backend_name)
|
||||
|
||||
def load_backend(self, backend_name):
|
||||
try:
|
||||
package_name = 'weboob.backends.%s' % backend_name
|
||||
backend = Backend(__import__(package_name, fromlist=[str(package_name)]))
|
||||
except ImportError, e:
|
||||
msg = u'Unable to load backend "%s": %s' % (backend_name, e)
|
||||
if logging.root.level == logging.DEBUG:
|
||||
exception(msg)
|
||||
return
|
||||
else:
|
||||
error(msg)
|
||||
return
|
||||
if backend.name in self.loaded:
|
||||
debug('Backend "%s" is already loaded from %s' % (backend_name, backend.package.__path__[0]))
|
||||
return
|
||||
self.loaded[backend.name] = backend
|
||||
debug('Loaded backend "%s" from %s' % (backend_name, backend.package.__path__[0]))
|
||||
103
weboob/core/backendscfg.py
Normal file
103
weboob/core/backendscfg.py
Normal file
|
|
@ -0,0 +1,103 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright(C) 2010 Romain Bignon
|
||||
#
|
||||
# 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 of the License.
|
||||
#
|
||||
# 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 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.
|
||||
|
||||
|
||||
from __future__ import with_statement
|
||||
|
||||
import stat
|
||||
import os
|
||||
from ConfigParser import RawConfigParser
|
||||
from logging import warning
|
||||
|
||||
__all__ = ['BackendsConfig']
|
||||
|
||||
|
||||
class BackendsConfig(object):
|
||||
class WrongPermissions(Exception):
|
||||
pass
|
||||
|
||||
def __init__(self, confpath):
|
||||
self.confpath = confpath
|
||||
try:
|
||||
mode = os.stat(confpath).st_mode
|
||||
except OSError:
|
||||
os.mknod(confpath, 0600)
|
||||
else:
|
||||
if mode & stat.S_IRGRP or mode & stat.S_IROTH:
|
||||
raise self.WrongPermissions(
|
||||
u'Weboob will not start until config file %s is readable by group or other users.' % confpath)
|
||||
|
||||
def iter_backends(self):
|
||||
config = RawConfigParser()
|
||||
config.read(self.confpath)
|
||||
for instance_name in config.sections():
|
||||
params = dict(config.items(instance_name))
|
||||
try:
|
||||
backend_name = params.pop('_backend')
|
||||
except KeyError:
|
||||
try:
|
||||
backend_name = params.pop('_type')
|
||||
warning(u'Please replace _type with _backend in your config file "%s", for backend "%s"' % (
|
||||
self.confpath, backend_name))
|
||||
except KeyError:
|
||||
warning('Missing field "_backend" for configured backend "%s"', instance_name)
|
||||
continue
|
||||
yield instance_name, backend_name, params
|
||||
|
||||
def add_backend(self, instance_name, backend_name, params, edit=False):
|
||||
if not instance_name:
|
||||
raise ValueError(u'Please give a name to the configured backend.')
|
||||
config = RawConfigParser()
|
||||
config.read(self.confpath)
|
||||
if not edit:
|
||||
config.add_section(instance_name)
|
||||
config.set(instance_name, '_backend', backend_name)
|
||||
for key, value in params.iteritems():
|
||||
config.set(instance_name, key, value)
|
||||
with open(self.confpath, 'wb') as f:
|
||||
config.write(f)
|
||||
|
||||
def edit_backend(self, instance_name, backend_name, params):
|
||||
return self.add_backend(instance_name, backend_name, params, True)
|
||||
|
||||
def get_backend(self, instance_name):
|
||||
config = RawConfigParser()
|
||||
config.read(self.confpath)
|
||||
if not config.has_section(instance_name):
|
||||
raise KeyError(u'Configured backend "%s" not found' % instance_name)
|
||||
|
||||
items = dict(config.items(instance_name))
|
||||
|
||||
try:
|
||||
backend_name = items.pop('_backend')
|
||||
except KeyError:
|
||||
try:
|
||||
backend_name = items.pop('_type')
|
||||
warning(u'Please replace _type with _backend in your config file "%s"' % self.confpath)
|
||||
except KeyError:
|
||||
warning('Missing field "_backend" for configured backend "%s"', instance_name)
|
||||
raise KeyError(u'Configured backend "%s" not found' % instance_name)
|
||||
return backend_name, items
|
||||
|
||||
def remove_backend(self, instance_name):
|
||||
config = RawConfigParser()
|
||||
config.read(self.confpath)
|
||||
config.remove_section(instance_name)
|
||||
with open(self.confpath, 'w') as f:
|
||||
config.write(f)
|
||||
|
||||
|
||||
141
weboob/core/modules.py
Normal file
141
weboob/core/modules.py
Normal file
|
|
@ -0,0 +1,141 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright(C) 2010 Romain Bignon
|
||||
#
|
||||
# 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 of the License.
|
||||
#
|
||||
# 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 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.
|
||||
|
||||
|
||||
from __future__ import with_statement
|
||||
|
||||
import logging
|
||||
from logging import debug, error, exception
|
||||
import os
|
||||
import re
|
||||
|
||||
from weboob.capabilities.base import IBaseCap
|
||||
from weboob.tools.backend import BaseBackend
|
||||
|
||||
|
||||
__all__ = ['Module', 'ModulesLoader']
|
||||
|
||||
|
||||
class Module(object):
|
||||
def __init__(self, package):
|
||||
self.package = package
|
||||
self.klass = None
|
||||
for attrname in dir(self.package):
|
||||
attr = getattr(self.package, attrname)
|
||||
if isinstance(attr, type) and issubclass(attr, BaseBackend) and attr != BaseBackend:
|
||||
self.klass = attr
|
||||
if not self.klass:
|
||||
raise ImportError('%s is not a backend (no BaseBackend class found)' % package)
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
return self.klass.NAME
|
||||
|
||||
@property
|
||||
def maintainer(self):
|
||||
return '%s <%s>' % (self.klass.MAINTAINER, self.klass.EMAIL)
|
||||
|
||||
@property
|
||||
def version(self):
|
||||
return self.klass.VERSION
|
||||
|
||||
@property
|
||||
def description(self):
|
||||
return self.klass.DESCRIPTION
|
||||
|
||||
@property
|
||||
def license(self):
|
||||
return self.klass.LICENSE
|
||||
|
||||
@property
|
||||
def config(self):
|
||||
return self.klass.CONFIG
|
||||
|
||||
@property
|
||||
def website(self):
|
||||
if self.klass.BROWSER and self.klass.BROWSER.DOMAIN:
|
||||
return '%s://%s' % (self.klass.BROWSER.PROTOCOL, self.klass.BROWSER.DOMAIN)
|
||||
else:
|
||||
return None
|
||||
|
||||
@property
|
||||
def icon_path(self):
|
||||
return self.klass.ICON
|
||||
|
||||
def iter_caps(self):
|
||||
for cap in self.klass.__bases__:
|
||||
if issubclass(cap, IBaseCap) and cap != IBaseCap:
|
||||
yield cap
|
||||
|
||||
def has_caps(self, *caps):
|
||||
for c in caps:
|
||||
if (isinstance(c, basestring) and c in [cap.__name__ for cap in self.iter_caps()]) or \
|
||||
(type(c) == type and issubclass(self.klass, c)):
|
||||
return True
|
||||
return False
|
||||
|
||||
def create_instance(self, weboob, instance_name, config, storage):
|
||||
backend_instance = self.klass(weboob, instance_name, config, storage)
|
||||
debug(u'Created backend instance "%s" for backend "%s"' % (instance_name, self.name))
|
||||
return backend_instance
|
||||
|
||||
|
||||
class ModulesLoader(object):
|
||||
def __init__(self):
|
||||
self.loaded = {}
|
||||
|
||||
def get_or_load_module(self, module_name):
|
||||
if module_name not in self.loaded:
|
||||
self.load_module(module_name)
|
||||
if module_name in self.loaded:
|
||||
return self.loaded[module_name]
|
||||
else:
|
||||
return None
|
||||
|
||||
def iter_existing_module_names(self):
|
||||
try:
|
||||
import weboob.backends
|
||||
except ImportError:
|
||||
return
|
||||
for path in weboob.backends.__path__:
|
||||
regexp = re.compile('^%s/([\w\d_]+)$' % path)
|
||||
for root, dirs, files in os.walk(path):
|
||||
m = regexp.match(root)
|
||||
if m and '__init__.py' in files:
|
||||
yield m.group(1)
|
||||
|
||||
def load_all(self):
|
||||
for existing_module_name in self.iter_existing_module_names():
|
||||
self.load_module(existing_module_name)
|
||||
|
||||
def load_module(self, module_name):
|
||||
try:
|
||||
package_name = 'weboob.backends.%s' % module_name
|
||||
module = Module(__import__(package_name, fromlist=[str(package_name)]))
|
||||
except ImportError, e:
|
||||
msg = u'Unable to load module "%s": %s' % (module_name, e)
|
||||
if logging.root.level == logging.DEBUG:
|
||||
exception(msg)
|
||||
return
|
||||
else:
|
||||
error(msg)
|
||||
return
|
||||
if module.name in self.loaded:
|
||||
debug('Module "%s" is already loaded from %s' % (module_name, module.package.__path__[0]))
|
||||
return
|
||||
self.loaded[module.name] = module
|
||||
debug('Loaded module "%s" from %s' % (module_name, module.package.__path__[0]))
|
||||
|
|
@ -22,7 +22,8 @@ from logging import warning
|
|||
import os
|
||||
|
||||
from weboob.core.bcall import BackendsCall
|
||||
from weboob.core.backends import BackendsConfig, BackendsLoader
|
||||
from weboob.core.modules import ModulesLoader
|
||||
from weboob.core.backendscfg import BackendsConfig
|
||||
from weboob.core.scheduler import Scheduler
|
||||
from weboob.tools.backend import BaseBackend
|
||||
|
||||
|
|
@ -50,7 +51,7 @@ class Weboob(object):
|
|||
warning(u'"%s" is not a directory' % self.workdir)
|
||||
|
||||
# Backends loader
|
||||
self.backends_loader = BackendsLoader()
|
||||
self.modules_loader = ModulesLoader()
|
||||
|
||||
# Backend instances config
|
||||
if not backends_filename:
|
||||
|
|
@ -73,25 +74,25 @@ class Weboob(object):
|
|||
if storage is None:
|
||||
storage = self.storage
|
||||
|
||||
for instance_name, backend_name, params in self.backends_config.iter_backends():
|
||||
for instance_name, module_name, params in self.backends_config.iter_backends():
|
||||
if '_enabled' in params and not params['_enabled'] or \
|
||||
names is not None and instance_name not in names or \
|
||||
modules is not None and backend_name not in modules:
|
||||
modules is not None and module_name not in modules:
|
||||
continue
|
||||
backend = self.backends_loader.get_or_load_backend(backend_name)
|
||||
if backend is None:
|
||||
module = self.modules_loader.get_or_load_module(module_name)
|
||||
if module is None:
|
||||
warning(u'Backend "%s" is referenced in ~/.weboob/backends '
|
||||
'configuration file, but was not found. '
|
||||
'Hint: is it installed?' % backend_name)
|
||||
'Hint: is it installed?' % module_name)
|
||||
continue
|
||||
if caps is not None and not backend.has_caps(caps):
|
||||
if caps is not None and not module.has_caps(caps):
|
||||
continue
|
||||
|
||||
if instance_name in self.backend_instances:
|
||||
warning(u'Oops, the backend "%s" is already loaded. Unload it before reloading...' % instance_name)
|
||||
self.unload_backends(instance_name)
|
||||
|
||||
backend_instance = backend.create_instance(self, instance_name, params, storage)
|
||||
backend_instance = module.create_instance(self, instance_name, params, storage)
|
||||
self.backend_instances[instance_name] = loaded[instance_name] = backend_instance
|
||||
return loaded
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue