prop/lib/microwaveprop/beacons.ex

defmodule Microwaveprop.Beacons do
  @moduledoc """
  The Beacons context. Anyone can submit a beacon — authenticated or not —
  but submissions are held as unapproved until an admin approves them.
  Only approved beacons appear in the public list.
  """

  import Ecto.Query, warn: false

  alias Microwaveprop.Accounts.User
  alias Microwaveprop.Beacons.Beacon
  alias Microwaveprop.Repo

  @topic "beacons"

  @doc """
  Subscribes to beacon change notifications. Messages:

    * `{:created, %Beacon{}}`
    * `{:updated, %Beacon{}}`
    * `{:deleted, %Beacon{}}`
  """
  @spec subscribe_beacons() :: :ok | {:error, term()}
  def subscribe_beacons do
    Phoenix.PubSub.subscribe(Microwaveprop.PubSub, @topic)
  end

  defp broadcast(message) do
    Phoenix.PubSub.broadcast(Microwaveprop.PubSub, @topic, message)
  end

  @doc "Returns approved beacons ordered by most recently added."
  @spec list_beacons() :: [Beacon.t()]
  def list_beacons do
    Repo.all(
      from b in Beacon,
        where: b.approved == true,
        order_by: [desc: b.inserted_at],
        limit: 500
    )
  end

  @doc """
  Base Ecto query for approved beacons. Used as a `live_table`
  `data_provider` so sort/search/pagination can be applied on top.
  """
  @spec approved_beacons_query() :: Ecto.Query.t()
  def approved_beacons_query do
    from b in Beacon, as: :resource, where: b.approved == true
  end

  @doc "Returns unapproved beacons awaiting admin review."
  @spec list_pending_beacons() :: [Beacon.t()]
  def list_pending_beacons do
    Repo.all(
      from b in Beacon,
        where: b.approved == false,
        order_by: [asc: b.inserted_at]
    )
  end

  @doc """
  Returns beacons that the given user submitted, newest first. Used by
  the `/u/:callsign` profile page. Pending (unapproved) beacons are
  filtered out unless the viewer is the profile owner or an admin —
  the public profile must not leak the existence of pending drafts.
  """
  @spec list_beacons_for_user(User.t(), User.t() | nil) :: [Beacon.t()]
  def list_beacons_for_user(%User{} = owner, viewer \\ nil) do
    Beacon
    |> where([b], b.user_id == ^owner.id)
    |> filter_unapproved_for_viewer(owner, viewer)
    |> order_by([b], desc: b.inserted_at)
    |> Repo.all()
  end

  defp filter_unapproved_for_viewer(query, %User{id: owner_id}, %User{id: viewer_id}) when owner_id == viewer_id,
    do: query

  defp filter_unapproved_for_viewer(query, _owner, %User{is_admin: true}), do: query

  defp filter_unapproved_for_viewer(query, _owner, _viewer) do
    where(query, [b], b.approved == true)
  end

  @doc "Gets a single beacon. Raises if not found."
  @spec get_beacon!(Ecto.UUID.t()) :: Beacon.t() | [Beacon.t()] | nil
  def get_beacon!(id), do: Beacon |> Repo.get!(id) |> Repo.preload(:user)

  @doc """
  Returns a beacon only if the viewer is allowed to see it. Approved
  beacons are visible to everyone; pending (unapproved) beacons are
  visible only to the submitter and admins. Returns `nil` for
  not-found, malformed ids, and unauthorized viewers — callers render
  the same 404 in each case so existence of a pending beacon is not
  observable.
  """
  @spec get_visible_beacon(Ecto.UUID.t() | String.t(), User.t() | nil) :: Beacon.t() | nil
  def get_visible_beacon(id, viewer) do
    case fetch_beacon(id) do
      nil -> nil
      beacon -> if can_view?(beacon, viewer), do: beacon
    end
  end

  defp fetch_beacon(id) do
    with {:ok, uuid} <- Ecto.UUID.cast(id),
         %Beacon{} = beacon <- Repo.get(Beacon, uuid) do
      Repo.preload(beacon, :user)
    else
      _ -> nil
    end
  end

  defp can_view?(%Beacon{approved: true}, _viewer), do: true
  defp can_view?(%Beacon{}, %User{is_admin: true}), do: true
  defp can_view?(%Beacon{user_id: uid}, %User{id: uid}) when not is_nil(uid), do: true
  defp can_view?(%Beacon{}, _viewer), do: false

  @doc """
  Creates a beacon. When a user is provided they are recorded as the
  creator; anonymous submissions pass `nil` and leave `user_id` unset.
  """
  @spec create_beacon(User.t() | nil, map()) :: {:ok, Beacon.t()} | {:error, Ecto.Changeset.t()}
  def create_beacon(user, attrs)

  def create_beacon(%User{} = user, attrs) do
    %Beacon{user_id: user.id}
    |> Beacon.changeset(attrs)
    |> Repo.insert()
    |> broadcast_if_ok(:created)
  end

  def create_beacon(nil, attrs) do
    %Beacon{}
    |> Beacon.changeset(attrs)
    |> Repo.insert()
    |> broadcast_if_ok(:created)
  end

  @doc "Updates a beacon."
  @spec update_beacon(Beacon.t(), map()) :: {:ok, Beacon.t()} | {:error, Ecto.Changeset.t()}
  def update_beacon(%Beacon{} = beacon, attrs) do
    beacon
    |> Beacon.changeset(attrs)
    |> Repo.update()
    |> broadcast_if_ok(:updated)
  end

  @doc "Marks a beacon as approved, making it visible in the public list."
  @spec approve_beacon(Beacon.t() | binary()) ::
          {:ok, Beacon.t()} | {:error, Ecto.Changeset.t()} | {:error, :not_found}
  def approve_beacon(id) when is_binary(id) do
    case Repo.get(Beacon, id) do
      nil -> {:error, :not_found}
      beacon -> approve_beacon(beacon)
    end
  end

  def approve_beacon(%Beacon{} = beacon) do
    beacon
    |> Ecto.Changeset.change(approved: true)
    |> Repo.update()
    |> broadcast_if_ok(:updated)
  end

  @doc "Deletes a beacon."
  @spec delete_beacon(Beacon.t() | binary()) ::
          {:ok, Beacon.t()} | {:error, Ecto.Changeset.t()} | {:error, :not_found}
  def delete_beacon(id) when is_binary(id) do
    case Repo.get(Beacon, id) do
      nil -> {:error, :not_found}
      beacon -> delete_beacon(beacon)
    end
  end

  def delete_beacon(%Beacon{} = beacon) do
    case Repo.delete(beacon) do
      {:ok, beacon} ->
        _ = broadcast({:deleted, beacon})
        {:ok, beacon}

      other ->
        other
    end
  end

  @doc "Returns an `%Ecto.Changeset{}` for tracking beacon changes."
  @spec change_beacon(Beacon.t(), map()) :: Ecto.Changeset.t()
  def change_beacon(%Beacon{} = beacon, attrs \\ %{}) do
    Beacon.changeset(beacon, attrs)
  end

  defp broadcast_if_ok({:ok, beacon} = result, type) do
    _ = broadcast({type, beacon})
    result
  end

  defp broadcast_if_ok(other, _type), do: other
end