mirror of
https://github.com/correl/SleekXMPP.git
synced 2024-11-30 19:19:55 +00:00
4375ac7d8b
Stanza objects now accept the use of underscored names. The CamelCase versions are still available for backwards compatibility, but are discouraged. The property stanza.values now maps to the old getStanzaValues and setStanzaValues, in addition to _set_stanza_values and _get_stanza_values.
97 lines
2.9 KiB
Python
97 lines
2.9 KiB
Python
"""
|
|
SleekXMPP: The Sleek XMPP Library
|
|
Copyright (C) 2010 Nathanael C. Fritz
|
|
This file is part of SleekXMPP.
|
|
|
|
See the file LICENSE for copying permission.
|
|
"""
|
|
|
|
from sleekxmpp.stanza import Message
|
|
from sleekxmpp.xmlstream import ElementBase, ET, register_stanza_plugin
|
|
|
|
|
|
class HTMLIM(ElementBase):
|
|
|
|
"""
|
|
XEP-0071: XHTML-IM defines a method for embedding XHTML content
|
|
within a <message> stanza so that lightweight markup can be used
|
|
to format the message contents and to create links.
|
|
|
|
Only a subset of XHTML is recommended for use with XHTML-IM.
|
|
See the full spec at 'http://xmpp.org/extensions/xep-0071.html'
|
|
for more information.
|
|
|
|
Example stanza:
|
|
<message to="user@example.com">
|
|
<body>Non-html message content.</body>
|
|
<html xmlns="http://jabber.org/protocol/xhtml-im">
|
|
<body xmlns="http://www.w3.org/1999/xhtml">
|
|
<p><b>HTML!</b></p>
|
|
</body>
|
|
</html>
|
|
</message>
|
|
|
|
Stanza Interface:
|
|
body -- The contents of the HTML body tag.
|
|
|
|
Methods:
|
|
setup -- Overrides ElementBase.setup.
|
|
get_body -- Return the HTML body contents.
|
|
set_body -- Set the HTML body contents.
|
|
del_body -- Remove the HTML body contents.
|
|
"""
|
|
|
|
namespace = 'http://jabber.org/protocol/xhtml-im'
|
|
name = 'html'
|
|
interfaces = set(('body',))
|
|
plugin_attrib = name
|
|
|
|
def setup(self, xml=None):
|
|
"""
|
|
Populate the stanza object using an optional XML object.
|
|
|
|
Overrides StanzaBase.setup.
|
|
|
|
Arguments:
|
|
xml -- Use an existing XML object for the stanza's values.
|
|
"""
|
|
# To comply with PEP8, method names now use underscores.
|
|
# Deprecated method names are re-mapped for backwards compatibility.
|
|
self.setBody = self.set_body
|
|
self.getBody = self.get_body
|
|
self.delBody = self.del_body
|
|
|
|
return ElementBase.setup(self, xml)
|
|
|
|
def set_body(self, html):
|
|
"""
|
|
Set the contents of the HTML body.
|
|
|
|
Arguments:
|
|
html -- Either a string or XML object. If the top level
|
|
element is not <body> with a namespace of
|
|
'http://www.w3.org/1999/xhtml', it will be wrapped.
|
|
"""
|
|
if isinstance(html, str):
|
|
html = ET.XML(html)
|
|
if html.tag != '{http://www.w3.org/1999/xhtml}body':
|
|
body = ET.Element('{http://www.w3.org/1999/xhtml}body')
|
|
body.append(html)
|
|
self.xml.append(body)
|
|
else:
|
|
self.xml.append(html)
|
|
|
|
def get_body(self):
|
|
"""Return the contents of the HTML body."""
|
|
html = self.xml.find('{http://www.w3.org/1999/xhtml}body')
|
|
if html is None:
|
|
return ''
|
|
return html
|
|
|
|
def del_body(self):
|
|
"""Remove the HTML body contents."""
|
|
if self.parent is not None:
|
|
self.parent().xml.remove(self.xml)
|
|
|
|
|
|
register_stanza_plugin(Message, HTMLIM)
|