debianize-mobilizon/lib/service/export/icalendar.ex
Thomas Citharel 1893d9f55b
Various refactoring and typespec improvements
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
2021-09-26 17:52:24 +02:00

144 lines
4.1 KiB
Elixir

defmodule Mobilizon.Service.Export.ICalendar do
@moduledoc """
Export an event to iCalendar format.
"""
alias Mobilizon.Actors.Actor
alias Mobilizon.Addresses.Address
alias Mobilizon.{Config, Events}
alias Mobilizon.Events.Event
alias Mobilizon.Service.Export.Common
alias Mobilizon.Service.Formatter.HTML
@item_limit 500
@doc """
Create cache for an actor, an event or an user token
"""
@spec create_cache(String.t()) :: {:commit, String.t()} | {:ignore, atom()}
def create_cache("actor_" <> name) do
case export_public_actor(name) do
{:ok, res} ->
{:commit, res}
{:error, err} ->
{:ignore, err}
end
end
def create_cache("event_" <> uuid) do
with %Event{} = event <- Events.get_public_event_by_uuid_with_preload(uuid),
{:ok, res} <- export_public_event(event) do
{:commit, res}
else
{:error, err} ->
{:ignore, err}
nil ->
{:ignore, :event_not_found}
end
end
def create_cache("token_" <> token) do
case fetch_events_from_token(token) do
{:ok, res} ->
{:commit, res}
{:error, err} ->
{:ignore, err}
end
end
def create_cache("instance") do
{:ok, res} = fetch_instance_feed()
{:commit, res}
end
@spec fetch_instance_feed :: {:ok, String.t()}
defp fetch_instance_feed do
{:ok, events, _posts} = Common.fetch_instance_public_content(@item_limit)
{:ok, %ICalendar{events: events |> Enum.map(&do_export_event/1)} |> ICalendar.to_ics()}
end
@doc """
Export an event to iCalendar format.
"""
@spec export_event(Event.t()) :: {:ok, String.t()}
def export_event(%Event{} = event), do: {:ok, events_to_ics([event])}
@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()} | {:error, :event_not_public}
def export_public_event(%Event{visibility: visibility} = event)
when visibility in [:public, :unlisted] do
{:ok, events_to_ics([event])}
end
def export_public_event(%Event{}), do: {:error, :event_not_public}
@doc """
Export a public actor's events to iCalendar format.
The actor must have a visibility of `:public` or `:unlisted`, as well as the events
"""
@spec export_public_actor(String.t()) ::
{:ok, String.t()} | {:error, :actor_not_public | :actor_not_found}
def export_public_actor(name, limit \\ @item_limit) do
case Common.fetch_actor_event_feed(name, limit) do
{:ok, _actor, events, _posts} ->
{:ok, events_to_ics(events)}
{:error, err} ->
{:error, err}
end
end
@spec export_private_actor(Actor.t(), integer()) :: {:ok, String.t()}
def export_private_actor(%Actor{} = actor, limit \\ @item_limit) do
events = Common.fetch_actor_private_events(actor, limit)
{:ok, events_to_ics(events)}
end
@spec fetch_events_from_token(String.t(), integer()) ::
{:ok, String.t()} | {:error, :actor_not_public | :actor_not_found}
defp fetch_events_from_token(token, limit \\ @item_limit) do
case Common.fetch_events_from_token(token, limit) do
%{events: events} ->
{:ok, events_to_ics(events)}
{:error, err} ->
{:error, err}
end
end
@spec events_to_ics(list(Events.t())) :: String.t()
defp events_to_ics(events) do
%ICalendar{events: events |> Enum.map(&do_export_event/1)}
|> ICalendar.to_ics(vendor: vendor())
end
@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,
dtstamp: event.publish_at || DateTime.utc_now(),
dtend: event.ends_on,
description: HTML.strip_tags(event.description),
uid: event.uuid,
url: event.url,
geo: Address.coords(event.physical_address),
location: Address.representation(event.physical_address),
categories: event.tags |> Enum.map(& &1.title)
}
end
@spec vendor :: String.t()
defp vendor do
"Mobilizon #{Config.instance_version()}"
end
end