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
|
# Copyright (C) 2019 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 TYPE_CHECKING
from nbxmpp.const import AnonymityMode
from nbxmpp.errors import MalformedStanzaError
from nbxmpp.errors import StanzaError
from nbxmpp.modules.base import BaseModule
from nbxmpp.modules.dataforms import extend_form
from nbxmpp.modules.util import finalize
from nbxmpp.namespaces import Namespace
from nbxmpp.protocol import Iq
from nbxmpp.protocol import Node
from nbxmpp.structs import MuclumbusItem
from nbxmpp.structs import MuclumbusResult
from nbxmpp.task import iq_request_task
if TYPE_CHECKING:
from nbxmpp.client import Client
# API Documentation
# https://search.jabber.network/docs/api
class Muclumbus(BaseModule):
def __init__(self, client: Client) -> None:
BaseModule.__init__(self, client)
self._client = client
self.handlers = []
@iq_request_task
def request_parameters(self, jid: str):
task = yield
response = yield _make_parameter_request(jid)
if response.isError():
raise StanzaError(response)
search = response.getTag("search", namespace=Namespace.MUCLUMBUS)
if search is None:
raise MalformedStanzaError("search node missing", response)
dataform = search.getTag("x", namespace=Namespace.DATA)
if dataform is None:
raise MalformedStanzaError("dataform node missing", response)
self._log.info("Muclumbus parameters received")
yield finalize(task, extend_form(node=dataform))
@iq_request_task
def set_search(
self, jid: str, dataform, items_per_page: int = 50, after: str | None = None
):
_task = yield
response = yield _make_search_query(jid, dataform, items_per_page, after)
if response.isError():
raise StanzaError(response)
result = response.getTag("result", namespace=Namespace.MUCLUMBUS)
if result is None:
raise MalformedStanzaError("result node missing", response)
items = result.getTags("item")
if not items:
yield MuclumbusResult(first=None, last=None, max=None, end=True, items=[])
set_ = result.getTag("set", namespace=Namespace.RSM)
if set_ is None:
raise MalformedStanzaError("set node missing", response)
first = set_.getTagData("first")
last = set_.getTagData("last")
try:
max_ = int(set_.getTagData("max"))
except Exception:
raise MalformedStanzaError("invalid max value", response)
results: list[MuclumbusItem] = []
for item in items:
jid = item.getAttr("address")
name = item.getTagData("name")
nusers = item.getTagData("nusers")
description = item.getTagData("description")
language = item.getTagData("language")
is_open = item.getTag("is-open") is not None
try:
anonymity_mode = AnonymityMode(item.getTagData("anonymity-mode"))
except ValueError:
anonymity_mode = AnonymityMode.UNKNOWN
results.append(
MuclumbusItem(
jid=jid,
name=name or "",
nusers=nusers or "",
description=description or "",
language=language or "",
is_open=is_open,
anonymity_mode=anonymity_mode,
)
)
yield MuclumbusResult(
first=first, last=last, max=max_, end=len(items) < max_, items=results
)
def _make_parameter_request(jid: str) -> Iq:
query = Iq(to=jid, typ="get")
query.addChild(node=Node("search", attrs={"xmlns": Namespace.MUCLUMBUS}))
return query
def _make_search_query(
jid: str, dataform, items_per_page: int = 50, after: str | None = None
) -> Iq:
search = Node("search", attrs={"xmlns": Namespace.MUCLUMBUS})
search.addChild(node=dataform)
rsm = search.addChild("set", namespace=Namespace.RSM)
rsm.addChild("max").setData(items_per_page)
if after is not None:
rsm.addChild("after").setData(after)
query = Iq(to=jid, typ="get")
query.addChild(node=search)
return query
|