slixmpp/sleekxmpp/plugins/xep_0280/carbons.py
2012-09-25 02:34:51 -07:00

76 lines
2.4 KiB
Python

"""
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 permissio
"""
import logging
import sleekxmpp
from sleekxmpp.stanza import Message, Iq
from sleekxmpp.xmlstream.handler import Callback
from sleekxmpp.xmlstream.matcher import StanzaPath
from sleekxmpp.xmlstream import register_stanza_plugin
from sleekxmpp.plugins import BasePlugin
from sleekxmpp.plugins.xep_0280 import stanza
log = logging.getLogger(__name__)
class XEP_0280(BasePlugin):
"""
XEP-0280 Message Carbons
"""
name = 'xep_0280'
description = 'XEP-0280: Message Carbons'
dependencies = set(['xep_0030', 'xep_0297'])
stanza = stanza
def plugin_init(self):
self.xmpp.register_handler(
Callback('Carbon Received',
StanzaPath('message/carbon_received'),
self._handle_carbon_received))
self.xmpp.register_handler(
Callback('Carbon Sent',
StanzaPath('message/carbon_sent'),
self._handle_carbon_sent))
register_stanza_plugin(Message, stanza.ReceivedCarbon)
register_stanza_plugin(Message, stanza.SentCarbon)
register_stanza_plugin(Message, stanza.PrivateCarbon)
register_stanza_plugin(Iq, stanza.CarbonEnable)
register_stanza_plugin(Iq, stanza.CarbonDisable)
def plugin_end(self):
self.xmpp.remove_handler('Carbon Received')
self.xmpp.remove_handler('Carbon Sent')
self.xmpp.plugin['xep_0030'].del_feature(feature='urn:xmpp:carbons:1')
def session_bind(self, jid):
self.xmpp.plugin['xep_0030'].add_feature('urn:xmpp:carbons:1')
def _handle_carbon_received(self, msg):
self.xmpp.event('carbon_received', msg)
def _handle_carbon_sent(self, msg):
self.xmpp.event('carbon_sent', msg)
def enable(self, ifrom=None, block=True, timeout=None, callback=None):
iq = self.xmpp.Iq()
iq['type'] = 'set'
iq['from'] = ifrom
iq.enable('carbon_enable')
return iq.send(block=block, timeout=timeout, callback=callback)
def disable(self, ifrom=None, block=True, timeout=None, callback=None):
iq = self.xmpp.Iq()
iq['type'] = 'set'
iq['from'] = ifrom
iq.enable('carbon_disable')
return iq.send(block=block, timeout=timeout, callback=callback)