summaryrefslogtreecommitdiff
path: root/sleekxmpp/plugins/xep_0249
diff options
context:
space:
mode:
authorTe-je Rodgers <te-je@geniphi.com>2011-01-11 04:05:05 +0800
committerLance Stout <lancestout@gmail.com>2011-01-11 04:11:05 +0800
commitfe3f8dde4b4eb19e1c1213bb56d8678f25000f37 (patch)
tree9cb0706c3b2d01300deb243ca1f7a16e3d626afc /sleekxmpp/plugins/xep_0249
parentacdf9e2d22dd604578f50d0a9b67c47e001da69f (diff)
downloadslixmpp-fe3f8dde4b4eb19e1c1213bb56d8678f25000f37.tar.gz
slixmpp-fe3f8dde4b4eb19e1c1213bb56d8678f25000f37.tar.bz2
slixmpp-fe3f8dde4b4eb19e1c1213bb56d8678f25000f37.tar.xz
slixmpp-fe3f8dde4b4eb19e1c1213bb56d8678f25000f37.zip
added plugin for xep-0249
Diffstat (limited to 'sleekxmpp/plugins/xep_0249')
-rw-r--r--sleekxmpp/plugins/xep_0249/__init__.py2
-rw-r--r--sleekxmpp/plugins/xep_0249/invite.py75
-rw-r--r--sleekxmpp/plugins/xep_0249/stanza.py29
3 files changed, 106 insertions, 0 deletions
diff --git a/sleekxmpp/plugins/xep_0249/__init__.py b/sleekxmpp/plugins/xep_0249/__init__.py
new file mode 100644
index 00000000..4af19a2b
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0249/__init__.py
@@ -0,0 +1,2 @@
+from sleekxmpp.plugins.xep_0249.stanza import Invite
+from sleekxmpp.plugins.xep_0249.invite import xep_0249
diff --git a/sleekxmpp/plugins/xep_0249/invite.py b/sleekxmpp/plugins/xep_0249/invite.py
new file mode 100644
index 00000000..7c966f15
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0249/invite.py
@@ -0,0 +1,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()
diff --git a/sleekxmpp/plugins/xep_0249/stanza.py b/sleekxmpp/plugins/xep_0249/stanza.py
new file mode 100644
index 00000000..43bb65d0
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0249/stanza.py
@@ -0,0 +1,29 @@
+from sleekxmpp.xmlstream import ElementBase
+
+
+class Invite(ElementBase):
+ """
+ XMPP allows for an agent in an MUC room to directly invite another
+ user to join the chat room (as opposed to a mediated invitation
+ done through the server).
+
+ Example invite stanza:
+ <message from='crone1@shakespeare.lit/desktop'
+ to='hecate@shakespeare.lit'>
+ <x xmlns='jabber:x:conference'
+ jid='darkcave@macbeth.shakespeare.lit'
+ password='cauldronburn'
+ reason='Hey Hecate, this is the place for all good witches!'/>
+ </message>
+
+ Stanza Interface:
+ jid -- The JID of the groupchat room
+ password -- The password used to gain entry in the room
+ (optional)
+ reason -- The reason for the invitation (optional)
+
+ """
+ name = "x"
+ namespace = "jabber:x:conference"
+ plugin_attrib = "groupchat_invite"
+ interfaces = ("jid", "password", "reason") \ No newline at end of file