prosody-hg: plugins/muc/mod_muc.lua history

Merge 13.0->trunk

Tue, 20 Jan 2026 11:13:31 +0000

Merge 13.0->trunk

mod_muc: Inherit mod_mam if globally loaded

Mon, 12 Jan 2026 17:46:32 +0000

mod_muc: Inherit mod_mam if globally loaded

This will load mod_muc_mam for all MUC components if mod_mam is enabled
globally in the config file. This behaviour can be prevented by explicitly
disabling mod_mam and mod_muc_mam in the config, under the Component:

Component "conference.example.com" "muc"
-- Don't enable MAM on this MUC component:
modules_disabled = { "mam", "muc_mam" }

MUC: Add basic "GC3" participant (affiliation) list fetch

Thu, 26 Jun 2025 15:17:57 +0100

MUC: Add basic "GC3" participant (affiliation) list fetch

RSM version currently held back until a planned restructuring of how we
store affiliations in MUC. This is because RSM needs a stable ordered list,
which we don't currently have.

MUC: Add get_occupant_id_from_jid() method, which works on real JIDs

Fri, 20 Jun 2025 18:55:39 +0100

MUC: Add get_occupant_id_from_jid() method, which works on real JIDs

This is useful to get the occupant ID of someone who is affiliated, but not
currently joined to the room.

MUC: Fix #1938 by reverting ac44bb7b7064

Thu, 05 Jun 2025 21:13:51 +0200

MUC: Fix #1938 by reverting ac44bb7b7064

MUC: Ensure room-creating join stanza includes nickname (fix #1934)

Mon, 19 May 2025 18:12:57 +0200

MUC: Ensure room-creating join stanza includes nickname (fix #1934)

Prevents a traceback when attempting to validate an absent nickname.

MUC: Factor out identification of join stanza

Mon, 19 May 2025 18:11:27 +0200

MUC: Factor out identification of join stanza

Makes it easier to extend this condition without the line growing too
long.

mod_muc: Integrate support for vcards/avatars on MUC rooms

Thu, 06 Feb 2025 17:08:46 +0000

mod_muc: Integrate support for vcards/avatars on MUC rooms

This was previously served by a community module (mod_vcard_muc).

It can be disabled by setting `vcard_muc = false` in the config.

MUC: Don't default component admins to being room owners

Tue, 18 Jun 2024 15:08:30 +0100

MUC: Don't default component admins to being room owners

This change has various technical and social benefits. If ownership of a MUC
is really needed, it can be gained using the 'Set affiliation' ad-hoc command
or prosodyctl shell.

Example client incompatibility with the old behaviour:

- https://github.com/monal-im/Monal/issues/1085

MUC: Add per-room PM restriction functionality (thanks Wirlaburla)

Thu, 23 May 2024 17:39:20 +0100

MUC: Add per-room PM restriction functionality (thanks Wirlaburla)

Based on mod_muc_restrict_pm in prosody-modules d82c0383106a

mod_muc: Switch to module:could() for some implicit access control checks

Tue, 07 Nov 2023 11:50:59 +0000

mod_muc: Switch to module:could() for some implicit access control checks

mod_muc: Allow guest users to list rooms by default

Tue, 07 Nov 2023 11:12:57 +0000

mod_muc: Allow guest users to list rooms by default

mod_muc: Add :list-rooms permission

Tue, 07 Nov 2023 11:10:38 +0000

mod_muc: Add :list-rooms permission

mod_muc: Use enum config API for 'restrict_room_creation'

Fri, 21 Jul 2023 22:49:01 +0200

mod_muc: Use enum config API for 'restrict_room_creation'

This communicates the accepted values in case the config diverges from
them. Note that older documentation used an "admin" value behaving like
an alias to true, but this is no longer handled. Should it?

plugins: Use boolean config method in some places

Tue, 18 Jul 2023 12:38:16 +0200

plugins: Use boolean config method in some places

Because it makes sense and improves feedback via logging

mod_muc: Use enum option method for 'muc_room_default_presence_broadcast'

Tue, 18 Jul 2023 12:32:41 +0200

mod_muc: Use enum option method for 'muc_room_default_presence_broadcast'

plugins: Use integer config API with interval specification where sensible

Mon, 17 Jul 2023 01:38:54 +0200

plugins: Use integer config API with interval specification where sensible

Many of these fall into a few categories:
- util.cache size, must be >= 1
- byte or item counts that logically can't be negative
- port numbers that should be in 1..0xffff

plugins: Switch to :get_option_period() for time range options

Sun, 16 Jul 2023 20:49:33 +0200

plugins: Switch to :get_option_period() for time range options

Improves readability ("1 day" vs 86400) and centralizes validation.

core, plugins: Split prosody:user role into prosody:{guest,registered,member}

Thu, 29 Jun 2023 15:36:13 +0100

core, plugins: Split prosody:user role into prosody:{guest,registered,member}

This gives us more granular control over different types of user account.
Accounts registered by IBR get assigned prosody:registered by default, while
accounts provisioned by an admin (e.g. via prosodyctl shell) will receive
prosody:member by default.

plugins: Prefix module imports with prosody namespace

Fri, 24 Mar 2023 13:15:28 +0100

plugins: Prefix module imports with prosody namespace

MUC: Add note about non-existant room method

Fri, 20 Jan 2023 19:47:00 +0100

MUC: Add note about non-existant room method

mod_muc: Better map restrict_room_creation to role permissions (behaviour change)

Thu, 29 Sep 2022 12:30:52 +0100

mod_muc: Better map restrict_room_creation to role permissions (behaviour change)

With this change and 427dd01f0864, room creation is now effectively restricted
to parent-host users by default. This is a better default than previous
Prosody versions (where room creation was not restricted).

The "local" option for restrict_room_creation is no longer used (any value
other than true/false won't change the default behaviour).

restrict_room_creation = true will grant prosody:admin the ability to create
rooms.

restrict_room_creation = false disables all permission checks.

Anything between these two can be achieved using custom roles and permissions.

Switch to a new role-based authorization framework, removing is_admin()

Wed, 15 Jun 2022 12:15:01 +0100

Switch to a new role-based authorization framework, removing is_admin()

We began moving away from simple "is this user an admin?" permission checks
before 0.12, with the introduction of mod_authz_internal and the ability to
dynamically change the roles of individual users.

The approach in 0.12 still had various limitations however, and apart from
the introduction of roles other than "admin" and the ability to pull that info
from storage, not much actually changed.

This new framework shakes things up a lot, though aims to maintain the same
functionality and behaviour on the surface for a default Prosody
configuration. That is, if you don't take advantage of any of the new
features, you shouldn't notice any change.

The biggest change visible to developers is that usermanager.is_admin() (and
the auth provider is_admin() method) have been removed. Gone. Completely.

Permission checks should now be performed using a new module API method:

module:may(action_name, context)

This method accepts an action name, followed by either a JID (string) or
(preferably) a table containing 'origin'/'session' and 'stanza' fields (e.g.
the standard object passed to most events). It will return true if the action
should be permitted, or false/nil otherwise.

Modules should no longer perform permission checks based on the role name.
E.g. a lot of code previously checked if the user's role was prosody:admin
before permitting some action. Since many roles might now exist with similar
permissions, and the permissions of prosody:admin may be redefined
dynamically, it is no longer suitable to use this method for permission
checks. Use module:may().

If you start an action name with ':' (recommended) then the current module's
name will automatically be used as a prefix.

To define a new permission, use the new module API:

module:default_permission(role_name, action_name)
module:default_permissions(role_name, { action_name[, action_name...] })

This grants the specified role permission to execute the named action(s) by
default. This may be overridden via other mechanisms external to your module.

The built-in roles that developers should use are:

- prosody:user (normal user)
- prosody:admin (host admin)
- prosody:operator (global admin)

The new prosody:operator role is intended for server-wide actions (such as
shutting down Prosody).

Finally, all usage of is_admin() in modules has been fixed by this commit.
Some of these changes were trickier than others, but no change is expected to
break existing deployments.

EXCEPT: mod_auth_ldap no longer supports the ldap_admin_filter option. It's
very possible nobody is using this, but if someone is then we can later update
it to pull roles from LDAP somehow.

MUC: Add method for getting the occupant id salt to allow reuse

Tue, 05 Oct 2021 18:13:51 +0200

MUC: Add method for getting the occupant id salt to allow reuse

MUC: Allow modules a chance to act prior to room destruction

Sun, 05 Dec 2021 14:49:06 +0100

MUC: Allow modules a chance to act prior to room destruction

MUC: Report number of live rooms to statsmanager

Sun, 28 Mar 2021 13:22:35 +0200

MUC: Report number of live rooms to statsmanager

Should help inform on whether the cache size should be increased.

MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)

Tue, 24 Nov 2020 10:38:56 +0000

MUC: Merge mod_muc_occupant_id into a sub-module (thanks pep.!)

MUC: Don't default room name to JID localpart (API breaking change)

Sat, 29 Aug 2020 18:51:13 +0200

MUC: Don't default room name to JID localpart (API breaking change)

Behavior with turning empty name into localpart was originally introduced
in 711eb5bf94b4

This has caused some problems for clients, making it difficult to
differentiate between a room actually named like the localpart from a
room without a name.

Breaking:
The function signature of the :get_name() method changes from always
returning a string to optional string.

MUC: Add ad-hoc command setting affiliation in a room (fixes #1174)

Sat, 21 Mar 2020 00:00:50 +0100

MUC: Add ad-hoc command setting affiliation in a room (fixes #1174)

This gives service admins a way to set an arbitrary affiliation in any
room. Enables various administrative use cases such as room ownership
reassignment or recovery.

Reduces the need for the admins-as-owners feature, as this can be used
by admins to make themselves owner in any room when needed, instead of
being owners all the time.

MUC: Add initial hats support (broadcast only)

Wed, 18 Mar 2020 17:42:56 +0000

MUC: Add initial hats support (broadcast only)

Based on the currently-deferred XEP-0317. The protocol differs
a little (because XEP-0317 is incomplete), therefore currently
we use a custom namespace.

The plan is to update and finish XEP-0317.

Merge 0.11->trunk

Thu, 13 Feb 2020 14:27:42 +0000

Merge 0.11->trunk

mod_muc: Allow control over the server-admins-are-room-owners feature (see #1174)

Thu, 13 Feb 2020 14:27:12 +0000

mod_muc: Allow control over the server-admins-are-room-owners feature (see #1174)

MUC: Indicate the component as origin of various errors where there's no room

Tue, 26 Nov 2019 00:02:13 +0100

MUC: Indicate the component as origin of various errors where there's no room

A room that doesn't exist can't return an error, can it?

MUC: Indicate that the room is the origin of various errors where 'from' is an occupant JID

Mon, 25 Nov 2019 23:52:45 +0100

MUC: Indicate that the room is the origin of various errors where 'from' is an occupant JID

MUC: Strictly validate room JID on creation

Fri, 01 Nov 2019 22:08:38 +0100

MUC: Strictly validate room JID on creation

This should prevent any MUCs with invalid JID (according to current normalization routine)

MUC: Add controls for whose presence is broadcast (closes #1335)

Sun, 20 Oct 2019 21:58:16 +0200

MUC: Add controls for whose presence is broadcast (closes #1335)

Committed by Zash

MUC: Move check for explicit room join earlier in room creation flow

Tue, 27 Nov 2018 17:01:47 +0100

MUC: Move check for explicit room join earlier in room creation flow

MUC: Use defaults from config in create_room() if no config provided

Thu, 15 Nov 2018 10:25:48 +0000

MUC: Use defaults from config in create_room() if no config provided

MUC: Add support for registering with a MUC, including reserving a nickname as per XEP-0045

Mon, 03 Sep 2018 12:26:25 +0100

MUC: Add support for registering with a MUC, including reserving a nickname as per XEP-0045

MUC: Add support for storing additional data with MUC affiliations

Mon, 03 Sep 2018 12:18:13 +0100

MUC: Add support for storing additional data with MUC affiliations

XEP-0045 registration provides examples of registering a nickname
and various other details. This also allows modules to store arbitrary
private data about an affiliated entity.

MUC: Normalize indentation

Wed, 22 Aug 2018 14:50:07 +0200

MUC: Normalize indentation

MUC: Fix traceback when failing to restore a room

Fri, 17 Aug 2018 08:12:58 +0100

MUC: Fix traceback when failing to restore a room

When a room exists in the DB but cannot be loaded (e.g. due to max_rooms
or a pre-restore handler) restore_room()/get_room_from_jid() returns false.

MUC: Pass missing argument to log message

Fri, 17 Aug 2018 00:31:24 +0200

MUC: Pass missing argument to log message

MUC: Allow destruction of tombstones (eg via telnet or adhoc command)

Fri, 03 Aug 2018 22:25:16 +0200

MUC: Allow destruction of tombstones (eg via telnet or adhoc command)

Otherwise this just updates the timestamp, which is probably the
opposite of what the user wanted

MUC: Split long lines [luacheck strict]

Fri, 03 Aug 2018 17:48:41 +0200

MUC: Split long lines [luacheck strict]

mod_muc: Fire event when room is (and about to be) restored

Fri, 03 Aug 2018 13:44:30 +0100

mod_muc: Fire event when room is (and about to be) restored

mod_muc: Add comment

Fri, 03 Aug 2018 13:43:47 +0100

mod_muc: Add comment

MUC: Add some comments clarifying methods

Tue, 17 Jul 2018 10:35:33 +0100

MUC: Add some comments clarifying methods

MUC: Add new iteration methods, all_rooms/live_rooms to eventually replace each_room

Tue, 17 Jul 2018 10:29:16 +0100

MUC: Add new iteration methods, all_rooms/live_rooms to eventually replace each_room

MUC: Rename variable for consistency with other code that uses the term 'live'

Tue, 17 Jul 2018 10:01:19 +0100

MUC: Rename variable for consistency with other code that uses the term 'live'

MUC: Return 'gone' error for destroyed rooms in other cases than attempted join

Mon, 16 Jul 2018 12:19:19 +0200

MUC: Return 'gone' error for destroyed rooms in other cases than attempted join

Lock expiry -> Reset
Admin wants to join -> Reset
Still locked -> cancel, gone
Don't return error in response to an error

MUC: Add sections in room config form

Fri, 13 Jul 2018 15:47:08 +0100

MUC: Add sections in room config form

MUC: Include redirect in 'gone' error for destroyed rooms

Wed, 11 Jul 2018 12:05:06 +0200

MUC: Include redirect in 'gone' error for destroyed rooms

MUC: Send an 'gone' error instead of unavailable +

Wed, 11 Jul 2018 11:50:44 +0200

MUC: Send an 'gone' error instead of unavailable +

List discussion here:
https://mail.jabber.org/pipermail/standards/2018-July/035228.html

MUC: Allow an admin to recreate destroyed rooms

Wed, 11 Jul 2018 03:38:01 +0200

MUC: Allow an admin to recreate destroyed rooms

MUC: Add support for storing a tombstone for destroyed rooms (#1182)

Wed, 11 Jul 2018 03:37:57 +0200

MUC: Add support for storing a tombstone for destroyed rooms (#1182)

MUC: Remove room state on successful restoration from disk

Wed, 11 Jul 2018 03:27:18 +0200

MUC: Remove room state on successful restoration from disk

MUC: Purge saved room state when deleting a room

Wed, 11 Jul 2018 03:27:02 +0200

MUC: Purge saved room state when deleting a room

MUC: Log a debug message when a non-persistent room becomes empty and is destroyed

Wed, 11 Jul 2018 02:25:07 +0200

MUC: Log a debug message when a non-persistent room becomes empty and is destroyed

MUC: Flag rooms being destroyed (fixes #887)

Tue, 10 Jul 2018 21:10:12 +0200

MUC: Flag rooms being destroyed (fixes #887)