Mercurial > prosody-modules
view mod_muc_bot/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 | 9cbdb60e21f2 |
| children | 55cf7f063af6 |
line wrap: on
line source
--- summary: Module for improving the life of bot authors --- This module makes it easier to write MUC bots by removing the requirement that the bot be online and joined to the room. All the bot needs to do is send a message and this module handles the rest. # Configuration Example configuration in Prosody: ```lua Component "muc.example.com" "muc" modules_enabled = { "muc_bot", } known_bots = { "bot@example.com" } bots_get_messages = false ignore_bot_errors = true ``` # Sending messages Simply send a stanza like this from your bot: ```xml <message type="groupchat" to="channel@muc.example.com"> <body>Beep boop, I'm a bot!</body> <nick xmlns="http://jabber.org/protocol/nick">Botty</nick> </message> ``` ## Use with mod_rest Using [mod_rest] to interact with MUC suffers from the same need to join with an online resource, so this module helps with that as well! ```bash curl https://xmpp.example.com/rest/message/groupchat/room@muc.example.com \ -d body="beep boop" \ -d nick="Botty" ``` # Compatibility Prosody **trunk** required.