1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.ActivityPub.Utils do
11 alias Pleroma.Notification
15 alias Pleroma.Web.ActivityPub.ActivityPub
16 alias Pleroma.Web.ActivityPub.Visibility
17 alias Pleroma.Web.AdminAPI.AccountView
18 alias Pleroma.Web.Endpoint
19 alias Pleroma.Web.Router.Helpers
24 require Pleroma.Constants
26 @supported_object_types [
36 @strip_status_report_states ~w(closed resolved)
37 @supported_report_states ~w(open closed resolved)
38 @valid_visibilities ~w(public unlisted private direct)
40 # Some implementations send the actor URI as the actor field, others send the entire actor object,
41 # so figure out what the actor's URI is based on what we have.
42 def get_ap_id(%{"id" => id} = _), do: id
43 def get_ap_id(id), do: id
45 def normalize_params(params) do
46 Map.put(params, "actor", get_ap_id(params["actor"]))
49 @spec determine_explicit_mentions(map()) :: [any]
50 def determine_explicit_mentions(%{"tag" => tag}) when is_list(tag) do
52 %{"type" => "Mention", "href" => href} -> [href]
57 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
59 |> Map.put("tag", [tag])
60 |> determine_explicit_mentions()
63 def determine_explicit_mentions(_), do: []
65 @spec label_in_collection?(any(), any()) :: boolean()
66 defp label_in_collection?(ap_id, coll) when is_binary(coll), do: ap_id == coll
67 defp label_in_collection?(ap_id, coll) when is_list(coll), do: ap_id in coll
68 defp label_in_collection?(_, _), do: false
70 @spec label_in_message?(String.t(), map()) :: boolean()
71 def label_in_message?(label, params),
73 [params["to"], params["cc"], params["bto"], params["bcc"]]
74 |> Enum.any?(&label_in_collection?(label, &1))
76 @spec unaddressed_message?(map()) :: boolean()
77 def unaddressed_message?(params),
79 [params["to"], params["cc"], params["bto"], params["bcc"]]
80 |> Enum.all?(&is_nil(&1))
82 @spec recipient_in_message(User.t(), User.t(), map()) :: boolean()
83 def recipient_in_message(%User{ap_id: ap_id} = recipient, %User{} = actor, params),
85 label_in_message?(ap_id, params) || unaddressed_message?(params) ||
86 User.following?(recipient, actor)
88 defp extract_list(target) when is_binary(target), do: [target]
89 defp extract_list(lst) when is_list(lst), do: lst
90 defp extract_list(_), do: []
92 def maybe_splice_recipient(ap_id, params) do
94 !label_in_collection?(ap_id, params["to"]) &&
95 !label_in_collection?(ap_id, params["cc"])
98 cc = [ap_id | extract_list(params["cc"])]
102 |> Maps.safe_put_in(["object", "cc"], cc)
108 def make_json_ld_header do
111 "https://www.w3.org/ns/activitystreams",
112 "#{Endpoint.url()}/schemas/litepub-0.1.jsonld",
121 DateTime.utc_now() |> DateTime.to_iso8601()
124 def generate_activity_id do
125 generate_id("activities")
128 def generate_context_id do
129 generate_id("contexts")
132 def generate_object_id do
133 Helpers.o_status_url(Endpoint, :object, UUID.generate())
136 def generate_id(type) do
137 "#{Endpoint.url()}/#{type}/#{UUID.generate()}"
140 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
141 fake_create_activity = %{
142 "to" => object["to"],
143 "cc" => object["cc"],
148 get_notified_from_object(fake_create_activity)
151 def get_notified_from_object(object) do
152 Notification.get_notified_from_activity(%Activity{data: object}, false)
155 def create_context(context) do
156 context = context || generate_id("contexts")
158 # Ecto has problems accessing the constraint inside the jsonb,
159 # so we explicitly check for the existed object before insert
160 object = Object.get_cached_by_ap_id(context)
162 with true <- is_nil(object),
163 changeset <- Object.context_mapping(context),
164 {:ok, inserted_object} <- Repo.insert(changeset) do
173 Enqueues an activity for federation if it's local
175 @spec maybe_federate(any()) :: :ok
176 def maybe_federate(%Activity{local: true, data: %{"type" => type}} = activity) do
177 outgoing_blocks = Config.get([:activitypub, :outgoing_blocks])
179 with true <- Config.get!([:instance, :federating]),
180 true <- type != "Block" || outgoing_blocks,
181 false <- Visibility.is_local_public?(activity) do
182 Pleroma.Web.Federator.publish(activity)
188 def maybe_federate(_), do: :ok
191 Adds an id and a published data if they aren't there,
192 also adds it to an included object
194 @spec lazy_put_activity_defaults(map(), boolean) :: map()
195 def lazy_put_activity_defaults(map, fake? \\ false)
197 def lazy_put_activity_defaults(map, true) do
199 |> Map.put_new("id", "pleroma:fakeid")
200 |> Map.put_new_lazy("published", &make_date/0)
201 |> Map.put_new("context", "pleroma:fakecontext")
202 |> Map.put_new("context_id", -1)
203 |> lazy_put_object_defaults(true)
206 def lazy_put_activity_defaults(map, _fake?) do
207 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
210 |> Map.put_new_lazy("id", &generate_activity_id/0)
211 |> Map.put_new_lazy("published", &make_date/0)
212 |> Map.put_new("context", context)
213 |> Map.put_new("context_id", context_id)
214 |> lazy_put_object_defaults(false)
217 # Adds an id and published date if they aren't there.
219 @spec lazy_put_object_defaults(map(), boolean()) :: map()
220 defp lazy_put_object_defaults(%{"object" => map} = activity, true)
224 |> Map.put_new("id", "pleroma:fake_object_id")
225 |> Map.put_new_lazy("published", &make_date/0)
226 |> Map.put_new("context", activity["context"])
227 |> Map.put_new("context_id", activity["context_id"])
228 |> Map.put_new("fake", true)
230 %{activity | "object" => object}
233 defp lazy_put_object_defaults(%{"object" => map} = activity, _)
237 |> Map.put_new_lazy("id", &generate_object_id/0)
238 |> Map.put_new_lazy("published", &make_date/0)
239 |> Map.put_new("context", activity["context"])
240 |> Map.put_new("context_id", activity["context_id"])
242 %{activity | "object" => object}
245 defp lazy_put_object_defaults(activity, _), do: activity
248 Inserts a full object if it is contained in an activity.
250 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
251 when type in @supported_object_types do
252 with {:ok, object} <- Object.create(object_data) do
253 map = Map.put(map, "object", object.data["id"])
259 def insert_full_object(map), do: {:ok, map, nil}
261 #### Like-related helpers
264 Returns an existing like if a user already liked an object
266 @spec get_existing_like(String.t(), map()) :: Activity.t() | nil
267 def get_existing_like(actor, %{data: %{"id" => id}}) do
269 |> Activity.Queries.by_actor()
270 |> Activity.Queries.by_object_id(id)
271 |> Activity.Queries.by_type("Like")
277 Returns like activities targeting an object
279 def get_object_likes(%{data: %{"id" => id}}) do
281 |> Activity.Queries.by_object_id()
282 |> Activity.Queries.by_type("Like")
286 @spec make_like_data(User.t(), map(), String.t()) :: map()
288 %User{ap_id: ap_id} = actor,
289 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
292 object_actor = User.get_cached_by_ap_id(object_actor_id)
295 if Visibility.is_public?(object) do
296 [actor.follower_address, object.data["actor"]]
298 [object.data["actor"]]
302 (object.data["to"] ++ (object.data["cc"] || []))
303 |> List.delete(actor.ap_id)
304 |> List.delete(object_actor.follower_address)
312 "context" => object.data["context"]
314 |> Maps.put_if_present("id", activity_id)
317 def make_emoji_reaction_data(user, object, emoji, activity_id) do
318 make_like_data(user, object, activity_id)
319 |> Map.put("type", "EmojiReact")
320 |> Map.put("content", emoji)
323 @spec update_element_in_object(String.t(), list(any), Object.t(), integer() | nil) ::
324 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
325 def update_element_in_object(property, element, object, count \\ nil) do
333 %{"#{property}_count" => length, "#{property}s" => element}
337 |> Changeset.change(data: data)
338 |> Object.update_and_set_cache()
341 @spec add_emoji_reaction_to_object(Activity.t(), Object.t()) ::
342 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
344 def add_emoji_reaction_to_object(
345 %Activity{data: %{"content" => emoji, "actor" => actor}},
348 reactions = get_cached_emoji_reactions(object)
351 case Enum.find_index(reactions, fn [candidate, _] -> emoji == candidate end) do
353 reactions ++ [[emoji, [actor]]]
359 fn [emoji, users] -> [emoji, Enum.uniq([actor | users])] end
363 count = emoji_count(new_reactions)
365 update_element_in_object("reaction", new_reactions, object, count)
368 def emoji_count(reactions_list) do
369 Enum.reduce(reactions_list, 0, fn [_, users], acc -> acc + length(users) end)
372 def remove_emoji_reaction_from_object(
373 %Activity{data: %{"content" => emoji, "actor" => actor}},
376 reactions = get_cached_emoji_reactions(object)
379 case Enum.find_index(reactions, fn [candidate, _] -> emoji == candidate end) do
387 fn [emoji, users] -> [emoji, List.delete(users, actor)] end
389 |> Enum.reject(fn [_, users] -> Enum.empty?(users) end)
392 count = emoji_count(new_reactions)
393 update_element_in_object("reaction", new_reactions, object, count)
396 def get_cached_emoji_reactions(object) do
397 if is_list(object.data["reactions"]) do
398 object.data["reactions"]
404 @spec add_like_to_object(Activity.t(), Object.t()) ::
405 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
406 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
407 [actor | fetch_likes(object)]
409 |> update_likes_in_object(object)
412 @spec remove_like_from_object(Activity.t(), Object.t()) ::
413 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
414 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
417 |> List.delete(actor)
418 |> update_likes_in_object(object)
421 defp update_likes_in_object(likes, object) do
422 update_element_in_object("like", likes, object)
425 defp fetch_likes(object) do
426 if is_list(object.data["likes"]) do
433 #### Follow-related helpers
436 Updates a follow activity's state (for locked accounts).
438 @spec update_follow_state_for_all(Activity.t(), String.t()) :: {:ok, Activity | nil}
439 def update_follow_state_for_all(
440 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
444 |> Activity.Queries.by_type()
445 |> Activity.Queries.by_actor(actor)
446 |> Activity.Queries.by_object_id(object)
447 |> where(fragment("data->>'state' = 'pending'"))
448 |> update(set: [data: fragment("jsonb_set(data, '{state}', ?)", ^state)])
449 |> Repo.update_all([])
451 activity = Activity.get_by_id(activity.id)
456 def update_follow_state(
457 %Activity{} = activity,
460 new_data = Map.put(activity.data, "state", state)
461 changeset = Changeset.change(activity, data: new_data)
463 with {:ok, activity} <- Repo.update(changeset) do
469 Makes a follow activity data for the given follower and followed
471 def make_follow_data(
472 %User{ap_id: follower_id},
473 %User{ap_id: followed_id} = _followed,
478 "actor" => follower_id,
479 "to" => [followed_id],
480 "cc" => [Pleroma.Constants.as_public()],
481 "object" => followed_id,
484 |> Maps.put_if_present("id", activity_id)
487 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
489 |> Activity.Queries.by_type()
490 |> where(actor: ^follower_id)
491 # this is to use the index
492 |> Activity.Queries.by_object_id(followed_id)
493 |> order_by([activity], fragment("? desc nulls last", activity.id))
498 def fetch_latest_undo(%User{ap_id: ap_id}) do
500 |> Activity.Queries.by_type()
501 |> where(actor: ^ap_id)
502 |> order_by([activity], fragment("? desc nulls last", activity.id))
507 def get_latest_reaction(internal_activity_id, %{ap_id: ap_id}, emoji) do
508 %{data: %{"object" => object_ap_id}} = Activity.get_by_id(internal_activity_id)
511 |> Activity.Queries.by_type()
512 |> where(actor: ^ap_id)
513 |> where([activity], fragment("?->>'content' = ?", activity.data, ^emoji))
514 |> Activity.Queries.by_object_id(object_ap_id)
515 |> order_by([activity], fragment("? desc nulls last", activity.id))
520 #### Announce-related helpers
523 Returns an existing announce activity if the notice has already been announced
525 @spec get_existing_announce(String.t(), map()) :: Activity.t() | nil
526 def get_existing_announce(actor, %{data: %{"id" => ap_id}}) do
528 |> Activity.Queries.by_type()
529 |> where(actor: ^actor)
530 # this is to use the index
531 |> Activity.Queries.by_object_id(ap_id)
536 Make announce activity data for the given actor and object
538 # for relayed messages, we only want to send to subscribers
539 def make_announce_data(
540 %User{ap_id: ap_id} = user,
541 %Object{data: %{"id" => id}} = object,
546 "type" => "Announce",
549 "to" => [user.follower_address],
551 "context" => object.data["context"]
553 |> Maps.put_if_present("id", activity_id)
556 def make_announce_data(
557 %User{ap_id: ap_id} = user,
558 %Object{data: %{"id" => id}} = object,
563 "type" => "Announce",
566 "to" => [user.follower_address, object.data["actor"]],
567 "cc" => [Pleroma.Constants.as_public()],
568 "context" => object.data["context"]
570 |> Maps.put_if_present("id", activity_id)
574 %User{ap_id: actor, follower_address: follower_address},
576 data: %{"id" => undone_activity_id, "context" => context},
577 actor: undone_activity_actor
584 "object" => undone_activity_id,
585 "to" => [follower_address, undone_activity_actor],
586 "cc" => [Pleroma.Constants.as_public()],
589 |> Maps.put_if_present("id", activity_id)
592 @spec add_announce_to_object(Activity.t(), Object.t()) ::
593 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
594 def add_announce_to_object(
595 %Activity{data: %{"actor" => actor}},
598 unless actor |> User.get_cached_by_ap_id() |> User.invisible?() do
599 announcements = take_announcements(object)
601 with announcements <- Enum.uniq([actor | announcements]) do
602 update_element_in_object("announcement", announcements, object)
609 def add_announce_to_object(_, object), do: {:ok, object}
611 @spec remove_announce_from_object(Activity.t(), Object.t()) ::
612 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
613 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
614 with announcements <- List.delete(take_announcements(object), actor) do
615 update_element_in_object("announcement", announcements, object)
619 defp take_announcements(%{data: %{"announcements" => announcements}} = _)
620 when is_list(announcements),
623 defp take_announcements(_), do: []
625 #### Unfollow-related helpers
627 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
630 "actor" => follower.ap_id,
631 "to" => [followed.ap_id],
632 "object" => follow_activity.data
634 |> Maps.put_if_present("id", activity_id)
637 #### Block-related helpers
638 @spec fetch_latest_block(User.t(), User.t()) :: Activity.t() | nil
639 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
641 |> Activity.Queries.by_type()
642 |> where(actor: ^blocker_id)
643 # this is to use the index
644 |> Activity.Queries.by_object_id(blocked_id)
645 |> order_by([activity], fragment("? desc nulls last", activity.id))
650 def make_block_data(blocker, blocked, activity_id) do
653 "actor" => blocker.ap_id,
654 "to" => [blocked.ap_id],
655 "object" => blocked.ap_id
657 |> Maps.put_if_present("id", activity_id)
660 #### Create-related helpers
662 def make_create_data(params, additional) do
663 published = params.published || make_date()
667 "to" => params.to |> Enum.uniq(),
668 "actor" => params.actor.ap_id,
669 "object" => params.object,
670 "published" => published,
671 "context" => params.context
673 |> Map.merge(additional)
676 #### Listen-related helpers
677 def make_listen_data(params, additional) do
678 published = params.published || make_date()
682 "to" => params.to |> Enum.uniq(),
683 "actor" => params.actor.ap_id,
684 "object" => params.object,
685 "published" => published,
686 "context" => params.context
688 |> Map.merge(additional)
691 #### Flag-related helpers
692 @spec make_flag_data(map(), map()) :: map()
693 def make_flag_data(%{actor: actor, context: context, content: content} = params, additional) do
696 "actor" => actor.ap_id,
697 "content" => content,
698 "object" => build_flag_object(params),
699 "context" => context,
702 |> Map.merge(additional)
705 def make_flag_data(_, _), do: %{}
707 defp build_flag_object(%{account: account, statuses: statuses}) do
708 [account.ap_id | build_flag_object(%{statuses: statuses})]
711 defp build_flag_object(%{statuses: statuses}) do
712 Enum.map(statuses || [], &build_flag_object/1)
715 defp build_flag_object(%Activity{data: %{"id" => id}, object: %{data: data}}) do
716 activity_actor = User.get_by_ap_id(data["actor"])
721 "content" => data["content"],
722 "published" => data["published"],
726 %{user: activity_actor, skip_visibility_check: true}
731 defp build_flag_object(act) when is_map(act) or is_binary(act) do
734 %Activity{} = act -> act.data["id"]
735 act when is_map(act) -> act["id"]
736 act when is_binary(act) -> act
739 case Activity.get_by_ap_id_with_object(id) do
740 %Activity{} = activity ->
741 build_flag_object(activity)
744 if activity = Activity.get_by_object_ap_id_with_object(id) do
745 build_flag_object(activity)
747 %{"id" => id, "deleted" => true}
752 defp build_flag_object(_), do: []
754 #### Report-related helpers
755 def get_reports(params, page, page_size) do
758 |> Map.put(:type, "Flag")
759 |> Map.put(:skip_preload, true)
760 |> Map.put(:preload_report_notes, true)
761 |> Map.put(:total, true)
762 |> Map.put(:limit, page_size)
763 |> Map.put(:offset, (page - 1) * page_size)
765 ActivityPub.fetch_activities([], params, :offset)
768 def update_report_state(%Activity{} = activity, state)
769 when state in @strip_status_report_states do
770 {:ok, stripped_activity} = strip_report_status_data(activity)
774 |> Map.put("state", state)
775 |> Map.put("object", stripped_activity.data["object"])
778 |> Changeset.change(data: new_data)
782 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
783 new_data = Map.put(activity.data, "state", state)
786 |> Changeset.change(data: new_data)
790 def update_report_state(activity_ids, state) when state in @supported_report_states do
791 activities_num = length(activity_ids)
793 from(a in Activity, where: a.id in ^activity_ids)
794 |> update(set: [data: fragment("jsonb_set(data, '{state}', ?)", ^state)])
795 |> Repo.update_all([])
797 {^activities_num, _} -> :ok
798 _ -> {:error, activity_ids}
802 def update_report_state(_, _), do: {:error, "Unsupported state"}
804 def strip_report_status_data(activity) do
805 [actor | reported_activities] = activity.data["object"]
807 stripped_activities =
808 Enum.map(reported_activities, fn
809 act when is_map(act) -> act["id"]
810 act when is_binary(act) -> act
813 new_data = put_in(activity.data, ["object"], [actor | stripped_activities])
815 {:ok, %{activity | data: new_data}}
818 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
819 [to, cc, recipients] =
821 |> get_updated_targets(visibility)
822 |> Enum.map(&Enum.uniq/1)
831 |> Object.change(%{data: object_data})
832 |> Object.update_and_set_cache()
840 |> Map.put(:object, object)
841 |> Activity.change(%{data: activity_data, recipients: recipients})
845 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
847 defp get_updated_targets(
848 %Activity{data: %{"to" => to} = data, recipients: recipients},
851 cc = Map.get(data, "cc", [])
852 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
853 public = Pleroma.Constants.as_public()
857 to = [public | List.delete(to, follower_address)]
858 cc = [follower_address | List.delete(cc, public)]
859 recipients = [public | recipients]
863 to = [follower_address | List.delete(to, public)]
864 cc = List.delete(cc, public)
865 recipients = List.delete(recipients, public)
869 to = [follower_address | List.delete(to, public)]
870 cc = [public | List.delete(cc, follower_address)]
871 recipients = recipients ++ [follower_address, public]
879 def get_existing_votes(actor, %{data: %{"id" => id}}) do
881 |> Activity.Queries.by_actor()
882 |> Activity.Queries.by_type("Create")
883 |> Activity.with_preloaded_object()
884 |> where([a, object: o], fragment("(?)->>'inReplyTo' = ?", o.data, ^to_string(id)))
885 |> where([a, object: o], fragment("(?)->>'type' = 'Answer'", o.data))