prosody-hg: util/stanza.lua history

util.stanza: New :get_meta()/:set_meta() API to attach custom properties to stanza objects

Sat, 06 Dec 2025 17:27:59 +0000

util.stanza: New :get_meta()/:set_meta() API to attach custom properties to stanza objects

These properties do not carry through clone(), and this is an intentional
decision (for now, at least). My feeling is that it is the cloner that knows
what metadata should be carried across to the clone, and the answer is usually
not "all of it".

Metadata is not persisted or serialized. It is designed to last only as long
as the in-memory stanza object, to communicate properties to code that is
processing that stanza object.

Although the API does not currently distinguish between stanzas and child
elements, it is recommended to refrain from setting metadata properties
on child elements as this ability may be removed in the future.

util.stanza: Handle Clark notation for attributes in :find()

Sun, 17 Nov 2024 13:40:20 +0100

util.stanza: Handle Clark notation for attributes in :find()

util.stanza: Handle namespace prefixes for attributes in :find()

Sun, 17 Nov 2024 12:35:51 +0100

util.stanza: Handle namespace prefixes for attributes in :find()

More correct handling of namespaces here.

This works with both prefixes from the parser and hacky .attr["foo:bar"]

util: Prefix module imports with prosody namespace

Fri, 17 Mar 2023 16:23:16 +0100

util: Prefix module imports with prosody namespace

Merge 0.12->trunk

Mon, 12 Dec 2022 07:10:54 +0100

Merge 0.12->trunk

Merge 0.11->0.12

Mon, 12 Dec 2022 07:07:13 +0100

Merge 0.11->0.12

util.stanza: Allow U+7F

Tue, 22 Nov 2022 23:56:01 +0100

util.stanza: Allow U+7F

Allowed by XML despite arguably being a control character.

Drops the part of the range meant to rule out octets invalid in UTF-8
(\247 starts a 4-byte sequence), since UTF-8 correctness is validated by
util.encodings.utf8.valid().

Merge 0.12->trunk

Thu, 15 Sep 2022 11:11:52 +0200

Merge 0.12->trunk

util.stanza: Return nil instead of nothing (fix test with luassert >=1.9)

Thu, 15 Sep 2022 11:05:21 +0200

util.stanza: Return nil instead of nothing (fix test with luassert >=1.9)

Due to a change in luassert, a dependency luassert of the Busted test
framework, returning nothing is no longer treated as not falsy.

util.stanza: Add add_error() to simplify adding error tags to existing stanzas

Mon, 29 Aug 2022 14:59:46 +0100

util.stanza: Add add_error() to simplify adding error tags to existing stanzas

Some fiddling is required now in error_reply() to ensure the cursor is in the
same place as before this change (a lot of code apparently uses that feature).

util.stanza: Add method for extracting a single attribute value

Wed, 17 Aug 2022 19:04:30 +0200

util.stanza: Add method for extracting a single attribute value

Sometimes you only care about a single attribute, but the child tag
itself may be optional, leading to needing `tag and tag.attr.foo` or
`stanza:find("tag@foo")`.

The `:find()` method is fairly complex, so avoiding it for this kind of
simpler use case is a win.

util.stanza: Create tables with correct size to avoid reallocations

Fri, 18 Mar 2022 16:43:06 +0100

util.stanza: Create tables with correct size to avoid reallocations

Potential performance gain since the tables don't need to be resized as
they grow to the final size.

util.stanza: Use table.move in clone

Fri, 18 Mar 2022 16:39:48 +0100

util.stanza: Use table.move in clone

Code reduction, potentially a performance gain.

util.stanza: Remove dead code

Fri, 31 Dec 2021 14:01:12 +0100

util.stanza: Remove dead code

These cases are caught by `check_text(v, ..)` above. Those errors do not
contain the attribute however, which would have been nice.

util.stanza: Make type error message consistent with others

Fri, 31 Dec 2021 13:52:11 +0100

util.stanza: Make type error message consistent with others

util.stanza: Adjust pretty printing for symmetry

Mon, 29 Nov 2021 02:13:45 +0100

util.stanza: Adjust pretty printing for symmetry

Self-closing and had some
asymmetries in applied colors.

util.stanza: Add :get_child_with_attr() + tests

Sun, 12 Sep 2021 10:31:02 +0100

util.stanza: Add :get_child_with_attr() + tests

util.stanza: Export pretty printing function

Tue, 29 Jun 2021 16:06:54 +0200

util.stanza: Export pretty printing function

util.stanza: Simplify and make pretty-printing look nicer

Sat, 07 Nov 2020 22:09:46 +0100

util.stanza: Simplify and make pretty-printing look nicer

I've had this color theme in a local debug module for some time and I
quite like it. The colors are from the XMPP logo.

Removes extra XML serialization implementation in favor of the standard
one. Also removes recursive str=str..more string building.

The new two-level gsub has the accumulator in C space so shouldn't be
too bad. The inner gsub calls use no callback, so should be fast and
not create all that much garbage.

No serious benchmarking has been done, but who cares if it looks nice?

util.stanza: Remove Windows "support" (disabling ANSI color pretty printing)

Sat, 07 Nov 2020 21:39:36 +0100

util.stanza: Remove Windows "support" (disabling ANSI color pretty printing)

Always enable pretty printing if util.termcolours is available

util.termcolours can be nooped out to disable pretty printing.

util.stanza: add at_top helper

Sat, 08 May 2021 16:31:48 +0200

util.stanza: add at_top helper

This allows the user to detect whether the cursor is currently
at the top of the stanza. This will be used by util.xmppstream
to be able to port it over.

Merge 0.11->trunk

Fri, 08 Jan 2021 23:56:27 +0100

Merge 0.11->trunk

util.stanza: Move misplaced argument to correct place

Thu, 24 Dec 2020 17:57:28 +0100

util.stanza: Move misplaced argument to correct place

valid_utf8() takes only one argument, so the false was probably meant
to be valid_xml_cdata(text, attribute=false)

Merge 0.11->trunk

Wed, 11 Nov 2020 16:09:55 +0100

Merge 0.11->trunk

util.stanza: Reject ASCII control characters (fixes #1606)

Wed, 11 Nov 2020 16:00:41 +0100

util.stanza: Reject ASCII control characters (fixes #1606)

util.stanza: Extract Application-Specific Condition from errors

Sat, 26 Sep 2020 18:12:18 +0200

util.stanza: Extract Application-Specific Condition from errors

API change

util.stanza: Support Application-Specific Conditions in util.error

Sat, 26 Sep 2020 18:09:10 +0200

util.stanza: Support Application-Specific Conditions in util.error

util.stanza: Get 'by' from context instead

Sat, 26 Sep 2020 18:07:33 +0200

util.stanza: Get 'by' from context instead

Zash> should go where? extra.by? context? source?
Zash> In Prosody this would usually be module.host or a bare user/room JID
MattJ> Zash: context
MattJ> context.by, basically the opposite of context.actor

util.stanza: Support inclusion of URI from util.error object

Sat, 26 Sep 2020 17:30:47 +0200

util.stanza: Support inclusion of URI from util.error object

util.stanza: Support getting 'by' from util.error object

Sat, 26 Sep 2020 17:26:31 +0200

util.stanza: Support getting 'by' from util.error object

util.stanza: Reorder code to prepare for extracting 'by' from util.error

Sat, 26 Sep 2020 17:18:17 +0200

util.stanza: Reorder code to prepare for extracting 'by' from util.error

util.stanza: Add method returning stanza with added indentation

Sun, 12 Apr 2020 17:03:05 +0200

util.stanza: Add method returning stanza with added indentation

Adds indentation and line breaks to stanzas, to make stanzas easier to
read for humans.

util.stanza: Accept util.error object to error_reply

Sat, 14 Dec 2019 22:47:41 +0100

util.stanza: Accept util.error object to error_reply

If we're moving towards util.error as the standard error container then
this makes sense.

This may allow for future extensibility without needing a lot of
optional arguments.

util.stanza: Support the 'by' attribute on errors

Mon, 25 Nov 2019 20:59:36 +0100

util.stanza: Support the 'by' attribute on errors

This is to be used when the entity generating the error is not the same
as the one the stanza was directed to, e.g. an intermediate server.

util.stanza: Check that argument to error_reply is NOT a stanza of type error

Mon, 25 Nov 2019 20:52:03 +0100

util.stanza: Check that argument to error_reply is NOT a stanza of type error

Replying to an error is Very Bad

util.stanza: Check that argument to error_reply is a stanza

Mon, 25 Nov 2019 20:52:01 +0100

util.stanza: Check that argument to error_reply is a stanza

util.stanza: Remove redundant check for attrs

Mon, 25 Nov 2019 20:46:55 +0100

util.stanza: Remove redundant check for attrs

A stanza can't not have attrs if created the correct way

util.stanza: Check that argument to reply is a stanza

Mon, 25 Nov 2019 20:44:05 +0100

util.stanza: Check that argument to reply is a stanza

util.stanza: Use :text_tag internally everywhere

Fri, 02 Aug 2019 08:56:29 +0200

util.stanza: Use :text_tag internally everywhere

May allow future changes in a single place.

util.stanza: Fix :top_tag() handling of namespaced attributes

Mon, 25 Mar 2019 14:37:43 +0000

util.stanza: Fix :top_tag() handling of namespaced attributes

util.stanza: Require a type attribute for iq stanzas

Fri, 28 Dec 2018 20:49:01 +0100

util.stanza: Require a type attribute for iq stanzas

util.stanza: Deserialize stanza without mutating input (fixes #711)

Sat, 01 Dec 2018 18:30:19 +0100

util.stanza: Deserialize stanza without mutating input (fixes #711)

util.stanza: Validate input to clone() (with brief tests)

Sat, 17 Nov 2018 15:26:11 +0100

util.stanza: Validate input to clone() (with brief tests)

util.stanza: Set preserialize as freeze metamethod

Fri, 12 Oct 2018 00:52:18 +0200

util.stanza: Set preserialize as freeze metamethod

util.stanza: Don't automatically generate ids for iq stanzas

Thu, 13 Sep 2018 16:35:48 +0100

util.stanza: Don't automatically generate ids for iq stanzas

Users of this API should provide their own id attribute that meets their
uniqueness requirements.

The current implementation leaks information (i.e. how many iq stanzas
have been sent by the server to other JIDs). Providing any strong
guarantees of randomness here would need to pull in additional
dependencies that we don't want in this simple library.

util.stanza + tests: Bail out of loop if we are iterating too far, fixes #981

Sun, 19 Aug 2018 21:56:33 +0100

util.stanza + tests: Bail out of loop if we are iterating too far, fixes #981

Merge 0.10->trunk

Sun, 08 Jul 2018 19:12:17 +0200

Merge 0.10->trunk

util.stanza: Add method for removing all children with a specific name, xmlns

Sun, 08 Jul 2018 16:48:59 +0200

util.stanza: Add method for removing all children with a specific name, xmlns

util.stanza: Remove redundant check from :text now done in :add_direct_child

Fri, 08 Jun 2018 17:44:44 +0200

util.stanza: Remove redundant check from :text now done in :add_direct_child

util.stanza: Verify that other objects added as children are valid strings

Fri, 08 Jun 2018 17:06:21 +0200

util.stanza: Verify that other objects added as children are valid strings

util.stanza: Verify that child tags added are really stanzas (closes #1165)

Fri, 08 Jun 2018 17:04:47 +0200

util.stanza: Verify that child tags added are really stanzas (closes #1165)

util.stanza: Add :text_tag(), a shortcut for adding nodes with text

Wed, 21 Mar 2018 23:20:26 +0100

util.stanza: Add :text_tag(), a shortcut for adding nodes with text

util.stanza: Allow :text(nil) and :text("") as harmless nops

Wed, 21 Mar 2018 22:04:20 +0000

util.stanza: Allow :text(nil) and :text("") as harmless nops

util.stanza: Switch from asserts to if's, improve performance, errors and tests

Sun, 18 Mar 2018 11:32:00 +0000

util.stanza: Switch from asserts to if's, improve performance, errors and tests

util.stanza: Add stricter validation for data passed to stanza builder API

Fri, 16 Mar 2018 14:51:24 +0000

util.stanza: Add stricter validation for data passed to stanza builder API

vairious: Add annotation when an empty environment is set [luacheck]

Wed, 28 Feb 2018 20:06:26 +0100

vairious: Add annotation when an empty environment is set [luacheck]

util.stanza: Change type to name as this is used by Lua 5.3 in some error reporting functions

Fri, 16 Feb 2018 08:16:38 +0100

util.stanza: Change __type to __name as this is used by Lua 5.3 in some error reporting functions

util: Various minor changes to please [luacheck]

Fri, 10 Nov 2017 05:42:32 +0100

util: Various minor changes to please [luacheck]

Merge 0.10->trunk

Fri, 02 Dec 2016 11:13:05 +0100

Merge 0.10->trunk

util.stanza: Add an is_stanza() function to check if an object is a stanza

Mon, 28 Nov 2016 07:30:21 +0100

util.stanza: Add an is_stanza() function to check if an object is a stanza