libervia-backend: src/plugins/plugin_tmp_directory

annotate src/plugins/plugin_tmp_directory_subscription.py @ 2532:772447ec070f

jp: pubsub options refactoring: There is now only "use_pubsub", and specification are set using "pubsub_flags" argument when instantiating CommandBase. Options are more Python Zen compliant by using explicit arguments for item, draft, url instead of trying to guess with magic keyword and type detection. Pubsub node and item are now always using respecively "-n" and "-i" even when required, this way shell history can be used to change command more easily, and it's globally less confusing for user. if --pubsub-url is used, elements can be overwritten with individual option (e.g. change item id with --item). New "use_draft" argument in CommandBase, to re-use current draft or open a file path as draft. Item can now be specified when using a draft. If it already exists, its content will be added to current draft (with a separator), to avoid loosing data. common.BaseEdit.getItemPath could be simplified thanks to those changes. Pubsub URI handling has been moved to base.py.

author	Goffi <goffi@goffi.org>
date	Wed, 21 Mar 2018 19:13:22 +0100
parents	33c8c4973743
children

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1810 diff changeset	1 #!/usr/bin/env python2
1810 25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	2 # -- coding: utf-8 --
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	3
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	4 # SAT plugin for directory subscription
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Jérôme Poisson (goffi@goffi.org)
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	6 # Copyright (C) 2015, 2016 Adrien Cossa (souliane@mailoo.org)
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	7
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	8 # This program is free software: you can redistribute it and/or modify
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	9 # it under the terms of the GNU Affero General Public License as published by
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	10 # the Free Software Foundation, either version 3 of the License, or
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	11 # (at your option) any later version.
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	12
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	13 # This program is distributed in the hope that it will be useful,
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	16 # GNU Affero General Public License for more details.
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	17
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	18 # You should have received a copy of the GNU Affero General Public License
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	20
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	21 from sat.core.i18n import _, D_
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	22 from sat.core.constants import Const as C
1810 25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	23 from sat.core.log import getLogger
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	24 log = getLogger(__name__)
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	25
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	26
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	27 PLUGIN_INFO = {
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	28 C.PI_NAME: "Directory subscription plugin",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	29 C.PI_IMPORT_NAME: "DIRECTORY-SUBSCRIPTION",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	30 C.PI_TYPE: "TMP",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	31 C.PI_PROTOCOLS: [],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	32 C.PI_DEPENDENCIES: ["XEP-0050", "XEP-0055"],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	33 C.PI_RECOMMENDATIONS: [],
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	34 C.PI_MAIN: "DirectorySubscription",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	35 C.PI_HANDLER: "no",
33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	36 C.PI_DESCRIPTION: _("""Implementation of directory subscription""")
1810 25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	37 }
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	38
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	39
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	40 NS_COMMANDS = "http://jabber.org/protocol/commands"
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	41 CMD_UPDATE_SUBSCRIBTION = "update"
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	42
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	43
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	44 class DirectorySubscription(object):
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	45
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	46 def __init__(self, host):
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	47 log.info(_("Directory subscription plugin initialization"))
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	48 self.host = host
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	49 host.importMenu((D_("Service"), D_("Directory subscription")), self.subscribe, security_limit=1, help_string=D_("User directory subscription"))
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	50
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	51 def subscribe(self, raw_data, profile):
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	52 """Request available commands on the jabber search service associated to profile's host.
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	53
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	54 @param raw_data (dict): data received from the frontend
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	55 @param profile (unicode): %(doc_profile)s
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	56 @return: a deferred dict{unicode: unicode}
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	57 """
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	58 d = self.host.plugins["XEP-0055"]._getHostServices(profile)
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	59
1810 25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	60 def got_services(services):
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	61 service_jid = services[0]
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	62 session_id, session_data = self.host.plugins["XEP-0050"].requesting.newSession(profile=profile)
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	63 session_data["jid"] = service_jid
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	64 session_data["node"] = CMD_UPDATE_SUBSCRIBTION
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	65 data = {"session_id": session_id}
25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	66 return self.host.plugins["XEP-0050"]._requestingEntity(data, profile)
2145 33c8c4973743 core (plugins): added missing contants + use of new constants in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 1934 diff changeset	67
1810 25c3569abb71 plugin XEP-0055, tmp_directory_subscription: move directory subscription to a new temporary plugin souliane <souliane@mailoo.org> parents: diff changeset	68 return d.addCallback(got_services)

Mercurial > libervia-backend

annotate src/plugins/plugin_tmp_directory_subscription.py @ 2532:772447ec070f