Files
bDS2/lib/bds/projects.ex

381 lines
12 KiB
Elixir

defmodule BDS.Projects do
@moduledoc false
import Ecto.Query
alias BDS.Metadata
alias BDS.Persistence
alias BDS.Projects.Project
alias BDS.Repo
alias BDS.Slug
alias BDS.Templates
@default_project_id "default"
@default_project_name "My Blog"
@typedoc "An attribute map that may use atom or string keys."
@type attrs :: %{optional(atom()) => term(), optional(String.t()) => term()}
@typedoc "Summary map returned for the shell projects panel."
@type project_summary :: %{
id: String.t(),
name: String.t(),
slug: String.t(),
data_path: String.t() | nil,
is_active: boolean()
}
@typedoc "Snapshot returned to the desktop shell."
@type shell_snapshot :: %{
active_project_id: String.t() | nil,
projects: [project_summary()]
}
@spec list_projects() :: [Project.t()]
def list_projects do
Repo.all(from project in Project, order_by: [asc: project.created_at])
end
@spec get_active_project() :: Project.t() | nil
def get_active_project do
Repo.one(from project in Project, where: project.is_active == true, limit: 1)
end
@spec shell_snapshot() :: shell_snapshot()
def shell_snapshot do
_ = ensure_default_project()
projects = list_projects()
active_project = Enum.find(projects, & &1.is_active)
%{
active_project_id: active_project && active_project.id,
projects: Enum.map(projects, &project_summary/1)
}
end
@spec get_project(String.t()) :: Project.t() | nil
def get_project(id), do: Repo.get(Project, id)
@spec get_project!(String.t()) :: Project.t()
def get_project!(id), do: Repo.get!(Project, id)
@spec ensure_default_project() :: {:ok, Project.t()} | {:error, term()}
def ensure_default_project do
case Repo.get(Project, @default_project_id) do
%Project{} = project ->
{:ok, project}
nil ->
now = Persistence.now_ms()
is_active = not Repo.exists?(from project in Project, where: project.is_active == true)
# The default project's public content folder is created at the per-user
# default content location on first launch — never in the repo or the
# private app dir (PublicContentLivesInProjectFolder).
data_path = default_project_dir(@default_project_id)
File.mkdir_p!(data_path)
Repo.transaction(fn ->
project =
%Project{}
|> Project.changeset(%{
id: @default_project_id,
name: @default_project_name,
slug: unique_slug(Slug.slugify(@default_project_name)),
description: nil,
data_path: data_path,
created_at: now,
updated_at: now,
is_active: is_active
})
|> Repo.insert!()
project
end)
|> case do
{:ok, project} ->
record_project_location(project.id, data_path)
rebuild_project_templates(project)
{:error, reason} ->
{:error, reason}
end
end
end
@spec project_data_dir(Project.t()) :: String.t()
def project_data_dir(%Project{data_path: data_path}) when is_binary(data_path) and data_path != "",
do: data_path
# A project without an explicit data_path resolves to its folder under the
# per-user default content location — never priv/data inside the repo
# (PublicContentLivesInProjectFolder).
def project_data_dir(%Project{id: id}), do: default_project_dir(id)
@doc """
Per-user base directory that holds the public, portable content of projects
created without an explicit folder (the default project on first launch).
Configurable via `:default_content_root`; otherwise the user's home dir under
`bds/`. Never the application repo nor `private_dir/0`
(PublicContentLivesInProjectFolder).
"""
@spec default_content_root() :: String.t()
def default_content_root do
case Application.get_env(:bds, :default_content_root) do
root when is_binary(root) -> Path.expand(root)
_other -> Path.join(System.user_home!(), "bds")
end
end
defp default_project_dir(project_id), do: Path.join(default_content_root(), project_id)
@doc """
The OS per-user app-data directory holding machine-specific, regenerable
artifacts only (database, embeddings index, model cache, project registry,
UI state) — never project content (PrivateArtifactsLiveInOsAppDir).
"""
@spec private_dir() :: String.t()
def private_dir, do: private_app_dir()
@spec project_cache_dir(Project.t() | String.t()) :: String.t()
def project_cache_dir(%Project{} = project), do: project_cache_dir(project.id)
def project_cache_dir(project_id) when is_binary(project_id) do
Path.join([project_cache_root(), "projects", project_id])
end
@spec create_project(attrs()) :: {:ok, Project.t()} | {:error, term()}
def create_project(attrs) do
now = Persistence.now_ms()
name = attr(attrs, :name) || ""
slug = unique_slug(attr(attrs, :slug) || Slug.slugify(name))
Repo.transaction(fn ->
project =
%Project{}
|> Project.changeset(%{
id: Ecto.UUID.generate(),
name: name,
slug: slug,
description: attr(attrs, :description),
data_path: attr(attrs, :data_path),
created_at: now,
updated_at: now,
is_active: false
})
|> Repo.insert!()
project
end)
|> case do
{:ok, project} ->
record_project_location(project.id, project_data_dir(project))
with {:ok, project} <- rebuild_project_templates(project) do
sync_filesystem_metadata(project)
end
{:error, reason} ->
{:error, reason}
end
end
@spec set_active_project(String.t()) :: {:ok, Project.t()} | {:error, :not_found | term()}
def set_active_project(project_id) do
case Repo.get(Project, project_id) do
nil ->
{:error, :not_found}
project ->
now = Persistence.now_ms()
previous_active_id =
Repo.one(from p in Project, where: p.is_active == true, select: p.id)
Repo.transaction(fn ->
Repo.update_all(
from(p in Project, where: p.is_active == true),
set: [is_active: false, updated_at: now]
)
project
|> Project.changeset(%{is_active: true, updated_at: now})
|> Repo.update!()
end)
|> case do
{:ok, active_project} ->
# Force-save the outgoing project's embedding index (DebouncedPersistence).
if is_binary(previous_active_id) and previous_active_id != active_project.id do
BDS.Embeddings.Index.flush(previous_active_id)
end
{:ok, active_project}
{:error, reason} ->
{:error, reason}
end
end
end
@spec delete_project(String.t()) ::
{:ok, Project.t()}
| {:error,
:not_found | :cannot_delete_default_project | :cannot_delete_active_project | term()}
def delete_project(project_id) when is_binary(project_id) do
case Repo.get(Project, project_id) do
nil ->
{:error, :not_found}
%Project{id: @default_project_id} ->
{:error, :cannot_delete_default_project}
%Project{is_active: true} ->
{:error, :cannot_delete_active_project}
%Project{} = project ->
data_dir = project_data_dir(project)
# App-managed folders (those under the per-user default content location)
# are removed; user-chosen external folders are preserved.
managed_dir =
if String.starts_with?(data_dir, default_content_root()), do: data_dir, else: nil
cleanup_dirs =
[managed_dir, project_cache_dir(project)] |> Enum.filter(&is_binary/1) |> Enum.uniq()
Repo.transaction(fn ->
case Repo.delete(project) do
{:ok, deleted} -> deleted
{:error, changeset} -> Repo.rollback(changeset)
end
end)
|> case do
{:ok, deleted_project} ->
BDS.Embeddings.Index.forget(deleted_project.id)
forget_project_location(deleted_project.id)
Enum.each(cleanup_dirs, fn dir ->
_ = File.rm_rf(dir)
end)
{:ok, deleted_project}
{:error, reason} ->
{:error, reason}
end
end
end
defp project_summary(%Project{} = project) do
%{
id: project.id,
name: project.name,
slug: project.slug,
data_path: project.data_path,
is_active: project.is_active
}
end
defp sync_filesystem_metadata(%Project{data_path: nil} = project), do: {:ok, project}
defp sync_filesystem_metadata(%Project{} = project) do
case Metadata.sync_project_metadata_from_filesystem(project.id) do
{:ok, _metadata} -> {:ok, get_project!(project.id)}
{:error, reason} -> {:error, reason}
end
end
defp rebuild_project_templates(%Project{} = project) do
with {:ok, _templates} <- Templates.rebuild_templates_from_files(project.id) do
{:ok, project}
end
end
defp unique_slug(base_slug) do
normalized = if base_slug in [nil, ""], do: "project", else: base_slug
if slug_available?(normalized) do
normalized
else
find_unique_slug(normalized, 2)
end
end
defp find_unique_slug(base_slug, suffix) do
candidate = "#{base_slug}-#{suffix}"
if slug_available?(candidate) do
candidate
else
find_unique_slug(base_slug, suffix + 1)
end
end
defp slug_available?(slug) do
not Repo.exists?(from project in Project, where: project.slug == ^slug)
end
defp project_cache_root do
case Application.get_env(:bds, :project_cache_root) do
root when is_binary(root) -> Path.expand(root)
# Private app-internal artifacts (e.g. the embeddings index) live under the
# OS private app directory — on macOS ~/Library/Application Support/bds —
# never inside the repo or a project's public folder. Colocating them with
# project_data_dir would pollute (and historically committed to) the repo.
_other -> private_app_dir()
end
end
defp private_app_dir do
case :filename.basedir(:user_config, "bds") do
path when is_list(path) -> List.to_string(path)
path -> path
end
|> Path.expand()
end
@doc """
Path to the machine-local project registry: a `id => data_path` pointer file
under `private_dir/0` that remembers where each project's folder currently
lives. The folder location is never embedded in `meta/project.json`, so a
project folder can be moved or renamed and only the registry is updated
(DataPathNotPersistedInProjectJson).
"""
@spec registry_path() :: String.t()
def registry_path, do: Path.join(private_dir(), "project_registry.json")
@doc "Reads the machine-local project registry as an `id => data_path` map."
@spec project_registry() :: %{optional(String.t()) => String.t()}
def project_registry do
with {:ok, contents} <- File.read(registry_path()),
{:ok, map} when is_map(map) <- Jason.decode(contents) do
map
else
_ -> %{}
end
end
defp record_project_location(project_id, data_path) when is_binary(data_path) do
project_registry() |> Map.put(project_id, data_path) |> write_registry()
end
defp forget_project_location(project_id) do
project_registry() |> Map.delete(project_id) |> write_registry()
end
defp write_registry(registry) do
path = registry_path()
File.mkdir_p!(Path.dirname(path))
File.write(path, Jason.encode!(registry))
end
defp attr(attrs, key) do
cond do
Map.has_key?(attrs, key) -> Map.get(attrs, key)
Map.has_key?(attrs, Atom.to_string(key)) -> Map.get(attrs, Atom.to_string(key))
true -> nil
end
end
end