1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Activity do
9 alias Pleroma.Activity.Queries
10 alias Pleroma.ActivityExpiration
11 alias Pleroma.Bookmark
12 alias Pleroma.Notification
15 alias Pleroma.ThreadMute
21 @type t :: %__MODULE__{}
22 @type actor :: String.t()
24 @primary_key {:id, FlakeId.Ecto.CompatType, autogenerate: true}
26 # https://github.com/tootsuite/mastodon/blob/master/app/models/notification.rb#L19
27 @mastodon_notification_types %{
28 "Create" => "mention",
30 "Announce" => "reblog",
31 "Like" => "favourite",
35 @mastodon_to_ap_notification_types for {k, v} <- @mastodon_notification_types,
39 schema "activities" do
41 field(:local, :boolean, default: true)
42 field(:actor, :string)
43 field(:recipients, {:array, :string}, default: [])
44 field(:thread_muted?, :boolean, virtual: true)
46 # This is a fake relation,
47 # do not use outside of with_preloaded_user_actor/with_joined_user_actor
48 has_one(:user_actor, User, on_delete: :nothing, foreign_key: :id)
49 # This is a fake relation, do not use outside of with_preloaded_bookmark/get_bookmark
50 has_one(:bookmark, Bookmark)
51 has_many(:notifications, Notification, on_delete: :delete_all)
53 # Attention: this is a fake relation, don't try to preload it blindly and expect it to work!
54 # The foreign key is embedded in a jsonb field.
56 # To use it, you probably want to do an inner join and a preload:
59 # |> join(:inner, [activity], o in Object,
60 # on: fragment("(?->>'id') = COALESCE((?)->'object'->> 'id', (?)->>'object')",
61 # o.data, activity.data, activity.data))
62 # |> preload([activity, object], [object: object])
65 # As a convenience, Activity.with_preloaded_object() sets up an inner join and preload for the
67 has_one(:object, Object, on_delete: :nothing, foreign_key: :id)
69 has_one(:expiration, ActivityExpiration, on_delete: :delete_all)
74 def with_joined_object(query, join_type \\ :inner) do
75 join(query, join_type, [activity], o in Object,
78 "(?->>'id') = COALESCE(?->'object'->>'id', ?->>'object')",
87 def with_preloaded_object(query, join_type \\ :inner) do
89 |> has_named_binding?(:object)
90 |> if(do: query, else: with_joined_object(query, join_type))
91 |> preload([activity, object: object], object: object)
94 def with_joined_user_actor(query, join_type \\ :inner) do
95 join(query, join_type, [activity], u in User,
96 on: u.ap_id == activity.actor,
101 def with_preloaded_user_actor(query, join_type \\ :inner) do
103 |> with_joined_user_actor(join_type)
104 |> preload([activity, user_actor: user_actor], user_actor: user_actor)
107 def with_preloaded_bookmark(query, %User{} = user) do
109 left_join: b in Bookmark,
110 on: b.user_id == ^user.id and b.activity_id == a.id,
111 preload: [bookmark: b]
115 def with_preloaded_bookmark(query, _), do: query
117 def with_set_thread_muted_field(query, %User{} = user) do
119 left_join: tm in ThreadMute,
120 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data),
122 select: %Activity{a | thread_muted?: not is_nil(tm.id)}
126 def with_set_thread_muted_field(query, _), do: query
128 def get_by_ap_id(ap_id) do
130 |> Queries.by_ap_id()
134 def get_bookmark(%Activity{} = activity, %User{} = user) do
135 if Ecto.assoc_loaded?(activity.bookmark) do
138 Bookmark.get(user.id, activity.id)
142 def get_bookmark(_, _), do: nil
144 def change(struct, params \\ %{}) do
146 |> cast(params, [:data, :recipients])
147 |> validate_required([:data])
148 |> unique_constraint(:ap_id, name: :activities_unique_apid_index)
151 def get_by_ap_id_with_object(ap_id) do
153 |> Queries.by_ap_id()
154 |> with_preloaded_object(:left)
158 @spec get_by_id(String.t()) :: Activity.t() | nil
160 case FlakeId.flake_id?(id) do
163 |> where([a], a.id == ^id)
164 |> restrict_deactivated_users()
172 def get_by_id_with_object(id) do
175 |> with_preloaded_object()
179 def all_by_ids_with_object(ids) do
181 |> where([a], a.id in ^ids)
182 |> with_preloaded_object()
187 Accepts `ap_id` or list of `ap_id`.
190 @spec create_by_object_ap_id(String.t() | [String.t()]) :: Ecto.Queryable.t()
191 def create_by_object_ap_id(ap_id) do
193 |> Queries.by_object_id()
194 |> Queries.by_type("Create")
197 def get_all_create_by_object_ap_id(ap_id) do
199 |> create_by_object_ap_id()
203 def get_create_by_object_ap_id(ap_id) when is_binary(ap_id) do
204 create_by_object_ap_id(ap_id)
205 |> restrict_deactivated_users()
209 def get_create_by_object_ap_id(_), do: nil
212 Accepts `ap_id` or list of `ap_id`.
215 @spec create_by_object_ap_id_with_object(String.t() | [String.t()]) :: Ecto.Queryable.t()
216 def create_by_object_ap_id_with_object(ap_id) do
218 |> create_by_object_ap_id()
219 |> with_preloaded_object()
222 def get_create_by_object_ap_id_with_object(ap_id) when is_binary(ap_id) do
224 |> create_by_object_ap_id_with_object()
228 def get_create_by_object_ap_id_with_object(_), do: nil
230 defp get_in_reply_to_activity_from_object(%Object{data: %{"inReplyTo" => ap_id}}) do
231 get_create_by_object_ap_id_with_object(ap_id)
234 defp get_in_reply_to_activity_from_object(_), do: nil
236 def get_in_reply_to_activity(%Activity{} = activity) do
237 get_in_reply_to_activity_from_object(Object.normalize(activity))
240 def normalize(obj) when is_map(obj), do: get_by_ap_id_with_object(obj["id"])
241 def normalize(ap_id) when is_binary(ap_id), do: get_by_ap_id_with_object(ap_id)
242 def normalize(_), do: nil
244 def delete_by_ap_id(id) when is_binary(id) do
246 |> Queries.by_object_id()
251 %{data: %{"type" => "Create", "object" => ap_id}} when is_binary(ap_id) -> ap_id == id
252 %{data: %{"type" => "Create", "object" => %{"id" => ap_id}}} -> ap_id == id
255 |> purge_web_resp_cache()
258 def delete_by_ap_id(_), do: nil
260 defp purge_web_resp_cache(%Activity{} = activity) do
261 %{path: path} = URI.parse(activity.data["id"])
262 Cachex.del(:web_resp_cache, path)
266 defp purge_web_resp_cache(nil), do: nil
268 for {ap_type, type} <- @mastodon_notification_types do
269 def mastodon_notification_type(%Activity{data: %{"type" => unquote(ap_type)}}),
273 def mastodon_notification_type(%Activity{}), do: nil
275 def from_mastodon_notification_type(type) do
276 Map.get(@mastodon_to_ap_notification_types, type)
279 def all_by_actor_and_id(actor, status_ids \\ [])
280 def all_by_actor_and_id(_actor, []), do: []
282 def all_by_actor_and_id(actor, status_ids) do
284 |> where([s], s.id in ^status_ids)
285 |> where([s], s.actor == ^actor)
289 def follow_requests_for_actor(%Pleroma.User{ap_id: ap_id}) do
291 |> Queries.by_object_id()
292 |> Queries.by_type("Follow")
293 |> where([a], fragment("? ->> 'state' = 'pending'", a.data))
296 def restrict_deactivated_users(query) do
298 from(u in User.Query.build(deactivated: true), select: u.ap_id)
301 from(activity in query,
302 where: activity.actor not in ^deactivated_users
306 defdelegate search(user, query, options \\ []), to: Pleroma.Activity.Search
308 def direct_conversation_id(activity, for_user) do
309 alias Pleroma.Conversation.Participation
311 with %{data: %{"context" => context}} when is_binary(context) <- activity,
312 %Pleroma.Conversation{} = conversation <- Pleroma.Conversation.get_for_ap_id(context),
313 %Participation{id: participation_id} <-
314 Participation.for_user_and_conversation(for_user, conversation) do