Add space group as another layer as unions of spaces (#72)

* Add engagement as another layer as unions of spaces

* Rename globally to user groups and space groups

source/docq/manage_settings.py

@@ -22,6 +22,15 @@
 USER_ID_AS_SYSTEM = 0
 
 
+def _init() -> None:
+    """Initialize the database."""
+    with closing(
+        sqlite3.connect(get_sqlite_system_file(), detect_types=sqlite3.PARSE_DECLTYPES)
+    ) as connection, closing(connection.cursor()) as cursor:
+        cursor.execute(SQL_CREATE_SETTINGS_TABLE)
+        connection.commit()
+
+
 def _get_sqlite_file(user_id: int = None) -> str:
     """Get the sqlite file for the given user."""
     return get_sqlite_usage_file(user_id) if user_id else get_sqlite_system_file()
@@ -32,7 +41,6 @@ def _get_settings(user_id: int = None) -> dict:
     with closing(
         sqlite3.connect(_get_sqlite_file(user_id), detect_types=sqlite3.PARSE_DECLTYPES)
     ) as connection, closing(connection.cursor()) as cursor:
-        cursor.execute(SQL_CREATE_SETTINGS_TABLE)
         id_ = user_id or USER_ID_AS_SYSTEM
         rows = cursor.execute(
             "SELECT key, val FROM settings WHERE user_id = ?",
@@ -48,7 +56,6 @@ def _update_settings(settings: dict, user_id: int = None) -> bool:
     with closing(
         sqlite3.connect(_get_sqlite_file(user_id), detect_types=sqlite3.PARSE_DECLTYPES)
     ) as connection, closing(connection.cursor()) as cursor:
-        cursor.execute(SQL_CREATE_SETTINGS_TABLE)
         id_ = user_id or USER_ID_AS_SYSTEM
         cursor.executemany(
             "INSERT OR REPLACE INTO settings (user_id, key, val) VALUES (?, ?, ?)",

source/docq/manage_space_groups.py

@@ -0,0 +1,152 @@
+"""Functions to manage space groups."""
+
+import logging as log
+import sqlite3
+from contextlib import closing
+from datetime import datetime
+from typing import List, Tuple
+
+from .support.store import get_sqlite_system_file
+
+SQL_CREATE_SPACE_GROUPS_TABLE = """
+CREATE TABLE IF NOT EXISTS space_groups (
+    id INTEGER PRIMARY KEY,
+    name TEXT UNIQUE,
+    summary TEXT,
+    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+)
+"""
+
+SQL_CREATE_SPACE_GROUP_MEMBERS_TABLE = """
+CREATE TABLE IF NOT EXISTS space_group_members (
+    group_id INTEGER NOT NULL,
+    space_id INTEGER NOT NULL,
+    FOREIGN KEY (group_id) REFERENCES space_groups (id) ON DELETE CASCADE,
+    FOREIGN KEY (space_id) REFERENCES spaces (id),
+    PRIMARY KEY (group_id, space_id)
+)
+"""
+
+
+def _init() -> None:
+    """Initialize the database."""
+    with closing(
+        sqlite3.connect(get_sqlite_system_file(), detect_types=sqlite3.PARSE_DECLTYPES)
+    ) as connection, closing(connection.cursor()) as cursor:
+        cursor.execute(SQL_CREATE_SPACE_GROUPS_TABLE)
+        cursor.execute(SQL_CREATE_SPACE_GROUP_MEMBERS_TABLE)
+        connection.commit()
+
+
+def list_space_groups(name_match: str = None) -> List[Tuple[int, str, List[Tuple[int, str]], datetime, datetime]]:
+    """List space groups.
+
+    Args:
+        name_match (str, optional): The space group name match. Defaults to None.
+
+    Returns:
+        List[Tuple[int, str, List[Tuple[int, str]], datetime, datetime]]: The list of space groups.
+    """
+    log.debug("Listing space groups: %s", name_match)
+    with closing(
+        sqlite3.connect(get_sqlite_system_file(), detect_types=sqlite3.PARSE_DECLTYPES)
+    ) as connection, closing(connection.cursor()) as cursor:
+        space_groups = cursor.execute(
+            "SELECT id, name, summary, created_at, updated_at FROM space_groups WHERE name LIKE ?",
+            (f"%{name_match}%" if name_match else "%",),
+        ).fetchall()
+
+        members = cursor.execute(
+            "SELECT c.group_id, s.id, s.name from spaces s, space_group_members c WHERE c.group_id in ({}) AND c.space_id = s.id".format(  # noqa: S608
+                ",".join([str(x[0]) for x in space_groups])
+            )
+        ).fetchall()
+
+        return [(x[0], x[1], x[2], [(y[1], y[2]) for y in members if y[0] == x[0]], x[3], x[4]) for x in space_groups]
+
+
+def create_space_group(name: str, summary: str = None) -> bool:
+    """Create a space group.
+
+    Args:
+        name (str): The space group name.
+        summary (str, optional): The space group summary. Defaults to None.
+
+    Returns:
+        bool: True if the space group is created, False otherwise.
+    """
+    log.debug("Creating space group: %s", name)
+    with closing(
+        sqlite3.connect(get_sqlite_system_file(), detect_types=sqlite3.PARSE_DECLTYPES)
+    ) as connection, closing(connection.cursor()) as cursor:
+        cursor.execute(
+            "INSERT INTO space_groups (name, summary) VALUES (?, ?)",
+            (
+                name,
+                summary,
+            ),
+        )
+        connection.commit()
+        return True
+
+
+def update_space_group(id_: int, members: List[int], name: str = None, summary: str = None) -> bool:
+    """Update a group.
+
+    Args:
+        id_ (int): The group id.
+        members (List[int]): The list of space ids.
+        name (str, optional): The group name. Defaults to None.
+        summary (str, optional): The group summary. Defaults to None.
+
+    Returns:
+        bool: True if the group is updated, False otherwise.
+    """
+    log.debug("Updating space group: %d", id_)
+
+    query = "UPDATE space_groups SET updated_at = ?"
+    params = [
+        datetime.now(),
+    ]
+
+    if name:
+        query += ", name = ?"
+        params.append(name)
+
+    if summary:
+        query += ", summary = ?"
+        params.append(summary)
+
+    query += " WHERE id = ?"
+    params.append(id_)
+
+    with closing(
+        sqlite3.connect(get_sqlite_system_file(), detect_types=sqlite3.PARSE_DECLTYPES)
+    ) as connection, closing(connection.cursor()) as cursor:
+        cursor.execute(query, params)
+        cursor.execute("DELETE FROM space_group_members WHERE group_id = ?", (id_,))
+        cursor.executemany(
+            "INSERT INTO space_group_members (group_id, space_id) VALUES (?, ?)", [(id_, x) for x in members]
+        )
+        connection.commit()
+        return True
+
+
+def delete_space_group(id_: int) -> bool:
+    """Delete an space group.
+
+    Args:
+        id_ (int): The space group id.
+
+    Returns:
+        bool: True if the space group is deleted, False otherwise.
+    """
+    log.debug("Deleting group: %d", id_)
+    with closing(
+        sqlite3.connect(get_sqlite_system_file(), detect_types=sqlite3.PARSE_DECLTYPES)
+    ) as connection, closing(connection.cursor()) as cursor:
+        cursor.execute("DELETE FROM space_group_members WHERE group_id = ?", (id_,))
+        cursor.execute("DELETE FROM space_groups WHERE id = ?", (id_,))
+        connection.commit()
+        return True