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     logfile = sopt.options.get('logfile', None)
  85     set_logger(verbosity, logfile)
  86     # loads configuration
  87     config = ConfMan(sopt.options).config
  88     logfile = config.get('log', 'logfile')
  89     verbosity = config.get('log', 'verbosity')
  90     set_logger(verbosity, logfile)
  91     logger = logging.getLogger('sima')
  92     logger.debug('Command line say: {0}'.format(sopt.options))
  93     # Create Database
  94     db_file = config.get('sima', 'db_file')
  95     if (sopt.options.get('create_db', None)
  96        or not isfile(db_file)):
  97         logger.info('Creating database in "{}"'.format(db_file))
  98         open(db_file, 'a').close()
  99         SimaDB(db_path=db_file).create_db()
 100         if sopt.options.get('create_db', None):
 101             logger.info('Done, bye...')
 102             sys.exit(0)
 103
 104     logger.info('Starting...')
 105     sima = core.Sima(config)
 106
 107     # required core plugins
 108     core_plugins = [History, MpdOptions, Uniq]
 109     for cplgn in core_plugins:
 110         logger.debug('Register core {name} ({doc})'.format(**cplgn.info()))
 111         sima.register_core_plugin(cplgn)
 112     logger.debug('core loaded, prioriy: {}'.format(' > '.join(map(str, sima.core_plugins))))
 113
 114     #  Loading internal plugins
 115     load_plugins(sima, 'internal')
 116
 117     #  Loading contrib plugins
 118     load_plugins(sima, 'contrib')
 119     logger.info('plugins loaded, prioriy: {}'.format(' > '.join(map(str, sima.plugins))))
 120     #  Set use of MusicBrainzIdentifier
 121     if not config.getboolean('sima', 'musicbrainzid'):
 122         logger.info('Disabling MusicBrainzIdentifier')
 123         Meta.use_mbid = False
 124
 125     # Run as a daemon
 126     if config.getboolean('daemon', 'daemon'):
 127         if restart:
 128             sima.run()
 129         else:
 130             logger.info('Daemonize process...')
 131             sima.start()
 132
 133     try:
 134         sima.foreground()
 135     except KeyboardInterrupt:
 136         logger.info('Caught KeyboardInterrupt, stopping')
 137         sys.exit(0)
 138
 139
 140 def run(sopt, restart=False):
 141     """
 142     Handles SigHup exception
 143     Catches Unhandled exception
 144     """
 145     # pylint: disable=broad-except
 146     try:
 147         start(sopt, restart)
 148     except SigHup:  # SigHup inherit from Exception
 149         run(sopt, True)
 150     except Exception:  # Unhandled exception
 151         exception_log()
 152
 153 # Script starts here
 154 def main():
 155     """Entry point"""
 156     nfo = dict({'version': info.__version__,
 157                  'prog': 'sima'})
 158     # StartOpt gathers options from command line call (in StartOpt().options)
 159     sopt = StartOpt(nfo)
 160     run(sopt)
 161
 162
 163 if __name__ == '__main__':
 164     main()
 165
 166 # VIM MODLINE
 167 # vim: ai ts=4 sw=4 sts=4 expandtab