import yaml
import logging
+import re
from http import HTTPStatus
from copy import deepcopy
from Crypto.Cipher import AES
"""
Connect to database
:param config: Configuration of database. Contains among others:
- host: database hosst (mandatory)
+ host: database host (mandatory)
port: database port (mandatory)
name: database name (mandatory)
user: database username
"""
raise DbException("Method 'get_list' not implemented")
+ def count(self, table, q_filter=None):
+ """
+ Count the number of entries matching q_filter
+ :param table: collection or table
+ :param q_filter: Filter
+ :return: number of entries found (can be zero)
+ :raise: DbException on error
+ """
+ raise DbException("Method 'count' not implemented")
+
def get_one(self, table, q_filter=None, fail_on_empty=True, fail_on_more=True):
"""
Obtain one entry matching q_filter
Add a new entry at database
:param table: collection or table
:param indata: content to be added
- :return: database id of the inserted element. Raises a DbException on error
+ :return: database '_id' of the inserted element. Raises a DbException on error
"""
raise DbException("Method 'create' not implemented")
+ def create_list(self, table, indata_list):
+ """
+ Add several entries at once
+ :param table: collection or table
+ :param indata_list: list of elements to insert. Each element must be a dictionary.
+ An '_id' key based on random uuid is added at each element if missing
+ :return: list of inserted '_id's. Exception on error
+ """
+ raise DbException("Method 'create_list' not implemented")
+
def set_one(self, table, q_filter, update_dict, fail_on_empty=True, unset=None, pull=None, push=None):
"""
Modifies an entry at database
"""
raise DbException("Method 'set_one' not implemented")
- def set_list(self, table, q_filter, update_dict):
+ def set_list(self, table, q_filter, update_dict, unset=None, pull=None, push=None):
"""
Modifies al matching entries at database
:param table: collection or table
:param q_filter: Filter
:param update_dict: Plain dictionary with the content to be updated. It is a dot separated keys and a value
+ :param unset: Plain dictionary with the content to be removed if exist. It is a dot separated keys, value is
+ ignored. If not exist, it is ignored
+ :param pull: Plain dictionary with the content to be removed from an array. It is a dot separated keys and value
+ if exist in the array is removed. If not exist, it is ignored
+ :param push: Plain dictionary with the content to be appended to an array. It is a dot separated keys and value
+ is appended to the end of the array
:return: Dict with the number of entries modified
"""
raise DbException("Method 'set_list' not implemented")
self.secret_key = None
self.secret_key = self._join_secret_key(new_secret_key)
+ def get_secret_key(self):
+ """
+ Get the database secret key in case it is not done when "connect" is called. It can happens when database is
+ empty after an initial install. It should skip if secret is already obtained.
+ """
+ pass
+
def encrypt(self, value, schema_version=None, salt=None):
"""
Encrypt a value
:param salt: optional salt to be used. Must be str
:return: Encrypted content of value
"""
+ self.get_secret_key()
if not self.secret_key or not schema_version or schema_version == '1.0':
return value
else:
:param salt: optional salt to be used
:return: Plain content of value
"""
+ self.get_secret_key()
if not self.secret_key or not schema_version or schema_version == '1.0':
return value
else:
http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
return unpadded_private_msg
+ def encrypt_decrypt_fields(self, item, action, fields=None, flags=re.I, schema_version=None, salt=None):
+ if not fields:
+ return
+ self.get_secret_key()
+ actions = ['encrypt', 'decrypt']
+ if action.lower() not in actions:
+ raise DbException("Unknown action ({}): Must be one of {}".format(action, actions),
+ http_code=HTTPStatus.INTERNAL_SERVER_ERROR)
+ method = self.encrypt if action.lower() == 'encrypt' else self.decrypt
+
+ def process(item):
+ if isinstance(item, list):
+ for elem in item:
+ process(elem)
+ elif isinstance(item, dict):
+ for key, val in item.items():
+ if any(re.search(f, key, flags) for f in fields) and isinstance(val, str):
+ item[key] = method(val, schema_version, salt)
+ else:
+ process(val)
+
+ process(item)
+
def deep_update_rfc7396(dict_to_change, dict_reference, key_list=None):
"""
Nothing happens if no match is found. If the value is None the matched elements are deleted.
$key: val In case a dictionary is passed in yaml format, if looks for all items in the array dict_to_change
that are dictionaries and contains this <key> equal to <val>. Several keys can be used by yaml
- format '{key: val, key: val, ...}'; and all of them mast match. Nothing happens if no match is
+ format '{key: val, key: val, ...}'; and all of them must match. Nothing happens if no match is
found. If value is None the matched items are deleted, otherwise they are edited.
$+val If no match if found (see '$val'), the value is appended to the array. If any match is found nothing
is changed. A value of None has not sense.
projects / osm / common.git / blobdiff