libervia-backend: src/plugins/plugin_xep

annotate src/plugins/plugin_xep_0059.py @ 1950:227a4e617549

jp: --output option: - new --output option can be added wich use_output. use_output can be True (in which case it wild default to C.OUTPUT_TEXT), or any of C.OUTPUT_TYPES (currently text, list and dict) - output change the output format mainly to make command result parsing more easy, but it can also be use to add fancy effects (like coloration) - outputs are added with plugins in the same way as commands (import of both is done in the same method) - in the command class, output need to be declared with use_output=C.OUTPUT_xxx, then the data only need to be processed with self.output(data) - outputs can have description (not used yet) - use_xxx argument handling has been refactored (minor refactoring) to be more generic - first outputs are "default", "json" (pretty printed) and "json_raw" (compact json) - the first command to use them is "profile list"

author	Goffi <goffi@goffi.org>
date	Sat, 23 Apr 2016 23:10:03 +0200
parents	2daf7b4c6756
children	1d3f73e065e1

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1769 diff changeset	1 #!/usr/bin/env python2
1219 16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	2 # -- coding: utf-8 --
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	3
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	4 # SAT plugin for Result Set Management (XEP-0059)
1766 d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1465 diff changeset	5 # Copyright (C) 2009-2016 Jérôme Poisson (goffi@goffi.org)
d17772b0fe22 copyright update Goffi <goffi@goffi.org> parents: 1465 diff changeset	6 # Copyright (C) 2013-2016 Adrien Cossa (souliane@mailoo.org)
1219 16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	7
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	8 # This program is free software: you can redistribute it and/or modify
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	9 # it under the terms of the GNU Affero General Public License as published by
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	10 # the Free Software Foundation, either version 3 of the License, or
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	11 # (at your option) any later version.
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	12
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	13 # This program is distributed in the hope that it will be useful,
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	16 # GNU Affero General Public License for more details.
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	17
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	18 # You should have received a copy of the GNU Affero General Public License
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	20
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	21 from sat.core.i18n import _
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	22 from sat.core.log import getLogger
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	23 log = getLogger(__name__)
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	24
1769 1fc6a380f4db plugin xep-0059: minor cleaning Goffi <goffi@goffi.org> parents: 1766 diff changeset	25 from wokkel import disco
1fc6a380f4db plugin xep-0059: minor cleaning Goffi <goffi@goffi.org> parents: 1766 diff changeset	26 from wokkel import iwokkel
1fc6a380f4db plugin xep-0059: minor cleaning Goffi <goffi@goffi.org> parents: 1766 diff changeset	27 from wokkel import rsm
1fc6a380f4db plugin xep-0059: minor cleaning Goffi <goffi@goffi.org> parents: 1766 diff changeset	28
1fc6a380f4db plugin xep-0059: minor cleaning Goffi <goffi@goffi.org> parents: 1766 diff changeset	29 from twisted.words.protocols.jabber import xmlstream
1219 16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	30 from zope.interface import implements
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	31
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	32
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	33 PLUGIN_INFO = {
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	34 "name": "Result Set Management",
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	35 "import_name": "XEP-0059",
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	36 "type": "XEP",
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	37 "protocols": ["XEP-0059"],
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	38 "main": "XEP_0059",
1465 cbf38047ca60 plugin XEP-0059: fixed bad disco handling Goffi <goffi@goffi.org> parents: 1396 diff changeset	39 "handler": "yes",
1219 16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	40 "description": _("""Implementation of Result Set Management""")
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	41 }
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	42
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	43
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	44 class XEP_0059(object):
1267 ea692d51a0ee plugins XEP-0059, XEP-0060: leave internal wokkel extensions to sat.tmp.wokkel souliane <souliane@mailoo.org> parents: 1219 diff changeset	45 # XXX: RSM management is done directly in Wokkel.
1219 16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	46
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	47 def __init__(self, host):
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	48 log.info(_("Result Set Management plugin initialization"))
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	49
1465 cbf38047ca60 plugin XEP-0059: fixed bad disco handling Goffi <goffi@goffi.org> parents: 1396 diff changeset	50 def getHandler(self, profile):
cbf38047ca60 plugin XEP-0059: fixed bad disco handling Goffi <goffi@goffi.org> parents: 1396 diff changeset	51 return XEP_0059_handler()
cbf38047ca60 plugin XEP-0059: fixed bad disco handling Goffi <goffi@goffi.org> parents: 1396 diff changeset	52
1219 16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	53
1769 1fc6a380f4db plugin xep-0059: minor cleaning Goffi <goffi@goffi.org> parents: 1766 diff changeset	54 class XEP_0059_handler(xmlstream.XMPPHandler):
1219 16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	55 implements(iwokkel.IDisco)
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	56
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	57 def getDiscoInfo(self, requestor, target, nodeIdentifier=''):
1769 1fc6a380f4db plugin xep-0059: minor cleaning Goffi <goffi@goffi.org> parents: 1766 diff changeset	58 return [disco.DiscoFeature(rsm.NS_RSM)]
1219 16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	59
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	60 def getDiscoItems(self, requestor, target, nodeIdentifier=''):
16484ebb695b plugin XEP-0059: first draft, pubsub and jabber search do not exploit it yet souliane <souliane@mailoo.org> parents: diff changeset	61 return []

Mercurial > libervia-backend

annotate src/plugins/plugin_xep_0059.py @ 1950:227a4e617549