Software `/` code `/` prosody-modules

Annotate

mod_vcard_muc/mod_vcard_muc.lua @ 5691:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.

author	Kim Alvefur <zash@zash.se>
date	Fri, 06 Oct 2023 18:34:39 +0200
parent	5290:dddac5a3f447
child	5927:6fb26b6691c0

rev	line source
3043 6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	1 -- Prosody IM
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	2 -- Copyright (C) 2008-2010 Matthew Wild
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	3 -- Copyright (C) 2008-2010 Waqas Hussain
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	4 -- Copyright (C) 2018 Michel Le Bihan
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	5 --
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	6 -- This project is MIT/X11 licensed. Please see the
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	7 -- COPYING file in the source package for more information.
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	8 --
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	9
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	10 local st = require "util.stanza"
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	11 local jid_split = require "util.jid".split;
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	12 local base64 = require"util.encodings".base64;
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	13 local sha1 = require"util.hashes".sha1;
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	14
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	15 local mod_muc = module:depends"muc";
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	16
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	17 local vcards = module:open_store();
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	18
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	19 module:add_feature("vcard-temp");
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	20
3077 f16b021e8a61 mod_vcard_muc: Get room from rooms table when get_room_from_jid API is not supported Michel Le Bihan <michel@lebihan.pl> parents: 3046 diff changeset	21 local get_room_from_jid = rawget(mod_muc, "get_room_from_jid") or
f16b021e8a61 mod_vcard_muc: Get room from rooms table when get_room_from_jid API is not supported Michel Le Bihan <michel@lebihan.pl> parents: 3046 diff changeset	22 function (jid)
f16b021e8a61 mod_vcard_muc: Get room from rooms table when get_room_from_jid API is not supported Michel Le Bihan <michel@lebihan.pl> parents: 3046 diff changeset	23 local rooms = rawget(mod_muc, "rooms");
f16b021e8a61 mod_vcard_muc: Get room from rooms table when get_room_from_jid API is not supported Michel Le Bihan <michel@lebihan.pl> parents: 3046 diff changeset	24 return rooms[jid];
f16b021e8a61 mod_vcard_muc: Get room from rooms table when get_room_from_jid API is not supported Michel Le Bihan <michel@lebihan.pl> parents: 3046 diff changeset	25 end
f16b021e8a61 mod_vcard_muc: Get room from rooms table when get_room_from_jid API is not supported Michel Le Bihan <michel@lebihan.pl> parents: 3046 diff changeset	26
3655 d7b589dec591 mod_vcard_muc: Factor out avatar hash retrieval into a function for easier reuse Kim Alvefur <zash@zash.se> parents: 3077 diff changeset	27 local function get_photo_hash(room)
d7b589dec591 mod_vcard_muc: Factor out avatar hash retrieval into a function for easier reuse Kim Alvefur <zash@zash.se> parents: 3077 diff changeset	28 local room_node = jid_split(room.jid);
3043 6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	29 local vcard = st.deserialize(vcards:get(room_node));
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	30 if vcard then
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	31 local photo = vcard:get_child("PHOTO");
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	32
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	33 if photo then
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	34 local photo_b64 = photo:get_child_text("BINVAL");
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	35 local photo_raw = photo_b64 and base64.decode(photo_b64);
3655 d7b589dec591 mod_vcard_muc: Factor out avatar hash retrieval into a function for easier reuse Kim Alvefur <zash@zash.se> parents: 3077 diff changeset	36 return sha1(photo_raw, true);
3043 6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	37 end
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	38 end
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	39
3655 d7b589dec591 mod_vcard_muc: Factor out avatar hash retrieval into a function for easier reuse Kim Alvefur <zash@zash.se> parents: 3077 diff changeset	40 end
d7b589dec591 mod_vcard_muc: Factor out avatar hash retrieval into a function for easier reuse Kim Alvefur <zash@zash.se> parents: 3077 diff changeset	41
4300 3f3b672b7616 mod_vcard_muc: Pass room object around instead of JID, hopefully fixing traceback Matthew Wild <mwild1@gmail.com> parents: 4043 diff changeset	42 local function broadcast_presence(room, to)
3656 3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	43 local photo_hash = get_photo_hash(room);
4300 3f3b672b7616 mod_vcard_muc: Pass room object around instead of JID, hopefully fixing traceback Matthew Wild <mwild1@gmail.com> parents: 4043 diff changeset	44 local presence_vcard = st.presence({to = to, from = room.jid})
3043 6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	45 :tag("x", { xmlns = "vcard-temp:x:update" })
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	46 :tag("photo"):text(photo_hash):up();
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	47
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	48 if to == nil then
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	49 room:broadcast_message(presence_vcard);
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	50 else
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	51 module:send(presence_vcard);
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	52 end
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	53 end
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	54
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	55 local function handle_vcard(event)
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	56 local session, stanza = event.origin, event.stanza;
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	57
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	58 local room_jid = stanza.attr.to;
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	59 local room_node = jid_split(room_jid);
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	60 local room = get_room_from_jid(room_jid);
4043 a533abe6ffd0 mod_vcard_muc: Fix #1414 issue with nil room being queried when a stanza with a nonexisting MUC localpart was sent Michel Le Bihan <michel@lebihan.pl> parents: 3656 diff changeset	61 if not room then
a533abe6ffd0 mod_vcard_muc: Fix #1414 issue with nil room being queried when a stanza with a nonexisting MUC localpart was sent Michel Le Bihan <michel@lebihan.pl> parents: 3656 diff changeset	62 session.send(st.error_reply(stanza, "cancel", "item-not-found"))
a533abe6ffd0 mod_vcard_muc: Fix #1414 issue with nil room being queried when a stanza with a nonexisting MUC localpart was sent Michel Le Bihan <michel@lebihan.pl> parents: 3656 diff changeset	63 return true;
a533abe6ffd0 mod_vcard_muc: Fix #1414 issue with nil room being queried when a stanza with a nonexisting MUC localpart was sent Michel Le Bihan <michel@lebihan.pl> parents: 3656 diff changeset	64 end
3043 6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	65
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	66 local from = stanza.attr.from;
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	67 local from_affiliation = room:get_affiliation(from);
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	68
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	69 if stanza.attr.type == "get" then
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	70 local vCard;
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	71 vCard = st.deserialize(vcards:get(room_node));
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	72
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	73 if vCard then
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	74 session.send(st.reply(stanza):add_child(vCard)); -- send vCard!
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	75 else
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	76 session.send(st.error_reply(stanza, "cancel", "item-not-found"));
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	77 end
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	78 else
5290 dddac5a3f447 mod_vcard_muc: take roles into account for access check Jonas Schäfer <jonas@wielicki.name> parents: 4300 diff changeset	79 if from_affiliation == "owner" or (module.may and module:may("muc:automatic-ownership", from)) then
3043 6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	80 if vcards:set(room_node, st.preserialize(stanza.tags[1])) then
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	81 session.send(st.reply(stanza):tag("vCard", { xmlns = "vcard-temp" }));
4300 3f3b672b7616 mod_vcard_muc: Pass room object around instead of JID, hopefully fixing traceback Matthew Wild <mwild1@gmail.com> parents: 4043 diff changeset	82 broadcast_presence(room, nil)
3656 3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	83
3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	84 room:broadcast_message(st.message({ from = room.jid, type = "groupchat" })
3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	85 :tag("x", { xmlns = "http://jabber.org/protocol/muc#user" })
3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	86 :tag("status", { code = "104" }));
3043 6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	87 else
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	88 -- TODO unable to write file, file may be locked, etc, what's the correct error?
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	89 session.send(st.error_reply(stanza, "wait", "internal-server-error"));
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	90 end
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	91 else
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	92 session.send(st.error_reply(stanza, "auth", "forbidden"));
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	93 end
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	94 end
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	95 return true;
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	96 end
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	97
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	98
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	99 module:hook("iq/bare/vcard-temp:vCard", handle_vcard);
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	100 module:hook("iq/host/vcard-temp:vCard", handle_vcard);
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	101
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	102 module:hook("muc-disco#info", function(event)
6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	103 event.reply:tag("feature", { var = "vcard-temp" }):up();
3656 3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	104
3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	105 table.insert(event.form, {
3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	106 name = "{http://modules.prosody.im/mod_vcard_muc}avatar#sha1",
3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	107 type = "text-single",
3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	108 });
3e0f4d727825 mod_vcard_muc: Add an alternative method of signaling avatar change Kim Alvefur <zash@zash.se> parents: 3655 diff changeset	109 event.formdata["{http://modules.prosody.im/mod_vcard_muc}avatar#sha1"] = get_photo_hash(event.room);
3043 6cc44e69443a mod_vcard_muc: Initial commit Michel Le Bihan <michel@lebihan.pl> parents: diff changeset	110 end);
3046 d0db28768980 mod_vcard_muc: Send presence on muc-occupant-session-new event Michel Le Bihan <michel@lebihan.pl> parents: 3043 diff changeset	111
d0db28768980 mod_vcard_muc: Send presence on muc-occupant-session-new event Michel Le Bihan <michel@lebihan.pl> parents: 3043 diff changeset	112 module:hook("muc-occupant-session-new", function(event)
4300 3f3b672b7616 mod_vcard_muc: Pass room object around instead of JID, hopefully fixing traceback Matthew Wild <mwild1@gmail.com> parents: 4043 diff changeset	113 broadcast_presence(event.room, event.jid);
3046 d0db28768980 mod_vcard_muc: Send presence on muc-occupant-session-new event Michel Le Bihan <michel@lebihan.pl> parents: 3043 diff changeset	114 end)

prosody-modules

ecfd7aece33b

mod_vcard_muc/mod_vcard_muc.lua

Software / code / prosody-modules

Annotate

mod_vcard_muc/mod_vcard_muc.lua @ 5691:ecfd7aece33b

Software `/` code `/` prosody-modules