def deleteNode(self, node, server=None):
"""
Deletes the selected node.
@type node: string
@param node: id of the node to delete
@type server: string
@param server: PubSub server
@rtype: (string , list[string])
@return: A tuple with the type of answer ('ok','error') and information
about the answer. In case of 'error', a list with the errors. In case of
'ok' an empty list.
"""
#TODO: A method to redirect the subscriptions to the node to another one COULD be implemented
if server is None:
server = self._server
iq = Iq(
typ='set',
queryNS=None,
attrs={},
frm=self._client,
to=server,
)
pubsub_node = Node(tag='pubsub', attrs={'xmlns': NS_PUBSUB_OWNER})
pubsub_node.addChild(name='delete', attrs={'node': node})
iq.addChild(node=pubsub_node)
return self._sendAndReceive(iq, lambda msg: [])
def unsubscribe(self, node, server=None, jid=None):
"""
Unsubscribe from the selected node
@type node: string
@param node: id of the node to unsubscribe
@type server: string
@param server: PubSub server
@rtype: (string , list[string])
@return: A tuple with the type of answer ('ok','error') and information
about the answer. In case of 'error', a list with the errors. In case of
'ok' an empty list.
"""
if server is None:
server = self._server
if jid is None:
jid = self._client
iq = Iq(typ='set', queryNS=None, attrs={}, frm=self._client, to=server)
pubsub_node = Node(tag='pubsub', attrs={'xmlns': NS_PUBSUB_OWNER})
unsubscribe_node = Node(tag='unsubscribe',
attrs={
'node': node,
'jid': jid
})
pubsub_node.addChild(node=unsubscribe_node)
iq.addChild(node=pubsub_node)
return self._sendAndReceive(iq, lambda msg: [])
def deleteNode(self, node, server=None):
"""
Deletes the selected node.
@type node: string
@param node: id of the node to delete
@type server: string
@param server: PubSub server
@rtype: (string , list[string])
@return: A tuple with the type of answer ('ok','error') and information
about the answer. In case of 'error', a list with the errors. In case of
'ok' an empty list.
"""
#TODO: A method to redirect the subscriptions to the node to another one COULD be implemented
if server is None:
server = self._server
iq = Iq(
typ='set',
queryNS=None,
attrs={},
frm=self._client,
to=server,
)
pubsub_node = Node(tag='pubsub', attrs={'xmlns': NS_PUBSUB_OWNER})
pubsub_node.addChild(name='delete', attrs={'node': node})
iq.addChild(node=pubsub_node)
return self._sendAndReceive(iq, lambda msg: [])
def unsubscribe(self, node, server=None, jid=None):
"""
Unsubscribe from the selected node
@type node: string
@param node: id of the node to unsubscribe
@type server: string
@param server: PubSub server
@rtype: (string , list[string])
@return: A tuple with the type of answer ('ok','error') and information
about the answer. In case of 'error', a list with the errors. In case of
'ok' an empty list.
"""
if server is None:
server = self._server
if jid is None:
jid = self._client
iq = Iq(
typ='set',
queryNS=None,
attrs={},
frm=self._client,
to=server
)
pubsub_node = Node(tag='pubsub', attrs={'xmlns': NS_PUBSUB_OWNER})
unsubscribe_node = Node(tag='unsubscribe', attrs={'node': node, 'jid': jid})
pubsub_node.addChild(node=unsubscribe_node)
iq.addChild(node=pubsub_node)
return self._sendAndReceive(iq, lambda msg: [])
def mshtmlformat(text):
"""Converts a MySpace formatted message into a (text,html) tuple"""
html = Node('html')
html.setNamespace('http://jabber.org/protocol/xhtml-im')
xhtml = html.addChild('body',namespace='http://www.w3.org/1999/xhtml')
tree = ET.XML('<body>' + text + '</body>')
text = convert_node_myspace_to_text_xhtml(tree, xhtml)
return text,html
def publish(self, node, event=None):
"""
Publishes an item to a given node.
XXX: 'node' here is not an XML node, but the attribute for <publish>
@type node: string
@param node: The ID of the pubsub node to publish
@type event: Event
@param event: Content to publish
@rtype: (string , list[string])
@return: A tuple with the type of answer ('ok','error') and information
about the answer. In case of 'error', a list with the errors. In case of
'ok' the name of the created node.
"""
iq = Iq(typ='set', queryNS=None, attrs={}, frm=self._client)
pubsub_node = Node(tag='pubsub', attrs={'xmlns': NS_PUBSUB})
publish_node = Node(tag='publish', attrs={'node': node})
item_node = Node(tag='item')
if event is not None:
item_node.addChild(node=event)
publish_node.addChild(node=item_node)
pubsub_node.addChild(node=publish_node)
iq.addChild(node=pubsub_node)
def getContents(msg):
node_publish = msg.getTag('pubsub').getTag('publish')
#XXX: Server implementation always returns the item id, but XEP-60 does
# vim snot require it
return [node_publish['node'], node_publish.getTag('item')['id']]
return self._sendAndReceive(iq, getContents)
def createNode(self,
node,
server=None,
type='leaf',
parent=None,
access=None):
"""
Creates a node with the specified parameters.
@type node: string
@param node: The ID of the node to create
@type server: string
@param server: PubSub server
@type type: string
@param type: Type of the node: 'leaf' or 'collection'
@type parent: string
@param parent: id of the parent node. None if parent is root
@type access: string
@param acccess: Access model of the node
@rtype: (string , list[string])
@return: A tuple with the type of answer ('ok','error') and information
about the answer. In case of 'error', a list with the errors. In case of
'ok' the name of the created node.
"""
#TODO: Add suport for node configuration (RECOMMENDED in XEP-60)
if server is None:
server = self._server
iq = Iq(typ='set', queryNS=None, attrs={}, frm=self._client, to=server)
pubsub_node = Node(tag='pubsub', attrs={'xmlns': NS_PUBSUB})
create_node = Node(tag='create',
attrs={} if node is None else {'node': node})
pubsub_node.addChild(node=create_node)
iq.addChild(node=pubsub_node)
if parent is not None or type == 'collection' or access is not None:
field_nodes = []
configure_node = Node(tag='configure')
field_nodes.append(
DataField('FORM_TYPE', NS_PUBSUB + '#node_config', 'hidden'))
if parent is not None:
field_nodes.append(DataField('pubsub#collection', parent))
# <field var='pubsub#collection'><value>announcements</value></field>
if type == 'collection':
field_nodes.append(DataField('pubsub#node_type', 'collection'))
if access is not None:
field_nodes.append(DataField('pubsub#access_model', access))
x_node = DataForm(typ='submit', data=field_nodes)
configure_node.addChild(x_node)
pubsub_node.addChild(configure_node)
return self._sendAndReceive(
iq, lambda msg: [msg.getTag('pubsub').getTag('create')['node']])
def createNode(self, node, server=None, type='leaf', parent=None, access=None):
"""
Creates a node with the specified parameters.
@type node: string
@param node: The ID of the node to create
@type server: string
@param server: PubSub server
@type type: string
@param type: Type of the node: 'leaf' or 'collection'
@type parent: string
@param parent: id of the parent node. None if parent is root
@type access: string
@param acccess: Access model of the node
@rtype: (string , list[string])
@return: A tuple with the type of answer ('ok','error') and information
about the answer. In case of 'error', a list with the errors. In case of
'ok' the name of the created node.
"""
#TODO: Add suport for node configuration (RECOMMENDED in XEP-60)
if server is None:
server = self._server
iq = Iq(
typ='set',
queryNS=None,
attrs={},
frm=self._client,
to=server
)
pubsub_node = Node(tag='pubsub', attrs={'xmlns':NS_PUBSUB})
create_node = Node(tag='create', attrs={} if node is None else {'node':node})
pubsub_node.addChild(node=create_node)
iq.addChild(node=pubsub_node)
if parent is not None or type=='collection' or access is not None:
field_nodes=[]
configure_node = Node(tag='configure')
field_nodes.append(DataField('FORM_TYPE', NS_PUBSUB+'#node_config','hidden'))
if parent is not None:
field_nodes.append(DataField('pubsub#collection',parent))
# <field var='pubsub#collection'><value>announcements</value></field>
if type == 'collection':
field_nodes.append(DataField('pubsub#node_type','collection'))
if access is not None:
field_nodes.append(DataField('pubsub#access_model',access))
x_node = DataForm(typ='submit',data=field_nodes)
configure_node.addChild(x_node)
pubsub_node.addChild(configure_node)
return self._sendAndReceive(iq, lambda msg:[msg.getTag('pubsub').getTag('create')['node']])
def publish(self, node, event=None):
"""
Publishes an item to a given node.
XXX: 'node' here is not an XML node, but the attribute for <publish>
@type node: string
@param node: The ID of the pubsub node to publish
@type event: Event
@param event: Content to publish
@rtype: (string , list[string])
@return: A tuple with the type of answer ('ok','error') and information
about the answer. In case of 'error', a list with the errors. In case of
'ok' the name of the created node.
"""
iq = Iq(
typ='set',
queryNS=None,
attrs={},
frm=self._client
)
pubsub_node = Node(tag='pubsub', attrs={'xmlns': NS_PUBSUB})
publish_node = Node(tag='publish', attrs={'node': node})
item_node = Node(tag='item')
if event is not None:
item_node.addChild(node=event)
publish_node.addChild(node=item_node)
pubsub_node.addChild(node=publish_node)
iq.addChild(node=pubsub_node)
def getContents(msg):
node_publish = msg.getTag('pubsub').getTag('publish')
#XXX: Server implementation always returns the item id, but XEP-60 does
# vim snot require it
return [node_publish['node'], node_publish.getTag('item')['id']]
return self._sendAndReceive(iq, getContents)
