1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2022 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.Bookmark
11 alias Pleroma.Notification
14 alias Pleroma.ReportNote
15 alias Pleroma.ThreadMute
17 alias Pleroma.Web.ActivityPub.ActivityPub
22 @type t :: %__MODULE__{}
23 @type actor :: String.t()
25 @primary_key {:id, FlakeId.Ecto.CompatType, autogenerate: true}
27 @cachex Pleroma.Config.get([:cachex, :provider], Cachex)
29 schema "activities" do
31 field(:local, :boolean, default: true)
32 field(:actor, :string)
33 field(:recipients, {:array, :string}, default: [])
34 field(:thread_muted?, :boolean, virtual: true)
36 # A field that can be used if you need to join some kind of other
37 # id to order / paginate this field by
38 field(:pagination_id, :string, virtual: true)
40 # This is a fake relation,
41 # do not use outside of with_preloaded_user_actor/with_joined_user_actor
42 has_one(:user_actor, User, on_delete: :nothing, foreign_key: :id)
43 # This is a fake relation, do not use outside of with_preloaded_bookmark/get_bookmark
44 has_one(:bookmark, Bookmark)
45 # This is a fake relation, do not use outside of with_preloaded_report_notes
46 has_many(:report_notes, ReportNote)
47 has_many(:notifications, Notification, on_delete: :delete_all)
49 # Attention: this is a fake relation, don't try to preload it blindly and expect it to work!
50 # The foreign key is embedded in a jsonb field.
52 # To use it, you probably want to do an inner join and a preload:
55 # |> join(:inner, [activity], o in Object,
56 # on: fragment("(?->>'id') = associated_object_id((?))",
57 # o.data, activity.data, activity.data))
58 # |> preload([activity, object], [object: object])
61 # As a convenience, Activity.with_preloaded_object() sets up an inner join and preload for the
63 has_one(:object, Object, on_delete: :nothing, foreign_key: :id)
68 def with_joined_object(query, join_type \\ :inner) do
69 join(query, join_type, [activity], o in Object,
72 "(?->>'id') = associated_object_id(?)",
80 def with_preloaded_object(query, join_type \\ :inner) do
82 |> has_named_binding?(:object)
83 |> if(do: query, else: with_joined_object(query, join_type))
84 |> preload([activity, object: object], object: object)
87 # Note: applies to fake activities (ActivityPub.Utils.get_notified_from_object/1 etc.)
88 def user_actor(%Activity{actor: nil}), do: nil
90 def user_actor(%Activity{} = activity) do
91 with %User{} <- activity.user_actor do
94 _ -> User.get_cached_by_ap_id(activity.actor)
98 def with_joined_user_actor(query, join_type \\ :inner) do
99 join(query, join_type, [activity], u in User,
100 on: u.ap_id == activity.actor,
105 def with_preloaded_user_actor(query, join_type \\ :inner) do
107 |> with_joined_user_actor(join_type)
108 |> preload([activity, user_actor: user_actor], user_actor: user_actor)
111 def with_preloaded_bookmark(query, %User{} = user) do
113 left_join: b in Bookmark,
114 on: b.user_id == ^user.id and b.activity_id == a.id,
116 preload: [bookmark: b]
120 def with_preloaded_bookmark(query, _), do: query
122 def with_preloaded_report_notes(query) do
124 left_join: r in ReportNote,
125 on: a.id == r.activity_id,
127 preload: [report_notes: r]
131 def with_preloaded_report_notes(query, _), do: query
133 def with_set_thread_muted_field(query, %User{} = user) do
135 left_join: tm in ThreadMute,
136 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data),
138 select: %Activity{a | thread_muted?: not is_nil(tm.id)}
142 def with_set_thread_muted_field(query, _), do: query
144 def get_by_ap_id(ap_id) do
146 |> Queries.by_ap_id()
150 def get_bookmark(%Activity{} = activity, %User{} = user) do
151 if Ecto.assoc_loaded?(activity.bookmark) do
154 Bookmark.get(user.id, activity.id)
158 def get_bookmark(_, _), do: nil
160 def get_report(activity_id) do
164 preload_report_notes: true
167 ActivityPub.fetch_activities_query([], opts)
168 |> where(id: ^activity_id)
172 def change(struct, params \\ %{}) do
174 |> cast(params, [:data, :recipients])
175 |> validate_required([:data])
176 |> unique_constraint(:ap_id, name: :activities_unique_apid_index)
179 def get_by_ap_id_with_object(ap_id) do
181 |> Queries.by_ap_id()
182 |> with_preloaded_object(:left)
187 Gets activity by ID, doesn't load activities from deactivated actors by default.
189 @spec get_by_id(String.t(), keyword()) :: t() | nil
190 def get_by_id(id, opts \\ [filter: [:restrict_deactivated]]), do: get_by_id_with_opts(id, opts)
192 @spec get_by_id_with_user_actor(String.t()) :: t() | nil
193 def get_by_id_with_user_actor(id), do: get_by_id_with_opts(id, preload: [:user_actor])
195 @spec get_by_id_with_object(String.t()) :: t() | nil
196 def get_by_id_with_object(id), do: get_by_id_with_opts(id, preload: [:object])
198 defp get_by_id_with_opts(id, opts) do
199 if FlakeId.flake_id?(id) do
200 query = Queries.by_id(id)
203 if is_list(opts[:filter]) do
204 Enum.reduce(opts[:filter], query, fn
205 {:type, type}, acc -> Queries.by_type(acc, type)
206 :restrict_deactivated, acc -> restrict_deactivated_users(acc)
213 with_preloads_query =
214 if is_list(opts[:preload]) do
215 Enum.reduce(opts[:preload], with_filters_query, fn
216 :user_actor, acc -> with_preloaded_user_actor(acc)
217 :object, acc -> with_preloaded_object(acc)
224 Repo.one(with_preloads_query)
228 def all_by_ids_with_object(ids) do
230 |> where([a], a.id in ^ids)
231 |> with_preloaded_object()
236 Accepts `ap_id` or list of `ap_id`.
239 @spec create_by_object_ap_id(String.t() | [String.t()]) :: Ecto.Queryable.t()
240 def create_by_object_ap_id(ap_id) do
242 |> Queries.by_object_id()
243 |> Queries.by_type("Create")
246 def get_all_create_by_object_ap_id(ap_id) do
248 |> create_by_object_ap_id()
252 def get_create_by_object_ap_id(ap_id) when is_binary(ap_id) do
253 create_by_object_ap_id(ap_id)
254 |> restrict_deactivated_users()
258 def get_create_by_object_ap_id(_), do: nil
261 Accepts `ap_id` or list of `ap_id`.
264 @spec create_by_object_ap_id_with_object(String.t() | [String.t()]) :: Ecto.Queryable.t()
265 def create_by_object_ap_id_with_object(ap_id) do
267 |> create_by_object_ap_id()
268 |> with_preloaded_object()
271 def get_create_by_object_ap_id_with_object(ap_id) when is_binary(ap_id) do
273 |> create_by_object_ap_id_with_object()
277 def get_create_by_object_ap_id_with_object(_), do: nil
279 @spec create_by_id_with_object(String.t()) :: t() | nil
280 def create_by_id_with_object(id) do
281 get_by_id_with_opts(id, preload: [:object], filter: [type: "Create"])
284 defp get_in_reply_to_activity_from_object(%Object{data: %{"inReplyTo" => ap_id}}) do
285 get_create_by_object_ap_id_with_object(ap_id)
288 defp get_in_reply_to_activity_from_object(_), do: nil
290 def get_in_reply_to_activity(%Activity{} = activity) do
291 get_in_reply_to_activity_from_object(Object.normalize(activity, fetch: false))
294 def normalize(%Activity{data: %{"id" => ap_id}}), do: get_by_ap_id_with_object(ap_id)
295 def normalize(%{"id" => ap_id}), do: get_by_ap_id_with_object(ap_id)
296 def normalize(ap_id) when is_binary(ap_id), do: get_by_ap_id_with_object(ap_id)
297 def normalize(_), do: nil
299 def delete_all_by_object_ap_id(id) when is_binary(id) do
301 |> Queries.by_object_id()
302 |> Queries.exclude_type("Delete")
304 |> Repo.delete_all(timeout: :infinity)
307 %{data: %{"type" => "Create", "object" => ap_id}} when is_binary(ap_id) -> ap_id == id
308 %{data: %{"type" => "Create", "object" => %{"id" => ap_id}}} -> ap_id == id
311 |> purge_web_resp_cache()
314 def delete_all_by_object_ap_id(_), do: nil
316 defp purge_web_resp_cache(%Activity{data: %{"id" => id}} = activity) when is_binary(id) do
317 with %{path: path} <- URI.parse(id) do
318 @cachex.del(:web_resp_cache, path)
324 defp purge_web_resp_cache(activity), do: activity
326 def follow_accepted?(
327 %Activity{data: %{"type" => "Follow", "object" => followed_ap_id}} = activity
329 with %User{} = follower <- Activity.user_actor(activity),
330 %User{} = followed <- User.get_cached_by_ap_id(followed_ap_id) do
331 Pleroma.FollowingRelationship.following?(follower, followed)
337 def follow_accepted?(_), do: false
339 def all_by_actor_and_id(actor, status_ids \\ [])
340 def all_by_actor_and_id(_actor, []), do: []
342 def all_by_actor_and_id(actor, status_ids) do
344 |> where([s], s.id in ^status_ids)
345 |> where([s], s.actor == ^actor)
349 def follow_requests_for_actor(%User{ap_id: ap_id}) do
351 |> Queries.by_object_id()
352 |> Queries.by_type("Follow")
353 |> where([a], fragment("? ->> 'state' = 'pending'", a.data))
356 def following_requests_for_actor(%User{ap_id: ap_id}) do
357 Queries.by_type("Follow")
358 |> where([a], fragment("?->>'state' = 'pending'", a.data))
359 |> where([a], a.actor == ^ap_id)
363 def restrict_deactivated_users(query) do
365 |> join(:inner, [activity], user in User,
367 on: activity.actor == user.ap_id and user.is_active == true
371 defdelegate search(user, query, options \\ []), to: Pleroma.Activity.Search
373 def direct_conversation_id(activity, for_user) do
374 alias Pleroma.Conversation.Participation
376 with %{data: %{"context" => context}} when is_binary(context) <- activity,
377 %Pleroma.Conversation{} = conversation <- Pleroma.Conversation.get_for_ap_id(context),
378 %Participation{id: participation_id} <-
379 Participation.for_user_and_conversation(for_user, conversation) do
386 @spec get_by_object_ap_id_with_object(String.t()) :: t() | nil
387 def get_by_object_ap_id_with_object(ap_id) when is_binary(ap_id) do
389 |> Queries.by_object_id()
390 |> with_preloaded_object()
395 def get_by_object_ap_id_with_object(_), do: nil
397 @spec add_by_params_query(String.t(), String.t(), String.t()) :: Ecto.Query.t()
398 def add_by_params_query(object_id, actor, target) do
400 |> Queries.by_object_id()
401 |> Queries.by_type("Add")
402 |> Queries.by_actor(actor)
403 |> where([a], fragment("?->>'target' = ?", a.data, ^target))