prosody
f4cc818db995
plugins/muc/subject.lib.lua

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

Software / code / prosody

Annotate

plugins/muc/subject.lib.lua @ 8857:f4cc818db995

MUC: Get acting occupant into a local variable for easier access
author Kim Alvefur <zash@zash.se>
date Fri, 01 Jun 2018 10:20:19 +0200
parent 8850:26f1a49fa9c0
child 8884:a387e00471d6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
1 -- Prosody IM
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
2 -- Copyright (C) 2008-2010 Matthew Wild
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
3 -- Copyright (C) 2008-2010 Waqas Hussain
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
4 -- Copyright (C) 2014 Daurnimator
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
5 --
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
6 -- This project is MIT/X11 licensed. Please see the
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
7 -- COPYING file in the source package for more information.
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
8 --
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
9
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
10 local st = require "util.stanza";
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
11
6429
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
12 local muc_util = module:require "muc/util";
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
13 local valid_roles = muc_util.valid_roles;
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
14
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
15 local function create_subject_message(from, subject)
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
16 return st.message({from = from; type = "groupchat"})
8606
b6b1f0f9b381 MUC: Use empty string if no subject provided (thanks pep+)
Matthew Wild <mwild1@gmail.com>
parents: 7401
diff changeset
17 :tag("subject"):text(subject or ""):up();
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
18 end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
19
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
20 local function get_changesubject(room)
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
21 return room._data.changesubject;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
22 end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
23
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
24 local function set_changesubject(room, changesubject)
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
25 changesubject = changesubject and true or nil;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
26 if get_changesubject(room) == changesubject then return false; end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
27 room._data.changesubject = changesubject;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
28 return true;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
29 end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
30
8848
402d8febfa43 MUC: Advertise in whether participants are allowed to change the subject (#1155)
Kim Alvefur <zash@zash.se>
parents: 8606
diff changeset
31 module:hook("muc-disco#info", function (event)
402d8febfa43 MUC: Advertise in whether participants are allowed to change the subject (#1155)
Kim Alvefur <zash@zash.se>
parents: 8606
diff changeset
32 table.insert(event.form, {
402d8febfa43 MUC: Advertise in whether participants are allowed to change the subject (#1155)
Kim Alvefur <zash@zash.se>
parents: 8606
diff changeset
33 name = "muc#roominfo_changesubject";
402d8febfa43 MUC: Advertise in whether participants are allowed to change the subject (#1155)
Kim Alvefur <zash@zash.se>
parents: 8606
diff changeset
34 type = "boolean";
402d8febfa43 MUC: Advertise in whether participants are allowed to change the subject (#1155)
Kim Alvefur <zash@zash.se>
parents: 8606
diff changeset
35 });
402d8febfa43 MUC: Advertise in whether participants are allowed to change the subject (#1155)
Kim Alvefur <zash@zash.se>
parents: 8606
diff changeset
36 event.formdata["muc#roominfo_changesubject"] = get_changesubject(event.room);
402d8febfa43 MUC: Advertise in whether participants are allowed to change the subject (#1155)
Kim Alvefur <zash@zash.se>
parents: 8606
diff changeset
37 end);
402d8febfa43 MUC: Advertise in whether participants are allowed to change the subject (#1155)
Kim Alvefur <zash@zash.se>
parents: 8606
diff changeset
38
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
39 module:hook("muc-config-form", function(event)
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
40 table.insert(event.form, {
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
41 name = "muc#roomconfig_changesubject";
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
42 type = "boolean";
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
43 label = "Allow Occupants to Change Subject?";
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
44 value = get_changesubject(event.room);
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
45 });
7401
e16b3fd0bd80 MUC: Assign priorities to config form hooks so they have a consistent order on each start
Kim Alvefur <zash@zash.se>
parents: 7365
diff changeset
46 end, 100-8);
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
47
6991
84e01dbb739e MUC: Update all config form handlers to take advantage of the new per-option events
Matthew Wild <mwild1@gmail.com>
parents: 6429
diff changeset
48 module:hook("muc-config-submitted/muc#roomconfig_changesubject", function(event)
84e01dbb739e MUC: Update all config form handlers to take advantage of the new per-option events
Matthew Wild <mwild1@gmail.com>
parents: 6429
diff changeset
49 if set_changesubject(event.room, event.value) then
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
50 event.status_codes["104"] = true;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
51 end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
52 end);
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
53
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
54 local function get_subject(room)
6228
4968d18e2c1e plugins/muc/subject.lib: If subject is not set by an occupant, it should come from room jid itself
daurnimator <quae@daurnimator.com>
parents: 6224
diff changeset
55 -- a <message/> stanza from the room JID (or from the occupant JID of the entity that set the subject)
4968d18e2c1e plugins/muc/subject.lib: If subject is not set by an occupant, it should come from room jid itself
daurnimator <quae@daurnimator.com>
parents: 6224
diff changeset
56 return room._data.subject_from or room.jid, room._data.subject;
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
57 end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
58
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
59 local function send_subject(room, to)
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
60 local msg = create_subject_message(get_subject(room));
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
61 msg.attr.to = to;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
62 room:route_stanza(msg);
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
63 end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
64
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
65 local function set_subject(room, from, subject)
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
66 if subject == "" then subject = nil; end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
67 local old_from, old_subject = get_subject(room);
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
68 if old_subject == subject and old_from == from then return false; end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
69 room._data.subject_from = from;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
70 room._data.subject = subject;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
71 local msg = create_subject_message(from, subject);
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
72 room:broadcast_message(msg);
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
73 return true;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
74 end
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
75
8849
cd186331ab1f MUC: Advertise room subject in disco#info
Kim Alvefur <zash@zash.se>
parents: 8848
diff changeset
76 module:hook("muc-disco#info", function (event)
cd186331ab1f MUC: Advertise room subject in disco#info
Kim Alvefur <zash@zash.se>
parents: 8848
diff changeset
77 table.insert(event.form, {
cd186331ab1f MUC: Advertise room subject in disco#info
Kim Alvefur <zash@zash.se>
parents: 8848
diff changeset
78 name = "muc#roominfo_subject";
cd186331ab1f MUC: Advertise room subject in disco#info
Kim Alvefur <zash@zash.se>
parents: 8848
diff changeset
79 });
cd186331ab1f MUC: Advertise room subject in disco#info
Kim Alvefur <zash@zash.se>
parents: 8848
diff changeset
80 event.formdata["muc#roominfo_subject"] = select(2, get_subject(event.room));
cd186331ab1f MUC: Advertise room subject in disco#info
Kim Alvefur <zash@zash.se>
parents: 8848
diff changeset
81 end);
cd186331ab1f MUC: Advertise room subject in disco#info
Kim Alvefur <zash@zash.se>
parents: 8848
diff changeset
82
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
83 -- Send subject to joining user
6277
f2c9c36979b3 plugins/muc: Fix use of incorrect event on occupant join
daurnimator <quae@daurnimator.com>
parents: 6228
diff changeset
84 module:hook("muc-occupant-session-new", function(event)
6228
4968d18e2c1e plugins/muc/subject.lib: If subject is not set by an occupant, it should come from room jid itself
daurnimator <quae@daurnimator.com>
parents: 6224
diff changeset
85 send_subject(event.room, event.stanza.attr.from);
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
86 end, 20);
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
87
6429
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
88 -- Prosody has made the decision that messages with <subject/> are exclusively subject changes
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
89 -- e.g. body will be ignored; even if the subject change was not allowed
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
90 module:hook("muc-occupant-groupchat", function(event)
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
91 local stanza = event.stanza;
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
92 local subject = stanza:get_child("subject");
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
93 if subject then
7365
2d502878b784 MUC/subject: Fix reference to room for save call (self, not room)
Kim Alvefur <zash@zash.se>
parents: 7357
diff changeset
94 local room = event.room;
6429
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
95 local occupant = event.occupant;
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
96 -- Role check for subject changes
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
97 local role_rank = valid_roles[occupant and occupant.role or "none"];
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
98 if role_rank >= valid_roles.moderator or
7365
2d502878b784 MUC/subject: Fix reference to room for save call (self, not room)
Kim Alvefur <zash@zash.se>
parents: 7357
diff changeset
99 ( role_rank >= valid_roles.participant and get_changesubject(room) ) then -- and participant
2d502878b784 MUC/subject: Fix reference to room for save call (self, not room)
Kim Alvefur <zash@zash.se>
parents: 7357
diff changeset
100 set_subject(room, occupant.nick, subject:get_text());
7357
d69521003e91 MUC: Save room after subject is changed
Kim Alvefur <zash@zash.se>
parents: 7353
diff changeset
101 room:save();
6429
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
102 return true;
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
103 else
8850
26f1a49fa9c0 MUC: Include a human-readable error message when not allowed to change subject
Kim Alvefur <zash@zash.se>
parents: 8849
diff changeset
104 event.origin.send(st.error_reply(stanza, "auth", "forbidden", "You are not allowed to change the subject"));
6429
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
105 return true;
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
106 end
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
107 end
6429
675aea867574 plugins/muc: Add muc-occupant-groupchat event
daurnimator <quae@daurnimator.com>
parents: 6277
diff changeset
108 end, 20);
6224
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
109
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
110 return {
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
111 get_changesubject = get_changesubject;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
112 set_changesubject = set_changesubject;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
113 get = get_subject;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
114 set = set_subject;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
115 send = send_subject;
2a9aff163545 plugins/muc: Move subject code to seperate module
daurnimator <quae@daurnimator.com>
parents:
diff changeset
116 };