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.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",
30 "Follow" => ["follow", "follow_request"],
31 "Announce" => "reblog",
32 "Like" => "favourite",
34 "EmojiReact" => "pleroma:emoji_reaction"
37 schema "activities" do
39 field(:local, :boolean, default: true)
40 field(:actor, :string)
41 field(:recipients, {:array, :string}, default: [])
42 field(:thread_muted?, :boolean, virtual: true)
44 # A field that can be used if you need to join some kind of other
45 # id to order / paginate this field by
46 field(:pagination_id, :string, virtual: true)
48 # This is a fake relation,
49 # do not use outside of with_preloaded_user_actor/with_joined_user_actor
50 has_one(:user_actor, User, on_delete: :nothing, foreign_key: :id)
51 # This is a fake relation, do not use outside of with_preloaded_bookmark/get_bookmark
52 has_one(:bookmark, Bookmark)
53 # This is a fake relation, do not use outside of with_preloaded_report_notes
54 has_many(:report_notes, ReportNote)
55 has_many(:notifications, Notification, on_delete: :delete_all)
57 # Attention: this is a fake relation, don't try to preload it blindly and expect it to work!
58 # The foreign key is embedded in a jsonb field.
60 # To use it, you probably want to do an inner join and a preload:
63 # |> join(:inner, [activity], o in Object,
64 # on: fragment("(?->>'id') = COALESCE((?)->'object'->> 'id', (?)->>'object')",
65 # o.data, activity.data, activity.data))
66 # |> preload([activity, object], [object: object])
69 # As a convenience, Activity.with_preloaded_object() sets up an inner join and preload for the
71 has_one(:object, Object, on_delete: :nothing, foreign_key: :id)
73 has_one(:expiration, ActivityExpiration, on_delete: :delete_all)
78 def with_joined_object(query, join_type \\ :inner) do
79 join(query, join_type, [activity], o in Object,
82 "(?->>'id') = COALESCE(?->'object'->>'id', ?->>'object')",
91 def with_preloaded_object(query, join_type \\ :inner) do
93 |> has_named_binding?(:object)
94 |> if(do: query, else: with_joined_object(query, join_type))
95 |> preload([activity, object: object], object: object)
98 # Note: applies to fake activities (ActivityPub.Utils.get_notified_from_object/1 etc.)
99 def user_actor(%Activity{actor: nil}), do: nil
101 def user_actor(%Activity{} = activity) do
102 with %User{} <- activity.user_actor do
105 _ -> User.get_cached_by_ap_id(activity.actor)
109 def with_joined_user_actor(query, join_type \\ :inner) do
110 join(query, join_type, [activity], u in User,
111 on: u.ap_id == activity.actor,
116 def with_preloaded_user_actor(query, join_type \\ :inner) do
118 |> with_joined_user_actor(join_type)
119 |> preload([activity, user_actor: user_actor], user_actor: user_actor)
122 def with_preloaded_bookmark(query, %User{} = user) do
124 left_join: b in Bookmark,
125 on: b.user_id == ^user.id and b.activity_id == a.id,
126 preload: [bookmark: b]
130 def with_preloaded_bookmark(query, _), do: query
132 def with_preloaded_report_notes(query) do
134 left_join: r in ReportNote,
135 on: a.id == r.activity_id,
136 preload: [report_notes: r]
140 def with_preloaded_report_notes(query, _), do: query
142 def with_set_thread_muted_field(query, %User{} = user) do
144 left_join: tm in ThreadMute,
145 on: tm.user_id == ^user.id and tm.context == fragment("?->>'context'", a.data),
147 select: %Activity{a | thread_muted?: not is_nil(tm.id)}
151 def with_set_thread_muted_field(query, _), do: query
153 def get_by_ap_id(ap_id) do
155 |> Queries.by_ap_id()
159 def get_bookmark(%Activity{} = activity, %User{} = user) do
160 if Ecto.assoc_loaded?(activity.bookmark) do
163 Bookmark.get(user.id, activity.id)
167 def get_bookmark(_, _), do: nil
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_object(id) do
200 |> with_preloaded_object()
204 def all_by_ids_with_object(ids) do
206 |> where([a], a.id in ^ids)
207 |> with_preloaded_object()
212 Accepts `ap_id` or list of `ap_id`.
215 @spec create_by_object_ap_id(String.t() | [String.t()]) :: Ecto.Queryable.t()
216 def create_by_object_ap_id(ap_id) do
218 |> Queries.by_object_id()
219 |> Queries.by_type("Create")
222 def get_all_create_by_object_ap_id(ap_id) do
224 |> create_by_object_ap_id()
228 def get_create_by_object_ap_id(ap_id) when is_binary(ap_id) do
229 create_by_object_ap_id(ap_id)
230 |> restrict_deactivated_users()
234 def get_create_by_object_ap_id(_), do: nil
237 Accepts `ap_id` or list of `ap_id`.
240 @spec create_by_object_ap_id_with_object(String.t() | [String.t()]) :: Ecto.Queryable.t()
241 def create_by_object_ap_id_with_object(ap_id) do
243 |> create_by_object_ap_id()
244 |> with_preloaded_object()
247 def get_create_by_object_ap_id_with_object(ap_id) when is_binary(ap_id) do
249 |> create_by_object_ap_id_with_object()
253 def get_create_by_object_ap_id_with_object(_), do: nil
255 defp get_in_reply_to_activity_from_object(%Object{data: %{"inReplyTo" => ap_id}}) do
256 get_create_by_object_ap_id_with_object(ap_id)
259 defp get_in_reply_to_activity_from_object(_), do: nil
261 def get_in_reply_to_activity(%Activity{} = activity) do
262 get_in_reply_to_activity_from_object(Object.normalize(activity))
265 def normalize(obj) when is_map(obj), do: get_by_ap_id_with_object(obj["id"])
266 def normalize(ap_id) when is_binary(ap_id), do: get_by_ap_id_with_object(ap_id)
267 def normalize(_), do: nil
269 def delete_all_by_object_ap_id(id) when is_binary(id) do
271 |> Queries.by_object_id()
272 |> Queries.exclude_type("Delete")
277 %{data: %{"type" => "Create", "object" => ap_id}} when is_binary(ap_id) -> ap_id == id
278 %{data: %{"type" => "Create", "object" => %{"id" => ap_id}}} -> ap_id == id
281 |> purge_web_resp_cache()
284 def delete_all_by_object_ap_id(_), do: nil
286 defp purge_web_resp_cache(%Activity{} = activity) do
287 %{path: path} = URI.parse(activity.data["id"])
288 Cachex.del(:web_resp_cache, path)
292 defp purge_web_resp_cache(nil), do: nil
294 def follow_accepted?(
295 %Activity{data: %{"type" => "Follow", "object" => followed_ap_id}} = activity
297 with %User{} = follower <- Activity.user_actor(activity),
298 %User{} = followed <- User.get_cached_by_ap_id(followed_ap_id) do
299 Pleroma.FollowingRelationship.following?(follower, followed)
305 def follow_accepted?(_), do: false
307 @spec mastodon_notification_type(Activity.t()) :: String.t() | nil
309 for {ap_type, type} <- @mastodon_notification_types, not is_list(type) do
310 def mastodon_notification_type(%Activity{data: %{"type" => unquote(ap_type)}}),
314 def mastodon_notification_type(%Activity{data: %{"type" => "Follow"}} = activity) do
315 if follow_accepted?(activity) do
322 def mastodon_notification_type(%Activity{}), do: nil
324 @spec from_mastodon_notification_type(String.t()) :: String.t() | nil
325 @doc "Converts Mastodon notification type to AR activity type"
326 def from_mastodon_notification_type(type) do
328 Enum.find(@mastodon_notification_types, fn {_k, v} -> type in List.wrap(v) end) do
333 def all_by_actor_and_id(actor, status_ids \\ [])
334 def all_by_actor_and_id(_actor, []), do: []
336 def all_by_actor_and_id(actor, status_ids) do
338 |> where([s], s.id in ^status_ids)
339 |> where([s], s.actor == ^actor)
343 def follow_requests_for_actor(%Pleroma.User{ap_id: ap_id}) do
345 |> Queries.by_object_id()
346 |> Queries.by_type("Follow")
347 |> where([a], fragment("? ->> 'state' = 'pending'", a.data))
350 def following_requests_for_actor(%Pleroma.User{ap_id: ap_id}) do
351 Queries.by_type("Follow")
352 |> where([a], fragment("?->>'state' = 'pending'", a.data))
353 |> where([a], a.actor == ^ap_id)
357 def restrict_deactivated_users(query) do
359 from(u in User.Query.build(%{deactivated: true}), select: u.ap_id)
362 Activity.Queries.exclude_authors(query, deactivated_users)
365 defdelegate search(user, query, options \\ []), to: Pleroma.Activity.Search
367 def direct_conversation_id(activity, for_user) do
368 alias Pleroma.Conversation.Participation
370 with %{data: %{"context" => context}} when is_binary(context) <- activity,
371 %Pleroma.Conversation{} = conversation <- Pleroma.Conversation.get_for_ap_id(context),
372 %Participation{id: participation_id} <-
373 Participation.for_user_and_conversation(for_user, conversation) do