Welcome to mirror list, hosted at ThFree Co, Russian Federation.

adhoc.py « modules « nbxmpp - dev.gajim.org/gajim/python-nbxmpp.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 2110414e06f42c4c446884e0e2668690cd93c0ba (plain)
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
# 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/>.

from nbxmpp.namespaces import Namespace
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
from nbxmpp.modules.base import BaseModule


class AdHoc(BaseModule):
    def __init__(self, client):
        BaseModule.__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().bare
        return get_disco_request(Namespace.DISCO_ITEMS,
                                 jid,
                                 node=Namespace.COMMANDS)

    @callback
    def _command_list_received(self, stanza):
        if not isResultNode(stanza):
            return raise_error(self._log.info, stanza)

        payload = stanza.getQueryPayload()
        if payload is None:
            return raise_error(self._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:
                self._log.warning(error)
                return raise_error(self._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': Namespace.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(self._log.info, stanza)

        command = stanza.getTag('command', namespace=Namespace.COMMANDS)
        if command is None:
            return raise_error(self._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=Namespace.DATA),
                actions=actions,
                notes=notes)
        except Exception as error:
            self._log.warning(error)
            return raise_error(self._log.warning, stanza, 'stanza-malformed')