Mercurial > libervia-backend
view doc/libervia-cli/pubsub_hook.rst @ 3888:aa7197b67c26
component AP gateway: AP <=> XMPP reactions conversions:
- Pubsub Attachments plugin has been renamed to XEP-0470 following publication
- XEP-0470 has been updated to follow 0.2 changes
- AP reactions (as implemented in Pleroma) are converted to XEP-0470
- XEP-0470 events are converted to AP reactions (again, using "EmojiReact" from Pleroma)
- AP activities related to attachments (like/reactions) are cached in Libervia because
it's not possible to retrieve them from Pleroma instances once they have been emitted
(doing an HTTP get on their ID returns a 404). For now those cache are not flushed, this
should be improved in the future.
- `sharedInbox` is used when available. Pleroma returns a 500 HTTP error when ``to`` or
``cc`` are used in a direct inbox.
- reactions and like are not currently used for direct messages, because they can't be
emitted from Pleroma in this case, thus there is no point in implementing them for the
moment.
rel 371
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 31 Aug 2022 17:07:03 +0200 |
parents | 21e7d46b988c |
children |
line wrap: on
line source
.. _libervia-cli_pubsub_hook: ==================================== pubsub/hook: PubSub hooks management ==================================== ``hook`` is a subcommand grouping all PubSub commands related to hooks management. Hooks are user actions launched on specific events. 3 types of hooks can be used: ``python`` A Python module is expected as argument. The module must be available in Python path, and it must have a ``hook`` function. ``python_file`` A path to a Python script is expected as argument. The script must contain a ``hook`` function. ``python_code`` Python code which will be directly executed. 3 variables will be set: ``host`` which contain the main Libervia instance, ``client`` which contain the session attached to the profile, and ``item`` which contain the item attached to the event. .. note:: Hooks are executed in Libervia context, and must be asynchronous. If they block, the whole Libervia execution will be blocked. They have access to everything, so don't run a code that you don't absolutely trust. .. note:: Only ``python_file`` type is currently implemented .. note:: Hook is an experimental feature, the way to use it may change in the future. create ====== Create a hook of given type. Type is specified with ``-t {python,python_file,python_code}, --type {python,python_file,python_code}`` and a positional arguments is expected, which depends on the chosen type. By default the hook is temporary (it will be lost if the profile is disconnected), but you can make is persistent accross reconnexions if you use the ``-P, --persistent`` argument. example ------- Install a persistent hook on blog node, using the Python script named ``do_something_neat.py`` in ``$HOME`` directory:: $ li pubsub node hook create -n urn:xmpp:microblog:0 -t python_file --persistent ~/do_something_neat.py delete ====== Delete one hook or all of them. To delete a hook, specify its type and argument (the that you have used with ``create``). If you use empty ``--type`` and ``--arg`` all hooks will be removed. example ------- Delete the ``do_something_neat.py`` hook:: $ li pubsub node hook delete -n urn:xmpp:microblog:0 -t python_file --arg ~/do_something_neat.py list ==== List registered hooks. The output will give the following informations: service PubSub service on which the hook is attached. node PubSub node on which the hook is attached. type hook type arg hook arguments (dependant of hook type) persistent boolean indicating is the hook persist accross sessions. example ------- Get PubSub hooks registered for this profile in JSON:: $ li pubsub hook list -O json