]> kaliko git repositories - mpd-sima.git/blob - sima/launch.py
Fixed examples
[mpd-sima.git] / sima / launch.py
1 # -*- coding: utf-8 -*-
2 # Copyright (c) 2013, 2014, 2015, 2020 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__ as sima_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.simadb import SimaDB
38 from .utils.config import ConfMan
39 from .utils.startopt import StartOpt
40 from .utils.utils import exception_log, SigHup, MPDSimaException
41 # core plugins
42 from .plugins.core.history import History
43 from .plugins.core.mpdoptions import MpdOptions
44 from .plugins.core.uniq import Uniq
45 ##
46
47
48 def load_plugins(sima, source):
49     """Handles internal/external plugins
50         sima:   sima.core.Sima instance
51         source: ['internal', 'contrib']
52     """
53     if not sima.config.get('sima', source):
54         return
55     logger = logging.getLogger('sima')
56     # TODO: Sanity check for "sima.config.get('sima', source)" ?
57     for plugin in sima.config.get('sima', source).split(','):
58         plugin = plugin.strip(' \n')
59         module = 'sima.plugins.{0}.{1}'.format(source, plugin.lower())
60         try:
61             mod_obj = sima_import(module, fromlist=[plugin])
62         except ImportError as err:
63             logger.error('Failed to load "{}" plugin\'s module: '.format(plugin) +
64                          '{0} ({1})'.format(module, err))
65             sima.shutdown()
66             sys.exit(1)
67         try:
68             plugin_obj = getattr(mod_obj, plugin)
69         except AttributeError as err:
70             logger.error('Failed to load plugin %s (%s)', plugin, err)
71             sima.shutdown()
72             sys.exit(1)
73         logger.info('Loading {0} plugin: {name} ({doc})'.format(
74             source, **plugin_obj.info()))
75         sima.register_plugin(plugin_obj)
76
77
78 def start(sopt, restart=False):
79     """starts application
80     """
81     # loads configuration
82     config = ConfMan(sopt.options).config
83     # set logger
84     logger = logging.getLogger('sima')
85     logfile = config.get('log', 'logfile', fallback=None)
86     verbosity = config.get('log', 'verbosity')
87     set_logger(verbosity, logfile)
88     logger.debug('Command line say: %s', sopt.options)
89     # Create Database
90     db_file = config.get('sima', 'db_file')
91     if (sopt.options.get('create_db', None)
92             or not isfile(db_file)):
93         logger.info('Creating database in "%s"', db_file)
94         open(db_file, 'a').close()
95         SimaDB(db_path=db_file).create_db()
96         if sopt.options.get('create_db', None):
97             logger.info('Done, bye...')
98             sys.exit(0)
99
100     if sopt.options.get('generate_config'):
101         config.write(sys.stdout, space_around_delimiters=True)
102         sys.exit(0)
103
104     logger.info('Starting (%s)...', info.__version__)
105     sima = core.Sima(config)
106
107     # required core plugins
108     core_plugins = [History, MpdOptions, Uniq]
109     if config.getboolean('sima', 'mopidy_compat'):
110         logger.warning('Running with mopidy compat. mode!')
111         core_plugins = [History, MpdOptions]
112         config['sima']['musicbrainzid'] = 'False'
113     for cplgn in core_plugins:
114         logger.debug('Register core %(name)s (%(doc)s)', cplgn.info())
115         sima.register_core_plugin(cplgn)
116     logger.debug('core loaded, prioriy: %s', ' > '.join(map(str, sima.core_plugins)))
117
118     #  Loading internal plugins
119     load_plugins(sima, 'internal')
120     #  Loading contrib plugins
121     load_plugins(sima, 'contrib')
122     logger.info('plugins loaded, prioriy: %s', ' > '.join(map(str, sima.plugins)))
123
124     # Run as a daemon
125     if config.getboolean('daemon', 'daemon'):
126         if restart:
127             sima.run()
128         else:
129             logger.info('Daemonize process...')
130             sima.start()
131
132     try:
133         sima.foreground()
134     except KeyboardInterrupt:
135         logger.info('Caught KeyboardInterrupt, stopping')
136         sys.exit(0)
137
138
139 def run(sopt, restart=False):
140     """
141     Handles SigHup exception
142     Catches Unhandled exception
143     """
144     # pylint: disable=broad-except
145     logger = logging.getLogger('sima')
146     try:
147         start(sopt, restart)
148     except SigHup:  # SigHup inherit from Exception
149         run(sopt, True)
150     except MPDSimaException as err:
151         logger.error(err)
152         sys.exit(2)
153     except Exception:  # Unhandled exception
154         exception_log()
155
156 # Script starts here
157 def main():
158     """Entry point"""
159     nfo = dict({'version': info.__version__,
160                 'prog': 'sima'})
161     # StartOpt gathers options from command line call (in StartOpt().options)
162     sopt = StartOpt(nfo)
163     run(sopt)
164
165
166 if __name__ == '__main__':
167     main()
168
169 # VIM MODLINE
170 # vim: ai ts=4 sw=4 sts=4 expandtab