prosody-modules
0ef11dee7050
mod_carbons/mod_carbons.lua

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_carbons/mod_carbons.lua @ 837:0ef11dee7050

mod_carbons: Fix logic, top resources should only be excluded for incoming messages
author Kim Alvefur <zash@zash.se>
date Sat, 22 Sep 2012 02:06:21 +0200
parent 836:a86131581180
child 850:0900ba54991e
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";
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
10 local full_sessions, bare_sessions = full_sessions, bare_sessions;
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
804
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
12 local function toggle_carbons(event)
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 local origin, stanza = event.origin, event.stanza;
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 if stanza.attr.type == "set" then
804
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
15 local state = stanza.tags[1].name;
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
16 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
17 origin.want_carbons = state == "enable";
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 origin.send(st.reply(stanza));
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 return true
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 end
804
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
21 end
9927d88a1b2a mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents: 743
diff changeset
22 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
23 module:hook("iq/self/"..xmlns_carbons..":enable", toggle_carbons);
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
25 local function message_handler(event, c2s)
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 local origin, stanza = event.origin, event.stanza;
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 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
28 local orig_from = stanza.attr.from;
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 local orig_to = stanza.attr.to;
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31 if not (orig_type == nil
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 or orig_type == "normal"
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33 or orig_type == "chat") then
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
34 return -- No carbons for messages of type error or headline
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35 end
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
37 -- Stanza sent by a local client
836
a86131581180 mod_carbons: Less complicated assignments (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 835
diff changeset
38 local bare_jid = jid_bare(orig_from);
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
39 local target_session = origin;
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
40 local top_priority = false;
836
a86131581180 mod_carbons: Less complicated assignments (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 835
diff changeset
41 local user_sessions = bare_sessions[bare_jid];
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
42
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
43 -- 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
44 if not c2s then
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
45 bare_jid = jid_bare(orig_to);
836
a86131581180 mod_carbons: Less complicated assignments (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 835
diff changeset
46 target_session = full_sessions[orig_to];
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
47 user_sessions = bare_sessions[bare_jid];
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
48 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
49 -- 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
50 -- 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
51 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
52 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
53 end
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
54 end
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
55
585
ce2798a1bc56 mod_carbons: Don't try to send carbons for entirely offline users.
Kim Alvefur <zash@zash.se>
parents: 545
diff changeset
56 if not user_sessions then
605
5175f6d33470 mod_carbons: Add more debug logging
Kim Alvefur <zash@zash.se>
parents: 585
diff changeset
57 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
58 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
59 end
ce2798a1bc56 mod_carbons: Don't try to send carbons for entirely offline users.
Kim Alvefur <zash@zash.se>
parents: 545
diff changeset
60
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
61 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
62 stanza:maptags(function(tag)
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
63 return tag.attr.xmlns == xmlns_carbons
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
64 and tag.name == "private" and tag or nil;
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
65 end);
605
5175f6d33470 mod_carbons: Add more debug logging
Kim Alvefur <zash@zash.se>
parents: 585
diff changeset
66 module:log("debug", "Message tagged private, ignoring");
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
67 return
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
68 end
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
69
832
9087431d35f6 mod_carbons: Add comments and rename some variables to make it clearer
Kim Alvefur <zash@zash.se>
parents: 804
diff changeset
70 -- 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
71 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
72 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
73 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
74 :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
75 :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
76 :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
77
618
267548522810 mod_carbons: Remove useless protection against loop that can't happen
Kim Alvefur <zash@zash.se>
parents: 617
diff changeset
78 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
79 for _, session in pairs(user_sessions) do
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
80 -- 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
81 if session.want_carbons
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
82 -- 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
83 and session ~= target_session
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
84 -- and isn't among the top resources that would receive the message per standard routing rules
837
0ef11dee7050 mod_carbons: Fix logic, top resources should only be excluded for incoming messages
Kim Alvefur <zash@zash.se>
parents: 836
diff changeset
85 and (c2s or session.priority ~= top_priority) then
833
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
86 carbon.attr.to = session.full_jid;
30d49c26d219 mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents: 832
diff changeset
87 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
88 session.send(carbon);
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
89 end
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
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
93 local function c2s_message_handler(event)
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
94 return message_handler(event, true)
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
95 end
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
96
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
97 -- Stanzas sent by local clients
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
98 module:hook("pre-message/bare", c2s_message_handler, 1);
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
99 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
100 -- Stanzas to local clients
480
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
101 module:hook("message/bare", message_handler, 1);
0cef5be669de mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents: 463
diff changeset
102 module:hook("message/full", message_handler, 1);
462
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
103
f28a3f260fc2 mod_carbons: Initial commit.
Kim Alvefur <zash@zash.se>
parents:
diff changeset
104 module:add_feature(xmlns_carbons);