Philipp Hörist pushed to branch master at gajim / python-nbxmpp
Commits: cf7f0625 by Philipp Hörist at 2019-04-06T21:25:37Z Add Discovery (XEP-0030) module
- - - - - 11dffacf by Philipp Hörist at 2019-04-06T21:26:47Z Add Ad-Hoc Commands (XEP-0050) module
- - - - -
5 changed files:
- nbxmpp/const.py - nbxmpp/dispatcher.py - + nbxmpp/modules/adhoc.py - + nbxmpp/modules/discovery.py - nbxmpp/structs.py
Changes:
===================================== nbxmpp/const.py ===================================== @@ -296,6 +296,26 @@ class AnonymityMode(Enum): NONE = 'none'
+class AdHocStatus(Enum): + EXECUTING = 'executing' + COMPLETED = 'completed' + CANCELED = 'canceled' + + +class AdHocAction(Enum): + EXECUTE = 'execute' + CANCEL = 'cancel' + PREV = 'prev' + NEXT = 'next' + COMPLETE = 'complete' + + +class AdHocNoteType(Enum): + INFO = 'info' + WARN = 'warn' + ERROR = 'error' + + MOODS = [ 'afraid', 'amazed',
===================================== nbxmpp/dispatcher.py ===================================== @@ -67,6 +67,7 @@ from nbxmpp.modules.omemo import OMEMO from nbxmpp.modules.annotations import Annotations from nbxmpp.modules.muclumbus import Muclumbus from nbxmpp.modules.software_version import SoftwareVersion +from nbxmpp.modules.adhoc import AdHoc from nbxmpp.modules.misc import unwrap_carbon from nbxmpp.modules.misc import unwrap_mam from nbxmpp.util import get_properties_struct @@ -202,6 +203,7 @@ class XMPPDispatcher(PlugIn): self._modules['Annotations'] = Annotations(self._owner) self._modules['Muclumbus'] = Muclumbus(self._owner) self._modules['SoftwareVersion'] = SoftwareVersion(self._owner) + self._modules['AdHoc'] = AdHoc(self._owner)
for instance in self._modules.values(): for handler in instance.handlers:
===================================== nbxmpp/modules/adhoc.py ===================================== @@ -0,0 +1,125 @@ +# Copyright (C) 2019 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see http://www.gnu.org/licenses/. + +import logging + +from nbxmpp.protocol import NS_COMMANDS +from nbxmpp.protocol import NS_DISCO_ITEMS +from nbxmpp.protocol import NS_DATA +from nbxmpp.protocol import Iq +from nbxmpp.protocol import isResultNode +from nbxmpp.protocol import Node +from nbxmpp.util import call_on_response +from nbxmpp.util import callback +from nbxmpp.util import raise_error +from nbxmpp.structs import AdHocCommand +from nbxmpp.structs import AdHocCommandNote +from nbxmpp.const import AdHocStatus +from nbxmpp.const import AdHocAction +from nbxmpp.const import AdHocNoteType +from nbxmpp.modules.discovery import get_disco_request + + +log = logging.getLogger('nbxmpp.m.adhoc') + + +class AdHoc: + def __init__(self, client): + self._client = client + self.handlers = [] + + @call_on_response('_command_list_received') + def request_command_list(self, jid=None): + if jid is None: + jid = self._client.get_bound_jid().getBare() + return get_disco_request(NS_DISCO_ITEMS, jid, node=NS_COMMANDS) + + @callback + def _command_list_received(self, stanza): + if not isResultNode(stanza): + return raise_error(log.info, stanza) + + payload = stanza.getQueryPayload() + if not payload: + return raise_error(log.warning, stanza, 'stanza-malformed') + + command_list = [] + for item in payload: + if item.getName() != 'item': + continue + try: + command_list.append(AdHocCommand(**item.getAttrs())) + except Exception as error: + log.warning(error) + return raise_error(log.warning, stanza, 'stanza-malformed') + + return command_list + + @call_on_response('_command_result_received') + def execute_command(self, command, action=None, dataform=None): + if action is None: + action = AdHocAction.EXECUTE + attrs = {'node': command.node, + 'xmlns': NS_COMMANDS, + 'action': action.value} + if command.sessionid is not None: + attrs['sessionid'] = command.sessionid + + 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 + + @callback + def _command_result_received(self, stanza): + if not isResultNode(stanza): + return raise_error(log.info, stanza) + + command = stanza.getTag('command', namespace=NS_COMMANDS) + if command is None: + return raise_error(log.warning, stanza, 'stanza-malformed') + + attrs = command.getAttrs() + notes = [] + actions = [] + try: + for note in command.getTags('note'): + type_ = note.getAttr('type') + if type_ is not None: + type_ = AdHocNoteType(note.getAttr('type')) + notes.append(AdHocCommandNote(text=note.getData(), + type=type_)) + + actions_ = command.getTag('actions') + if actions_ is not None: + for action in actions_.getChildren(): + actions.append(AdHocAction(action.getName())) + + return AdHocCommand( + jid=str(stanza.getFrom()), + name=None, + node=attrs['node'], + sessionid=attrs.get('sessionid'), + status=AdHocStatus(attrs['status']), + data=command.getTag('x', namespace=NS_DATA), + actions=actions, + notes=notes) + except Exception as error: + log.warning(error) + return raise_error(log.warning, stanza, 'stanza-malformed')
===================================== nbxmpp/modules/discovery.py ===================================== @@ -0,0 +1,30 @@ +# Copyright (C) 2019 Philipp Hörist <philipp AT hoerist.com> +# +# This file is part of nbxmpp. +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 3 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; If not, see http://www.gnu.org/licenses/. + +import logging + +from nbxmpp.protocol import Iq + + +log = logging.getLogger('nbxmpp.m.discovery') + + +def get_disco_request(namespace, jid, node=None): + iq = Iq('get', to=jid, queryNS=namespace) + if node is not None: + iq.getQuery().setAttr('node', node) + return iq
===================================== nbxmpp/structs.py ===================================== @@ -29,6 +29,7 @@ from nbxmpp.const import StatusCode from nbxmpp.const import PresenceType from nbxmpp.const import Error from nbxmpp.const import LOCATION_DATA +from nbxmpp.const import AdHocStatus
StanzaHandler = namedtuple('StanzaHandler', 'name callback typ ns xmlns system priority') @@ -106,6 +107,25 @@ MuclumbusItem = namedtuple('MuclumbusItem', 'jid name nusers description languag
SoftwareVersionResult = namedtuple('SoftwareVersionResult', 'name version os')
+AdHocCommandNote = namedtuple('AdHocCommandNote', 'text type') + +class AdHocCommand(namedtuple('AdHocCommand', 'jid node name sessionid status data actions notes')): + + __slots__ = [] + + def __new__(cls, jid, node, name, sessionid=None, status=None, + data=None, actions=None, notes=None): + return super(AdHocCommand, cls).__new__(cls, jid, node, name, sessionid, + status, data, actions, notes) + + @property + def is_completed(self): + return self.status == AdHocStatus.COMPLETED + + @property + def is_canceled(self): + return self.status == AdHocStatus.CANCEL +
class OMEMOBundle(namedtuple('OMEMOBundle', 'spk spk_signature ik otpks')): def pick_prekey(self):
View it on GitLab: https://dev.gajim.org/gajim/python-nbxmpp/compare/79330a5079d4f9c85d98c90281...