Allow SharedPostgreSQL backend, also for new trees (#368)

Author: DavidMStraub

Dockerfile

@@ -43,7 +43,10 @@ ENV GRAMPSWEB_EXPORT_DIR=/app/cache/export
 # install PostgreSQL addon
 RUN wget https://github.com/gramps-project/addons/archive/refs/heads/master.zip \
     && unzip -p master.zip addons-master/gramps$GRAMPS_VERSION/download/PostgreSQL.addon.tgz | \
-    tar -xvz -C /root/.gramps/gramps$GRAMPS_VERSION/plugins && rm master.zip
+    tar -xvz -C /root/.gramps/gramps$GRAMPS_VERSION/plugins \
+    && unzip -p master.zip addons-master/gramps$GRAMPS_VERSION/download/SharedPostgreSQL.addon.tgz | \
+    tar -xvz -C /root/.gramps/gramps$GRAMPS_VERSION/plugins \
+    && rm master.zip
 
 # install gunicorn
 RUN python3 -m pip install --no-cache-dir --extra-index-url https://www.piwheels.org/simple \

gramps_webapi/api/resources/trees.py

@@ -85,9 +85,7 @@ def get(self):
         return [get_tree_details(tree_id) for tree_id in tree_ids]
 
     @use_args(
-        {
-            "name": fields.Str(required=True),
-        },
+        {"name": fields.Str(required=True)},
         location="json",
     )
     def post(self, args):
@@ -96,7 +94,13 @@ def post(self, args):
             abort(405)
         require_permissions([PERM_ADD_TREE])
         tree_id = str(uuid.uuid4())
-        dbmgr = WebDbManager(dirname=tree_id, name=args["name"], create_if_missing=True)
+        backend = current_app.config["NEW_DB_BACKEND"]
+        dbmgr = WebDbManager(
+            dirname=tree_id,
+            name=args["name"],
+            create_if_missing=True,
+            create_backend=backend,
+        )
         return {"name": args["name"], "tree_id": dbmgr.dirname}, 201
 
 

gramps_webapi/app.py

@@ -28,6 +28,7 @@
 from flask_compress import Compress
 from flask_cors import CORS
 from flask_jwt_extended import JWTManager
+from gramps.gen.config import config as gramps_config
 
 from .api import api_blueprint
 from .api.cache import thumbnail_cache
@@ -118,6 +119,11 @@ def create_app(config: Optional[Dict[str, Any]] = None):
             "files to users belonging to different trees!"
         )
 
+    if app.config["TREE"] == TREE_MULTI and app.config["NEW_DB_BACKEND"] != "sqlite":
+        # needed in case a new postgres tree is to be created
+        gramps_config.set("database.host", app.config["POSTGRES_HOST"])
+        gramps_config.set("database.port", app.config["POSTGRES_PORT"])
+
     # load JWT default settings
     app.config.from_object(DefaultConfigJWT)
 

gramps_webapi/auth/__init__.py

@@ -67,7 +67,7 @@ def add_user(
         raise ValueError("Invalid or existing user") from exc
 
 
-def get_guid(name: str) -> None:
+def get_guid(name: str) -> str:
     """Get the GUID of an existing user by username."""
     query = user_db.session.query(User.id)  # pylint: disable=no-member
     user_id = query.filter_by(name=name).scalar()
@@ -76,7 +76,7 @@ def get_guid(name: str) -> None:
     return user_id
 
 
-def get_name(guid: str) -> None:
+def get_name(guid: str) -> str:
     """Get the username of an existing user by GUID."""
     try:
         query = user_db.session.query(User.name)  # pylint: disable=no-member

gramps_webapi/config.py

@@ -46,11 +46,14 @@ class DefaultConfig(object):
     }
     POSTGRES_USER = None
     POSTGRES_PASSWORD = None
+    POSTGRES_HOST = "localhost"
+    POSTGRES_PORT = "5432"
     CELERY_CONFIG: Dict[str, str] = {}
     MEDIA_BASE_DIR = ""
     MEDIA_PREFIX_TREE = False
     REPORT_DIR = str(Path.cwd() / "report_cache")
     EXPORT_DIR = str(Path.cwd() / "export_cache")
+    NEW_DB_BACKEND = "sqlite"
 
 
 class DefaultConfigJWT(object):

gramps_webapi/dbmanager.py

@@ -41,7 +41,7 @@
 class WebDbManager:
     """Database manager class based on Gramps CLI."""
 
-    ALLOWED_DB_BACKENDS = ["sqlite", "postgresql"]
+    ALLOWED_DB_BACKENDS = ["sqlite", "postgresql", "sharedpostgresql"]
 
     def __init__(
         self,
@@ -50,6 +50,7 @@ def __init__(
         username: Optional[str] = None,
         password: Optional[str] = None,
         create_if_missing: bool = True,
+        create_backend: str = "sqlite",
     ) -> None:
         """Initialize given a family tree name or subdirectory name (path)."""
         if dirname:
@@ -65,6 +66,7 @@ def __init__(
         self.username = username
         self.password = password
         self.create_if_missing = create_if_missing
+        self.create_backend = create_backend
         self.path = self._get_path()
         self._check_backend()
 
@@ -111,8 +113,13 @@ def _get_path(self) -> str:
             self._create(path=path)
         return path
 
-    def _create(self, path: str, dbid: str = "sqlite") -> None:
+    def _create(self, path: str) -> None:
         """Create new database."""
+        if self.create_backend not in self.ALLOWED_DB_BACKENDS:
+            raise ValueError(
+                f"Database backend '{self.create_backend}' not supported for new tree."
+            )
+
         if not self.name:
             raise ValueError("Cannot create database if name not specified.")
         os.mkdir(path)
@@ -123,12 +130,12 @@ def _create(self, path: str, dbid: str = "sqlite") -> None:
             name_file.write(self.name)
 
         # create database
-        make_database(dbid)
+        make_database(self.create_backend)
 
         # create dbid file
         backend_path = os.path.join(path, DBBACKEND)
         with open(backend_path, "w", encoding="utf8") as backend_file:
-            backend_file.write(dbid)
+            backend_file.write(self.create_backend)
 
     def _check_backend(self) -> None:
         """Check that the backend is among the allowed backends."""