1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2020 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 schema "activities" do
29 field(:local, :boolean, default: true)
30 field(:actor, :string)
31 field(:recipients, {:array, :string}, default: [])
32 field(:thread_muted?, :boolean, virtual: true)
34 # A field that can be used if you need to join some kind of other
35 # id to order / paginate this field by
36 field(:pagination_id, :string, virtual: true)
38 # This is a fake relation,
39 # do not use outside of with_preloaded_user_actor/with_joined_user_actor
40 has_one(:user_actor, User, on_delete: :nothing, foreign_key: :id)
41 # This is a fake relation, do not use outside of with_preloaded_bookmark/get_bookmark
42 has_one(:bookmark, Bookmark)
43 # This is a fake relation, do not use outside of with_preloaded_report_notes
44 has_many(:report_notes, ReportNote)
45 has_many(:notifications, Notification, on_delete: :delete_all)
47 # Attention: this is a fake relation, don't try to preload it blindly and expect it to work!
48 # The foreign key is embedded in a jsonb field.
50 # To use it, you probably want to do an inner join and a preload:
53 # |> join(:inner, [activity], o in Object,
54 # on: fragment("(?->>'id') = COALESCE((?)->'object'->> 'id', (?)->>'object')",
55 # o.data, activity.data, activity.data))
56 # |> preload([activity, object], [object: object])
59 # As a convenience, Activity.with_preloaded_object() sets up an inner join and preload for the
61 has_one(:object, Object, on_delete: :nothing, foreign_key: :id)
66 def with_joined_object(query, join_type \\ :inner) do
67 join(query, join_type, [activity], o in Object,
70 "(?->>'id') = COALESCE(?->'object'->>'id', ?->>'object')",
79 def with_preloaded_object(query, join_type \\ :inner) do
81 |> has_named_binding?(:object)
82 |> if(do: query, else: with_joined_object(query, join_type))
83 |> preload([activity, object: object], object: object)
86 # Note: applies to fake activities (ActivityPub.Utils.get_notified_from_object/1 etc.)
87 def user_actor(%Activity{actor: nil}), do: nil
89 def user_actor(%Activity{} = activity) do
90 with %User{} <- activity.user_actor do
93 _ -> User.get_cached_by_ap_id(activity.actor)
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 get_report(activity_id) do
161 preload_report_notes: true
164 ActivityPub.fetch_activities_query([], opts)
165 |> where(id: ^activity_id)
169 def change(struct, params \\ %{}) do
171 |> cast(params, [:data, :recipients])
172 |> validate_required([:data])
173 |> unique_constraint(:ap_id, name: :activities_unique_apid_index)
176 def get_by_ap_id_with_object(ap_id) do
178 |> Queries.by_ap_id()
179 |> with_preloaded_object(:left)
183 @spec get_by_id(String.t()) :: Activity.t() | nil
185 case FlakeId.flake_id?(id) do
188 |> where([a], a.id == ^id)
189 |> restrict_deactivated_users()
197 def get_by_id_with_user_actor(id) do
198 case FlakeId.flake_id?(id) do
201 |> where([a], a.id == ^id)
202 |> with_preloaded_user_actor()
210 def get_by_id_with_object(id) do
213 |> with_preloaded_object()
217 def all_by_ids_with_object(ids) do
219 |> where([a], a.id in ^ids)
220 |> with_preloaded_object()
225 Accepts `ap_id` or list of `ap_id`.
228 @spec create_by_object_ap_id(String.t() | [String.t()]) :: Ecto.Queryable.t()
229 def create_by_object_ap_id(ap_id) do
231 |> Queries.by_object_id()
232 |> Queries.by_type("Create")
235 def get_all_create_by_object_ap_id(ap_id) do
237 |> create_by_object_ap_id()
241 def get_create_by_object_ap_id(ap_id) when is_binary(ap_id) do
242 create_by_object_ap_id(ap_id)
243 |> restrict_deactivated_users()
247 def get_create_by_object_ap_id(_), do: nil
250 Accepts `ap_id` or list of `ap_id`.
253 @spec create_by_object_ap_id_with_object(String.t() | [String.t()]) :: Ecto.Queryable.t()
254 def create_by_object_ap_id_with_object(ap_id) do
256 |> create_by_object_ap_id()
257 |> with_preloaded_object()
260 def get_create_by_object_ap_id_with_object(ap_id) when is_binary(ap_id) do
262 |> create_by_object_ap_id_with_object()
266 def get_create_by_object_ap_id_with_object(_), do: nil
268 defp get_in_reply_to_activity_from_object(%Object{data: %{"inReplyTo" => ap_id}}) do
269 get_create_by_object_ap_id_with_object(ap_id)
272 defp get_in_reply_to_activity_from_object(_), do: nil
274 def get_in_reply_to_activity(%Activity{} = activity) do
275 get_in_reply_to_activity_from_object(Object.normalize(activity))
278 def normalize(obj) when is_map(obj), do: get_by_ap_id_with_object(obj["id"])
279 def normalize(ap_id) when is_binary(ap_id), do: get_by_ap_id_with_object(ap_id)
280 def normalize(_), do: nil
282 def delete_all_by_object_ap_id(id) when is_binary(id) do
284 |> Queries.by_object_id()
285 |> Queries.exclude_type("Delete")
290 %{data: %{"type" => "Create", "object" => ap_id}} when is_binary(ap_id) -> ap_id == id
291 %{data: %{"type" => "Create", "object" => %{"id" => ap_id}}} -> ap_id == id
294 |> purge_web_resp_cache()
297 def delete_all_by_object_ap_id(_), do: nil
299 defp purge_web_resp_cache(%Activity{} = activity) do
300 %{path: path} = URI.parse(activity.data["id"])
301 Cachex.del(:web_resp_cache, path)
305 defp purge_web_resp_cache(nil), do: nil
307 def follow_accepted?(
308 %Activity{data: %{"type" => "Follow", "object" => followed_ap_id}} = activity
310 with %User{} = follower <- Activity.user_actor(activity),
311 %User{} = followed <- User.get_cached_by_ap_id(followed_ap_id) do
312 Pleroma.FollowingRelationship.following?(follower, followed)
318 def follow_accepted?(_), do: false
320 def all_by_actor_and_id(actor, status_ids \\ [])
321 def all_by_actor_and_id(_actor, []), do: []
323 def all_by_actor_and_id(actor, status_ids) do
325 |> where([s], s.id in ^status_ids)
326 |> where([s], s.actor == ^actor)
330 def follow_requests_for_actor(%User{ap_id: ap_id}) do
332 |> Queries.by_object_id()
333 |> Queries.by_type("Follow")
334 |> where([a], fragment("? ->> 'state' = 'pending'", a.data))
337 def following_requests_for_actor(%User{ap_id: ap_id}) do
338 Queries.by_type("Follow")
339 |> where([a], fragment("?->>'state' = 'pending'", a.data))
340 |> where([a], a.actor == ^ap_id)
344 def restrict_deactivated_users(query) do
346 from(u in User.Query.build(%{deactivated: true}), select: u.ap_id)
349 Activity.Queries.exclude_authors(query, deactivated_users)
352 defdelegate search(user, query, options \\ []), to: Pleroma.Activity.Search
354 def direct_conversation_id(activity, for_user) do
355 alias Pleroma.Conversation.Participation
357 with %{data: %{"context" => context}} when is_binary(context) <- activity,
358 %Pleroma.Conversation{} = conversation <- Pleroma.Conversation.get_for_ap_id(context),
359 %Participation{id: participation_id} <-
360 Participation.for_user_and_conversation(for_user, conversation) do
367 @spec pinned_by_actor?(Activity.t()) :: boolean()
368 def pinned_by_actor?(%Activity{} = activity) do
369 actor = user_actor(activity)
370 activity.id in actor.pinned_activities
373 @spec get_by_object_ap_id_with_object(String.t()) :: t() | nil
374 def get_by_object_ap_id_with_object(ap_id) when is_binary(ap_id) do
376 |> Queries.by_object_id()
377 |> with_preloaded_object()
382 def get_by_object_ap_id_with_object(_), do: nil