X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Futils%2Fconfig.py;h=a46c0c66493e3519ab1af41cefe7d88e8087ddbf;hb=d67a78c3f86751a551b370c32aaf3934e772825f;hp=157d7c3c341ce7cea04a47aa54e3ba468b30c608;hpb=3ee55407f08ca20a37ca008822283682d2ba58f9;p=mpd-sima.git diff --git a/sima/utils/config.py b/sima/utils/config.py index 157d7c3..a46c0c6 100644 --- a/sima/utils/config.py +++ b/sima/utils/config.py @@ -1,5 +1,6 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2009, 2010, 2011, 2013, 2014 Jack Kaliko +# Copyright (c) 2009-2015, 2019-2021 kaliko +# Copyright (c) 2019 sacha # # This file is part of sima # @@ -16,7 +17,7 @@ # You should have received a copy of the GNU General Public License # along with sima. If not, see . # -# +# pylint: disable=bad-continuation """ Deal with configuration and data files. @@ -25,18 +26,19 @@ Parse configuration file and set defaults for missing options. # IMPORTS import configparser +import logging import sys from configparser import Error -from os import (makedirs, environ, stat, chmod) -from os.path import (join, isdir, isfile) +from os import (access, makedirs, environ, stat, chmod, W_OK) +from os.path import (join, isdir, isfile, dirname, exists) from stat import (S_IMODE, ST_MODE, S_IRWXO, S_IRWXG) from . import utils # DEFAULTS DIRNAME = 'mpd_sima' -CONF_FILE = 'sima.cfg' +CONF_FILE = 'mpd_sima.cfg' DEFAULT_CONF = { 'MPD': { @@ -45,14 +47,18 @@ DEFAULT_CONF = { 'port': 6600, }, 'sima': { - 'internal': "Crop, Lastfm, RandomFallBack", + 'internal': "Crop, Lastfm, Random", 'contrib': "", - 'user_db': "false", + 'user_db': False, 'history_duration': 8, - 'queue_length': 1, + 'queue_length': 2, 'var_dir': 'empty', + 'musicbrainzid': True, + 'repeat_disable_queue': True, + 'single_disable_queue': True, + 'mopidy_compat': False, }, - 'daemon':{ + 'daemon': { 'daemon': False, 'pidfile': "", }, @@ -60,31 +66,52 @@ DEFAULT_CONF = { 'verbosity': "info", 'logfile': "", }, - 'echonest': { - 'queue_mode': "track", #TODO control values - 'max_art': 15, - 'single_album': "false", - 'track_to_add': 1, - 'album_to_add': 1, - 'depth': 1, + 'crop': { + 'consume': 10, + 'priority': 0, }, 'lastfm': { - 'queue_mode': "track", #TODO control values + 'queue_mode': "track", # TODO control values 'max_art': 10, - 'single_album': "false", + 'single_album': False, 'track_to_add': 1, 'album_to_add': 1, + 'shuffle_album': False, + 'track_to_add_from_album': 0, # <=0 means keep all 'depth': 1, + 'cache': True, + 'priority': 100, + }, + 'random': { + 'flavour': "sensible", # in pure, sensible + 'track_to_add': 1, + 'priority': 50, }, - 'randomfallback': { - 'flavour': "sensible", # in pure, sensible + 'tags': { + 'comment': "", + 'date': "", + 'genre': "", + 'label': "", + 'originaldate': "", + 'filter': "", + 'queue_mode': "track", + 'single_album': False, 'track_to_add': 1, - } + 'album_to_add': 1, + 'priority': 80, + }, + 'genre': { + 'queue_mode': "track", + 'single_album': False, + 'track_to_add': 1, + 'album_to_add': 1, + 'priority': 80, + }, } # -class ConfMan(object): # CONFIG MANAGER CLASS +class ConfMan: # CONFIG MANAGER CLASS """ Configuration manager. Default configuration is stored in DEFAULT_CONF dictionnary. @@ -101,8 +128,8 @@ class ConfMan(object): # CONFIG MANAGER CLASS * command line options (overrides previous) """ - def __init__(self, logger, options=None): - self.log = logger + def __init__(self, options=None): + self.log = logging.getLogger('sima') # options settings priority: # defauts < env. var. < conf. file < command line self.conf_file = options.get('conf_file') @@ -112,30 +139,55 @@ class ConfMan(object): # CONFIG MANAGER CLASS self.use_envar() self.startopt = options - ## INIT CALLS + # INIT CALLS self.init_config() self.supersedes_config_with_cmd_line_options() + # set dbfile + self.config['sima']['db_file'] = join(self.config['sima']['var_dir'], 'sima.db') + # Controls files access + self.control_facc() - def get_pw(self): - try: - self.config.getboolean('MPD', 'password') - self.log.debug('No password set, proceeding without ' + - 'authentication...') - return None - except ValueError: - # ValueError if password not a boolean, hence an actual password. - pwd = self.config.get('MPD', 'password') - if not pwd: - self.log.debug('Password set as an empty string.') - return None - return pwd + # Create directories + data_dir = self.config['sima']['var_dir'] + if not isdir(data_dir): + self.log.trace('Creating "%s"', data_dir) + makedirs(data_dir) + chmod(data_dir, 0o700) + + def control_facc(self): + """Controls file access. + This is relevant only for file provided through the configuration file + since files provided on the command line are already checked with + argparse. Also add config['sima']['db_file'] contructed here in init + """ + ok = True + for op, ftochk in [('logfile', self.config.get('log', 'logfile')), + ('pidfile', self.config.get('daemon', 'pidfile')), + ('db file', self.config.get('sima', 'db_file'))]: + if not ftochk: + continue + if isdir(ftochk): + self.log.critical('Need a file not a directory: "%s"', ftochk) + ok = False + if not exists(ftochk): + # Is parent directory writable then + filedir = dirname(ftochk) + if not access(filedir, W_OK): + self.log.critical('no write access to "%s" (%s)', filedir, op) + ok = False + else: + if not access(ftochk, W_OK): + self.log.critical('no write access to "%s" (%s)', ftochk, op) + ok = False + if not ok: + sys.exit(2) def control_mod(self): """ Controls conf file permissions. """ mode = S_IMODE(stat(self.conf_file)[ST_MODE]) - self.log.debug('file permission is: %o' % mode) + self.log.debug('file permission is: %o', mode) if mode & S_IRWXO or mode & S_IRWXG: self.log.warning('File is readable by "other" and/or' + ' "group" (actual permission %o octal).' % @@ -149,18 +201,26 @@ class ConfMan(object): # CONFIG MANAGER CLASS for opt in self.config.options(sec): if opt in list(self.startopt.keys()): self.config.set(sec, opt, str(self.startopt.get(opt))) + # honor MPD_HOST format as in mpc(1) for command line option --host + if self.startopt.get('host'): + if '@' in self.startopt.get('host'): + host, passwd = utils.parse_mpd_host(self.startopt.get('host')) + if passwd: + self.config.set('MPD', 'password', passwd) + if host: + self.config.set('MPD', 'host', host) def use_envar(self): """Use MPD en.var. to set defaults""" mpd_host, mpd_port, passwd = utils.get_mpd_environ() if mpd_host: - self.log.info('Env. variable MPD_HOST set to "%s"' % mpd_host) + self.log.info('Env. variable MPD_HOST set to "%s"', mpd_host) self.config['MPD'].update(host=mpd_host) if passwd: self.log.info('Env. variable MPD_HOST contains password.') self.config['MPD'].update(password=passwd) if mpd_port: - self.log.info('Env. variable MPD_PORT set to "%s".' % mpd_port) + self.log.info('Env. variable MPD_PORT set to "%s".', mpd_port) self.config['MPD'].update(port=mpd_port) def init_config(self): @@ -177,40 +237,32 @@ class ConfMan(object): # CONFIG MANAGER CLASS elif homedir and isdir(homedir) and homedir not in ['/']: data_dir = join(homedir, '.local', 'share', DIRNAME) else: - self.log.error('Can\'t find a suitable location for data folder (XDG_DATA_HOME)') - self.log.error('Please use "--var_dir" to set a proper location') + self.log.critical('Can\'t find a suitable location for data folder (XDG_DATA_HOME)') + self.log.critical('Please use "--var-dir" to set a proper location') sys.exit(1) - if not isdir(data_dir): - makedirs(data_dir) - chmod(data_dir, 0o700) - if self.startopt.get('conf_file'): # No need to handle conf file location pass elif environ.get('XDG_CONFIG_HOME'): conf_dir = join(environ.get('XDG_CONFIG_HOME'), DIRNAME) + self.conf_file = join(conf_dir, CONF_FILE) elif homedir and isdir(homedir) and homedir not in ['/']: conf_dir = join(homedir, '.config', DIRNAME) - # Create conf_dir if necessary - if not isdir(conf_dir): - makedirs(conf_dir) - chmod(conf_dir, 0o700) self.conf_file = join(conf_dir, CONF_FILE) else: - self.log.error('Can\'t find a suitable location for config folder (XDG_CONFIG_HOME)') - self.log.error('Please use "--config" to locate the conf file') + self.log.critical('Can\'t find a suitable location for config folder (XDG_CONFIG_HOME)') + self.log.critical('Please use "--config" to locate the conf file') sys.exit(1) - ## Sima sqlite DB + # Sima sqlite DB self.config['sima']['var_dir'] = join(data_dir) - self.config['sima']['db_file'] = join(data_dir, 'sima.db') # If no conf file present, uses defaults if not isfile(self.conf_file): return - self.log.info('Loading configuration from: %s' % self.conf_file) + self.log.info('Loading configuration from: %s', self.conf_file) self.control_mod() try: