libervia-backend: sat/core/sat

annotate sat/core/sat_main.py @ 3237:b0c57c9a4bd8

plugin XEP-0384: OMEMO trust policy: OMEMO trust policy can now be specified. For now there are 2 policies: - `manual`: each new device fingerprint must be explicitly trusted or not before the device can be used, and the message sent - `BTBV` (Blind Trust Before Verification): each new device fingerprint is automically trusted, until user manually trust or not a device, in which case the behaviour becomes the same as for `manual` for the entity. When using the Trust UI, user can put the entity back to blind trust if they wish. A message is send as feedback to user when a new device is/must be trusted, trying to explain clearly what's happening to the user. Devices which have been automically trusted are marked, so user can know which ones may cause security issue.

author	Goffi <goffi@goffi.org>
date	Fri, 27 Mar 2020 10:02:14 +0100
parents	2f406b762788
children	6cf4bd6972c2

rev	line source
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1 #!/usr/bin/env python3
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	2
3220 4fbea7f1e012 tools (images): methods renaming Goffi <goffi@goffi.org> parents: 3206 diff changeset	3 # SàT: an XMPP client
3136 9d0df638c8b4 dates update Goffi <goffi@goffi.org> parents: 3125 diff changeset	4 # Copyright (C) 2009-2020 Jérôme Poisson (goffi@goffi.org)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	5
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	6 # This program is free software: you can redistribute it and/or modify
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	7 # it under the terms of the GNU Affero General Public License as published by
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	8 # the Free Software Foundation, either version 3 of the License, or
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	9 # (at your option) any later version.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	10
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	11 # This program is distributed in the hope that it will be useful,
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	14 # GNU Affero General Public License for more details.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	15
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	16 # You should have received a copy of the GNU Affero General Public License
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 605 diff changeset	17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	18
2810 c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	19 from glob import glob
c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	20 import sys
c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	21 import os.path
c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	22 import uuid
3201 439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	23 import hashlib
3206 ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	24 import copy
3201 439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	25 from pathlib import Path
1376 28fd9e838f8f core: getRepositoryData now get the module in argument Goffi <goffi@goffi.org> parents: 1375 diff changeset	26 import sat
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	27 from sat.core.i18n import _, D_, languageSwitch
2687 e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2666 diff changeset	28 from sat.core import patches
e9cd473a2f46 core (xmpp): server certificate validation: Goffi <goffi@goffi.org> parents: 2666 diff changeset	29 patches.apply()
331 0a8eb0461f31 core: main SAT class now moved in its own module core.sat_main Goffi <goffi@goffi.org> parents: 330 diff changeset	30 from twisted.application import service
0a8eb0461f31 core: main SAT class now moved in its own module core.sat_main Goffi <goffi@goffi.org> parents: 330 diff changeset	31 from twisted.internet import defer
1037 6e975c6b0faf core, memory, bridge, plugin misc_register_account: move registerNewAccount to a new plugin: souliane <souliane@mailoo.org> parents: 1032 diff changeset	32 from twisted.words.protocols.jabber import jid
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	33 from twisted.internet import reactor
346 ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	34 from wokkel.xmppim import RosterItem
332 8c9b9ef13ba1 core: minor refactoring Goffi <goffi@goffi.org> parents: 331 diff changeset	35 from sat.core import xmpp
627 d207c2186519 core, bridge, jp, quick_frontend: SàT stop more gracefully if bridge can't be initialised: Goffi <goffi@goffi.org> parents: 609 diff changeset	36 from sat.core import exceptions
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 991 diff changeset	37 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	38
914 1a3ba959f0ab core (memory): moved Params in its own module + introduced a new core/constants module, and moved some constants there Goffi <goffi@goffi.org> parents: 909 diff changeset	39 from sat.core.constants import Const as C
2509 d485e9416493 core (memory/cache): common cache: Goffi <goffi@goffi.org> parents: 2496 diff changeset	40 from sat.memory import memory
d485e9416493 core (memory/cache): common cache: Goffi <goffi@goffi.org> parents: 2496 diff changeset	41 from sat.memory import cache
2646 712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature: Goffi <goffi@goffi.org> parents: 2645 diff changeset	42 from sat.memory import encryption
2645 f2cf1daa42cb core: added async TriggerManager Goffi <goffi@goffi.org> parents: 2643 diff changeset	43 from sat.tools import async_trigger as trigger
1375 3a20312d4012 core: if we are in dev version and it's possible, repository data are now checked and added to SàT version Goffi <goffi@goffi.org> parents: 1374 diff changeset	44 from sat.tools import utils
3220 4fbea7f1e012 tools (images): methods renaming Goffi <goffi@goffi.org> parents: 3206 diff changeset	45 from sat.tools import image
2088 c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	46 from sat.tools.common import dynamic_import
2496 769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	47 from sat.tools.common import regex
3066 2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	48 from sat.tools.common import data_format
1032 b262ae6d53af stdui: add ui_profile_manager to interact with frontends when profile authentication is needed souliane <souliane@mailoo.org> parents: 1030 diff changeset	49 from sat.stdui import ui_contact_list, ui_profile_manager
2105 c96fe007ca41 core(constants): added a constant for profile extension (PLUGIN_EXT): Goffi <goffi@goffi.org> parents: 2100 diff changeset	50 import sat.plugins
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	51
2691 1ecceac3df96 plugin XEP-0198: Stream Management implementation: Goffi <goffi@goffi.org> parents: 2689 diff changeset	52
987 3a96920c07b7 core, frontends: unify the roster management UIs in sat/stdui/ui_contact_list.py souliane <souliane@mailoo.org> parents: 972 diff changeset	53 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	54 from collections import OrderedDict # only available from python 2.7
987 3a96920c07b7 core, frontends: unify the roster management UIs in sat/stdui/ui_contact_list.py souliane <souliane@mailoo.org> parents: 972 diff changeset	55 except ImportError:
3a96920c07b7 core, frontends: unify the roster management UIs in sat/stdui/ui_contact_list.py souliane <souliane@mailoo.org> parents: 972 diff changeset	56 from ordereddict import OrderedDict
3a96920c07b7 core, frontends: unify the roster management UIs in sat/stdui/ui_contact_list.py souliane <souliane@mailoo.org> parents: 972 diff changeset	57
2810 c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	58 log = getLogger(__name__)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	59
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	60 class SAT(service.Service):
3110 3fcc99b2d6b7 core (sat_main): avoid double init + log version Goffi <goffi@goffi.org> parents: 3102 diff changeset	61 def _init(self):
3fcc99b2d6b7 core (sat_main): avoid double init + log version Goffi <goffi@goffi.org> parents: 3102 diff changeset	62 # we don't use __init__ to avoid doule initialisation with twistd
3fcc99b2d6b7 core (sat_main): avoid double init + log version Goffi <goffi@goffi.org> parents: 3102 diff changeset	63 # this _init is called in startService
3fcc99b2d6b7 core (sat_main): avoid double init + log version Goffi <goffi@goffi.org> parents: 3102 diff changeset	64 log.info(f"{C.APP_NAME} {self.full_version}")
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	65 self._cb_map = {} # map from callback_id to callbacks
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	66 self._menus = (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	67 OrderedDict()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	68 ) # dynamic menus. key: callback_id, value: menu data (dictionnary)
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	69 self._menus_paths = {} # path to id. key: (menu_type, lower case tuple of path),
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	70 # value: menu id
1591 0df9c6247474 core: profile session starting and connection are now separated. Moved profile session starting/authentication to memory module Goffi <goffi@goffi.org> parents: 1587 diff changeset	71 self.initialised = defer.Deferred()
62 93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	72 self.profiles = {}
22 bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button. Goffi <goffi@goffi.org> parents: 18 diff changeset	73 self.plugins = {}
2688 943e78e18882 core (xmpp): added missing disco#info namespace to disco info result. Goffi <goffi@goffi.org> parents: 2687 diff changeset	74 # map for short name to whole namespace,
3088 d1464548055a plugin file download: meta plugin to handle file download: Goffi <goffi@goffi.org> parents: 3066 diff changeset	75 # extended by plugins with registerNamespace
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	76 self.ns_map = {
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	77 "x-data": xmpp.NS_X_DATA,
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	78 "disco#info": xmpp.NS_DISCO_INFO,
2688 943e78e18882 core (xmpp): added missing disco#info namespace to disco info result. Goffi <goffi@goffi.org> parents: 2687 diff changeset	79 }
3088 d1464548055a plugin file download: meta plugin to handle file download: Goffi <goffi@goffi.org> parents: 3066 diff changeset	80
2509 d485e9416493 core (memory/cache): common cache: Goffi <goffi@goffi.org> parents: 2496 diff changeset	81 self.memory = memory.Memory(self)
3088 d1464548055a plugin file download: meta plugin to handle file download: Goffi <goffi@goffi.org> parents: 3066 diff changeset	82
d1464548055a plugin file download: meta plugin to handle file download: Goffi <goffi@goffi.org> parents: 3066 diff changeset	83 # trigger are used to change SàT behaviour
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	84 self.trigger = (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	85 trigger.TriggerManager()
3088 d1464548055a plugin file download: meta plugin to handle file download: Goffi <goffi@goffi.org> parents: 3066 diff changeset	86 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	87
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	88 bridge_name = self.memory.getConfig("", "bridge", "dbus")
2088 c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	89
c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	90 bridge_module = dynamic_import.bridge(bridge_name)
c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	91 if bridge_module is None:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	92 log.error("Can't find bridge module of name {}".format(bridge_name))
2088 c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	93 sys.exit(1)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	94 log.info("using {} bridge".format(bridge_name))
627 d207c2186519 core, bridge, jp, quick_frontend: SàT stop more gracefully if bridge can't be initialised: Goffi <goffi@goffi.org> parents: 609 diff changeset	95 try:
2088 c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	96 self.bridge = bridge_module.Bridge()
627 d207c2186519 core, bridge, jp, quick_frontend: SàT stop more gracefully if bridge can't be initialised: Goffi <goffi@goffi.org> parents: 609 diff changeset	97 except exceptions.BridgeInitError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	98 log.error("Bridge can't be initialised, can't start SàT core")
627 d207c2186519 core, bridge, jp, quick_frontend: SàT stop more gracefully if bridge can't be initialised: Goffi <goffi@goffi.org> parents: 609 diff changeset	99 sys.exit(1)
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	100 self.bridge.register_method("getReady", lambda: self.initialised)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	101 self.bridge.register_method("getVersion", lambda: self.full_version)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	102 self.bridge.register_method("getFeatures", self.getFeatures)
2168 255830fdb80b core, bridge: renamed getProfileName to profileNameGet according to new conventions Goffi <goffi@goffi.org> parents: 2167 diff changeset	103 self.bridge.register_method("profileNameGet", self.memory.getProfileName)
2146 1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	104 self.bridge.register_method("profilesListGet", self.memory.getProfilesList)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	105 self.bridge.register_method(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	106 "getEntityData",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	107 lambda jid_, keys, profile: self.memory.getEntityData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	108 jid.JID(jid_), keys, profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	109 ),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	110 )
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	111 self.bridge.register_method("getEntitiesData", self.memory._getEntitiesData)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	112 self.bridge.register_method("profileCreate", self.memory.createProfile)
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	113 self.bridge.register_method("asyncDeleteProfile", self.memory.asyncDeleteProfile)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	114 self.bridge.register_method("profileStartSession", self.memory.startSession)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	115 self.bridge.register_method(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	116 "profileIsSessionStarted", self.memory._isSessionStarted
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	117 )
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	118 self.bridge.register_method("profileSetDefault", self.memory.profileSetDefault)
2142 be96beb7ca14 core, bridge, frontends: renamed asyncConnect to connect, and added options parameters (not used yet) Goffi <goffi@goffi.org> parents: 2138 diff changeset	119 self.bridge.register_method("connect", self._connect)
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	120 self.bridge.register_method("disconnect", self.disconnect)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	121 self.bridge.register_method("getContacts", self.getContacts)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	122 self.bridge.register_method("getContactsFromGroup", self.getContactsFromGroup)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	123 self.bridge.register_method("getMainResource", self.memory._getMainResource)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	124 self.bridge.register_method(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	125 "getPresenceStatuses", self.memory._getPresenceStatuses
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	126 )
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	127 self.bridge.register_method("getWaitingSub", self.memory.getWaitingSub)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	128 self.bridge.register_method("messageSend", self._messageSend)
2646 712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature: Goffi <goffi@goffi.org> parents: 2645 diff changeset	129 self.bridge.register_method("messageEncryptionStart",
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature: Goffi <goffi@goffi.org> parents: 2645 diff changeset	130 self._messageEncryptionStart)
2658 4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	131 self.bridge.register_method("messageEncryptionStop",
4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	132 self._messageEncryptionStop)
4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	133 self.bridge.register_method("messageEncryptionGet",
4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	134 self._messageEncryptionGet)
2733 e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	135 self.bridge.register_method("encryptionNamespaceGet",
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	136 self._encryptionNamespaceGet)
2658 4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	137 self.bridge.register_method("encryptionPluginsGet", self._encryptionPluginsGet)
2733 e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	138 self.bridge.register_method("encryptionTrustUIGet", self._encryptionTrustUIGet)
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	139 self.bridge.register_method("getConfig", self._getConfig)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	140 self.bridge.register_method("setParam", self.setParam)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	141 self.bridge.register_method("getParamA", self.memory.getStringParamA)
3163 d10b2368684e bridge: added methods to let frontends store/retrieve/delete private data Goffi <goffi@goffi.org> parents: 3140 diff changeset	142 self.bridge.register_method("privateDataGet", self.memory._privateDataGet)
d10b2368684e bridge: added methods to let frontends store/retrieve/delete private data Goffi <goffi@goffi.org> parents: 3140 diff changeset	143 self.bridge.register_method("privateDataSet", self.memory._privateDataSet)
d10b2368684e bridge: added methods to let frontends store/retrieve/delete private data Goffi <goffi@goffi.org> parents: 3140 diff changeset	144 self.bridge.register_method("privateDataDelete", self.memory._privateDataDelete)
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	145 self.bridge.register_method("asyncGetParamA", self.memory.asyncGetStringParamA)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	146 self.bridge.register_method(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	147 "asyncGetParamsValuesFromCategory",
3123 130f9cb6e0ab core (memory/params): added `extra` argument to filter out params notably in `getParamsUI`: Goffi <goffi@goffi.org> parents: 3120 diff changeset	148 self.memory._getParamsValuesFromCategory,
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	149 )
3123 130f9cb6e0ab core (memory/params): added `extra` argument to filter out params notably in `getParamsUI`: Goffi <goffi@goffi.org> parents: 3120 diff changeset	150 self.bridge.register_method("getParamsUI", self.memory._getParamsUI)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	151 self.bridge.register_method(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	152 "getParamsCategories", self.memory.getParamsCategories
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	153 )
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	154 self.bridge.register_method("paramsRegisterApp", self.memory.paramsRegisterApp)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	155 self.bridge.register_method("historyGet", self.memory._historyGet)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	156 self.bridge.register_method("setPresence", self._setPresence)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	157 self.bridge.register_method("subscription", self.subscription)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	158 self.bridge.register_method("addContact", self._addContact)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	159 self.bridge.register_method("updateContact", self._updateContact)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	160 self.bridge.register_method("delContact", self._delContact)
2892 82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2886 diff changeset	161 self.bridge.register_method("rosterResync", self._rosterResync)
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	162 self.bridge.register_method("isConnected", self.isConnected)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	163 self.bridge.register_method("launchAction", self.launchCallback)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	164 self.bridge.register_method("actionsGet", self.actionsGet)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	165 self.bridge.register_method("progressGet", self._progressGet)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	166 self.bridge.register_method("progressGetAll", self._progressGetAll)
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	167 self.bridge.register_method("menusGet", self.getMenus)
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	168 self.bridge.register_method("menuHelpGet", self.getMenuHelp)
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	169 self.bridge.register_method("menuLaunch", self._launchMenu)
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	170 self.bridge.register_method("discoInfos", self.memory.disco._discoInfos)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	171 self.bridge.register_method("discoItems", self.memory.disco._discoItems)
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	172 self.bridge.register_method("discoFindByFeatures", self._findByFeatures)
2086 4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	173 self.bridge.register_method("saveParamsTemplate", self.memory.save_xml)
4633cfcbcccb bridge (D-Bus): bad design fixes: Goffi <goffi@goffi.org> parents: 2050 diff changeset	174 self.bridge.register_method("loadParamsTemplate", self.memory.load_xml)
2113 9c861d07b5b6 core: added sessionGetInfos bridge method to retrieve various data on current profile session + client.started keep start time Goffi <goffi@goffi.org> parents: 2105 diff changeset	175 self.bridge.register_method("sessionInfosGet", self.getSessionInfos)
3206 ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	176 self.bridge.register_method("devicesInfosGet", self._getDevicesInfos)
2443 81a45e7886c9 core: added a mechanism to associate short names to namespaces: Goffi <goffi@goffi.org> parents: 2431 diff changeset	177 self.bridge.register_method("namespacesGet", self.getNamespaces)
3066 2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	178 self.bridge.register_method("imageCheck", self._imageCheck)
2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	179 self.bridge.register_method("imageResize", self._imageResize)
3201 439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	180 self.bridge.register_method("imageGeneratePreview", self._imageGeneratePreview)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	181
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	182 self.memory.initialized.addCallback(lambda __: defer.ensureDeferred(self._postMemoryInit()))
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	183
1550 465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	184 @property
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	185 def version(self):
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	186 """Return the short version of SàT"""
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	187 return C.APP_VERSION
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	188
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	189 @property
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	190 def full_version(self):
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	191 """Return the full version of SàT
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	192
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	193 In developement mode, release name and extra data are returned too
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	194 """
1550 465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	195 version = self.version
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	196 if version[-1] == "D":
1550 465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	197 # we are in debug version, we add extra data
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	198 try:
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	199 return self._version_cache
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	200 except AttributeError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	201 self._version_cache = "{} « {} » ({})".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	202 version, C.APP_RELEASE_NAME, utils.getRepositoryData(sat)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	203 )
1550 465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	204 return self._version_cache
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	205 else:
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	206 return version
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	207
2088 c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	208 @property
c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	209 def bridge_name(self):
c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	210 return os.path.splitext(os.path.basename(self.bridge.__file__))[0]
c02f96756d5c core: bridge can now be changed in conf Goffi <goffi@goffi.org> parents: 2086 diff changeset	211
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	212 async def _postMemoryInit(self):
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	213 """Method called after memory initialization is done"""
2509 d485e9416493 core (memory/cache): common cache: Goffi <goffi@goffi.org> parents: 2496 diff changeset	214 self.common_cache = cache.Cache(self, None)
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 991 diff changeset	215 log.info(_("Memory initialised"))
2262 24f5a4d5f195 core: check uncatched exceptions during plugin import and stdui init, log error and exit if any found Goffi <goffi@goffi.org> parents: 2251 diff changeset	216 try:
24f5a4d5f195 core: check uncatched exceptions during plugin import and stdui init, log error and exit if any found Goffi <goffi@goffi.org> parents: 2251 diff changeset	217 self._import_plugins()
24f5a4d5f195 core: check uncatched exceptions during plugin import and stdui init, log error and exit if any found Goffi <goffi@goffi.org> parents: 2251 diff changeset	218 ui_contact_list.ContactList(self)
24f5a4d5f195 core: check uncatched exceptions during plugin import and stdui init, log error and exit if any found Goffi <goffi@goffi.org> parents: 2251 diff changeset	219 ui_profile_manager.ProfileManager(self)
24f5a4d5f195 core: check uncatched exceptions during plugin import and stdui init, log error and exit if any found Goffi <goffi@goffi.org> parents: 2251 diff changeset	220 except Exception as e:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	221 log.error(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	222 _("Could not initialize backend: {reason}").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	223 reason=str(e).decode("utf-8", "ignore")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	224 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	225 )
2262 24f5a4d5f195 core: check uncatched exceptions during plugin import and stdui init, log error and exit if any found Goffi <goffi@goffi.org> parents: 2251 diff changeset	226 sys.exit(1)
2810 c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	227 self._addBaseMenus()
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	228
1591 0df9c6247474 core: profile session starting and connection are now separated. Moved profile session starting/authentication to memory module Goffi <goffi@goffi.org> parents: 1587 diff changeset	229 self.initialised.callback(None)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	230 log.info(_("Backend is ready"))
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	231
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	232 # profile autoconnection must be done after self.initialised is called because
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	233 # startSession waits for it.
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	234 autoconnect_dict = await self.memory.storage.getIndParamValues(
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	235 category='Connection', name='autoconnect_backend',
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	236 )
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	237 profiles_autoconnect = [p for p, v in autoconnect_dict.items() if C.bool(v)]
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	238 if not self.trigger.point("profilesAutoconnect", profiles_autoconnect):
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	239 return
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	240 if profiles_autoconnect:
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	241 log.info(D_(
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	242 "Following profiles will be connected automatically: {profiles}"
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	243 ).format(profiles= ', '.join(profiles_autoconnect)))
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	244 connect_d_list = []
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	245 for profile in profiles_autoconnect:
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	246 connect_d_list.append(defer.ensureDeferred(self.connect(profile)))
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	247
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	248 if connect_d_list:
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	249 results = await defer.DeferredList(connect_d_list)
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	250 for idx, (success, result) in enumerate(results):
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	251 if not success:
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	252 profile = profiles_autoconnect[0]
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	253 log.warning(
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	254 _("Can't autoconnect profile {profile}: {reason}").format(
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	255 profile = profile,
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	256 reason = result)
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	257 )
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	258
2810 c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	259 def _addBaseMenus(self):
c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	260 """Add base menus"""
c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	261 encryption.EncryptionHandler._importMenus(self)
c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	262
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	263 def _unimport_plugin(self, plugin_path):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	264 """remove a plugin from sys.modules if it is there"""
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	265 try:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	266 del sys.modules[plugin_path]
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	267 except KeyError:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	268 pass
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	269
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	270 def _import_plugins(self):
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	271 """Import all plugins found in plugins directory"""
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	272 # FIXME: module imported but cancelled should be deleted
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	273 # TODO: make this more generic and reusable in tools.common
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	274 # FIXME: should use imp
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	275 # TODO: do not import all plugins if no needed: component plugins are not needed
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	276 # if we just use a client, and plugin blacklisting should be possible in
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	277 # sat.conf
2105 c96fe007ca41 core(constants): added a constant for profile extension (PLUGIN_EXT): Goffi <goffi@goffi.org> parents: 2100 diff changeset	278 plugins_path = os.path.dirname(sat.plugins.__file__)
c96fe007ca41 core(constants): added a constant for profile extension (PLUGIN_EXT): Goffi <goffi@goffi.org> parents: 2100 diff changeset	279 plugin_glob = "plugin*." + C.PLUGIN_EXT
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	280 plug_lst = [
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	281 os.path.splitext(plugin)[0]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	282 for plugin in map(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	283 os.path.basename, glob(os.path.join(plugins_path, plugin_glob))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	284 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	285 ]
1503 f681788097ba core (plugins): detect import_name conflicts Goffi <goffi@goffi.org> parents: 1491 diff changeset	286 plugins_to_import = {} # plugins we still have to import
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	287 for plug in plug_lst:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	288 plugin_path = "sat.plugins." + plug
1145 4e1a0a1523f1 core: more robust plugins importation Goffi <goffi@goffi.org> parents: 1130 diff changeset	289 try:
4e1a0a1523f1 core: more robust plugins importation Goffi <goffi@goffi.org> parents: 1130 diff changeset	290 __import__(plugin_path)
1535 c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	291 except exceptions.MissingModule as e:
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	292 self._unimport_plugin(plugin_path)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	293 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	294 "Can't import plugin [{path}] because of an unavailale third party "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	295 "module:\n{msg}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	296 path=plugin_path, msg=e
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	297 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	298 )
1535 c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	299 continue
2100 fbeeba721954 plugin android: first draft: Goffi <goffi@goffi.org> parents: 2089 diff changeset	300 except exceptions.CancelError as e:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	301 log.info(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	302 "Plugin [{path}] cancelled its own import: {msg}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	303 path=plugin_path, msg=e
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	304 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	305 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	306 self._unimport_plugin(plugin_path)
2100 fbeeba721954 plugin android: first draft: Goffi <goffi@goffi.org> parents: 2089 diff changeset	307 continue
3040 fee60f17ebac jp: jp asyncio port: Goffi <goffi@goffi.org> parents: 3028 diff changeset	308 except Exception:
1535 c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	309 import traceback
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	310
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	311 log.error(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	312 _("Can't import plugin [{path}]:\n{error}").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	313 path=plugin_path, error=traceback.format_exc()
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	314 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	315 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	316 self._unimport_plugin(plugin_path)
1145 4e1a0a1523f1 core: more robust plugins importation Goffi <goffi@goffi.org> parents: 1130 diff changeset	317 continue
287 2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	318 mod = sys.modules[plugin_path]
2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	319 plugin_info = mod.PLUGIN_INFO
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	320 import_name = plugin_info["import_name"]
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	321
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	322 plugin_modes = plugin_info["modes"] = set(
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	323 plugin_info.setdefault("modes", C.PLUG_MODE_DEFAULT)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	324 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	325
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	326 # if the plugin is an entry point, it must work in component mode
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	327 if plugin_info["type"] == C.PLUG_TYPE_ENTRY_POINT:
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	328 # if plugin is an entrypoint, we cache it
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	329 if C.PLUG_MODE_COMPONENT not in plugin_modes:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	330 log.error(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	331 _(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	332 "{type} type must be used with {mode} mode, ignoring plugin"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	333 ).format(type=C.PLUG_TYPE_ENTRY_POINT, mode=C.PLUG_MODE_COMPONENT)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	334 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	335 self._unimport_plugin(plugin_path)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	336 continue
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	337
1503 f681788097ba core (plugins): detect import_name conflicts Goffi <goffi@goffi.org> parents: 1491 diff changeset	338 if import_name in plugins_to_import:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	339 log.error(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	340 _(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	341 "Name conflict for import name [{import_name}], can't import "
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	342 "plugin [{name}]"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	343 ).format(**plugin_info)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	344 )
1503 f681788097ba core (plugins): detect import_name conflicts Goffi <goffi@goffi.org> parents: 1491 diff changeset	345 continue
f681788097ba core (plugins): detect import_name conflicts Goffi <goffi@goffi.org> parents: 1491 diff changeset	346 plugins_to_import[import_name] = (plugin_path, mod, plugin_info)
287 2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	347 while True:
1535 c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	348 try:
c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	349 self._import_plugins_from_dict(plugins_to_import)
c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	350 except ImportError:
c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	351 pass
1503 f681788097ba core (plugins): detect import_name conflicts Goffi <goffi@goffi.org> parents: 1491 diff changeset	352 if not plugins_to_import:
287 2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	353 break
2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	354
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	355 def _import_plugins_from_dict(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	356 self, plugins_to_import, import_name=None, optional=False
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	357 ):
287 2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	358 """Recursively import and their dependencies in the right order
925 5c78cefd233f core: plugins now accepts recommendations: Goffi <goffi@goffi.org> parents: 923 diff changeset	359
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	360 @param plugins_to_import(dict): key=import_name and values=(plugin_path, module,
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	361 plugin_info)
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	362 @param import_name(unicode, None): name of the plugin to import as found in
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	363 PLUGIN_INFO['import_name']
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	364 @param optional(bool): if False and plugin is not found, an ImportError exception
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	365 is raised
925 5c78cefd233f core: plugins now accepts recommendations: Goffi <goffi@goffi.org> parents: 923 diff changeset	366 """
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	367 if import_name in self.plugins:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	368 log.debug("Plugin {} already imported, passing".format(import_name))
287 2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	369 return
2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	370 if not import_name:
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	371 import_name, (plugin_path, mod, plugin_info) = plugins_to_import.popitem()
287 2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	372 else:
288 76247af9917c core: added plugin dependency not found import error Goffi <goffi@goffi.org> parents: 287 diff changeset	373 if not import_name in plugins_to_import:
925 5c78cefd233f core: plugins now accepts recommendations: Goffi <goffi@goffi.org> parents: 923 diff changeset	374 if optional:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	375 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	376 _("Recommended plugin not found: {}").format(import_name)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	377 )
925 5c78cefd233f core: plugins now accepts recommendations: Goffi <goffi@goffi.org> parents: 923 diff changeset	378 return
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	379 msg = "Dependency not found: {}".format(import_name)
1535 c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	380 log.error(msg)
c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	381 raise ImportError(msg)
287 2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	382 plugin_path, mod, plugin_info = plugins_to_import.pop(import_name)
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	383 dependencies = plugin_info.setdefault("dependencies", [])
925 5c78cefd233f core: plugins now accepts recommendations: Goffi <goffi@goffi.org> parents: 923 diff changeset	384 recommendations = plugin_info.setdefault("recommendations", [])
5c78cefd233f core: plugins now accepts recommendations: Goffi <goffi@goffi.org> parents: 923 diff changeset	385 for to_import in dependencies + recommendations:
5c78cefd233f core: plugins now accepts recommendations: Goffi <goffi@goffi.org> parents: 923 diff changeset	386 if to_import not in self.plugins:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	387 log.debug(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	388 "Recursively import dependency of [%s]: [%s]"
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	389 % (import_name, to_import)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	390 )
1145 4e1a0a1523f1 core: more robust plugins importation Goffi <goffi@goffi.org> parents: 1130 diff changeset	391 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	392 self._import_plugins_from_dict(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	393 plugins_to_import, to_import, to_import not in dependencies
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	394 )
1145 4e1a0a1523f1 core: more robust plugins importation Goffi <goffi@goffi.org> parents: 1130 diff changeset	395 except ImportError as e:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	396 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	397 _("Can't import plugin {name}: {error}").format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	398 name=plugin_info["name"], error=e
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	399 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	400 )
1535 c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	401 if optional:
c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	402 return
c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	403 raise e
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	404 log.info("importing plugin: {}".format(plugin_info["name"]))
1535 c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	405 # we instanciate the plugin here
c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	406 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	407 self.plugins[import_name] = getattr(mod, plugin_info["main"])(self)
1535 c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	408 except Exception as e:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	409 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	410 'Error while loading plugin "{name}", ignoring it: {error}'.format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	411 name=plugin_info["name"], error=e
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	412 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	413 )
1535 c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	414 if optional:
c9ef16de3f13 core: more robust plugins loading: Goffi <goffi@goffi.org> parents: 1533 diff changeset	415 return
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	416 raise ImportError("Error during initiation")
2525 e8e1507049b7 core: use C.bool to detect value of "handler" field in PLUGIN_INFO Goffi <goffi@goffi.org> parents: 2509 diff changeset	417 if C.bool(plugin_info.get(C.PI_HANDLER, C.BOOL_FALSE)):
287 2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	418 self.plugins[import_name].is_handler = True
2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	419 else:
2720536b5a22 core: added plugin dependency management Goffi <goffi@goffi.org> parents: 282 diff changeset	420 self.plugins[import_name].is_handler = False
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	421 # we keep metadata as a Class attribute
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	422 self.plugins[import_name]._info = plugin_info
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	423 # TODO: test xmppclient presence and register handler parent
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	424
1550 465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	425 def pluginsUnload(self):
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	426 """Call unload method on every loaded plugin, if exists
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	427
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	428 @return (D): A deferred which return None when all method have been called
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	429 """
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	430 # TODO: in the futur, it should be possible to hot unload a plugin
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	431 # pluging depending on the unloaded one should be unloaded too
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	432 # for now, just a basic call on plugin.unload is done
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	433 defers_list = []
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	434 for plugin in self.plugins.values():
1550 465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	435 try:
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	436 unload = plugin.unload
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	437 except AttributeError:
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	438 continue
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	439 else:
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	440 defers_list.append(defer.maybeDeferred(unload))
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	441 return defers_list
465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	442
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	443 def _connect(self, profile_key, password="", options=None):
1591 0df9c6247474 core: profile session starting and connection are now separated. Moved profile session starting/authentication to memory module Goffi <goffi@goffi.org> parents: 1587 diff changeset	444 profile = self.memory.getProfileName(profile_key)
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	445 return defer.ensureDeferred(self.connect(profile, password, options))
1591 0df9c6247474 core: profile session starting and connection are now separated. Moved profile session starting/authentication to memory module Goffi <goffi@goffi.org> parents: 1587 diff changeset	446
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	447 async def connect(
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	448 self, profile, password="", options=None, max_retries=C.XMPP_MAX_RETRIES):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	449 """Connect a profile (i.e. connect client.component to XMPP server)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	450
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	451 Retrieve the individual parameters, authenticate the profile
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1027 diff changeset	452 and initiate the connection to the associated XMPP server.
1725 c1be6363bfab core, plugin misc_account: set XMPP connection max retries to 0 when checking if an external account exists souliane <souliane@mailoo.org> parents: 1694 diff changeset	453 @param profile: %(doc_profile)s
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1027 diff changeset	454 @param password (string): the SàT profile password
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	455 @param options (dict): connection options. Key can be:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	456 -
1725 c1be6363bfab core, plugin misc_account: set XMPP connection max retries to 0 when checking if an external account exists souliane <souliane@mailoo.org> parents: 1694 diff changeset	457 @param max_retries (int): max number of connection retries
1591 0df9c6247474 core: profile session starting and connection are now separated. Moved profile session starting/authentication to memory module Goffi <goffi@goffi.org> parents: 1587 diff changeset	458 @return (D(bool)):
0df9c6247474 core: profile session starting and connection are now separated. Moved profile session starting/authentication to memory module Goffi <goffi@goffi.org> parents: 1587 diff changeset	459 - True if the XMPP connection was already established
0df9c6247474 core: profile session starting and connection are now separated. Moved profile session starting/authentication to memory module Goffi <goffi@goffi.org> parents: 1587 diff changeset	460 - False if the XMPP connection has been initiated (it may still fail)
0df9c6247474 core: profile session starting and connection are now separated. Moved profile session starting/authentication to memory module Goffi <goffi@goffi.org> parents: 1587 diff changeset	461 @raise exceptions.PasswordError: Profile password is wrong
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	462 """
2142 be96beb7ca14 core, bridge, frontends: renamed asyncConnect to connect, and added options parameters (not used yet) Goffi <goffi@goffi.org> parents: 2138 diff changeset	463 if options is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	464 options = {}
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	465
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	466 await self.memory.startSession(password, profile)
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	467
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	468 if self.isConnected(profile):
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	469 log.info(_("already connected !"))
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	470 return True
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	471
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	472 if self.memory.isComponent(profile):
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	473 await xmpp.SatXMPPComponent.startConnection(self, profile, max_retries)
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	474 else:
0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	475 await xmpp.SatXMPPClient.startConnection(self, profile, max_retries)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	476
3120 0c29155ac68b core: backend autoconnection: Goffi <goffi@goffi.org> parents: 3117 diff changeset	477 return False
1019 6a16ec17a458 better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1015 diff changeset	478
346 ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	479 def disconnect(self, profile_key):
16 0a024d5e0cd0 New account creation (in-band registration) Goffi <goffi@goffi.org> parents: 15 diff changeset	480 """disconnect from jabber server"""
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	481 # FIXME: client should not be deleted if only disconnected
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	482 # it shoud be deleted only when session is finished
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	483 if not self.isConnected(profile_key):
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	484 # isConnected is checked here and not on client
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	485 # because client is deleted when session is ended
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	486 log.info(_("not connected !"))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	487 return defer.succeed(None)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	488 client = self.getClient(profile_key)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	489 return client.entityDisconnect()
6 5799493fa548 connection and disconnection management Goffi <goffi@goffi.org> parents: 5 diff changeset	490
1482 80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	491 def getFeatures(self, profile_key=C.PROF_KEY_NONE):
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	492 """Get available features
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	493
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	494 Return list of activated plugins and plugin specific data
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	495 @param profile_key: %(doc_profile_key)s
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	496 C.PROF_KEY_NONE can be used to have general plugins data (i.e. not profile
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	497 dependent)
1482 80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	498 @return (dict)[Deferred]: features data where:
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	499 - key is plugin import name, present only for activated plugins
1650 b08b828a87c9 quick frontend (blog): fixed group blog panels (displaying only, sending is not working yet) Goffi <goffi@goffi.org> parents: 1644 diff changeset	500 - value is a an other dict, when meaning is specific to each plugin.
1482 80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	501 this dict is return by plugin's getFeature method.
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	502 If this method doesn't exists, an empty dict is returned.
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	503 """
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	504 try:
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	505 # FIXME: there is no method yet to check profile session
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	506 # as soon as one is implemented, it should be used here
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	507 self.getClient(profile_key)
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	508 except KeyError:
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	509 log.warning("Requesting features for a profile outside a session")
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	510 profile_key = C.PROF_KEY_NONE
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	511 except exceptions.ProfileNotSetError:
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	512 pass
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	513
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	514 features = []
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	515 for import_name, plugin in self.plugins.items():
1482 80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	516 try:
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	517 features_d = defer.maybeDeferred(plugin.getFeatures, profile_key)
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	518 except AttributeError:
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	519 features_d = defer.succeed({})
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	520 features.append(features_d)
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	521
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	522 d_list = defer.DeferredList(features)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	523
1482 80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	524 def buildFeatures(result, import_names):
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	525 assert len(result) == len(import_names)
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	526 ret = {}
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	527 for name, (success, data) in zip(import_names, result):
1482 80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	528 if success:
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	529 ret[name] = data
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	530 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	531 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	532 "Error while getting features for {name}: {failure}".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	533 name=name, failure=data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	534 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	535 )
1482 80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	536 ret[name] = {}
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	537 return ret
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	538
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	539 d_list.addCallback(buildFeatures, list(self.plugins.keys()))
1482 80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	540 return d_list
80cd55dd5b04 core, bridge: added getFeatures method: Goffi <goffi@goffi.org> parents: 1470 diff changeset	541
466 448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 460 diff changeset	542 def getContacts(self, profile_key):
448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 460 diff changeset	543 client = self.getClient(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	544
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2733 diff changeset	545 def got_roster(__):
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	546 ret = []
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	547 for item in client.roster.getItems(): # we get all items for client's roster
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	548 # and convert them to expected format
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	549 attr = client.roster.getAttributes(item)
2977 06f30ad8e110 core: return full jid in bridge's getContacts: Goffi <goffi@goffi.org> parents: 2914 diff changeset	550 # we use full() and not userhost() because jid with resources are allowed
06f30ad8e110 core: return full jid in bridge's getContacts: Goffi <goffi@goffi.org> parents: 2914 diff changeset	551 # in roster, even if it's not common.
06f30ad8e110 core: return full jid in bridge's getContacts: Goffi <goffi@goffi.org> parents: 2914 diff changeset	552 ret.append([item.entity.full(), attr, item.groups])
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	553 return ret
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	554
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	555 return client.roster.got_roster.addCallback(got_roster)
466 448ce3c9e2ac core: Roster cache refactoring: cache is now managed by client's SatRosterProtocol instance. Goffi <goffi@goffi.org> parents: 460 diff changeset	556
501 e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1: Goffi <goffi@goffi.org> parents: 489 diff changeset	557 def getContactsFromGroup(self, group, profile_key):
e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1: Goffi <goffi@goffi.org> parents: 489 diff changeset	558 client = self.getClient(profile_key)
941 c6d8fc63b1db core, plugins: host.getClient now raise an exception instead of returning None when no profile is found, plugins have been adapted consequently and a bit cleaned Goffi <goffi@goffi.org> parents: 930 diff changeset	559 return [jid_.full() for jid_ in client.roster.getJidsFromGroup(group)]
501 e9634d2e7b38 core, quick_frontend, primitivus, wix: Contacts List refactoring phase 1: Goffi <goffi@goffi.org> parents: 489 diff changeset	560
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	561 def purgeEntity(self, profile):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	562 """Remove reference to a profile client/component and purge cache
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	563
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	564 the garbage collector can then free the memory
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	565 """
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	566 try:
32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	567 del self.profiles[profile]
32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	568 except KeyError:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 991 diff changeset	569 log.error(_("Trying to remove reference to a client not referenced"))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	570 else:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	571 self.memory.purgeProfileSession(profile)
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	572
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	573 def startService(self):
3110 3fcc99b2d6b7 core (sat_main): avoid double init + log version Goffi <goffi@goffi.org> parents: 3102 diff changeset	574 self._init()
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	575 log.info("Salut à toi ô mon frère !")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	576
13 bd9e9997d540 wokkel integration (not finished yet) Goffi <goffi@goffi.org> parents: 12 diff changeset	577 def stopService(self):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	578 log.info("Salut aussi à Rantanplan")
1550 465d4d484e7c core: plugin unload: Goffi <goffi@goffi.org> parents: 1535 diff changeset	579 return self.pluginsUnload()
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	580
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	581 def run(self):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 991 diff changeset	582 log.debug(_("running app"))
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	583 reactor.run()
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	584
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	585 def stop(self):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 991 diff changeset	586 log.debug(_("stopping app"))
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	587 reactor.stop()
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	588
37 a61beb21d16d Gateway registration, unregistration & edition Goffi <goffi@goffi.org> parents: 36 diff changeset	589 ## Misc methods ##
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	590
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	591 def getJidNStream(self, profile_key):
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	592 """Convenient method to get jid and stream from profile key
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	593 @return: tuple (jid, xmlstream) from profile, can be None"""
1573 6338677f3a89 core (client): added a sendError method to easily build error response from <IQ\> stanza Goffi <goffi@goffi.org> parents: 1550 diff changeset	594 # TODO: deprecate this method (getClient is enough)
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	595 profile = self.memory.getProfileName(profile_key)
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	596 if not profile or not self.profiles[profile].isConnected():
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	597 return (None, None)
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	598 return (self.profiles[profile].jid, self.profiles[profile].xmlstream)
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	599
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	600 def getClient(self, profile_key):
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	601 """Convenient method to get client from profile key
1624 7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	602
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	603 @return: client or None if it doesn't exist
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	604 @raise exceptions.ProfileKeyUnknown: the profile or profile key doesn't exist
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	605 @raise exceptions.NotFound: client is not available
2176 61128d260eef plugin account: removed dependency to Prosody/prosodyctl and properly use in-band registration instead Goffi <goffi@goffi.org> parents: 2168 diff changeset	606 This happen if profile has not been used yet
1624 7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	607 """
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	608 profile = self.memory.getProfileName(profile_key)
d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	609 if not profile:
1624 7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	610 raise exceptions.ProfileKeyUnknown
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	611 try:
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	612 return self.profiles[profile]
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	613 except KeyError:
2445 0199c0bd4c60 core: specify profile on NotFound exception Goffi <goffi@goffi.org> parents: 2443 diff changeset	614 raise exceptions.NotFound(profile_key)
64 d46f849664aa SàT: multi-profile, plugins updated Goffi <goffi@goffi.org> parents: 63 diff changeset	615
728 e07afabc4a25 plugin XEP-0050: Ad-Hoc commands first draft (answering part) Goffi <goffi@goffi.org> parents: 727 diff changeset	616 def getClients(self, profile_key):
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	617 """Convenient method to get list of clients from profile key
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	618
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	619 Manage list through profile_key like C.PROF_KEY_ALL
728 e07afabc4a25 plugin XEP-0050: Ad-Hoc commands first draft (answering part) Goffi <goffi@goffi.org> parents: 727 diff changeset	620 @param profile_key: %(doc_profile_key)s
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	621 @return: list of clients
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	622 """
2251 83bcd9ec4782 core: fixed profile key detection in getClients + raise DataError on empty profile Goffi <goffi@goffi.org> parents: 2176 diff changeset	623 if not profile_key:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	624 raise exceptions.DataError(_("profile_key must not be empty"))
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	625 try:
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	626 profile = self.memory.getProfileName(profile_key, True)
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	627 except exceptions.ProfileUnknownError:
728 e07afabc4a25 plugin XEP-0050: Ad-Hoc commands first draft (answering part) Goffi <goffi@goffi.org> parents: 727 diff changeset	628 return []
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	629 if profile == C.PROF_KEY_ALL:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	630 return list(self.profiles.values())
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	631 elif profile[0] == "@": # only profile keys can start with "@"
1624 7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	632 raise exceptions.ProfileKeyUnknown
728 e07afabc4a25 plugin XEP-0050: Ad-Hoc commands first draft (answering part) Goffi <goffi@goffi.org> parents: 727 diff changeset	633 return [self.profiles[profile]]
e07afabc4a25 plugin XEP-0050: Ad-Hoc commands first draft (answering part) Goffi <goffi@goffi.org> parents: 727 diff changeset	634
1234 9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1189 diff changeset	635 def _getConfig(self, section, name):
9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1189 diff changeset	636 """Get the main configuration option
9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1189 diff changeset	637
9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1189 diff changeset	638 @param section: section of the config file (None or '' for DEFAULT)
9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1189 diff changeset	639 @param name: name of the option
9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1189 diff changeset	640 @return: unicode representation of the option
9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1189 diff changeset	641 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	642 return str(self.memory.getConfig(section, name, ""))
1234 9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1189 diff changeset	643
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	644 def logErrback(self, failure_, msg=_("Unexpected error: {failure_}")):
2990 6959c71ab8bf plugin XEP-0045: log "failure" on configure error Goffi <goffi@goffi.org> parents: 2977 diff changeset	645 """Generic errback logging
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	646
2990 6959c71ab8bf plugin XEP-0045: log "failure" on configure error Goffi <goffi@goffi.org> parents: 2977 diff changeset	647 @param msg(unicode): error message ("failure_" key will be use for format)
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	648 can be used as last errback to show unexpected error
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	649 """
2990 6959c71ab8bf plugin XEP-0045: log "failure" on configure error Goffi <goffi@goffi.org> parents: 2977 diff changeset	650 log.error(msg.format(failure_=failure_))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	651 return failure_
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2142 diff changeset	652
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	653 # namespaces
2496 769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	654
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	655 def registerNamespace(self, short_name, namespace):
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	656 """associate a namespace to a short name"""
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	657 if short_name in self.ns_map:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	658 raise exceptions.ConflictError("this short name is already used")
3117 385fdd684f87 core: added a debug log when a namespace is registered Goffi <goffi@goffi.org> parents: 3110 diff changeset	659 log.debug(f"registering namespace {short_name} => {namespace}")
2496 769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	660 self.ns_map[short_name] = namespace
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	661
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	662 def getNamespaces(self):
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	663 return self.ns_map
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	664
2914 25f14fbd364e core: added getNamespace method to retrieve a namespace from short name. Goffi <goffi@goffi.org> parents: 2892 diff changeset	665 def getNamespace(self, short_name):
25f14fbd364e core: added getNamespace method to retrieve a namespace from short name. Goffi <goffi@goffi.org> parents: 2892 diff changeset	666 try:
25f14fbd364e core: added getNamespace method to retrieve a namespace from short name. Goffi <goffi@goffi.org> parents: 2892 diff changeset	667 return self.ns_map[short_name]
25f14fbd364e core: added getNamespace method to retrieve a namespace from short name. Goffi <goffi@goffi.org> parents: 2892 diff changeset	668 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	669 raise exceptions.NotFound("namespace {short_name} is not registered"
2914 25f14fbd364e core: added getNamespace method to retrieve a namespace from short name. Goffi <goffi@goffi.org> parents: 2892 diff changeset	670 .format(short_name=short_name))
25f14fbd364e core: added getNamespace method to retrieve a namespace from short name. Goffi <goffi@goffi.org> parents: 2892 diff changeset	671
2496 769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	672 def getSessionInfos(self, profile_key):
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	673 """compile interesting data on current profile session"""
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	674 client = self.getClient(profile_key)
2689 d715d912afac plugin XEP-0199: implementation of XMPP Ping Goffi <goffi@goffi.org> parents: 2688 diff changeset	675 data = {
d715d912afac plugin XEP-0199: implementation of XMPP Ping Goffi <goffi@goffi.org> parents: 2688 diff changeset	676 "jid": client.jid.full(),
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	677 "started": str(int(client.started))
2689 d715d912afac plugin XEP-0199: implementation of XMPP Ping Goffi <goffi@goffi.org> parents: 2688 diff changeset	678 }
2496 769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	679 return defer.succeed(data)
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	680
3206 ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	681 def _getDevicesInfos(self, bare_jid, profile_key):
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	682 client = self.getClient(profile_key)
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	683 if not bare_jid:
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	684 bare_jid = None
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	685 d = defer.ensureDeferred(self.getDevicesInfos(client, bare_jid))
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	686 d.addCallback(lambda data: data_format.serialise(data))
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	687 return d
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	688
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	689 async def getDevicesInfos(self, client, bare_jid=None):
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	690 """compile data on an entity devices
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	691
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	692 @param bare_jid(jid.JID, None): bare jid of entity to check
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	693 None to use client own jid
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	694 @return (list[dict]): list of data, one item per resource.
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	695 Following keys can be set:
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	696 - resource(str): resource name
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	697 """
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	698 own_jid = client.jid.userhostJID()
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	699 if bare_jid is None:
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	700 bare_jid = own_jid
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	701 else:
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	702 bare_jid = jid.JID(bare_jid)
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	703 resources = self.memory.getAllResources(client, bare_jid)
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	704 if bare_jid == own_jid:
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	705 # our own jid is not stored in memory's cache
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	706 resources.add(client.jid.resource)
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	707 ret_data = []
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	708 for resource in resources:
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	709 res_jid = copy.copy(bare_jid)
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	710 res_jid.resource = resource
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	711 cache_data = self.memory.getEntityData(res_jid, profile_key=client.profile)
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	712 res_data = {
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	713 "resource": resource,
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	714 }
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	715 try:
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	716 presence = cache_data['presence']
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	717 except KeyError:
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	718 pass
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	719 else:
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	720 res_data['presence'] = {
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	721 "show": presence.show,
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	722 "priority": presence.priority,
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	723 "statuses": presence.statuses,
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	724 }
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	725
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	726 disco = await self.getDiscoInfos(client, res_jid)
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	727
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	728 for (category, type_), name in disco.identities.items():
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	729 identities = res_data.setdefault('identities', [])
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	730 identities.append({
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	731 "name": name,
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	732 "category": category,
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	733 "type": type_,
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	734 })
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	735
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	736 ret_data.append(res_data)
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	737
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	738 return ret_data
ae09989e9feb core, bridge: new `devicesInfosGet` method to get infos on known devices of an entity Goffi <goffi@goffi.org> parents: 3201 diff changeset	739
3066 2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	740 # images
2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	741
2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	742 def _imageCheck(self, path):
3220 4fbea7f1e012 tools (images): methods renaming Goffi <goffi@goffi.org> parents: 3206 diff changeset	743 report = image.check(self, path)
3066 2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	744 return data_format.serialise(report)
2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	745
2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	746 def _imageResize(self, path, width, height):
3220 4fbea7f1e012 tools (images): methods renaming Goffi <goffi@goffi.org> parents: 3206 diff changeset	747 d = image.resize(path, (width, height))
3066 2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	748 d.addCallback(lambda new_image_path: str(new_image_path))
2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	749 return d
2cc2f65379f7 core: added imageCheck and imageResize methods: Goffi <goffi@goffi.org> parents: 3040 diff changeset	750
3201 439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	751 def _imageGeneratePreview(self, path, profile_key):
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	752 client = self.getClient(profile_key)
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	753 d = defer.ensureDeferred(self.imageGeneratePreview(client, Path(path)))
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	754 d.addCallback(lambda preview_path: str(preview_path))
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	755 return d
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	756
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	757 async def imageGeneratePreview(self, client, path):
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	758 """Helper method to generate in cache a preview of an image
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	759
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	760 @param path(Path): path to the image
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	761 @return (Path): path to the generated preview
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	762 """
3220 4fbea7f1e012 tools (images): methods renaming Goffi <goffi@goffi.org> parents: 3206 diff changeset	763 report = image.check(self, path, max_size=(300, 300))
3201 439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	764
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	765 if not report['too_large']:
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	766 # in the unlikely case that image is already smaller than a preview
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	767 preview_path = path
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	768 else:
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	769 # we use hash as id, to re-use potentially existing preview
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	770 path_hash = hashlib.sha256(str(path).encode()).hexdigest()
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	771 uid = f"{path.stem}_{path_hash}_preview"
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	772 filename = f"{uid}{path.suffix.lower()}"
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	773 metadata = client.cache.getMetadata(uid=uid)
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	774 if metadata is not None:
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	775 preview_path = metadata['path']
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	776 else:
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	777 with client.cache.cacheData(
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	778 source='HOST_PREVIEW',
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	779 uid=uid,
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	780 filename=filename) as cache_f:
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	781
3220 4fbea7f1e012 tools (images): methods renaming Goffi <goffi@goffi.org> parents: 3206 diff changeset	782 preview_path = await image.resize(
3201 439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	783 path,
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	784 new_size=report['recommended_size'],
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	785 dest=cache_f
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	786 )
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	787
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	788 return preview_path
439e2f88c3a9 core, bridge: new `imageGeneratePreview` helped method to generate a thumbnail Goffi <goffi@goffi.org> parents: 3179 diff changeset	789
2496 769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	790 # local dirs
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	791
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	792 def getLocalPath(self, client, dir_name, extra_path, *kwargs):
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	793 """retrieve path for local data
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	794
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	795 if path doesn't exist, it will be created
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	796 @param client(SatXMPPClient, None): client instance
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	797 used when profile is set, can be None if profile is False
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	798 @param dir_name(unicode): name of the main path directory
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	799 @param component(bool): if True, path will be prefixed with C.COMPONENTS_DIR
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	800 @param profile(bool): if True, path will be suffixed by profile name
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	801 @param *extra_path: extra path element(s) to use
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	802 @return (unicode): path
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	803 """
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	804 # FIXME: component and profile are parsed with **kwargs because of python 2
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	805 # limitations. Once moved to python 3, this can be fixed
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	806 component = kwargs.pop("component", False)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	807 profile = kwargs.pop("profile", True)
2496 769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	808 assert not kwargs
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	809
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	810 path_elts = [self.memory.getConfig("", "local_dir")]
2496 769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	811 if component:
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	812 path_elts.append(C.COMPONENTS_DIR)
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	813 path_elts.append(regex.pathEscape(dir_name))
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	814 if extra_path:
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	815 path_elts.extend([regex.pathEscape(p) for p in extra_path])
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	816 if profile:
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	817 regex.pathEscape(client.profile)
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	818 path = os.path.join(*path_elts)
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	819 if not os.path.exists(path):
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	820 os.makedirs(path)
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	821 return path
769e8d9d2438 core: new getLocalPath method to retrieve a path in SàT local dir, which may be specific to a profile or component Goffi <goffi@goffi.org> parents: 2483 diff changeset	822
16 0a024d5e0cd0 New account creation (in-band registration) Goffi <goffi@goffi.org> parents: 15 diff changeset	823 ## Client management ##
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	824
641 49587e170f53 core: added the security_limit to setParam souliane <souliane@mailoo.org> parents: 636 diff changeset	825 def setParam(self, name, value, category, security_limit, profile_key):
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	826 """set wanted paramater and notice observers"""
641 49587e170f53 core: added the security_limit to setParam souliane <souliane@mailoo.org> parents: 636 diff changeset	827 self.memory.setParam(name, value, category, security_limit, profile_key)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	828
346 ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	829 def isConnected(self, profile_key):
62 93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	830 """Return connection status of profile
3125 c3ce8c997fdf plugin android: reconnect profiles with autoconnect if network is activated: Goffi <goffi@goffi.org> parents: 3123 diff changeset	831
62 93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	832 @param profile_key: key_word or profile name to determine profile name
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1027 diff changeset	833 @return: True if connected
62 93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	834 """
93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	835 profile = self.memory.getProfileName(profile_key)
93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	836 if not profile:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	837 log.error(_("asking connection status for a non-existant profile"))
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1027 diff changeset	838 raise exceptions.ProfileUnknownError(profile_key)
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	839 if profile not in self.profiles:
62 93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	840 return False
93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 60 diff changeset	841 return self.profiles[profile].isConnected()
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	842
2646 712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature: Goffi <goffi@goffi.org> parents: 2645 diff changeset	843 ## Encryption ##
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature: Goffi <goffi@goffi.org> parents: 2645 diff changeset	844
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature: Goffi <goffi@goffi.org> parents: 2645 diff changeset	845 def registerEncryptionPlugin(self, args, *kwargs):
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature: Goffi <goffi@goffi.org> parents: 2645 diff changeset	846 return encryption.EncryptionHandler.registerPlugin(args, *kwargs)
712cb4ff3e13 core: new EncryptionHandler class which manage encrypted session as a core feature: Goffi <goffi@goffi.org> parents: 2645 diff changeset	847
2733 e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	848 def _messageEncryptionStart(self, to_jid_s, namespace, replace=False,
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	849 profile_key=C.PROF_KEY_NONE):
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	850 client = self.getClient(profile_key)
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	851 to_jid = jid.JID(to_jid_s)
3226 2f406b762788 core (memory/encryption): encryption session are now restored on client connection Goffi <goffi@goffi.org> parents: 3220 diff changeset	852 return defer.ensureDeferred(
2f406b762788 core (memory/encryption): encryption session are now restored on client connection Goffi <goffi@goffi.org> parents: 3220 diff changeset	853 client.encryption.start(to_jid, namespace or None, replace))
2733 e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	854
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	855 def _messageEncryptionStop(self, to_jid_s, profile_key=C.PROF_KEY_NONE):
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	856 client = self.getClient(profile_key)
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	857 to_jid = jid.JID(to_jid_s)
3226 2f406b762788 core (memory/encryption): encryption session are now restored on client connection Goffi <goffi@goffi.org> parents: 3220 diff changeset	858 return defer.ensureDeferred(
2f406b762788 core (memory/encryption): encryption session are now restored on client connection Goffi <goffi@goffi.org> parents: 3220 diff changeset	859 client.encryption.stop(to_jid))
2733 e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	860
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	861 def _messageEncryptionGet(self, to_jid_s, profile_key=C.PROF_KEY_NONE):
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	862 client = self.getClient(profile_key)
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	863 to_jid = jid.JID(to_jid_s)
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	864 session_data = client.encryption.getSession(to_jid)
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	865 return client.encryption.getBridgeData(session_data)
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	866
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	867 def _encryptionNamespaceGet(self, name):
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	868 return encryption.EncryptionHandler.getNSFromName(name)
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	869
2658 4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	870 def _encryptionPluginsGet(self):
4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	871 plugins = encryption.EncryptionHandler.getPlugins()
4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	872 ret = []
4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	873 for p in plugins:
4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	874 ret.append({
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	875 "name": p.name,
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	876 "namespace": p.namespace,
3102 7574f795bd1e core, bridge: encryptionPluginsGet now returns a serialised list + added "directed" in metadata Goffi <goffi@goffi.org> parents: 3088 diff changeset	877 "priority": p.priority,
7574f795bd1e core, bridge: encryptionPluginsGet now returns a serialised list + added "directed" in metadata Goffi <goffi@goffi.org> parents: 3088 diff changeset	878 "directed": p.directed,
2658 4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	879 })
3102 7574f795bd1e core, bridge: encryptionPluginsGet now returns a serialised list + added "directed" in metadata Goffi <goffi@goffi.org> parents: 3088 diff changeset	880 return data_format.serialise(ret)
2658 4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	881
2733 e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	882 def _encryptionTrustUIGet(self, to_jid_s, namespace, profile_key):
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	883 client = self.getClient(profile_key)
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	884 to_jid = jid.JID(to_jid_s)
3237 b0c57c9a4bd8 plugin XEP-0384: OMEMO trust policy: Goffi <goffi@goffi.org> parents: 3226 diff changeset	885 d = defer.ensureDeferred(
b0c57c9a4bd8 plugin XEP-0384: OMEMO trust policy: Goffi <goffi@goffi.org> parents: 3226 diff changeset	886 client.encryption.getTrustUI(to_jid, namespace=namespace or None))
2733 e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	887 d.addCallback(lambda xmlui: xmlui.toXml())
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	888 return d
e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	889
1052 e88bff4c8b77 core (XMPP): sendMessage refactoring: Goffi <goffi@goffi.org> parents: 1043 diff changeset	890 ## XMPP methods ##
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	891
3179 84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3163 diff changeset	892 def _messageSend(
84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3163 diff changeset	893 self, to_jid_s, message, subject=None, mess_type="auto", extra_s="",
84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3163 diff changeset	894 profile_key=C.PROF_KEY_NONE):
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	895 client = self.getClient(profile_key)
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	896 to_jid = jid.JID(to_jid_s)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	897 return client.sendMessage(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	898 to_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	899 message,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	900 subject,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	901 mess_type,
3179 84a94b385760 bridge: messageSend's extra is now serialised Goffi <goffi@goffi.org> parents: 3163 diff changeset	902 data_format.deserialise(extra_s)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	903 )
16 0a024d5e0cd0 New account creation (in-band registration) Goffi <goffi@goffi.org> parents: 15 diff changeset	904
917 a9401694d2dc bridge, frontends: display presence with the highest priority + reset your own presence when you (dis)connect souliane <souliane@mailoo.org> parents: 916 diff changeset	905 def _setPresence(self, to="", show="", statuses=None, profile_key=C.PROF_KEY_NONE):
a9401694d2dc bridge, frontends: display presence with the highest priority + reset your own presence when you (dis)connect souliane <souliane@mailoo.org> parents: 916 diff changeset	906 return self.setPresence(jid.JID(to) if to else None, show, statuses, profile_key)
807 be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	907
2658 4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	908 def setPresence(self, to_jid=None, show="", statuses=None,
4e130cc9bfc0 core (memore/encryption): new methods and checks: Goffi <goffi@goffi.org> parents: 2646 diff changeset	909 profile_key=C.PROF_KEY_NONE):
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	910 """Send our presence information"""
727 c1cd6c0c2c38 core: fixed statuses parameter in setPresence, and using @NONE@ instead of @DEFAULT@ for default profile_key Goffi <goffi@goffi.org> parents: 700 diff changeset	911 if statuses is None:
c1cd6c0c2c38 core: fixed statuses parameter in setPresence, and using @NONE@ instead of @DEFAULT@ for default profile_key Goffi <goffi@goffi.org> parents: 700 diff changeset	912 statuses = {}
63 0db25931b60d SàT: multi-profiles: somes fixes in core Goffi <goffi@goffi.org> parents: 62 diff changeset	913 profile = self.memory.getProfileName(profile_key)
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	914 assert profile
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	915 priority = int(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	916 self.memory.getParamA("Priority", "Connection", profile_key=profile)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	917 )
63 0db25931b60d SàT: multi-profiles: somes fixes in core Goffi <goffi@goffi.org> parents: 62 diff changeset	918 self.profiles[profile].presence.available(to_jid, show, statuses, priority)
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	919 # XXX: FIXME: temporary fix to work around openfire 3.7.0 bug (presence is not
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	920 # broadcasted to generating resource)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	921 if "" in statuses:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	922 statuses[C.PRESENCE_STATUSES_DEFAULT] = statuses.pop("")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	923 self.bridge.presenceUpdate(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	924 self.profiles[profile].jid.full(), show, int(priority), statuses, profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	925 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	926
346 ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	927 def subscription(self, subs_type, raw_jid, profile_key):
187 12544ea2951f Core: removed addItem for roster list, according to http://wokkel.ik.nu/ticket/56 Goffi <goffi@goffi.org> parents: 155 diff changeset	928 """Called to manage subscription
12544ea2951f Core: removed addItem for roster list, according to http://wokkel.ik.nu/ticket/56 Goffi <goffi@goffi.org> parents: 155 diff changeset	929 @param subs_type: subsciption type (cf RFC 3921)
12544ea2951f Core: removed addItem for roster list, according to http://wokkel.ik.nu/ticket/56 Goffi <goffi@goffi.org> parents: 155 diff changeset	930 @param raw_jid: unicode entity's jid
12544ea2951f Core: removed addItem for roster list, according to http://wokkel.ik.nu/ticket/56 Goffi <goffi@goffi.org> parents: 155 diff changeset	931 @param profile_key: profile"""
63 0db25931b60d SàT: multi-profiles: somes fixes in core Goffi <goffi@goffi.org> parents: 62 diff changeset	932 profile = self.memory.getProfileName(profile_key)
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	933 assert profile
50 daa1f01a5332 SàT improvement: Goffi <goffi@goffi.org> parents: 41 diff changeset	934 to_jid = jid.JID(raw_jid)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	935 log.debug(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	936 _("subsciption request [%(subs_type)s] for %(jid)s")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	937 % {"subs_type": subs_type, "jid": to_jid.full()}
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	938 )
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	939 if subs_type == "subscribe":
63 0db25931b60d SàT: multi-profiles: somes fixes in core Goffi <goffi@goffi.org> parents: 62 diff changeset	940 self.profiles[profile].presence.subscribe(to_jid)
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	941 elif subs_type == "subscribed":
89 23caf1051099 multi-profile/subscription misc fixes Goffi <goffi@goffi.org> parents: 79 diff changeset	942 self.profiles[profile].presence.subscribed(to_jid)
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	943 elif subs_type == "unsubscribe":
63 0db25931b60d SàT: multi-profiles: somes fixes in core Goffi <goffi@goffi.org> parents: 62 diff changeset	944 self.profiles[profile].presence.unsubscribe(to_jid)
589 d1b4805124a1 Fix pep8 support in src/core. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	945 elif subs_type == "unsubscribed":
63 0db25931b60d SàT: multi-profiles: somes fixes in core Goffi <goffi@goffi.org> parents: 62 diff changeset	946 self.profiles[profile].presence.unsubscribed(to_jid)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	947
807 be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	948 def _addContact(self, to_jid_s, profile_key):
846 59d486726577 core: fix mispelled argument souliane <souliane@mailoo.org> parents: 834 diff changeset	949 return self.addContact(jid.JID(to_jid_s), profile_key)
807 be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	950
be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	951 def addContact(self, to_jid, profile_key):
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	952 """Add a contact in roster list"""
63 0db25931b60d SàT: multi-profiles: somes fixes in core Goffi <goffi@goffi.org> parents: 62 diff changeset	953 profile = self.memory.getProfileName(profile_key)
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	954 assert profile
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	955 # presence is sufficient, as a roster push will be sent according to
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	956 # RFC 6121 §3.1.2
63 0db25931b60d SàT: multi-profiles: somes fixes in core Goffi <goffi@goffi.org> parents: 62 diff changeset	957 self.profiles[profile].presence.subscribe(to_jid)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	958
807 be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	959 def _updateContact(self, to_jid_s, name, groups, profile_key):
be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	960 return self.updateContact(jid.JID(to_jid_s), name, groups, profile_key)
be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	961
be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	962 def updateContact(self, to_jid, name, groups, profile_key):
346 ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	963 """update a contact in roster list"""
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	964 profile = self.memory.getProfileName(profile_key)
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	965 assert profile
346 ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	966 groups = set(groups)
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	967 roster_item = RosterItem(to_jid)
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	968 roster_item.name = name or None
ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	969 roster_item.groups = set(groups)
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	970 return self.profiles[profile].roster.setItem(roster_item)
346 ca3a041fed30 core: fixed several subscription scheme issues + removed most of profile_key default value in core.sat_main and core.xmmp (source of bugs) + contact update Goffi <goffi@goffi.org> parents: 341 diff changeset	971
807 be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	972 def _delContact(self, to_jid_s, profile_key):
be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	973 return self.delContact(jid.JID(to_jid_s), profile_key)
be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	974
be4c5e24dab9 plugin XEP-0077, plugin XEP-0100, frontends: gateways have been entirely implemented in backend using the new refactored XMLUI and AdvancedListContainer. The now useless code has been removed from frontends. Goffi <goffi@goffi.org> parents: 806 diff changeset	975 def delContact(self, to_jid, profile_key):
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	976 """Remove contact from roster list"""
63 0db25931b60d SàT: multi-profiles: somes fixes in core Goffi <goffi@goffi.org> parents: 62 diff changeset	977 profile = self.memory.getProfileName(profile_key)
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	978 assert profile
1355 33a21f06551d core: fixes bug introduced by 1262 (f8a8434dbac7) in SAT.delContact souliane <souliane@mailoo.org> parents: 1325 diff changeset	979 self.profiles[profile].presence.unsubscribe(to_jid) # is not asynchronous
33a21f06551d core: fixes bug introduced by 1262 (f8a8434dbac7) in SAT.delContact souliane <souliane@mailoo.org> parents: 1325 diff changeset	980 return self.profiles[profile].roster.removeItem(to_jid)
742 03744d9ebc13 plugin XEP-0033: implementation of the addressing feature: souliane <souliane@mailoo.org> parents: 728 diff changeset	981
2892 82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2886 diff changeset	982 def _rosterResync(self, profile_key):
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2886 diff changeset	983 client = self.getClient(profile_key)
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2886 diff changeset	984 return client.roster.resync()
82b781c46841 core: added a rosterResync method to bridge: Goffi <goffi@goffi.org> parents: 2886 diff changeset	985
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	986 ## Discovery ##
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	987 # discovery methods are shortcuts to self.memory.disco
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	988 # the main difference with client.disco is that self.memory.disco manage cache
742 03744d9ebc13 plugin XEP-0033: implementation of the addressing feature: souliane <souliane@mailoo.org> parents: 728 diff changeset	989
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	990 def hasFeature(self, args, *kwargs):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	991 return self.memory.disco.hasFeature(args, *kwargs)
742 03744d9ebc13 plugin XEP-0033: implementation of the addressing feature: souliane <souliane@mailoo.org> parents: 728 diff changeset	992
951 027a054c6dda core (disco): added checkFeature method + fixed hasFeature test Goffi <goffi@goffi.org> parents: 949 diff changeset	993 def checkFeature(self, args, *kwargs):
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test Goffi <goffi@goffi.org> parents: 949 diff changeset	994 return self.memory.disco.checkFeature(args, *kwargs)
027a054c6dda core (disco): added checkFeature method + fixed hasFeature test Goffi <goffi@goffi.org> parents: 949 diff changeset	995
1491 704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures Goffi <goffi@goffi.org> parents: 1482 diff changeset	996 def checkFeatures(self, args, *kwargs):
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures Goffi <goffi@goffi.org> parents: 1482 diff changeset	997 return self.memory.disco.checkFeatures(args, *kwargs)
704ca56f5ca9 core (disco): added checkFeatures to check several features at once + identities are now managed with a tuple in findFeaturesSet and checkFeatures Goffi <goffi@goffi.org> parents: 1482 diff changeset	998
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	999 def getDiscoInfos(self, args, *kwargs):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1000 return self.memory.disco.getInfos(args, *kwargs)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1001
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1002 def getDiscoItems(self, args, *kwargs):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1003 return self.memory.disco.getItems(args, *kwargs)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1004
2431 a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind Goffi <goffi@goffi.org> parents: 2414 diff changeset	1005 def findServiceEntity(self, args, *kwargs):
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind Goffi <goffi@goffi.org> parents: 2414 diff changeset	1006 return self.memory.disco.findServiceEntity(args, *kwargs)
a9fac72825a2 memory (disco): added findServiceEntity helper method to get first service of a kind Goffi <goffi@goffi.org> parents: 2414 diff changeset	1007
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1008 def findServiceEntities(self, args, *kwargs):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1009 return self.memory.disco.findServiceEntities(args, *kwargs)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	1010
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1011 def findFeaturesSet(self, args, *kwargs):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1012 return self.memory.disco.findFeaturesSet(args, *kwargs)
397 ccfd69d090c3 core: workaround to avoid a bug in item detection on jabber.fr. Need more investigation with jabber.fr admins (may be a bug in ejabberd) Goffi <goffi@goffi.org> parents: 391 diff changeset	1013
2666 bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1014 def _findByFeatures(self, namespaces, identities, bare_jids, service, roster, own_jid,
bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1015 local_device, profile_key):
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1016 client = self.getClient(profile_key)
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1017 return defer.ensureDeferred(self.findByFeatures(
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1018 client, namespaces, identities, bare_jids, service, roster, own_jid,
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1019 local_device))
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1020
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1021 async def findByFeatures(
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1022 self, client, namespaces, identities=None, bare_jids=False, service=True,
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1023 roster=True, own_jid=True, local_device=False):
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1024 """Retrieve all services or contacts managing a set a features
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1025
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1026 @param namespaces(list[unicode]): features which must be handled
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1027 @param identities(list[tuple[unicode,unicode]], None): if not None or empty,
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1028 only keep those identities tuple must by (category, type)
2536 27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1029 @param bare_jids(bool): retrieve only bare_jids if True
27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1030 if False, retrieve full jid of connected devices
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1031 @param service(bool): if True return service from our roster
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1032 @param roster(bool): if True, return entities in roster
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1033 full jid of all matching resources available will be returned
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1034 @param own_jid(bool): if True, return profile's jid resources
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1035 @param local_device(bool): if True, return profile's jid local resource
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1036 (i.e. client.jid)
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1037 @return (tuple(dict[jid.JID(), tuple[unicode, unicode, unicode]]*3)): found
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1038 entities in a tuple with:
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1039 - service entities
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1040 - own entities
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1041 - roster entities
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1042 """
2666 bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1043 assert isinstance(namespaces, list)
2536 27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1044 if not identities:
27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1045 identities = None
27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1046 if not namespaces and not identities:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1047 raise exceptions.DataError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1048 "at least one namespace or one identity must be set"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1049 )
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1050 found_service = {}
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1051 found_own = {}
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1052 found_roster = {}
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1053 if service:
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1054 services_jids = await self.findFeaturesSet(client, namespaces)
2791 034c88e9cd93 core (findByFeatures): fixed services discovery Goffi <goffi@goffi.org> parents: 2771 diff changeset	1055 services_jids = list(services_jids) # we need a list to map results below
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1056 services_infos = await defer.DeferredList(
2767 a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1057 [self.getDiscoInfos(client, service_jid) for service_jid in services_jids]
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1058 )
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1059
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1060 for idx, (success, infos) in enumerate(services_infos):
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1061 service_jid = services_jids[idx]
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1062 if not success:
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1063 log.warning(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1064 _("Can't find features for service {service_jid}, ignoring")
2767 a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1065 .format(service_jid=service_jid.full()))
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1066 continue
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1067 if (identities is not None
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1068 and not set(infos.identities.keys()).issuperset(identities)):
2536 27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1069 continue
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1070 found_identities = [
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1071 (cat, type_, name or "")
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1072 for (cat, type_), name in infos.identities.items()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1073 ]
2536 27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1074 found_service[service_jid.full()] = found_identities
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1075
2666 bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1076 to_find = []
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1077 if own_jid:
2666 bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1078 to_find.append((found_own, [client.jid.userhostJID()]))
bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1079 if roster:
bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1080 to_find.append((found_roster, client.roster.getJids()))
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1081
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1082 for found, jids in to_find:
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1083 full_jids = []
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1084 disco_defers = []
2767 a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1085
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1086 for jid_ in jids:
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1087 if jid_.resource:
2536 27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1088 if bare_jids:
27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1089 continue
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1090 resources = [jid_.resource]
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1091 else:
2536 27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1092 if bare_jids:
27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1093 resources = [None]
27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1094 else:
27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1095 try:
2597 9446f1ea9eac core: discoFindByFeatures now return only available resources Goffi <goffi@goffi.org> parents: 2595 diff changeset	1096 resources = self.memory.getAvailableResources(client, jid_)
2536 27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1097 except exceptions.UnknownEntityError:
27539029a662 core: added bare_jid and identities arguments to discoGetByFeatures: Goffi <goffi@goffi.org> parents: 2534 diff changeset	1098 continue
2666 bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1099 if not resources and jid_ == client.jid.userhostJID() and own_jid:
bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1100 # small hack to avoid missing our own resource when this
bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1101 # method is called at the very beginning of the session
bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1102 # and our presence has not been received yet
bc122b68eacd core: findByFeatures fixes Goffi <goffi@goffi.org> parents: 2658 diff changeset	1103 resources = [client.jid.resource]
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1104 for resource in resources:
7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1105 full_jid = jid.JID(tuple=(jid_.user, jid_.host, resource))
2595 973d4551ffae core: added local_device argument to discoFindByFeatures Goffi <goffi@goffi.org> parents: 2562 diff changeset	1106 if full_jid == client.jid and not local_device:
973d4551ffae core: added local_device argument to discoFindByFeatures Goffi <goffi@goffi.org> parents: 2562 diff changeset	1107 continue
2767 a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1108 full_jids.append(full_jid)
a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1109
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1110 disco_defers.append(self.getDiscoInfos(client, full_jid))
2767 a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1111
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1112 d_list = defer.DeferredList(disco_defers)
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1113 # XXX: 10 seconds may be too low for slow connections (e.g. mobiles)
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1114 # but for discovery, that's also the time the user will wait the first time
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1115 # before seing the page, if something goes wrong.
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1116 d_list.addTimeout(10, reactor)
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1117 infos_data = await d_list
2767 a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1118
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1119 for idx, (success, infos) in enumerate(infos_data):
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1120 full_jid = full_jids[idx]
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1121 if not success:
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1122 log.warning(
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1123 _("Can't retrieve {full_jid} infos, ignoring")
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1124 .format(full_jid=full_jid.full()))
2767 a97c43dc4924 core: findByFeatures speed improvments: Goffi <goffi@goffi.org> parents: 2765 diff changeset	1125 continue
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1126 if infos.features.issuperset(namespaces):
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1127 if identities is not None and not set(
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1128 infos.identities.keys()
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1129 ).issuperset(identities):
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1130 continue
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1131 found_identities = [
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1132 (cat, type_, name or "")
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1133 for (cat, type_), name in infos.identities.items()
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1134 ]
46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1135 found[full_jid.full()] = found_identities
2534 7da86e1633a5 core: new discoFindFeatures method which return all server services/roster entities implementing a set of features. Goffi <goffi@goffi.org> parents: 2525 diff changeset	1136
3140 46a6251713d3 core: fixed `findByFeatures`: Goffi <goffi@goffi.org> parents: 3136 diff changeset	1137 return (found_service, found_own, found_roster)
742 03744d9ebc13 plugin XEP-0033: implementation of the addressing feature: souliane <souliane@mailoo.org> parents: 728 diff changeset	1138
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	1139 ## Generic HMI ##
952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 579 diff changeset	1140
1622 5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1141 def _killAction(self, keep_id, client):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1142 log.debug("Killing action {} for timeout".format(keep_id))
1622 5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1143 client.actions[keep_id]
5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1144
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1145 def actionNew(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1146 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1147 action_data,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1148 security_limit=C.NO_SECURITY_LIMIT,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1149 keep_id=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1150 profile=C.PROF_KEY_NONE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1151 ):
1622 5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1152 """Shortcut to bridge.actionNew which generate and id and keep for retrieval
1467 ceba6fd77739 core, bridge: new signal actionNew to launch an action from the backend (e.g. display a dialog message): Goffi <goffi@goffi.org> parents: 1417 diff changeset	1153
ceba6fd77739 core, bridge: new signal actionNew to launch an action from the backend (e.g. display a dialog message): Goffi <goffi@goffi.org> parents: 1417 diff changeset	1154 @param action_data(dict): action data (see bridge documentation)
1599 e2ed8009e66e backend, bridge, frontends: actionNew has now a security_limit argument + added some docstring to explain data argument Goffi <goffi@goffi.org> parents: 1598 diff changeset	1155 @param security_limit: %(doc_security_limit)s
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1156 @param keep_id(None, unicode): if not None, used to keep action for differed
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1157 retrieval. Must be set to the callback_id.
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1158 Action will be deleted after 30 min.
1467 ceba6fd77739 core, bridge: new signal actionNew to launch an action from the backend (e.g. display a dialog message): Goffi <goffi@goffi.org> parents: 1417 diff changeset	1159 @param profile: %(doc_profile)s
ceba6fd77739 core, bridge: new signal actionNew to launch an action from the backend (e.g. display a dialog message): Goffi <goffi@goffi.org> parents: 1417 diff changeset	1160 """
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1161 id_ = str(uuid.uuid4())
1622 5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1162 if keep_id is not None:
5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1163 client = self.getClient(profile)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1164 action_timer = reactor.callLater(60 * 30, self._killAction, keep_id, client)
1622 5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1165 client.actions[keep_id] = (action_data, id_, security_limit, action_timer)
5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1166
1599 e2ed8009e66e backend, bridge, frontends: actionNew has now a security_limit argument + added some docstring to explain data argument Goffi <goffi@goffi.org> parents: 1598 diff changeset	1167 self.bridge.actionNew(action_data, id_, security_limit, profile)
1467 ceba6fd77739 core, bridge: new signal actionNew to launch an action from the backend (e.g. display a dialog message): Goffi <goffi@goffi.org> parents: 1417 diff changeset	1168
1622 5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1169 def actionsGet(self, profile):
5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1170 """Return current non answered actions
5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1171
5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1172 @param profile: %(doc_profile)s
5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1173 """
5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1174 client = self.getClient(profile)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1175 return [action_tuple[:-1] for action_tuple in client.actions.values()]
1622 5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1176
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1177 def registerProgressCb(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1178 self, progress_id, callback, metadata=None, profile=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1179 ):
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1180 """Register a callback called when progress is requested for id"""
1626 63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1181 if metadata is None:
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1182 metadata = {}
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 536 diff changeset	1183 client = self.getClient(profile)
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1184 if progress_id in client._progress_cb:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1185 raise exceptions.ConflictError("Progress ID is not unique !")
1626 63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1186 client._progress_cb[progress_id] = (callback, metadata)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1187
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1188 def removeProgressCb(self, progress_id, profile):
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1189 """Remove a progress callback"""
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 536 diff changeset	1190 client = self.getClient(profile)
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1191 try:
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1192 del client._progress_cb[progress_id]
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1193 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1194 log.error(_("Trying to remove an unknow progress callback"))
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1195
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1196 def _progressGet(self, progress_id, profile):
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1197 data = self.progressGet(progress_id, profile)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1198 return {k: str(v) for k, v in data.items()}
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1199
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1200 def progressGet(self, progress_id, profile):
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1201 """Return a dict with progress information
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1202
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1203 @param progress_id(unicode): unique id of the progressing element
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1204 @param profile: %(doc_profile)s
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1205 @return (dict): data with the following keys:
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1206 'position' (int): current possition
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1207 'size' (int): end_position
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1208 if id doesn't exists (may be a finished progression), and empty dict is
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1209 returned
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1210 """
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 536 diff changeset	1211 client = self.getClient(profile)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1212 try:
1626 63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1213 data = client._progress_cb[progress_id][0](progress_id, profile)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1214 except KeyError:
1598 b144babc2658 core, plugin file: fixed progress id + data is now returned by getProgress, instead of being an argument to fill Goffi <goffi@goffi.org> parents: 1595 diff changeset	1215 data = {}
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1216 return data
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1217
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1218 def _progressGetAll(self, profile_key):
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1219 progress_all = self.progressGetAll(profile_key)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1220 for profile, progress_dict in progress_all.items():
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1221 for progress_id, data in progress_dict.items():
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1222 for key, value in data.items():
ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1223 data[key] = str(value)
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1224 return progress_all
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1225
1626 63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1226 def progressGetAllMetadata(self, profile_key):
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1227 """Return all progress metadata at once
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1228
1626 63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1229 @param profile_key: %(doc_profile)s
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1230 if C.PROF_KEY_ALL is used, all progress metadata from all profiles are
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1231 returned
1626 63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1232 @return (dict[dict[dict]]): a dict which map profile to progress_dict
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1233 progress_dict map progress_id to progress_data
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1234 progress_metadata is the same dict as sent by [progressStarted]
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1235 """
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1236 clients = self.getClients(profile_key)
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1237 progress_all = {}
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1238 for client in clients:
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1239 profile = client.profile
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1240 progress_dict = {}
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1241 progress_all[profile] = progress_dict
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1242 for (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1243 progress_id,
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2733 diff changeset	1244 (__, progress_metadata),
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1245 ) in client._progress_cb.items():
1626 63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1246 progress_dict[progress_id] = progress_metadata
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1247 return progress_all
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1248
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1249 def progressGetAll(self, profile_key):
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1250 """Return all progress status at once
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1251
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1252 @param profile_key: %(doc_profile)s
63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1253 if C.PROF_KEY_ALL is used, all progress status from all profiles are returned
1598 b144babc2658 core, plugin file: fixed progress id + data is now returned by getProgress, instead of being an argument to fill Goffi <goffi@goffi.org> parents: 1595 diff changeset	1254 @return (dict[dict[dict]]): a dict which map profile to progress_dict
b144babc2658 core, plugin file: fixed progress id + data is now returned by getProgress, instead of being an argument to fill Goffi <goffi@goffi.org> parents: 1595 diff changeset	1255 progress_dict map progress_id to progress_data
b144babc2658 core, plugin file: fixed progress id + data is now returned by getProgress, instead of being an argument to fill Goffi <goffi@goffi.org> parents: 1595 diff changeset	1256 progress_data is the same dict as returned by [progressGet]
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1257 """
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1258 clients = self.getClients(profile_key)
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1259 progress_all = {}
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1260 for client in clients:
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1261 profile = client.profile
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1262 progress_dict = {}
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1263 progress_all[profile] = progress_dict
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1264 for progress_id, (progress_cb, __) in client._progress_cb.items():
1626 63cef4dbf2a4 core, plugins file, XEP-0234, bridge: progression api enhancement: Goffi <goffi@goffi.org> parents: 1624 diff changeset	1265 progress_dict[progress_id] = progress_cb(progress_id, profile)
1522 7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1266 return progress_all
7d7e57a84792 core: progression handling improvments: Goffi <goffi@goffi.org> parents: 1503 diff changeset	1267
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1268 def registerCallback(self, callback, args, *kwargs):
1603 2b82d846848e core: added callback_id in DataError message of launchCallback Goffi <goffi@goffi.org> parents: 1599 diff changeset	1269 """Register a callback.
2b82d846848e core: added callback_id in DataError message of launchCallback Goffi <goffi@goffi.org> parents: 1599 diff changeset	1270
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1271 @param callback(callable): method to call
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1272 @param kwargs: can contain:
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1273 with_data(bool): True if the callback use the optional data dict
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1274 force_id(unicode): id to avoid generated id. Can lead to name conflict, avoid
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1275 if possible
2733 e347e32aa07f core (memory/encryption): new encryptionNamespaceGet and encryptionTrustUIGet methods: Goffi <goffi@goffi.org> parents: 2691 diff changeset	1276 one_shot(bool): True to delete callback once it has been called
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1277 @return: id of the registered callback
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1278 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1279 callback_id = kwargs.pop("force_id", None)
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1280 if callback_id is None:
2167 4b78b4c7f805 core, frontends: various fixes for Libervia: Goffi <goffi@goffi.org> parents: 2147 diff changeset	1281 callback_id = str(uuid.uuid4())
22 bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button. Goffi <goffi@goffi.org> parents: 18 diff changeset	1282 else:
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1283 if callback_id in self._cb_map:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1284 raise exceptions.ConflictError(_("id already registered"))
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1285 self._cb_map[callback_id] = (callback, args, kwargs)
806 5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1286
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1287 if "one_shot" in kwargs: # One Shot callback are removed after 30 min
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1288
806 5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1289 def purgeCallback():
5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1290 try:
5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1291 self.removeCallback(callback_id)
5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1292 except KeyError:
5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1293 pass
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1294
806 5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1295 reactor.callLater(1800, purgeCallback)
5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1296
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1297 return callback_id
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1298
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1299 def removeCallback(self, callback_id):
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1300 """ Remove a previously registered callback
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1301 @param callback_id: id returned by [registerCallback] """
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 991 diff changeset	1302 log.debug("Removing callback [%s]" % callback_id)
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1303 del self._cb_map[callback_id]
22 bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button. Goffi <goffi@goffi.org> parents: 18 diff changeset	1304
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	1305 def launchCallback(self, callback_id, data=None, profile_key=C.PROF_KEY_NONE):
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1306 """Launch a specific callback
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1307
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1308 @param callback_id: id of the action (callback) to launch
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1309 @param data: optional data
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1310 @profile_key: %(doc_profile_key)s
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1311 @return: a deferred which fire a dict where key can be:
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1312 - xmlui: a XMLUI need to be displayed
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1313 - validated: if present, can be used to launch a callback, it can have the
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1314 values
1262 f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	1315 - C.BOOL_TRUE
f8a8434dbac7 core: improved roster management + misc: Goffi <goffi@goffi.org> parents: 1234 diff changeset	1316 - C.BOOL_FALSE
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1317 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1318 # FIXME: security limit need to be checked here
1622 5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1319 try:
1624 7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1320 client = self.getClient(profile_key)
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1321 except exceptions.NotFound:
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1322 # client is not available yet
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1323 profile = self.memory.getProfileName(profile_key)
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1324 if not profile:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1325 raise exceptions.ProfileUnknownError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1326 _("trying to launch action with a non-existant profile")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1327 )
1622 5b24d6bf5d15 core, bridge: actionsGet: Goffi <goffi@goffi.org> parents: 1603 diff changeset	1328 else:
1624 7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1329 profile = client.profile
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1330 # we check if the action is kept, and remove it
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1331 try:
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1332 action_tuple = client.actions[callback_id]
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1333 except KeyError:
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1334 pass
7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1335 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1336 action_tuple[-1].cancel() # the last item is the action timer
1624 7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1337 del client.actions[callback_id]
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1338
22 bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button. Goffi <goffi@goffi.org> parents: 18 diff changeset	1339 try:
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1340 callback, args, kwargs = self._cb_map[callback_id]
22 bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button. Goffi <goffi@goffi.org> parents: 18 diff changeset	1341 except KeyError:
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1342 raise exceptions.DataError("Unknown callback id {}".format(callback_id))
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1343
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1344 if kwargs.get("with_data", False):
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1345 if data is None:
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1346 raise exceptions.DataError("Required data for this callback is missing")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1347 args, kwargs = (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1348 list(args)[:],
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1349 kwargs.copy(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1350 ) # we don't want to modify the original (kw)args
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1351 args.insert(0, data)
1624 7e749e8eefd0 core: fixed launchAction: Goffi <goffi@goffi.org> parents: 1622 diff changeset	1352 kwargs["profile"] = profile
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1353 del kwargs["with_data"]
93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1354
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1355 if kwargs.pop("one_shot", False):
806 5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1356 self.removeCallback(callback_id)
5d6c45d6ee1b core: added "one_shot" option to registered callback: Goffi <goffi@goffi.org> parents: 801 diff changeset	1357
759 93bd868b8fb6 backend, frontends: callbacks refactoring: Goffi <goffi@goffi.org> parents: 755 diff changeset	1358 return defer.maybeDeferred(callback, args, *kwargs)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1359
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1360 # Menus management
101 783e9d6980ec Couchsurfing plugin: first draft Goffi <goffi@goffi.org> parents: 90 diff changeset	1361
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1362 def _getMenuCanonicalPath(self, path):
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1363 """give canonical form of path
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1364
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1365 canonical form is a tuple of the path were every element is stripped and lowercase
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1366 @param path(iterable[unicode]): untranslated path to menu
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1367 @return (tuple[unicode]): canonical form of path
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1368 """
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1369 return tuple((p.lower().strip() for p in path))
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1370
2810 c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	1371 def importMenu(self, path, callback, security_limit=C.NO_SECURITY_LIMIT,
c161a294fffd core: added a base menu allowing to set encryption session or show the trust management UI. Goffi <goffi@goffi.org> parents: 2791 diff changeset	1372 help_string="", type_=C.MENU_GLOBAL):
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1373 r"""register a new menu for frontends
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	1374
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1375 @param path(iterable[unicode]): path to go to the menu
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1376 (category/subcategory/.../item) (e.g.: ("File", "Open"))
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1377 /!\ use D_() instead of _() for translations (e.g. (D_("File"), D_("Open")))
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1378 untranslated/lower case path can be used to identity a menu, for this reason
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1379 it must be unique independently of case.
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1380 @param callback(callable): method to be called when menuitem is selected, callable
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1381 or a callback id (string) as returned by [registerCallback]
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1382 @param security_limit(int): %(doc_security_limit)s
809 743b757777d3 core: security limit in menus Goffi <goffi@goffi.org> parents: 807 diff changeset	1383 /!\ security_limit MUST be added to data in launchCallback if used #TODO
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1384 @param help_string(unicode): string used to indicate what the menu do (can be
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1385 show as a tooltip).
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1386 /!\ use D_() instead of _() for translations
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1387 @param type(unicode): one of:
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1388 - C.MENU_GLOBAL: classical menu, can be shown in a menubar on top (e.g.
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1389 something like File/Open)
1092 0eefc74c346b core (menus): constants are used for menu types Goffi <goffi@goffi.org> parents: 1089 diff changeset	1390 - C.MENU_ROOM: like a global menu, but only shown in multi-user chat
0eefc74c346b core (menus): constants are used for menu types Goffi <goffi@goffi.org> parents: 1089 diff changeset	1391 menu_data must contain a "room_jid" data
0eefc74c346b core (menus): constants are used for menu types Goffi <goffi@goffi.org> parents: 1089 diff changeset	1392 - C.MENU_SINGLE: like a global menu, but only shown in one2one chat
0eefc74c346b core (menus): constants are used for menu types Goffi <goffi@goffi.org> parents: 1089 diff changeset	1393 menu_data must contain a "jid" data
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1394 - C.MENU_JID_CONTEXT: contextual menu, used with any jid (e.g.: ad hoc
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1395 commands, jid is already filled)
1092 0eefc74c346b core (menus): constants are used for menu types Goffi <goffi@goffi.org> parents: 1089 diff changeset	1396 menu_data must contain a "jid" data
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1397 - C.MENU_ROSTER_JID_CONTEXT: like JID_CONTEXT, but restricted to jids in
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1398 roster.
1092 0eefc74c346b core (menus): constants are used for menu types Goffi <goffi@goffi.org> parents: 1089 diff changeset	1399 menu_data must contain a "room_jid" data
2643 189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1400 - C.MENU_ROSTER_GROUP_CONTEXT: contextual menu, used with group (e.g.: publish
189e38fb11ff core: style improvments (90 chars limit) Goffi <goffi@goffi.org> parents: 2624 diff changeset	1401 microblog, group is already filled)
1092 0eefc74c346b core (menus): constants are used for menu types Goffi <goffi@goffi.org> parents: 1089 diff changeset	1402 menu_data must contain a "group" data
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1403 @return (unicode): menu_id (same as callback_id)
755 e3ad48a2aab2 core, frontends: callMenu is now async and don't use callback_id anymore Goffi <goffi@goffi.org> parents: 752 diff changeset	1404 """
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1405
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1406 if callable(callback):
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1407 callback_id = self.registerCallback(callback, with_data=True)
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1408 elif isinstance(callback, str):
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1409 # The callback is already registered
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1410 callback_id = callback
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1411 try:
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1412 callback, args, kwargs = self._cb_map[callback_id]
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1413 except KeyError:
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1414 raise exceptions.DataError("Unknown callback id")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1415 kwargs["with_data"] = True # we have to be sure that we use extra data
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1416 else:
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1417 raise exceptions.DataError("Unknown callback type")
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1418
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1419 for menu_data in self._menus.values():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1420 if menu_data["path"] == path and menu_data["type"] == type_:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1421 raise exceptions.ConflictError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1422 _("A menu with the same path and type already exists")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1423 )
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1424
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1425 path_canonical = self._getMenuCanonicalPath(path)
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1426 menu_key = (type_, path_canonical)
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1427
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1428 if menu_key in self._menus_paths:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1429 raise exceptions.ConflictError(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1430 "this menu path is already used: {path} ({menu_key})".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1431 path=path_canonical, menu_key=menu_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1432 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1433 )
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1434
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1435 menu_data = {
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1436 "path": tuple(path),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1437 "path_canonical": path_canonical,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1438 "security_limit": security_limit,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1439 "help_string": help_string,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1440 "type": type_,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1441 }
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1442
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1443 self._menus[callback_id] = menu_data
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1444 self._menus_paths[menu_key] = callback_id
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1445
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1446 return callback_id
101 783e9d6980ec Couchsurfing plugin: first draft Goffi <goffi@goffi.org> parents: 90 diff changeset	1447
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1448 def getMenus(self, language="", security_limit=C.NO_SECURITY_LIMIT):
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1449 """Return all menus registered
1365 ba87b940f07a core, quick_frontends: added an "extra" item in getMenus + use of new quick_menus module in QuickApp Goffi <goffi@goffi.org> parents: 1355 diff changeset	1450
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1451 @param language: language used for translation, or empty string for default
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1452 @param security_limit: %(doc_security_limit)s
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1453 @return: array of tuple with:
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1454 - menu id (same as callback_id)
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1455 - menu type
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1456 - raw menu path (array of strings)
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1457 - translated menu path
1365 ba87b940f07a core, quick_frontends: added an "extra" item in getMenus + use of new quick_menus module in QuickApp Goffi <goffi@goffi.org> parents: 1355 diff changeset	1458 - extra (dict(unicode, unicode)): extra data where key can be:
ba87b940f07a core, quick_frontends: added an "extra" item in getMenus + use of new quick_menus module in QuickApp Goffi <goffi@goffi.org> parents: 1355 diff changeset	1459 - icon: name of the icon to use (TODO)
ba87b940f07a core, quick_frontends: added an "extra" item in getMenus + use of new quick_menus module in QuickApp Goffi <goffi@goffi.org> parents: 1355 diff changeset	1460 - help_url: link to a page with more complete documentation (TODO)
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1461 """
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1462 ret = []
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1463 for menu_id, menu_data in self._menus.items():
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1464 type_ = menu_data["type"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1465 path = menu_data["path"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1466 menu_security_limit = menu_data["security_limit"]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1467 if security_limit != C.NO_SECURITY_LIMIT and (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1468 menu_security_limit == C.NO_SECURITY_LIMIT
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1469 or menu_security_limit > security_limit
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1470 ):
809 743b757777d3 core: security limit in menus Goffi <goffi@goffi.org> parents: 807 diff changeset	1471 continue
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1472 languageSwitch(language)
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1473 path_i18n = [_(elt) for elt in path]
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1474 languageSwitch()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1475 extra = {} # TODO: manage extra data like icon
1365 ba87b940f07a core, quick_frontends: added an "extra" item in getMenus + use of new quick_menus module in QuickApp Goffi <goffi@goffi.org> parents: 1355 diff changeset	1476 ret.append((menu_id, type_, path, path_i18n, extra))
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1477
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1478 return ret
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1479
2879 5ba98fd6c9a4 core: minor style improvments Goffi <goffi@goffi.org> parents: 2810 diff changeset	1480 def _launchMenu(self, menu_type, path, data=None, security_limit=C.NO_SECURITY_LIMIT,
5ba98fd6c9a4 core: minor style improvments Goffi <goffi@goffi.org> parents: 2810 diff changeset	1481 profile_key=C.PROF_KEY_NONE):
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1482 client = self.getClient(profile_key)
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1483 return self.launchMenu(client, menu_type, path, data, security_limit)
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1484
2879 5ba98fd6c9a4 core: minor style improvments Goffi <goffi@goffi.org> parents: 2810 diff changeset	1485 def launchMenu(self, client, menu_type, path, data=None,
5ba98fd6c9a4 core: minor style improvments Goffi <goffi@goffi.org> parents: 2810 diff changeset	1486 security_limit=C.NO_SECURITY_LIMIT):
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1487 """launch action a menu action
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1488
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1489 @param menu_type(unicode): type of menu to launch
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1490 @param path(iterable[unicode]): canonical path of the menu
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1491 @params data(dict): menu data
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1492 @raise NotFound: this path is not known
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1493 """
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1494 # FIXME: manage security_limit here
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1495 # defaut security limit should be high instead of C.NO_SECURITY_LIMIT
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1496 canonical_path = self._getMenuCanonicalPath(path)
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1497 menu_key = (menu_type, canonical_path)
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1498 try:
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1499 callback_id = self._menus_paths[menu_key]
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1500 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1501 raise exceptions.NotFound(
3028 ab2696e34d29 Python 3 port: Goffi <goffi@goffi.org> parents: 2990 diff changeset	1502 "Can't find menu {path} ({menu_type})".format(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1503 path=canonical_path, menu_type=menu_type
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1504 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1505 )
2126 2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1506 return self.launchCallback(callback_id, data, client.profile)
2f264f3df280 core (menus): improvments: Goffi <goffi@goffi.org> parents: 2113 diff changeset	1507
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1508 def getMenuHelp(self, menu_id, language=""):
2113 9c861d07b5b6 core: added sessionGetInfos bridge method to retrieve various data on current profile session + client.started keep start time Goffi <goffi@goffi.org> parents: 2105 diff changeset	1509 """return the help string of the menu
9c861d07b5b6 core: added sessionGetInfos bridge method to retrieve various data on current profile session + client.started keep start time Goffi <goffi@goffi.org> parents: 2105 diff changeset	1510
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1511 @param menu_id: id of the menu (same as callback_id)
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1512 @param language: language used for translation, or empty string for default
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1513 @param return: translated help
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1514
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1515 """
101 783e9d6980ec Couchsurfing plugin: first draft Goffi <goffi@goffi.org> parents: 90 diff changeset	1516 try:
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1517 menu_data = self._menus[menu_id]
101 783e9d6980ec Couchsurfing plugin: first draft Goffi <goffi@goffi.org> parents: 90 diff changeset	1518 except KeyError:
755 e3ad48a2aab2 core, frontends: callMenu is now async and don't use callback_id anymore Goffi <goffi@goffi.org> parents: 752 diff changeset	1519 raise exceptions.DataError("Trying to access an unknown menu")
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1520 languageSwitch(language)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1521 help_string = _(menu_data["help_string"])
773 eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1522 languageSwitch()
eac23b1aad90 core: dynamics menus refactoring: Goffi <goffi@goffi.org> parents: 771 diff changeset	1523 return help_string

Mercurial > libervia-backend

annotate sat/core/sat_main.py @ 3237:b0c57c9a4bd8