Consolidates restricted visibility-based filtering (#995)

* Consolidates restricted visibility-based filtering

* Improvements

* Renames base.py to core.py

* Removes unused imports

* Adds restricted filtering for incident types

Author: mvilanova

src/dispatch/alembic/env.py

@@ -4,7 +4,7 @@
 from sqlalchemy import engine_from_config, pool
 
 from dispatch.config import SQLALCHEMY_DATABASE_URI
-from dispatch.database import Base
+from dispatch.database.core import Base
 
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.

src/dispatch/alembic/versions/b6da2dad0396_.py

@@ -8,7 +8,7 @@
 from alembic import op
 import sqlalchemy as sa
 
-from dispatch.database import SessionLocal
+from dispatch.database.core import SessionLocal
 from dispatch.incident_cost_type.models import IncidentCostTypeUpdate
 from dispatch.incident_cost_type import service as incident_cost_type_service
 

src/dispatch/auth/models.py

@@ -10,7 +10,7 @@
 from sqlalchemy import Column, String, Binary, Integer
 from sqlalchemy_utils import TSVectorType
 
-from dispatch.database import Base
+from dispatch.database.core import Base
 from dispatch.models import TimeStampMixin, DispatchBase
 from dispatch.enums import UserRoles
 

src/dispatch/auth/service.py

@@ -14,7 +14,7 @@
 
 from sqlalchemy.orm import Session
 from sqlalchemy.exc import IntegrityError
-from dispatch.database import get_db
+from dispatch.database.core import get_db
 
 from dispatch.plugins.base import plugins
 from dispatch.config import (

src/dispatch/auth/views.py

@@ -4,7 +4,8 @@
 from sqlalchemy.orm import Session
 from dispatch.auth.permissions import AdminPermission, PermissionsDependency
 
-from dispatch.database import get_db, search_filter_sort_paginate
+from dispatch.database.core import get_db
+from dispatch.database.service import search_filter_sort_paginate
 
 from .models import (
     UserLogin,

src/dispatch/cli.py

@@ -13,7 +13,7 @@
 from dispatch.enums import UserRoles
 
 from .main import *  # noqa
-from .database import Base, engine
+from .database.core import Base, engine
 from .exceptions import DispatchException
 from .plugins.base import plugins
 from .scheduler import scheduler
@@ -47,7 +47,7 @@ def plugins_group():
 @plugins_group.command("list")
 def list_plugins():
     """Shows all available plugins"""
-    from dispatch.database import SessionLocal
+    from dispatch.database.core import SessionLocal
     from dispatch.plugin import service as plugin_service
 
     db_session = SessionLocal()
@@ -99,7 +99,7 @@ def list_plugins():
 )
 def install_plugins(force):
     """Installs all plugins, or only one."""
-    from dispatch.database import SessionLocal
+    from dispatch.database.core import SessionLocal
     from dispatch.plugin import service as plugin_service
     from dispatch.plugin.models import Plugin
 
@@ -141,7 +141,7 @@ def install_plugins(force):
 @click.argument("plugins", nargs=-1)
 def uninstall_plugins(plugins):
     """Uninstalls all plugins, or only one."""
-    from dispatch.database import SessionLocal
+    from dispatch.database.core import SessionLocal
     from dispatch.plugin import service as plugin_service
 
     db_session = SessionLocal()
@@ -198,7 +198,7 @@ def dispatch_user():
 )
 def update_user(email: str, role: str):
     """Updates a user's roles."""
-    from dispatch.database import SessionLocal
+    from dispatch.database.core import SessionLocal
     from dispatch.auth import service as user_service
     from dispatch.auth.models import UserUpdate
 
@@ -217,7 +217,7 @@ def update_user(email: str, role: str):
 @click.password_option()
 def reset_user_password(email: str, password: str):
     """Resets a user's password."""
-    from dispatch.database import SessionLocal
+    from dispatch.database.core import SessionLocal
     from dispatch.auth import service as user_service
     from dispatch.auth.models import UserUpdate
 

src/dispatch/conference/models.py

@@ -4,7 +4,7 @@
 from pydantic import validator
 from sqlalchemy import Column, Integer, String, ForeignKey
 
-from dispatch.database import Base
+from dispatch.database.core import Base
 from dispatch.messaging.strings import INCIDENT_CONFERENCE_DESCRIPTION
 from dispatch.models import DispatchBase, ResourceMixin
 

src/dispatch/conversation/messaging.py

@@ -1,4 +1,4 @@
-from dispatch.database import SessionLocal
+from dispatch.database.core import SessionLocal
 from dispatch.plugin import service as plugin_service
 
 

src/dispatch/conversation/models.py

@@ -4,7 +4,7 @@
 
 from sqlalchemy import Column, String, Integer, ForeignKey
 
-from dispatch.database import Base
+from dispatch.database.core import Base
 from dispatch.messaging.strings import INCIDENT_CONVERSATION_DESCRIPTION
 from dispatch.models import DispatchBase, ResourceMixin
 

src/dispatch/database/core.py

@@ -0,0 +1,66 @@
+import re
+import functools
+from typing import Any
+
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base, declared_attr
+from sqlalchemy.orm import sessionmaker
+from sqlalchemy_searchable import make_searchable
+from starlette.requests import Request
+
+from dispatch.config import SQLALCHEMY_DATABASE_URI
+
+
+engine = create_engine(str(SQLALCHEMY_DATABASE_URI))
+SessionLocal = sessionmaker(bind=engine)
+
+
+def resolve_table_name(name):
+    """Resolves table names to their mapped names."""
+    names = re.split("(?=[A-Z])", name)  # noqa
+    return "_".join([x.lower() for x in names if x])
+
+
+raise_attribute_error = object()
+
+
+def resolve_attr(obj, attr, default=None):
+    """Attempts to access attr via dotted notation, returns none if attr does not exist."""
+    try:
+        return functools.reduce(getattr, attr.split("."), obj)
+    except AttributeError:
+        return default
+
+
+class CustomBase:
+    @declared_attr
+    def __tablename__(self):
+        return resolve_table_name(self.__name__)
+
+
+Base = declarative_base(cls=CustomBase)
+make_searchable(Base.metadata)
+
+
+def get_db(request: Request):
+    return request.state.db
+
+
+def get_model_name_by_tablename(table_fullname: str) -> str:
+    """Returns the model name of a given table."""
+    return get_class_by_tablename(table_fullname=table_fullname).__name__
+
+
+def get_class_by_tablename(table_fullname: str) -> Any:
+    """Return class reference mapped to table."""
+    mapped_name = resolve_table_name(table_fullname)
+    for c in Base._decl_class_registry.values():
+        if hasattr(c, "__table__"):
+            if c.__table__.fullname.lower() == mapped_name.lower():
+                return c
+    raise Exception(f"Incorrect tablename '{mapped_name}'. Check the name of your model.")
+
+
+def get_table_name_by_class_instance(class_instance: Base) -> str:
+    """Returns the name of the table for a given class instance."""
+    return class_instance._sa_instance_state.mapper.mapped_table.name