Add XEP-0163 plugin.

This is just a very simple wrapper for XEP-0030, XEP-0115, and XEP-0060
for adding interests to caps information, and publishing.

1 files changed, 98 insertions, 0 deletions

diff --git a/sleekxmpp/plugins/xep_0163.py b/sleekxmpp/plugins/xep_0163.py
new file mode 100644
index 00000000..fc40c751
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0163.py
@@ -0,0 +1,98 @@
+"""
+    SleekXMPP: The Sleek XMPP Library
+    Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
+    This file is part of SleekXMPP.
+
+    See the file LICENSE for copying permission.
+"""
+
+import logging
+
+from sleekxmpp.plugins.base import base_plugin
+
+
+log = logging.getLogger(__name__)
+
+
+class xep_0163(base_plugin):
+
+    """
+    XEP-0163: Personal Eventing Protocol (PEP)
+    """
+
+    def plugin_init(self):
+        self.xep = '163'
+        self.description = 'Personal Eventing Protocol'
+
+    def add_interest(self, namespace, jid=None):
+        """
+        Mark an interest in a PEP subscription by including a disco
+        feature with the '+notify' extension.
+
+        Arguments:
+            namespace -- The base namespace to register as an interest, such
+                         as 'http://jabber.org/protocol/tune'. This may also
+                         be a list of such namespaces.
+            jid       -- Optionally specify the JID.
+        """
+        if not isinstance(namespace, set) and not isinstance(namespace, list):
+           namespace = [namespace]
+
+        for ns in namespace:
+            self.xmpp['xep_0030'].add_feature('%s+notify' % ns,
+                                              jid=jid)
+        self.xmpp['xep_0115'].update_caps()
+
+    def remove_interest(self, namespace, jid=None):
+        """
+        Mark an interest in a PEP subscription by including a disco
+        feature with the '+notify' extension.
+
+        Arguments:
+            namespace -- The base namespace to remove as an interest, such
+                         as 'http://jabber.org/protocol/tune'. This may also
+                         be a list of such namespaces.
+            jid       -- Optionally specify the JID.
+        """
+        if not isinstance(namespace, set) and not isinstance(namespace, list):
+           namespace = [namespace]
+
+        for ns in namespace:
+            self.xmpp['xep_0030'].del_feature(jid=jid,
+                                              feature='%s+notify' % namespace)
+        self.xmpp['xep_0115'].update_caps()
+
+    def publish(self, stanza, node=None, id=None, options=None, ifrom=None,
+                block=True, callback=None, timeout=None):
+        """
+        Publish a PEP update.
+
+        This is just a thin wrapper around the XEP-0060 publish() method
+        to set the defaults expected by PEP.
+
+        Arguments:
+            stanza   -- The PEP update stanza to publish.
+            node     -- The node to publish the item to. If not specified,
+                        the stanza's namespace will be used.
+            id       -- Optionally specify the ID of the item.
+            options  -- A form of publish options.
+            ifrom    -- Specify the sender's JID.
+            block    -- Specify if the send call will block until a response
+                        is received, or a timeout occurs. Defaults to True.
+            timeout  -- The length of time (in seconds) to wait for a response
+                        before exiting the send call if blocking is used.
+                        Defaults to sleekxmpp.xmlstream.RESPONSE_TIMEOUT
+            callback -- Optional reference to a stream handler function. Will
+                        be executed when a reply stanza is received.
+     
+        """
+        if node is None:
+            node = stanza.namespace
+
+        self.xmpp['xep_0060'].publish(ifrom, node,
+                payload=stanza.xml,
+                options=options,
+                ifrom=ifrom,
+                block=block,
+                callback=callback,
+                timeout=timeout)