Add plugin for XEP-0191: Simple Communications Blocking

setup.py

@@ -85,6 +85,7 @@ packages     = [ 'sleekxmpp',
                  'sleekxmpp/plugins/xep_0172',
                  'sleekxmpp/plugins/xep_0184',
                  'sleekxmpp/plugins/xep_0186',
+                 'sleekxmpp/plugins/xep_0191',
                  'sleekxmpp/plugins/xep_0198',
                  'sleekxmpp/plugins/xep_0199',
                  'sleekxmpp/plugins/xep_0202',

sleekxmpp/plugins/__init__.py

@@ -46,6 +46,7 @@ __all__ = [
     'xep_0172',  # User Nickname
     'xep_0184',  # Message Receipts
     'xep_0186',  # Invisible Command
+    'xep_0191',  # Simple Communications Blocking
     'xep_0198',  # Stream Management
     'xep_0199',  # Ping
     'xep_0202',  # Entity Time

sleekxmpp/plugins/xep_0191/__init__.py

@@ -0,0 +1,15 @@
+"""
+    SleekXMPP: The Sleek XMPP Library
+    Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
+    This file is part of SleekXMPP.
+
+    See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.plugins.base import register_plugin
+
+from sleekxmpp.plugins.xep_0191.stanza import Block, Unblock, BlockList
+from sleekxmpp.plugins.xep_0191.blocking import XEP_0191
+
+
+register_plugin(XEP_0191)

sleekxmpp/plugins/xep_0191/blocking.py

@@ -0,0 +1,83 @@
+"""
+    SleekXMPP: The Sleek XMPP Library
+    Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
+    This file is part of SleekXMPP.
+
+    See the file LICENSE for copying permission.
+"""
+
+import logging
+
+from sleekxmpp import Iq
+from sleekxmpp.plugins import BasePlugin
+from sleekxmpp.xmlstream.handler import Callback
+from sleekxmpp.xmlstream.matcher import StanzaPath
+from sleekxmpp.xmlstream import register_stanza_plugin, JID
+from sleekxmpp.plugins.xep_0191 import stanza, Block, Unblock, BlockList
+
+
+log = logging.getLogger(__name__)
+
+
+class XEP_0191(BasePlugin):
+
+    name = 'xep_0191'
+    description = 'XEP-0191: Simple Communications Blocking'
+    dependencies = set(['xep_0030'])
+    stanza = stanza
+
+    def plugin_init(self):
+        register_stanza_plugin(Iq, BlockList)
+        register_stanza_plugin(Iq, Block)
+        register_stanza_plugin(Iq, Unblock)
+
+        self.xmpp.register_handler(
+                Callback('Blocked Contact',
+                    StanzaPath('iq@type=set/block'),
+                    self._handle_blocked))
+
+        self.xmpp.register_handler(
+                Callback('Unblocked Contact',
+                    StanzaPath('iq@type=set/unblock'),
+                    self._handle_unblocked))
+
+    def plugin_end(self):
+        self.xmpp.remove_handler('Blocked Contact')
+        self.xmpp.remove_handler('Unblocked Contact')
+
+    def get_blocked(self, ifrom=None, block=True, timeout=None, callback=None):
+        iq = self.xmpp.Iq()
+        iq['type'] = 'get'
+        iq['from'] = 'ifrom'
+        iq.enable('blocklist')
+        return iq.send(block=block, timeout=timeout, callback=callback)
+
+    def block(self, jids, ifrom=None, block=True, timeout=None, callback=None):
+        iq = self.xmpp.Iq()
+        iq['type'] = 'set'
+        iq['from'] = ifrom
+
+        if not isinstance(jids, (set, list)):
+            jids = [jids]
+
+        iq['block']['items'] = jids
+        return iq.send(block=block, timeout=timeout, callback=callback)
+
+    def unblock(self, jids=None, ifrom=None, block=True, timeout=None, callback=None):
+        iq = self.xmpp.Iq()
+        iq['type'] = 'set'
+        iq['from'] = ifrom
+
+        if jids is None:
+            jids = []
+        if not isinstance(jids, (set, list)):
+            jids = [jids]
+
+        iq['unblock']['items'] = jids
+        return iq.send(block=block, timeout=timeout, callback=callback)
+
+    def _handle_blocked(self, iq):
+        self.xmpp.event('blocked', iq)
+
+    def _handle_unblocked(self, iq):
+        self.xmpp.event('unblocked', iq)

sleekxmpp/plugins/xep_0191/stanza.py

@@ -0,0 +1,50 @@
+"""
+    SleekXMPP: The Sleek XMPP Library
+    Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
+    This file is part of SleekXMPP.
+
+    See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.xmlstream import ET, ElementBase, JID
+
+
+class BlockList(ElementBase):
+    name = 'blocklist'
+    namespace = 'urn:xmpp:blocking'
+    plugin_attrib = 'blocklist'
+    interfaces = set(['items'])
+
+    def get_items(self):
+        result = set()
+        items = self.xml.findall('{%s}item' % self.namespace)
+        if items is not None:
+            for item in items:
+                jid = JID(item.attrib.get('jid', ''))
+                if jid:
+                    result.add(jid)
+        return result
+
+    def set_items(self, values):
+        self.del_items()
+        for jid in values:
+            if jid:
+                item = ET.Element('{%s}item' % self.namespace)
+                item.attrib['jid'] = JID(jid).full
+                self.xml.append(item)
+
+    def del_items(self):
+        items = self.xml.findall('{%s}item' % self.namespace)
+        if items is not None:
+            for item in items:
+                self.xml.remove(item)
+
+
+class Block(BlockList):
+    name = 'block'
+    plugin_attrib = 'block'
+
+
+class Unblock(BlockList):
+    name = 'unblock'
+    plugin_attrib = 'unblock'