annotate sat_frontends/jp/cmd_uri.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 be6d91572633
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
1 #!/usr/bin/env python3
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
3
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
4 # jp: a SàT command line tool
3136
9d0df638c8b4 dates update
Goffi <goffi@goffi.org>
parents: 3040
diff changeset
5 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
6
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # This program is free software: you can redistribute it and/or modify
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
10 # (at your option) any later version.
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
11
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # This program is distributed in the hope that it will be useful,
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
15 # GNU Affero General Public License for more details.
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
16
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
19
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
20
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
21 from . import base
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
22 from sat.core.i18n import _
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
23 from sat_frontends.jp.constants import Const as C
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
24 from sat.tools.common import uri
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
25
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
26 __commands__ = ["Uri"]
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
27
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
28
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
29 class Parse(base.CommandBase):
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
30 def __init__(self, host):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
31 base.CommandBase.__init__(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
32 self,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
33 host,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
34 "parse",
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
35 use_profile=False,
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
36 use_output=C.OUTPUT_DICT,
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
37 help=_("parse URI"),
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
38 )
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
39
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
40 def add_parser_options(self):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
41 self.parser.add_argument(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
42 "uri", help=_("XMPP URI to parse")
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
43 )
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
44
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
45 async def start(self):
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
46 await self.output(uri.parseXMPPUri(self.args.uri))
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
47 self.host.quit()
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
48
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
49
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
50 class Build(base.CommandBase):
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
51 def __init__(self, host):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
52 base.CommandBase.__init__(
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
53 self, host, "build", use_profile=False, help=_("build URI")
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
54 )
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
55
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
56 def add_parser_options(self):
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
57 self.parser.add_argument("type", help=_("URI type"))
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
58 self.parser.add_argument("path", help=_("URI path"))
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
59 self.parser.add_argument(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
60 "-f",
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
61 "--field",
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
62 action="append",
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
63 nargs=2,
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
64 dest="fields",
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
65 metavar=("KEY", "VALUE"),
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
66 help=_("URI fields"),
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
67 )
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
68
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
69 async def start(self):
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
70 fields = dict(self.args.fields) if self.args.fields else {}
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
71 self.disp(uri.buildXMPPUri(self.args.type, path=self.args.path, **fields))
3040
fee60f17ebac jp: jp asyncio port:
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
72 self.host.quit()
2240
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
73
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
74
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
75 class Uri(base.CommandBase):
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
76 subcommands = (Parse, Build)
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
77
4b66f070cfbb jp (uri): new command to parse or generate XMPP URIs
Goffi <goffi@goffi.org>
parents:
diff changeset
78 def __init__(self, host):
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
79 super(Uri, self).__init__(
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
80 host, "uri", use_profile=False, help=_("XMPP URI parsing/generation")
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
81 )