https://soft.trung.fun/code/prosody/ en-us prosody: .luacheckrc history .luacheckrc revision history .luacheckrc: Ignore config files in spec/tls https://soft.trung.fun/code/prosody/log/b88f94aecfe3/.luacheckrc Matthew Wild <mwild1@gmail.com> Thu, 03 Apr 2025 19:56:11 +0100 luacheck: Declare new config globals https://soft.trung.fun/code/prosody/log/23aef73f0cb0/.luacheckrc Kim Alvefur <zash@zash.se> Sat, 18 Jan 2025 12:33:18 +0100 luacheckrc: Add module.ready() https://soft.trung.fun/code/prosody/log/7b632cd0e00d/.luacheckrc Kim Alvefur <zash@zash.se> Fri, 10 Jan 2025 12:34:29 +0100 luacheckrc: Reorder module API methods for consistency with prosody-modules https://soft.trung.fun/code/prosody/log/981bbe358771/.luacheckrc
Makes it easier to keep them in sync when the diff is smaller]]> Kim Alvefur <zash@zash.se> Fri, 10 Jan 2025 12:32:29 +0100 util.rfc6724: Remove, unused since introduction of Happy Eyeballs https://soft.trung.fun/code/prosody/log/581899aef96f/.luacheckrc
It was mainly used to determine whether to try IPv6 or IPv4 first,
following the rules for this in the RFC.

Now we always try IPv6 and IPv4 at roughly the same time, thus there no
need to carry these rules.]]> Kim Alvefur <zash@zash.se> Thu, 22 Feb 2024 19:46:52 +0100 luacheckrc, mod_http_file_share: Update for module API change (once->on_ready) https://soft.trung.fun/code/prosody/log/11e66ad894f0/.luacheckrc Matthew Wild <mwild1@gmail.com> Thu, 30 Nov 2023 10:14:17 +0000 .luacheckrc: Add module:could() https://soft.trung.fun/code/prosody/log/7bc1cabb3c6c/.luacheckrc Matthew Wild <mwild1@gmail.com> Tue, 07 Nov 2023 11:56:15 +0000 lint: Teach luacheck about module:once https://soft.trung.fun/code/prosody/log/14bbfb2cc8dd/.luacheckrc
Silence warning for using this introduced in 9c62ffbdf2ae]]> Kim Alvefur <zash@zash.se> Sun, 15 Oct 2023 16:43:14 +0200 moduleapi: Add :get_option_integer() https://soft.trung.fun/code/prosody/log/4d4f9e42bcf8/.luacheckrc
Many options in Prosody that are treated as numbers don't make sense as
floats, e.g. sizes and limits measured in bytes.

Simplified implementation based on an earlier attempt dating back to 2020]]> Kim Alvefur <zash@zash.se> Mon, 17 Jul 2023 00:09:41 +0200 core.moduleapi: Add :get_option_period for parsing time intervals https://soft.trung.fun/code/prosody/log/c9ef35fab0b1/.luacheckrc
E.g. for use in mod_mam and others that take an amount of time before
some (usually cleanup) action is taken.]]> Kim Alvefur <zash@zash.se> Sun, 16 Jul 2023 19:49:12 +0200 moduleapi: Add enum config option method https://soft.trung.fun/code/prosody/log/65fb0d7a2312/.luacheckrc
For when a setting has a few fixed values it can take]]> Kim Alvefur <zash@zash.se> Sat, 16 Jan 2021 20:40:14 +0100 luacheck: Remove long gone mod_storage_sql1 from excludes https://soft.trung.fun/code/prosody/log/330bfcaa5532/.luacheckrc
No point not checking a file that doesn't exist]]> Kim Alvefur <zash@zash.se> Thu, 19 Jan 2023 17:29:40 +0100 .luacheckrc: Add test_mutants.sh.lua to the ignore list https://soft.trung.fun/code/prosody/log/bde224616766/.luacheckrc Matthew Wild <mwild1@gmail.com> Tue, 11 Oct 2022 13:12:26 +0100 Switch to a new role-based authorization framework, removing is_admin() https://soft.trung.fun/code/prosody/log/9061f9621330/.luacheckrc
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.]]> Matthew Wild <mwild1@gmail.com> Wed, 15 Jun 2022 12:15:01 +0100 luacheck: Set expected globals to Lua 5.4 + compat https://soft.trung.fun/code/prosody/log/1332c650400d/.luacheckrc
Requires luacheck 0.25.0]]> Kim Alvefur <zash@zash.se> Sun, 10 Jul 2022 16:10:29 +0200 Merge 0.12->trunk https://soft.trung.fun/code/prosody/log/6abbf2dd2b14/.luacheckrc Kim Alvefur <zash@zash.se> Fri, 08 Jul 2022 19:56:29 +0200 luacheck: Shut up (backports 3caff1f93520, ignores module deleted in trunk) https://soft.trung.fun/code/prosody/log/fb0bf0a0864f/.luacheckrc Kim Alvefur <zash@zash.se> Mon, 30 May 2022 17:34:58 +0200 Merge 0.12->trunk https://soft.trung.fun/code/prosody/log/93bed323e361/.luacheckrc Kim Alvefur <zash@zash.se> Fri, 08 Jul 2022 19:43:47 +0200 Backport 875f73ead4e8 8e4033213c62 to deal with luacheck 0.26 https://soft.trung.fun/code/prosody/log/e72bb50456c4/.luacheckrc Kim Alvefur <zash@zash.se> Fri, 08 Jul 2022 19:42:48 +0200 luacheck: Ignore new warning about uses of `not (x == y)` and similar https://soft.trung.fun/code/prosody/log/875f73ead4e8/.luacheckrc
Added in luacheck 0.26.]]> Kim Alvefur <zash@zash.se> Mon, 30 May 2022 17:12:58 +0200 luacheck: Ignore new warning about using variables prefixed with '_' https://soft.trung.fun/code/prosody/log/8e4033213c62/.luacheckrc
luacheck 0.26 considers the _ prefix as a hint that the variable or
argument is unused, then warns if they are used despite this.

We have several places where this prefix is used to avoid shadowing
another similarly named variable, resulting in many instances of this
warning.]]> Kim Alvefur <zash@zash.se> Mon, 30 May 2022 16:49:52 +0200 mod_c2s,mod_s2s: Disable and close port listeners before closing sessions https://soft.trung.fun/code/prosody/log/cb459f8fa740/.luacheckrc
This ensures no new clients can start connecting during shutdown]]> Kim Alvefur <zash@zash.se> Fri, 11 Feb 2022 21:36:53 +0100 prosody: Expose main thread on the 'prosody' global https://soft.trung.fun/code/prosody/log/49ebac8a5260/.luacheckrc
To allow running things in it.]]> Kim Alvefur <zash@zash.se> Wed, 06 Oct 2021 14:49:26 +0200 mod_cron: Add a 'weekly' job frequency https://soft.trung.fun/code/prosody/log/cbed7d8d8f35/.luacheckrc Kim Alvefur <zash@zash.se> Fri, 03 Dec 2021 09:05:41 +0100 core.moduleapi: Add API for adding daily or hourly tasks via mod_cron https://soft.trung.fun/code/prosody/log/4b519c575ad0/.luacheckrc Kim Alvefur <zash@zash.se> Sun, 21 Nov 2021 18:13:21 +0100 Statistics: Rewrite statistics backends to use OpenMetrics https://soft.trung.fun/code/prosody/log/5f15ab7c6ae5/.luacheckrc
The metric subsystem of Prosody has had some shortcomings from
the perspective of the current state-of-the-art in metric
observability.

The OpenMetrics standard [0] is a formalization of the data
model (and serialization format) of the well-known and
widely-used Prometheus [1] software stack.

The previous stats subsystem of Prosody did not map well to that
format (see e.g. [2] and [3]); the key reason is that it was
trying to do too much math on its own ([2]) while lacking
first-class support for "families" of metrics ([3]) and
structured metric metadata (despite the `extra` argument to
metrics, there was no standard way of representing common things
like "tags" or "labels").

Even though OpenMetrics has grown from the Prometheus world of
monitoring, it maps well to other popular monitoring stacks
such as:

- InfluxDB (labels can be mapped to tags and fields as necessary)
- Carbon/Graphite (labels can be attached to the metric name with
dot-separation)
- StatsD (see graphite when assuming that graphite is used as
backend, which is the default)

The util.statsd module has been ported to use the OpenMetrics
model as a proof of concept. An implementation which exposes
the util.statistics backend data as Prometheus metrics is
ready for publishing in prosody-modules (most likely as
mod_openmetrics_prometheus to avoid breaking existing 0.11
deployments).

At the same time, the previous measure()-based API had one major
advantage: It is really simple and easy to use without requiring
lots of knowledge about OpenMetrics or similar concepts. For that
reason as well as compatibility with existing code, it is preserved
and may even be extended in the future.

However, code relying on the `stats-updated` event as well as
`get_stats` from `statsmanager` will break because the data
model has changed completely; in case of `stats-updated`, the
code will simply not run (as the event was renamed in order
to avoid conflicts); the `get_stats` function has been removed
completely (so it will cause a traceback when it is attempted
to be used).

Note that the measure_*_event methods have been removed from
the module API. I was unable to find any uses or documentation
and thus deemed they should not be ported. Re-implementation is
possible when necessary.

[0]: https://openmetrics.io/
[1]: https://prometheus.io/
[2]: #959
[3]: #960]]> Jonas Schäfer <jonas@wielicki.name> Sun, 18 Apr 2021 11:47:41 +0200 util.datamapper: Library for extracting data from stanzas https://soft.trung.fun/code/prosody/log/a1fa6202fa13/.luacheckrc
Based on the XML support in the OpenAPI specification.]]> Kim Alvefur <zash@zash.se> Sun, 07 Mar 2021 00:57:36 +0100 util.jsonschema: Library for JSON Schema validation https://soft.trung.fun/code/prosody/log/66d4067bdfb2/.luacheckrc Kim Alvefur <zash@zash.se> Sat, 06 Mar 2021 21:07:53 +0100 luacheck: Remove exception for net.cqueues since it is now clean https://soft.trung.fun/code/prosody/log/2451e3918c2c/.luacheckrc Kim Alvefur <zash@zash.se> Wed, 08 Jul 2020 20:22:48 +0200 util.sasl.digest-md5: Remove, obsolete since 2011 https://soft.trung.fun/code/prosody/log/144a1ee24a4e/.luacheckrc
RFC 6331 lists several problems with this outdated authentication
mechanism. The code here was also completely ignored by lint checks and
has probably not been used for a long time, as it is incompatible with
SCRAM-hashed password storage.]]> Kim Alvefur <zash@zash.se> Tue, 14 Apr 2020 16:51:24 +0200 luacheck: Don't not warn about not using secondary return values https://soft.trung.fun/code/prosody/log/d59be9befad7/.luacheckrc
Brace for ONE BILLION WARNINGS!!!]]> Kim Alvefur <zash@zash.se> Fri, 20 Dec 2019 22:23:22 +0100 .luacheckrc: Remove passing spec/ files from ignore list https://soft.trung.fun/code/prosody/log/d302fc749464/.luacheckrc Matthew Wild <mwild1@gmail.com> Mon, 09 Dec 2019 12:44:43 +0000 .luacheckrc: Remove passing file from ignore list https://soft.trung.fun/code/prosody/log/ec67425dedf1/.luacheckrc Matthew Wild <mwild1@gmail.com> Mon, 09 Dec 2019 12:42:22 +0000 .luacheckrc: Correct indentation of 'exclude_files' list https://soft.trung.fun/code/prosody/log/5d5e3d982bdc/.luacheckrc Kim Alvefur <zash@zash.se> Mon, 01 Apr 2019 21:15:47 +0200 .luacheckrc: Update to reflect new module API methods https://soft.trung.fun/code/prosody/log/7be5477c399e/.luacheckrc Matthew Wild <mwild1@gmail.com> Tue, 19 Mar 2019 09:07:36 +0000 luacheckrc: Teach luacheck about the new module:send_iq() API https://soft.trung.fun/code/prosody/log/8132030ff04a/.luacheckrc Kim Alvefur <zash@zash.se> Sun, 30 Dec 2018 03:20:37 +0100 net.adns: Silence individual luacheck warnings instead of ignoring entire file https://soft.trung.fun/code/prosody/log/47121e8dc5b1/.luacheckrc Kim Alvefur <zash@zash.se> Mon, 24 Dec 2018 03:00:27 +0100 luacheckrc: No longer ignore access to undefined fields on table lib https://soft.trung.fun/code/prosody/log/faebfd3ad2a1/.luacheckrc Kim Alvefur <zash@zash.se> Sat, 08 Dec 2018 17:13:39 +0100 lint: No longer ignore access to the deprecated global 'unpack' https://soft.trung.fun/code/prosody/log/75ed3403065d/.luacheckrc
_G.unpack is deprecated in Lua 5.2]]> Kim Alvefur <zash@zash.se> Sat, 08 Dec 2018 17:07:28 +0100 luacheckrc: Set Lua standard to 5.3 with 5.2 compat enabled https://soft.trung.fun/code/prosody/log/9e2ee40b4a0a/.luacheckrc Kim Alvefur <zash@zash.se> Sat, 08 Dec 2018 17:00:30 +0100 mod_net_multiplex: Remove exception from luacheck https://soft.trung.fun/code/prosody/log/eacdafd07217/.luacheckrc Kim Alvefur <zash@zash.se> Wed, 10 Oct 2018 21:55:58 +0200 mod_http_files: Remove exception from luacheck https://soft.trung.fun/code/prosody/log/cc19b8f8e692/.luacheckrc Kim Alvefur <zash@zash.se> Wed, 10 Oct 2018 21:53:15 +0200 mod_privacy: Remove exception from luacheck https://soft.trung.fun/code/prosody/log/009f7054a9a5/.luacheckrc
Plugin has been removed and replaced by a tombstone, no point in
excluding it from linting]]> Kim Alvefur <zash@zash.se> Wed, 10 Oct 2018 21:48:38 +0200 mod_storage_sql: Remove exception from luacheck https://soft.trung.fun/code/prosody/log/640c4f1b69a1/.luacheckrc Kim Alvefur <zash@zash.se> Wed, 10 Oct 2018 21:22:43 +0200 .luacheckrc: Ignore unused secondaries in non-strict mode https://soft.trung.fun/code/prosody/log/4e881be88727/.luacheckrc
Previous commit was backwards]]> Kim Alvefur <zash@zash.se> Sat, 06 Oct 2018 18:56:22 +0200 .luacheckrc: Do not ignore unused secondaries in strict mode https://soft.trung.fun/code/prosody/log/f210ee7dffe9/.luacheckrc Kim Alvefur <zash@zash.se> Sat, 06 Oct 2018 18:52:52 +0200 mod_websocket: Silence the one warning instead of ignoring the entire file https://soft.trung.fun/code/prosody/log/02155a10c5e9/.luacheckrc Kim Alvefur <zash@zash.se> Sun, 30 Sep 2018 17:55:13 +0200 mod_s2s: Silence all warnings instead of ignoring the entire module https://soft.trung.fun/code/prosody/log/063977461363/.luacheckrc Kim Alvefur <zash@zash.se> Sun, 30 Sep 2018 17:49:56 +0200 mod_admin_telnet: Remove from luacheck ignore list https://soft.trung.fun/code/prosody/log/0a8ddd855587/.luacheckrc Kim Alvefur <zash@zash.se> Sun, 30 Sep 2018 14:38:32 +0200 mod_admin_adhoc: Remove from global luacheck ignore list https://soft.trung.fun/code/prosody/log/7f8ba13b4dd6/.luacheckrc Kim Alvefur <zash@zash.se> Sun, 30 Sep 2018 13:37:13 +0200 .luacheckrc: Allow randomize() global in spec/ https://soft.trung.fun/code/prosody/log/b749cce57f08/.luacheckrc
This is a busted function that is not currently recognized by luacheck.

See https://github.com/mpeterv/luacheck/pull/183]]> Matthew Wild <mwild1@gmail.com> Sat, 29 Sep 2018 12:20:51 +0100 util.json tests: Add [luacheck] annotation to mark intentionally-empty if branch https://soft.trung.fun/code/prosody/log/c9c4b8bc53b1/.luacheckrc Matthew Wild <mwild1@gmail.com> Mon, 17 Sep 2018 15:28:53 +0100 .luacheckrc: Remove util_cache_spec.lua from the ignore list https://soft.trung.fun/code/prosody/log/982f8ae61de2/.luacheckrc Matthew Wild <mwild1@gmail.com> Mon, 17 Sep 2018 15:27:01 +0100 .luacheckrc: Remove aspirational goals from strict check, keep it simple for now https://soft.trung.fun/code/prosody/log/0616412409c5/.luacheckrc Matthew Wild <mwild1@gmail.com> Thu, 13 Sep 2018 16:17:46 +0100 luacheckrc: Remove mod_groups from ignored files https://soft.trung.fun/code/prosody/log/903351e082aa/.luacheckrc Kim Alvefur <zash@zash.se> Sat, 07 Jul 2018 21:00:14 +0200 luacheckrc: Remove exception for modules that produce no warnings https://soft.trung.fun/code/prosody/log/47dd2e850781/.luacheckrc Kim Alvefur <zash@zash.se> Fri, 06 Jul 2018 00:19:22 +0200 mod_announce: Fix luacheck warnings https://soft.trung.fun/code/prosody/log/71500c68fed4/.luacheckrc Kim Alvefur <zash@zash.se> Fri, 06 Jul 2018 00:16:48 +0200 luacheckrc: Consider mod_http clean https://soft.trung.fun/code/prosody/log/188c05e906f1/.luacheckrc Kim Alvefur <zash@zash.se> Fri, 06 Jul 2018 00:16:17 +0200 luacheckrc: Remove exception for mod_pep, it's clean https://soft.trung.fun/code/prosody/log/27c6fff84c8f/.luacheckrc Kim Alvefur <zash@zash.se> Fri, 06 Jul 2018 00:06:36 +0200 .luacheckrc: Remove mod_pubsub/pubsub.lib.lua from files excluded from checks https://soft.trung.fun/code/prosody/log/9232305618ac/.luacheckrc Kim Alvefur <zash@zash.se> Wed, 23 May 2018 15:02:55 +0200