libervia-pubsub: sat_pubsub/iidavoll.py annotate

annotate sat_pubsub/iidavoll.py @ 364:8bd8be6815ab

completed docstrings + use short notation for sets

author	Arnaud Joset <info@agayon.be>
date	Fri, 03 Nov 2017 13:59:54 +0100
parents	5d7c3787672e
children	9fbb31ce495b

rev	line source
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	1 #!/usr/bin/python
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	2 #-- coding: utf-8 --
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	3
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	4 # Copyright (c) 2003-2011 Ralph Meijer
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	5 # Copyright (c) 2012-2016 Jérôme Poisson
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	6
564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	7
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	8 # This program is free software: you can redistribute it and/or modify
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	9 # it under the terms of the GNU Affero General Public License as published by
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	10 # the Free Software Foundation, either version 3 of the License, or
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	11 # (at your option) any later version.
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	12
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	13 # This program is distributed in the hope that it will be useful,
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	16 # GNU Affero General Public License for more details.
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	17
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	18 # You should have received a copy of the GNU Affero General Public License
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	20 # --
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	21
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	22 # This program is based on Idavoll (http://idavoll.ik.nu/),
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	23 # originaly written by Ralph Meijer (http://ralphm.net/blog/)
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	24 # It is sublicensed under AGPL v3 (or any later version) as allowed by the original
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	25 # license.
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	26
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	27 # --
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	28
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	29 # Here is a copy of the original license:
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	30
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	31 # Copyright (c) 2003-2011 Ralph Meijer
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	32
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	33 # Permission is hereby granted, free of charge, to any person obtaining
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	34 # a copy of this software and associated documentation files (the
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	35 # "Software"), to deal in the Software without restriction, including
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	36 # without limitation the rights to use, copy, modify, merge, publish,
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	37 # distribute, sublicense, and/or sell copies of the Software, and to
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	38 # permit persons to whom the Software is furnished to do so, subject to
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	39 # the following conditions:
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	40
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	41 # The above copyright notice and this permission notice shall be
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	42 # included in all copies or substantial portions of the Software.
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	43
312 5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	44 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	45 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	46 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	47 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	48 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	49 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
5d7c3787672e fixed copyright put in docstring instead of comments Goffi <goffi@goffi.org> parents: 311 diff changeset	50 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
233 564ae55219e1 sublicensed under AGPL V3 Goffi <goffi@goffi.org> parents: 232 diff changeset	51
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	52
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	53 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	54 Interfaces for idavoll.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	55 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	56
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	57 from zope.interface import Attribute, Interface
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	58
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	59 class IBackendService(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	60 """ Interface to a backend service of a pubsub service. """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	61
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	62
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	63 def __init__(storage):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	64 """
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	65 @param storage: Object providing L{IStorage}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	66 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	67
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	68
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	69 def supportsPublisherAffiliation():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	70 """ Reports if the backend supports the publisher affiliation.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	71
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	72 @rtype: C{bool}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	73 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	74
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	75
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	76 def supportsOutcastAffiliation():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	77 """ Reports if the backend supports the publisher affiliation.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	78
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	79 @rtype: C{bool}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	80 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	81
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	82
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	83 def supportsPersistentItems():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	84 """ Reports if the backend supports persistent items.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	85
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	86 @rtype: C{bool}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	87 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	88
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	89
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	90 def getNodeType(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	91 """ Return type of a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	92
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	93 @return: a deferred that returns either 'leaf' or 'collection'
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	94 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	95
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	96
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	97 def getNodes():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	98 """ Returns list of all nodes.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	99
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	100 @return: a deferred that returns a C{list} of node ids.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	101 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	102
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	103
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	104 def getNodeMetaData(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	105 """ Return meta data for a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	106
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	107 @return: a deferred that returns a C{list} of C{dict}s with the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	108 metadata.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	109 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	110
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	111
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	112 def createNode(nodeIdentifier, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	113 """ Create a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	114
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	115 @return: a deferred that fires when the node has been created.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	116 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	117
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	118
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	119 def registerPreDelete(preDeleteFn):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	120 """ Register a callback that is called just before a node deletion.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	121
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	122 The function C{preDeletedFn} is added to a list of functions to be
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	123 called just before deletion of a node. The callback C{preDeleteFn} is
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	124 called with the C{nodeIdentifier} that is about to be deleted and
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	125 should return a deferred that returns a list of deferreds that are to
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	126 be fired after deletion. The backend collects the lists from all these
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	127 callbacks before actually deleting the node in question. After
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	128 deletion all collected deferreds are fired to do post-processing.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	129
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	130 The idea is that you want to be able to collect data from the node
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	131 before deleting it, for example to get a list of subscribers that have
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	132 to be notified after the node has been deleted. To do this,
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	133 C{preDeleteFn} fetches the subscriber list and passes this list to a
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	134 callback attached to a deferred that it sets up. This deferred is
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	135 returned in the list of deferreds.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	136 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	137
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	138
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	139 def deleteNode(nodeIdentifier, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	140 """ Delete a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	141
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	142 @return: a deferred that fires when the node has been deleted.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	143 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	144
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	145
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	146 def purgeNode(nodeIdentifier, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	147 """ Removes all items in node from persistent storage """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	148
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	149
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	150 def subscribe(nodeIdentifier, subscriber, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	151 """ Request the subscription of an entity to a pubsub node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	152
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	153 Depending on the node's configuration and possible business rules, the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	154 C{subscriber} is added to the list of subscriptions of the node with id
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	155 C{nodeIdentifier}. The C{subscriber} might be different from the
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	156 C{requestor}, and if the C{requestor} is not allowed to subscribe this
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	157 entity an exception should be raised.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	158
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	159 @return: a deferred that returns the subscription state
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	160 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	161
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	162
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	163 def unsubscribe(nodeIdentifier, subscriber, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	164 """ Cancel the subscription of an entity to a pubsub node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	165
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	166 The subscription of C{subscriber} is removed from the list of
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	167 subscriptions of the node with id C{nodeIdentifier}. If the
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	168 C{requestor} is not allowed to unsubscribe C{subscriber}, an an
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	169 exception should be raised.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	170
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	171 @return: a deferred that fires when unsubscription is complete.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	172 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	173
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	174
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	175 def getSubscribers(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	176 """ Get node subscriber list.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	177
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	178 @return: a deferred that fires with the list of subscribers.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	179 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	180
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	181
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	182 def getSubscriptions(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	183 """ Report the list of current subscriptions with this pubsub service.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	184
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	185 Report the list of the current subscriptions with all nodes within this
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	186 pubsub service, for the C{entity}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	187
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	188 @return: a deferred that returns the list of all current subscriptions
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	189 as tuples C{(nodeIdentifier, subscriber, subscription)}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	190 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	191
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	192
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	193 def getAffiliations(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	194 """ Report the list of current affiliations with this pubsub service.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	195
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	196 Report the list of the current affiliations with all nodes within this
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	197 pubsub service, for the C{entity}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	198
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	199 @return: a deferred that returns the list of all current affiliations
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	200 as tuples C{(nodeIdentifier, affiliation)}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	201 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	202
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	203
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	204 def publish(nodeIdentifier, items, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	205 """ Publish items to a pubsub node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	206
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	207 @return: a deferred that fires when the items have been published.
173 246911bcb699 Make node type part of node configuration. Ralph Meijer <ralphm@ik.nu> parents: 167 diff changeset	208 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	209 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	210
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	211
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	212 def registerNotifier(observerfn, args, *kwargs):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	213 """ Register callback which is called for notification. """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	214
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	215
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	216 def getNotifications(nodeIdentifier, items):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	217 """
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	218 Get notification list.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	219
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	220 This method is called to discover which entities should receive
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	221 notifications for the given items that have just been published to the
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	222 given node.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	223
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	224 The notification list contains tuples (subscriber, subscriptions,
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	225 items) to result in one notification per tuple: the given subscriptions
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	226 yielded the given items to be notified to this subscriber. This
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	227 structure is needed allow for letting the subscriber know which
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	228 subscriptions yielded which notifications, while catering for
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	229 collection nodes and content-based subscriptions.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	230
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	231 To minimize the amount of notifications per entity, implementers
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	232 should take care that if all items in C{items} were yielded
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	233 by the same set of subscriptions, exactly one tuple is for this
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	234 subscriber is returned, so that the subscriber would get exactly one
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	235 notification. Alternatively, one tuple per subscription combination.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	236
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	237 @param nodeIdentifier: The identifier of the node the items were
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	238 published to.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	239 @type nodeIdentifier: C{unicode}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	240 @param items: The list of published items as
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	241 L{Element<twisted.words.xish.domish.Element>}s.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	242 @type items: C{list}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	243 @return: The notification list as tuples of
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	244 (L{JID<twisted.words.protocols.jabber.jid.JID>},
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	245 C{list} of L{Subscription<wokkel.pubsub.Subscription>},
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	246 C{list} of L{Element<twisted.words.xish.domish.Element>}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	247 @rtype: C{list}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	248 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	249
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	250
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	251 def getItems(nodeIdentifier, requestor, maxItems=None, itemIdentifiers=[]):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	252 """ Retrieve items from persistent storage
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	253
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	254 If C{maxItems} is given, return the C{maxItems} last published
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	255 items, else if C{itemIdentifiers} is not empty, return the items
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	256 requested. If neither is given, return all items.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	257
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	258 @return: a deferred that returns the requested items
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	259 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	260
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	261
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	262 def retractItem(nodeIdentifier, itemIdentifier, requestor):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	263 """ Removes item in node from persistent storage """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	264
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	265
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	266
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	267 class IStorage(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	268 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	269 Storage interface.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	270 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	271
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	272
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	273 def getNode(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	274 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	275 Get Node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	276
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	277 @param nodeIdentifier: NodeID of the desired node.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	278 @type nodeIdentifier: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	279 @return: deferred that returns a L{INode} providing object.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	280 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	281
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	282
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	283 def getNodeIds():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	284 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	285 Return all NodeIDs.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	286
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	287 @return: deferred that returns a list of NodeIDs (C{unicode}).
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	288 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	289
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	290
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	291 def createNode(nodeIdentifier, owner, config):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	292 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	293 Create new node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	294
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	295 The implementation should make sure, the passed owner JID is stripped
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	296 of the resource (e.g. using C{owner.userhostJID()}). The passed config
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	297 is expected to have values for the fields returned by
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	298 L{getDefaultConfiguration}, as well as a value for
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	299 C{'pubsub#node_type'}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	300
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	301 @param nodeIdentifier: NodeID of the new node.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	302 @type nodeIdentifier: C{unicode}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	303 @param owner: JID of the new nodes's owner.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	304 @type owner: L{JID<twisted.words.protocols.jabber.jid.JID>}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	305 @param config: Node configuration.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	306 @type config: C{dict}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	307 @return: deferred that fires on creation.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	308 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	309
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	310
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	311 def deleteNode(nodeIdentifier):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	312 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	313 Delete a node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	314
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	315 @param nodeIdentifier: NodeID of the new node.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	316 @type nodeIdentifier: C{unicode}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	317 @return: deferred that fires on deletion.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	318 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	319
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	320
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	321 def getAffiliations(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	322 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	323 Get all affiliations for entity.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	324
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	325 The implementation should make sure, the passed owner JID is stripped
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	326 of the resource (e.g. using C{owner.userhostJID()}).
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	327
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	328 @param entity: JID of the entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	329 @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	330 @return: deferred that returns a C{list} of tuples of the form
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	331 C{(nodeIdentifier, affiliation)}, where C{nodeIdentifier} is
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	332 of the type L{unicode} and C{affiliation} is one of
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	333 C{'owner'}, C{'publisher'} and C{'outcast'}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	334 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	335
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	336
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	337 def getSubscriptions(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	338 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	339 Get all subscriptions for an entity.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	340
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	341 The implementation should make sure, the passed owner JID is stripped
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	342 of the resource (e.g. using C{owner.userhostJID()}).
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	343
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	344 @param entity: JID of the entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	345 @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	346 @return: deferred that returns a C{list} of tuples of the form
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	347 C{(nodeIdentifier, subscriber, state)}, where
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	348 C{nodeIdentifier} is of the type C{unicode}, C{subscriber} of
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	349 the type J{JID<twisted.words.protocols.jabber.jid.JID>}, and
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	350 C{state} is C{'subscribed'}, C{'pending'} or
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	351 C{'unconfigured'}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	352 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	353
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	354
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	355 def getDefaultConfiguration(nodeType):
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	356 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	357 Get the default configuration for the given node type.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	358
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	359 @param nodeType: Either C{'leaf'} or C{'collection'}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	360 @type nodeType: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	361 @return: The default configuration.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	362 @rtype: C{dict}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	363 @raises: L{idavoll.error.NoCollections} if collections are not
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	364 supported.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	365 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	366
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	367
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	368
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	369 class INode(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	370 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	371 Interface to the class of objects that represent nodes.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	372 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	373
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	374 nodeType = Attribute("""The type of this node. One of {'leaf'},
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	375 {'collection'}.""")
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	376 nodeIdentifier = Attribute("""The node identifer of this node""")
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	377
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	378
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	379 def getType():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	380 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	381 Get node's type.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	382
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	383 @return: C{'leaf'} or C{'collection'}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	384 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	385
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	386
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	387 def getConfiguration():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	388 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	389 Get node's configuration.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	390
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	391 The configuration must at least have two options:
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	392 C{pubsub#persist_items}, and C{pubsub#deliver_payloads}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	393
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	394 @return: C{dict} of configuration options.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	395 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	396
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	397
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	398 def getMetaData():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	399 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	400 Get node's meta data.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	401
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	402 The meta data must be a superset of the configuration options, and
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	403 also at least should have a C{pubsub#node_type} entry.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	404
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	405 @return: C{dict} of meta data.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	406 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	407
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	408
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	409 def setConfiguration(options):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	410 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	411 Set node's configuration.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	412
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	413 The elements of {options} will set the new values for those
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	414 configuration items. This means that only changing items have to
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	415 be given.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	416
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	417 @param options: a dictionary of configuration options.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	418 @returns: a deferred that fires upon success.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	419 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	420
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	421
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	422 def getAffiliation(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	423 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	424 Get affiliation of entity with this node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	425
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	426 @param entity: JID of entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	427 @type entity: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	428 @return: deferred that returns C{'owner'}, C{'publisher'}, C{'outcast'}
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	429 or C{None}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	430 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	431
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	432
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	433 def getSubscription(subscriber):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	434 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	435 Get subscription to this node of subscriber.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	436
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	437 @param subscriber: JID of the new subscriptions' entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	438 @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	439 @return: deferred that returns the subscription state (C{'subscribed'},
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	440 C{'pending'} or C{None}).
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	441 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	442
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	443
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	444 def getSubscriptions(state=None):
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	445 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	446 Get list of subscriptions to this node.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	447
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	448 The optional C{state} argument filters the subscriptions to their
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	449 state.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	450
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	451 @param state: Subscription state filter. One of C{'subscribed'},
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	452 C{'pending'}, C{'unconfigured'}.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	453 @type state: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	454 @return: a deferred that returns a C{list} of
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	455 L{wokkel.pubsub.Subscription}s.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	456 """
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	457
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	458
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	459 def addSubscription(subscriber, state, config):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	460 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	461 Add new subscription to this node with given state.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	462
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	463 @param subscriber: JID of the new subscriptions' entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	464 @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	465 @param state: C{'subscribed'} or C{'pending'}
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	466 @type state: C{str}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	467 @param config: Subscription configuration.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	468 @param config: C{dict}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	469 @return: deferred that fires on subscription.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	470 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	471
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	472
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	473 def removeSubscription(subscriber):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	474 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	475 Remove subscription to this node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	476
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	477 @param subscriber: JID of the subscriptions' entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	478 @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	479 @return: deferred that fires on removal.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	480 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	481
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	482
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	483 def isSubscribed(entity):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	484 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	485 Returns whether entity has any subscription to this node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	486
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	487 Only returns C{True} when the subscription state (if present) is
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	488 C{'subscribed'} for any subscription that matches the bare JID.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	489
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	490 @param subscriber: bare JID of the subscriptions' entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	491 @type subscriber: L{JID<twisted.words.protocols.jabber.jid.JID>}
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	492 @return: deferred that returns a C{bool}.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	493 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	494
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	495
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	496 def getAffiliations():
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	497 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	498 Get affiliations of entities with this node.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	499
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	500 @return: deferred that returns a C{list} of tuples (jid, affiliation),
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	501 where jid is a L(JID<twisted.words.protocols.jabber.jid.JID>)
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	502 and affiliation is one of C{'owner'},
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	503 C{'publisher'}, C{'outcast'}.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	504 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	505
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	506
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	507
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	508 class ILeafNode(Interface):
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	509 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	510 Interface to the class of objects that represent leaf nodes.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	511 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	512
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	513 def storeItems(items, publisher):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	514 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	515 Store items in persistent storage for later retrieval.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	516
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	517 @param items: The list of items to be stored. Each item is the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	518 L{domish} representation of the XML fragment as defined
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	519 for C{<item/>} in the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	520 C{http://jabber.org/protocol/pubsub} namespace.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	521 @type items: C{list} of {domish.Element}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	522 @param publisher: JID of the publishing entity.
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	523 @type publisher: L{JID<twisted.words.protocols.jabber.jid.JID>}
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	524 @return: deferred that fires upon success.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	525 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	526
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	527
e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	528 def removeItems(itemIdentifiers):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	529 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	530 Remove items by id.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	531
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	532 @param itemIdentifiers: C{list} of item ids.
274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	533 @return: deferred that fires with a C{list} of ids of the items that
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	534 were deleted
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	535 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	536
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	537
265 89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	538 def getItems(authorized_groups, unrestricted, maxItems=None):
89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	539 """ Get all authorised items
89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	540 If C{maxItems} is not given, all authorised items in the node are returned,
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	541 just like C{getItemsById}. Otherwise, C{maxItems} limits
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	542 the returned items to a maximum of that number of most recently
265 89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	543 published and authorised items.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	544
265 89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	545 @param authorized_groups: we want to get items that these groups can access
89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	546 @param unrestricted: if true, don't check permissions (i.e.: get all items)
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	547 @param maxItems: if given, a natural number (>0) that limits the
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	548 returned number of items.
265 89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	549 @return: deferred that fires a C{list} of (item, access_model, id)
89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	550 if unrestricted is True, else a C{list} of items.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	551 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	552
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	553
278 8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	554 def countItems(authorized_groups, unrestricted):
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	555 """ Count the accessible items.
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	556
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	557 @param authorized_groups: we want to get items that these groups can access.
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	558 @param unrestricted: if true, don't check permissions (i.e.: get all items).
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	559 @return: deferred that fires a C{int}.
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	560 """
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	561
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	562
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	563 def getIndex(authorized_groups, unrestricted, item):
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	564 """ Retrieve the index of the given item within the accessible window.
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	565
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	566 @param authorized_groups: we want to get items that these groups can access.
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	567 @param unrestricted: if true, don't check permissions (i.e.: get all items).
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	568 @param item: item identifier.
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	569 @return: deferred that fires a C{int}.
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	570 """
8a71486c3e95 implements RSM (XEP-0059) souliane <souliane@mailoo.org> parents: 265 diff changeset	571
265 89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	572 def getItemsById(authorized_groups, unrestricted, itemIdentifiers):
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	573 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	574 Get items by item id.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	575
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	576 Each item in the returned list is a unicode string that
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	577 represent the XML of the item as it was published, including the
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	578 item wrapper with item id.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	579
265 89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	580 @param authorized_groups: we want to get items that these groups can access
89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	581 @param unrestricted: if true, don't check permissions
206 274a45d2a5ab Implement root collection that includes all leaf nodes. Ralph Meijer <ralphm@ik.nu> parents: 204 diff changeset	582 @param itemIdentifiers: C{list} of item ids.
265 89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	583 @return: deferred that fires a C{list} of (item, access_model, id)
89493845d3dd fix the method signatures of iidavoll.ILeafNode and memory_storage.LeafNode according to pgsql_storage.LeafNode souliane <souliane@mailoo.org> parents: 263 diff changeset	584 if unrestricted is True, else a C{list} of items.
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	585 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	586
198 e404775b12df Change naming and spacing conventions to match Twisted's. Ralph Meijer <ralphm@ik.nu> parents: 189 diff changeset	587
167 ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	588 def purge():
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	589 """
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	590 Purge node of all items in persistent storage.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	591
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	592 @return: deferred that fires when the node has been purged.
ef22e4150caa Move protocol implementations (pubsub, disco, forms) to and depend on wokkel. Ralph Meijer <ralphm@ik.nu> parents: diff changeset	593 """
204 b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	594
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	595
263 9dfd3890e646 added the constant FLAG_RETRACT_ALLOW_PUBLISHER to allow a publisher to retract an item he has published in a node of "open" publish model. souliane <souliane@mailoo.org> parents: 255 diff changeset	596 def filterItemsWithPublisher(itemIdentifiers, requestor):
9dfd3890e646 added the constant FLAG_RETRACT_ALLOW_PUBLISHER to allow a publisher to retract an item he has published in a node of "open" publish model. souliane <souliane@mailoo.org> parents: 255 diff changeset	597 """
9dfd3890e646 added the constant FLAG_RETRACT_ALLOW_PUBLISHER to allow a publisher to retract an item he has published in a node of "open" publish model. souliane <souliane@mailoo.org> parents: 255 diff changeset	598 Filter the given items by checking the items publisher against the requestor.
9dfd3890e646 added the constant FLAG_RETRACT_ALLOW_PUBLISHER to allow a publisher to retract an item he has published in a node of "open" publish model. souliane <souliane@mailoo.org> parents: 255 diff changeset	599
9dfd3890e646 added the constant FLAG_RETRACT_ALLOW_PUBLISHER to allow a publisher to retract an item he has published in a node of "open" publish model. souliane <souliane@mailoo.org> parents: 255 diff changeset	600 @param itemIdentifiers: C{list} of item ids.
9dfd3890e646 added the constant FLAG_RETRACT_ALLOW_PUBLISHER to allow a publisher to retract an item he has published in a node of "open" publish model. souliane <souliane@mailoo.org> parents: 255 diff changeset	601 @param requestor: JID of the requestor.
9dfd3890e646 added the constant FLAG_RETRACT_ALLOW_PUBLISHER to allow a publisher to retract an item he has published in a node of "open" publish model. souliane <souliane@mailoo.org> parents: 255 diff changeset	602 @type requestor: L{JID<twisted.words.protocols.jabber.jid.JID>}
9dfd3890e646 added the constant FLAG_RETRACT_ALLOW_PUBLISHER to allow a publisher to retract an item he has published in a node of "open" publish model. souliane <souliane@mailoo.org> parents: 255 diff changeset	603 @return: deferred that fires with a C{list} of item identifiers.
9dfd3890e646 added the constant FLAG_RETRACT_ALLOW_PUBLISHER to allow a publisher to retract an item he has published in a node of "open" publish model. souliane <souliane@mailoo.org> parents: 255 diff changeset	604 """
204 b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	605
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	606 class IGatewayStorage(Interface):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	607
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	608 def addCallback(service, nodeIdentifier, callback):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	609 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	610 Register a callback URI.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	611
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	612 The registered HTTP callback URI will have an Atom Entry documented
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	613 POSTed to it upon receiving a notification for the given pubsub node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	614
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	615 @param service: The XMPP entity that holds the node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	616 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	617 @param nodeIdentifier: The identifier of the publish-subscribe node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	618 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	619 @param callback: The callback URI to be registered.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	620 @type callback: C{str}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	621 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	622 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	623
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	624 def removeCallback(service, nodeIdentifier, callback):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	625 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	626 Remove a registered callback URI.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	627
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	628 The returned deferred will fire with a boolean that signals wether or
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	629 not this was the last callback unregistered for this node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	630
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	631 @param service: The XMPP entity that holds the node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	632 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	633 @param nodeIdentifier: The identifier of the publish-subscribe node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	634 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	635 @param callback: The callback URI to be unregistered.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	636 @type callback: C{str}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	637 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	638 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	639
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	640 def getCallbacks(service, nodeIdentifier):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	641 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	642 Get the callbacks registered for this node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	643
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	644 Returns a deferred that fires with the set of HTTP callback URIs
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	645 registered for this node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	646
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	647 @param service: The XMPP entity that holds the node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	648 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	649 @param nodeIdentifier: The identifier of the publish-subscribe node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	650 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	651 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	652 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	653
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	654
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	655 def hasCallbacks(service, nodeIdentifier):
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	656 """
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	657 Return wether there are callbacks registered for a node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	658
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	659 @param service: The XMPP entity that holds the node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	660 @type service: L{JID<twisted.words.protocols.jabber.jid.JID>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	661 @param nodeIdentifier: The identifier of the publish-subscribe node.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	662 @type nodeIdentifier: C{unicode}.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	663 @returns: Deferred that fires with a boolean.
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	664 @rtype: L{Deferred<twisted.internet.defer.Deferred>}
b4bf0a5ce50d Implement storage facilities for the HTTP gateway. Ralph Meijer <ralphm@ik.nu> parents: 198 diff changeset	665 """

Mercurial > libervia-pubsub

annotate sat_pubsub/iidavoll.py @ 364:8bd8be6815ab