mirror of
https://github.com/bjc/prosody.git
synced 2025-04-04 21:57:45 +03:00
util.pubsub, pubsub.lib and tests: Add text to precondition-not-met error (fixes #1455)
This commit is contained in:
Matthew Wild
parent
7207a107fd
commit
b5b9b70c88
4 changed files with 248 additions and 4 deletions
|
|
@ -7,6 +7,7 @@ local st = require "util.stanza";
|
||||||
local it = require "util.iterators";
|
local it = require "util.iterators";
|
||||||
local uuid_generate = require "util.uuid".generate;
|
local uuid_generate = require "util.uuid".generate;
|
||||||
local dataform = require"util.dataforms".new;
|
local dataform = require"util.dataforms".new;
|
||||||
|
local errors = require "util.error";
|
||||||
|
|
||||||
local xmlns_pubsub = "http://jabber.org/protocol/pubsub";
|
local xmlns_pubsub = "http://jabber.org/protocol/pubsub";
|
||||||
local xmlns_pubsub_errors = "http://jabber.org/protocol/pubsub#errors";
|
local xmlns_pubsub_errors = "http://jabber.org/protocol/pubsub#errors";
|
||||||
|
|
@ -34,6 +35,9 @@ local pubsub_errors = {
|
||||||
};
|
};
|
||||||
local function pubsub_error_reply(stanza, error)
|
local function pubsub_error_reply(stanza, error)
|
||||||
local e = pubsub_errors[error];
|
local e = pubsub_errors[error];
|
||||||
|
if not e and errors.is_err(error) then
|
||||||
|
e = { error.type, error.condition, error.text, error.pubsub_condition };
|
||||||
|
end
|
||||||
local reply = st.error_reply(stanza, t_unpack(e, 1, 3));
|
local reply = st.error_reply(stanza, t_unpack(e, 1, 3));
|
||||||
if e[4] then
|
if e[4] then
|
||||||
reply:tag(e[4], { xmlns = xmlns_pubsub_errors }):up();
|
reply:tag(e[4], { xmlns = xmlns_pubsub_errors }):up();
|
||||||
|
|
|
||||||
234
spec/scansion/pubsub_preconditions.scs
Normal file
234
spec/scansion/pubsub_preconditions.scs
Normal file
|
|
@ -0,0 +1,234 @@
|
||||||
|
# Pubsub preconditions are enforced
|
||||||
|
|
||||||
|
[Client] Romeo
|
||||||
|
password: password
|
||||||
|
jid: jqpcrbq2@localhost
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
Romeo connects
|
||||||
|
|
||||||
|
Romeo sends:
|
||||||
|
<iq id="67eb1f47-1e69-4cb3-91e2-4d5943e72d4c" type="set">
|
||||||
|
<pubsub xmlns="http://jabber.org/protocol/pubsub">
|
||||||
|
<publish node="http://jabber.org/protocol/tune">
|
||||||
|
<item id="current">
|
||||||
|
<tune xmlns="http://jabber.org/protocol/tune"/>
|
||||||
|
</item>
|
||||||
|
</publish>
|
||||||
|
</pubsub>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Romeo receives:
|
||||||
|
<iq id="67eb1f47-1e69-4cb3-91e2-4d5943e72d4c" type="result">
|
||||||
|
<pubsub xmlns="http://jabber.org/protocol/pubsub">
|
||||||
|
<publish node="http://jabber.org/protocol/tune">
|
||||||
|
<item id="current"/>
|
||||||
|
</publish>
|
||||||
|
</pubsub>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Romeo sends:
|
||||||
|
<iq id="52d74a36-afb0-4028-87ed-b25b988b049e" type="get">
|
||||||
|
<pubsub xmlns="http://jabber.org/protocol/pubsub#owner">
|
||||||
|
<configure node="http://jabber.org/protocol/tune"/>
|
||||||
|
</pubsub>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Romeo receives:
|
||||||
|
<iq id="52d74a36-afb0-4028-87ed-b25b988b049e" type="result">
|
||||||
|
<pubsub xmlns="http://jabber.org/protocol/pubsub#owner">
|
||||||
|
<configure node="http://jabber.org/protocol/tune">
|
||||||
|
<x xmlns="jabber:x:data" type="form">
|
||||||
|
<field var="FORM_TYPE" type="hidden">
|
||||||
|
<value>http://jabber.org/protocol/pubsub#node_config</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#title" label="Title" type="text-single"/>
|
||||||
|
<field var="pubsub#description" label="Description" type="text-single"/>
|
||||||
|
<field var="pubsub#type" label="The type of node data, usually specified by the namespace of the payload (if any)" type="text-single"/>
|
||||||
|
<field var="pubsub#max_items" label="Max # of items to persist" type="text-single">
|
||||||
|
<validate xmlns="http://jabber.org/protocol/xdata-validate" datatype="xs:integer"/>
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#persist_items" label="Persist items to storage" type="boolean">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#access_model" label="Specify the subscriber model" type="list-single">
|
||||||
|
<option label="authorize">
|
||||||
|
<value>authorize</value>
|
||||||
|
</option>
|
||||||
|
<option label="open">
|
||||||
|
<value>open</value>
|
||||||
|
</option>
|
||||||
|
<option label="presence">
|
||||||
|
<value>presence</value>
|
||||||
|
</option>
|
||||||
|
<option label="roster">
|
||||||
|
<value>roster</value>
|
||||||
|
</option>
|
||||||
|
<option label="whitelist">
|
||||||
|
<value>whitelist</value>
|
||||||
|
</option>
|
||||||
|
<value>presence</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#publish_model" label="Specify the publisher model" type="list-single">
|
||||||
|
<option label="publishers">
|
||||||
|
<value>publishers</value>
|
||||||
|
</option>
|
||||||
|
<option label="subscribers">
|
||||||
|
<value>subscribers</value>
|
||||||
|
</option>
|
||||||
|
<option label="open">
|
||||||
|
<value>open</value>
|
||||||
|
</option>
|
||||||
|
<value>publishers</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#deliver_notifications" label="Whether to deliver event notifications" type="boolean">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#deliver_payloads" label="Whether to deliver payloads with event notifications" type="boolean">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#notification_type" label="Specify the delivery style for notifications" type="list-single">
|
||||||
|
<option label="Messages of type normal">
|
||||||
|
<value>normal</value>
|
||||||
|
</option>
|
||||||
|
<option label="Messages of type headline">
|
||||||
|
<value>headline</value>
|
||||||
|
</option>
|
||||||
|
<value>headline</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#notify_delete" label="Whether to notify subscribers when the node is deleted" type="boolean">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#notify_retract" label="Whether to notify subscribers when items are removed from the node" type="boolean">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
</x>
|
||||||
|
</configure>
|
||||||
|
</pubsub>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Romeo sends:
|
||||||
|
<iq id="a73aac09-74be-4ee2-97e5-571bbdbcd956" type="set">
|
||||||
|
<pubsub xmlns="http://jabber.org/protocol/pubsub#owner">
|
||||||
|
<configure node="http://jabber.org/protocol/tune">
|
||||||
|
<x xmlns="jabber:x:data" type="submit">
|
||||||
|
<field var="FORM_TYPE" type="hidden">
|
||||||
|
<value>http://jabber.org/protocol/pubsub#node_config</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#title" type="text-single" label="Title">
|
||||||
|
<value>Nice tunes</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#description" type="text-single" label="Description"/>
|
||||||
|
<field var="pubsub#type" type="text-single" label="The type of node data, usually specified by the namespace of the payload (if any)"/>
|
||||||
|
<field var="pubsub#max_items" type="text-single" label="Max # of items to persist">
|
||||||
|
<validate xmlns="http://jabber.org/protocol/xdata-validate" datatype="xs:integer"/>
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#persist_items" type="boolean" label="Persist items to storage">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#access_model" type="list-single" label="Specify the subscriber model">
|
||||||
|
<option label="authorize">
|
||||||
|
<value>authorize</value>
|
||||||
|
</option>
|
||||||
|
<option label="open">
|
||||||
|
<value>open</value>
|
||||||
|
</option>
|
||||||
|
<option label="presence">
|
||||||
|
<value>presence</value>
|
||||||
|
</option>
|
||||||
|
<option label="roster">
|
||||||
|
<value>roster</value>
|
||||||
|
</option>
|
||||||
|
<option label="whitelist">
|
||||||
|
<value>whitelist</value>
|
||||||
|
</option>
|
||||||
|
<value>presence</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#publish_model" type="list-single" label="Specify the publisher model">
|
||||||
|
<option label="publishers">
|
||||||
|
<value>publishers</value>
|
||||||
|
</option>
|
||||||
|
<option label="subscribers">
|
||||||
|
<value>subscribers</value>
|
||||||
|
</option>
|
||||||
|
<option label="open">
|
||||||
|
<value>open</value>
|
||||||
|
</option>
|
||||||
|
<value>publishers</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#deliver_notifications" type="boolean" label="Whether to deliver event notifications">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#deliver_payloads" type="boolean" label="Whether to deliver payloads with event notifications">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#notification_type" type="list-single" label="Specify the delivery style for notifications">
|
||||||
|
<option label="Messages of type normal">
|
||||||
|
<value>normal</value>
|
||||||
|
</option>
|
||||||
|
<option label="Messages of type headline">
|
||||||
|
<value>headline</value>
|
||||||
|
</option>
|
||||||
|
<value>headline</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#notify_delete" type="boolean" label="Whether to notify subscribers when the node is deleted">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#notify_retract" type="boolean" label="Whether to notify subscribers when items are removed from the node">
|
||||||
|
<value>1</value>
|
||||||
|
</field>
|
||||||
|
</x>
|
||||||
|
</configure>
|
||||||
|
</pubsub>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Romeo receives:
|
||||||
|
<iq id="a73aac09-74be-4ee2-97e5-571bbdbcd956" type="result"/>
|
||||||
|
|
||||||
|
Romeo sends:
|
||||||
|
<iq id="ab0e92d2-c06b-4987-9d45-f9f9e7721709" type="get">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items"/>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Romeo receives:
|
||||||
|
<iq id="ab0e92d2-c06b-4987-9d45-f9f9e7721709" type="result">
|
||||||
|
<query xmlns="http://jabber.org/protocol/disco#items">
|
||||||
|
<item name="Nice tunes" node="http://jabber.org/protocol/tune" jid="${Romeo's JID}"/>
|
||||||
|
</query>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Romeo sends:
|
||||||
|
<iq id="67eb1f47-1e69-4cb3-91e2-4d5943e72d4c" type="set">
|
||||||
|
<pubsub xmlns="http://jabber.org/protocol/pubsub">
|
||||||
|
<publish node="http://jabber.org/protocol/tune">
|
||||||
|
<item id="current">
|
||||||
|
<tune xmlns="http://jabber.org/protocol/tune"/>
|
||||||
|
</item>
|
||||||
|
</publish>
|
||||||
|
<publish-options>
|
||||||
|
<x xmlns="jabber:x:data">
|
||||||
|
<field var="FORM_TYPE" type="hidden">
|
||||||
|
<value>http://jabber.org/protocol/pubsub#publish-options</value>
|
||||||
|
</field>
|
||||||
|
<field var="pubsub#access_model">
|
||||||
|
<value>whitelist</value>
|
||||||
|
</field>
|
||||||
|
</x>
|
||||||
|
</publish-options>
|
||||||
|
</pubsub>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Romeo receives:
|
||||||
|
<iq type='error' id='67eb1f47-1e69-4cb3-91e2-4d5943e72d4c'>
|
||||||
|
<error type='cancel'>
|
||||||
|
<conflict xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
|
||||||
|
<text xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'>Field does not match: access_model</text>
|
||||||
|
<precondition-not-met xmlns='http://jabber.org/protocol/pubsub#errors'/>
|
||||||
|
</error>
|
||||||
|
</iq>
|
||||||
|
|
||||||
|
Romeo disconnects
|
||||||
|
|
||||||
|
|
@ -107,7 +107,7 @@ describe("util.pubsub", function ()
|
||||||
it("fails to publish to a node with differing config", function ()
|
it("fails to publish to a node with differing config", function ()
|
||||||
local ok, err = service:publish("node", true, "1", "item 2", { myoption = false });
|
local ok, err = service:publish("node", true, "1", "item 2", { myoption = false });
|
||||||
assert.falsy(ok);
|
assert.falsy(ok);
|
||||||
assert.equals("precondition-not-met", err);
|
assert.equals("precondition-not-met", err.pubsub_condition);
|
||||||
end);
|
end);
|
||||||
|
|
||||||
it("allows to publish to a node with differing config when only defaults are suggested", function ()
|
it("allows to publish to a node with differing config when only defaults are suggested", function ()
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,6 @@
|
||||||
local events = require "util.events";
|
local events = require "util.events";
|
||||||
local cache = require "util.cache";
|
local cache = require "util.cache";
|
||||||
|
local errors = require "util.error";
|
||||||
|
|
||||||
local service_mt = {};
|
local service_mt = {};
|
||||||
|
|
||||||
|
|
@ -510,7 +511,7 @@ local function check_preconditions(node_config, required_config)
|
||||||
end
|
end
|
||||||
for config_field, value in pairs(required_config) do
|
for config_field, value in pairs(required_config) do
|
||||||
if node_config[config_field] ~= value then
|
if node_config[config_field] ~= value then
|
||||||
return false;
|
return false, config_field;
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
return true;
|
return true;
|
||||||
|
|
@ -546,8 +547,13 @@ function service:publish(node, actor, id, item, requested_config) --> ok, err
|
||||||
node_obj = self.nodes[node];
|
node_obj = self.nodes[node];
|
||||||
elseif requested_config and not requested_config._defaults_only then
|
elseif requested_config and not requested_config._defaults_only then
|
||||||
-- Check that node has the requested config before we publish
|
-- Check that node has the requested config before we publish
|
||||||
if not check_preconditions(node_obj.config, requested_config) then
|
local ok, field = check_preconditions(node_obj.config, requested_config);
|
||||||
return false, "precondition-not-met";
|
if not ok then
|
||||||
|
local err = errors.new({
|
||||||
|
type = "cancel", condition = "conflict", text = "Field does not match: "..field;
|
||||||
|
});
|
||||||
|
err.pubsub_condition = "precondition-not-met";
|
||||||
|
return false, err;
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
if not self.config.itemcheck(item) then
|
if not self.config.itemcheck(item) then
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue