X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=osm_common%2Fdbbase.py;h=c71c5e1a8cb54dd915f73d7df7a5f92c6f01c811;hb=399f6c3acc2e8852d463844a562bcde063c912e2;hp=95250c18bf285c172a8397153746bb6b2e219551;hpb=54a5464d6d6d64cfd083ecda739b796d63a860b2;p=osm%2Fcommon.git diff --git a/osm_common/dbbase.py b/osm_common/dbbase.py index 95250c1..c71c5e1 100644 --- a/osm_common/dbbase.py +++ b/osm_common/dbbase.py @@ -61,7 +61,7 @@ class DbBase(object): """ 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 @@ -137,11 +137,22 @@ class DbBase(object): 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 set_one(self, table, q_filter, update_dict, fail_on_empty=True, unset=None, pull=None, push=None): + 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, + push_list=None): """ Modifies an entry at database :param table: collection or table @@ -155,16 +166,26 @@ class DbBase(object): 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 + :param push_list: Same as push but values are arrays where each item is and appended instead of appending the + whole array :return: Dict with the number of entries modified. None if no matching is found. """ 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, push_list=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 + :param push_list: Same as push but values are arrays where each item is and appended instead of appending the + whole array :return: Dict with the number of entries modified """ raise DbException("Method 'set_list' not implemented") @@ -212,6 +233,13 @@ class DbBase(object): 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 @@ -221,6 +249,7 @@ class DbBase(object): :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: @@ -240,6 +269,7 @@ class DbBase(object): :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: @@ -254,26 +284,29 @@ class DbBase(object): 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): + def encrypt_decrypt_fields(self, item, action, fields=None, flags=None, 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 + if flags is None: + flags = re.I - def process(item): - if isinstance(item, list): - for elem in item: + 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) + elif isinstance(_item, dict): + for key, val in _item.items(): + if isinstance(val, str): + if any(re.search(f, key, flags) for f in fields): + _item[key] = method(val, schema_version, salt) else: process(val) - process(item)