88072e0453
/!\ 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`
47 lines
1.6 KiB
ReStructuredText
47 lines
1.6 KiB
ReStructuredText
===============================
|
|
avatar: retrieve/upload avatars
|
|
===============================
|
|
|
|
Avatars are images associated to an XMPP entity. Several XMPP extensions are in use, SàT
|
|
tries to hide the technical details so avatar are as easy as possible to manipulate for
|
|
end-user.
|
|
|
|
get
|
|
===
|
|
|
|
Retrieve the avatar of the given entity. Entity jid is specified as positional argument.
|
|
|
|
If an avatar is found, a path to its cached file is printed. Please note that this is the
|
|
cache used by all SàT ecosystem, **do not modify the cached image**. You may use it for
|
|
read-only access, or copy it if you want to modify the image.
|
|
|
|
You may use the ``-s, --show`` argument to display the found avatar. The software used to
|
|
display the image can be specified in SàT configuration (cf. :ref:`configuration`), in the
|
|
``[jp]`` section: the ``image_cmd`` setting let you specify the path to the software. If
|
|
``image_cmd`` is not used, ``jp`` will try some common software, and if none is found, it
|
|
will try to open the image in a browser (which may sometimes result in using the default
|
|
image software of the platform).
|
|
|
|
When available, cached avatar is returned by defaut. If you want to ignore the cache, use
|
|
the ``--no-cache`` option (of course this can result in more network requests).
|
|
|
|
example
|
|
-------
|
|
|
|
Get the avatar of ``louise@example.org`` and display it::
|
|
|
|
$ jp avatar get --show louise@example.org
|
|
|
|
|
|
set
|
|
===
|
|
|
|
Upload and set the given avatar for the profile. The only required argument is the path to
|
|
the image to use as avatar.
|
|
|
|
example
|
|
-------
|
|
|
|
Set the avatar of the default profile::
|
|
|
|
$ jp avatar set ~/photos/some_photo.jpg
|