| author | Matthew Wild <mwild1@gmail.com> |
| Sat, 24 Sep 2022 09:26:26 +0100 | |
| changeset 5063 | 5f1120c284c5 |
| parent 4105 | 0e1e775bdea0 |
| permissions | -rw-r--r-- |
|
4104
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
1 |
--- |
|
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
2 |
labels: |
|
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
3 |
- 'Stage-Alpha' |
|
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
4 |
summary: 'Experimental module to add metadata to media in MUCs' |
|
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
5 |
... |
|
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
6 |
|
|
3686
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 |
# Introduction |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 |
|
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 |
This module adds additional metadata to media shared in a MUC. This can help clients |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 |
make decisions and provide better UI and enhanced privacy, by knowing things like file |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 |
size without needing to make external network requests. |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 |
|
|
4105
0e1e775bdea0
mod_muc_media_metadata: Bootstrap warning box
Kim Alvefur <zash@zash.se>
parents:
4104
diff
changeset
|
13 |
::: {.alert .alert-danger} |
|
4104
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
14 |
**NOTE:** This is an experimental module. It is not supported by any |
|
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
15 |
clients, and therefore is mainly of interest to client developers who |
|
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
16 |
wish to explore the idea. |
|
4105
0e1e775bdea0
mod_muc_media_metadata: Bootstrap warning box
Kim Alvefur <zash@zash.se>
parents:
4104
diff
changeset
|
17 |
::: |
|
4104
20d436a1028d
mod_muc_media_metadata: Add alpha tag and experimental warning
Matthew Wild <mwild1@gmail.com>
parents:
3691
diff
changeset
|
18 |
|
|
3686
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 |
# Configuring |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 |
|
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 |
## Enabling |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 |
|
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 |
``` {.lua} |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 |
Component "rooms.example.net" "muc" |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 |
modules_enabled = { |
|
3688
0f3cb1247682
mod_muc_media_metadata: Fix example config
Matthew Wild <mwild1@gmail.com>
parents:
3687
diff
changeset
|
26 |
"muc_media_metadata"; |
|
3686
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 |
} |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 |
``` |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 |
|
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 |
## Settings |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 |
|
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 |
There are no configuration options for this module. |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 |
|
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
34 |
# Developers |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
35 |
|
|
3691
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
36 |
## Example stanzas |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
37 |
|
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
38 |
A normal message in a chatroom containing an image: |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
39 |
|
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
40 |
``` |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
41 |
<message from="test@rooms.example.com/matthew" id="9f45a784-5e5b-4db5-a9b3-8ea1d7c1162d" type="groupchat"> |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
42 |
<body>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</body> |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
43 |
<x xmlns="jabber:x:oob"> |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
44 |
<url>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</url> |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
45 |
</x> |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
46 |
</message> |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
47 |
``` |
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
48 |
|
|
c40422cca3b7
mod_muc_media_metadata: Include original message stanza example
Matthew Wild <mwild1@gmail.com>
parents:
3690
diff
changeset
|
49 |
The same stanza with this module loaded now contains additional metadata added by the server: |
|
3686
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
50 |
|
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
51 |
``` |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
52 |
<message from="test@rooms.example.com/matthew" id="9f45a784-5e5b-4db5-a9b3-8ea1d7c1162d" type="groupchat"> |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
53 |
<body>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</body> |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
54 |
<x xmlns="jabber:x:oob"> |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
55 |
<url>https://matthewwild.co.uk/share.php/70334772-ff74-439b-8173-a71e40ca28db/mam-flow.png</url> |
|
3690
2573d143621f
mod_muc_media_metadata: Update namespace
Matthew Wild <mwild1@gmail.com>
parents:
3688
diff
changeset
|
56 |
<metadata xmlns="xmpp:prosody.im/protocol/media-metadata#0"> |
|
3686
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
57 |
<bytes>15690</bytes> |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
58 |
<type>image/png</type> |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
59 |
<blurhash>LEHV6nWB2yk8pyo0adR*.7kCMdnj</blurhash> |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
60 |
</metadata> |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
61 |
</x> |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
62 |
</message> |
|
47e1c94fb6fb
mod_muc_media_metadata: Module to automatically fetch metadata for posted media
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
63 |
``` |