libervia-backend: sat/memory/memory.py annotate

annotate sat/memory/memory.py @ 2787:298408833ec2

memory (sqlite): optimizations indexes were missing on foreign keys for "message", "subject" and "thread" tables, seriously impacting performances. In addition to those indexes, two indexes have been added to speed ordering by timestamp on "history", and one on "files" table. history.rowid is not used anymore as there is an index on (profile_id, received_timestamp) which will speed up the query. Primary keys order has been changed to use automatic index in most common cases (filtering by profile_id then namespace).

author	Goffi <goffi@goffi.org>
date	Sat, 19 Jan 2019 22:49:32 +0100
parents	003b8b4b56a7
children	90146552cde5

rev	line source
1934 2daf7b4c6756 use of /usr/bin/env instead of /usr/bin/python in shebang Goffi <goffi@goffi.org> parents: 1859 diff changeset	1 #!/usr/bin/env python2
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	2 # -- coding: utf-8 --
c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	3
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 592 diff changeset	4 # SAT: a jabber client
2771 003b8b4b56a7 date update Goffi <goffi@goffi.org> parents: 2765 diff changeset	5 # Copyright (C) 2009-2019 Jérôme Poisson (goffi@goffi.org)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	6
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 592 diff changeset	7 # 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: 592 diff changeset	8 # 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: 592 diff changeset	9 # 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: 592 diff changeset	10 # (at your option) any later version.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	11
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 592 diff changeset	12 # 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: 592 diff changeset	13 # 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: 592 diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 592 diff changeset	15 # GNU Affero General Public License for more details.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	16
609 84a6e83157c2 fixed licences in docstrings (they are now in comments) Goffi <goffi@goffi.org> parents: 592 diff changeset	17 # 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: 592 diff changeset	18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	19
771 bfabeedbf32e core: i18n refactoring: Goffi <goffi@goffi.org> parents: 759 diff changeset	20 from sat.core.i18n import _
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	21
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	22 from sat.core.log import getLogger
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	23
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	24 log = getLogger(__name__)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	25
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	26 import os.path
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	27 import copy
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	28 from collections import namedtuple
364 312ca6f9d84a core: configuration file Goffi <goffi@goffi.org> parents: 346 diff changeset	29 from ConfigParser import SafeConfigParser, NoOptionError, NoSectionError
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	30 from uuid import uuid4
1447 b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	31 from twisted.python import failure
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	32 from twisted.internet import defer, reactor, error
47 9aa2d9dd4045 memory methods improvement Goffi <goffi@goffi.org> parents: 41 diff changeset	33 from twisted.words.protocols.jabber import jid
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	34 from sat.core import exceptions
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	35 from sat.core.constants import Const as C
432 31e8c48b5f5d core: - memory refactoring (moved memory.py and sqlite.py from tools to memory) Goffi <goffi@goffi.org> parents: 428 diff changeset	36 from sat.memory.sqlite import SqliteStorage
31e8c48b5f5d core: - memory refactoring (moved memory.py and sqlite.py from tools to memory) Goffi <goffi@goffi.org> parents: 428 diff changeset	37 from sat.memory.persistent import PersistentDict
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	38 from sat.memory.params import Params
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	39 from sat.memory.disco import Discovery
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	40 from sat.memory.crypto import BlockCipher
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	41 from sat.memory.crypto import PasswordHasher
1064 7ee9d9db67b9 memory, tools (config): move special config retrieval from memory to tools souliane <souliane@mailoo.org> parents: 1046 diff changeset	42 from sat.tools import config as tools_config
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	43 import shortuuid
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	44 import mimetypes
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	45 import time
420 acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	46
679 59c9a7ff903d wix, misc: use picture of dimension 32x32 for tray icon + better PEP-8 compliance souliane <souliane@mailoo.org> parents: 677 diff changeset	47
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	48 PresenceTuple = namedtuple("PresenceTuple", ("show", "priority", "statuses"))
1447 b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	49 MSG_NO_SESSION = "Session id doesn't exist or is finished"
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	50
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	51
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	52 class Sessions(object):
1029 f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	53 """Sessions are data associated to key used for a temporary moment, with optional profile checking."""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	54
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	55 DEFAULT_TIMEOUT = 600
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	56
1215 d9c399ec5dd9 memory: session timeout won't be reset on each access if the Sessions() is called with resettable_timeout=False souliane <souliane@mailoo.org> parents: 1214 diff changeset	57 def __init__(self, timeout=None, resettable_timeout=True):
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	58 """
1215 d9c399ec5dd9 memory: session timeout won't be reset on each access if the Sessions() is called with resettable_timeout=False souliane <souliane@mailoo.org> parents: 1214 diff changeset	59 @param timeout (int): nb of seconds before session destruction
d9c399ec5dd9 memory: session timeout won't be reset on each access if the Sessions() is called with resettable_timeout=False souliane <souliane@mailoo.org> parents: 1214 diff changeset	60 @param resettable_timeout (bool): if True, the timeout is reset on each access
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	61 """
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	62 self._sessions = dict()
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	63 self.timeout = timeout or Sessions.DEFAULT_TIMEOUT
1215 d9c399ec5dd9 memory: session timeout won't be reset on each access if the Sessions() is called with resettable_timeout=False souliane <souliane@mailoo.org> parents: 1214 diff changeset	64 self.resettable_timeout = resettable_timeout
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	65
1212 628e320eab1f memory: Sessions.newSession can be called with a forced session ID souliane <souliane@mailoo.org> parents: 1199 diff changeset	66 def newSession(self, session_data=None, session_id=None, profile=None):
1447 b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	67 """Create a new session
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	68
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	69 @param session_data: mutable data to use, default to a dict
1212 628e320eab1f memory: Sessions.newSession can be called with a forced session ID souliane <souliane@mailoo.org> parents: 1199 diff changeset	70 @param session_id (str): force the session_id to the given string
757 bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	71 @param profile: if set, the session is owned by the profile,
bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	72 and profileGet must be used instead of __getitem__
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	73 @return: session_id, session_data
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	74 """
1212 628e320eab1f memory: Sessions.newSession can be called with a forced session ID souliane <souliane@mailoo.org> parents: 1199 diff changeset	75 if session_id is None:
628e320eab1f memory: Sessions.newSession can be called with a forced session ID souliane <souliane@mailoo.org> parents: 1199 diff changeset	76 session_id = str(uuid4())
1213 b5928601d7aa memory: handle the case where an existing session ID is re-used for creating a new session souliane <souliane@mailoo.org> parents: 1212 diff changeset	77 elif session_id in self._sessions:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	78 raise exceptions.ConflictError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	79 u"Session id {} is already used".format(session_id)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	80 )
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	81 timer = reactor.callLater(self.timeout, self._purgeSession, session_id)
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	82 if session_data is None:
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	83 session_data = {}
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	84 self._sessions[session_id] = (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	85 (timer, session_data) if profile is None else (timer, session_data, profile)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	86 )
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	87 return session_id, session_data
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	88
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	89 def _purgeSession(self, session_id):
1447 b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	90 try:
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	91 timer, session_data, profile = self._sessions[session_id]
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	92 except ValueError:
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	93 timer, session_data = self._sessions[session_id]
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	94 profile = None
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	95 try:
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	96 timer.cancel()
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	97 except error.AlreadyCalled:
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	98 # if the session is time-outed, the timer has been called
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	99 pass
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	100 del self._sessions[session_id]
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	101 log.debug(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	102 u"Session {} purged{}".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	103 session_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	104 u" (profile {})".format(profile) if profile is not None else u"",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	105 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	106 )
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	107
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	108 def __len__(self):
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	109 return len(self._sessions)
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	110
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	111 def __contains__(self, session_id):
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	112 return session_id in self._sessions
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	113
757 bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	114 def profileGet(self, session_id, profile):
bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	115 try:
bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	116 timer, session_data, profile_set = self._sessions[session_id]
bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	117 except ValueError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	118 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	119 "You need to use __getitem__ when profile is not set"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	120 )
1447 b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	121 except KeyError:
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	122 raise failure.Failure(KeyError(MSG_NO_SESSION))
757 bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	123 if profile_set != profile:
bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	124 raise exceptions.InternalError("current profile differ from set profile !")
1215 d9c399ec5dd9 memory: session timeout won't be reset on each access if the Sessions() is called with resettable_timeout=False souliane <souliane@mailoo.org> parents: 1214 diff changeset	125 if self.resettable_timeout:
d9c399ec5dd9 memory: session timeout won't be reset on each access if the Sessions() is called with resettable_timeout=False souliane <souliane@mailoo.org> parents: 1214 diff changeset	126 timer.reset(self.timeout)
757 bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	127 return session_data
bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	128
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	129 def __getitem__(self, session_id):
757 bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	130 try:
bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	131 timer, session_data = self._sessions[session_id]
bbe55c7bee43 core (memory): added optional profile checking in Sessions: Goffi <goffi@goffi.org> parents: 756 diff changeset	132 except ValueError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	133 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	134 "You need to use profileGet instead of __getitem__ when profile is set"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	135 )
1447 b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	136 except KeyError:
b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	137 raise failure.Failure(KeyError(MSG_NO_SESSION))
1215 d9c399ec5dd9 memory: session timeout won't be reset on each access if the Sessions() is called with resettable_timeout=False souliane <souliane@mailoo.org> parents: 1214 diff changeset	138 if self.resettable_timeout:
d9c399ec5dd9 memory: session timeout won't be reset on each access if the Sessions() is called with resettable_timeout=False souliane <souliane@mailoo.org> parents: 1214 diff changeset	139 timer.reset(self.timeout)
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	140 return session_data
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	141
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	142 def __setitem__(self, key, value):
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	143 raise NotImplementedError("You need do use newSession to create a session")
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	144
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	145 def __delitem__(self, session_id):
1474 c2a498dce4b4 core (memory): fixed a double timer.cancel in Sessions Goffi <goffi@goffi.org> parents: 1460 diff changeset	146 """ delete the session data """
1447 b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	147 self._purgeSession(session_id)
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	148
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	149 def keys(self):
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	150 return self._sessions.keys()
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	151
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	152 def iterkeys(self):
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	153 return self._sessions.iterkeys()
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	154
efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	155
1029 f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	156 class ProfileSessions(Sessions):
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	157 """ProfileSessions extends the Sessions class, but here the profile can be
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	158 used as the key to retrieve data or delete a session (instead of session id).
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	159 """
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	160
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	161 def _profileGetAllIds(self, profile):
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	162 """Return a list of the sessions ids that are associated to the given profile.
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	163
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	164 @param profile: %(doc_profile)s
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	165 @return: a list containing the sessions ids
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	166 """
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	167 ret = []
1447 b003dbd2b4e9 core (memory): Sessions fixes: Goffi <goffi@goffi.org> parents: 1409 diff changeset	168 for session_id in self._sessions.iterkeys():
1029 f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	169 try:
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	170 timer, session_data, profile_set = self._sessions[session_id]
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	171 except ValueError:
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	172 continue
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	173 if profile == profile_set:
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	174 ret.append(session_id)
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	175 return ret
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	176
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	177 def profileGetUnique(self, profile):
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	178 """Return the data of the unique session that is associated to the given profile.
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	179
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	180 @param profile: %(doc_profile)s
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	181 @return:
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	182 - mutable data (default: dict) of the unique session
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	183 - None if no session is associated to the profile
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	184 - raise an error if more than one session are found
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	185 """
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	186 ids = self._profileGetAllIds(profile)
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	187 if len(ids) > 1:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	188 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	189 "profileGetUnique has been used but more than one session has been found!"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	190 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	191 return (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	192 self.profileGet(ids[0], profile) if len(ids) == 1 else None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	193 ) # XXX: timeout might be reset
1214 ed3b01ed70d7 memory: profileSessions.profileGetUnique was not resetting the timer souliane <souliane@mailoo.org> parents: 1213 diff changeset	194
1029 f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	195 def profileDelUnique(self, profile):
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	196 """Delete the unique session that is associated to the given profile.
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	197
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	198 @param profile: %(doc_profile)s
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	199 @return: None, but raise an error if more than one session are found
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	200 """
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	201 ids = self._profileGetAllIds(profile)
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	202 if len(ids) > 1:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	203 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	204 "profileDelUnique has been used but more than one session has been found!"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	205 )
1029 f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	206 if len(ids) == 1:
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	207 del self._sessions[ids[0]]
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	208
f6182f6418ea memory: add class ProfileSessions based on Sessions souliane <souliane@mailoo.org> parents: 1015 diff changeset	209
1247 c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	210 class PasswordSessions(ProfileSessions):
c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	211
c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	212 # FIXME: temporary hack for the user personal key not to be lost. The session
c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	213 # must actually be purged and later, when the personal key is needed, the
c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	214 # profile password should be asked again in order to decrypt it.
c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	215 def __init__(self, timeout=None):
c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	216 ProfileSessions.__init__(self, timeout, resettable_timeout=False)
c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	217
c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	218 def _purgeSession(self, session_id):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	219 log.debug(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	220 "FIXME: PasswordSessions should ask for the profile password after the session expired"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	221 )
1247 c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	222
c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	223
1003 52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	224 # XXX: tmp update code, will be removed in the future
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	225 # When you remove this, please add the default value for
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	226 # 'local_dir' in sat.core.constants.Const.DEFAULT_CONFIG
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	227 def fixLocalDir(silent=True):
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	228 """Retro-compatibility with the previous local_dir default value.
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	229
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	230 @param silent (boolean): toggle logging output (must be True when called from sat.sh)
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	231 """
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	232 user_config = SafeConfigParser()
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	233 try:
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	234 user_config.read(C.CONFIG_FILES)
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	235 except:
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	236 pass # file is readable but its structure if wrong
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	237 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	238 current_value = user_config.get("DEFAULT", "local_dir")
1003 52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	239 except (NoOptionError, NoSectionError):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	240 current_value = ""
1003 52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	241 if current_value:
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	242 return # nothing to do
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	243 old_default = "~/.sat"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	244 if os.path.isfile(os.path.expanduser(old_default) + "/" + C.SAVEFILE_DATABASE):
1003 52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	245 if not silent:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	246 log.warning(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	247 _(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	248 u"A database has been found in the default local_dir for previous versions (< 0.5)"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	249 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	250 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	251 tools_config.fixConfigOption("", "local_dir", old_default, silent)
1003 52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	252
52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	253
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	254 class Memory(object):
1199 96fb74a4714d misc: fixed some typos Matteo Cypriani <mcy@lm7.fr> parents: 1097 diff changeset	255 """This class manage all the persistent information"""
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	256
22 bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button. Goffi <goffi@goffi.org> parents: 21 diff changeset	257 def __init__(self, host):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 946 diff changeset	258 log.info(_("Memory manager init"))
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	259 self.initialized = defer.Deferred()
41 d24629c631fc SàT: new constant management, a local dir (~/.sat) is now used Goffi <goffi@goffi.org> parents: 38 diff changeset	260 self.host = host
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	261 self._entities_cache = {} # XXX: keep presence/last resource/other data in cache
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	262 # /!\ an entity is not necessarily in roster
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	263 # main key is bare jid, value is a dict
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	264 # where main key is resource, or None for bare jid
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	265 self._key_signals = set() # key which need a signal to frontends when updated
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	266 self.subscriptions = {}
1247 c6cf44e6330b memory: temporary dirty hack to fix the personnal key issue after the auth session expired souliane <souliane@mailoo.org> parents: 1240 diff changeset	267 self.auth_sessions = PasswordSessions() # remember the authenticated profiles
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	268 self.disco = Discovery(host)
1003 52ec79aa5bbe memory: fixes the method fixLocalDir for pid_dir and log_dir to use local_dir as default souliane <souliane@mailoo.org> parents: 993 diff changeset	269 fixLocalDir(False) # XXX: tmp update code, will be removed in the future
1859 ac2ac7fe8a9b core (memory, config): moved parseMainConf to tools/config so it can be used by frontends too Goffi <goffi@goffi.org> parents: 1766 diff changeset	270 self.config = tools_config.parseMainConf()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	271 database_file = os.path.expanduser(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	272 os.path.join(self.getConfig("", "local_dir"), C.SAVEFILE_DATABASE)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	273 )
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: 1315 diff changeset	274 self.storage = SqliteStorage(database_file, host.version)
432 31e8c48b5f5d core: - memory refactoring (moved memory.py and sqlite.py from tools to memory) Goffi <goffi@goffi.org> parents: 428 diff changeset	275 PersistentDict.storage = self.storage
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	276 self.params = Params(host, self.storage)
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 946 diff changeset	277 log.info(_("Loading default params template"))
677 9a50aa7feefb core (memory): cleaned the part for load/save to xml (not used) souliane <souliane@mailoo.org> parents: 669 diff changeset	278 self.params.load_default_params()
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	279 d = self.storage.initialized.addCallback(lambda ignore: self.load())
443 7099ea9c1b12 core: getPrivate/setPrivate removed from memory, private values now use database storage and persistent dicts \o/ Goffi <goffi@goffi.org> parents: 432 diff changeset	280 self.memory_data = PersistentDict("memory")
7099ea9c1b12 core: getPrivate/setPrivate removed from memory, private values now use database storage and persistent dicts \o/ Goffi <goffi@goffi.org> parents: 432 diff changeset	281 d.addCallback(lambda ignore: self.memory_data.load())
1684 373ce871b0f3 core (disco): disco hashes are now stored in database to avoid doing the same disco request on next load Goffi <goffi@goffi.org> parents: 1682 diff changeset	282 d.addCallback(lambda ignore: self.disco.load())
428 a4a9efadabfc core: fixed memory initialisation sequence Goffi <goffi@goffi.org> parents: 425 diff changeset	283 d.chainDeferred(self.initialized)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	284
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	285 ## Configuration ##
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	286
1234 9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1224 diff changeset	287 def getConfig(self, section, name, default=None):
364 312ca6f9d84a core: configuration file Goffi <goffi@goffi.org> parents: 346 diff changeset	288 """Get the main configuration option
1234 9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1224 diff changeset	289
364 312ca6f9d84a core: configuration file Goffi <goffi@goffi.org> parents: 346 diff changeset	290 @param section: section of the config file (None or '' for DEFAULT)
312ca6f9d84a core: configuration file Goffi <goffi@goffi.org> parents: 346 diff changeset	291 @param name: name of the option
1234 9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1224 diff changeset	292 @param default: value to use if not found
9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1224 diff changeset	293 @return: str, list or dict
365 efbfccfed623 core: local_dir moved to config file Goffi <goffi@goffi.org> parents: 364 diff changeset	294 """
1234 9c17bd37e6e5 core: better management of default value in getConfig Goffi <goffi@goffi.org> parents: 1224 diff changeset	295 return tools_config.getConfig(self.config, section, name, default)
364 312ca6f9d84a core: configuration file Goffi <goffi@goffi.org> parents: 346 diff changeset	296
677 9a50aa7feefb core (memory): cleaned the part for load/save to xml (not used) souliane <souliane@mailoo.org> parents: 669 diff changeset	297 def load_xml(self, filename):
1015 fee00f2e11c2 memory, jp: added jp commands to load/save parameters template souliane <souliane@mailoo.org> parents: 1007 diff changeset	298 """Load parameters template from xml file
fee00f2e11c2 memory, jp: added jp commands to load/save parameters template souliane <souliane@mailoo.org> parents: 1007 diff changeset	299
fee00f2e11c2 memory, jp: added jp commands to load/save parameters template souliane <souliane@mailoo.org> parents: 1007 diff changeset	300 @param filename (str): input file
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	301 @return: bool: True in case of success
1015 fee00f2e11c2 memory, jp: added jp commands to load/save parameters template souliane <souliane@mailoo.org> parents: 1007 diff changeset	302 """
fee00f2e11c2 memory, jp: added jp commands to load/save parameters template souliane <souliane@mailoo.org> parents: 1007 diff changeset	303 if not filename:
677 9a50aa7feefb core (memory): cleaned the part for load/save to xml (not used) souliane <souliane@mailoo.org> parents: 669 diff changeset	304 return False
9a50aa7feefb core (memory): cleaned the part for load/save to xml (not used) souliane <souliane@mailoo.org> parents: 669 diff changeset	305 filename = os.path.expanduser(filename)
9a50aa7feefb core (memory): cleaned the part for load/save to xml (not used) souliane <souliane@mailoo.org> parents: 669 diff changeset	306 if os.path.exists(filename):
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	307 try:
677 9a50aa7feefb core (memory): cleaned the part for load/save to xml (not used) souliane <souliane@mailoo.org> parents: 669 diff changeset	308 self.params.load_xml(filename)
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	309 log.debug(_(u"Parameters loaded from file: %s") % filename)
677 9a50aa7feefb core (memory): cleaned the part for load/save to xml (not used) souliane <souliane@mailoo.org> parents: 669 diff changeset	310 return True
557 4f856dd4c0d0 core: paramaters are now merged: if a parameter doens't exist in loaded xml but exists in default parameters, it is added Goffi <goffi@goffi.org> parents: 556 diff changeset	311 except Exception as e:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	312 log.error(_(u"Can't load parameters from file: %s") % e)
677 9a50aa7feefb core (memory): cleaned the part for load/save to xml (not used) souliane <souliane@mailoo.org> parents: 669 diff changeset	313 return False
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	314
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	315 def save_xml(self, filename):
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	316 """Save parameters template to xml file
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	317
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	318 @param filename (str): output file
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	319 @return: bool: True in case of success
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	320 """
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	321 if not filename:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	322 return False
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	323 # TODO: need to encrypt files (at least passwords !) and set permissions
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	324 filename = os.path.expanduser(filename)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	325 try:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	326 self.params.save_xml(filename)
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	327 log.debug(_(u"Parameters saved to file: %s") % filename)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	328 return True
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	329 except Exception as e:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	330 log.error(_(u"Can't save parameters to file: %s") % e)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	331 return False
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	332
443 7099ea9c1b12 core: getPrivate/setPrivate removed from memory, private values now use database storage and persistent dicts \o/ Goffi <goffi@goffi.org> parents: 432 diff changeset	333 def load(self):
428 a4a9efadabfc core: fixed memory initialisation sequence Goffi <goffi@goffi.org> parents: 425 diff changeset	334 """Load parameters and all memory things from db"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	335 # parameters data
428 a4a9efadabfc core: fixed memory initialisation sequence Goffi <goffi@goffi.org> parents: 425 diff changeset	336 return self.params.loadGenParams()
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	337
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	338 def loadIndividualParams(self, profile):
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	339 """Load individual parameters for a profile
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	340 @param profile: %(doc_profile)s"""
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	341 return self.params.loadIndParams(profile)
62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	342
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	343 ## Profiles/Sessions management ##
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	344
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	345 def startSession(self, password, profile):
484 23cbdf0a0777 core: presence status + last resource refactored and kept in entitiesCache in memory.py, profile cache is purged on disconnection Goffi <goffi@goffi.org> parents: 480 diff changeset	346 """"Iniatialise session for a profile
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	347
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	348 @param password(unicode): profile session password
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	349 or empty string is no password is set
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	350 @param profile: %(doc_profile)s
1694 3c608d660f0b core (memory): profile is checked in startSession (an error is raised if it doesn't exist) Goffi <goffi@goffi.org> parents: 1693 diff changeset	351 @raise exceptions.ProfileUnknownError if profile doesn't exists
3c608d660f0b core (memory): profile is checked in startSession (an error is raised if it doesn't exist) Goffi <goffi@goffi.org> parents: 1693 diff changeset	352 @raise exceptions.PasswordError: the password does not match
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	353 """
1694 3c608d660f0b core (memory): profile is checked in startSession (an error is raised if it doesn't exist) Goffi <goffi@goffi.org> parents: 1693 diff changeset	354 profile = self.getProfileName(profile)
3c608d660f0b core (memory): profile is checked in startSession (an error is raised if it doesn't exist) Goffi <goffi@goffi.org> parents: 1693 diff changeset	355
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	356 def createSession(__):
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	357 """Called once params are loaded."""
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	358 self._entities_cache[profile] = {}
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	359 log.info(u"[{}] Profile session started".format(profile))
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	360 return False
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	361
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	362 def backendInitialised(__):
378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	363 def doStartSession(__=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	364 if self.isSessionStarted(profile):
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	365 log.info("Session already started!")
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	366 return True
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	367 try:
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	368 # if there is a value at this point in self._entities_cache,
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	369 # it is the loadIndividualParams Deferred, the session is starting
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	370 session_d = self._entities_cache[profile]
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	371 except KeyError:
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	372 # else we do request the params
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	373 session_d = self._entities_cache[profile] = self.loadIndividualParams(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	374 profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	375 )
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	376 session_d.addCallback(createSession)
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	377 finally:
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	378 return session_d
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	379
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	380 auth_d = self.profileAuthenticate(password, profile)
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	381 auth_d.addCallback(doStartSession)
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	382 return auth_d
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	383
1723 5632c5350296 core: avoid initialisation blocking when a long callback is added to backend.initialised (could prevent sessions starting) Goffi <goffi@goffi.org> parents: 1704 diff changeset	384 if self.host.initialised.called:
5632c5350296 core: avoid initialisation blocking when a long callback is added to backend.initialised (could prevent sessions starting) Goffi <goffi@goffi.org> parents: 1704 diff changeset	385 return defer.succeed(None).addCallback(backendInitialised)
5632c5350296 core: avoid initialisation blocking when a long callback is added to backend.initialised (could prevent sessions starting) Goffi <goffi@goffi.org> parents: 1704 diff changeset	386 else:
5632c5350296 core: avoid initialisation blocking when a long callback is added to backend.initialised (could prevent sessions starting) Goffi <goffi@goffi.org> parents: 1704 diff changeset	387 return self.host.initialised.addCallback(backendInitialised)
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	388
1693 35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	389 def stopSession(self, profile):
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	390 """Delete a profile session
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	391
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	392 @param profile: %(doc_profile)s
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	393 """
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	394 if self.host.isConnected(profile):
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	395 log.debug(u"Disconnecting profile because of session stop")
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	396 self.host.disconnect(profile)
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	397 self.auth_sessions.profileDelUnique(profile)
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	398 try:
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	399 self._entities_cache[profile]
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	400 except KeyError:
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	401 log.warning(u"Profile was not in cache")
35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	402
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	403 def _isSessionStarted(self, profile_key):
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	404 return self.isSessionStarted(self.getProfileName(profile_key))
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	405
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	406 def isSessionStarted(self, profile):
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	407 try:
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	408 # XXX: if the value in self._entities_cache is a Deferred,
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	409 # the session is starting but not started yet
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	410 return not isinstance(self._entities_cache[profile], defer.Deferred)
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	411 except KeyError:
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	412 return False
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	413
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	414 def profileAuthenticate(self, password, profile):
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	415 """Authenticate the profile.
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	416
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	417 @param password (unicode): the SàT profile password
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	418 @param profile: %(doc_profile)s
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	419 @return (D): a deferred None in case of success, a failure otherwise.
1693 35426d58471c core (memory): stopSession implementation Goffi <goffi@goffi.org> parents: 1689 diff changeset	420 @raise exceptions.PasswordError: the password does not match
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	421 """
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	422 session_data = self.auth_sessions.profileGetUnique(profile)
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	423 if not password and session_data:
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	424 # XXX: this allows any frontend to connect with the empty password as soon as
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	425 # the profile has been authenticated at least once before. It is OK as long as
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	426 # submitting a form with empty passwords is restricted to local frontends.
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	427 return defer.succeed(None)
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	428
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	429 def check_result(result):
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	430 if not result:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	431 log.warning(u"Authentication failure of profile {}".format(profile))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	432 raise failure.Failure(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	433 exceptions.PasswordError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	434 u"The provided profile password doesn't match."
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	435 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	436 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	437 if (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	438 not session_data
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	439 ): # avoid to create two profile sessions when password if specified
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	440 return self.newAuthSession(password, profile)
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	441
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	442 d = self.asyncGetParamA(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	443 C.PROFILE_PASS_PATH[1], C.PROFILE_PASS_PATH[0], profile_key=profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	444 )
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	445 d.addCallback(lambda sat_cipher: PasswordHasher.verify(password, sat_cipher))
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 return d.addCallback(check_result)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	447
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	448 def newAuthSession(self, key, profile):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	449 """Start a new session for the authenticated profile.
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	450
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	451 The personal key is loaded encrypted from a PersistentDict before being decrypted.
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	452
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	453 @param key: the key to decrypt the personal key
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	454 @param profile: %(doc_profile)s
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	455 @return: a deferred None value
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	456 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	457
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	458 def gotPersonalKey(personal_key):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	459 """Create the session for this profile and store the personal key"""
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	460 self.auth_sessions.newSession(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	461 {C.MEMORY_CRYPTO_KEY: personal_key}, profile=profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	462 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	463 log.debug(u"auth session created for profile %s" % profile)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	464
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	465 d = PersistentDict(C.MEMORY_CRYPTO_NAMESPACE, profile).load()
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	466 d.addCallback(lambda data: BlockCipher.decrypt(key, data[C.MEMORY_CRYPTO_KEY]))
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	467 return d.addCallback(gotPersonalKey)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	468
484 23cbdf0a0777 core: presence status + last resource refactored and kept in entitiesCache in memory.py, profile cache is purged on disconnection Goffi <goffi@goffi.org> parents: 480 diff changeset	469 def purgeProfileSession(self, profile):
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	470 """Delete cache of data of profile
32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	471 @param profile: %(doc_profile)s"""
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 946 diff changeset	472 log.info(_("[%s] Profile session purge" % profile))
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	473 self.params.purgeProfile(profile)
484 23cbdf0a0777 core: presence status + last resource refactored and kept in entitiesCache in memory.py, profile cache is purged on disconnection Goffi <goffi@goffi.org> parents: 480 diff changeset	474 try:
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	475 del self._entities_cache[profile]
484 23cbdf0a0777 core: presence status + last resource refactored and kept in entitiesCache in memory.py, profile cache is purged on disconnection Goffi <goffi@goffi.org> parents: 480 diff changeset	476 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	477 log.error(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	478 _(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	479 u"Trying to purge roster status cache for a profile not in memory: [%s]"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	480 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	481 % profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	482 )
484 23cbdf0a0777 core: presence status + last resource refactored and kept in entitiesCache in memory.py, profile cache is purged on disconnection Goffi <goffi@goffi.org> parents: 480 diff changeset	483
2146 1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	484 def getProfilesList(self, clients=True, components=False):
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	485 """retrieve profiles list
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	486
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	487 @param clients(bool): if True return clients profiles
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	488 @param components(bool): if True return components profiles
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	489 @return (list[unicode]): selected profiles
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	490 """
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	491 if not clients and not components:
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	492 log.warning(_(u"requesting no profiles at all"))
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	493 return []
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	494 profiles = self.storage.getProfilesList()
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	495 if clients and components:
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	496 return sorted(profiles)
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	497 isComponent = self.storage.profileIsComponent
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	498 if clients:
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	499 p_filter = lambda p: not isComponent(p)
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	500 else:
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	501 p_filter = lambda p: isComponent(p)
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	502
1bb9bf1b4150 core, frontends: getProfilesList renamed to profilesGetList + behaviour change: Goffi <goffi@goffi.org> parents: 2144 diff changeset	503 return sorted(p for p in profiles if p_filter(p))
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	504
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	505 def getProfileName(self, profile_key, return_profile_keys=False):
62 93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 61 diff changeset	506 """Return name of profile from keyword
1263 cfd636203e8f core: misc improvments: Goffi <goffi@goffi.org> parents: 1258 diff changeset	507
1519 fbe86b5d156f core (memory, params): minor docstrings updates Goffi <goffi@goffi.org> parents: 1474 diff changeset	508 @param profile_key: can be the profile name or a keyword (like @DEFAULT@)
1263 cfd636203e8f core: misc improvments: Goffi <goffi@goffi.org> parents: 1258 diff changeset	509 @param return_profile_keys: if True, return unmanaged profile keys (like "@ALL@"). This keys must be managed by the caller
1519 fbe86b5d156f core (memory, params): minor docstrings updates Goffi <goffi@goffi.org> parents: 1474 diff changeset	510 @return: requested profile name
1460 c7fd121a6180 core: getProfileName no raise ProfileUnknownError + minor doc fixes Goffi <goffi@goffi.org> parents: 1447 diff changeset	511 @raise exceptions.ProfileUnknownError if profile doesn't exists
1263 cfd636203e8f core: misc improvments: Goffi <goffi@goffi.org> parents: 1258 diff changeset	512 """
728 e07afabc4a25 plugin XEP-0050: Ad-Hoc commands first draft (answering part) Goffi <goffi@goffi.org> parents: 722 diff changeset	513 return self.params.getProfileName(profile_key, return_profile_keys)
62 93cb45a7420f SàT multi-profile: connection using profiles Goffi <goffi@goffi.org> parents: 61 diff changeset	514
1595 a3d0cfa5b7a6 core, bridge: added a profileSetDefault method Goffi <goffi@goffi.org> parents: 1591 diff changeset	515 def profileSetDefault(self, profile):
a3d0cfa5b7a6 core, bridge: added a profileSetDefault method Goffi <goffi@goffi.org> parents: 1591 diff changeset	516 """Set default profile
a3d0cfa5b7a6 core, bridge: added a profileSetDefault method Goffi <goffi@goffi.org> parents: 1591 diff changeset	517
a3d0cfa5b7a6 core, bridge: added a profileSetDefault method Goffi <goffi@goffi.org> parents: 1591 diff changeset	518 @param profile: %(doc_profile)s
a3d0cfa5b7a6 core, bridge: added a profileSetDefault method Goffi <goffi@goffi.org> parents: 1591 diff changeset	519 """
a3d0cfa5b7a6 core, bridge: added a profileSetDefault method Goffi <goffi@goffi.org> parents: 1591 diff changeset	520 # we want to be sure that the profile exists
a3d0cfa5b7a6 core, bridge: added a profileSetDefault method Goffi <goffi@goffi.org> parents: 1591 diff changeset	521 profile = self.getProfileName(profile)
a3d0cfa5b7a6 core, bridge: added a profileSetDefault method Goffi <goffi@goffi.org> parents: 1591 diff changeset	522
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	523 self.memory_data["Profile_default"] = profile
1595 a3d0cfa5b7a6 core, bridge: added a profileSetDefault method Goffi <goffi@goffi.org> parents: 1591 diff changeset	524
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	525 def createProfile(self, name, password, component=None):
420 acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	526 """Create a new profile
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	527
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	528 @param name(unicode): profile name
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	529 @param password(unicode): profile password
1695 5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	530 Can be empty to disable password
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	531 @param component(None, unicode): set to entry point if this is a component
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	532 @return: Deferred
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	533 @raise exceptions.NotFound: component is not a known plugin import name
420 acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	534 """
1263 cfd636203e8f core: misc improvments: Goffi <goffi@goffi.org> parents: 1258 diff changeset	535 if not name:
2052 d44efd32bc2f core: line feed (\n) are now forbidden in profile names Goffi <goffi@goffi.org> parents: 2013 diff changeset	536 raise ValueError(u"Empty profile name")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	537 if name[0] == "@":
2052 d44efd32bc2f core: line feed (\n) are now forbidden in profile names Goffi <goffi@goffi.org> parents: 2013 diff changeset	538 raise ValueError(u"A profile name can't start with a '@'")
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	539 if "\n" in name:
2052 d44efd32bc2f core: line feed (\n) are now forbidden in profile names Goffi <goffi@goffi.org> parents: 2013 diff changeset	540 raise ValueError(u"A profile name can't contain line feed ('\\n')")
1682 61391d863709 plugin XEP-0054: fixed vcard-update callback which was updating avatar when hash was empty, resulting in a really slow start Goffi <goffi@goffi.org> parents: 1652 diff changeset	541
1695 5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	542 if name in self._entities_cache:
5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	543 raise exceptions.ConflictError(u"A session for this profile exists")
5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	544
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	545 if component:
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	546 if not component in self.host.plugins:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	547 raise exceptions.NotFound(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	548 _(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	549 u"Can't find component {component} entry point".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	550 component=component
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	551 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	552 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	553 )
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	554 # FIXME: PLUGIN_INFO is not currently accessible after import, but type shoul be tested here
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	555 # if self.host.plugins[component].PLUGIN_INFO[u"type"] != C.PLUG_TYPE_ENTRY_POINT:
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	556 # raise ValueError(_(u"Plugin {component} is not an entry point !".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	557 # component = component)))
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	558
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	559 d = self.params.createProfile(name, component)
1682 61391d863709 plugin XEP-0054: fixed vcard-update callback which was updating avatar when hash was empty, resulting in a really slow start Goffi <goffi@goffi.org> parents: 1652 diff changeset	560
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	561 def initPersonalKey(__):
1652 fd7f41d8cbdf memory: fixes asyncCreateProfile to not overwrite the personal key souliane <souliane@mailoo.org> parents: 1595 diff changeset	562 # be sure to call this after checking that the profile doesn't exist yet
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	563 personal_key = BlockCipher.getRandomKey(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	564 base64=True
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	565 ) # generated once for all and saved in a PersistentDict
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	566 self.auth_sessions.newSession(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	567 {C.MEMORY_CRYPTO_KEY: personal_key}, profile=name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	568 ) # will be encrypted by setParam
1652 fd7f41d8cbdf memory: fixes asyncCreateProfile to not overwrite the personal key souliane <souliane@mailoo.org> parents: 1595 diff changeset	569
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	570 def startFakeSession(__):
1695 5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	571 # avoid ProfileNotConnected exception in setParam
5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	572 self._entities_cache[name] = None
5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	573 self.params.loadIndParams(name)
5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	574
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	575 def stopFakeSession(__):
1695 5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	576 del self._entities_cache[name]
5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	577 self.params.purgeProfile(name)
5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	578
1652 fd7f41d8cbdf memory: fixes asyncCreateProfile to not overwrite the personal key souliane <souliane@mailoo.org> parents: 1595 diff changeset	579 d.addCallback(initPersonalKey)
1695 5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	580 d.addCallback(startFakeSession)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	581 d.addCallback(
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	582 lambda __: self.setParam(
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	583 C.PROFILE_PASS_PATH[1], password, C.PROFILE_PASS_PATH[0], profile_key=name
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	584 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	585 )
1695 5a93f13c1e76 core (memory): asyncCreateProfile fix: a fake session is created to set general password param Goffi <goffi@goffi.org> parents: 1694 diff changeset	586 d.addCallback(stopFakeSession)
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	587 d.addCallback(lambda __: self.auth_sessions.profileDelUnique(name))
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	588 return d
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	589
894 57c32d8ec847 core (memory): asyncDeleteProfile can force the deletion of a profile, even if it's connected (when called from the backend only) souliane <souliane@mailoo.org> parents: 893 diff changeset	590 def asyncDeleteProfile(self, name, force=False):
68 9b842086d915 multiple profiles update Goffi <goffi@goffi.org> parents: 66 diff changeset	591 """Delete an existing profile
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	592
894 57c32d8ec847 core (memory): asyncDeleteProfile can force the deletion of a profile, even if it's connected (when called from the backend only) souliane <souliane@mailoo.org> parents: 893 diff changeset	593 @param name: Name of the profile
57c32d8ec847 core (memory): asyncDeleteProfile can force the deletion of a profile, even if it's connected (when called from the backend only) souliane <souliane@mailoo.org> parents: 893 diff changeset	594 @param force: force the deletion even if the profile is connected.
57c32d8ec847 core (memory): asyncDeleteProfile can force the deletion of a profile, even if it's connected (when called from the backend only) souliane <souliane@mailoo.org> parents: 893 diff changeset	595 To be used for direct calls only (not through the bridge).
57c32d8ec847 core (memory): asyncDeleteProfile can force the deletion of a profile, even if it's connected (when called from the backend only) souliane <souliane@mailoo.org> parents: 893 diff changeset	596 @return: a Deferred instance
57c32d8ec847 core (memory): asyncDeleteProfile can force the deletion of a profile, even if it's connected (when called from the backend only) souliane <souliane@mailoo.org> parents: 893 diff changeset	597 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	598
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	599 def cleanMemory(__):
1704 292f9c2712f2 core (memory): fixed bad memory cleaning on asyncDeleteProfile Goffi <goffi@goffi.org> parents: 1695 diff changeset	600 self.auth_sessions.profileDelUnique(name)
292f9c2712f2 core (memory): fixed bad memory cleaning on asyncDeleteProfile Goffi <goffi@goffi.org> parents: 1695 diff changeset	601 try:
292f9c2712f2 core (memory): fixed bad memory cleaning on asyncDeleteProfile Goffi <goffi@goffi.org> parents: 1695 diff changeset	602 del self._entities_cache[name]
292f9c2712f2 core (memory): fixed bad memory cleaning on asyncDeleteProfile Goffi <goffi@goffi.org> parents: 1695 diff changeset	603 except KeyError:
292f9c2712f2 core (memory): fixed bad memory cleaning on asyncDeleteProfile Goffi <goffi@goffi.org> parents: 1695 diff changeset	604 pass
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	605
1704 292f9c2712f2 core (memory): fixed bad memory cleaning on asyncDeleteProfile Goffi <goffi@goffi.org> parents: 1695 diff changeset	606 d = self.params.asyncDeleteProfile(name, force)
292f9c2712f2 core (memory): fixed bad memory cleaning on asyncDeleteProfile Goffi <goffi@goffi.org> parents: 1695 diff changeset	607 d.addCallback(cleanMemory)
292f9c2712f2 core (memory): fixed bad memory cleaning on asyncDeleteProfile Goffi <goffi@goffi.org> parents: 1695 diff changeset	608 return d
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	609
2144 1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	610 def isComponent(self, profile_name):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	611 """Tell if a profile is a component
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	612
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	613 @param profile_name(unicode): name of the profile
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	614 @return (bool): True if profile is a component
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	615 @raise exceptions.NotFound: profile doesn't exist
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	616 """
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	617 return self.storage.profileIsComponent(profile_name)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	618
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	619 def getEntryPoint(self, profile_name):
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	620 """Get a component entry point
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	621
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	622 @param profile_name(unicode): name of the profile
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	623 @return (bool): True if profile is a component
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	624 @raise exceptions.NotFound: profile doesn't exist
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	625 """
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	626 return self.storage.getEntryPoint(profile_name)
1d3f73e065e1 core, jp: component handling + client handling refactoring: Goffi <goffi@goffi.org> parents: 2052 diff changeset	627
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	628 ## History ##
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	629
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	630 def addToHistory(self, client, data):
633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	631 return self.storage.addToHistory(data, client.profile)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	632
2698 5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2624 diff changeset	633 def _historyGet(self, from_jid_s, to_jid_s, limit=C.HISTORY_LIMIT_NONE, between=True,
5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2624 diff changeset	634 filters=None, profile=C.PROF_KEY_NONE):
5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2624 diff changeset	635 return self.historyGet(jid.JID(from_jid_s), jid.JID(to_jid_s), limit, between,
5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2624 diff changeset	636 filters, profile)
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	637
2698 5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2624 diff changeset	638 def historyGet(self, from_jid, to_jid, limit=C.HISTORY_LIMIT_NONE, between=True,
5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2624 diff changeset	639 filters=None, profile=C.PROF_KEY_NONE):
1222 e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	640 """Retrieve messages in history
1955 633b5c21aefd backend, frontend: messages refactoring (huge commit, not finished): Goffi <goffi@goffi.org> parents: 1934 diff changeset	641
1222 e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	642 @param from_jid (JID): source JID (full, or bare for catchall)
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	643 @param to_jid (JID): dest JID (full, or bare for catchall)
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	644 @param limit (int): maximum number of messages to get:
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	645 - 0 for no message (returns the empty list)
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	646 - C.HISTORY_LIMIT_NONE or None for unlimited
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	647 - C.HISTORY_LIMIT_DEFAULT to use the HISTORY_LIMIT parameter value
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	648 @param between (bool): confound source and dest (ignore the direction)
2698 5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2624 diff changeset	649 @param filters (dict[unicode, unicode]): pattern to filter the history results
5060cbeec01e core: minor style/typos fixes Goffi <goffi@goffi.org> parents: 2624 diff changeset	650 (see bridge API for details)
1222 e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	651 @param profile (str): %(doc_profile)s
1963 a2bc5089c2eb backend, frontends: message refactoring (huge commit): Goffi <goffi@goffi.org> parents: 1955 diff changeset	652 @return (D(list)): list of message data as in [messageNew]
1222 e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	653 """
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	654 assert profile != C.PROF_KEY_NONE
1222 e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	655 if limit == C.HISTORY_LIMIT_DEFAULT:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	656 limit = int(self.getParamA(C.HISTORY_LIMIT, "General", profile_key=profile))
1222 e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	657 elif limit == C.HISTORY_LIMIT_NONE:
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	658 limit = None
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	659 if limit == 0:
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1221 diff changeset	660 return defer.succeed([])
2013 b536dd121da1 backend (memory), frontends: improved history filtering: Goffi <goffi@goffi.org> parents: 1970 diff changeset	661 return self.storage.historyGet(from_jid, to_jid, limit, between, filters, profile)
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	662
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	663 ## Statuses ##
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	664
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	665 def _getPresenceStatuses(self, profile_key):
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	666 ret = self.getPresenceStatuses(profile_key)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	667 return {entity.full(): data for entity, data in ret.iteritems()}
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	668
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	669 def getPresenceStatuses(self, profile_key):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	670 """Get all the presence statuses of a profile
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	671
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	672 @param profile_key: %(doc_profile_key)s
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	673 @return: presence data: key=entity JID, value=presence data for this entity
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	674 """
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	675 client = self.host.getClient(profile_key)
8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	676 profile_cache = self._getProfileCache(client)
484 23cbdf0a0777 core: presence status + last resource refactored and kept in entitiesCache in memory.py, profile cache is purged on disconnection Goffi <goffi@goffi.org> parents: 480 diff changeset	677 entities_presence = {}
23cbdf0a0777 core: presence status + last resource refactored and kept in entitiesCache in memory.py, profile cache is purged on disconnection Goffi <goffi@goffi.org> parents: 480 diff changeset	678
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	679 for entity_jid, entity_data in profile_cache.iteritems():
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	680 for resource, resource_data in entity_data.iteritems():
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	681 full_jid = copy.copy(entity_jid)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	682 full_jid.resource = resource
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	683 try:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	684 presence_data = self.getEntityDatum(full_jid, "presence", profile_key)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	685 except KeyError:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	686 continue
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	687 entities_presence.setdefault(entity_jid, {})[
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	688 resource or ""
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	689 ] = presence_data
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	690
484 23cbdf0a0777 core: presence status + last resource refactored and kept in entitiesCache in memory.py, profile cache is purged on disconnection Goffi <goffi@goffi.org> parents: 480 diff changeset	691 return entities_presence
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	692
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	693 def setPresenceStatus(self, entity_jid, show, priority, statuses, profile_key):
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	694 """Change the presence status of an entity
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	695
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	696 @param entity_jid: jid.JID of the entity
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	697 @param show: show status
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	698 @param priority: priority
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	699 @param statuses: dictionary of statuses
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	700 @param profile_key: %(doc_profile_key)s
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	701 """
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	702 presence_data = PresenceTuple(show, priority, statuses)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	703 self.updateEntityData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	704 entity_jid, "presence", presence_data, profile_key=profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	705 )
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	706 if entity_jid.resource and show != C.PRESENCE_UNAVAILABLE:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	707 # If a resource is available, bare jid should not have presence information
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	708 try:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	709 self.delEntityDatum(entity_jid.userhostJID(), "presence", profile_key)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	710 except (KeyError, exceptions.UnknownEntityError):
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	711 pass
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	712
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	713 ## Resources ##
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	714
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	715 def _getAllResource(self, jid_s, profile_key):
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	716 client = self.host.getClient(profile_key)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	717 jid_ = jid.JID(jid_s)
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	718 return self.getAllResources(client, jid_)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	719
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	720 def getAllResources(self, client, entity_jid):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	721 """Return all resource from jid for which we have had data in this session
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	722
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	723 @param entity_jid: bare jid of the entity
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	724 return (list[unicode]): list of resources
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	725
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	726 @raise exceptions.UnknownEntityError: if entity is not in cache
1689 a40124e03baf core (memory): catch exceptions.UnknownEntityError in getMainResource Goffi <goffi@goffi.org> parents: 1684 diff changeset	727 @raise ValueError: entity_jid has a resource
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	728 """
2597 9446f1ea9eac core: discoFindByFeatures now return only available resources Goffi <goffi@goffi.org> parents: 2562 diff changeset	729 # FIXME: is there a need to keep cache data for resources which are not connected anymore?
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	730 if entity_jid.resource:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	731 raise ValueError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	732 "getAllResources must be used with a bare jid (got {})".format(entity_jid)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	733 )
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	734 profile_cache = self._getProfileCache(client)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	735 try:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	736 entity_data = profile_cache[entity_jid.userhostJID()]
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	737 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	738 raise exceptions.UnknownEntityError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	739 u"Entity {} not in cache".format(entity_jid)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	740 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	741 resources = set(entity_data.keys())
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	742 resources.discard(None)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	743 return resources
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	744
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	745 def getAvailableResources(self, client, entity_jid):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	746 """Return available resource for entity_jid
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	747
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	748 This method differs from getAllResources by returning only available resources
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	749 @param entity_jid: bare jid of the entit
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	750 return (list[unicode]): list of available resources
1251 51a85e8f599a memory: add method isContactConnected souliane <souliane@mailoo.org> parents: 1247 diff changeset	751
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	752 @raise exceptions.UnknownEntityError: if entity is not in cache
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	753 """
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	754 available = []
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	755 for resource in self.getAllResources(client, entity_jid):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	756 full_jid = copy.copy(entity_jid)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	757 full_jid.resource = resource
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	758 try:
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	759 presence_data = self.getEntityDatum(full_jid, "presence", client.profile)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	760 except KeyError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	761 log.debug(u"Can't get presence data for {}".format(full_jid))
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	762 else:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	763 if presence_data.show != C.PRESENCE_UNAVAILABLE:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	764 available.append(resource)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	765 return available
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	766
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	767 def _getMainResource(self, jid_s, profile_key):
1970 200cd707a46d plugin XEP-0045, quick_frontend + primitivus (chat): cleaning of XEP-0045 (first pass): Goffi <goffi@goffi.org> parents: 1963 diff changeset	768 client = self.host.getClient(profile_key)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	769 jid_ = jid.JID(jid_s)
1970 200cd707a46d plugin XEP-0045, quick_frontend + primitivus (chat): cleaning of XEP-0045 (first pass): Goffi <goffi@goffi.org> parents: 1963 diff changeset	770 return self.getMainResource(client, jid_) or ""
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	771
1970 200cd707a46d plugin XEP-0045, quick_frontend + primitivus (chat): cleaning of XEP-0045 (first pass): Goffi <goffi@goffi.org> parents: 1963 diff changeset	772 def getMainResource(self, client, entity_jid):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	773 """Return the main resource used by an entity
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	774
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	775 @param entity_jid: bare entity jid
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	776 @return (unicode): main resource or None
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	777 """
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	778 if entity_jid.resource:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	779 raise ValueError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	780 "getMainResource must be used with a bare jid (got {})".format(entity_jid)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	781 )
1392 c7082457d03f memory, plugin XEP-0045: getMainResource returns None when asking a MUC entity + fixes /whois on a MUC (bare) entity souliane <souliane@mailoo.org> parents: 1375 diff changeset	782 try:
1970 200cd707a46d plugin XEP-0045, quick_frontend + primitivus (chat): cleaning of XEP-0045 (first pass): Goffi <goffi@goffi.org> parents: 1963 diff changeset	783 if self.host.plugins["XEP-0045"].isJoinedRoom(client, entity_jid):
1392 c7082457d03f memory, plugin XEP-0045: getMainResource returns None when asking a MUC entity + fixes /whois on a MUC (bare) entity souliane <souliane@mailoo.org> parents: 1375 diff changeset	784 return None # MUC rooms have no main resource
c7082457d03f memory, plugin XEP-0045: getMainResource returns None when asking a MUC entity + fixes /whois on a MUC (bare) entity souliane <souliane@mailoo.org> parents: 1375 diff changeset	785 except KeyError: # plugin not found
c7082457d03f memory, plugin XEP-0045: getMainResource returns None when asking a MUC entity + fixes /whois on a MUC (bare) entity souliane <souliane@mailoo.org> parents: 1375 diff changeset	786 pass
1689 a40124e03baf core (memory): catch exceptions.UnknownEntityError in getMainResource Goffi <goffi@goffi.org> parents: 1684 diff changeset	787 try:
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	788 resources = self.getAllResources(client, entity_jid)
1689 a40124e03baf core (memory): catch exceptions.UnknownEntityError in getMainResource Goffi <goffi@goffi.org> parents: 1684 diff changeset	789 except exceptions.UnknownEntityError:
a40124e03baf core (memory): catch exceptions.UnknownEntityError in getMainResource Goffi <goffi@goffi.org> parents: 1684 diff changeset	790 log.warning(u"Entity is not in cache, we can't find any resource")
a40124e03baf core (memory): catch exceptions.UnknownEntityError in getMainResource Goffi <goffi@goffi.org> parents: 1684 diff changeset	791 return None
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	792 priority_resources = []
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	793 for resource in resources:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	794 full_jid = copy.copy(entity_jid)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	795 full_jid.resource = resource
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	796 try:
1970 200cd707a46d plugin XEP-0045, quick_frontend + primitivus (chat): cleaning of XEP-0045 (first pass): Goffi <goffi@goffi.org> parents: 1963 diff changeset	797 presence_data = self.getEntityDatum(full_jid, "presence", client.profile)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	798 except KeyError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	799 log.debug(u"No presence information for {}".format(full_jid))
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	800 continue
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	801 priority_resources.append((resource, presence_data.priority))
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	802 try:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	803 return max(priority_resources, key=lambda res_tuple: res_tuple[1])[0]
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	804 except ValueError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	805 log.warning(u"No resource found at all for {}".format(entity_jid))
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	806 return None
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	807
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	808 ## Entities data ##
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	809
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	810 def _getProfileCache(self, client):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	811 """Check profile validity and return its cache
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	812
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	813 @param client: SatXMPPClient
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	814 @return (dict): profile cache
1251 51a85e8f599a memory: add method isContactConnected souliane <souliane@mailoo.org> parents: 1247 diff changeset	815 """
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	816 return self._entities_cache[client.profile]
1251 51a85e8f599a memory: add method isContactConnected souliane <souliane@mailoo.org> parents: 1247 diff changeset	817
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	818 def setSignalOnUpdate(self, key, signal=True):
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	819 """Set a signal flag on the key
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	820
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	821 When the key will be updated, a signal will be sent to frontends
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	822 @param key: key to signal
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	823 @param signal(boolean): if True, do the signal
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	824 """
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	825 if signal:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	826 self._key_signals.add(key)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	827 else:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	828 self._key_signals.discard(key)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	829
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	830 def getAllEntitiesIter(self, client, with_bare=False):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	831 """Return an iterator of full jids of all entities in cache
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	832
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	833 @param with_bare: if True, include bare jids
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	834 @return (list[unicode]): list of jids
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	835 """
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	836 profile_cache = self._getProfileCache(client)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	837 # we construct a list of all known full jids (bare jid of entities x resources)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	838 for bare_jid, entity_data in profile_cache.iteritems():
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	839 for resource in entity_data.iterkeys():
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	840 if resource is None:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	841 continue
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	842 full_jid = copy.copy(bare_jid)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	843 full_jid.resource = resource
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	844 yield full_jid
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	845
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	846 def updateEntityData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	847 self, entity_jid, key, value, silent=False, profile_key=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	848 ):
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	849 """Set a misc data for an entity
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	850
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	851 If key was registered with setSignalOnUpdate, a signal will be sent to frontends
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	852 @param entity_jid: JID of the entity, C.ENTITY_ALL_RESOURCES for all resources of all entities,
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	853 C.ENTITY_ALL for all entities (all resources + bare jids)
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	854 @param key: key to set (eg: "type")
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	855 @param value: value for this key (eg: "chatroom")
1682 61391d863709 plugin XEP-0054: fixed vcard-update callback which was updating avatar when hash was empty, resulting in a really slow start Goffi <goffi@goffi.org> parents: 1652 diff changeset	856 @param silent(bool): if True, doesn't send signal to frontend, even if there is a signal flag (see setSignalOnUpdate)
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	857 @param profile_key: %(doc_profile_key)s
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	858 """
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	859 client = self.host.getClient(profile_key)
8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	860 profile_cache = self._getProfileCache(client)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	861 if entity_jid in (C.ENTITY_ALL_RESOURCES, C.ENTITY_ALL):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	862 entities = self.getAllEntitiesIter(client, entity_jid == C.ENTITY_ALL)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	863 else:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	864 entities = (entity_jid,)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	865
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	866 for jid_ in entities:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	867 entity_data = profile_cache.setdefault(jid_.userhostJID(), {}).setdefault(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	868 jid_.resource, {}
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	869 )
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	870
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	871 entity_data[key] = value
1315 be3a301540c0 core (memory): updateEntityData now accept a "silent" argument to avoid sending signal to frontends when updating an attribute with "signalOnUpdate" flag. Goffi <goffi@goffi.org> parents: 1314 diff changeset	872 if key in self._key_signals and not silent:
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	873 if not isinstance(value, basestring):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	874 log.error(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	875 u"Setting a non string value ({}) for a key ({}) which has a signal flag".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	876 value, key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	877 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	878 )
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	879 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	880 self.host.bridge.entityDataUpdated(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	881 jid_.full(), key, value, self.getProfileName(profile_key)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	882 )
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	883
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	884 def delEntityDatum(self, entity_jid, key, profile_key):
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	885 """Delete a data for an entity
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	886
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	887 @param entity_jid: JID of the entity, C.ENTITY_ALL_RESOURCES for all resources of all entities,
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	888 C.ENTITY_ALL for all entities (all resources + bare jids)
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	889 @param key: key to delete (eg: "type")
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	890 @param profile_key: %(doc_profile_key)s
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	891
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	892 @raise exceptions.UnknownEntityError: if entity is not in cache
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	893 @raise KeyError: key is not in cache
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	894 """
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	895 client = self.host.getClient(profile_key)
8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	896 profile_cache = self._getProfileCache(client)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	897 if entity_jid in (C.ENTITY_ALL_RESOURCES, C.ENTITY_ALL):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	898 entities = self.getAllEntitiesIter(client, entity_jid == C.ENTITY_ALL)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	899 else:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	900 entities = (entity_jid,)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	901
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	902 for jid_ in entities:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	903 try:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	904 entity_data = profile_cache[jid_.userhostJID()][jid_.resource]
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	905 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	906 raise exceptions.UnknownEntityError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	907 u"Entity {} not in cache".format(jid_)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	908 )
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	909 try:
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	910 del entity_data[key]
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	911 except KeyError as e:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	912 if entity_jid in (C.ENTITY_ALL_RESOURCES, C.ENTITY_ALL):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	913 continue # we ignore KeyError when deleting keys from several entities
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	914 else:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	915 raise e
399 3ed53803b3b3 core: added getLastResource method Goffi <goffi@goffi.org> parents: 398 diff changeset	916
1314 bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	917 def _getEntitiesData(self, entities_jids, keys_list, profile_key):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	918 ret = self.getEntitiesData(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	919 [jid.JID(jid_) for jid_ in entities_jids], keys_list, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	920 )
1314 bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	921 return {jid_.full(): data for jid_, data in ret.iteritems()}
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	922
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	923 def getEntitiesData(self, entities_jids, keys_list=None, profile_key=C.PROF_KEY_NONE):
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	924 """Get a list of cached values for several entities at once
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	925
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	926 @param entities_jids: jids of the entities, or empty list for all entities in cache
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	927 @param keys_list (iterable,None): list of keys to get, None for everything
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	928 @param profile_key: %(doc_profile_key)s
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	929 @return: dict withs values for each key in keys_list.
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	930 if there is no value of a given key, resulting dict will
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	931 have nothing with that key nether
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	932 if an entity doesn't exist in cache, it will not appear
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	933 in resulting dict
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	934
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	935 @raise exceptions.UnknownEntityError: if entity is not in cache
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	936 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	937
1314 bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	938 def fillEntityData(entity_cache_data):
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	939 entity_data = {}
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	940 if keys_list is None:
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	941 entity_data = entity_cache_data
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	942 else:
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	943 for key in keys_list:
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	944 try:
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	945 entity_data[key] = entity_cache_data[key]
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	946 except KeyError:
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	947 continue
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	948 return entity_data
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	949
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	950 client = self.host.getClient(profile_key)
8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	951 profile_cache = self._getProfileCache(client)
1314 bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	952 ret_data = {}
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	953 if entities_jids:
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	954 for entity in entities_jids:
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	955 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	956 entity_cache_data = profile_cache[entity.userhostJID()][
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	957 entity.resource
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	958 ]
1314 bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	959 except KeyError:
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	960 continue
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	961 ret_data[entity.full()] = fillEntityData(entity_cache_data, keys_list)
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	962 else:
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	963 for bare_jid, data in profile_cache.iteritems():
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	964 for resource, entity_cache_data in data.iteritems():
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	965 full_jid = copy.copy(bare_jid)
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	966 full_jid.resource = resource
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	967 ret_data[full_jid] = fillEntityData(entity_cache_data)
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	968
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	969 return ret_data
bb9c32249778 core: added getEntitiesData which get cache data for several entities at once Goffi <goffi@goffi.org> parents: 1290 diff changeset	970
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	971 def getEntityData(self, entity_jid, keys_list=None, profile_key=C.PROF_KEY_NONE):
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	972 """Get a list of cached values for entity
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	973
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	974 @param entity_jid: JID of the entity
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	975 @param keys_list (iterable,None): list of keys to get, None for everything
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	976 @param profile_key: %(doc_profile_key)s
0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	977 @return: dict withs values for each key in keys_list.
504 65ecbb473cbb core, quick frontend, plugin xep-0054, bridge: use of memory's entities data for vcard: Goffi <goffi@goffi.org> parents: 494 diff changeset	978 if there is no value of a given key, resulting dict will
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	979 have nothing with that key nether
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	980
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	981 @raise exceptions.UnknownEntityError: if entity is not in cache
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	982 """
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	983 client = self.host.getClient(profile_key)
8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	984 profile_cache = self._getProfileCache(client)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	985 try:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	986 entity_data = profile_cache[entity_jid.userhostJID()][entity_jid.resource]
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	987 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	988 raise exceptions.UnknownEntityError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	989 u"Entity {} not in cache (was requesting {})".format(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	990 entity_jid, keys_list
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	991 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	992 )
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	993 if keys_list is None:
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	994 return entity_data
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	995
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	996 return {key: entity_data[key] for key in keys_list if key in entity_data}
47 9aa2d9dd4045 memory methods improvement Goffi <goffi@goffi.org> parents: 41 diff changeset	997
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	998 def getEntityDatum(self, entity_jid, key, profile_key):
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	999 """Get a datum from entity
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1000
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1001 @param entity_jid: JID of the entity
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1002 @param keys: key to get
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1003 @param profile_key: %(doc_profile_key)s
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1004 @return: requested value
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1005
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1006 @raise exceptions.UnknownEntityError: if entity is not in cache
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1007 @raise KeyError: if there is no value for this key and this entity
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1008 """
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1009 return self.getEntityData(entity_jid, (key,), profile_key)[key]
e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 943 diff changeset	1010
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1011 def delEntityCache(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1012 self, entity_jid, delete_all_resources=True, profile_key=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1013 ):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1014 """Remove all cached data for entity
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1015
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	1016 @param entity_jid: JID of the entity to delete
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1017 @param delete_all_resources: if True also delete all known resources from cache (a bare jid must be given in this case)
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	1018 @param profile_key: %(doc_profile_key)s
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1019
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1020 @raise exceptions.UnknownEntityError: if entity is not in cache
507 f98bef71a918 frontends, core, plugin XEP-0045: leave implementation + better nick change Goffi <goffi@goffi.org> parents: 504 diff changeset	1021 """
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	1022 client = self.host.getClient(profile_key)
8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	1023 profile_cache = self._getProfileCache(client)
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	1024
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	1025 if delete_all_resources:
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	1026 if entity_jid.resource:
71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	1027 raise ValueError(_("Need a bare jid to delete all resources"))
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1028 try:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1029 del profile_cache[entity_jid]
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1030 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1031 raise exceptions.UnknownEntityError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1032 u"Entity {} not in cache".format(entity_jid)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1033 )
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1034 else:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1035 try:
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1036 del profile_cache[entity_jid.userhostJID()][entity_jid.resource]
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1037 except KeyError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1038 raise exceptions.UnknownEntityError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1039 u"Entity {} not in cache".format(entity_jid)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1040 )
943 71926ec2114d core (memory): entities cache improvments: Goffi <goffi@goffi.org> parents: 935 diff changeset	1041
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1042 ## Encryption ##
507 f98bef71a918 frontends, core, plugin XEP-0045: leave implementation + better nick change Goffi <goffi@goffi.org> parents: 504 diff changeset	1043
1090 594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1044 def encryptValue(self, value, profile):
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1045 """Encrypt a value for the given profile. The personal key must be loaded
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1046 already in the profile session, that should be the case if the profile is
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1047 already authenticated.
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1048
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1049 @param value (str): the value to encrypt
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1050 @param profile (str): %(doc_profile)s
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1051 @return: the deferred encrypted value
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1052 """
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1053 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1054 personal_key = self.auth_sessions.profileGetUnique(profile)[
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1055 C.MEMORY_CRYPTO_KEY
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1056 ]
1090 594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1057 except TypeError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1058 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1059 _("Trying to encrypt a value for %s while the personal key is undefined!")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1060 % profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1061 )
1090 594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1062 return BlockCipher.encrypt(personal_key, value)
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1063
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1064 def decryptValue(self, value, profile):
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1065 """Decrypt a value for the given profile. The personal key must be loaded
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1066 already in the profile session, that should be the case if the profile is
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1067 already authenticated.
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1068
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1069 @param value (str): the value to decrypt
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1070 @param profile (str): %(doc_profile)s
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1071 @return: the deferred decrypted value
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1072 """
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1073 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1074 personal_key = self.auth_sessions.profileGetUnique(profile)[
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1075 C.MEMORY_CRYPTO_KEY
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1076 ]
1090 594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1077 except TypeError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1078 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1079 _("Trying to decrypt a value for %s while the personal key is undefined!")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1080 % profile
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1081 )
1090 594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1082 return BlockCipher.decrypt(personal_key, value)
594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1064 diff changeset	1083
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1084 def encryptPersonalData(self, data_key, data_value, crypto_key, profile):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1085 """Re-encrypt a personal data (saved to a PersistentDict).
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1086
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1087 @param data_key: key for the individual PersistentDict instance
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1088 @param data_value: the value to be encrypted
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1089 @param crypto_key: the key to encrypt the value
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1090 @param profile: %(profile_doc)s
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1091 @return: a deferred None value
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1092 """
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1093
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1094 def gotIndMemory(data):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1095 d = BlockCipher.encrypt(crypto_key, data_value)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1096
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1097 def cb(cipher):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1098 data[data_key] = cipher
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1099 return data.force(data_key)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1100
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1101 return d.addCallback(cb)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1102
2765 378188abe941 misc: replaced all "dummy" by the more conventional and readable "__" ("_" being used for gettext) Goffi <goffi@goffi.org> parents: 2698 diff changeset	1103 def done(__):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1104 log.debug(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1105 _(u"Personal data (%(ns)s, %(key)s) has been successfuly encrypted")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1106 % {"ns": C.MEMORY_CRYPTO_NAMESPACE, "key": data_key}
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1107 )
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1108
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1109 d = PersistentDict(C.MEMORY_CRYPTO_NAMESPACE, profile).load()
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1110 return d.addCallback(gotIndMemory).addCallback(done)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1029 diff changeset	1111
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1112 ## Subscription requests ##
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1113
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	1114 def addWaitingSub(self, type_, entity_jid, profile_key):
47 9aa2d9dd4045 memory methods improvement Goffi <goffi@goffi.org> parents: 41 diff changeset	1115 """Called when a subcription request is received"""
65 d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	1116 profile = self.getProfileName(profile_key)
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1117 assert profile
e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1118 if profile not in self.subscriptions:
65 d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	1119 self.subscriptions[profile] = {}
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	1120 self.subscriptions[profile][entity_jid] = type_
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1121
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	1122 def delWaitingSub(self, entity_jid, profile_key):
47 9aa2d9dd4045 memory methods improvement Goffi <goffi@goffi.org> parents: 41 diff changeset	1123 """Called when a subcription request is finished"""
65 d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	1124 profile = self.getProfileName(profile_key)
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1125 assert profile
e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1126 if profile in self.subscriptions and entity_jid in self.subscriptions[profile]:
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	1127 del self.subscriptions[profile][entity_jid]
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1128
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: 327 diff changeset	1129 def getWaitingSub(self, profile_key):
47 9aa2d9dd4045 memory methods improvement Goffi <goffi@goffi.org> parents: 41 diff changeset	1130 """Called to get a list of currently waiting subscription requests"""
65 d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	1131 profile = self.getProfileName(profile_key)
d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	1132 if not profile:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1133 log.error(_("Asking waiting subscriptions for a non-existant profile"))
65 d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	1134 return {}
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	1135 if profile not in self.subscriptions:
65 d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	1136 return {}
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1137
65 d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	1138 return self.subscriptions[profile]
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1139
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1140 ## Parameters ##
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1141
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	1142 def getStringParamA(self, name, category, attr="value", profile_key=C.PROF_KEY_NONE):
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	1143 return self.params.getStringParamA(name, category, attr, profile_key)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1144
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	1145 def getParamA(self, name, category, attr="value", profile_key=C.PROF_KEY_NONE):
1534 a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	1146 return self.params.getParamA(name, category, attr, profile_key=profile_key)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1147
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1148 def asyncGetParamA(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1149 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1150 name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1151 category,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1152 attr="value",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1153 security_limit=C.NO_SECURITY_LIMIT,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1154 profile_key=C.PROF_KEY_NONE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1155 ):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1156 return self.params.asyncGetParamA(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1157 name, category, attr, security_limit, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1158 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1159
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1160 def asyncGetParamsValuesFromCategory(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1161 self, category, security_limit=C.NO_SECURITY_LIMIT, profile_key=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1162 ):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1163 return self.params.asyncGetParamsValuesFromCategory(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1164 category, security_limit, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1165 )
1587 698d6755d62a core, bridge (params): added asyncGetParamsValuesFromCategory (yes that's a long name!) method to retrive params names and values for a given category Goffi <goffi@goffi.org> parents: 1586 diff changeset	1166
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1167 def asyncGetStringParamA(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1168 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1169 name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1170 category,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1171 attr="value",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1172 security_limit=C.NO_SECURITY_LIMIT,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1173 profile_key=C.PROF_KEY_NONE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1174 ):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1175 return self.params.asyncGetStringParamA(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1176 name, category, attr, security_limit, profile_key
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1177 )
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1178
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1179 def getParamsUI(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1180 self, security_limit=C.NO_SECURITY_LIMIT, app="", profile_key=C.PROF_KEY_NONE
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1181 ):
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	1182 return self.params.getParamsUI(security_limit, app, profile_key)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1183
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1184 def getParamsCategories(self):
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	1185 return self.params.getParamsCategories()
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1186
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1187 def setParam(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1188 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1189 name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1190 value,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1191 category,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1192 security_limit=C.NO_SECURITY_LIMIT,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1193 profile_key=C.PROF_KEY_NONE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1194 ):
641 49587e170f53 core: added the security_limit to setParam souliane <souliane@mailoo.org> parents: 639 diff changeset	1195 return self.params.setParam(name, value, category, security_limit, profile_key)
19 f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	1196
662 4f747d7fde8c core: importParams renamed to updateParams: it now updates the parameter instead of appending children if it find an existing one. Goffi <goffi@goffi.org> parents: 656 diff changeset	1197 def updateParams(self, xml):
4f747d7fde8c core: importParams renamed to updateParams: it now updates the parameter instead of appending children if it find an existing one. Goffi <goffi@goffi.org> parents: 656 diff changeset	1198 return self.params.updateParams(xml)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	1199
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1200 def paramsRegisterApp(self, xml, security_limit=C.NO_SECURITY_LIMIT, app=""):
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	1201 return self.params.paramsRegisterApp(xml, security_limit, app)
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	1202
20 fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	1203 def setDefault(self, name, category, callback, errback=None):
fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	1204 return self.params.setDefault(name, category, callback, errback)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1205
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1206 ## Files ##
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1207
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1208 def checkFilePermission(self, file_data, peer_jid, perms_to_check):
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1209 """check that an entity has the right permission on a file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1210
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1211 @param file_data(dict): data of one file, as returned by getFiles
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1212 @param peer_jid(jid.JID): entity trying to access the file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1213 @param perms_to_check(tuple[unicode]): permissions to check
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1214 tuple of C.ACCESS_PERM_*
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1215 @param check_parents(bool): if True, also check all parents until root node
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1216 @raise exceptions.PermissionError: peer_jid doesn't have all permission
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1217 in perms_to_check for file_data
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1218 @raise exceptions.InternalError: perms_to_check is invalid
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1219 """
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1220 if peer_jid is None and perms_to_check is None:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1221 return
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1222 peer_jid = peer_jid.userhostJID()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1223 if peer_jid == file_data["owner"]:
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1224 # the owner has all rights
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1225 return
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1226 if not C.ACCESS_PERMS.issuperset(perms_to_check):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1227 raise exceptions.InternalError(_(u"invalid permission"))
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1228
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1229 for perm in perms_to_check:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1230 # we check each perm and raise PermissionError as soon as one condition is not valid
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1231 # we must never return here, we only return after the loop if nothing was blocking the access
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1232 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1233 perm_data = file_data[u"access"][perm]
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1234 perm_type = perm_data[u"type"]
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1235 except KeyError:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1236 raise failure.Failure(exceptions.PermissionError())
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1237 if perm_type == C.ACCESS_TYPE_PUBLIC:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1238 continue
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1239 elif perm_type == C.ACCESS_TYPE_WHITELIST:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1240 try:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1241 jids = perm_data[u"jids"]
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1242 except KeyError:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1243 raise failure.Failure(exceptions.PermissionError())
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1244 if peer_jid.full() in jids:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1245 continue
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1246 else:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1247 raise failure.Failure(exceptions.PermissionError())
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1248 else:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1249 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1250 _(u"unknown access type: {type}").format(type=perm_type)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1251 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1252
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1253 @defer.inlineCallbacks
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1254 def checkPermissionToRoot(self, client, file_data, peer_jid, perms_to_check):
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1255 """do checkFilePermission on file_data and all its parents until root"""
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1256 current = file_data
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1257 while True:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1258 self.checkFilePermission(current, peer_jid, perms_to_check)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1259 parent = current[u"parent"]
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1260 if not parent:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1261 break
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1262 files_data = yield self.getFile(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1263 self, client, peer_jid=None, file_id=parent, perms_to_check=None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1264 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1265 try:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1266 current = files_data[0]
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1267 except IndexError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1268 raise exceptions.DataError(u"Missing parent")
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1269
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1270 @defer.inlineCallbacks
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1271 def _getParentDir(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1272 self, client, path, parent, namespace, owner, peer_jid, perms_to_check
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1273 ):
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1274 """Retrieve parent node from a path, or last existing directory
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1275
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1276 each directory of the path will be retrieved, until the last existing one
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1277 @return (tuple[unicode, list[unicode])): parent, remaining path elements:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1278 - parent is the id of the last retrieved directory (or u'' for root)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1279 - remaining path elements are the directories which have not been retrieved
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1280 (i.e. which don't exist)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1281 """
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1282 # if path is set, we have to retrieve parent directory of the file(s) from it
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1283 if parent is not None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1284 raise exceptions.ConflictError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1285 _(u"You can't use path and parent at the same time")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1286 )
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1287 path_elts = filter(None, path.split(u"/"))
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1288 if {u"..", u"."}.intersection(path_elts):
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1289 raise ValueError(_(u'".." or "." can\'t be used in path'))
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1290
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1291 # we retrieve all directories from path until we get the parent container
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1292 # non existing directories will be created
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1293 parent = u""
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1294 for idx, path_elt in enumerate(path_elts):
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1295 directories = yield self.storage.getFiles(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1296 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1297 parent=parent,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1298 type_=C.FILE_TYPE_DIRECTORY,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1299 name=path_elt,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1300 namespace=namespace,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1301 owner=owner,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1302 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1303 if not directories:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1304 defer.returnValue((parent, path_elts[idx:]))
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1305 # from this point, directories don't exist anymore, we have to create them
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1306 elif len(directories) > 1:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1307 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1308 _(u"Several directories found, this should not happen")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1309 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1310 else:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1311 directory = directories[0]
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1312 self.checkFilePermission(directory, peer_jid, perms_to_check)
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1313 parent = directory[u"id"]
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1314 defer.returnValue((parent, []))
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1315
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1316 @defer.inlineCallbacks
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1317 def getFiles(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1318 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1319 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1320 peer_jid,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1321 file_id=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1322 version=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1323 parent=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1324 path=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1325 type_=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1326 file_hash=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1327 hash_algo=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1328 name=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1329 namespace=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1330 mime_type=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1331 owner=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1332 access=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1333 projection=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1334 unique=False,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1335 perms_to_check=(C.ACCESS_PERM_READ,),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1336 ):
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1337 """retrieve files with with given filters
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1338
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1339 @param peer_jid(jid.JID, None): jid trying to access the file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1340 needed to check permission.
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1341 Use None to ignore permission (perms_to_check must be None too)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1342 @param file_id(unicode, None): id of the file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1343 None to ignore
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1344 @param version(unicode, None): version of the file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1345 None to ignore
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1346 empty string to look for current version
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1347 @param parent(unicode, None): id of the directory containing the files
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1348 None to ignore
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1349 empty string to look for root files/directories
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1350 @param projection(list[unicode], None): name of columns to retrieve
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1351 None to retrieve all
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1352 @param unique(bool): if True will remove duplicates
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1353 @param perms_to_check(tuple[unicode],None): permission to check
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1354 must be a tuple of C.ACCESS_PERM_* or None
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1355 if None, permission will no be checked (peer_jid must be None too in this case)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1356 other params are the same as for [setFile]
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1357 @return (list[dict]): files corresponding to filters
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1358 @raise exceptions.NotFound: parent directory not found (when path is specified)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1359 @raise exceptions.PermissionError: peer_jid can't use perms_to_check for one of the file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1360 on the path
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1361 """
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1362 if peer_jid is None and perms_to_check or perms_to_check is None and peer_jid:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1363 raise exceptions.InternalError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1364 "if you want to disable permission check, both peer_jid and perms_to_check must be None"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1365 )
2518 e4de2f16a284 core (memory): use bare jid for owner in setFiles: Goffi <goffi@goffi.org> parents: 2508 diff changeset	1366 if owner is not None:
e4de2f16a284 core (memory): use bare jid for owner in setFiles: Goffi <goffi@goffi.org> parents: 2508 diff changeset	1367 owner = owner.userhostJID()
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1368 if path is not None:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1369 # permission are checked by _getParentDir
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1370 parent, remaining_path_elts = yield self._getParentDir(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1371 client, path, parent, namespace, owner, peer_jid, perms_to_check
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1372 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1373 if remaining_path_elts:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1374 # if we have remaining path elements,
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1375 # the parent directory is not found
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1376 raise failure.Failure(exceptions.NotFound())
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1377 if parent and peer_jid:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1378 # if parent is given directly and permission check is need,
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1379 # we need to check all the parents
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1380 parent_data = yield self.storage.getFiles(client, file_id=parent)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1381 try:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1382 parent_data = parent_data[0]
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1383 except IndexError:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1384 raise exceptions.DataError(u"mising parent")
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1385 yield self.checkPermissionToRoot(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1386 client, parent_data, peer_jid, perms_to_check
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1387 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1388
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1389 files = yield self.storage.getFiles(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1390 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1391 file_id=file_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1392 version=version,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1393 parent=parent,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1394 type_=type_,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1395 file_hash=file_hash,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1396 hash_algo=hash_algo,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1397 name=name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1398 namespace=namespace,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1399 mime_type=mime_type,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1400 owner=owner,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1401 access=access,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1402 projection=projection,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1403 unique=unique,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1404 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1405
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1406 if peer_jid:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1407 # if permission are checked, we must remove all file tha use can't access
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1408 to_remove = []
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1409 for file_data in files:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1410 try:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1411 self.checkFilePermission(file_data, peer_jid, perms_to_check)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1412 except exceptions.PermissionError:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1413 to_remove.append(file_data)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1414 for file_data in to_remove:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1415 files.remove(file_data)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1416 defer.returnValue(files)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1417
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1418 @defer.inlineCallbacks
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1419 def setFile(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1420 self,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1421 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1422 name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1423 file_id=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1424 version=u"",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1425 parent=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1426 path=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1427 type_=C.FILE_TYPE_FILE,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1428 file_hash=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1429 hash_algo=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1430 size=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1431 namespace=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1432 mime_type=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1433 created=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1434 modified=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1435 owner=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1436 access=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1437 extra=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1438 peer_jid=None,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1439 perms_to_check=(C.ACCESS_PERM_WRITE,),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1440 ):
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1441 """set a file metadata
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1442
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1443 @param name(unicode): basename of the file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1444 @param file_id(unicode): unique id of the file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1445 @param version(unicode): version of this file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1446 empty string for current version or when there is no versioning
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1447 @param parent(unicode, None): id of the directory containing the files
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1448 @param path(unicode, None): virtual path of the file in the namespace
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1449 if set, parent must be None. All intermediate directories will be created if needed,
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1450 using current access.
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1451 @param file_hash(unicode): unique hash of the payload
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1452 @param hash_algo(unicode): algorithm used for hashing the file (usually sha-256)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1453 @param size(int): size in bytes
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1454 @param namespace(unicode, None): identifier (human readable is better) to group files
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1455 for instance, namespace could be used to group files in a specific photo album
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1456 @param mime_type(unicode): MIME type of the file, or None if not known/guessed
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1457 @param created(int): UNIX time of creation
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1458 @param modified(int,None): UNIX time of last modification, or None to use created date
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1459 @param owner(jid.JID, None): jid of the owner of the file (mainly useful for component)
2518 e4de2f16a284 core (memory): use bare jid for owner in setFiles: Goffi <goffi@goffi.org> parents: 2508 diff changeset	1460 will be used to check permission (only bare jid is used, don't use with MUC).
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1461 Use None to ignore permission (perms_to_check must be None too)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1462 @param access(dict, None): serialisable dictionary with access rules.
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1463 None (or empty dict) to use private access, i.e. allow only profile's jid to access the file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1464 key can be on on C.ACCESS_PERM_*,
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1465 then a sub dictionary with a type key is used (one of C.ACCESS_TYPE_*).
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1466 According to type, extra keys can be used:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1467 - C.ACCESS_TYPE_PUBLIC: the permission is granted for everybody
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1468 - C.ACCESS_TYPE_WHITELIST: the permission is granted for jids (as unicode) in the 'jids' key
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1469 will be encoded to json in database
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1470 @param extra(dict, None): serialisable dictionary of any extra data
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1471 will be encoded to json in database
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1472 @param perms_to_check(tuple[unicode],None): permission to check
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1473 must be a tuple of C.ACCESS_PERM_* or None
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1474 if None, permission will no be checked (peer_jid must be None too in this case)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1475 @param profile(unicode): profile owning the file
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1476 """
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1477 if "/" in name:
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1478 raise ValueError('name must not contain a slash ("/")')
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1479 if file_id is None:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1480 file_id = shortuuid.uuid()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1481 if (
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1482 file_hash is not None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1483 and hash_algo is None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1484 or hash_algo is not None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1485 and file_hash is None
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1486 ):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1487 raise ValueError("file_hash and hash_algo must be set at the same time")
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1488 if mime_type is None:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1489 mime_type, file_encoding = mimetypes.guess_type(name)
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1490 if created is None:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1491 created = time.time()
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1492 if namespace is not None:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1493 namespace = namespace.strip() or None
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1494 if type_ == C.FILE_TYPE_DIRECTORY:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1495 if any(version, file_hash, size, mime_type):
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1496 raise ValueError(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1497 u"version, file_hash, size and mime_type can't be set for a directory"
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1498 )
2518 e4de2f16a284 core (memory): use bare jid for owner in setFiles: Goffi <goffi@goffi.org> parents: 2508 diff changeset	1499 if owner is not None:
e4de2f16a284 core (memory): use bare jid for owner in setFiles: Goffi <goffi@goffi.org> parents: 2508 diff changeset	1500 owner = owner.userhostJID()
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1501
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1502 if path is not None:
2518 e4de2f16a284 core (memory): use bare jid for owner in setFiles: Goffi <goffi@goffi.org> parents: 2508 diff changeset	1503 # _getParentDir will check permissions if peer_jid is set, so we use owner
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1504 parent, remaining_path_elts = yield self._getParentDir(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1505 client, path, parent, namespace, owner, owner, perms_to_check
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1506 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1507 # if remaining directories don't exist, we have to create them
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1508 for new_dir in remaining_path_elts:
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1509 new_dir_id = shortuuid.uuid()
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1510 yield self.storage.setFile(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1511 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1512 name=new_dir,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1513 file_id=new_dir_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1514 version=u"",
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1515 parent=parent,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1516 type_=C.FILE_TYPE_DIRECTORY,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1517 namespace=namespace,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1518 created=time.time(),
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1519 owner=owner,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1520 access=access,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1521 extra={},
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1522 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1523 parent = new_dir_id
3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1524 elif parent is None:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1525 parent = u""
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1526
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1527 yield self.storage.setFile(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1528 client,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1529 file_id=file_id,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1530 version=version,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1531 parent=parent,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1532 type_=type_,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1533 file_hash=file_hash,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1534 hash_algo=hash_algo,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1535 name=name,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1536 size=size,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1537 namespace=namespace,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1538 mime_type=mime_type,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1539 created=created,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1540 modified=modified,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1541 owner=owner,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1542 access=access,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1543 extra=extra,
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1544 )
2501 3b67fe672206 core (memory): file metadata handling methods: Goffi <goffi@goffi.org> parents: 2483 diff changeset	1545
2526 35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1546 def fileUpdate(self, file_id, column, update_cb):
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1547 """update a file column taking care of race condition
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1548
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1549 access is NOT checked in this method, it must be checked beforehand
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1550 @param file_id(unicode): id of the file to update
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1551 @param column(unicode): one of "access" or "extra"
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1552 @param update_cb(callable): method to update the value of the colum
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1553 the method will take older value as argument, and must update it in place
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1554 Note that the callable must be thread-safe
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1555 """
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1556 return self.storage.fileUpdate(file_id, column, update_cb)
35d591086974 core (memory, sqlite): added fileUpdate method to update "extra" and "access" avoiding race condition Goffi <goffi@goffi.org> parents: 2518 diff changeset	1557
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1558 ## Misc ##
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1559
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	1560 def isEntityAvailable(self, client, entity_jid):
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1561 """Tell from the presence information if the given entity is available.
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1562
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1563 @param entity_jid (JID): the entity to check (if bare jid is used, all resources are tested)
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1564 @return (bool): True if entity is available
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1565 """
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1566 if not entity_jid.resource:
2624 56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1567 return bool(
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1568 self.getAvailableResources(client, entity_jid)
56f94936df1e code style reformatting using black Goffi <goffi@goffi.org> parents: 2597 diff changeset	1569 ) # is any resource is available, entity is available
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1570 try:
2533 8d82a62fa098 core (disco), plugin XEP-0115: client use + capabilities hash improvment: Goffi <goffi@goffi.org> parents: 2526 diff changeset	1571 presence_data = self.getEntityDatum(entity_jid, "presence", client.profile)
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1572 except KeyError:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	1573 log.debug(u"No presence information for {}".format(entity_jid))
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1574 return False
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	1575 return presence_data.show != C.PRESENCE_UNAVAILABLE

Mercurial > libervia-backend

annotate sat/memory/memory.py @ 2787:298408833ec2