From 9005d35b4850dcde6d8fb4cba713f50a641a5b88 Mon Sep 17 00:00:00 2001 From: Kim Alvefur Date: Fri, 8 Nov 2024 02:11:00 +0100 Subject: util.pubsub: Add method returning subset of config as metadata Allows granting read only access to other sets of users using a separate access control capability, which makes sense as some properties may be intended to be public but read-only. --- spec/util_pubsub_spec.lua | 10 ++++++++++ util/pubsub.lua | 19 +++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/spec/util_pubsub_spec.lua b/spec/util_pubsub_spec.lua index f968fb97..a03ffa64 100644 --- a/spec/util_pubsub_spec.lua +++ b/spec/util_pubsub_spec.lua @@ -605,4 +605,14 @@ describe("util.pubsub", function () end); end) + + describe("metadata", function() + it("works", function() + local service = pubsub.new { metadata_subset = { "title" } }; + assert.truthy(service:create("node", true, { title = "Hello", secret = "hidden" })) + local ok, meta = service:get_node_metadata("node", "nobody"); + assert.truthy(ok, meta); + assert.same({ title = "Hello" }, meta); + end) + end); end); diff --git a/util/pubsub.lua b/util/pubsub.lua index 11ed4e1c..d6779736 100644 --- a/util/pubsub.lua +++ b/util/pubsub.lua @@ -11,6 +11,7 @@ local default_config = { itemcheck = function () return true; end; get_affiliation = function () end; normalize_jid = function (jid) return jid; end; + metadata_subset = {}; capabilities = { outcast = { create = false; @@ -45,6 +46,7 @@ local default_config = { get_subscription = true; get_subscriptions = true; get_items = false; + get_metadata = true; subscribe_other = false; unsubscribe_other = false; @@ -67,6 +69,7 @@ local default_config = { get_subscription = true; get_subscriptions = true; get_items = true; + get_metadata = true; subscribe_other = false; unsubscribe_other = false; @@ -90,6 +93,7 @@ local default_config = { get_subscription = true; get_subscriptions = true; get_items = true; + get_metadata = true; subscribe_other = false; unsubscribe_other = false; @@ -115,6 +119,7 @@ local default_config = { get_subscription = true; get_subscriptions = true; get_items = true; + get_metadata = true; subscribe_other = true; @@ -872,6 +877,20 @@ function service:get_node_config(node, actor) --> (true, config) or (false, err) return true, config_table; end +function service:get_node_metadata(node, actor) + if not self:may(node, actor, "get_metadata") then + return false, "forbidden"; + end + + local ok, config = self:get_node_config(node, true); + if not ok then return ok, config; end + local meta = {}; + for _, k in ipairs(self.config.metadata_subset) do + meta[k] = config[k]; + end + return true, meta; +end + return { new = new; }; -- cgit v1.2.3