poezio/plugins/embed.py

"""
Display an image URL as an embedded image in some clients like Conversations.
Uses: https://xmpp.org/extensions/xep-0066.html#x-oob

Usage
-----

.. glossary::

    /embed <image_url>

        Run this command to send the <image_url> as an
        embedded image in your contact's client.
"""

from poezio import tabs
from poezio.plugin import BasePlugin
from poezio.theming import get_theme
from poezio.ui.types import Message


class Plugin(BasePlugin):
    def init(self):
        for tab_t in [tabs.MucTab, tabs.StaticConversationTab, tabs.DynamicConversationTab, tabs.PrivateTab]:
            self.api.add_tab_command(
                tab_t,
                'embed',
                self.embed_image_url,
                help='Embed an image url into the contact\'s client',
                usage='<image_url>')

    def embed_image_url(self, url, tab=None):
        tab = tab or self.api.current_tab()
        message = self.core.xmpp.make_message(tab.jid)
        message['body'] = url
        message['oob']['url'] = url
        message['type'] = 'groupchat'
        if not isinstance(tab, tabs.MucTab):
            message['type'] = 'chat'
            tab.add_message(
                Message(
                    message['body'],
                    nickname=tab.core.own_nick,
                    nick_color=get_theme().COLOR_OWN_NICK,
                    identifier=message['id'],
                    jid=tab.core.xmpp.boundjid,
                ),
            )
        message.send()
        self.core.refresh_window()