annotate mod_pep_vcard_png_avatar/README.markdown @ 4651:8231774f5bfd

mod_cloud_notify_encrypted: Ensure body substring remains valid UTF-8 The `body:sub()` call risks splitting the string in the middle of a multi-byte UTF-8 sequence. This should have been caught by util.stanza validation, but that would have caused some havoc, at the very least causing the notification to not be sent. There have been no reports of this happening. Likely because this module isn't widely deployed among users with languages that use many longer UTF-8 sequences. The util.encodings.utf8.valid() function is O(n) where only the last sequence really needs to be checked, but it's in C and expected to be fast.
author Kim Alvefur <zash@zash.se>
date Sun, 22 Aug 2021 13:22:59 +0200
parents e6a3bdbce7b9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2218
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
1 Introduction
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
2 ============
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
3
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
4 Conversations (an XMPP client for Android) is publishing PEP avatars in the webp file format. However Pidgin and other XMPP desktop clients can only show vcard avatars, that are in the PNG file format. This module is the [mod_pep_vcard_avatar](https://modules.prosody.im/mod_pep_vcard_avatar.html) module extended to also change the avatar file format to PNG.
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
5
2496
e6a3bdbce7b9 mod_pep_vcard_png_avatar: Move to dwebp, handle errors on opening file_png.
Michel Le Bihan <michel@lebihan.pl>
parents: 2325
diff changeset
6 This module needs `dwebp` from `webp` package as an additional dependency.
2325
557dc366838e Add information about ImageMagick dependency
Michael Vetter <jubalh@openmailbox.org>
parents: 2218
diff changeset
7
2218
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
8 Configuration
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
9 =============
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
10
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
11 Enable the module as any other:
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
12
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
13 modules_enabled = {
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
14 "mod_pep_vcard_png_avatar";
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
15 }
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
16
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
17 You MUSTN'T load mod\_pep\_vcard\_avatar if this module is loaded.
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
18
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
19 Compatibility
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
20 =============
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
21
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
22 ----- -------------
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
23 trunk Works
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
24 0.10 Should work
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
25 0.9 Should work
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
26 ----- -------------
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
27
0ca0fdad3b2c mod_pep_vcard_png_avatar: Add a README
Michel Le Bihan <michel@lebihan.pl>
parents:
diff changeset
28