# -*- coding: utf-8 -*- # Copyright(C) 2010-2012 Christophe Benz, Romain Bignon # # This file is part of weboob. # # weboob is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # weboob 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 Affero General Public License for more details. # # You should have received a copy of the GNU Affero General Public License # along with weboob. If not, see . from copy import copy import getpass import logging import sys import os import locale from tempfile import NamedTemporaryFile from ssl import SSLError from weboob.capabilities import UserError from weboob.capabilities.account import ICapAccount, Account, AccountRegisterError from weboob.core.backendscfg import BackendAlreadyExists from weboob.core.modules import ModuleLoadError from weboob.core.repositories import ModuleInstallError from weboob.tools.browser import BrowserUnavailable, BrowserIncorrectPassword, BrowserForbidden from weboob.tools.value import Value, ValueBool, ValueFloat, ValueInt from weboob.tools.misc import to_unicode from .base import BaseApplication __all__ = ['ConsoleApplication', 'BackendNotGiven'] class BackendNotGiven(Exception): def __init__(self, id, backends): self.id = id self.backends = sorted(backends) Exception.__init__(self, 'Please specify a backend to use for this argument (%s@backend_name). ' 'Availables: %s.' % (id, ', '.join(name for name, backend in backends))) class BackendNotFound(Exception): pass class ConsoleApplication(BaseApplication): """ Base application class for CLI applications. """ CAPS = None # shell escape strings if sys.platform == 'win32': #workaround to disable bold BOLD = '' NC = '' # no color else: BOLD = '' NC = '' # no color stdin = sys.stdin stdout = sys.stdout def __init__(self, option_parser=None): BaseApplication.__init__(self, option_parser) self.weboob.callbacks['login'] = self.login_cb self.enabled_backends = set() def login_cb(self, backend_name, value): return self.ask('[%s] %s' % (backend_name, value.label), masked=True, default='', regexp=value.regexp) def unload_backends(self, *args, **kwargs): unloaded = self.weboob.unload_backends(*args, **kwargs) for backend in unloaded.itervalues(): try: self.enabled_backends.remove(backend) except KeyError: pass return unloaded def is_module_loadable(self, info): return self.CAPS is None or info.has_caps(self.CAPS) def load_backends(self, *args, **kwargs): if 'errors' in kwargs: errors = kwargs['errors'] else: kwargs['errors'] = errors = [] ret = super(ConsoleApplication, self).load_backends(*args, **kwargs) for err in errors: print >>sys.stderr, 'Error(%s): %s' % (err.backend_name, err) if self.ask('Do you want to reconfigure this backend?', default=True): self.edit_backend(err.backend_name) self.load_backends(names=[err.backend_name]) for name, backend in ret.iteritems(): self.enabled_backends.add(backend) self.check_loaded_backends() return ret def check_loaded_backends(self, default_config=None): while len(self.enabled_backends) == 0: print 'Warning: there is currently no configured backend for %s' % self.APPNAME if not os.isatty(sys.stdout.fileno()) or not self.ask('Do you want to configure backends?', default=True): return False self.prompt_create_backends(default_config) return True def prompt_create_backends(self, default_config=None): r = '' while r != 'q': modules = [] print '\nAvailable modules:' for name, info in sorted(self.weboob.repositories.get_all_modules_info().iteritems()): if not self.is_module_loadable(info): continue modules.append(name) loaded = ' ' for bi in self.weboob.iter_backends(): if bi.NAME == name: if loaded == ' ': loaded = 'X' elif loaded == 'X': loaded = 2 else: loaded += 1 print '%s%d)%s [%s] %s%-15s%s %s' % (self.BOLD, len(modules), self.NC, loaded, self.BOLD, name, self.NC, info.description) print '%sa) --all--%s install all backends' % (self.BOLD, self.NC) print '%sq)%s --stop--\n' % (self.BOLD, self.NC) r = self.ask('Select a backend to create (q to stop)', regexp='^(\d+|q|a)$') if str(r).isdigit(): i = int(r) - 1 if i < 0 or i >= len(modules): print >>sys.stderr, 'Error: %s is not a valid choice' % r continue name = modules[i] try: inst = self.add_backend(name, default_config) if inst: self.load_backends(names=[inst]) except (KeyboardInterrupt, EOFError): print '\nAborted.' elif r == 'a': try: for name in modules: if name in [b.NAME for b in self.weboob.iter_backends()]: continue inst = self.add_backend(name, default_config) if inst: self.load_backends(names=[inst]) except (KeyboardInterrupt, EOFError): print '\nAborted.' else: break print 'Right right!' def _handle_options(self): self.load_default_backends() def load_default_backends(self): """ By default loads all backends. Applications can overload this method to restrict backends loaded. """ self.load_backends(self.CAPS) @classmethod def run(klass, args=None): try: super(ConsoleApplication, klass).run(args) except BackendNotFound, e: print 'Error: Backend "%s" not found.' % e sys.exit(1) def do(self, function, *args, **kwargs): if not 'backends' in kwargs: kwargs['backends'] = self.enabled_backends return self.weboob.do(function, *args, **kwargs) def parse_id(self, _id, unique_backend=False): try: _id, backend_name = _id.rsplit('@', 1) except ValueError: backend_name = None backends = [(b.name, b) for b in self.enabled_backends] if unique_backend and not backend_name: if len(backends) == 1: backend_name = backends[0][0] else: raise BackendNotGiven(_id, backends) if backend_name is not None and not backend_name in dict(backends): raise BackendNotFound(backend_name) return _id, backend_name # user interaction related methods def register_backend(self, name, ask_add=True): try: backend = self.weboob.modules_loader.get_or_load_module(name) except ModuleLoadError, e: backend = None if not backend: print >>sys.stderr, 'Backend "%s" does not exist.' % name return 1 if not backend.has_caps(ICapAccount) or backend.klass.ACCOUNT_REGISTER_PROPERTIES is None: print >>sys.stderr, 'You can\'t register a new account with %s' % name return 1 account = Account() account.properties = {} if backend.website: website = 'on website %s' % backend.website else: website = 'with backend %s' % backend.name while 1: asked_config = False for key, prop in backend.klass.ACCOUNT_REGISTER_PROPERTIES.iteritems(): if not asked_config: asked_config = True print 'Configuration of new account %s' % website print '-----------------------------%s' % ('-' * len(website)) p = copy(prop) p.set(self.ask(prop, default=account.properties[key].get() if (key in account.properties) else prop.default)) account.properties[key] = p if asked_config: print '-----------------------------%s' % ('-' * len(website)) try: backend.klass.register_account(account) except AccountRegisterError, e: print u'%s' % e if self.ask('Do you want to try again?', default=True): continue else: return None else: break backend_config = {} for key, value in account.properties.iteritems(): if key in backend.config: backend_config[key] = value.get() if ask_add and self.ask('Do you want to add the new register account?', default=True): return self.add_backend(name, backend_config, ask_register=False) return backend_config def install_module(self, name): try: self.weboob.repositories.install(name) except ModuleInstallError, e: print >>sys.stderr, 'Unable to install module "%s": %s' % (name, e) return False print '' return True def edit_backend(self, name, params=None): return self.add_backend(name, params, True) def add_backend(self, name, params=None, edit=False, ask_register=True): if params is None: params = {} module = None config = None try: if not edit: minfo = self.weboob.repositories.get_module_info(name) if minfo is None: raise ModuleLoadError(name, 'Module does not exist') if not minfo.is_installed(): print 'Module "%s" is available but not installed.' % minfo.name self.install_module(minfo) module = self.weboob.modules_loader.get_or_load_module(name) config = module.config else: bname, items = self.weboob.backends_config.get_backend(name) module = self.weboob.modules_loader.get_or_load_module(bname) items.update(params) params = items config = module.config.load(self.weboob, bname, name, params, nofail=True) except ModuleLoadError, e: print >>sys.stderr, 'Unable to load module "%s": %s' % (name, e) return 1 # ask for params non-specified on command-line arguments asked_config = False for key, value in config.iteritems(): if not asked_config: asked_config = True print '' print 'Configuration of backend %s' % module.name print '-------------------------%s' % ('-' * len(module.name)) if key not in params or edit: params[key] = self.ask(value, default=params[key] if (key in params) else value.default) else: print u' [%s] %s: %s' % (key, value.description, '(masked)' if value.masked else params[key]) if asked_config: print '-------------------------%s' % ('-' * len(module.name)) while not edit and self.weboob.backends_config.backend_exists(name): print >>sys.stderr, 'Backend instance "%s" already exists in "%s"' % (name, self.weboob.backends_config.confpath) if not self.ask('Add new backend for module "%s"?' % module.name, default=False): return 1 name = self.ask('Please give new instance name', default='%s2' % name, regexp=r'^[\w\-_]+$') try: config = config.load(self.weboob, module.name, name, params, nofail=True) for key, value in params.iteritems(): if key.startswith('_'): continue config[key].set(value) config.save(edit=edit) print 'Backend "%s" successfully added.' % name return name except BackendAlreadyExists: print >>sys.stderr, 'Backend "%s" already exists.' % name return 1 def ask(self, question, default=None, masked=False, regexp=None, choices=None, tiny=None): """ Ask a question to user. @param question text displayed (str) @param default optional default value (str) @param masked if True, do not show typed text (bool) @param regexp text must match this regexp (str) @param choices choices to do (list) @param tiny ask for the (small) value of the choice (bool) @return entered text by user (str) """ if isinstance(question, Value): v = copy(question) if default: v.default = default if masked: v.masked = masked if regexp: v.regexp = regexp if choices: v.choices = choices if tiny: v.tiny = tiny else: if isinstance(default, bool): klass = ValueBool elif isinstance(default, float): klass = ValueFloat elif isinstance(default, (int,long)): klass = ValueInt else: klass = Value v = klass(label=question, default=default, masked=masked, regexp=regexp, choices=choices, tiny=tiny) question = v.label if v.id: question = u'[%s] %s' % (v.id, question) aliases = {} if isinstance(v, ValueBool): question = u'%s (%s/%s)' % (question, 'Y' if v.default else 'y', 'n' if v.default else 'N') elif v.choices: if v.tiny is None: v.tiny = True for key in v.choices.iterkeys(): if len(key) > 5 or ' ' in key: v.tiny = False break if v.tiny: question = u'%s (%s)' % (question, '/'.join((s.upper() if s == v.default else s) for s in (v.choices.iterkeys()))) for key, value in v.choices.iteritems(): print '%s%s%s: %s' % (self.BOLD, key, self.NC, value) else: for n, (key, value) in enumerate(v.choices.iteritems()): print '%s%2d)%s %s' % (self.BOLD, n + 1, self.NC, value) aliases[str(n + 1)] = key question = u'%s (choose in list)' % question elif default not in (None, '') and not v.masked: question = u'%s [%s]' % (question, v.default) if v.masked: question = u'%s (hidden input)' % question question += ': ' while True: if v.masked: if sys.platform == 'win32': line = getpass.getpass(str(question)) else: line = getpass.getpass(question) else: self.stdout.write(question.encode(sys.stdout.encoding or locale.getpreferredencoding())) self.stdout.flush() line = self.stdin.readline() if len(line) == 0: raise EOFError() else: line = line.rstrip('\r\n') if not line and v.default is not None: line = v.default if isinstance(line, str): line = line.decode('utf-8') if line in aliases: line = aliases[line] try: v.set(line) except ValueError, e: print >>sys.stderr, u'Error: %s' % e else: break return v.get() def acquire_input(self, content=None): editor = os.getenv('EDITOR', 'vi') if sys.stdin.isatty() and editor: with NamedTemporaryFile() as f: filename = f.name if content is not None: f.write(content) f.flush() os.system("%s %s" % (editor, filename)) f.seek(0) text = f.read() else: if sys.stdin.isatty(): print 'Reading content from stdin... Type ctrl-D ' \ 'from an empty line to stop.' text = sys.stdin.read() return text.decode(sys.stdin.encoding or locale.getpreferredencoding()) def bcall_error_handler(self, backend, error, backtrace): """ Handler for an exception inside the CallErrors exception. This method can be overrided to support more exceptions types. """ if isinstance(error, BrowserIncorrectPassword): msg = unicode(error) if not msg: msg = 'invalid login/password.' print >>sys.stderr, 'Error(%s): %s' % (backend.name, msg) if self.ask('Do you want to reconfigure this backend?', default=True): self.unload_backends(names=[backend.name]) self.edit_backend(backend.name) self.load_backends(names=[backend.name]) elif isinstance(error, BrowserUnavailable): msg = unicode(error) if not msg: msg = 'website is unavailable.' print >>sys.stderr, u'Error(%s): %s' % (backend.name, msg) elif isinstance(error, BrowserForbidden): print >>sys.stderr, u'Error(%s): %s' % (backend.name, msg or 'Forbidden') elif isinstance(error, NotImplementedError): print >>sys.stderr, u'Error(%s): this feature is not supported yet by this backend.' % backend.name print >>sys.stderr, u' %s To help the maintainer of this backend implement this feature,' % (' ' * len(backend.name)) print >>sys.stderr, u' %s please contact: %s <%s>' % (' ' * len(backend.name), backend.MAINTAINER, backend.EMAIL) elif isinstance(error, UserError): print >>sys.stderr, u'Error(%s): %s' % (backend.name, to_unicode(error)) elif isinstance(error, SSLError): print >>sys.stderr, u'FATAL(%s): ' % backend.name + self.BOLD + '/!\ SERVER CERTIFICATE IS INVALID /!\\' + self.NC else: print >>sys.stderr, u'Bug(%s): %s' % (backend.name, to_unicode(error)) minfo = self.weboob.repositories.get_module_info(backend.NAME) if minfo and not minfo.is_local(): self.weboob.repositories.update_repositories() # minfo of the new available module minfo = self.weboob.repositories.get_module_info(backend.NAME) if minfo and minfo.version > self.weboob.repositories.versions.get(minfo.name) and \ self.ask('A new version of %s is available. Do you want to install it?' % minfo.name, default=True) and \ self.install_module(minfo): print 'New version of module %s has been installed. Retry to call the command.' % minfo.name return if logging.root.level == logging.DEBUG: print >>sys.stderr, backtrace else: return True def bcall_errors_handler(self, errors, debugmsg='Use --debug option to print backtraces'): """ Handler for the CallErrors exception. """ ask_debug_mode = False for backend, error, backtrace in errors.errors: if self.bcall_error_handler(backend, error, backtrace): ask_debug_mode = True if ask_debug_mode: print >>sys.stderr, debugmsg