# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
import logging
from uuid import uuid4
from http import HTTPStatus
from time import time
from osm_common.dbbase import deep_update_rfc7396
-from validation import validate_input, ValidationError
+from validation import validate_input, ValidationError, is_valid_uuid
__author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
topic_msg = None # to_override
schema_new = None # to_override
schema_edit = None # to_override
+ multiproject = True # True if this Topic can be shared by several projects. Then it contains _admin.projects_read
+
+ # Alternative ID Fields for some Topics
+ alt_id_field = {
+ "projects": "name",
+ "users": "username",
+ "roles": "name",
+ "roles_operations": "name"
+ }
def __init__(self, db, fs, msg):
self.db = db
self.msg = msg
self.logger = logging.getLogger("nbi.engine")
+ @staticmethod
+ def id_field(topic, value):
+ """Returns ID Field for given topic and field value"""
+ if topic in BaseTopic.alt_id_field.keys() and not is_valid_uuid(value):
+ return BaseTopic.alt_id_field[topic]
+ else:
+ return "_id"
+
@staticmethod
def _remove_envelop(indata=None):
if not indata:
return input
@staticmethod
- def _get_project_filter(session, write=False, show_all=True):
+ def _get_project_filter(session):
"""
Generates a filter dictionary for querying database, so that only allowed items for this project can be
addressed. Only propietary or public can be used. Allowed projects are at _admin.project_read/write. If it is
not present or contains ANY mean public.
- :param session: contains "username", if user is "admin" and the working "project_id"
- :param write: if operation is for reading (False) or writing (True)
- :param show_all: if True it will show public or
- :return:
- """
- if write:
- k = "_admin.projects_write.cont"
- else:
- k = "_admin.projects_read.cont"
- if not show_all:
- return {k: session["project_id"]}
- elif session["admin"]: # and show_all: # allows all
- return {}
- else:
- return {k: ["ANY", session["project_id"], None]}
-
- def check_conflict_on_new(self, session, indata, force=False):
+ :param session: contains:
+ project_id: project list this session has rights to access. Can be empty, one or several
+ set_project: items created will contain this project list
+ force: True or False
+ public: True, False or None
+ method: "list", "show", "write", "delete"
+ admin: True or False
+ :return: dictionary with project filter
+ """
+ p_filter = {}
+ project_filter_n = []
+ project_filter = list(session["project_id"])
+
+ if session["method"] not in ("list", "delete"):
+ if project_filter:
+ project_filter.append("ANY")
+ elif session["public"] is not None:
+ if session["public"]:
+ project_filter.append("ANY")
+ else:
+ project_filter_n.append("ANY")
+
+ if session.get("PROJECT.ne"):
+ project_filter_n.append(session["PROJECT.ne"])
+
+ if project_filter:
+ if session["method"] in ("list", "show", "delete") or session.get("set_project"):
+ p_filter["_admin.projects_read.cont"] = project_filter
+ else:
+ p_filter["_admin.projects_write.cont"] = project_filter
+ if project_filter_n:
+ if session["method"] in ("list", "show", "delete") or session.get("set_project"):
+ p_filter["_admin.projects_read.ncont"] = project_filter_n
+ else:
+ p_filter["_admin.projects_write.ncont"] = project_filter_n
+
+ return p_filter
+
+ def check_conflict_on_new(self, session, indata):
"""
Check that the data to be inserted is valid
- :param session: contains "username", if user is "admin" and the working "project_id"
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
:param indata: data to be inserted
- :param force: boolean. With force it is more tolerant
:return: None or raises EngineException
"""
pass
- def check_conflict_on_edit(self, session, final_content, edit_content, _id, force=False):
+ def check_conflict_on_edit(self, session, final_content, edit_content, _id):
"""
Check that the data to be edited/uploaded is valid
- :param session: contains "username", if user is "admin" and the working "project_id"
- :param final_content: data once modified
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param final_content: data once modified. This methdo may change it.
:param edit_content: incremental data that contains the modifications to apply
:param _id: internal _id
- :param force: boolean. With force it is more tolerant
:return: None or raises EngineException
"""
- pass
+ if not self.multiproject:
+ return
+ # Change public status
+ if session["public"] is not None:
+ if session["public"] and "ANY" not in final_content["_admin"]["projects_read"]:
+ final_content["_admin"]["projects_read"].append("ANY")
+ final_content["_admin"]["projects_write"].clear()
+ if not session["public"] and "ANY" in final_content["_admin"]["projects_read"]:
+ final_content["_admin"]["projects_read"].remove("ANY")
+
+ # Change project status
+ if session.get("set_project"):
+ for p in session["set_project"]:
+ if p not in final_content["_admin"]["projects_read"]:
+ final_content["_admin"]["projects_read"].append(p)
def check_unique_name(self, session, name, _id=None):
"""
Check that the name is unique for this project
- :param session: contains "username", if user is "admin" and the working "project_id"
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
:param name: name to be checked
:param _id: If not None, ignore this entry that are going to change
:return: None or raises EngineException
"""
- _filter = self._get_project_filter(session, write=False, show_all=False)
+ if not self.multiproject:
+ _filter = {}
+ else:
+ _filter = self._get_project_filter(session)
_filter["name"] = name
if _id:
_filter["_id.neq"] = _id
"""
Modifies content descriptor to include _admin
:param content: descriptor to be modified
- :param project_id: if included, it add project read/write permissions
+ :param project_id: if included, it add project read/write permissions. Can be None or a list
:param make_public: if included it is generated as public for reading.
:return: None, but content is modified
"""
content["_admin"]["modified"] = now
if not content.get("_id"):
content["_id"] = str(uuid4())
- if project_id:
+ if project_id is not None:
if not content["_admin"].get("projects_read"):
- content["_admin"]["projects_read"] = [project_id]
+ content["_admin"]["projects_read"] = list(project_id)
if make_public:
content["_admin"]["projects_read"].append("ANY")
if not content["_admin"].get("projects_write"):
- content["_admin"]["projects_write"] = [project_id]
+ content["_admin"]["projects_write"] = list(project_id)
@staticmethod
def format_on_edit(final_content, edit_content):
content.pop("_admin", None)
self.msg.write(self.topic_msg, action, content)
- def check_conflict_on_del(self, session, _id, force=False):
+ def check_conflict_on_del(self, session, _id, db_content):
"""
Check if deletion can be done because of dependencies if it is not force. To override
- :param session: contains "username", if user is "admin" and the working "project_id"
- :param _id: itnernal _id
- :param force: Avoid this checking
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id: internal _id
+ :param db_content: The database content of this item _id
:return: None if ok or raises EngineException with the conflict
"""
pass
Update descriptor with the kwargs. It contains dot separated keys
:param desc: dictionary to be updated
:param kwargs: plain dictionary to be used for updating.
- :return: None, 'desc' is modified. It raises EngineException.
+ :return: None, 'desc' is modified. It raises EngineException.
"""
if not kwargs:
return
def show(self, session, _id):
"""
Get complete information on an topic
- :param session: contains the used login username and working project
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
:param _id: server internal id
:return: dictionary, raise exception if not found.
"""
- filter_db = self._get_project_filter(session, write=False, show_all=True)
- filter_db["_id"] = _id
+ if not self.multiproject:
+ filter_db = {}
+ else:
+ filter_db = self._get_project_filter(session)
+ # To allow project&user addressing by name AS WELL AS _id
+ filter_db[BaseTopic.id_field(self.topic, _id)] = _id
return self.db.get_one(self.topic, filter_db)
# TODO transform data for SOL005 URL requests
# TODO remove _admin if not admin
def get_file(self, session, _id, path=None, accept_header=None):
"""
Only implemented for descriptor topics. Return the file content of a descriptor
- :param session: contains the used login username and working project
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
:param _id: Identity of the item to get content
:param path: artifact path or "$DESCRIPTOR" or None
:param accept_header: Content of Accept header. Must contain applition/zip or/and text/plain
"""
if not filter_q:
filter_q = {}
-
- filter_q.update(self._get_project_filter(session, write=False, show_all=True))
+ if self.multiproject:
+ filter_q.update(self._get_project_filter(session))
# TODO transform data for SOL005 URL requests. Transform filtering
# TODO implement "field-type" query string SOL005
return self.db.get_list(self.topic, filter_q)
- def new(self, rollback, session, indata=None, kwargs=None, headers=None, force=False, make_public=False):
+ def new(self, rollback, session, indata=None, kwargs=None, headers=None):
"""
Creates a new entry into database.
:param rollback: list to append created items at database in case a rollback may to be done
- :param session: contains the used login username and working project
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
:param indata: data to be inserted
:param kwargs: used to override the indata descriptor
:param headers: http request headers
- :param force: If True avoid some dependence checks
- :param make_public: Make the created item public to all projects
:return: _id: identity of the inserted data.
"""
try:
# Override descriptor with query string kwargs
self._update_input_with_kwargs(content, kwargs)
- content = self._validate_input_new(content, force=force)
- self.check_conflict_on_new(session, content, force=force)
- self.format_on_new(content, project_id=session["project_id"], make_public=make_public)
+ content = self._validate_input_new(content, force=session["force"])
+ self.check_conflict_on_new(session, content)
+ self.format_on_new(content, project_id=session["project_id"], make_public=session["public"])
_id = self.db.create(self.topic, content)
rollback.append({"topic": self.topic, "_id": _id})
self._send_msg("create", content)
except ValidationError as e:
raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
- def upload_content(self, session, _id, indata, kwargs, headers, force=False):
+ def upload_content(self, session, _id, indata, kwargs, headers):
"""
Only implemented for descriptor topics. Used for receiving content by chunks (with a transaction_id header
and/or gzip file. It will store and extract)
- :param session: session
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
:param _id : the database id of entry to be updated
:param indata: http body request
:param kwargs: user query string to override parameters. NOT USED
:param headers: http request headers
- :param force: to be more tolerant with validation
:return: True package has is completely uploaded or False if partial content has been uplodaed.
Raise exception on error
"""
def delete_list(self, session, filter_q=None):
"""
Delete a several entries of a topic. This is for internal usage and test only, not exposed to NBI API
- :param session: contains the used login username and working project
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
:param filter_q: filter of data to be applied
:return: The deleted list, it can be empty if no one match the filter.
"""
# TODO add admin to filter, validate rights
if not filter_q:
filter_q = {}
- filter_q.update(self._get_project_filter(session, write=True, show_all=True))
+ if self.multiproject:
+ filter_q.update(self._get_project_filter(session))
return self.db.del_list(self.topic, filter_q)
- def delete(self, session, _id, force=False, dry_run=False):
+ def delete_extra(self, session, _id, db_content):
+ """
+ Delete other things apart from database entry of a item _id.
+ e.g.: other associated elements at database and other file system storage
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id: server internal id
+ :param db_content: The database content of the _id. It is already deleted when reached this method, but the
+ content is needed in same cases
+ :return: None if ok or raises EngineException with the problem
+ """
+ pass
+
+ def delete(self, session, _id, dry_run=False):
"""
Delete item by its internal _id
- :param session: contains the used login username, working project, and admin rights
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
:param _id: server internal id
- :param force: indicates if deletion must be forced in case of conflict
:param dry_run: make checking but do not delete
:return: dictionary with deleted item _id. It raises EngineException on error: not found, conflict, ...
"""
+
+ # To allow addressing projects and users by name AS WELL AS by _id
+ filter_q = {BaseTopic.id_field(self.topic, _id): _id}
+ item_content = self.db.get_one(self.topic, filter_q)
+
# TODO add admin to filter, validate rights
# data = self.get_item(topic, _id)
- self.check_conflict_on_del(session, _id, force)
- filter_q = self._get_project_filter(session, write=True, show_all=True)
- filter_q["_id"] = _id
- if not dry_run:
+ self.check_conflict_on_del(session, _id, item_content)
+ if dry_run:
+ return None
+
+ if self.multiproject:
+ filter_q.update(self._get_project_filter(session))
+ if self.multiproject and session["project_id"]:
+ # remove reference from project_read. If not last delete
+ self.db.set_one(self.topic, filter_q, update_dict=None,
+ pull={"_admin.projects_read": {"$in": session["project_id"]}})
+ # try to delete if there is not any more reference from projects. Ignore if it is not deleted
+ filter_q = {'_id': _id, '_admin.projects_read': [[], ["ANY"]]}
+ v = self.db.del_one(self.topic, filter_q, fail_on_empty=False)
+ if not v or not v["deleted"]:
+ return v
+ else:
v = self.db.del_one(self.topic, filter_q)
- self._send_msg("deleted", {"_id": _id})
- return v
- return None
+ self.delete_extra(session, _id, item_content)
+ self._send_msg("deleted", {"_id": _id})
+ return v
- def edit(self, session, _id, indata=None, kwargs=None, force=False, content=None):
+ def edit(self, session, _id, indata=None, kwargs=None, content=None):
+ """
+ Change the content of an item
+ :param session: contains "username", "admin", "force", "public", "project_id", "set_project"
+ :param _id: server internal id
+ :param indata: contains the changes to apply
+ :param kwargs: modifies indata
+ :param content: original content of the item
+ :return:
+ """
indata = self._remove_envelop(indata)
# Override descriptor with query string kwargs
if kwargs:
self._update_input_with_kwargs(indata, kwargs)
try:
- indata = self._validate_input_edit(indata, force=force)
+ if indata and session.get("set_project"):
+ raise EngineException("Cannot edit content and set to project (query string SET_PROJECT) at same time",
+ HTTPStatus.UNPROCESSABLE_ENTITY)
+ indata = self._validate_input_edit(indata, force=session["force"])
# TODO self._check_edition(session, indata, _id, force)
if not content:
content = self.show(session, _id)
deep_update_rfc7396(content, indata)
- self.check_conflict_on_edit(session, content, indata, _id=_id, force=force)
+ self.check_conflict_on_edit(session, content, indata, _id=_id)
self.format_on_edit(content, indata)
- self.db.replace(self.topic, _id, content)
+ # To allow project addressing by name AS WELL AS _id
+ # self.db.replace(self.topic, _id, content)
+ cid = content.get("_id")
+ self.db.replace(self.topic, cid if cid else _id, content)
indata.pop("_admin", None)
indata["_id"] = _id
self._send_msg("edit", indata)
- return id
+ return _id
except ValidationError as e:
raise EngineException(e, HTTPStatus.UNPROCESSABLE_ENTITY)
projects / osm / NBI.git / blobdiff