Mercurial > prosody-modules

view mod_ogp/README.markdown @ 4477:8df6cc648963

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Add more REST-looking way to send stanzas Example: POST /rest/message/chat/juliet@example.net { body: "Hello" } Becomes equivalent to POST /rest { kind: "message", type: "chat", to: "juliet@example.net", body: "Hello" } Sending messages as plain/text also becomes more convenient. IQ stazas are still weird, but we'll do something special for those.
author Kim Alvefur <zash@zash.se>
date Sun, 28 Feb 2021 19:25:45 +0100
parents 205e50fdcebc
children c4f11a4b5ac7
line wrap: on
line source

# mod_ogp

This module adds [Open Graph Protocol](https://ogp.me) metadata to URLs sent inside a MUC.

With mod_ogp enabled, when a user sends a URL in a MUC (where the message has its `id` equal to its `origin-id`), the module calls the URL and parses the result for `<meta>` html tags that have any `og:...` properties.
If it finds any, it sends a [XEP-0422 fastening](https://xmpp.org/extensions/xep-0422.html) applied to the original message that looks like:

```
    <message id="example" from="chatroom@chatservice.example" to="chatroom@chatservice.example">
        <apply-to xmlns="urn:xmpp:fasten:0" id="origin-id-X">
            <meta xmlns="http://www.w3.org/1999/xhtml" property="og:title" content="The Rock"/>
            <meta xmlns="http://www.w3.org/1999/xhtml" property="og:url" content="https://www.imdb.com/title/tt0117500/"/>
            <meta xmlns="http://www.w3.org/1999/xhtml" property="og:image" content="https://ia.media-imdb.com/images/rock.jpg"/>
        </apply-to>
    </message>
```

The module is intentionally simple in the sense that it is basically a transport for https://ogp.me/