libervia-backend: src/memory/params.py annotate

annotate src/memory/params.py @ 1534:a5e0393a06cd

plugin ip, params: plugin IP discovery, first draft: - a dedicated plugin now manage IP discovery, for now it uses external website, but it should implement XEP-0279 soon - a permission is requested to user for calling an external website. Once the permission is granted (it's global), it is not asked anymore. - the ip is discovered on demand, and cache is kept for the session. - memory.params.getParamA has a new parameter use_default, which allow to get None when a parameter is not set, instead of the default value. This allow to detected when we need to do the first permission request. memory.getParamA don't have this parameter.

author	Goffi <goffi@goffi.org>
date	Tue, 29 Sep 2015 17:54:22 +0200
parents	fbe86b5d156f
children	42285d993e68

rev	line source
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	1 #!/usr/bin/python
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
1396 069ad98b360d 2015 copyright dates update Goffi <goffi@goffi.org> parents: 1290 diff changeset	5 # Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015 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
1222 e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1220 diff changeset	20 from sat.core.i18n import _, D_
0 c4bc297b82f0 sat: goffi@necton2 parents: diff changeset	21
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	22 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	23 from sat.core.constants import Const as C
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	24 from sat.memory.crypto import BlockCipher, PasswordHasher
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	25 from xml.dom import minidom, NotFoundErr
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	26 from sat.core.log import getLogger
301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	27 log = getLogger(__name__)
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	28 from twisted.internet import defer
645 17bd09cd1001 core: misc bug fixes Goffi <goffi@goffi.org> parents: 643 diff changeset	29 from twisted.python.failure import Failure
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	30 from twisted.words.protocols.jabber import jid
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 784 diff changeset	31 from sat.tools.xml_tools import paramsXML2XMLUI
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	32
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	33 # TODO: params should be rewritten using Twisted directly instead of minidom
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	34 # general params should be linked to sat.conf and kept synchronised
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	35 # this need an overall simplification to make maintenance easier
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	36
756 efa0e0f57950 core (memory): new Sessions management class (similar to dict) Goffi <goffi@goffi.org> parents: 751 diff changeset	37
588 beaf6bec2fcd Remove every old-style class. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 587 diff changeset	38 class Params(object):
65 d35c5edab53f SàT: multi-profile: memory & dbus bridge's methods profile management Goffi <goffi@goffi.org> parents: 64 diff changeset	39 """This class manage parameters with xml"""
19 f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	40 ### TODO: add desciption in params
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	41
611 d722778b152c core: added Priority management Goffi <goffi@goffi.org> parents: 609 diff changeset	42 #TODO: when priority is changed, a new presence stanza must be emitted
d722778b152c core: added Priority management Goffi <goffi@goffi.org> parents: 609 diff changeset	43 #TODO: int type (Priority should be int instead of string)
34 a544b376b6f0 use proper utf-8 encoding for parsing xml in parameters Goffi <goffi@goffi.org> parents: 22 diff changeset	44 default_xml = u"""
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	45 <params>
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	46 <general>
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	47 </general>
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	48 <individual>
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	49 <category name="General" label="%(category_general)s">
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	50 <param name="Password" value="" type="password" />
1226 72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	51 <param name="%(history_param)s" label="%(history_label)s" value="20" constraint="0;100" type="int" security="0" />
1227 4da2e4d58bd0 memory (params): add parameters "Show offline contacts" and "Show empty groups" souliane <souliane@mailoo.org> parents: 1226 diff changeset	52 <param name="%(show_offline_contacts)s" label="%(show_offline_contacts_label)s" value="false" type="bool" security="0" />
1238 ff58a49a7022 memory (params): set "Show empty groups" to True by default souliane <souliane@mailoo.org> parents: 1227 diff changeset	53 <param name="%(show_empty_groups)s" label="%(show_empty_groups_label)s" value="true" type="bool" security="0" />
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	54 </category>
183 9ee4a1d0d7fb Added auto(dis)connect params + misc Goffi <goffi@goffi.org> parents: 182 diff changeset	55 <category name="Connection" label="%(category_connection)s">
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	56 <param name="JabberID" value="name@example.org/SàT" type="string" security="0" />
256 f5181f6dd98f Test value replaced by example values for memory params Goffi <goffi@goffi.org> parents: 228 diff changeset	57 <param name="Password" value="" type="password" />
1226 72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	58 <param name="Priority" value="50" type="int" constraint="-128;127"/>
1088 b29452cab50b core, memory, plugins, stdui, frontends: look for DNS SRV records when server is not specified: souliane <souliane@mailoo.org> parents: 1051 diff changeset	59 <param name="%(force_server_param)s" value="" type="string" />
1226 72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	60 <param name="%(force_port_param)s" value="" type="int" constraint="1;65535" />
72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	61 <param name="NewAccount" label="%(new_account_label)s" type="button" callback_id="registerNewAccount"/>
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	62 <param name="autoconnect" label="%(autoconnect_label)s" value="true" type="bool" security="0" />
faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	63 <param name="autodisconnect" label="%(autodisconnect_label)s" value="false" type="bool" security="0" />
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	64 </category>
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	65 </individual>
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	66 </params>
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	67 """ % {
1222 e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1220 diff changeset	68 'category_general': D_("General"),
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1220 diff changeset	69 'category_connection': D_("Connection"),
e6e0ea4dc835 memory: add Parameter "Chat history limit" souliane <souliane@mailoo.org> parents: 1220 diff changeset	70 'history_param': C.HISTORY_LIMIT,
1226 72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	71 'history_label': D_('Chat history limit'),
1227 4da2e4d58bd0 memory (params): add parameters "Show offline contacts" and "Show empty groups" souliane <souliane@mailoo.org> parents: 1226 diff changeset	72 'show_offline_contacts': C.SHOW_OFFLINE_CONTACTS,
4da2e4d58bd0 memory (params): add parameters "Show offline contacts" and "Show empty groups" souliane <souliane@mailoo.org> parents: 1226 diff changeset	73 'show_offline_contacts_label': D_('Show offline contacts'),
4da2e4d58bd0 memory (params): add parameters "Show offline contacts" and "Show empty groups" souliane <souliane@mailoo.org> parents: 1226 diff changeset	74 'show_empty_groups': C.SHOW_EMPTY_GROUPS,
4da2e4d58bd0 memory (params): add parameters "Show offline contacts" and "Show empty groups" souliane <souliane@mailoo.org> parents: 1226 diff changeset	75 'show_empty_groups_label': D_('Show empty groups'),
1088 b29452cab50b core, memory, plugins, stdui, frontends: look for DNS SRV records when server is not specified: souliane <souliane@mailoo.org> parents: 1051 diff changeset	76 'force_server_param': C.FORCE_SERVER_PARAM,
b29452cab50b core, memory, plugins, stdui, frontends: look for DNS SRV records when server is not specified: souliane <souliane@mailoo.org> parents: 1051 diff changeset	77 'force_port_param': C.FORCE_PORT_PARAM,
1226 72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	78 'new_account_label': D_("Register new account"),
72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	79 'autoconnect_label': D_('Connect on frontend startup'),
72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	80 'autodisconnect_label': D_('Disconnect on frontend closure'),
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	81 }
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	82
74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	83 def load_default_params(self):
458 094050fe461e core: fixed Params class name in load_default_params Goffi <goffi@goffi.org> parents: 443 diff changeset	84 self.dom = minidom.parseString(Params.default_xml.encode('utf-8'))
38 3e24753b9e0b Fixed parameters loading/saving Goffi <goffi@goffi.org> parents: 34 diff changeset	85
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	86 def _mergeParams(self, source_node, dest_node):
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	87 """Look for every node in source_node and recursively copy them to dest if they don't exists"""
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	88
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	89 def getNodesMap(children):
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	90 ret = {}
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	91 for child in children:
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	92 if child.nodeType == child.ELEMENT_NODE:
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	93 ret[(child.tagName, child.getAttribute('name'))] = child
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	94 return ret
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	95 source_map = getNodesMap(source_node.childNodes)
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	96 dest_map = getNodesMap(dest_node.childNodes)
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	97 source_set = set(source_map.keys())
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	98 dest_set = set(dest_map.keys())
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	99 to_add = source_set.difference(dest_set)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	100
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	101 for node_key in to_add:
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	102 dest_node.appendChild(source_map[node_key].cloneNode(True))
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	103
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	104 to_recurse = source_set - to_add
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	105 for node_key in to_recurse:
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	106 self._mergeParams(source_map[node_key], dest_map[node_key])
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	107
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	108 def load_xml(self, xml_file):
1015 fee00f2e11c2 memory, jp: added jp commands to load/save parameters template souliane <souliane@mailoo.org> parents: 993 diff changeset	109 """Load parameters template from xml file"""
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	110 self.dom = minidom.parse(xml_file)
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	111 default_dom = minidom.parseString(Params.default_xml.encode('utf-8'))
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	112 self._mergeParams(default_dom.documentElement, self.dom.documentElement)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	113
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	114 def loadGenParams(self):
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	115 """Load general parameters data from storage
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	116
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	117 @return: deferred triggered once params are loaded
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	118 """
413 dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	119 return self.storage.loadGenParams(self.params_gen)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	120
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	121 def loadIndParams(self, profile, cache=None):
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	122 """Load individual parameters
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	123
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	124 set self.params cache or a temporary cache
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	125 @param profile: profile to load (must exist)
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	126 @param cache: if not None, will be used to store the value, as a short time cache
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	127 @return: deferred triggered once params are loaded
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	128 """
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	129 if cache is None:
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	130 self.params[profile] = {}
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	131 return self.storage.loadIndParams(self.params[profile] if cache is None else cache, profile)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	132
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	133 def purgeProfile(self, profile):
32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	134 """Remove cache data of a profile
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	135
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	136 @param profile: %(doc_profile)s
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	137 """
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	138 try:
32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	139 del self.params[profile]
32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	140 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	141 log.error(_(u"Trying to purge cache of a profile not in memory: [%s]") % profile)
416 32dc8b18c2ae core: param loading/purging on profile connection/disconnection Goffi <goffi@goffi.org> parents: 413 diff changeset	142
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	143 def save_xml(self, filename):
61 58d49fc19639 parameters are saved again Goffi <goffi@goffi.org> parents: 60 diff changeset	144 """Save parameters template to xml file"""
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	145 with open(filename, 'wb') as xml_file:
214 e178e8f6d13a fixed some unicode issue Goffi <goffi@goffi.org> parents: 197 diff changeset	146 xml_file.write(self.dom.toxml('utf-8'))
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	147
413 dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	148 def __init__(self, host, storage):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	149 log.debug("Parameters init")
22 bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button. Goffi <goffi@goffi.org> parents: 21 diff changeset	150 self.host = host
413 dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	151 self.storage = storage
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	152 self.default_profile = None
182 556c2bd7c344 Primitivus now implement showDialog + new "newAlert" bridge method to show a dialog from core Goffi <goffi@goffi.org> parents: 166 diff changeset	153 self.params = {}
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	154 self.params_gen = {}
19 f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	155
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	156 def asyncCreateProfile(self, profile):
420 acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	157 """Create a new profile
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	158
420 acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	159 @param profile: name of the profile
acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	160 @param callback: called when the profile actually exists in database and memory
893 308a96bc7c1b core, frontends: add method asyncDeleteProfile, remove synchronous methods createProfile and deleteProfile souliane <souliane@mailoo.org> parents: 866 diff changeset	161 @return: a Deferred instance
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	162 """
420 acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	163 if self.storage.hasProfile(profile):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	164 log.info(_('The profile name already exists'))
751 1def5b7edf9f core, bridge: better GenericException handling Goffi <goffi@goffi.org> parents: 747 diff changeset	165 return defer.fail(Failure(exceptions.ConflictError))
420 acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	166 if not self.host.trigger.point("ProfileCreation", profile):
751 1def5b7edf9f core, bridge: better GenericException handling Goffi <goffi@goffi.org> parents: 747 diff changeset	167 return defer.fail(Failure(exceptions.CancelError))
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	168 return self.storage.createProfile(profile)
420 acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	169
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	170 def asyncDeleteProfile(self, profile, force=False):
68 9b842086d915 multiple profiles update Goffi <goffi@goffi.org> parents: 66 diff changeset	171 """Delete an existing profile
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 938 diff changeset	172
893 308a96bc7c1b core, frontends: add method asyncDeleteProfile, remove synchronous methods createProfile and deleteProfile souliane <souliane@mailoo.org> parents: 866 diff changeset	173 @param profile: name of the profile
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	174 @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	175 To be used for direct calls only (not through the bridge).
893 308a96bc7c1b core, frontends: add method asyncDeleteProfile, remove synchronous methods createProfile and deleteProfile souliane <souliane@mailoo.org> parents: 866 diff changeset	176 @return: a Deferred instance
308a96bc7c1b core, frontends: add method asyncDeleteProfile, remove synchronous methods createProfile and deleteProfile souliane <souliane@mailoo.org> parents: 866 diff changeset	177 """
420 acd908528ef7 core: profile creation/deletion through database Goffi <goffi@goffi.org> parents: 418 diff changeset	178 if not self.storage.hasProfile(profile):
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	179 log.info(_('Trying to delete an unknown profile'))
893 308a96bc7c1b core, frontends: add method asyncDeleteProfile, remove synchronous methods createProfile and deleteProfile souliane <souliane@mailoo.org> parents: 866 diff changeset	180 return defer.fail(Failure(exceptions.ProfileUnknownError))
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	181 if self.host.isConnected(profile):
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	182 if force:
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	183 self.host.disconnect(profile)
fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	184 else:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	185 log.info(_("Trying to delete a connected profile"))
938 fc7e0828b18e plugin account, groupblog: user can erase all their microblogs at once souliane <souliane@mailoo.org> parents: 916 diff changeset	186 return defer.fail(Failure(exceptions.ConnectedProfileError))
893 308a96bc7c1b core, frontends: add method asyncDeleteProfile, remove synchronous methods createProfile and deleteProfile souliane <souliane@mailoo.org> parents: 866 diff changeset	187 return self.storage.deleteProfile(profile)
68 9b842086d915 multiple profiles update Goffi <goffi@goffi.org> parents: 66 diff changeset	188
1263 cfd636203e8f core: misc improvments: Goffi <goffi@goffi.org> parents: 1238 diff changeset	189 def getProfileName(self, profile_key, return_profile_keys=False):
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	190 """return profile according to profile_key
944 e1842ebcb2f3 core, plugin XEP-0115: discovery refactoring: Goffi <goffi@goffi.org> parents: 938 diff changeset	191
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	192 @param profile_key: profile name or key which can be
1519 fbe86b5d156f core (memory, params): minor docstrings updates Goffi <goffi@goffi.org> parents: 1497 diff changeset	193 C.PROF_KEY_ALL for all profiles
fbe86b5d156f core (memory, params): minor docstrings updates Goffi <goffi@goffi.org> parents: 1497 diff changeset	194 C.PROF_KEY_DEFAULT for default profile
fbe86b5d156f core (memory, params): minor docstrings updates Goffi <goffi@goffi.org> parents: 1497 diff changeset	195 @param return_profile_keys: if True, return unmanaged profile keys (like C.PROF_KEY_ALL). This keys must be managed by the caller
1460 c7fd121a6180 core: getProfileName no raise ProfileUnknownError + minor doc fixes Goffi <goffi@goffi.org> parents: 1409 diff changeset	196 @return: requested profile name
c7fd121a6180 core: getProfileName no raise ProfileUnknownError + minor doc fixes Goffi <goffi@goffi.org> parents: 1409 diff changeset	197 @raise exceptions.ProfileUnknownError if profile doesn't exists
c7fd121a6180 core: getProfileName no raise ProfileUnknownError + minor doc fixes Goffi <goffi@goffi.org> parents: 1409 diff changeset	198 """
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	199 if profile_key == '@DEFAULT@':
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	200 default = self.host.memory.memory_data.get('Profile_default')
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	201 if not default:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	202 log.info(_('No default profile, returning first one')) # TODO: manage real default profile
625 5646ecd3e35e core: fixed crash on first run, when no profile exist yet Goffi <goffi@goffi.org> parents: 620 diff changeset	203 try:
5646ecd3e35e core: fixed crash on first run, when no profile exist yet Goffi <goffi@goffi.org> parents: 620 diff changeset	204 default = self.host.memory.memory_data['Profile_default'] = self.storage.getProfilesList()[0]
5646ecd3e35e core: fixed crash on first run, when no profile exist yet Goffi <goffi@goffi.org> parents: 620 diff changeset	205 except IndexError:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	206 log.info(_('No profile exist yet'))
625 5646ecd3e35e core: fixed crash on first run, when no profile exist yet Goffi <goffi@goffi.org> parents: 620 diff changeset	207 return ""
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	208 return default # FIXME: temporary, must use real default value, and fallback to first one if it doesn't exists
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	209 elif profile_key == C.PROF_KEY_NONE:
639 99eee75ec1b7 core: better handling of profile_key and don't write the param file anymore souliane <souliane@mailoo.org> parents: 635 diff changeset	210 raise exceptions.ProfileNotSetError
1519 fbe86b5d156f core (memory, params): minor docstrings updates Goffi <goffi@goffi.org> parents: 1497 diff changeset	211 elif return_profile_keys and profile_key in [C.PROF_KEY_ALL]:
728 e07afabc4a25 plugin XEP-0050: Ad-Hoc commands first draft (answering part) Goffi <goffi@goffi.org> parents: 722 diff changeset	212 return profile_key # this value must be managed by the caller
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	213 if not self.storage.hasProfile(profile_key):
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	214 log.error(_(u'Trying to access an unknown profile (%s)') % profile_key)
1460 c7fd121a6180 core: getProfileName no raise ProfileUnknownError + minor doc fixes Goffi <goffi@goffi.org> parents: 1409 diff changeset	215 raise exceptions.ProfileUnknownError
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	216 return profile_key
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	217
19 f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	218 def __get_unique_node(self, parent, tag, name):
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	219 """return node with given tag
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	220
19 f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	221 @param parent: parent of nodes to check (e.g. documentElement)
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	222 @param tag: tag to check (e.g. "category")
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	223 @param name: name to check (e.g. "JID")
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	224 @return: node if it exist or None
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	225 """
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	226 for node in parent.childNodes:
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	227 if node.nodeName == tag and node.getAttribute("name") == name:
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	228 #the node already exists
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	229 return node
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	230 #the node is new
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	231 return None
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	232
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	233 def updateParams(self, xml, security_limit=C.NO_SECURITY_LIMIT, app=''):
833 9bac2fc74968 memory: bug fix to not register twice frontends parameters + added some tests for param update souliane <souliane@mailoo.org> parents: 813 diff changeset	234 """import xml in parameters, update if the param already exists
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	235
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	236 If security_limit is specified and greater than -1, the parameters
778 bfafed251b40 memory: fixed wrong information in the docstrings for security_limit souliane <souliane@mailoo.org> parents: 777 diff changeset	237 that have a security level greater than security_limit are skipped.
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	238 @param xml: parameters in xml form
778 bfafed251b40 memory: fixed wrong information in the docstrings for security_limit souliane <souliane@mailoo.org> parents: 777 diff changeset	239 @param security_limit: -1 means no security, 0 is the maximum security then the higher the less secure
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	240 @param app: name of the frontend registering the parameters or empty value
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	241 """
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	242 # TODO: should word with domish.Element
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	243 src_parent = minidom.parseString(xml.encode('utf-8')).documentElement
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	244
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	245 def pre_process_app_node(src_parent, security_limit, app):
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	246 """Parameters that are registered from a frontend must be checked"""
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	247 to_remove = []
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	248 for type_node in src_parent.childNodes:
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	249 if type_node.nodeName != C.INDIVIDUAL:
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	250 to_remove.append(type_node) # accept individual parameters only
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	251 continue
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	252 for cat_node in type_node.childNodes:
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	253 if cat_node.nodeName != 'category':
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	254 to_remove.append(cat_node)
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	255 continue
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	256 to_remove_count = 0 # count the params to be removed from current category
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	257 for node in cat_node.childNodes:
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	258 if node.nodeName != "param" or not self.checkSecurityLimit(node, security_limit):
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	259 to_remove.append(node)
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	260 to_remove_count += 1
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	261 continue
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	262 node.setAttribute('app', app)
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	263 if len(cat_node.childNodes) == to_remove_count: # remove empty category
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	264 for dummy in xrange(0, to_remove_count):
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	265 to_remove.pop()
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	266 to_remove.append(cat_node)
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	267 for node in to_remove:
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	268 node.parentNode.removeChild(node)
19 f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	269
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	270 def import_node(tgt_parent, src_parent):
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	271 for child in src_parent.childNodes:
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	272 if child.nodeName == '#text':
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	273 continue
f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	274 node = self.__get_unique_node(tgt_parent, child.nodeName, child.getAttribute("name"))
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	275 if not node: # The node is new
1051 854880a31717 memory (params), test: fixes updateParams bug souliane <souliane@mailoo.org> parents: 1050 diff changeset	276 tgt_parent.appendChild(child.cloneNode(True))
19 f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	277 else:
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	278 if child.nodeName == "param":
833 9bac2fc74968 memory: bug fix to not register twice frontends parameters + added some tests for param update souliane <souliane@mailoo.org> parents: 813 diff changeset	279 # The child updates an existing parameter, we replace the node
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	280 tgt_parent.replaceChild(child, node)
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	281 else:
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	282 # the node already exists, we recurse 1 more level
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	283 import_node(node, child)
19 f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	284
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	285 if app:
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	286 pre_process_app_node(src_parent, security_limit, app)
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	287 import_node(self.dom.documentElement, src_parent)
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	288
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	289 def paramsRegisterApp(self, xml, security_limit, app):
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	290 """Register frontend's specific parameters
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	291
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	292 If security_limit is specified and greater than -1, the parameters
778 bfafed251b40 memory: fixed wrong information in the docstrings for security_limit souliane <souliane@mailoo.org> parents: 777 diff changeset	293 that have a security level greater than security_limit are skipped.
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	294 @param xml: XML definition of the parameters to be added
778 bfafed251b40 memory: fixed wrong information in the docstrings for security_limit souliane <souliane@mailoo.org> parents: 777 diff changeset	295 @param security_limit: -1 means no security, 0 is the maximum security then the higher the less secure
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	296 @param app: name of the frontend registering the parameters
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	297 """
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	298 if not app:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	299 log.warning(_(u"Trying to register frontends parameters with no specified app: aborted"))
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	300 return
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	301 if not hasattr(self, "frontends_cache"):
833 9bac2fc74968 memory: bug fix to not register twice frontends parameters + added some tests for param update souliane <souliane@mailoo.org> parents: 813 diff changeset	302 self.frontends_cache = []
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	303 if app in self.frontends_cache:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	304 log.debug(_(u"Trying to register twice frontends parameters for %(app)s: aborted" % {"app": app}))
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	305 return
833 9bac2fc74968 memory: bug fix to not register twice frontends parameters + added some tests for param update souliane <souliane@mailoo.org> parents: 813 diff changeset	306 self.frontends_cache.append(app)
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	307 self.updateParams(xml, security_limit, app)
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	308 log.debug(u"Frontends parameters registered for %(app)s" % {'app': app})
19 f2a745ca0fbc refactoring: using xml params part III (parameters import) Goffi <goffi@goffi.org> parents: 18 diff changeset	309
20 fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	310 def __default_ok(self, value, name, category):
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	311 #FIXME: will not work with individual parameters
04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	312 self.setParam(name, value, category)
20 fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	313
fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	314 def __default_ko(self, failure, name, category):
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	315 log.error(_(u"Can't determine default value for [%(category)s/%(name)s]: %(reason)s") % {'category': category, 'name': name, 'reason': str(failure.value)})
20 fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	316
fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	317 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	318 """Set default value of parameter
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	319
20 fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	320 'default_cb' attibute of parameter must be set to 'yes'
fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	321 @param name: name of the parameter
fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	322 @param category: category of the parameter
fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	323 @param callback: must return a string with the value (use deferred if needed)
fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	324 @param errback: must manage the error with args failure, name, category
fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	325 """
22 bb72c29f3432 added action cb mechanism for buttons. Tested with a temporary new user registration button. Goffi <goffi@goffi.org> parents: 21 diff changeset	326 #TODO: send signal param update if value changed
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	327 #TODO: manage individual paramaters
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	328 log.debug ("setDefault called for %(category)s/%(name)s" % {"category": category, "name": name})
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	329 node = self._getParamNode(name, category, '@ALL@')
20 fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	330 if not node:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	331 log.error(_(u"Requested param [%(name)s] in category [%(category)s] doesn't exist !") % {'name': name, 'category': category})
20 fc8c202cda87 refactoring: using xml params part IV (default values) Goffi <goffi@goffi.org> parents: 19 diff changeset	332 return
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	333 if node[1].getAttribute('default_cb') == 'yes':
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	334 # del node[1].attributes['default_cb'] # default_cb is not used anymore as a flag to know if we have to set the default value,
04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	335 # and we can still use it later e.g. to call a generic setDefault method
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	336 value = self._getParam(category, name, C.GENERAL)
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	337 if value is None: # no value set by the user: we have the default value
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	338 log.debug ("Default value to set, using callback")
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	339 d = defer.maybeDeferred(callback)
04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	340 d.addCallback(self.__default_ok, name, category)
04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	341 d.addErrback(errback or self.__default_ko, name, category)
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	342
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	343 def _getAttr_internal(self, node, attr, value):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	344 """Get attribute value.
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	345
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	346 /!\ This method would return encrypted password values.
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	347
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	348 @param node: XML param node
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	349 @param attr: name of the attribute to get (e.g.: 'value' or 'type')
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	350 @param value: user defined value
1534 a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	351 @return: value (can be str, bool, int, list, None)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	352 """
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	353 if attr == 'value':
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	354 value_to_use = value if value is not None else node.getAttribute(attr) # we use value (user defined) if it exist, else we use node's default value
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	355 if node.getAttribute('type') == 'bool':
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	356 return C.bool(value_to_use)
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	357 if node.getAttribute('type') == 'int':
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	358 return int(value_to_use)
1039 902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	359 elif node.getAttribute('type') == 'list':
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	360 options = [option for option in node.childNodes if option.nodeName == 'option']
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	361 values = [option.getAttribute('value') for option in options]
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	362 if value_to_use not in values: # value_to_use is probably empty
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	363 selected = [option for option in options if option.getAttribute('selected') == 'true']
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	364 cat, param = node.parentNode.getAttribute('name'), node.getAttribute('name')
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	365 if len(selected) == 1:
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	366 value_to_use = selected[0].getAttribute('value')
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	367 log.info(_("Unset parameter (%(cat)s, %(param)s) of type list will use the default option '%(value)s'") %
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	368 {'cat': cat, 'param': param, 'value': value_to_use})
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	369 return value_to_use
902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	370 if len(selected) == 0:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	371 log.error(_(u'Parameter (%(cat)s, %(param)s) of type list has no default option!') % {'cat': cat, 'param': param})
1039 902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	372 else:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	373 log.error(_(u'Parameter (%(cat)s, %(param)s) of type list has more than one default option!') % {'cat': cat, 'param': param})
1039 902c764a0d2b memory (params): fix parameters of type "list" to use the default option when no individual value is set souliane <souliane@mailoo.org> parents: 1037 diff changeset	374 raise exceptions.DataError
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	375 elif node.getAttribute('type') == 'jids_list':
1497 7a9cef71ae43 core (params): fixes jid_list to use node's default value when no user value is defined souliane <souliane@mailoo.org> parents: 1496 diff changeset	376 if not value_to_use:
1496 de71cd99ba9b core (params): fixed exception on empty jids list Goffi <goffi@goffi.org> parents: 1480 diff changeset	377 log.debug(u"jids list value is empty")
de71cd99ba9b core (params): fixed exception on empty jids list Goffi <goffi@goffi.org> parents: 1480 diff changeset	378 return []
1497 7a9cef71ae43 core (params): fixes jid_list to use node's default value when no user value is defined souliane <souliane@mailoo.org> parents: 1496 diff changeset	379 jids = value_to_use.split('\t')
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	380 to_delete = []
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	381 for idx, value in enumerate(jids):
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	382 try:
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	383 jids[idx] = jid.JID(value)
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	384 except jid.InvalidFormat:
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	385 log.warning(u"Incorrect jid value found in jids list: [{}]".format(value))
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	386 to_delete.append(value)
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	387 for value in to_delete:
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	388 jids.remove(value)
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	389 return jids
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	390 return value_to_use
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	391 return node.getAttribute(attr)
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	392
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	393 def _getAttr(self, node, attr, value):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	394 """Get attribute value (synchronous).
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	395
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	396 /!\ This method can not be used to retrieve password values.
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	397 @param node: XML param node
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	398 @param attr: name of the attribute to get (e.g.: 'value' or 'type')
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	399 @param value: user defined value
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	400 @return (unicode, bool, int, list): value to retrieve
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	401 """
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	402 if attr == 'value' and node.getAttribute('type') == 'password':
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	403 raise exceptions.InternalError('To retrieve password values, use _asyncGetAttr instead of _getAttr')
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	404 return self._getAttr_internal(node, attr, value)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	405
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	406 def _asyncGetAttr(self, node, attr, value, profile=None):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	407 """Get attribute value.
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	408
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	409 Profile passwords are returned hashed (if not empty),
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	410 other passwords are returned decrypted (if not empty).
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	411 @param node: XML param node
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	412 @param attr: name of the attribute to get (e.g.: 'value' or 'type')
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	413 @param value: user defined value
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	414 @param profile: %(doc_profile)s
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	415 @return (unicode, bool, int, list): Deferred value to retrieve
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	416 """
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	417 value = self._getAttr_internal(node, attr, value)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	418 if attr != 'value' or node.getAttribute('type') != 'password':
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	419 return defer.succeed(value)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	420 param_cat = node.parentNode.getAttribute('name')
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	421 param_name = node.getAttribute('name')
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	422 if ((param_cat, param_name) == C.PROFILE_PASS_PATH) or not value:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	423 return defer.succeed(value) # profile password and empty passwords are returned "as is"
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	424 if not profile:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	425 raise exceptions.ProfileUnknownError('The profile is needed to decrypt a password')
1090 594fbdda4a87 memory: add helper methods encryptValue and decryptValue souliane <souliane@mailoo.org> parents: 1088 diff changeset	426 d = self.host.memory.decryptValue(value, profile)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	427
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	428 def gotPlainPassword(password):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	429 if password is None: # empty value means empty password, None means decryption failure
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	430 raise exceptions.InternalError(_('The stored password could not be decrypted!'))
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	431 return password
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	432
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	433 return d.addCallback(gotPlainPassword)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	434
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	435 def __type_to_string(self, result):
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	436 """ convert result to string, according to its type """
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	437 if isinstance(result, bool):
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	438 return "true" if result else "false"
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	439 elif isinstance(result, int):
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	440 return str(result)
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	441 return result
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	442
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	443 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	444 """ Same as getParamA but for bridge: convert non string value to string """
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	445 return self.__type_to_string(self.getParamA(name, category, attr, profile_key))
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	446
1534 a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	447 def getParamA(self, name, category, attr="value", use_default=True, profile_key=C.PROF_KEY_NONE):
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	448 """Helper method to get a specific attribute.
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	449
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	450 /!\ This method would return encrypted password values,
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	451 to get the plain values you have to use _asyncGetParamA.
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	452 @param name: name of the parameter
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	453 @param category: category of the parameter
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	454 @param attr: name of the attribute (default: "value")
1534 a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	455 @parm use_default(bool): if True and attr=='value', return default value if not set
a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	456 else return None if not set
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	457 @param profile: owner of the param (@ALL@ for everyone)
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	458 @return: attribute
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	459 """
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	460 #FIXME: looks really dirty and buggy, need to be reviewed/refactored
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	461 node = self._getParamNode(name, category)
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	462 if not node:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	463 log.error(_(u"Requested param [%(name)s] in category [%(category)s] doesn't exist !") % {'name': name, 'category': category})
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	464 raise exceptions.NotFound
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	465
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	466 if attr == 'value' and node[1].getAttribute('type') == 'password':
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	467 raise exceptions.InternalError('To retrieve password values, use asyncGetParamA instead of getParamA')
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	468
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	469 if node[0] == C.GENERAL:
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	470 value = self._getParam(category, name, C.GENERAL)
1534 a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	471 if value is None and attr=='value' and not use_default:
a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	472 return value
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	473 return self._getAttr(node[1], attr, value)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	474
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	475 assert node[0] == C.INDIVIDUAL
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	476
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	477 profile = self.getProfileName(profile_key)
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	478 if not profile:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	479 log.error(_('Requesting a param for an non-existant profile'))
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	480 raise exceptions.ProfileUnknownError
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	481
413 dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	482 if profile not in self.params:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	483 log.error(_('Requesting synchronous param for not connected profile'))
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	484 raise exceptions.NotConnectedProfileError(profile)
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	485
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	486 if attr == "value":
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	487 value = self._getParam(category, name, profile=profile)
1534 a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	488 if value is None and attr=='value' and not use_default:
a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	489 return value
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	490 return self._getAttr(node[1], attr, value)
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	491
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	492 def asyncGetStringParamA(self, name, category, attr="value", security_limit=C.NO_SECURITY_LIMIT, profile_key=C.PROF_KEY_NONE):
656 7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	493 d = self.asyncGetParamA(name, category, attr, security_limit, profile_key)
538 2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	494 d.addCallback(self.__type_to_string)
2c4016921403 core, frontends, bridgen plugins: fixed methods which were unproperly managing multi-profiles Goffi <goffi@goffi.org> parents: 512 diff changeset	495 return d
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	496
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	497 def asyncGetParamA(self, name, category, attr="value", security_limit=C.NO_SECURITY_LIMIT, profile_key=C.PROF_KEY_NONE):
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	498 """Helper method to get a specific attribute.
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	499
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	500 @param name: name of the parameter
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	501 @param category: category of the parameter
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	502 @param attr: name of the attribute (default: "value")
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	503 @param profile: owner of the param (@ALL@ for everyone)
1534 a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	504 @return (defer.Deferred): parameter value, with corresponding type (bool, int, list, etc)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	505 """
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	506 node = self._getParamNode(name, category)
413 dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	507 if not node:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	508 log.error(_(u"Requested param [%(name)s] in category [%(category)s] doesn't exist !") % {'name': name, 'category': category})
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	509 raise ValueError("Requested param doesn't exist")
413 dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	510
656 7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	511 if not self.checkSecurityLimit(node[1], security_limit):
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	512 log.warning(_(u"Trying to get parameter '%(param)s' in category '%(cat)s' without authorization!!!"
844 f3513c8cc2e6 misc: fix unnamed arguments in format strings souliane <souliane@mailoo.org> parents: 833 diff changeset	513 % {'param': name, 'cat': category}))
1290 faa1129559b8 core, frontends: refactoring to base Libervia on QuickFrontend (big mixed commit): Goffi <goffi@goffi.org> parents: 1263 diff changeset	514 raise exceptions.PermissionError
656 7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	515
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	516 if node[0] == C.GENERAL:
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	517 value = self._getParam(category, name, C.GENERAL)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	518 return self._asyncGetAttr(node[1], attr, value)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	519
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	520 assert node[0] == C.INDIVIDUAL
413 dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	521
dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	522 profile = self.getProfileName(profile_key)
dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	523 if not profile:
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	524 raise exceptions.InternalError(_('Requesting a param for a non-existant profile'))
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	525
952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	526 if attr != "value":
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	527 return defer.succeed(node[1].getAttribute(attr))
413 dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	528 try:
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	529 value = self._getParam(category, name, profile=profile)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	530 return self._asyncGetAttr(node[1], attr, value, profile)
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	531 except exceptions.ProfileNotInCacheError:
413 dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	532 #We have to ask data to the storage manager
dd4caab17008 core: - individual parameters managed through sqlite Goffi <goffi@goffi.org> parents: 412 diff changeset	533 d = self.storage.getIndParam(category, name, profile)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	534 return d.addCallback(lambda value: self._asyncGetAttr(node[1], attr, value, profile))
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	535
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	536 def _getParam(self, category, name, type_=C.INDIVIDUAL, cache=None, profile=C.PROF_KEY_NONE):
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	537 """Return the param, or None if it doesn't exist
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	538
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	539 @param category: param category
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	540 @param name: param name
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	541 @param type_: GENERAL or INDIVIDUAL
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	542 @param cache: temporary cache, to use when profile is not logged
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	543 @param profile: the profile name (not profile key, i.e. name and not something like @DEFAULT@)
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	544 @return: param value or None if it doesn't exist
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	545 """
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	546 if type_ == C.GENERAL:
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	547 if (category, name) in self.params_gen:
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	548 return self.params_gen[(category, name)]
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	549 return None # This general param has the default value
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	550 assert type_ == C.INDIVIDUAL
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	551 if profile == C.PROF_KEY_NONE:
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	552 raise exceptions.ProfileNotSetError
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	553 if profile in self.params:
e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	554 cache = self.params[profile] # if profile is in main cache, we use it,
e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	555 # ignoring the temporary cache
e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	556 elif cache is None: # else we use the temporary cache if it exists, or raise an exception
486 0d9908ac775e core: entity cache misc data management + error moved to core.exceptions in memory Goffi <goffi@goffi.org> parents: 484 diff changeset	557 raise exceptions.ProfileNotInCacheError
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	558 if (category, name) not in cache:
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	559 return None
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	560 return cache[(category, name)]
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	561
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	562 def _constructProfileXml(self, security_limit, app, profile):
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	563 """Construct xml for asked profile, filling values when needed
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	564
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	565 /!\ as noticed in doc, don't forget to unlink the minidom.Document
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	566 @param security_limit: NO_SECURITY_LIMIT (-1) to return all the params.
642 e07a03d52321 core: fix for methods signature souliane <souliane@mailoo.org> parents: 641 diff changeset	567 Otherwise sole the params which have a security level defined and
e07a03d52321 core: fix for methods signature souliane <souliane@mailoo.org> parents: 641 diff changeset	568 lower or equal to the specified value are returned.
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	569 @param app: name of the frontend requesting the parameters, or '' to get all parameters
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	570 @param profile: profile name (not key !)
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	571 @return: a deferred that fire a minidom.Document of the profile xml (cf warning above)
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	572 """
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	573
784 900987e1c0c4 memory: factorize the node checks in Params.__constructProfileXml souliane <souliane@mailoo.org> parents: 779 diff changeset	574 def checkNode(node):
900987e1c0c4 memory: factorize the node checks in Params.__constructProfileXml souliane <souliane@mailoo.org> parents: 779 diff changeset	575 """Check the node against security_limit and app"""
900987e1c0c4 memory: factorize the node checks in Params.__constructProfileXml souliane <souliane@mailoo.org> parents: 779 diff changeset	576 return self.checkSecurityLimit(node, security_limit) and self.checkApp(node, app)
900987e1c0c4 memory: factorize the node checks in Params.__constructProfileXml souliane <souliane@mailoo.org> parents: 779 diff changeset	577
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	578 def constructProfile(ignore, profile_cache):
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	579 # init the result document
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	580 prof_xml = minidom.parseString('<params/>')
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	581 cache = {}
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	582
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	583 for type_node in self.dom.documentElement.childNodes:
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	584 if type_node.nodeName != C.GENERAL and type_node.nodeName != C.INDIVIDUAL:
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	585 continue
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	586 # we use all params, general and individual
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	587 for cat_node in type_node.childNodes:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	588 if cat_node.nodeName != 'category':
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	589 continue
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	590 category = cat_node.getAttribute('name')
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	591 dest_params = {} # result (merged) params for category
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	592 if category not in cache:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	593 # we make a copy for the new xml
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	594 cache[category] = dest_cat = cat_node.cloneNode(True)
1050 de415d7984f7 memory (params), test: fixes bug relative to parameter filtering souliane <souliane@mailoo.org> parents: 1044 diff changeset	595 to_remove = []
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	596 for node in dest_cat.childNodes:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	597 if node.nodeName != "param":
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	598 continue
784 900987e1c0c4 memory: factorize the node checks in Params.__constructProfileXml souliane <souliane@mailoo.org> parents: 779 diff changeset	599 if not checkNode(node):
1050 de415d7984f7 memory (params), test: fixes bug relative to parameter filtering souliane <souliane@mailoo.org> parents: 1044 diff changeset	600 to_remove.append(node)
779 a978c703bf57 memory: bug fix related to method paramsRegisterApp + getParams was not always returning a Deferred souliane <souliane@mailoo.org> parents: 778 diff changeset	601 continue
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	602 dest_params[node.getAttribute('name')] = node
1050 de415d7984f7 memory (params), test: fixes bug relative to parameter filtering souliane <souliane@mailoo.org> parents: 1044 diff changeset	603 for node in to_remove:
de415d7984f7 memory (params), test: fixes bug relative to parameter filtering souliane <souliane@mailoo.org> parents: 1044 diff changeset	604 dest_cat.removeChild(node)
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	605 new_node = True
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	606 else:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	607 # It's not a new node, we use the previously cloned one
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	608 dest_cat = cache[category]
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	609 new_node = False
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	610 params = cat_node.getElementsByTagName("param")
395 79fe50fc8edc memory: multiples params of the same category are now merged Goffi <goffi@goffi.org> parents: 392 diff changeset	611
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	612 for param_node in params:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	613 # we have to merge new params (we are parsing individual parameters, we have to add them
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	614 # to the previously parsed general ones)
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	615 name = param_node.getAttribute('name')
784 900987e1c0c4 memory: factorize the node checks in Params.__constructProfileXml souliane <souliane@mailoo.org> parents: 779 diff changeset	616 if not checkNode(param_node):
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	617 continue
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	618 if name not in dest_params:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	619 # this is reached when a previous category exists
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	620 dest_params[name] = param_node.cloneNode(True)
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	621 dest_cat.appendChild(dest_params[name])
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	622
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	623 profile_value = self._getParam(category,
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	624 name, type_node.nodeName,
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	625 cache=profile_cache, profile=profile)
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	626 if profile_value is not None:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	627 # there is a value for this profile, we must change the default
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	628 if dest_params[name].getAttribute('type') == 'list':
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	629 for option in dest_params[name].getElementsByTagName("option"):
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	630 if option.getAttribute('value') == profile_value:
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	631 option.setAttribute('selected', 'true')
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	632 else:
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	633 try:
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	634 option.removeAttribute('selected')
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	635 except NotFoundErr:
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	636 pass
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	637 elif dest_params[name].getAttribute('type') == 'jids_list':
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	638 jids = profile_value.split('\t') # FIXME: it's not good to use tabs as separator !
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	639 for jid_ in jids:
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	640 jid_elt = prof_xml.createElement('jid')
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	641 jid_elt.appendChild(prof_xml.createTextNode(jid_))
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	642 dest_params[name].appendChild(jid_elt)
968 75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	643 else:
75f3b3b430ff tools, frontends, memory: param definition and XMLUI handle multi-selection for list widgets: souliane <souliane@mailoo.org> parents: 944 diff changeset	644 dest_params[name].setAttribute('value', profile_value)
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	645 if new_node:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	646 prof_xml.documentElement.appendChild(dest_cat)
395 79fe50fc8edc memory: multiples params of the same category are now merged Goffi <goffi@goffi.org> parents: 392 diff changeset	647
634 ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	648 to_remove = []
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	649 for cat_node in prof_xml.documentElement.childNodes:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	650 # we remove empty categories
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	651 if cat_node.getElementsByTagName("param").length == 0:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	652 to_remove.append(cat_node)
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	653 for node in to_remove:
ca2cae6b2c6d core: security attribute added to the parameters souliane <souliane@mailoo.org> parents: 625 diff changeset	654 prof_xml.documentElement.removeChild(node)
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	655 return prof_xml
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	656
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	657 if profile in self.params:
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	658 d = defer.succeed(None)
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	659 profile_cache = self.params[profile]
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	660 else:
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	661 #profile is not in cache, we load values in a short time cache
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	662 profile_cache = {}
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	663 d = self.loadIndParams(profile, profile_cache)
395 79fe50fc8edc memory: multiples params of the same category are now merged Goffi <goffi@goffi.org> parents: 392 diff changeset	664
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	665 return d.addCallback(constructProfile, profile_cache)
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	666
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	667 def getParamsUI(self, security_limit, app, profile_key):
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	668 """
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	669 @param security_limit: NO_SECURITY_LIMIT (-1) to return all the params.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	670 Otherwise sole the params which have a security level defined and
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	671 lower or equal to the specified value are returned.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	672 @param app: name of the frontend requesting the parameters, or '' to get all parameters
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	673 @param profile_key: Profile key which can be either a magic (eg: @DEFAULT@) or the name of an existing profile.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	674 @return: a SàT XMLUI for parameters
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	675 """
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 79 diff changeset	676 profile = self.getProfileName(profile_key)
d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 79 diff changeset	677 if not profile:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	678 log.error(_("Asking params for inexistant profile"))
105 d2630fba8dfd params to XMLUI tools Goffi <goffi@goffi.org> parents: 79 diff changeset	679 return ""
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	680 d = self.getParams(security_limit, app, profile)
802 9007bb133009 core, frontends: XMLUI refactoring: Goffi <goffi@goffi.org> parents: 784 diff changeset	681 return d.addCallback(lambda param_xml: paramsXML2XMLUI(param_xml))
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	682
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	683 def getParams(self, security_limit, app, profile_key):
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	684 """Construct xml for asked profile, take params xml as skeleton
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	685
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	686 @param security_limit: NO_SECURITY_LIMIT (-1) to return all the params.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	687 Otherwise sole the params which have a security level defined and
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	688 lower or equal to the specified value are returned.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	689 @param app: name of the frontend requesting the parameters, or '' to get all parameters
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	690 @param profile_key: Profile key which can be either a magic (eg: @DEFAULT@) or the name of an existing profile.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	691 @return: XML of parameters
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	692 """
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	693 profile = self.getProfileName(profile_key)
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	694 if not profile:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	695 log.error(_("Asking params for inexistant profile"))
779 a978c703bf57 memory: bug fix related to method paramsRegisterApp + getParams was not always returning a Deferred souliane <souliane@mailoo.org> parents: 778 diff changeset	696 return defer.succeed("")
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	697
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	698 def returnXML(prof_xml):
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	699 return_xml = prof_xml.toxml()
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	700 prof_xml.unlink()
643 262d9d9ad27a plugin XEP-0085: renamed category and parameter souliane <souliane@mailoo.org> parents: 642 diff changeset	701 return '\n'.join((line for line in return_xml.split('\n') if line))
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	702
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	703 return self._constructProfileXml(security_limit, app, profile).addCallback(returnXML)
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	704
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	705 def getParamsForCategory(self, category, security_limit, app, profile_key):
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	706 """
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	707 @param category: the desired category
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	708 @param security_limit: NO_SECURITY_LIMIT (-1) to return all the params.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	709 Otherwise sole the params which have a security level defined and
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	710 lower or equal to the specified value are returned.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	711 @param app: name of the frontend requesting the parameters, or '' to get all parameters
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	712 @param profile_key: Profile key which can be either a magic (eg: @DEFAULT@) or the name of an existing profile.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	713 @return: node's xml for selected category
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	714 """
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	715 #TODO: manage category of general type (without existant profile)
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	716 profile = self.getProfileName(profile_key)
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	717 if not profile:
993 301b342c697a core: use of the new core.log module: Goffi <goffi@goffi.org> parents: 968 diff changeset	718 log.error(_("Asking params for inexistant profile"))
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	719 return ""
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	720
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	721 def returnCategoryXml(prof_xml):
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	722 for node in prof_xml.getElementsByTagName("category"):
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	723 if node.nodeName == "category" and node.getAttribute("name") == category:
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	724 result = node.toxml()
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	725 prof_xml.unlink()
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	726 return result
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	727
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	728 prof_xml.unlink()
6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	729 return "<category />"
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	730
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	731 d = self._constructProfileXml(security_limit, app, profile)
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	732 return d.addCallback(returnCategoryXml)
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	733
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	734 def _getParamNode(self, name, category, type_="@ALL@"): # FIXME: is type_ useful ?
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	735 """Return a node from the param_xml
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	736 @param name: name of the node
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	737 @param category: category of the node
1019 6a16ec17a458 better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1015 diff changeset	738 @param type_: keyword for search:
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	739 @ALL@ search everywhere
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	740 @GENERAL@ only search in general type
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	741 @INDIVIDUAL@ only search in individual type
1019 6a16ec17a458 better PEP-8 compliance souliane <souliane@mailoo.org> parents: 1015 diff changeset	742 @return: a tuple (node type, node) or None if not found"""
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	743
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	744 for type_node in self.dom.documentElement.childNodes:
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	745 if (((type_ == "@ALL@" or type_ == "@GENERAL@") and type_node.nodeName == C.GENERAL)
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	746 or ((type_ == "@ALL@" or type_ == "@INDIVIDUAL@") and type_node.nodeName == C.INDIVIDUAL)):
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	747 for node in type_node.getElementsByTagName('category'):
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	748 if node.getAttribute("name") == category:
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	749 params = node.getElementsByTagName("param")
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	750 for param in params:
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	751 if param.getAttribute("name") == name:
9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	752 return (type_node.nodeName, param)
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	753 return None
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	754
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	755 def getParamsCategories(self):
74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	756 """return the categories availables"""
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	757 categories = []
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	758 for cat in self.dom.getElementsByTagName("category"):
396 cecd22241d56 memory: avoid duplicate in getParamsCategories Goffi <goffi@goffi.org> parents: 395 diff changeset	759 name = cat.getAttribute("name")
cecd22241d56 memory: avoid duplicate in getParamsCategories Goffi <goffi@goffi.org> parents: 395 diff changeset	760 if name not in categories:
cecd22241d56 memory: avoid duplicate in getParamsCategories Goffi <goffi@goffi.org> parents: 395 diff changeset	761 categories.append(cat.getAttribute("name"))
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	762 return categories
74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	763
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	764 def setParam(self, name, value, category, security_limit=C.NO_SECURITY_LIMIT, profile_key=C.PROF_KEY_NONE):
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	765 """Set a parameter, return None if the parameter is not in param xml.
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	766
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	767 Parameter of type 'password' that are not the SàT profile password are
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	768 stored encrypted (if not empty). The profile password is stored hashed
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	769 (if not empty).
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	770
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	771 @param name (str): the parameter name
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	772 @param value (str): the new value
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	773 @param category (str): the parameter category
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	774 @param security_limit (int)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	775 @param profile_key (str): %(doc_profile_key)s
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	776 @return: a deferred None value when everything is done
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	777 """
1534 a5e0393a06cd plugin ip, params: plugin IP discovery, first draft: Goffi <goffi@goffi.org> parents: 1519 diff changeset	778 # FIXME: setParam should accept the right type for value, not only str !
916 1a759096ccbd core: use of Const for profile_key + replaced '@DEFAULT@' default profile_key by '@NONE@' Goffi <goffi@goffi.org> parents: 914 diff changeset	779 if profile_key != C.PROF_KEY_NONE:
392 20f11097d99b memory: general param default value fix Goffi <goffi@goffi.org> parents: 369 diff changeset	780 profile = self.getProfileName(profile_key)
20f11097d99b memory: general param default value fix Goffi <goffi@goffi.org> parents: 369 diff changeset	781 if not profile:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	782 log.error(_(u'Trying to set parameter for an unknown profile'))
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	783 raise exceptions.ProfileUnknownError
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	784
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	785 node = self._getParamNode(name, category, '@ALL@')
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	786 if not node:
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	787 log.error(_(u'Requesting an unknown parameter (%(category)s/%(name)s)')
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	788 % {'category': category, 'name': name})
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	789 return defer.succeed(None)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	790
656 7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	791 if not self.checkSecurityLimit(node[1], security_limit):
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	792 log.warning(_(u"Trying to set parameter '%(param)s' in category '%(cat)s' without authorization!!!"
844 f3513c8cc2e6 misc: fix unnamed arguments in format strings souliane <souliane@mailoo.org> parents: 833 diff changeset	793 % {'param': name, 'cat': category}))
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	794 return defer.succeed(None)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	795
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	796 type_ = node[1].getAttribute("type")
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	797 if type_ == 'int':
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	798 if not value: # replace with the default value (which might also be '')
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	799 value = node[1].getAttribute("value")
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	800 else:
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	801 try:
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	802 int(value)
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	803 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	804 log.debug(_(u"Trying to set parameter '%(param)s' in category '%(cat)s' with an non-integer value"
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	805 % {'param': name, 'cat': category}))
f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	806 return defer.succeed(None)
1226 72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	807 if node[1].hasAttribute("constraint"):
72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	808 constraint = node[1].getAttribute("constraint")
72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	809 try:
72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	810 min_, max_ = [int(limit) for limit in constraint.split(";")]
72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	811 except ValueError:
72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	812 raise exceptions.InternalError("Invalid integer parameter constraint: %s" % constraint)
72f25d671368 memory (params): use more generic param attribute "constraint" instead of "min" and "max" souliane <souliane@mailoo.org> parents: 1222 diff changeset	813 value = str(min(max(int(value), min_), max_))
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	814
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	815 log.info(_("Setting parameter (%(category)s, %(name)s) = %(value)s") %
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	816 {'category': category, 'name': name, 'value': value if type_ != 'password' else '********'})
641 49587e170f53 core: added the security_limit to setParam souliane <souliane@mailoo.org> parents: 639 diff changeset	817
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	818 if node[0] == C.GENERAL:
60 9764e027ecc0 SàT: multi-profile parameters, first draft Goffi <goffi@goffi.org> parents: 57 diff changeset	819 self.params_gen[(category, name)] = value
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	820 self.storage.setGenParam(category, name, value)
423 6c20c76abdcc backend: - bridge async D-Bus method now automatically manage callback and errback, we just have to return a deferred Goffi <goffi@goffi.org> parents: 420 diff changeset	821 for profile in self.storage.getProfilesList():
392 20f11097d99b memory: general param default value fix Goffi <goffi@goffi.org> parents: 369 diff changeset	822 if self.host.isConnected(profile):
20f11097d99b memory: general param default value fix Goffi <goffi@goffi.org> parents: 369 diff changeset	823 self.host.bridge.paramUpdate(name, value, category, profile)
635 eff8772fd472 core: memory's updateEntityData improvments. souliane <souliane@mailoo.org> parents: 634 diff changeset	824 self.host.trigger.point("paramUpdateTrigger", name, value, category, node[0], profile)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	825 return defer.succeed(None)
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	826
1477 ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	827 assert node[0] == C.INDIVIDUAL
ac522c4dab0e core (params): jids_list type management Goffi <goffi@goffi.org> parents: 1460 diff changeset	828 assert profile_key != C.PROF_KEY_NONE
587 952322b1d490 Remove trailing whitespaces. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 574 diff changeset	829
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	830 d_list = []
722 04aabc3f2684 core (memory): fixed setDefault behaviour + minor refactoring Goffi <goffi@goffi.org> parents: 679 diff changeset	831 if type_ == "button":
1409 3265a2639182 massive (preventive) addition of 'u' (unicode) before the strings passed to logging functions souliane <souliane@mailoo.org> parents: 1396 diff changeset	832 log.debug(u"Clicked param button %s" % node.toxml())
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	833 return defer.succeed(None)
1042 59de0c7a28ec memory (params): fixes bugs in setParam: souliane <souliane@mailoo.org> parents: 1039 diff changeset	834 d = defer.succeed(value)
59de0c7a28ec memory (params): fixes bugs in setParam: souliane <souliane@mailoo.org> parents: 1039 diff changeset	835 if type_ == "password":
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	836 try:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	837 personal_key = self.host.memory.auth_sessions.profileGetUnique(profile)[C.MEMORY_CRYPTO_KEY]
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	838 except TypeError:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	839 raise exceptions.InternalError(_('Trying to encrypt a password while the personal key is undefined!'))
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	840 if (category, name) == C.PROFILE_PASS_PATH:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	841 # using 'value' as the encryption key to encrypt another encryption key... could be confusing!
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	842 d_list.append(self.host.memory.encryptPersonalData(data_key=C.MEMORY_CRYPTO_KEY,
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	843 data_value=personal_key,
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	844 crypto_key=value,
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	845 profile=profile))
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	846 d = PasswordHasher.hash(value) # profile password is hashed (empty value stays empty)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	847 elif value: # other non empty passwords are encrypted with the personal key
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	848 d = BlockCipher.encrypt(personal_key, value)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	849
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	850 def gotFinalValue(value):
592 e5a875a3311b Fix pep8 support in src/memory. Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 588 diff changeset	851 if self.host.isConnected(profile): # key can not exists if profile is not connected
412 62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	852 self.params[profile][(category, name)] = value
62b17854254e database integration: first draft Goffi <goffi@goffi.org> parents: 399 diff changeset	853 self.host.bridge.paramUpdate(name, value, category, profile)
635 eff8772fd472 core: memory's updateEntityData improvments. souliane <souliane@mailoo.org> parents: 634 diff changeset	854 self.host.trigger.point("paramUpdateTrigger", name, value, category, node[0], profile)
1042 59de0c7a28ec memory (params): fixes bugs in setParam: souliane <souliane@mailoo.org> parents: 1039 diff changeset	855 return self.storage.setIndParam(category, name, value, profile)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	856
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	857 d.addCallback(gotFinalValue)
1042 59de0c7a28ec memory (params): fixes bugs in setParam: souliane <souliane@mailoo.org> parents: 1039 diff changeset	858 d_list.append(d)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	859 return defer.DeferredList(d_list).addCallback(lambda dummy: None)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	860
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	861 def _getNodesOfTypes(self, attr_type, node_type="@ALL@"):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	862 """Return all the nodes matching the given types.
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	863
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	864 TODO: using during the dev but not anymore... remove if not needed
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	865
1220 f91e7028e2c3 memory (params), tools (xml_tools), plugins, frontends: add "int" parameter type with "min" and "max" attributes souliane <souliane@mailoo.org> parents: 1090 diff changeset	866 @param attr_type (str): the attribute type (string, text, password, bool, int, button, list)
1030 15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	867 @param node_type (str): keyword for filtering:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	868 @ALL@ search everywhere
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	869 @GENERAL@ only search in general type
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	870 @INDIVIDUAL@ only search in individual type
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	871 @return: dict{tuple: node}: a dict {key, value} where:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	872 - key is a couple (attribute category, attribute name)
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	873 - value is a node
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	874 """
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	875 ret = {}
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	876 for type_node in self.dom.documentElement.childNodes:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	877 if (((node_type == "@ALL@" or node_type == "@GENERAL@") and type_node.nodeName == C.GENERAL) or
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	878 ((node_type == "@ALL@" or node_type == "@INDIVIDUAL@") and type_node.nodeName == C.INDIVIDUAL)):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	879 for cat_node in type_node.getElementsByTagName('category'):
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	880 cat = cat_node.getAttribute('name')
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	881 params = cat_node.getElementsByTagName("param")
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	882 for param in params:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	883 if param.getAttribute("type") == attr_type:
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	884 ret[(cat, param.getAttribute("name"))] = param
15f43b54d697 core, memory, bridge: added profile password + password encryption: souliane <souliane@mailoo.org> parents: 1023 diff changeset	885 return ret
17 74a39f40eb6d refactoring: using xml params (not finished yet) Goffi <goffi@goffi.org> parents: 14 diff changeset	886
656 7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	887 def checkSecurityLimit(self, node, security_limit):
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	888 """Check the given node against the given security limit.
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	889 The value NO_SECURITY_LIMIT (-1) means that everything is allowed.
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	890 @return: True if this node can be accessed with the given security limit.
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	891 """
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	892 if security_limit < 0:
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	893 return True
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	894 if node.hasAttribute("security"):
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	895 if int(node.getAttribute("security")) <= security_limit:
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	896 return True
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	897 return False
7d6e5807504a bridge, memory: added the parameter security_limit to asyncGetParamA so it can be used from libervia. refactorization in memory.py are related to that. souliane <souliane@mailoo.org> parents: 645 diff changeset	898
777 5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	899 def checkApp(self, node, app):
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	900 """Check the given node against the given app.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	901 @param node: parameter node
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	902 @param app: name of the frontend requesting the parameters, or '' to get all parameters
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	903 @return: True if this node concerns the given app.
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	904 """
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	905 if not app or not node.hasAttribute("app"):
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	906 return True
5642939d254e core, bridge: new method paramsRegisterApp to register frontend's specific parameters souliane <souliane@mailoo.org> parents: 771 diff changeset	907 return node.getAttribute("app") == app

Mercurial > libervia-backend

annotate src/memory/params.py @ 1534:a5e0393a06cd