Software / code / prosody-modules
Annotate
mod_csi_muc_priorities/README.md @ 6057:cc665f343690
mod_firewall: SUBSCRIBED: Flip subscription check to match documentation
The documentation claims that this condition checks whether the recipient is
subscribed to the sender.
However, it was using the wrong method, and actually checking whether the
sender was subscribed to the recipient.
A quick poll of folk suggested that the documentation's approach is the right
one, so this should fix the code to match the documentation.
This should also fix the bundled anti-spam rules from blocking presence from
JIDs that you subscribe do (but don't have a mutual subscription with).
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Fri, 22 Nov 2024 13:50:48 +0000 |
| parent | 6003:fe081789f7b5 |
| child | 6211:750d64c47ec6 |
| rev | line source |
|---|---|
|
3545
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 # Introduction |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 This module lets users specify which of the group chats they are in are |
|
5997
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
4 more or less important. This influences when |
|
3545
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 [mod_csi_simple][doc:modules:mod_csi_simple] decides to send |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 stanzas vs waiting until there is more to send. Users in many large |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 public channels might benefit from this. |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 # Configuration |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 The module is configured via ad-hoc an command called *Configure group |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 chat priorities* that should appear in the menus of compatible clients. |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
13 |
|
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 The command presents a form that accepts a list of XMPP addresses. |
|
5997
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
15 Currently you can specify channels as lower priority (which is suitable |
|
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
16 for e.g. noisy public channels) or higher priority (which is suitable |
|
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
17 for e.g. small private channels where immediate message delivery is |
|
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
18 desired). You can also specify whether mucs default to lower priority |
|
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
19 or not. |
|
3545
c1d7e6752d18
mod_csi_muc_priorities: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 |
|
5997
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
21 A message of type groupchat from an address in the low priority list will |
|
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
22 not be considered important enough to send it to an inactive client, |
|
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
23 unless it is from the current user or mentions of their nickname. |
|
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
24 **Note** that mention support require the separate module |
|
d3812826c1cd
mod_csi_muc_priorities: Allow setting the default priority for mucs to low
aereaux <aidan@jmad.org>
parents:
3639
diff
changeset
|
25 [mod_track_muc_joins] to also be loaded. |
|
3639
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
26 |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
27 ``` {.lua} |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
28 modules_enabled = { |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
29 -- other modules etc |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
30 |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
31 "csi_simple", |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
32 "csi_muc_priorities", |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
33 "track_muc_joins", -- optional |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
34 } |
|
562d3b219876
mod_csi_muc_priorities: Add an example
Kim Alvefur <zash@zash.se>
parents:
3638
diff
changeset
|
35 ``` |
