sima/launch.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright (c) 2013, 2014, 2015 Jack Kaliko <kaliko@azylum.org>
   3 #
   4 #  This file is part of sima
   5 #
   6 #  sima is free software: you can redistribute it and/or modify
   7 #  it under the terms of the GNU General Public License as published by
   8 #  the Free Software Foundation, either version 3 of the License, or
   9 #  (at your option) any later version.
  10 #
  11 #  sima is distributed in the hope that it will be useful,
  12 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 #  GNU General Public License for more details.
  15 #
  16 #  You should have received a copy of the GNU General Public License
  17 #  along with sima.  If not, see <http://www.gnu.org/licenses/>.
  18 #
  19 #
  20 """Sima
  21 """
  22
  23 # standard library import
  24 import logging
  25 import sys
  26
  27 from importlib import __import__
  28 from os.path import isfile
  29 ##
  30
  31 # third parties components
  32 ##
  33
  34 # local import
  35 from . import core, info
  36 from .lib.logger import set_logger
  37 from .lib.meta import Meta
  38 from .lib.simadb import SimaDB
  39 from .utils.config import ConfMan
  40 from .utils.startopt import StartOpt
  41 from .utils.utils import exception_log, SigHup
  42  # core plugins
  43 from .plugins.core.history import History
  44 from .plugins.core.mpdoptions import MpdOptions
  45 from .plugins.core.uniq import Uniq
  46 ##
  47
  48
  49 def load_plugins(sima, source):
  50     """Handles internal/external plugins
  51         sima:   sima.core.Sima instance
  52         source: ['internal', 'contrib']
  53     """
  54     if not sima.config.get('sima', source):
  55         return
  56     logger = logging.getLogger('sima')
  57     # TODO: Sanity check for "sima.config.get('sima', source)" ?
  58     for plugin in sima.config.get('sima', source).split(','):
  59         plugin = plugin.strip(' \n')
  60         module = 'sima.plugins.{0}.{1}'.format(source, plugin.lower())
  61         try:
  62             mod_obj = __import__(module, fromlist=[plugin])
  63         except ImportError as err:
  64             logger.error('Failed to load plugin\'s module: ' +
  65                          '{0} ({1})'.format(module, err))
  66             sima.shutdown()
  67             sys.exit(1)
  68         try:
  69             plugin_obj = getattr(mod_obj, plugin)
  70         except AttributeError as err:
  71             logger.error('Failed to load plugin {0} ({1})'.format(plugin, err))
  72             sima.shutdown()
  73             sys.exit(1)
  74         logger.info('Loading {0} plugin: {name} ({doc})'.format(
  75             source, **plugin_obj.info()))
  76         sima.register_plugin(plugin_obj)
  77
  78
  79 def start(sopt, restart=False):
  80     """starts application
  81     """
  82     # set logger
  83     verbosity = sopt.options.get('verbosity', 'warning')
  84     # loads configuration
  85     config = ConfMan(sopt.options).config
  86     logfile = config.get('log', 'logfile')
  87     verbosity = config.get('log', 'verbosity')
  88     set_logger(verbosity, logfile)
  89     logger = logging.getLogger('sima')
  90     logger.debug('Command line say: {0}'.format(sopt.options))
  91     # Create Database
  92     db_file = config.get('sima', 'db_file')
  93     if (sopt.options.get('create_db', None)
  94        or not isfile(db_file)):
  95         logger.info('Creating database in "{}"'.format(db_file))
  96         open(db_file, 'a').close()
  97         SimaDB(db_path=db_file).create_db()
  98         if sopt.options.get('create_db', None):
  99             logger.info('Done, bye...')
 100             sys.exit(0)
 101
 102     logger.info('Starting...')
 103     sima = core.Sima(config)
 104
 105     # required core plugins
 106     core_plugins = [History, MpdOptions, Uniq]
 107     for cplgn in core_plugins:
 108         logger.debug('Register core {name} ({doc})'.format(**cplgn.info()))
 109         sima.register_core_plugin(cplgn)
 110     logger.debug('core loaded, prioriy: {}'.format(' > '.join(map(str, sima.core_plugins))))
 111
 112     #  Loading internal plugins
 113     load_plugins(sima, 'internal')
 114
 115     #  Loading contrib plugins
 116     load_plugins(sima, 'contrib')
 117     logger.info('plugins loaded, prioriy: {}'.format(' > '.join(map(str, sima.plugins))))
 118     #  Set use of MusicBrainzIdentifier
 119     if not config.getboolean('sima', 'musicbrainzid'):
 120         logger.info('Disabling MusicBrainzIdentifier')
 121         Meta.use_mbid = False
 122
 123     # Run as a daemon
 124     if config.getboolean('daemon', 'daemon'):
 125         if restart:
 126             sima.run()
 127         else:
 128             logger.info('Daemonize process...')
 129             sima.start()
 130
 131     try:
 132         sima.foreground()
 133     except KeyboardInterrupt:
 134         logger.info('Caught KeyboardInterrupt, stopping')
 135         sys.exit(0)
 136
 137
 138 def run(sopt, restart=False):
 139     """
 140     Handles SigHup exception
 141     Catches Unhandled exception
 142     """
 143     # pylint: disable=broad-except
 144     try:
 145         start(sopt, restart)
 146     except SigHup:  # SigHup inherit from Exception
 147         run(sopt, True)
 148     except Exception:  # Unhandled exception
 149         exception_log()
 150
 151 # Script starts here
 152 def main():
 153     """Entry point"""
 154     nfo = dict({'version': info.__version__,
 155                  'prog': 'sima'})
 156     # StartOpt gathers options from command line call (in StartOpt().options)
 157     sopt = StartOpt(nfo)
 158     run(sopt)
 159
 160
 161 if __name__ == '__main__':
 162     main()
 163
 164 # VIM MODLINE
 165 # vim: ai ts=4 sw=4 sts=4 expandtab