Mercurial > libervia-backend
view sat/tools/config.py @ 3254:6cf4bd6972c2
core, frontends: avatar refactoring:
/!\ huge commit
Avatar logic has been reworked around the IDENTITY plugin: plugins able to handle avatar
or other identity related metadata (like nicknames) register to IDENTITY plugin in the
same way as for other features like download/upload. Once registered, IDENTITY plugin will
call them when suitable in order of priority, and handle caching.
Methods to manage those metadata from frontend now use serialised data.
For now `avatar` and `nicknames` are handled:
- `avatar` is now a dict with `path` + metadata like `media_type`, instead of just a string
path
- `nicknames` is now a list of nicknames in order of priority. This list is never empty,
and `nicknames[0]` should be the preferred nickname to use by frontends in most cases.
In addition to contact specified nicknames, user set nickname (the one set in roster) is
used in priority when available.
Among the side changes done with this commit, there are:
- a new `contactGet` bridge method to get roster metadata for a single contact
- SatPresenceProtocol.send returns a Deferred to check when it has actually been sent
- memory's methods to handle entities data now use `client` as first argument
- metadata filter can be specified with `getIdentity`
- `getAvatar` and `setAvatar` are now part of the IDENTITY plugin instead of XEP-0054 (and
there signature has changed)
- `isRoom` and `getBareOrFull` are now part of XEP-0045 plugin
- jp avatar/get command uses `xdg-open` first when available for `--show` flag
- `--no-cache` has been added to jp avatar/get and identity/get
- jp identity/set has been simplified, explicit options (`--nickname` only for now) are
used instead of `--field`. `--field` may come back in the future if necessary for extra
data.
- QuickContactList `SetContact` now handle None as a value, and doesn't use it to delete the
metadata anymore
- improved cache handling for `metadata` and `nicknames` in quick frontend
- new `default` argument in QuickContactList `getCache`
author | Goffi <goffi@goffi.org> |
---|---|
date | Tue, 14 Apr 2020 21:00:33 +0200 |
parents | 60a9e47ef988 |
children | a3639d6d9643 |
line wrap: on
line source
#!/usr/bin/env python3 # SAT: a jabber client # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org) # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org) # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Affero General Public License for more details. # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. """ Configuration related useful methods """ import os import csv import json from configparser import ConfigParser, DEFAULTSECT, NoOptionError, NoSectionError from xdg import BaseDirectory from sat.core.log import getLogger from sat.core.constants import Const as C from sat.core.i18n import _ from sat.core import exceptions log = getLogger(__name__) def fixConfigOption(section, option, value, silent=True): """Force a configuration option value, writing it in the first found user config file, eventually creating a new user config file if none is found. @param section (str): the config section @param option (str): the config option @param value (str): the new value @param silent (boolean): toggle logging output (must be True when called from sat.sh) """ config = ConfigParser() target_file = None for file_ in C.CONFIG_FILES[::-1]: # we will eventually update the existing file with the highest priority, # if it's a user personal file... if not silent: log.debug(_("Testing file %s") % file_) if os.path.isfile(file_): if file_.startswith(os.path.expanduser("~")): config.read([file_]) target_file = file_ break if not target_file: # ... otherwise we create a new config file for that user target_file = BaseDirectory.save_config_path("sat") + "/sat.conf" if section and section.upper() != DEFAULTSECT and not config.has_section(section): config.add_section(section) config.set(section, option, value) with open(target_file, "wb") as configfile: config.write(configfile) # for the next time that user launches sat if not silent: if option in ("passphrase",): # list here the options storing a password value = "******" log.warning(_("Config auto-update: {option} set to {value} in the file " "{config_file}.").format(option=option, value=value, config_file=target_file)) # XXX: tmp update code, will be removed in the future # When you remove this, please add the default value for # 'local_dir' in sat.core.constants.Const.DEFAULT_CONFIG def fixLocalDir(silent=True): """Retro-compatibility with the previous local_dir default value. @param silent (boolean): toggle logging output (must be True when called from sat.sh) """ user_config = ConfigParser() try: user_config.read(C.CONFIG_FILES) except: pass # file is readable but its structure if wrong try: current_value = user_config.get("DEFAULT", "local_dir") except (NoOptionError, NoSectionError): current_value = "" if current_value: return # nothing to do old_default = "~/.sat" if os.path.isfile(os.path.expanduser(old_default) + "/" + C.SAVEFILE_DATABASE): if not silent: log.warning(_( "A database has been found in the default local_dir for previous " "versions (< 0.5)" )) fixConfigOption("", "local_dir", old_default, silent) def parseMainConf(log_filenames=False): """Look for main .ini configuration file, and parse it @param log_filenames(bool): if True, log filenames of read config files """ config = ConfigParser(defaults=C.DEFAULT_CONFIG) try: filenames = config.read(C.CONFIG_FILES) except Exception as e: log.error(_("Can't read main config: {msg}").format(msg=e), exc_info=True) else: if log_filenames: log.info( _("Configuration was read from: {filenames}").format( filenames=', '.join(filenames))) return config def getConfig(config, section, name, default=None): """Get a configuration option @param config (ConfigParser): the configuration instance @param section (str): section of the config file (None or '' for DEFAULT) @param name (str): name of the option @param default: value to use if not found, or Exception to raise an exception @return (unicode, list, dict): parsed value @raise: NoOptionError if option is not present and default is Exception NoSectionError if section doesn't exists and default is Exception exceptions.ParsingError error while parsing value """ if not section: section = DEFAULTSECT try: value = config.get(section, name) except (NoOptionError, NoSectionError) as e: if default is Exception: raise e return default if name.endswith("_path") or name.endswith("_dir"): value = os.path.expanduser(value) # thx to Brian (http://stackoverflow.com/questions/186857/splitting-a-semicolon-separated-string-to-a-dictionary-in-python/186873#186873) elif name.endswith("_list"): value = next(csv.reader( [value], delimiter=",", quotechar='"', skipinitialspace=True )) elif name.endswith("_dict"): try: value = json.loads(value) except ValueError as e: raise exceptions.ParsingError("Error while parsing data: {}".format(e)) if not isinstance(value, dict): raise exceptions.ParsingError( "{name} value is not a dict: {value}".format(name=name, value=value) ) elif name.endswith("_json"): try: value = json.loads(value) except ValueError as e: raise exceptions.ParsingError("Error while parsing data: {}".format(e)) return value