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
|
# 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 AdHocAction
from nbxmpp.const import AdHocNoteType
from nbxmpp.const import AdHocStatus
from nbxmpp.errors import MalformedStanzaError
from nbxmpp.errors import StanzaError
from nbxmpp.modules.base import BaseModule
from nbxmpp.modules.dataforms import MultipleDataForm
from nbxmpp.modules.dataforms import SimpleDataForm
from nbxmpp.modules.discovery import get_disco_request
from nbxmpp.namespaces import Namespace
from nbxmpp.protocol import Iq
from nbxmpp.protocol import Node
from nbxmpp.protocol import Protocol
from nbxmpp.structs import AdHocCommand
from nbxmpp.structs import AdHocCommandNote
from nbxmpp.task import iq_request_task
if TYPE_CHECKING:
from nbxmpp.client import Client
class AdHoc(BaseModule):
def __init__(self, client: Client) -> None:
BaseModule.__init__(self, client)
self._client = client
self.handlers = []
@iq_request_task
def request_command_list(self, jid: str | None = None):
_task = yield
if jid is None:
jid = self._client.get_bound_jid().bare
response = yield get_disco_request(
Namespace.DISCO_ITEMS, jid, node=Namespace.COMMANDS
)
if response.isError():
raise StanzaError(response)
children = response.getQueryChildren()
command_list: list[AdHocCommand] = []
for item in children:
if item.getName() != "item":
continue
try:
command_list.append(AdHocCommand(**item.getAttrs()))
except Exception as error:
raise MalformedStanzaError(
f"invalid item attributes: {error}", response
)
yield command_list
@iq_request_task
def execute_command(
self,
cmd: AdHocCommand,
action: AdHocAction | None = None,
dataform: SimpleDataForm | MultipleDataForm | None = None,
):
_task = yield
if action is None:
action = AdHocAction.EXECUTE
attrs = {"node": cmd.node, "xmlns": Namespace.COMMANDS, "action": action.value}
if cmd.sessionid is not None:
attrs["sessionid"] = cmd.sessionid
response = yield _make_command(cmd, attrs, dataform)
if response.isError():
raise StanzaError(response)
command = response.getTag("command", namespace=Namespace.COMMANDS)
if command is None:
raise MalformedStanzaError("command node missing", response)
node = command.getAttr("node")
if node is None:
raise MalformedStanzaError("node attribute missing", response)
status = command.getAttr("status")
if status is None:
raise MalformedStanzaError("status attribute missing", response)
if status not in ("executing", "completed", "canceled"):
raise MalformedStanzaError("invalid status attribute %s" % status, response)
status = AdHocStatus(status)
sessionid = command.getAttr("sessionid")
if sessionid is None and _expect_sessionid(status, cmd.sessionid):
raise MalformedStanzaError("sessionid attribute missing", response)
try:
notes = _parse_notes(command)
except ValueError as error:
raise MalformedStanzaError(error, response)
try:
actions, default = _parse_actions(command)
except ValueError as error:
raise MalformedStanzaError(error, response)
yield AdHocCommand(
jid=response.getFrom(),
name=None,
node=node,
sessionid=sessionid,
status=status,
data=command.getTag("x", namespace=Namespace.DATA),
actions=actions,
default=default,
notes=notes,
)
def _make_command(
command: AdHocCommand,
attrs: dict[str, Node | str],
dataform: SimpleDataForm | MultipleDataForm | None,
) -> Iq:
command_node = Node("command", attrs=attrs)
if dataform is not None:
command_node.addChild(node=dataform)
iq = Iq("set", to=command.jid)
iq.addChild(node=command_node)
return iq
def _parse_notes(command: Protocol) -> list[AdHocCommandNote]:
notes: list[AdHocCommandNote] = []
for note in command.getTags("note"):
type_ = note.getAttr("type")
if type_ is None:
type_ = "info"
if type_ not in ("info", "warn", "error"):
raise ValueError("invalid note type %s" % type_)
notes.append(AdHocCommandNote(text=note.getData(), type=AdHocNoteType(type_)))
return notes
def _parse_actions(command: Protocol) -> tuple[set[AdHocAction], AdHocAction | None]:
if command.getAttr("status") != "executing":
return set(), None
actions_node = command.getTag("actions")
if actions_node is None:
# If there is no <actions/> element,
# the user-agent can use a single-stage dialog or view.
# The action "execute" is equivalent to the action "complete".
return {AdHocAction.CANCEL, AdHocAction.COMPLETE}, AdHocAction.COMPLETE
default = actions_node.getAttr("execute")
if default is None:
# If the "execute" attribute is absent, it defaults to "next".
default = "next"
if default not in ("prev", "next", "complete"):
raise ValueError("invalid execute attribute %s" % default)
default = AdHocAction(default)
# We use a set because it cannot contain duplicates
actions: set[AdHocAction] = set()
for action in actions_node.getChildren():
name = action.getName()
if name == "execute":
actions.add(default)
if name in ("prev", "next", "complete"):
actions.add(AdHocAction(name))
if not actions:
raise ValueError("actions element without actions")
# The action "cancel" is always allowed.
actions.add(AdHocAction.CANCEL)
# A form which has an <actions/> element and an "execute" attribute
# which evaluates (taking the default into account if absent) to an
# action which is not allowed is therefore invalid.
if default not in actions:
# Some implementations don’t respect this rule.
# Take the first action so we don’t fail here.
for act in actions:
default = act
break
return actions, default
def _expect_sessionid(status: AdHocStatus, sent_sessionid: str | None) -> bool:
# Session id should only be expected for multiple stage commands
# or when we initialize the session (set the session attribute)
return status != status.COMPLETED or sent_sessionid is not None
|
