Mercurial > libervia-backend
view sat_frontends/jp/cmd_input.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 | 559a625a236b |
children | 2f0be2b7de68 |
line wrap: on
line source
#!/usr/bin/env python3 # jp: a SàT command line tool # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.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/>. import subprocess import argparse import sys import shlex import asyncio from . import base from sat.core.i18n import _ from sat.core import exceptions from sat_frontends.jp.constants import Const as C from sat.tools.common.ansi import ANSI as A __commands__ = ["Input"] OPT_STDIN = "stdin" OPT_SHORT = "short" OPT_LONG = "long" OPT_POS = "positional" OPT_IGNORE = "ignore" OPT_TYPES = (OPT_STDIN, OPT_SHORT, OPT_LONG, OPT_POS, OPT_IGNORE) OPT_EMPTY_SKIP = "skip" OPT_EMPTY_IGNORE = "ignore" OPT_EMPTY_CHOICES = (OPT_EMPTY_SKIP, OPT_EMPTY_IGNORE) class InputCommon(base.CommandBase): def __init__(self, host, name, help): base.CommandBase.__init__( self, host, name, use_verbose=True, use_profile=False, help=help ) self.idx = 0 self.reset() def reset(self): self.args_idx = 0 self._stdin = [] self._opts = [] self._pos = [] self._values_ori = [] def add_parser_options(self): self.parser.add_argument( "--encoding", default="utf-8", help=_("encoding of the input data") ) self.parser.add_argument( "-i", "--stdin", action="append_const", const=(OPT_STDIN, None), dest="arguments", help=_("standard input"), ) self.parser.add_argument( "-s", "--short", type=self.opt(OPT_SHORT), action="append", dest="arguments", help=_("short option"), ) self.parser.add_argument( "-l", "--long", type=self.opt(OPT_LONG), action="append", dest="arguments", help=_("long option"), ) self.parser.add_argument( "-p", "--positional", type=self.opt(OPT_POS), action="append", dest="arguments", help=_("positional argument"), ) self.parser.add_argument( "-x", "--ignore", action="append_const", const=(OPT_IGNORE, None), dest="arguments", help=_("ignore value"), ) self.parser.add_argument( "-D", "--debug", action="store_true", help=_("don't actually run commands but echo what would be launched"), ) self.parser.add_argument( "--log", type=argparse.FileType("w"), help=_("log stdout to FILE") ) self.parser.add_argument( "--log-err", type=argparse.FileType("w"), help=_("log stderr to FILE") ) self.parser.add_argument("command", nargs=argparse.REMAINDER) def opt(self, type_): return lambda s: (type_, s) def addValue(self, value): """add a parsed value according to arguments sequence""" self._values_ori.append(value) arguments = self.args.arguments try: arg_type, arg_name = arguments[self.args_idx] except IndexError: self.disp( _("arguments in input data and in arguments sequence don't match"), error=True, ) self.host.quit(C.EXIT_DATA_ERROR) self.args_idx += 1 while self.args_idx < len(arguments): next_arg = arguments[self.args_idx] if next_arg[0] not in OPT_TYPES: # value will not be used if False or None, so we skip filter if value not in (False, None): # we have a filter filter_type, filter_arg = arguments[self.args_idx] value = self.filter(filter_type, filter_arg, value) else: break self.args_idx += 1 if value is None: # we ignore this argument return if value is False: # we skip the whole row if self.args.debug: self.disp( A.color( C.A_SUBHEADER, _("values: "), A.RESET, ", ".join(self._values_ori), ), 2, ) self.disp(A.color(A.BOLD, _("**SKIPPING**\n"))) self.reset() self.idx += 1 raise exceptions.CancelError if not isinstance(value, list): value = [value] for v in value: if arg_type == OPT_STDIN: self._stdin.append(v) elif arg_type == OPT_SHORT: self._opts.append("-{}".format(arg_name)) self._opts.append(v) elif arg_type == OPT_LONG: self._opts.append("--{}".format(arg_name)) self._opts.append(v) elif arg_type == OPT_POS: self._pos.append(v) elif arg_type == OPT_IGNORE: pass else: self.parser.error( _( "Invalid argument, an option type is expected, got {type_}:{name}" ).format(type_=arg_type, name=arg_name) ) async def runCommand(self): """run requested command with parsed arguments""" if self.args_idx != len(self.args.arguments): self.disp( _("arguments in input data and in arguments sequence don't match"), error=True, ) self.host.quit(C.EXIT_DATA_ERROR) self.disp( A.color(C.A_HEADER, _("command {idx}").format(idx=self.idx)), no_lf=not self.args.debug, ) stdin = "".join(self._stdin) if self.args.debug: self.disp( A.color( C.A_SUBHEADER, _("values: "), A.RESET, ", ".join([shlex.quote(a) for a in self._values_ori]) ), 2, ) if stdin: self.disp(A.color(C.A_SUBHEADER, "--- STDIN ---")) self.disp(stdin) self.disp(A.color(C.A_SUBHEADER, "-------------")) self.disp( "{indent}{prog} {static} {options} {positionals}".format( indent=4 * " ", prog=sys.argv[0], static=" ".join(self.args.command), options=" ".join(shlex.quote(o) for o in self._opts), positionals=" ".join(shlex.quote(p) for p in self._pos), ) ) self.disp("\n") else: self.disp(" (" + ", ".join(self._values_ori) + ")", 2, no_lf=True) args = [sys.argv[0]] + self.args.command + self._opts + self._pos p = await asyncio.create_subprocess_exec( *args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, ) stdout, stderr = await p.communicate(stdin.encode('utf-8')) log = self.args.log log_err = self.args.log_err log_tpl = "{command}\n{buff}\n\n" if log: log.write(log_tpl.format( command=" ".join(shlex.quote(a) for a in args), buff=stdout.decode('utf-8', 'replace'))) if log_err: log_err.write(log_tpl.format( command=" ".join(shlex.quote(a) for a in args), buff=stderr.decode('utf-8', 'replace'))) ret = p.returncode if ret == 0: self.disp(A.color(C.A_SUCCESS, _("OK"))) else: self.disp(A.color(C.A_FAILURE, _("FAILED"))) self.reset() self.idx += 1 def filter(self, filter_type, filter_arg, value): """change input value @param filter_type(unicode): name of the filter @param filter_arg(unicode, None): argument of the filter @param value(unicode): value to filter @return (unicode, False, None): modified value False to skip the whole row None to ignore this argument (but continue row with other ones) """ raise NotImplementedError class Csv(InputCommon): def __init__(self, host): super(Csv, self).__init__(host, "csv", _("comma-separated values")) def add_parser_options(self): InputCommon.add_parser_options(self) self.parser.add_argument( "-r", "--row", type=int, default=0, help=_("starting row (previous ones will be ignored)"), ) self.parser.add_argument( "-S", "--split", action="append_const", const=("split", None), dest="arguments", help=_("split value in several options"), ) self.parser.add_argument( "-E", "--empty", action="append", type=self.opt("empty"), dest="arguments", help=_("action to do on empty value ({choices})").format( choices=", ".join(OPT_EMPTY_CHOICES) ), ) def filter(self, filter_type, filter_arg, value): if filter_type == "split": return value.split() elif filter_type == "empty": if filter_arg == OPT_EMPTY_IGNORE: return value if value else None elif filter_arg == OPT_EMPTY_SKIP: return value if value else False else: self.parser.error( _("--empty value must be one of {choices}").format( choices=", ".join(OPT_EMPTY_CHOICES) ) ) super(Csv, self).filter(filter_type, filter_arg, value) async def start(self): import csv if self.args.encoding: sys.stdin.reconfigure(encoding=self.args.encoding, errors="replace") reader = csv.reader(sys.stdin) for idx, row in enumerate(reader): try: if idx < self.args.row: continue for value in row: self.addValue(value) await self.runCommand() except exceptions.CancelError: # this row has been cancelled, we skip it continue self.host.quit() class Input(base.CommandBase): subcommands = (Csv,) def __init__(self, host): super(Input, self).__init__( host, "input", use_profile=False, help=_("launch command with external input"), )