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.ReportNote
16 alias Pleroma.ThreadMute
22 @type t :: %__MODULE__{}
23 @type actor :: String.t()
25 @primary_key {:id, FlakeId.Ecto.CompatType, autogenerate: true}
27 # https://github.com/tootsuite/mastodon/blob/master/app/models/notification.rb#L19
28 @mastodon_notification_types %{
29 "Create" => "mention",
31 "Announce" => "reblog",
32 "Like" => "favourite",
36 @mastodon_to_ap_notification_types for {k, v} <- @mastodon_notification_types,
40 schema "activities" do
42 field(:local, :boolean, default: true)
43 field(:actor, :string)
44 field(:recipients, {:array, :string}, default: [])
45 field(:thread_muted?, :boolean, virtual: true)
47 # This is a fake relation,
48 # do not use outside of with_preloaded_user_actor/with_joined_user_actor
49 has_one(:user_actor, User, on_delete: :nothing, foreign_key: :id)
50 # This is a fake relation, do not use outside of with_preloaded_bookmark/get_bookmark
51 has_one(:bookmark, Bookmark)
52 # This is a fake relation, do not use outside of with_preloaded_report_notes
53 has_many(:report_notes, ReportNote)
54 has_many(:notifications, Notification, on_delete: :delete_all)
56 # Attention: this is a fake relation, don't try to preload it blindly and expect it to work!
57 # The foreign key is embedded in a jsonb field.
59 # To use it, you probably want to do an inner join and a preload:
62 # |> join(:inner, [activity], o in Object,
63 # on: fragment("(?->>'id') = COALESCE((?)->'object'->> 'id', (?)->>'object')",
64 # o.data, activity.data, activity.data))
65 # |> preload([activity, object], [object: object])
68 # As a convenience, Activity.with_preloaded_object() sets up an inner join and preload for the
70 has_one(:object, Object, on_delete: :nothing, foreign_key: :id)
72 has_one(:expiration, ActivityExpiration, on_delete: :delete_all)
77 def with_joined_object(query, join_type \\ :inner) do
78 join(query, join_type, [activity], o in Object,
81 "(?->>'id') = COALESCE(?->'object'->>'id', ?->>'object')",
90 def with_preloaded_object(query, join_type \\ :inner) do
92 |> has_named_binding?(:object)
93 |> if(do: query, else: with_joined_object(query, join_type))
94 |> preload([activity, object: object], object: object)
97 def with_joined_user_actor(query, join_type \\ :inner) do
98 join(query, join_type, [activity], u in User,
99 on: u.ap_id == activity.actor,
104 def with_preloaded_user_actor(query, join_type \\ :inner) do
106 |> with_joined_user_actor(join_type)
107 |> preload([activity, user_actor: user_actor], user_actor: user_actor)
110 def with_preloaded_bookmark(query, %User{} = user) do
112 left_join: b in Bookmark,
113 on: b.user_id == ^user.id and b.activity_id == a.id,
114 preload: [bookmark: b]
118 def with_preloaded_bookmark(query, _), do: query
120 def with_preloaded_report_notes(query) do
122 left_join: r in ReportNote,
123 on: a.id == r.activity_id,
124 preload: [report_notes: r]
128 def with_preloaded_report_notes(query, _), do: query
130 def with_set_thread_muted_field(query, %User{} = user) do
132 left_join: tm in ThreadMute,
133 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data),
135 select: %Activity{a | thread_muted?: not is_nil(tm.id)}
139 def with_set_thread_muted_field(query, _), do: query
141 def get_by_ap_id(ap_id) do
143 |> Queries.by_ap_id()
147 def get_bookmark(%Activity{} = activity, %User{} = user) do
148 if Ecto.assoc_loaded?(activity.bookmark) do
151 Bookmark.get(user.id, activity.id)
155 def get_bookmark(_, _), do: nil
157 def change(struct, params \\ %{}) do
159 |> cast(params, [:data, :recipients])
160 |> validate_required([:data])
161 |> unique_constraint(:ap_id, name: :activities_unique_apid_index)
164 def get_by_ap_id_with_object(ap_id) do
166 |> Queries.by_ap_id()
167 |> with_preloaded_object(:left)
171 @spec get_by_id(String.t()) :: Activity.t() | nil
173 case FlakeId.flake_id?(id) do
176 |> where([a], a.id == ^id)
177 |> restrict_deactivated_users()
185 def get_by_id_with_object(id) do
188 |> with_preloaded_object()
192 def all_by_ids_with_object(ids) do
194 |> where([a], a.id in ^ids)
195 |> with_preloaded_object()
200 Accepts `ap_id` or list of `ap_id`.
203 @spec create_by_object_ap_id(String.t() | [String.t()]) :: Ecto.Queryable.t()
204 def create_by_object_ap_id(ap_id) do
206 |> Queries.by_object_id()
207 |> Queries.by_type("Create")
210 def get_all_create_by_object_ap_id(ap_id) do
212 |> create_by_object_ap_id()
216 def get_create_by_object_ap_id(ap_id) when is_binary(ap_id) do
217 create_by_object_ap_id(ap_id)
218 |> restrict_deactivated_users()
222 def get_create_by_object_ap_id(_), do: nil
225 Accepts `ap_id` or list of `ap_id`.
228 @spec create_by_object_ap_id_with_object(String.t() | [String.t()]) :: Ecto.Queryable.t()
229 def create_by_object_ap_id_with_object(ap_id) do
231 |> create_by_object_ap_id()
232 |> with_preloaded_object()
235 def get_create_by_object_ap_id_with_object(ap_id) when is_binary(ap_id) do
237 |> create_by_object_ap_id_with_object()
241 def get_create_by_object_ap_id_with_object(_), do: nil
243 defp get_in_reply_to_activity_from_object(%Object{data: %{"inReplyTo" => ap_id}}) do
244 get_create_by_object_ap_id_with_object(ap_id)
247 defp get_in_reply_to_activity_from_object(_), do: nil
249 def get_in_reply_to_activity(%Activity{} = activity) do
250 get_in_reply_to_activity_from_object(Object.normalize(activity))
253 def normalize(obj) when is_map(obj), do: get_by_ap_id_with_object(obj["id"])
254 def normalize(ap_id) when is_binary(ap_id), do: get_by_ap_id_with_object(ap_id)
255 def normalize(_), do: nil
257 def delete_all_by_object_ap_id(id) when is_binary(id) do
259 |> Queries.by_object_id()
260 |> Queries.exclude_type("Delete")
265 %{data: %{"type" => "Create", "object" => ap_id}} when is_binary(ap_id) -> ap_id == id
266 %{data: %{"type" => "Create", "object" => %{"id" => ap_id}}} -> ap_id == id
269 |> purge_web_resp_cache()
272 def delete_all_by_object_ap_id(_), do: nil
274 defp purge_web_resp_cache(%Activity{} = activity) do
275 %{path: path} = URI.parse(activity.data["id"])
276 Cachex.del(:web_resp_cache, path)
280 defp purge_web_resp_cache(nil), do: nil
282 for {ap_type, type} <- @mastodon_notification_types do
283 def mastodon_notification_type(%Activity{data: %{"type" => unquote(ap_type)}}),
287 def mastodon_notification_type(%Activity{}), do: nil
289 def from_mastodon_notification_type(type) do
290 Map.get(@mastodon_to_ap_notification_types, type)
293 def all_by_actor_and_id(actor, status_ids \\ [])
294 def all_by_actor_and_id(_actor, []), do: []
296 def all_by_actor_and_id(actor, status_ids) do
298 |> where([s], s.id in ^status_ids)
299 |> where([s], s.actor == ^actor)
303 def follow_requests_for_actor(%Pleroma.User{ap_id: ap_id}) do
305 |> Queries.by_object_id()
306 |> Queries.by_type("Follow")
307 |> where([a], fragment("? ->> 'state' = 'pending'", a.data))
310 def restrict_deactivated_users(query) do
312 from(u in User.Query.build(deactivated: true), select: u.ap_id)
315 Activity.Queries.exclude_authors(query, deactivated_users)
318 defdelegate search(user, query, options \\ []), to: Pleroma.Activity.Search
320 def direct_conversation_id(activity, for_user) do
321 alias Pleroma.Conversation.Participation
323 with %{data: %{"context" => context}} when is_binary(context) <- activity,
324 %Pleroma.Conversation{} = conversation <- Pleroma.Conversation.get_for_ap_id(context),
325 %Participation{id: participation_id} <-
326 Participation.for_user_and_conversation(for_user, conversation) do