diff options
Diffstat (limited to 'sleekxmpp/plugins/xep_0084/avatar.py')
-rw-r--r-- | sleekxmpp/plugins/xep_0084/avatar.py | 101 |
1 files changed, 101 insertions, 0 deletions
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) |