]> kaliko git repositories - mpd-sima.git/blob - sima/launch.py
Fixed indentation
[mpd-sima.git] / sima / launch.py
1 # -*- coding: utf-8 -*-
2 # Copyright (c) 2013, 2014, 2015, 2020,2021 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     cfg_mgmt = ConfMan(sopt.options)
83     config = cfg_mgmt.config
84     # set logger
85     logger = logging.getLogger('sima')
86     logfile = config.get('log', 'logfile', fallback=None)
87     verbosity = config.get('log', 'verbosity')
88     set_logger(verbosity, logfile)
89     logger.debug('Command line say: %s', sopt.options)
90
91     # Create database if not present
92     db_file = config.get('sima', 'db_file')
93     if not isfile(db_file):
94         logger.debug('Creating database in "%s"', db_file)
95         open(db_file, 'a').close()  # TODO: to remove with new simadb in v0.18
96         SimaDB(db_path=db_file).create_db()
97
98     if sopt.options.get('command'):
99         cmd = sopt.options.get('command')
100         if cmd == "generate-config":
101             config.write(sys.stdout, space_around_delimiters=True)
102             sys.exit(0)
103         logger.info('Running "%s" and exit' % cmd)
104         if cmd == "config-test":
105             logger.info('Config location: "%s"', cfg_mgmt.conf_file)
106             from .utils.configtest import config_test
107             config_test(config)
108             sys.exit(0)
109         if cmd == "create-db":
110             if not isfile(db_file):
111                 logger.info('Creating database in "%s"', db_file)
112                 open(db_file, 'a').close()  # TODO: to remove with new simadb in v0.18
113                 SimaDB(db_path=db_file).create_db()
114             else:
115                 logger.info('Database already there, not overwriting %s', db_file)
116             logger.info('Done, bye...')
117             sys.exit(0)
118         if cmd == "purge-history":
119             db_file = config.get('sima', 'db_file')
120             if not isfile(db_file):
121                 logger.warning('No db found: %s', db_file)
122                 sys.exit(1)
123             SimaDB(db_path=db_file).purge_history(duration=0)
124             sys.exit(0)
125
126     logger.info('Starting (%s)...', info.__version__)
127     sima = core.Sima(config)
128
129     # required core plugins
130     core_plugins = [History, MpdOptions, Uniq]
131     if config.getboolean('sima', 'mopidy_compat'):
132         logger.warning('Running with mopidy compat. mode!')
133         core_plugins = [History, MpdOptions]
134         config['sima']['musicbrainzid'] = 'False'
135     for cplgn in core_plugins:
136         logger.debug('Register core %(name)s (%(doc)s)', cplgn.info())
137         sima.register_core_plugin(cplgn)
138     logger.debug('core loaded, prioriy: %s', ' > '.join(map(str, sima.core_plugins)))
139
140     #  Loading internal plugins
141     load_plugins(sima, 'internal')
142     #  Loading contrib plugins
143     load_plugins(sima, 'contrib')
144     logger.info('plugins loaded, prioriy: %s', ' > '.join(map(str, sima.plugins)))
145
146     # Run as a daemon
147     if config.getboolean('daemon', 'daemon'):
148         if restart:
149             sima.run()
150         else:
151             logger.info('Daemonize process...')
152             sima.start()
153
154     try:
155         sima.foreground()
156     except KeyboardInterrupt:
157         logger.info('Caught KeyboardInterrupt, stopping')
158         sys.exit(0)
159
160
161 def run(sopt, restart=False):
162     """
163     Handles SigHup exception
164     Catches Unhandled exception
165     """
166     # pylint: disable=broad-except
167     logger = logging.getLogger('sima')
168     try:
169         start(sopt, restart)
170     except SigHup:  # SigHup inherit from Exception
171         run(sopt, True)
172     except MPDSimaException as err:
173         logger.error(err)
174         sys.exit(2)
175     except Exception:  # Unhandled exception
176         exception_log()
177
178 # Script starts here
179 def main():
180     """Entry point"""
181     nfo = dict({'version': info.__version__,
182                 'prog': 'sima'})
183     # StartOpt gathers options from command line call (in StartOpt().options)
184     sopt = StartOpt(nfo)
185     run(sopt)
186
187
188 if __name__ == '__main__':
189     main()
190
191 # VIM MODLINE
192 # vim: ai ts=4 sw=4 sts=4 expandtab