Mercurial > libervia-backend
view libervia/cli/cmd_avatar.py @ 4212:5f2d496c633f
core: get rid of `pickle`:
Use of `pickle` to serialise data was a technical legacy that was causing trouble to store
in database, to update (if a class was serialised, a change could break update), and to
security (pickle can lead to code execution).
This patch remove all use of Pickle in favour in JSON, notably:
- for caching data, a Pydantic model is now used instead
- for SQLAlchemy model, the LegacyPickle is replaced by JSON serialisation
- in XEP-0373 a class `PublicKeyMetadata` was serialised. New method `from_dict` and
`to_dict` method have been implemented to do serialisation.
- new methods to (de)serialise data can now be specified with Identity data types. It is
notably used to (de)serialise `path` of avatars.
A migration script has been created to convert data (for upgrade or downgrade), with
special care for XEP-0373 case. Depending of size of database, this migration script can
be long to run.
rel 443
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 23 Feb 2024 13:31:04 +0100 |
parents | 47401850dec6 |
children | 0d7bb4df2343 |
line wrap: on
line source
#!/usr/bin/env python3 # Libervia CLI # Copyright (C) 2009-2021 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 os import os.path import asyncio from . import base from libervia.backend.core.i18n import _ from libervia.cli.constants import Const as C from libervia.backend.tools import config from libervia.backend.tools.common import data_format __commands__ = ["Avatar"] DISPLAY_CMD = ["xdg-open", "xv", "display", "gwenview", "showtell"] class Get(base.CommandBase): def __init__(self, host): super(Get, self).__init__( host, "get", use_verbose=True, help=_("retrieve avatar of an entity") ) def add_parser_options(self): self.parser.add_argument( "--no-cache", action="store_true", help=_("do no use cached values") ) self.parser.add_argument( "-s", "--show", action="store_true", help=_("show avatar") ) self.parser.add_argument("jid", nargs='?', default='', help=_("entity")) async def show_image(self, path): sat_conf = config.parse_main_conf() cmd = config.config_get(sat_conf, C.CONFIG_SECTION, "image_cmd") cmds = [cmd] + DISPLAY_CMD if cmd else DISPLAY_CMD for cmd in cmds: try: process = await asyncio.create_subprocess_exec(cmd, path) ret = await process.wait() except OSError: continue if ret in (0, 2): # we can get exit code 2 with display when stopping it with C-c break else: # didn't worked with commands, we try our luck with webbrowser # in some cases, webbrowser can actually open the associated display program. # Note that this may be possibly blocking, depending on the platform and # available browser import webbrowser webbrowser.open(path) async def start(self): try: avatar_data_raw = await self.host.bridge.avatar_get( self.args.jid, not self.args.no_cache, self.profile, ) except Exception as e: self.disp(f"can't retrieve avatar: {e}", error=True) self.host.quit(C.EXIT_BRIDGE_ERRBACK) avatar_data = data_format.deserialise(avatar_data_raw, type_check=None) if not avatar_data: self.disp(_("No avatar found."), 1) self.host.quit(C.EXIT_NOT_FOUND) avatar_path = avatar_data['path'] self.disp(avatar_path) if self.args.show: await self.show_image(avatar_path) self.host.quit() class Set(base.CommandBase): def __init__(self, host): super(Set, self).__init__( host, "set", use_verbose=True, help=_("set avatar of the profile or an entity") ) def add_parser_options(self): self.parser.add_argument( "-j", "--jid", default='', help=_("entity whose avatar must be changed")) self.parser.add_argument( "image_path", type=str, help=_("path to the image to upload") ) async def start(self): path = self.args.image_path if not os.path.exists(path): self.disp(_("file {path} doesn't exist!").format(path=repr(path)), error=True) self.host.quit(C.EXIT_BAD_ARG) path = os.path.abspath(path) try: await self.host.bridge.avatar_set(path, self.args.jid, self.profile) except Exception as e: self.disp(f"can't set avatar: {e}", error=True) self.host.quit(C.EXIT_BRIDGE_ERRBACK) else: self.disp(_("avatar has been set"), 1) self.host.quit() class Avatar(base.CommandBase): subcommands = (Get, Set) def __init__(self, host): super(Avatar, self).__init__( host, "avatar", use_profile=False, help=_("avatar uploading/retrieving") )