diff options
Diffstat (limited to 'slixmpp/plugins/xep_0084')
| -rw-r--r-- | slixmpp/plugins/xep_0084/__init__.py | 16 | ||||
| -rw-r--r-- | slixmpp/plugins/xep_0084/avatar.py | 110 | ||||
| -rw-r--r-- | slixmpp/plugins/xep_0084/stanza.py | 78 |
3 files changed, 204 insertions, 0 deletions
diff --git a/slixmpp/plugins/xep_0084/__init__.py b/slixmpp/plugins/xep_0084/__init__.py new file mode 100644 index 00000000..aa5fdae5 --- /dev/null +++ b/slixmpp/plugins/xep_0084/__init__.py @@ -0,0 +1,16 @@ +""" + Slixmpp: The Slick XMPP Library + Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout + This file is part of Slixmpp. + + See the file LICENSE for copying permission. +""" + +from slixmpp.plugins.base import register_plugin + +from slixmpp.plugins.xep_0084 import stanza +from slixmpp.plugins.xep_0084.stanza import Data, MetaData +from slixmpp.plugins.xep_0084.avatar import XEP_0084 + + +register_plugin(XEP_0084) diff --git a/slixmpp/plugins/xep_0084/avatar.py b/slixmpp/plugins/xep_0084/avatar.py new file mode 100644 index 00000000..e5f9dfaa --- /dev/null +++ b/slixmpp/plugins/xep_0084/avatar.py @@ -0,0 +1,110 @@ +""" + Slixmpp: The Slick XMPP Library + Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout + This file is part of Slixmpp. + + See the file LICENSE for copying permission. +""" + +import hashlib +import logging + +from slixmpp import Iq +from slixmpp.plugins import BasePlugin +from slixmpp.xmlstream.handler import Callback +from slixmpp.xmlstream.matcher import StanzaPath +from slixmpp.xmlstream import register_stanza_plugin, JID +from slixmpp.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): + 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 plugin_end(self): + self.xmpp['xep_0030'].del_feature(feature=MetaData.namespace) + self.xmpp['xep_0163'].remove_interest(MetaData.namespace) + + def session_bind(self, jid): + self.xmpp['xep_0163'].register_pep('avatar_metadata', MetaData) + + def generate_id(self, data): + return hashlib.sha1(data).hexdigest() + + def retrieve_avatar(self, jid, id, url=None, ifrom=None, + callback=None, timeout=None, timeout_callback=None): + return self.xmpp['xep_0060'].get_item(jid, Data.namespace, id, + ifrom=ifrom, + callback=callback, + timeout=timeout, + timeout_callback=timeout_callback) + + def publish_avatar(self, data, ifrom=None, callback=None, + timeout=None, timeout_callback=None): + payload = Data() + payload['value'] = data + return self.xmpp['xep_0163'].publish(payload, + id=self.generate_id(data), + ifrom=ifrom, + callback=callback, + timeout=timeout, + timeout_callback=timeout_callback) + + def publish_avatar_metadata(self, items=None, pointers=None, + ifrom=None, + callback=None, timeout=None, + timeout_callback=None): + metadata = MetaData() + if items is None: + items = [] + if not isinstance(items, (list, set)): + items = [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', '')) + + if pointers is not None: + for pointer in pointers: + metadata.add_pointer(pointer) + + return self.xmpp['xep_0163'].publish(metadata, + id=info['id'], + ifrom=ifrom, + callback=callback, + timeout=timeout, + timeout_callback=timeout_callback) + + def stop(self, ifrom=None, callback=None, timeout=None, timeout_callback=None): + """ + Clear existing avatar metadata information to stop notifications. + + Arguments: + ifrom -- Specify the sender's JID. + timeout -- The length of time (in seconds) to wait for a response + before exiting the send call if blocking is used. + Defaults to slixmpp.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, + callback=callback, + timeout=timeout, + timeout_callback=timeout_callback) diff --git a/slixmpp/plugins/xep_0084/stanza.py b/slixmpp/plugins/xep_0084/stanza.py new file mode 100644 index 00000000..ebcd73e3 --- /dev/null +++ b/slixmpp/plugins/xep_0084/stanza.py @@ -0,0 +1,78 @@ +""" + Slixmpp: The Slick XMPP Library + Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout + This file is part of Slixmpp. + + See the file LICENSE for copying permission. +""" + +from base64 import b64encode, b64decode + +from slixmpp.util import bytes +from slixmpp.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 b'' + + def set_value(self, value): + if value: + self.xml.text = b64encode(bytes(value)).decode() + 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': '%s' % 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' + plugin_multi_attrib = 'pointers' + interfaces = set() + + +register_stanza_plugin(MetaData, Info, iterable=True) +register_stanza_plugin(MetaData, Pointer, iterable=True) |