Add initial XEP-0084 support.

It does not auto-retrieve and store avatars yet, but everything is there
to do so.

5 files changed, 199 insertions, 0 deletions

diff --git a/sleekxmpp/plugins/__init__.py b/sleekxmpp/plugins/__init__.py
index 9ad3fbba..884449c2 100644
--- a/sleekxmpp/plugins/__init__.py
+++ b/sleekxmpp/plugins/__init__.py
@@ -32,6 +32,7 @@ __all__ = [
 #   'xep_0078',  # Non-SASL auth. Don't automatically load
     'xep_0080',  # User Location
     'xep_0082',  # XMPP Date and Time Profiles
+    'xep_0084',  # User Avatar
     'xep_0085',  # Chat State Notifications
     'xep_0086',  # Legacy Error Codes
     'xep_0092',  # Software Version
diff --git a/sleekxmpp/plugins/xep_0084/__init__.py b/sleekxmpp/plugins/xep_0084/__init__.py
new file mode 100644
index 00000000..39aa8d76
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0084/__init__.py
@@ -0,0 +1,18 @@
+"""
+    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_0084 import stanza
+from sleekxmpp.plugins.xep_0084.stanza import Data, MetaData
+from sleekxmpp.plugins.xep_0084.avatar import XEP_0084
+
+
+register_plugin(XEP_0084)
+
+
diff --git a/sleekxmpp/plugins/xep_0084/avatar.py b/sleekxmpp/plugins/xep_0084/avatar.py
new file mode 100644
index 00000000..c5f8e4de
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0084/avatar.py
@@ -0,0 +1,101 @@
+"""
+    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 hashlib
+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_0084 import stanza, Data, MetaData
+
+
+log = logging.getLogger(__name__)
+
+
+class XEP_0084(BasePlugin):
+
+    name = 'xep_0084'
+    description = 'XEP-0084: User Avatar'
+    dependencies = set(['xep_0163', 'xep_0060'])
+    stanza = stanza
+
+    def plugin_init(self):
+        self.xmpp['xep_0163'].register_pep('avatar_metadata', MetaData)
+
+        pubsub_stanza = self.xmpp['xep_0060'].stanza
+        register_stanza_plugin(pubsub_stanza.Item, Data)
+        register_stanza_plugin(pubsub_stanza.EventItem, Data)
+
+        self.xmpp['xep_0060'].map_node_event(Data.namespace, 'avatar_data')
+
+    def retrieve_avatar(self, jid, id, url=None, ifrom=None, block=True,
+                              callback=None, timeout=None):
+        return self.xmpp['xep_0060'].get_item(jid, Data.namespace, id, 
+                ifrom=ifrom,
+                block=block,
+                callback=callback,
+                timeout=timeout)
+
+    def publish_avatar(self, data, ifrom=None, block=True, callback=None,
+                             timeout=None):
+        payload = Data()
+        payload['value'] = data
+        return self.xmpp['xep_0163'].publish(payload,
+                node=Data.namespace,
+                id=hashlib.sha1(data).hexdigest(),
+                ifrom=ifrom,
+                block=block,
+                callback=callback,
+                timeout=timeout)
+
+    def publish_avatar_metadata(self, items=None, pointers=None,
+                                      ifrom=None, block=True,
+                                      callback=None, timeout=None):
+        metadata = MetaData()
+        if items is None:
+            items = []
+        for info in items:
+            metadata.add_info(info['id'], info['type'], info['bytes'],
+                    height=info.get('height', ''),
+                    width=info.get('width', ''),
+                    url=info.get('url', ''))
+        for pointer in pointers:
+            metadata.add_pointer(pointer)
+
+        return self.xmpp['xep_0163'].publish(payload,
+                node=Data.namespace,
+                id=hashlib.sha1(data).hexdigest(),
+                ifrom=ifrom,
+                block=block,
+                callback=callback,
+                timeout=timeout)
+
+    def stop(self, ifrom=None, block=True, callback=None, timeout=None):
+        """
+        Clear existing avatar metadata information to stop notifications.
+
+        Arguments:
+            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.
+        """
+        metadata = MetaData()
+        return self.xmpp['xep_0163'].publish(metadata,
+                node=MetaData.namespace,
+                ifrom=ifrom,
+                block=block,
+                callback=callback,
+                timeout=timeout)
diff --git a/sleekxmpp/plugins/xep_0084/stanza.py b/sleekxmpp/plugins/xep_0084/stanza.py
new file mode 100644
index 00000000..6c9580e3
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0084/stanza.py
@@ -0,0 +1,78 @@
+"""
+    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 base64 import b64encode, b64decode
+from sleekxmpp.thirdparty.suelta.util import bytes
+
+from sleekxmpp.xmlstream import ET, ElementBase, register_stanza_plugin
+
+
+class Data(ElementBase):
+    name = 'data'
+    namespace = 'urn:xmpp:avatar:data'
+    plugin_attrib = 'avatar_data'
+    interfaces = set(['value'])
+
+    def get_value(self):
+        if self.xml.text:
+            return b64decode(bytes(self.xml.text))
+        return ''
+
+    def set_value(self, value):
+        if value:
+            self.xml.text = b64encode(bytes(value))
+        else:
+            self.xml.text = ''
+
+    def del_value(self):
+        self.xml.text = ''
+
+
+class MetaData(ElementBase):
+    name = 'metadata'
+    namespace = 'urn:xmpp:avatar:metadata'
+    plugin_attrib = 'avatar_metadata'
+    interfaces = set()
+
+    def add_info(self, id, itype, ibytes, height=None, width=None, url=None):
+        info = Info()
+        info.values = {'id': id,
+                       'type': itype,
+                       'bytes': ibytes,
+                       'height': height,
+                       'width': width,
+                       'url': url}
+        self.append(info)
+
+    def add_pointer(self, xml):
+        if not isinstance(xml, Pointer):
+            pointer = Pointer()
+            pointer.append(xml)
+            self.append(pointer)
+        else:
+            self.append(xml)
+
+
+class Info(ElementBase):
+    name = 'info'
+    namespace = 'urn:xmpp:avatar:metadata'
+    plugin_attrib = 'info'
+    plugin_multi_attrib = 'items'
+    interfaces = set(['bytes', 'height', 'id', 'type', 'url', 'width'])
+
+
+class Pointer(ElementBase):
+    name = 'pointer'
+    namespace = 'urn:xmpp:avatar:metadata'
+    plugin_attrib = 'pointer'
+    multi_plugin_attrib = 'pointers'
+    interfaces = set()
+
+
+register_stanza_plugin(MetaData, Info, iterable=True)
+register_stanza_plugin(MetaData, Pointer, iterable=True)
diff --git a/sleekxmpp/plugins/xep_0163.py b/sleekxmpp/plugins/xep_0163.py
index 5a6df1c8..0bb67e32 100644
--- a/sleekxmpp/plugins/xep_0163.py
+++ b/sleekxmpp/plugins/xep_0163.py
@@ -109,6 +109,7 @@ class XEP_0163(BasePlugin):
             node = stanza.namespace
 
         return self.xmpp['xep_0060'].publish(ifrom, node,
+                id=id,
                 payload=stanza.xml,
                 options=options,
                 ifrom=ifrom,