1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
|
# Copyright (C) 2020 Philipp Hörist <philipp AT hoerist.com>
#
# This file is part of nbxmpp.
#
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import annotations
from typing import Any
from typing import Literal
from typing import NamedTuple
from typing import TYPE_CHECKING
from dataclasses import dataclass
from nbxmpp.const import MessageType
from nbxmpp.errors import is_error
from nbxmpp.errors import MalformedStanzaError
from nbxmpp.errors import PubSubStanzaError
from nbxmpp.modules.base import BaseModule
from nbxmpp.modules.dataforms import extend_form
from nbxmpp.modules.util import finalize
from nbxmpp.modules.util import process_response
from nbxmpp.modules.util import raise_if_error
from nbxmpp.namespaces import Namespace
from nbxmpp.protocol import Iq
from nbxmpp.protocol import JID
from nbxmpp.protocol import Message
from nbxmpp.protocol import Node
from nbxmpp.structs import CommonResult
from nbxmpp.structs import MessageProperties
from nbxmpp.structs import PubSubEventData
from nbxmpp.structs import StanzaHandler
from nbxmpp.task import iq_request_task
if TYPE_CHECKING:
from nbxmpp.client import Client
class PubSub(BaseModule):
def __init__(self, client: Client) -> None:
BaseModule.__init__(self, client)
self._client = client
self.handlers = [
StanzaHandler(
name="message",
callback=self._process_pubsub_base,
ns=Namespace.PUBSUB_EVENT,
priority=15,
),
]
def _process_pubsub_base(
self, _client: Client, stanza: Message, properties: MessageProperties
) -> None:
if properties.type not in (MessageType.HEADLINE, MessageType.NORMAL):
return
properties.pubsub = True
assert properties.jid is not None
if properties.jid.is_full:
self._log.warning("PubSub event from full jid %s", properties.jid)
self._log.warning(stanza)
return
event = stanza.getTag("event", namespace=Namespace.PUBSUB_EVENT)
delete = event.getTag("delete")
if delete is not None:
node = delete.getAttr("node")
properties.pubsub_event = PubSubEventData(node, deleted=True)
return
purge = event.getTag("purge")
if purge is not None:
node = purge.getAttr("node")
properties.pubsub_event = PubSubEventData(node, purged=True)
return
items = event.getTag("items")
if items is not None:
node = items.getAttr("node")
retract = items.getTag("retract")
if retract is not None:
id_ = retract.getAttr("id")
properties.pubsub_event = PubSubEventData(node, id_, retracted=True)
return
if len(items.getChildren()) != 1:
self._log.warning("PubSub event with != 1 item")
self._log.warning(stanza)
return
item = items.getTag("item")
if item is None:
self._log.warning("No item node found")
self._log.warning(stanza)
return
id_ = item.getAttr("id")
properties.pubsub_event = PubSubEventData(node, id_, item)
@iq_request_task
def request_item(self, node: str, id_: str, jid: JID | None = None):
task = yield
response = yield _make_pubsub_request(node, id_=id_, jid=jid)
if response.isError():
raise PubSubStanzaError(response)
item = _get_pubsub_item(response, node, id_)
yield task.set_result(item)
@iq_request_task
def request_items(
self, node: str, max_items: int | None = None, jid: JID | None = None
):
_task = yield
response = yield _make_pubsub_request(node, max_items=max_items, jid=jid)
if response.isError():
raise PubSubStanzaError(response)
yield _get_pubsub_items(response, node)
@iq_request_task
def publish(
self,
node: str,
item: Node,
id_: str | None = None,
options: dict[str, str] | None = None,
jid: JID | None = None,
force_node_options: bool = False,
):
_task = yield
request = _make_publish_request(node, item, id_, options, jid)
response = yield request
if response.isError():
error = PubSubStanzaError(response)
if not force_node_options or error.app_condition != "precondition-not-met":
raise error
result = yield self.reconfigure_node(node, options, jid)
if is_error(result):
raise result
response = yield request
if response.isError():
raise PubSubStanzaError(response)
jid = response.getFrom()
item_id = _get_published_item_id(response, node, id_)
yield PubSubPublishResult(jid, node, item_id)
@iq_request_task
def get_access_model(self, node: str):
_task = yield
result = yield self.get_node_configuration(node)
raise_if_error(result)
yield result.form["pubsub#access_model"].value
@iq_request_task
def set_access_model(self, node: str, model: Literal["open", "presence"]):
task = yield
if model not in ("open", "presence"):
raise ValueError("Invalid access model")
result = yield self.get_node_configuration(node)
raise_if_error(result)
try:
access_model = result.form["pubsub#access_model"].value
except Exception:
yield task.set_error("warning", condition="access-model-not-supported")
if access_model == model:
jid = self._client.get_bound_jid().new_as_bare()
yield CommonResult(jid=jid)
result.form["pubsub#access_model"].value = model
result = yield self.set_node_configuration(node, result.form)
yield finalize(task, result)
@iq_request_task
def retract(self, node: str, id_: str, jid: JID | None = None, notify: bool = True):
_task = yield
response = yield _make_retract_request(node, id_, jid, notify)
yield process_response(response)
@iq_request_task
def purge(self, node: str, jid: JID | None = None):
_task = yield
response = yield _make_purge_request(node, jid)
yield process_response(response)
@iq_request_task
def delete(self, node: str, jid: JID | None = None):
_task = yield
response = yield _make_delete_request(node, jid)
yield process_response(response)
@iq_request_task
def reconfigure_node(self, node: str, options: dict[str, str], jid=None):
_task = yield
result = yield self.get_node_configuration(node, jid)
if is_error(result):
raise result
_apply_options(result.form, options)
result = yield self.set_node_configuration(node, result.form, jid)
yield result
@iq_request_task
def set_node_configuration(self, node: Node, form, jid: JID | None = None):
_task = yield
response = yield _make_node_configuration(node, form, jid)
yield process_response(response)
@iq_request_task
def get_node_configuration(self, node: str, jid: JID | None = None):
_task = yield
response = yield _make_node_configuration_request(node, jid)
if response.isError():
raise PubSubStanzaError(response)
jid = response.getFrom()
form = _get_configure_form(response, node)
yield PubSubNodeConfigurationResult(jid=jid, node=node, form=form)
@iq_request_task
def get_subscriptions(self, jid: JID):
_task = yield
response = yield _make_get_subscription_request(jid)
if response.isError():
raise PubSubStanzaError(response)
pubsub_node = response.getTag("pubsub", namespace=Namespace.PUBSUB)
if pubsub_node is None:
raise MalformedStanzaError("pubsub node missing", response)
subscriptions = pubsub_node.getTag("subscriptions", namespace=Namespace.PUBSUB)
if subscriptions is None:
raise MalformedStanzaError("subscriptions node missing", response)
result = []
for item in subscriptions.getTags("subscription", namespace=Namespace.PUBSUB):
try:
sub = PubSubSubscription.from_response(item)
except MalformedStanzaError as error:
self._log.warning(error)
self._log.warning(error.stanza)
continue
result.append(sub)
yield result
@iq_request_task
def subscribe(self, node: str, jid: str | None = None):
_task = yield
own_jid = self._client.get_bound_jid().new_as_bare()
response = yield _make_subscribe_request(node, own_jid, jid)
if response.isError():
raise PubSubStanzaError(response)
item = _get_subscription_item(response)
if item is None:
raise MalformedStanzaError("subscription node missing", response)
yield PubSubSubscription.from_response(item)
@iq_request_task
def unsubscribe(self, node: str, jid: str | None = None):
_task = yield
own_jid = self._client.get_bound_jid().new_as_bare()
response = yield _make_unsubscribe_request(node, own_jid, jid)
yield process_response(response)
def get_pubsub_request(
jid: JID, node: str, id_: str | None = None, max_items: int | None = None
) -> Iq:
query = Iq("get", to=jid)
pubsub = query.addChild("pubsub", namespace=Namespace.PUBSUB)
items = pubsub.addChild("items", {"node": node})
if max_items is not None:
items.setAttr("max_items", max_items)
if id_ is not None:
items.addChild("item", {"id": id_})
return query
def get_pubsub_item(stanza: Node) -> Node | None:
pubsub_node = stanza.getTag("pubsub")
items_node = pubsub_node.getTag("items")
return items_node.getTag("item")
def get_pubsub_items(stanza: Node, node: str | None = None) -> list[Node] | None:
pubsub_node = stanza.getTag("pubsub")
items_node = pubsub_node.getTag("items")
if node is not None and items_node.getAttr("node") != node:
return None
if items_node is not None:
return items_node.getTags("item")
return None
def get_publish_options(config: dict[str, str]) -> Node:
options = Node(Namespace.DATA + " x", attrs={"type": "submit"})
field = options.addChild("field", attrs={"var": "FORM_TYPE", "type": "hidden"})
field.setTagData("value", Namespace.PUBSUB_PUBLISH_OPTIONS)
for var, value in config.items():
field = options.addChild("field", attrs={"var": var})
field.setTagData("value", value)
return options
def _get_pubsub_items(response: Iq, node: str) -> list[Node]:
pubsub_node = response.getTag("pubsub", namespace=Namespace.PUBSUB)
if pubsub_node is None:
raise MalformedStanzaError("pubsub node missing", response)
items_node = pubsub_node.getTag("items")
if items_node is None:
raise MalformedStanzaError("items node missing", response)
if items_node.getAttr("node") != node:
raise MalformedStanzaError("invalid node attr", response)
return items_node.getTags("item")
def _get_pubsub_item(response: Iq, node: str, id_: str) -> Node | None:
items = _get_pubsub_items(response, node)
if len(items) > 1:
raise MalformedStanzaError("multiple items found", response)
if not items:
return None
item = items[0]
if item.getAttr("id") != id_:
raise MalformedStanzaError("invalid item id", response)
return item
def _get_subscription_item(response: Iq) -> Node | None:
pubsub_node = response.getTag("pubsub", namespace=Namespace.PUBSUB)
if pubsub_node is None:
raise MalformedStanzaError("pubsub node missing", response)
return pubsub_node.getTag("subscription", namespace=Namespace.PUBSUB)
def _make_pubsub_request(
node: str,
id_: str | None = None,
max_items: int | None = None,
jid: JID | None = None,
) -> Iq:
query = Iq("get", to=jid)
pubsub = query.addChild("pubsub", namespace=Namespace.PUBSUB)
items = pubsub.addChild("items", {"node": node})
if max_items is not None:
items.setAttr("max_items", max_items)
if id_ is not None:
items.addChild("item", {"id": id_})
return query
def _get_configure_form(response: Iq, node: str):
pubsub = response.getTag("pubsub", namespace=Namespace.PUBSUB_OWNER)
if pubsub is None:
raise MalformedStanzaError("pubsub node missing", response)
configure = pubsub.getTag("configure")
if configure is None:
raise MalformedStanzaError("configure node missing", response)
if node != configure.getAttr("node"):
raise MalformedStanzaError("invalid node attribute", response)
forms = configure.getTags("x", namespace=Namespace.DATA)
for form in forms:
dataform = extend_form(node=form)
form_type = dataform.vars.get("FORM_TYPE")
if form_type is None or form_type.value != Namespace.PUBSUB_CONFIG:
continue
return dataform
raise MalformedStanzaError("no valid form type found", response)
def _get_published_item_id(response: Iq, node: str, id_: str | None) -> str | None:
pubsub = response.getTag("pubsub", namespace=Namespace.PUBSUB)
if pubsub is None:
# https://xmpp.org/extensions/xep-0060.html#publisher-publish-success
# If the publish request did not include an ItemID,
# the IQ-result SHOULD include an empty <item/> element
# that specifies the ItemID of the published item.
#
# If the server did not add a payload we assume the item was
# published with the id we requested
return id_
publish = pubsub.getTag("publish")
if publish is None:
raise MalformedStanzaError("publish node missing", response)
if node != publish.getAttr("node"):
raise MalformedStanzaError("invalid node attribute", response)
item = publish.getTag("item")
if item is None:
raise MalformedStanzaError("item node missing", response)
item_id = item.getAttr("id")
if id_ is not None and item_id != id_:
raise MalformedStanzaError("invalid item id", response)
return item_id
def _make_publish_request(
node: str,
item: Node,
id_: str | None,
options: dict[str, str] | None,
jid: JID | None,
) -> Iq:
query = Iq("set", to=jid)
pubsub = query.addChild("pubsub", namespace=Namespace.PUBSUB)
publish = pubsub.addChild("publish", {"node": node})
attrs = {}
if id_ is not None:
attrs = {"id": id_}
publish.addChild("item", attrs, [item])
if options:
publish = pubsub.addChild("publish-options")
publish.addChild(node=_make_publish_options(options))
return query
def _make_publish_options(options: dict[str, str]) -> Node:
data = Node(Namespace.DATA + " x", attrs={"type": "submit"})
field = data.addChild("field", attrs={"var": "FORM_TYPE", "type": "hidden"})
field.setTagData("value", Namespace.PUBSUB_PUBLISH_OPTIONS)
for var, value in options.items():
field = data.addChild("field", attrs={"var": var})
field.setTagData("value", value)
return data
def _make_retract_request(node: str, id_: str, jid: JID | None, notify: bool) -> Iq:
query = Iq("set", to=jid)
pubsub = query.addChild("pubsub", namespace=Namespace.PUBSUB)
attrs = {"node": node}
if notify:
attrs["notify"] = "true"
retract = pubsub.addChild("retract", attrs=attrs)
retract.addChild("item", {"id": id_})
return query
def _make_purge_request(node: str, jid: JID | None) -> Iq:
query = Iq("set", to=jid)
pubsub = query.addChild("pubsub", namespace=Namespace.PUBSUB_OWNER)
pubsub.addChild("purge", attrs={"node": node})
return query
def _make_delete_request(node: str, jid: JID | None) -> Iq:
query = Iq("set", to=jid)
pubsub = query.addChild("pubsub", namespace=Namespace.PUBSUB_OWNER)
pubsub.addChild("delete", attrs={"node": node})
return query
def _make_node_configuration(node: Node, form, jid: JID | None) -> Iq:
query = Iq("set", to=jid)
pubsub = query.addChild("pubsub", namespace=Namespace.PUBSUB_OWNER)
configure = pubsub.addChild("configure", {"node": node})
form.setAttr("type", "submit")
configure.addChild(node=form)
return query
def _make_node_configuration_request(node: str, jid: JID | None) -> Iq:
query = Iq("get", to=jid)
pubsub = query.addChild("pubsub", namespace=Namespace.PUBSUB_OWNER)
pubsub.addChild("configure", {"node": node})
return query
def _make_get_subscription_request(
jid: JID | None = None,
) -> Iq:
query = Iq("get", to=jid)
pubsub = query.addChild("pubsub", namespace=Namespace.PUBSUB)
pubsub.addChild("subscriptions")
return query
def _make_subscribe_request(node: str, own_jid: JID, jid: JID | None = None) -> Iq:
query = Iq("set", to=jid)
pb = query.addChild("pubsub", namespace=Namespace.PUBSUB)
pb.addChild("subscribe", {"node": node, "jid": str(own_jid)})
return query
def _make_unsubscribe_request(node: str, own_jid: JID, jid: JID | None = None) -> Iq:
query = Iq("set", to=jid)
pb = query.addChild("pubsub", namespace=Namespace.PUBSUB)
pb.addChild("unsubscribe", {"node": node, "jid": str(own_jid)})
return query
def _apply_options(form, options: dict[str, str]) -> None:
for var, value in options.items():
try:
field = form[var]
except KeyError:
pass
else:
field.value = value
class PubSubNodeConfigurationResult(NamedTuple):
jid: JID
node: str
form: Any
class PubSubPublishResult(NamedTuple):
jid: JID
node: str
id: str
@dataclass
class PubSubSubscription:
node: str
jid: JID
subscription: str
subid: str | None
@classmethod
def from_response(cls, sub_item: Iq) -> PubSubSubscription:
node = sub_item.getAttr("node")
if not node:
raise MalformedStanzaError("node attr is missing", sub_item)
jid = sub_item.getAttr("jid")
if not jid:
raise MalformedStanzaError("jid attr is missing", sub_item)
try:
jid = JID.from_string(jid)
except Exception:
raise MalformedStanzaError("jid is invalidvalid", sub_item)
subscription = sub_item.getAttr("subscription")
if not subscription:
raise MalformedStanzaError("subscription attr is missing", sub_item)
if subscription not in ("none", "pending", "subscribed", "unconfigured"):
raise MalformedStanzaError(
"unknown subscription value '%s'" % subscription, sub_item
)
subid = sub_item.getAttr("subid")
return cls(node=node, jid=jid, subscription=subscription, subid=subid)
|