Mercurial > prosody-modules

annotate mod_carbons/mod_carbons.lua @ 835:07cc1efde2f8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_carbons: Fix handling of messages from remote hosts
author Kim Alvefur <zash@zash.se>
date Wed, 19 Sep 2012 16:36:32 +0200
parents 30d49c26d219
children a86131581180
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
521
6d0d2673f95e mod_carbons: Add MIT license statement.
Kim Alvefur <zash@zash.se>
parents: 520
diff changeset
1 -- XEP-0280: Message Carbons implementation for Prosody
6d0d2673f95e mod_carbons: Add MIT license statement.
Kim Alvefur <zash@zash.se>
parents: 520
diff changeset
2 -- Copyright (C) 2011 Kim Alvefur
6d0d2673f95e mod_carbons: Add MIT license statement.
Kim Alvefur <zash@zash.se>
parents: 520
diff changeset
3 --
6d0d2673f95e mod_carbons: Add MIT license statement.
Kim Alvefur <zash@zash.se>
parents: 520
diff changeset
4 -- This file is MIT/X11 licensed.
6d0d2673f95e mod_carbons: Add MIT license statement.
Kim Alvefur <zash@zash.se>
parents: 520
diff changeset
5
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 local st = require "util.stanza";
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 local jid_bare = require "util.jid".bare;
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 local xmlns_carbons = "urn:xmpp:carbons:1";
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 local xmlns_forward = "urn:xmpp:forward:0";
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 local host_sessions = hosts[module.host].sessions;
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
11 local full_sessions, bare_sessions = full_sessions, bare_sessions;
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12
804
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
13 local function toggle_carbons(event)
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 local origin, stanza = event.origin, event.stanza;
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 if stanza.attr.type == "set" then
804
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
16 local state = stanza.tags[1].name;
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
17 module:log("debug", "%s %sd carbons", origin.full_jid, state);
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
18 origin.want_carbons = state == "enable";
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 origin.send(st.reply(stanza));
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 return true
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 end
804
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
22 end
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
23 module:hook("iq/self/"..xmlns_carbons..":disable", toggle_carbons);
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
24 module:hook("iq/self/"..xmlns_carbons..":enable", toggle_carbons);
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
26 local function message_handler(event, c2s)
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 local origin, stanza = event.origin, event.stanza;
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 local orig_type = stanza.attr.type;
835
07cc1efde2f8 mod_carbons: Fix handling of messages from remote hosts
Kim Alvefur <zash@zash.se>
parents: 833
diff changeset
29 local orig_from = stanza.attr.from;
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 local orig_to = stanza.attr.to;
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 if not (orig_type == nil
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 or orig_type == "normal"
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 or orig_type == "chat") then
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
35 return -- No carbons for messages of type error or headline
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 end
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
38 -- Stanza sent by a local client
835
07cc1efde2f8 mod_carbons: Fix handling of messages from remote hosts
Kim Alvefur <zash@zash.se>
parents: 833
diff changeset
39 local bare_jid = origin.type == "c2s" and origin.username .. "@" .. origin.host or jid_bare(orig_from);
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
40 local target_session = origin;
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
41 local top_priority = false;
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
42 local user_sessions = host_sessions[origin.username];
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
43
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
44 -- Stanza about to be delivered to a local client
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
45 if not c2s then
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
46 bare_jid = jid_bare(orig_to);
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
47 target_session = full_sessions[orig_to]
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
48 user_sessions = bare_sessions[bare_jid];
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
49 if not target_session and user_sessions then
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
50 -- The top resources will already receive this message per normal routing rules,
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
51 -- so we are going to skip them in order to avoid sending duplicated messages.
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
52 local top_resources = user_sessions.top_resources;
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
53 top_priority = top_resources and top_resources[1].priority
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
54 end
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
55 end
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
56
585
ce2798a1bc56 mod_carbons: Don't try to send carbons for entirely offline users.
Kim Alvefur <zash@zash.se>
parents: 545
diff changeset
57 if not user_sessions then
605
5175f6d33470 mod_carbons: Add more debug logging
Kim Alvefur <zash@zash.se>
parents: 585
diff changeset
58 module:log("debug", "Skip carbons for offline user");
585
ce2798a1bc56 mod_carbons: Don't try to send carbons for entirely offline users.
Kim Alvefur <zash@zash.se>
parents: 545
diff changeset
59 return -- No use in sending carbons to an offline user
ce2798a1bc56 mod_carbons: Don't try to send carbons for entirely offline users.
Kim Alvefur <zash@zash.se>
parents: 545
diff changeset
60 end
ce2798a1bc56 mod_carbons: Don't try to send carbons for entirely offline users.
Kim Alvefur <zash@zash.se>
parents: 545
diff changeset
61
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
62 if not c2s and stanza:get_child("private", xmlns_carbons) then
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
63 stanza:maptags(function(tag)
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
64 return tag.attr.xmlns == xmlns_carbons
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
65 and tag.name == "private" and tag or nil;
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
66 end);
605
5175f6d33470 mod_carbons: Add more debug logging
Kim Alvefur <zash@zash.se>
parents: 585
diff changeset
67 module:log("debug", "Message tagged private, ignoring");
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
68 return
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
69 end
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
70
832
9087431d35f6 mod_carbons: Add comments and rename some variables to make it clearer
Kim Alvefur <zash@zash.se>
parents: 804
diff changeset
71 -- Create the carbon copy and wrap it as per the Stanza Forwarding XEP
9087431d35f6 mod_carbons: Add comments and rename some variables to make it clearer
Kim Alvefur <zash@zash.se>
parents: 804
diff changeset
72 local copy = st.clone(stanza);
9087431d35f6 mod_carbons: Add comments and rename some variables to make it clearer
Kim Alvefur <zash@zash.se>
parents: 804
diff changeset
73 copy.attr.xmlns = "jabber:client";
9087431d35f6 mod_carbons: Add comments and rename some variables to make it clearer
Kim Alvefur <zash@zash.se>
parents: 804
diff changeset
74 local carbon = st.message{ from = bare_jid, type = orig_type, }
664
2f11d2473afd mod_carbons: Move creation of the carbon stanza out of the loop.
Kim Alvefur <zash@zash.se>
parents: 618
diff changeset
75 :tag(c2s and "sent" or "received", { xmlns = xmlns_carbons }):up()
2f11d2473afd mod_carbons: Move creation of the carbon stanza out of the loop.
Kim Alvefur <zash@zash.se>
parents: 618
diff changeset
76 :tag("forwarded", { xmlns = xmlns_forward })
832
9087431d35f6 mod_carbons: Add comments and rename some variables to make it clearer
Kim Alvefur <zash@zash.se>
parents: 804
diff changeset
77 :add_child(copy):reset();
664
2f11d2473afd mod_carbons: Move creation of the carbon stanza out of the loop.
Kim Alvefur <zash@zash.se>
parents: 618
diff changeset
78
618
267548522810 mod_carbons: Remove useless protection against loop that can't happen
Kim Alvefur <zash@zash.se>
parents: 617
diff changeset
79 user_sessions = user_sessions and user_sessions.sessions;
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
80 for _, session in pairs(user_sessions) do
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
81 -- Carbons are sent to resources that have enabled it
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
82 if session.want_carbons
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
83 -- but not the resource that sent the message, or the one that it's directed to
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
84 and session ~= target_session
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
85 -- and isn't among the top resources that would receive the message per standard routing rules
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
86 and (not c2s or session.priority ~= top_priority) then
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
87 carbon.attr.to = session.full_jid;
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
88 module:log("debug", "Sending carbon to %s", session.full_jid);
832
9087431d35f6 mod_carbons: Add comments and rename some variables to make it clearer
Kim Alvefur <zash@zash.se>
parents: 804
diff changeset
89 session.send(carbon);
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
90 end
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
91 end
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
92 end
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
93
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
94 local function c2s_message_handler(event)
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
95 return message_handler(event, true)
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
96 end
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
97
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
98 -- Stanzas sent by local clients
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
99 module:hook("pre-message/bare", c2s_message_handler, 1);
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
100 module:hook("pre-message/full", c2s_message_handler, 1);
510
59e80326f2b3 mod_carbons: Fix a typo and unindent a line.
Kim Alvefur <zash@zash.se>
parents: 480
diff changeset
101 -- Stanzas to local clients
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
102 module:hook("message/bare", message_handler, 1);
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
103 module:hook("message/full", message_handler, 1);
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
104
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
105 module:add_feature(xmlns_carbons);