summaryrefslogtreecommitdiff
path: root/sleekxmpp/plugins/xep_0249/invite.py
blob: 7c966f1577354fa6c48308a1def0a49cfc8da82f (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
"""Direct MUC Invitation."""


import logging

import sleekxmpp
from sleekxmpp import Message
from sleekxmpp.plugins.base import base_plugin
from sleekxmpp.xmlstream import register_stanza_plugin
from sleekxmpp.xmlstream.handler import Callback
from sleekxmpp.xmlstream.matcher import StanzaPath
from sleekxmpp.plugins.xep_0249 import Invite

log = logging.getLogger(__name__)


class xep_0249(base_plugin):

    """
    XEP-0249: Direct MUC Invitations
    """

    def plugin_init(self):
        self.xep = "0249"
        self.description = "Direct MUC Invitations"
        self.stanza = sleekxmpp.plugins.xep_0249.stanza

        self.xmpp.register_handler(
                Callback('Direct MUC Invitations',
                         StanzaPath('message/groupchat_invite'),
                         self._handle_invite))

        register_stanza_plugin(Message, Invite)

    def post_init(self):
        base_plugin.post_init(self)
        self.xmpp.plugin['xep_0030'].add_feature(Invite.namespace)

    def _handle_invite(self, message):
        """
        Raise an event for all invitations received.

        """
        log.debug("Received direct muc invitation from %s to room %s",
                  message['from'], message['groupchat_invite']['jid'])

        self.xmpp.event('groupchat_direct_invite', message)

    def send_invitation(self, jid, roomjid, password=None,
                        reason=None, ifrom=None):
        """
        Send a direct MUC invitation to an XMPP entity.

        Arguments:
            jid         -- The jid of the entity to which the inviation
                           is sent
            roomjid     -- the address of the groupchat room to be joined
            password    -- a password needed for entry into a
                           password-protected room (OPTIONAL).
            reason      -- a human-readable purpose for the invitation
                           (OPTIONAL).

        """

        message = self.xmpp.Message()
        message['to'] = jid
        if ifrom is not None:
            message['from'] = ifrom
        message['groupchat_invite']['jid'] = roomjid
        if password is not None:
            message['groupchat_invite']['password'] = password
        if reason is not None:
            message['groupchat_invite']['reason'] = reason

        return message.send()