Implement public actor ICS endpoint and event ICS export

Closes #83 and #84

Signed-off-by: Thomas Citharel <tcit@tcit.fr>

lib/service/export/feed.ex

@@ -0,0 +1,93 @@
+defmodule Mobilizon.Service.Export.Feed do
+  @moduledoc """
+  Serve Atom Syndication Feeds
+  """
+
+  alias Mobilizon.Actors
+  alias Mobilizon.Actors.Actor
+  alias Mobilizon.Events
+  alias Mobilizon.Events.Event
+  alias Atomex.{Feed, Entry}
+  import MobilizonWeb.Gettext
+  alias MobilizonWeb.Router.Helpers, as: Routes
+  alias MobilizonWeb.Endpoint
+
+  @version Mix.Project.config()[:version]
+  def version(), do: @version
+
+  @spec create_cache(String.t()) :: {:commit, String.t()} | {:ignore, any()}
+  def create_cache("actor_" <> name) do
+    with {:ok, res} <- fetch_actor_event_feed(name) do
+      {:commit, res}
+    else
+      err ->
+        {:ignore, err}
+    end
+  end
+
+  @spec fetch_actor_event_feed(String.t()) :: String.t()
+  defp fetch_actor_event_feed(name) do
+    with %Actor{} = actor <- Actors.get_local_actor_by_name(name),
+         {:ok, events, _count} <- Events.get_public_events_for_actor(actor) do
+      {:ok, build_actor_feed(actor, events)}
+    else
+      err ->
+        {:error, err}
+    end
+  end
+
+  # Build an atom feed from actor and it's public events
+  @spec build_actor_feed(Actor.t(), list()) :: String.t()
+  defp build_actor_feed(%Actor{} = actor, events) do
+    display_name = Actor.display_name(actor)
+    self_url = Routes.feed_url(Endpoint, :actor, actor.preferred_username, "atom") |> URI.decode()
+
+    # Title uses default instance language
+    feed =
+      Feed.new(
+        self_url,
+        DateTime.utc_now(),
+        gettext("%{actor}'s public events feed", actor: display_name)
+      )
+      |> Feed.author(display_name, uri: actor.url)
+      |> Feed.link(self_url, rel: "self")
+      |> Feed.link(actor.url, rel: "alternate")
+      |> Feed.generator("Mobilizon", uri: "https://joinmobilizon.org", version: version())
+      |> Feed.entries(Enum.map(events, &get_entry/1))
+
+    feed = if actor.avatar_url, do: Feed.icon(feed, actor.avatar_url), else: feed
+
+    feed =
+      if actor.banner_url,
+        do: Feed.logo(feed, actor.banner_url),
+        else: feed
+
+    feed
+    |> Feed.build()
+    |> Atomex.generate_document()
+  end
+
+  # Create an entry for the Atom feed
+  @spec get_entry(Event.t()) :: any()
+  defp get_entry(%Event{} = event) do
+    with {:ok, html, []} <- Earmark.as_html(event.description) do
+      entry =
+        Entry.new(event.url, event.publish_at || event.inserted_at, event.title)
+        |> Entry.link(event.url, rel: "alternate", type: "text/html")
+        |> Entry.content({:cdata, html}, type: "html")
+        |> Entry.published(event.publish_at || event.inserted_at)
+
+      # Add tags
+      entry =
+        event.tags
+        |> Enum.uniq()
+        |> Enum.reduce(entry, fn tag, acc -> Entry.category(acc, tag.slug, label: tag.title) end)
+
+      Entry.build(entry)
+    else
+      {:error, _html, error_messages} ->
+        require Logger
+        Logger.error("Unable to produce HTML for Markdown", details: inspect(error_messages))
+    end
+  end
+end

lib/service/export/icalendar.ex

@@ -0,0 +1,75 @@
+defmodule Mobilizon.Service.Export.ICalendar do
+  @moduledoc """
+  Export an event to iCalendar format
+  """
+
+  alias Mobilizon.Events.Event
+  alias Mobilizon.Events
+  alias Mobilizon.Actors.Actor
+  alias Mobilizon.Actors
+
+  @doc """
+  Export a public event to iCalendar format.
+
+  The event must have a visibility of `:public` or `:unlisted`
+  """
+  @spec export_public_event(Event.t()) :: {:ok, String.t()}
+  def export_public_event(%Event{visibility: visibility} = event)
+      when visibility in [:public, :unlisted] do
+    {:ok, %ICalendar{events: [do_export_event(event)]} |> ICalendar.to_ics()}
+  end
+
+  @spec export_public_event(Event.t()) :: {:error, :event_not_public}
+  def export_public_event(%Event{}), do: {:error, :event_not_public}
+
+  @spec do_export_event(Event.t()) :: ICalendar.Event.t()
+  defp do_export_event(%Event{} = event) do
+    %ICalendar.Event{
+      summary: event.title,
+      dtstart: event.begins_on,
+      dtend: event.ends_on,
+      description: event.description,
+      uid: event.uuid,
+      categories: [event.category] ++ (event.tags |> Enum.map(& &1.slug))
+    }
+  end
+
+  @doc """
+  Export a public actor's events to iCalendar format.
+
+  The events must have a visibility of `:public` or `:unlisted`
+  """
+  # TODO: The actor should also have visibility options
+  @spec export_public_actor(Actor.t()) :: String.t()
+  def export_public_actor(%Actor{} = actor) do
+    with {:ok, events, _} <- Events.get_public_events_for_actor(actor) do
+      {:ok, %ICalendar{events: events |> Enum.map(&do_export_event/1)} |> ICalendar.to_ics()}
+    end
+  end
+
+  @doc """
+  Create cache for an actor
+  """
+  def create_cache("actor_" <> name) do
+    with %Actor{} = actor <- Actors.get_local_actor_by_name(name),
+         {:ok, res} <- export_public_actor(actor) do
+      {:commit, res}
+    else
+      err ->
+        {:ignore, err}
+    end
+  end
+
+  @doc """
+  Create cache for an actor
+  """
+  def create_cache("event_" <> uuid) do
+    with %Event{} = event <- Events.get_event_full_by_uuid(uuid),
+         {:ok, res} <- export_public_event(event) do
+      {:commit, res}
+    else
+      err ->
+        {:ignore, err}
+    end
+  end
+end