prosody-hg: plugins/mod_pubsub/mod_pubsub.lua history

mod_pubsub, util.pubsub: Support for 'authorize' access model

Tue, 31 Mar 2026 14:18:06 +0100

mod_pubsub, util.pubsub: Support for 'authorize' access model

mod_pubsub: Provide iteminfo method to enable retract-own-items functionality

Tue, 31 Mar 2026 14:15:00 +0100

mod_pubsub: Provide iteminfo method to enable retract-own-items functionality

mod_pubsub: Error if loaded outside of a component

Mon, 12 Jan 2026 17:13:06 +0000

mod_pubsub: Error if loaded outside of a component

This may change in the future, if we decide to support pubsub on hosts, but we
would need to resolve e.g. #1808 first.

mod_pubsub: Remove unused loop variable [luacheck]

Wed, 08 Jan 2025 08:54:52 +0100

mod_pubsub: Remove unused loop variable [luacheck]

mod_pubsub: Quiet down check for service admin

Tue, 07 Jan 2025 23:37:41 +0100

mod_pubsub: Quiet down check for service admin

This produced a *lot* of noise, especially listing items.

mod_pubsub: Limit node listing based on new ACL-aware metadata method

Tue, 07 Jan 2025 22:57:39 +0100

mod_pubsub: Limit node listing based on new ACL-aware metadata method

Ensures that nodes that one does not have metadata access to are hidden
from view.

This follows from the new ACL-aware method added in 3b357ab6b6eb.

mod_pubsub: Expand shell commands to include node/item management

Tue, 07 Jan 2025 14:27:18 +0000

mod_pubsub: Expand shell commands to include node/item management

mod_pubsub: Use new metadata method

Fri, 08 Nov 2024 02:12:45 +0100

mod_pubsub: Use new metadata method

No longer bypasses access control to retrieve this config subset, which
is also explicitly named in the service config now.

mod_pubsub: Check new role framework for node creation privileges

Sun, 13 Oct 2024 13:03:08 +0200

mod_pubsub: Check new role framework for node creation privileges

This enables granting regular users permission to create nodes via the
new roles framework. Previously this required either making everyone an
admin or writing a custom mod_pubsub variant with different permission
details.

Previous default behavior of only allowing creation by admin is kept as
to not give out unexpected permissions on upgrade, but could be
reevaluated at a later time.

Fixes #1324

mod_pubsub: Ignore shadowed variable [luacheck]

Wed, 06 Mar 2024 19:12:11 +0100

mod_pubsub: Ignore shadowed variable [luacheck]

mod_pubsub: Add shell commands to create and list nodes

Wed, 06 Mar 2024 17:38:21 +0000

mod_pubsub: Add shell commands to create and list nodes

mod_pubsub: Provide some node properties in summary template #1809

Wed, 22 Nov 2023 22:35:44 +0100

mod_pubsub: Provide some node properties in summary template #1809

Gives some access to node details which are otherwise hard to determine
if you only see the plain text summary, since it is shared based on the
pubsub#type setting (or payload xmlns).

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: Use get_option_enum where appropriate

Sat, 16 Jan 2021 21:04:58 +0100

plugins: Use get_option_enum where appropriate

plugins: Prefix module imports with prosody namespace

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

plugins: Prefix module imports with prosody namespace

mod_pubsub, mod_pep: Support per-node configurable inclusion of publisher

Wed, 22 Mar 2023 11:39:19 +0000

mod_pubsub, mod_pep: Support per-node configurable inclusion of publisher

This matches ejabberd's behaviour, using the 'pubsub#itemreply' config option.

Although the current definition of this option in the specification is not
as clear as it could be, I think matching what existing deployments do is the
best option to resolve the ambiguity and reduce fragmentation.

We should update the spec to be clearer about how to use and interpret this
option.

The 'expose_publisher' option for mod_pubsub is now an override (always expose
or never expose). If unset, it will use the per-node config (which defaults to
not exposing).

Thanks to Link Mauve, edhelas and goffi for sparking this feature.

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.

mod_pubsub: Don't attempt to use server actor as publisher (fixes #1723)

Mon, 21 Mar 2022 12:36:20 +0000

mod_pubsub: Don't attempt to use server actor as publisher (fixes #1723)

mod_pubsub: Allow configuring summary templates

Mon, 24 Jan 2022 23:06:45 +0100

mod_pubsub: Allow configuring summary templates

Enables generation of summaries for more than Atom without additional
modules.

mod_pubsub: Use the util.xtemplate to render Atom summary

Mon, 24 Jan 2022 23:04:38 +0100

mod_pubsub: Use the util.xtemplate to render Atom summary

mod_pubsub: Use the 'pubsub#type' setting to pick summary generator

Mon, 24 Jan 2022 23:05:26 +0100

mod_pubsub: Use the 'pubsub#type' setting to pick summary generator

Allows using different ones even if multiple semantically different
formats share the same root element xmlns, e.g. generic Atom and
XEP-0277 entries.

util.pubsub: Fix item store resize to "max"

Thu, 06 Jan 2022 01:18:35 +0100

util.pubsub: Fix item store resize to "max"

Previously this would end up passing the "max" directly to the
underlying storage.

mod_pubsub: Allow specifying the JID of the pubsub service

Tue, 07 Dec 2021 13:03:55 +0100

mod_pubsub: Allow specifying the JID of the pubsub service

This allows overriding it in cases where it is not equal to module.host,
like say, in mod_pep

mod_pubsub,mod_pep: Advertise maximum number of items via XEP-0122

Wed, 20 Oct 2021 17:32:34 +0200

mod_pubsub,mod_pep: Advertise maximum number of items via XEP-0122

Clients would generally be using the "max" symbol instead of discovering
this, but this also gets us validation and earlier rejection of out of
bounds values.

mod_pubsub: Update callbacks on reload to more completely refresh config

Thu, 29 Jul 2021 17:37:27 +0200

mod_pubsub: Update callbacks on reload to more completely refresh config

This would also release any resources held via references from these
callbacks.

I'm not sure why we don't just re-new() the whole thing.

Related to #1382

mod_pubsub: Update configuration on reload (fixes #1382)

Sun, 25 Jul 2021 18:58:25 +0200

mod_pubsub: Update configuration on reload (fixes #1382)

Because of the way the previous pubsub service is carried access module
reloads, it would retain the configuration options with their previous
values from when the service was first created.

mod_pubsub: Silence warning about 'service' as argument [luacheck]

Sun, 25 Jul 2021 16:33:19 +0200

mod_pubsub: Silence warning about 'service' as argument [luacheck]

Maybe the 'service' in the outer scope should be moved down to minimize
overlap with other functions that receive the same service as argument?

mod_pubsub: Explicitly enable persistence by default to preserve behavior

Wed, 21 Jul 2021 23:35:08 +0200

mod_pubsub: Explicitly enable persistence by default to preserve behavior

Since nodes were always persistent according to the XEP-0060 definition.
Whether data is stored in memory or on disk was not what this setting
was meant for.

mod_pubsub: Remove publisher field when not exposing publisher

Sun, 25 Jul 2021 14:23:35 +0200

mod_pubsub: Remove publisher field when not exposing publisher

The publisher is already there on the item when the broadcaster gets it,
so it needs to do the opposite thing.

mod_pubsub: Normalize 'publisher' JID

Sun, 25 Jul 2021 14:01:45 +0200

mod_pubsub: Normalize 'publisher' JID

All the XEP-0060 examples have the publisher attribute set to a bare
JID, but the text does allow it to be the full JID.

Since mod_pubsub is more likely used for open nodes that anyone can
subscribe to it makes sense to not leak the full JIDs. This is also
disabled by defaults.

In mod_pep on the other hand it might make sense to have the full JID
since that data is more likely to be broadcast to contacts which are
already somewhat trusted.

mod_pubsub: Respect 'expose publisher' setting in item retrieval

Sun, 25 Jul 2021 13:52:27 +0200

mod_pubsub: Respect 'expose publisher' setting in item retrieval

mod_pubsub,mod_pep: Support "max" as 'pubsub#max_items'

Wed, 09 Jun 2021 15:58:49 +0200

mod_pubsub,mod_pep: Support "max" as 'pubsub#max_items'

Fixes #1643

API change: The argument to archive_itemstore() changes type to integer

Merge 0.11->trunk

Fri, 06 Nov 2020 16:52:38 +0100

Merge 0.11->trunk

mod_pubsub: Fix notification stanza type setting (fixes #1605)

Fri, 06 Nov 2020 13:49:40 +0100

mod_pubsub: Fix notification stanza type setting (fixes #1605)

Merge 0.11->trunk

Thu, 05 Nov 2020 22:31:25 +0100

Merge 0.11->trunk

mod_pubsub: Lower priority of default generator

Thu, 05 Nov 2020 22:27:17 +0100

mod_pubsub: Lower priority of default generator

in order to avoid conflict with a handler at the default (0) priority,
making it easier to write your own formatting in plugins.

this follows the common pattern of default modules having lower priority

mod_pubsub: Comment on itemstore type

Sun, 25 Oct 2020 15:23:36 +0100

mod_pubsub: Comment on itemstore type

Merge 0.11->trunk

Thu, 27 Feb 2020 20:05:47 +0100

Merge 0.11->trunk

mod_pubsub, mod_pep: Ensure correct number of children of (fixes #1496)

Thu, 27 Feb 2020 20:01:54 +0100

mod_pubsub, mod_pep: Ensure correct number of children of (fixes #1496)

mod_pubsub: Move a comment to where it makes sense

Wed, 10 Jul 2019 19:12:19 +0200

mod_pubsub: Move a comment to where it makes sense

This code has moved but the comment did not follow it.

Merge 0.11->trunk

Fri, 22 Feb 2019 07:40:30 +0100

Merge 0.11->trunk

mod_pubsub: Simplify configuration for node data (see #1302)

Fri, 22 Feb 2019 07:33:23 +0100

mod_pubsub: Simplify configuration for node data (see #1302)

mod_pubsub: Split line in config check to improve readability

Sun, 23 Dec 2018 03:06:35 +0100

mod_pubsub: Split line in config check to improve readability

Also makes it easier to compare with mod_pep

mod_pubsub: Change order of luacheck directives to match arguments they apply to

Sun, 23 Dec 2018 03:05:58 +0100

mod_pubsub: Change order of luacheck directives to match arguments they apply to

mod_pubsub: Add semicolon (code style)

Sun, 23 Dec 2018 02:50:22 +0100

mod_pubsub: Add semicolon (code style)

pubsub: Set pubsub#title as name attribute in disco#items (fixes #1226)

Tue, 30 Oct 2018 18:20:54 +0100

pubsub: Set pubsub#title as name attribute in disco#items (fixes #1226)

mod_pubsub: Fix summary generation for Atom entries to use the correct field

Fri, 31 Aug 2018 21:57:04 +0200

mod_pubsub: Fix summary generation for Atom entries to use the correct field

mod_pubsub: Add support for thin notifications (without the full payload)

Thu, 16 Aug 2018 15:20:29 +0200

mod_pubsub: Add support for thin notifications (without the full payload)

mod_pubsub: Only attach publisher on normal "item" broadcasts

Thu, 16 Aug 2018 15:18:29 +0200

mod_pubsub: Only attach publisher on normal "item" broadcasts

The 'publisher' is only on in the schema.

mod_pubsub: Prepare to support turning notifications off for each kind of broadcast

Thu, 16 Aug 2018 14:47:30 +0200

mod_pubsub: Prepare to support turning notifications off for each kind of broadcast

util.pubsub: Pass "retract" as the type of such broadcasts

Thu, 16 Aug 2018 14:32:21 +0200

util.pubsub: Pass "retract" as the type of such broadcasts

This moves some XEP-0060 awkwardness out of util.pubsub and into mod_pubsub

A retraction is broadcast in an container, whereas most other
kinds of broadcasts are in a container with a name matching the 'kind'
attribute.

mod_pubsub, mod_pep, util.pubsub: Move capability definitions into util.pubsub to avoid duplication

Wed, 08 Aug 2018 20:48:02 +0100

mod_pubsub, mod_pep, util.pubsub: Move capability definitions into util.pubsub to avoid duplication

mod_pubsub, mod_pep: The "restricted" affiliation should be allowed to be unsubscribed but nothing else

Mon, 06 Aug 2018 18:33:33 +0200

mod_pubsub, mod_pep: The "restricted" affiliation should be allowed to be unsubscribed but nothing else

Can't revoke their subscriptions on change of access model otherwise

mod_pubsub: Add 'get_configuration' capability to relevant affiliations

Sun, 05 Aug 2018 19:12:29 +0200

mod_pubsub: Add 'get_configuration' capability to relevant affiliations

Like ca5228a7d907 did for mod_pep

Thanks pep.

mod_pubsub: Add a public method for retrieving the service object

Sun, 05 Aug 2018 18:28:31 +0200

mod_pubsub: Add a public method for retrieving the service object

There is already a set_service()

mod_pubsub: Add comment to document nodestore/itemstore methods

Sat, 04 Aug 2018 21:33:17 +0100

mod_pubsub: Add comment to document nodestore/itemstore methods

mod_pubsub: Restrict access model to 'whitelist' and 'open'

Sat, 04 Aug 2018 03:31:21 +0200

mod_pubsub: Restrict access model to 'whitelist' and 'open'

'presence' and 'roster' makes more sense for PEP
'auithorize' needs additional code for authorization flow

mod_pubsub: Add configurable maximum on number of items

Sat, 04 Aug 2018 03:13:55 +0200

mod_pubsub: Add configurable maximum on number of items

Like aefb96a52f5f

mod_pubsub: Make generation of notification body into an event to allow extensibility

Sat, 14 Jul 2018 21:34:22 +0200

mod_pubsub: Make generation of notification body into an event to allow extensibility

mod_pubsub: Skip checks for adding body if no body generated

Sat, 14 Jul 2018 21:26:59 +0200

mod_pubsub: Skip checks for adding body if no body generated