Software /
code /
prosody-modules
Annotate
mod_carbons/mod_carbons.lua @ 1183:3acb01ca7e5c
mod_carbons: Handle enabled/disable with the same callback for all versions
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 05 Sep 2013 01:00:08 +0200 |
parent | 1167:8ceab2331216 |
child | 1184:0d3d15586d7e |
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 | 6 local st = require "util.stanza"; |
7 local jid_bare = require "util.jid".bare; | |
850
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
8 local xmlns_carbons = "urn:xmpp:carbons:2"; |
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
9 local xmlns_carbons_old = "urn:xmpp:carbons:1"; |
884
2ece37bf9cc6
mod_carbons: Support the pre-forwarding version of Carbons. Please don't implement this.
Kim Alvefur <zash@zash.se>
parents:
854
diff
changeset
|
10 local xmlns_carbons_really_old = "urn:xmpp:carbons:0"; |
462 | 11 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
|
12 local full_sessions, bare_sessions = full_sessions, bare_sessions; |
462 | 13 |
804
9927d88a1b2a
mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents:
743
diff
changeset
|
14 local function toggle_carbons(event) |
462 | 15 local origin, stanza = event.origin, event.stanza; |
16 if stanza.attr.type == "set" then | |
1183
3acb01ca7e5c
mod_carbons: Handle enabled/disable with the same callback for all versions
Kim Alvefur <zash@zash.se>
parents:
1167
diff
changeset
|
17 local state = stanza.tags[1].attr.mode or stanza.tags[1].name; |
804
9927d88a1b2a
mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents:
743
diff
changeset
|
18 module:log("debug", "%s %sd carbons", origin.full_jid, state); |
850
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
19 origin.want_carbons = state == "enable" and stanza.tags[1].attr.xmlns; |
462 | 20 origin.send(st.reply(stanza)); |
21 return true | |
22 end | |
804
9927d88a1b2a
mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents:
743
diff
changeset
|
23 end |
9927d88a1b2a
mod_carbons: Merge enable and disable handlers
Kim Alvefur <zash@zash.se>
parents:
743
diff
changeset
|
24 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
|
25 module:hook("iq/self/"..xmlns_carbons..":enable", toggle_carbons); |
462 | 26 |
850
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
27 -- COMPAT |
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
28 module:hook("iq/self/"..xmlns_carbons_old..":disable", toggle_carbons); |
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
29 module:hook("iq/self/"..xmlns_carbons_old..":enable", toggle_carbons); |
1183
3acb01ca7e5c
mod_carbons: Handle enabled/disable with the same callback for all versions
Kim Alvefur <zash@zash.se>
parents:
1167
diff
changeset
|
30 module:hook("iq/self/"..xmlns_carbons_really_old..":carbons", toggle_carbons); |
884
2ece37bf9cc6
mod_carbons: Support the pre-forwarding version of Carbons. Please don't implement this.
Kim Alvefur <zash@zash.se>
parents:
854
diff
changeset
|
31 |
480
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
32 local function message_handler(event, c2s) |
462 | 33 local origin, stanza = event.origin, event.stanza; |
34 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
|
35 local orig_from = stanza.attr.from; |
462 | 36 local orig_to = stanza.attr.to; |
37 | |
38 if not (orig_type == nil | |
39 or orig_type == "normal" | |
40 or orig_type == "chat") then | |
480
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
41 return -- No carbons for messages of type error or headline |
462 | 42 end |
43 | |
833
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
44 -- Stanza sent by a local client |
836
a86131581180
mod_carbons: Less complicated assignments (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
835
diff
changeset
|
45 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
|
46 local target_session = origin; |
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
47 local top_priority = false; |
836
a86131581180
mod_carbons: Less complicated assignments (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
835
diff
changeset
|
48 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
|
49 |
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
50 -- 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
|
51 if not c2s then |
480
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
52 bare_jid = jid_bare(orig_to); |
836
a86131581180
mod_carbons: Less complicated assignments (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
835
diff
changeset
|
53 target_session = full_sessions[orig_to]; |
833
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
54 user_sessions = bare_sessions[bare_jid]; |
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
55 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
|
56 -- 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
|
57 -- 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
|
58 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
|
59 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
|
60 end |
462 | 61 end |
62 | |
585
ce2798a1bc56
mod_carbons: Don't try to send carbons for entirely offline users.
Kim Alvefur <zash@zash.se>
parents:
545
diff
changeset
|
63 if not user_sessions then |
605
5175f6d33470
mod_carbons: Add more debug logging
Kim Alvefur <zash@zash.se>
parents:
585
diff
changeset
|
64 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
|
65 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
|
66 end |
ce2798a1bc56
mod_carbons: Don't try to send carbons for entirely offline users.
Kim Alvefur <zash@zash.se>
parents:
545
diff
changeset
|
67 |
480
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
68 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
|
69 stanza:maptags(function(tag) |
1167
8ceab2331216
mod_carbons: Fix <private/> handling
Kim Alvefur <zash@zash.se>
parents:
1151
diff
changeset
|
70 if not ( tag.attr.xmlns == xmlns_carbons and tag.name == "private" ) then |
8ceab2331216
mod_carbons: Fix <private/> handling
Kim Alvefur <zash@zash.se>
parents:
1151
diff
changeset
|
71 return tag; |
8ceab2331216
mod_carbons: Fix <private/> handling
Kim Alvefur <zash@zash.se>
parents:
1151
diff
changeset
|
72 end |
480
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
73 end); |
605
5175f6d33470
mod_carbons: Add more debug logging
Kim Alvefur <zash@zash.se>
parents:
585
diff
changeset
|
74 module:log("debug", "Message tagged private, ignoring"); |
480
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
75 return |
1151
28d4b58bcc3b
mod_carbons: Add support for XEP-0334: Message Processing Hints
Kim Alvefur <zash@zash.se>
parents:
900
diff
changeset
|
76 elseif stanza:get_child("no-copy", "urn:xmpp:hints") then |
28d4b58bcc3b
mod_carbons: Add support for XEP-0334: Message Processing Hints
Kim Alvefur <zash@zash.se>
parents:
900
diff
changeset
|
77 module:log("debug", "Message has no-copy hint, ignoring"); |
28d4b58bcc3b
mod_carbons: Add support for XEP-0334: Message Processing Hints
Kim Alvefur <zash@zash.se>
parents:
900
diff
changeset
|
78 return |
480
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
79 end |
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
80 |
832
9087431d35f6
mod_carbons: Add comments and rename some variables to make it clearer
Kim Alvefur <zash@zash.se>
parents:
804
diff
changeset
|
81 -- 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
|
82 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
|
83 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
|
84 local carbon = st.message{ from = bare_jid, type = orig_type, } |
896
d24d87ca3f5f
mod_carbons: <forwarded/> should be nested in <sent/>/<received/>
Florian Zeitz <florob@babelmonkeys.de>
parents:
888
diff
changeset
|
85 :tag(c2s and "sent" or "received", { xmlns = xmlns_carbons }) |
664
2f11d2473afd
mod_carbons: Move creation of the carbon stanza out of the loop.
Kim Alvefur <zash@zash.se>
parents:
618
diff
changeset
|
86 :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
|
87 :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
|
88 |
850
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
89 -- COMPAT |
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
90 local carbon_old = st.message{ from = bare_jid, type = orig_type, } |
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
91 :tag(c2s and "sent" or "received", { xmlns = xmlns_carbons_old }):up() |
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
92 :tag("forwarded", { xmlns = xmlns_forward }) |
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
93 :add_child(copy):reset(); |
0900ba54991e
mod_carbons: Update to latest version of XEP-0280, while supporting the old version.
Kim Alvefur <zash@zash.se>
parents:
837
diff
changeset
|
94 |
884
2ece37bf9cc6
mod_carbons: Support the pre-forwarding version of Carbons. Please don't implement this.
Kim Alvefur <zash@zash.se>
parents:
854
diff
changeset
|
95 -- COMPAT |
2ece37bf9cc6
mod_carbons: Support the pre-forwarding version of Carbons. Please don't implement this.
Kim Alvefur <zash@zash.se>
parents:
854
diff
changeset
|
96 local carbon_really_old = st.clone(stanza) |
2ece37bf9cc6
mod_carbons: Support the pre-forwarding version of Carbons. Please don't implement this.
Kim Alvefur <zash@zash.se>
parents:
854
diff
changeset
|
97 :tag(c2s and "sent" or "received", { xmlns = xmlns_carbons_really_old }):up() |
2ece37bf9cc6
mod_carbons: Support the pre-forwarding version of Carbons. Please don't implement this.
Kim Alvefur <zash@zash.se>
parents:
854
diff
changeset
|
98 |
618
267548522810
mod_carbons: Remove useless protection against loop that can't happen
Kim Alvefur <zash@zash.se>
parents:
617
diff
changeset
|
99 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
|
100 for _, session in pairs(user_sessions) do |
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
101 -- 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
|
102 if session.want_carbons |
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
103 -- 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
|
104 and session ~= target_session |
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
105 -- and isn't among the top resources that would receive the message per standard routing rules |
888
f8d08f8ed7de
mod_carbons: Make support for v0 disabled by default, don't send v0 carbons for c2s
Michael Holzt <kju@fqdn.org>
parents:
884
diff
changeset
|
106 and (c2s or session.priority ~= top_priority) |
f8d08f8ed7de
mod_carbons: Make support for v0 disabled by default, don't send v0 carbons for c2s
Michael Holzt <kju@fqdn.org>
parents:
884
diff
changeset
|
107 -- don't send v0 carbons (or copies) for c2s |
f8d08f8ed7de
mod_carbons: Make support for v0 disabled by default, don't send v0 carbons for c2s
Michael Holzt <kju@fqdn.org>
parents:
884
diff
changeset
|
108 and (not c2s or session.want_carbons ~= xmlns_carbons_really_old) then |
833
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
109 carbon.attr.to = session.full_jid; |
30d49c26d219
mod_carbons: Optimize and clarify (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
832
diff
changeset
|
110 module:log("debug", "Sending carbon to %s", session.full_jid); |
884
2ece37bf9cc6
mod_carbons: Support the pre-forwarding version of Carbons. Please don't implement this.
Kim Alvefur <zash@zash.se>
parents:
854
diff
changeset
|
111 local carbon = session.want_carbons == xmlns_carbons_old and carbon_old -- COMPAT |
2ece37bf9cc6
mod_carbons: Support the pre-forwarding version of Carbons. Please don't implement this.
Kim Alvefur <zash@zash.se>
parents:
854
diff
changeset
|
112 or session.want_carbons == xmlns_carbons_really_old and carbon_really_old -- COMPAT |
2ece37bf9cc6
mod_carbons: Support the pre-forwarding version of Carbons. Please don't implement this.
Kim Alvefur <zash@zash.se>
parents:
854
diff
changeset
|
113 or carbon; |
832
9087431d35f6
mod_carbons: Add comments and rename some variables to make it clearer
Kim Alvefur <zash@zash.se>
parents:
804
diff
changeset
|
114 session.send(carbon); |
462 | 115 end |
116 end | |
117 end | |
118 | |
480
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
119 local function c2s_message_handler(event) |
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
120 return message_handler(event, true) |
462 | 121 end |
122 | |
123 -- Stanzas sent by local clients | |
900
aca1c5eb0508
mod_carbons: Catch outgoing messages to hosts (thanks waqas)
Kim Alvefur <zash@zash.se>
parents:
896
diff
changeset
|
124 module:hook("pre-message/host", c2s_message_handler, 1); |
462 | 125 module:hook("pre-message/bare", c2s_message_handler, 1); |
126 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
|
127 -- Stanzas to local clients |
480
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
128 module:hook("message/bare", message_handler, 1); |
0cef5be669de
mod_carbons: Consolidate message handlers
Kim Alvefur <zash@zash.se>
parents:
463
diff
changeset
|
129 module:hook("message/full", message_handler, 1); |
462 | 130 |
131 module:add_feature(xmlns_carbons); | |
854
1c64ab8ae374
mod_carbons: Advertise support for the previous version
Kim Alvefur <zash@zash.se>
parents:
850
diff
changeset
|
132 module:add_feature(xmlns_carbons_old); |
888
f8d08f8ed7de
mod_carbons: Make support for v0 disabled by default, don't send v0 carbons for c2s
Michael Holzt <kju@fqdn.org>
parents:
884
diff
changeset
|
133 if module:get_option_boolean("carbons_v0") then |
f8d08f8ed7de
mod_carbons: Make support for v0 disabled by default, don't send v0 carbons for c2s
Michael Holzt <kju@fqdn.org>
parents:
884
diff
changeset
|
134 module:add_feature(xmlns_carbons_really_old); |
f8d08f8ed7de
mod_carbons: Make support for v0 disabled by default, don't send v0 carbons for c2s
Michael Holzt <kju@fqdn.org>
parents:
884
diff
changeset
|
135 end |