Ben Stull
87 lines
3.3 KiB
Python
87 lines
3.3 KiB
Python
"""§22 collection grain — resolution helpers beneath the project tier.
|
|
|
|
In S1 each project has exactly one collection (the default). These helpers
|
|
recover the collection for a project and read the per-corpus fields (`type`,
|
|
`initial_state`) that moved down from `projects` in migration 029. Project-grain
|
|
authz (auth.py) recovers a row's project by joining `collections` on
|
|
`collection_id`.
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
from . import db
|
|
|
|
DEFAULT_COLLECTION_ID = "default"
|
|
|
|
|
|
def default_collection_id(project_id: str) -> str:
|
|
"""The id of a project's default (S1: sole) collection. Falls back to the
|
|
literal 'default' when the project has no collection row yet."""
|
|
row = db.conn().execute(
|
|
"SELECT id FROM collections WHERE project_id = ? ORDER BY created_at, id LIMIT 1",
|
|
(project_id,),
|
|
).fetchone()
|
|
return row["id"] if row else DEFAULT_COLLECTION_ID
|
|
|
|
|
|
def project_of_collection(collection_id: str) -> str | None:
|
|
"""The project a collection belongs to, or None if unknown."""
|
|
row = db.conn().execute(
|
|
"SELECT project_id FROM collections WHERE id = ?", (collection_id,)
|
|
).fetchone()
|
|
return row["project_id"] if row else None
|
|
|
|
|
|
def collection_initial_state(collection_id: str) -> str:
|
|
"""§22.4b landing state for new entries in a collection. 'super-draft'
|
|
default for an unknown/unset row (today's safe flow)."""
|
|
row = db.conn().execute(
|
|
"SELECT initial_state FROM collections WHERE id = ?", (collection_id,)
|
|
).fetchone()
|
|
if row is None or not row["initial_state"]:
|
|
return "super-draft"
|
|
return row["initial_state"]
|
|
|
|
|
|
def collection_type(collection_id: str) -> str:
|
|
"""The collection's immutable §22.4a type. 'document' default for unknown."""
|
|
row = db.conn().execute(
|
|
"SELECT type FROM collections WHERE id = ?", (collection_id,)
|
|
).fetchone()
|
|
return row["type"] if row and row["type"] else "document"
|
|
|
|
|
|
def subfolder_of(collection_id: str) -> str:
|
|
"""The content-repo subfolder a collection lives under (§22.3). Empty string
|
|
for the default collection (entries at the repo root `rfcs/`)."""
|
|
row = db.conn().execute(
|
|
"SELECT subfolder FROM collections WHERE id = ?", (collection_id,)
|
|
).fetchone()
|
|
return (row["subfolder"] if row else "") or ""
|
|
|
|
|
|
def get_collection(collection_id: str) -> dict | None:
|
|
"""The full collection row as a dict, or None if unknown."""
|
|
row = db.conn().execute(
|
|
"SELECT id, project_id, type, subfolder, initial_state, visibility, name "
|
|
"FROM collections WHERE id = ?",
|
|
(collection_id,),
|
|
).fetchone()
|
|
return dict(row) if row else None
|
|
|
|
|
|
def list_collections(project_id: str, include_unlisted: bool = False) -> list[dict]:
|
|
"""Collections in a project, the default first then by name (§22.5). `unlisted`
|
|
is omitted from enumeration unless include_unlisted (a direct-id read or the
|
|
corpus mirror, which serves every collection)."""
|
|
rows = db.conn().execute(
|
|
"SELECT id, project_id, type, subfolder, initial_state, visibility, name "
|
|
"FROM collections WHERE project_id = ? ORDER BY (id != 'default'), name, id",
|
|
(project_id,),
|
|
).fetchall()
|
|
out: list[dict] = []
|
|
for r in rows:
|
|
if not include_unlisted and r["visibility"] == "unlisted":
|
|
continue
|
|
out.append(dict(r))
|
|
return out
|