From 02997b2522b9c66072b16f1425c02e81e0085e3c Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Tue, 14 Jul 2020 21:10:56 +0200 Subject: Rename web-server to API This change renames the web-server component to API in order to be more descriptive of its role. The OpenDC API bridges between the frontend on one side and the database and simulator on the other side. --- web-server/opendc/models/__init__.py | 0 web-server/opendc/models/model.py | 59 ----------------------------------- web-server/opendc/models/portfolio.py | 24 -------------- web-server/opendc/models/prefab.py | 26 --------------- web-server/opendc/models/project.py | 31 ------------------ web-server/opendc/models/scenario.py | 26 --------------- web-server/opendc/models/topology.py | 27 ---------------- web-server/opendc/models/trace.py | 7 ----- web-server/opendc/models/user.py | 36 --------------------- 9 files changed, 236 deletions(-) delete mode 100644 web-server/opendc/models/__init__.py delete mode 100644 web-server/opendc/models/model.py delete mode 100644 web-server/opendc/models/portfolio.py delete mode 100644 web-server/opendc/models/prefab.py delete mode 100644 web-server/opendc/models/project.py delete mode 100644 web-server/opendc/models/scenario.py delete mode 100644 web-server/opendc/models/topology.py delete mode 100644 web-server/opendc/models/trace.py delete mode 100644 web-server/opendc/models/user.py (limited to 'web-server/opendc/models') diff --git a/web-server/opendc/models/__init__.py b/web-server/opendc/models/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/web-server/opendc/models/model.py b/web-server/opendc/models/model.py deleted file mode 100644 index bcb833ae..00000000 --- a/web-server/opendc/models/model.py +++ /dev/null @@ -1,59 +0,0 @@ -from uuid import uuid4 - -from opendc.util.database import DB -from opendc.util.exceptions import ClientError -from opendc.util.rest import Response - - -class Model: - """Base class for all models.""" - - collection_name = '' - - @classmethod - def from_id(cls, _id): - """Fetches the document with given ID from the collection.""" - return cls(DB.fetch_one({'_id': _id}, cls.collection_name)) - - @classmethod - def get_all(cls): - """Fetches all documents from the collection.""" - return cls(DB.fetch_all({}, cls.collection_name)) - - def __init__(self, obj): - self.obj = obj - - def get_id(self): - """Returns the ID of the enclosed object.""" - return str(self.obj['_id']) - - def check_exists(self): - """Raises an error if the enclosed object does not exist.""" - if self.obj is None: - raise ClientError(Response(404, 'Not found.')) - - def set_property(self, key, value): - """Sets the given property on the enclosed object, with support for simple nested access.""" - if '.' in key: - keys = key.split('.') - self.obj[keys[0]][keys[1]] = value - else: - self.obj[key] = value - - def insert(self): - """Inserts the enclosed object and generates a UUID for it.""" - self.obj['_id'] = str(uuid4()) - DB.insert(self.obj, self.collection_name) - - def update(self): - """Updates the enclosed object and updates the internal reference to the newly inserted object.""" - DB.update(self.get_id(), self.obj, self.collection_name) - - def delete(self): - """Deletes the enclosed object in the database, if it existed.""" - if self.obj is None: - return None - - old_object = self.obj.copy() - DB.delete_one({'_id': self.get_id()}, self.collection_name) - return old_object diff --git a/web-server/opendc/models/portfolio.py b/web-server/opendc/models/portfolio.py deleted file mode 100644 index 32961b63..00000000 --- a/web-server/opendc/models/portfolio.py +++ /dev/null @@ -1,24 +0,0 @@ -from opendc.models.model import Model -from opendc.models.user import User -from opendc.util.exceptions import ClientError -from opendc.util.rest import Response - - -class Portfolio(Model): - """Model representing a Portfolio.""" - - collection_name = 'portfolios' - - def check_user_access(self, google_id, edit_access): - """Raises an error if the user with given [google_id] has insufficient access. - - Checks access on the parent project. - - :param google_id: The Google ID of the user. - :param edit_access: True when edit access should be checked, otherwise view access. - """ - user = User.from_google_id(google_id) - authorizations = list( - filter(lambda x: str(x['projectId']) == str(self.obj['projectId']), user.obj['authorizations'])) - if len(authorizations) == 0 or (edit_access and authorizations[0]['authorizationLevel'] == 'VIEW'): - raise ClientError(Response(403, 'Forbidden from retrieving/editing portfolio.')) diff --git a/web-server/opendc/models/prefab.py b/web-server/opendc/models/prefab.py deleted file mode 100644 index 70910c4a..00000000 --- a/web-server/opendc/models/prefab.py +++ /dev/null @@ -1,26 +0,0 @@ -from opendc.models.model import Model -from opendc.models.user import User -from opendc.util.exceptions import ClientError -from opendc.util.rest import Response - - -class Prefab(Model): - """Model representing a Project.""" - - collection_name = 'prefabs' - - def check_user_access(self, google_id): - """Raises an error if the user with given [google_id] has insufficient access to view this prefab. - - :param google_id: The Google ID of the user. - """ - user = User.from_google_id(google_id) - - #try: - - print(self.obj) - if self.obj['authorId'] != user.get_id() and self.obj['visibility'] == "private": - raise ClientError(Response(403, "Forbidden from retrieving prefab.")) - #except KeyError: - # OpenDC-authored objects don't necessarily have an authorId - # return diff --git a/web-server/opendc/models/project.py b/web-server/opendc/models/project.py deleted file mode 100644 index b57e9f77..00000000 --- a/web-server/opendc/models/project.py +++ /dev/null @@ -1,31 +0,0 @@ -from opendc.models.model import Model -from opendc.models.user import User -from opendc.util.database import DB -from opendc.util.exceptions import ClientError -from opendc.util.rest import Response - - -class Project(Model): - """Model representing a Project.""" - - collection_name = 'projects' - - def check_user_access(self, google_id, edit_access): - """Raises an error if the user with given [google_id] has insufficient access. - - :param google_id: The Google ID of the user. - :param edit_access: True when edit access should be checked, otherwise view access. - """ - user = User.from_google_id(google_id) - authorizations = list(filter(lambda x: str(x['projectId']) == str(self.get_id()), - user.obj['authorizations'])) - if len(authorizations) == 0 or (edit_access and authorizations[0]['authorizationLevel'] == 'VIEW'): - raise ClientError(Response(403, "Forbidden from retrieving project.")) - - def get_all_authorizations(self): - """Get all user IDs having access to this project.""" - return [ - str(user['_id']) for user in DB.fetch_all({'authorizations': { - 'projectId': self.obj['_id'] - }}, User.collection_name) - ] diff --git a/web-server/opendc/models/scenario.py b/web-server/opendc/models/scenario.py deleted file mode 100644 index 8d53e408..00000000 --- a/web-server/opendc/models/scenario.py +++ /dev/null @@ -1,26 +0,0 @@ -from opendc.models.model import Model -from opendc.models.portfolio import Portfolio -from opendc.models.user import User -from opendc.util.exceptions import ClientError -from opendc.util.rest import Response - - -class Scenario(Model): - """Model representing a Scenario.""" - - collection_name = 'scenarios' - - def check_user_access(self, google_id, edit_access): - """Raises an error if the user with given [google_id] has insufficient access. - - Checks access on the parent project. - - :param google_id: The Google ID of the user. - :param edit_access: True when edit access should be checked, otherwise view access. - """ - portfolio = Portfolio.from_id(self.obj['portfolioId']) - user = User.from_google_id(google_id) - authorizations = list( - filter(lambda x: str(x['projectId']) == str(portfolio.obj['projectId']), user.obj['authorizations'])) - if len(authorizations) == 0 or (edit_access and authorizations[0]['authorizationLevel'] == 'VIEW'): - raise ClientError(Response(403, 'Forbidden from retrieving/editing scenario.')) diff --git a/web-server/opendc/models/topology.py b/web-server/opendc/models/topology.py deleted file mode 100644 index cb4c4bab..00000000 --- a/web-server/opendc/models/topology.py +++ /dev/null @@ -1,27 +0,0 @@ -from opendc.models.model import Model -from opendc.models.user import User -from opendc.util.exceptions import ClientError -from opendc.util.rest import Response - - -class Topology(Model): - """Model representing a Project.""" - - collection_name = 'topologies' - - def check_user_access(self, google_id, edit_access): - """Raises an error if the user with given [google_id] has insufficient access. - - Checks access on the parent project. - - :param google_id: The Google ID of the user. - :param edit_access: True when edit access should be checked, otherwise view access. - """ - user = User.from_google_id(google_id) - if 'projectId' not in self.obj: - raise ClientError(Response(400, 'Missing projectId in topology.')) - - authorizations = list( - filter(lambda x: str(x['projectId']) == str(self.obj['projectId']), user.obj['authorizations'])) - if len(authorizations) == 0 or (edit_access and authorizations[0]['authorizationLevel'] == 'VIEW'): - raise ClientError(Response(403, 'Forbidden from retrieving topology.')) diff --git a/web-server/opendc/models/trace.py b/web-server/opendc/models/trace.py deleted file mode 100644 index 2f6e4926..00000000 --- a/web-server/opendc/models/trace.py +++ /dev/null @@ -1,7 +0,0 @@ -from opendc.models.model import Model - - -class Trace(Model): - """Model representing a Trace.""" - - collection_name = 'traces' diff --git a/web-server/opendc/models/user.py b/web-server/opendc/models/user.py deleted file mode 100644 index 8e8ff945..00000000 --- a/web-server/opendc/models/user.py +++ /dev/null @@ -1,36 +0,0 @@ -from opendc.models.model import Model -from opendc.util.database import DB -from opendc.util.exceptions import ClientError -from opendc.util.rest import Response - - -class User(Model): - """Model representing a User.""" - - collection_name = 'users' - - @classmethod - def from_email(cls, email): - """Fetches the user with given email from the collection.""" - return User(DB.fetch_one({'email': email}, User.collection_name)) - - @classmethod - def from_google_id(cls, google_id): - """Fetches the user with given Google ID from the collection.""" - return User(DB.fetch_one({'googleId': google_id}, User.collection_name)) - - def check_correct_user(self, request_google_id): - """Raises an error if a user tries to modify another user. - - :param request_google_id: - """ - if request_google_id is not None and self.obj['googleId'] != request_google_id: - raise ClientError(Response(403, f'Forbidden from editing user with ID {self.obj["_id"]}.')) - - def check_already_exists(self): - """Checks if the user already exists in the database.""" - - existing_user = DB.fetch_one({'googleId': self.obj['googleId']}, self.collection_name) - - if existing_user is not None: - raise ClientError(Response(409, 'User already exists.')) -- cgit v1.2.3