Mercurial > libervia-backend
annotate sat_frontends/jp/cmd_identity.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 |
rev | line source |
---|---|
3137 | 1 #!/usr/bin/env python3 |
2 | |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 # jp: a SàT command line tool |
3136 | 5 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org) |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 # This program is free software: you can redistribute it and/or modify |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 # it under the terms of the GNU Affero General Public License as published by |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 # the Free Software Foundation, either version 3 of the License, or |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 # (at your option) any later version. |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 # This program is distributed in the hope that it will be useful, |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 # GNU Affero General Public License for more details. |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 # You should have received a copy of the GNU Affero General Public License |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
20 |
3028 | 21 from . import base |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
22 from sat.core.i18n import _ |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
23 from sat_frontends.jp.constants import Const as C |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
24 from sat.tools.common import data_format |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
25 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
26 __commands__ = ["Identity"] |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
27 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
28 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
29 class Get(base.CommandBase): |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
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 "get", |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
35 use_output=C.OUTPUT_DICT, |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
36 use_verbose=True, |
3028 | 37 help=_("get identity data"), |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
38 ) |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
39 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
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( |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
42 "--no-cache", action="store_true", help=_("do no use cached values") |
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
43 ) |
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
44 self.parser.add_argument( |
3028 | 45 "jid", help=_("entity to check") |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
46 ) |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
47 |
3040 | 48 async def start(self): |
49 jid_ = (await self.host.check_jids([self.args.jid]))[0] | |
50 try: | |
51 data = await self.host.bridge.identityGet( | |
52 jid_, | |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
53 [], |
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
54 not self.args.no_cache, |
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
55 self.profile |
3040 | 56 ) |
57 except Exception as e: | |
58 self.disp(f"can't get identity data: {e}", error=True) | |
59 self.host.quit(C.EXIT_BRIDGE_ERRBACK) | |
60 else: | |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
61 data = data_format.deserialise(data) |
3040 | 62 await self.output(data) |
63 self.host.quit() | |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
64 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
65 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
66 class Set(base.CommandBase): |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
67 def __init__(self, host): |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
68 super(Set, self).__init__(host, "set", help=_("update identity data")) |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
69 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
70 def add_parser_options(self): |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
71 self.parser.add_argument( |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
72 "-n", |
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
73 "--nickname", |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
74 action="append", |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
75 dest="nicknames", |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
76 required=True, |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
77 help=_("nicknames of the entity"), |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
78 ) |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
79 |
3040 | 80 async def start(self): |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
81 id_data = { |
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
82 "nicknames": self.args.nicknames, |
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
83 } |
3040 | 84 try: |
85 self.host.bridge.identitySet( | |
3254
6cf4bd6972c2
core, frontends: avatar refactoring:
Goffi <goffi@goffi.org>
parents:
3137
diff
changeset
|
86 data_format.serialise(id_data), |
3040 | 87 self.profile, |
88 ) | |
89 except Exception as e: | |
90 self.disp(f"can't set identity data: {e}", error=True) | |
91 self.host.quit(C.EXIT_BRIDGE_ERRBACK) | |
92 else: | |
93 self.host.quit() | |
2254
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
94 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
95 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
96 class Identity(base.CommandBase): |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
97 subcommands = (Get, Set) |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
98 |
6297817c3dc9
jp (identity): new identity command to handle the new plugin identity in backend, and maybe other plugins like vcard in the future
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
99 def __init__(self, host): |
2624
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
100 super(Identity, self).__init__( |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
101 host, "identity", use_profile=False, help=_("identity management") |
56f94936df1e
code style reformatting using black
Goffi <goffi@goffi.org>
parents:
2562
diff
changeset
|
102 ) |