annotate sat/__init__.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
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
1 #!/usr/bin/env python3
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
2571
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
3
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
4 # SàT: a XMPP client
3136
9d0df638c8b4 dates update
Goffi <goffi@goffi.org>
parents: 3028
diff changeset
5 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
2571
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
6
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
7 # This program is free software: you can redistribute it and/or modify
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
8 # it under the terms of the GNU Affero General Public License as published by
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
9 # the Free Software Foundation, either version 3 of the License, or
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
10 # (at your option) any later version.
1470
8bfbf5cb0e28 core: moved __version__ to __init__.py, so we can check version by doing "import sat;print(sat.__version__)"
Goffi <goffi@goffi.org>
parents: 224
diff changeset
11
2571
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
12 # This program is distributed in the hope that it will be useful,
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
15 # GNU Affero General Public License for more details.
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
16
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
17 # You should have received a copy of the GNU Affero General Public License
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
19 import os.path
4aca060075b7 setup: version is now set in SAT/VERSION, sat is not imported anymore in setup
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
20
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2607
diff changeset
21 version_file = os.path.join(os.path.dirname(__file__), "VERSION")
2607
4c086cf7af66 core (version): added workaround for Pyjamas, avoiding crash when reading VERSION
Goffi <goffi@goffi.org>
parents: 2571
diff changeset
22 try:
4c086cf7af66 core (version): added workaround for Pyjamas, avoiding crash when reading VERSION
Goffi <goffi@goffi.org>
parents: 2571
diff changeset
23 with open(version_file) as f:
4c086cf7af66 core (version): added workaround for Pyjamas, avoiding crash when reading VERSION
Goffi <goffi@goffi.org>
parents: 2571
diff changeset
24 __version__ = f.read().strip()
4c086cf7af66 core (version): added workaround for Pyjamas, avoiding crash when reading VERSION
Goffi <goffi@goffi.org>
parents: 2571
diff changeset
25 except NotImplementedError:
4c086cf7af66 core (version): added workaround for Pyjamas, avoiding crash when reading VERSION
Goffi <goffi@goffi.org>
parents: 2571
diff changeset
26 # pyjamas workaround
2665
20bf6887d1ed core: minor version fix for pyjamas workaround
Goffi <goffi@goffi.org>
parents: 2624
diff changeset
27 __version__ = "0.7.0D"