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.Web.ActivityPub.Utils do
9 alias Pleroma.Notification
14 alias Pleroma.Web.ActivityPub.ActivityPub
15 alias Pleroma.Web.ActivityPub.Visibility
16 alias Pleroma.Web.AdminAPI.AccountView
17 alias Pleroma.Web.Endpoint
18 alias Pleroma.Web.Router.Helpers
23 require Pleroma.Constants
25 @supported_object_types [
35 @strip_status_report_states ~w(closed resolved)
36 @supported_report_states ~w(open closed resolved)
37 @valid_visibilities ~w(public unlisted private direct)
39 # Some implementations send the actor URI as the actor field, others send the entire actor object,
40 # so figure out what the actor's URI is based on what we have.
41 def get_ap_id(%{"id" => id} = _), do: id
42 def get_ap_id(id), do: id
44 def normalize_params(params) do
45 Map.put(params, "actor", get_ap_id(params["actor"]))
48 @spec determine_explicit_mentions(map()) :: [any]
49 def determine_explicit_mentions(%{"tag" => tag}) when is_list(tag) do
51 %{"type" => "Mention", "href" => href} -> [href]
56 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
58 |> Map.put("tag", [tag])
59 |> determine_explicit_mentions()
62 def determine_explicit_mentions(_), do: []
64 @spec label_in_collection?(any(), any()) :: boolean()
65 defp label_in_collection?(ap_id, coll) when is_binary(coll), do: ap_id == coll
66 defp label_in_collection?(ap_id, coll) when is_list(coll), do: ap_id in coll
67 defp label_in_collection?(_, _), do: false
69 @spec label_in_message?(String.t(), map()) :: boolean()
70 def label_in_message?(label, params),
72 [params["to"], params["cc"], params["bto"], params["bcc"]]
73 |> Enum.any?(&label_in_collection?(label, &1))
75 @spec unaddressed_message?(map()) :: boolean()
76 def unaddressed_message?(params),
78 [params["to"], params["cc"], params["bto"], params["bcc"]]
79 |> Enum.all?(&is_nil(&1))
81 @spec recipient_in_message(User.t(), User.t(), map()) :: boolean()
82 def recipient_in_message(%User{ap_id: ap_id} = recipient, %User{} = actor, params),
84 label_in_message?(ap_id, params) || unaddressed_message?(params) ||
85 User.following?(recipient, actor)
87 defp extract_list(target) when is_binary(target), do: [target]
88 defp extract_list(lst) when is_list(lst), do: lst
89 defp extract_list(_), do: []
91 def maybe_splice_recipient(ap_id, params) do
93 !label_in_collection?(ap_id, params["to"]) &&
94 !label_in_collection?(ap_id, params["cc"])
97 cc_list = extract_list(params["cc"])
98 Map.put(params, "cc", [ap_id | cc_list])
104 def make_json_ld_header do
107 "https://www.w3.org/ns/activitystreams",
108 "#{Web.base_url()}/schemas/litepub-0.1.jsonld",
117 DateTime.utc_now() |> DateTime.to_iso8601()
120 def generate_activity_id do
121 generate_id("activities")
124 def generate_context_id do
125 generate_id("contexts")
128 def generate_object_id do
129 Helpers.o_status_url(Endpoint, :object, UUID.generate())
132 def generate_id(type) do
133 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
136 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
137 fake_create_activity = %{
138 "to" => object["to"],
139 "cc" => object["cc"],
144 get_notified_from_object(fake_create_activity)
147 def get_notified_from_object(object) do
148 Notification.get_notified_from_activity(%Activity{data: object}, false)
151 def create_context(context) do
152 context = context || generate_id("contexts")
154 # Ecto has problems accessing the constraint inside the jsonb,
155 # so we explicitly check for the existed object before insert
156 object = Object.get_cached_by_ap_id(context)
158 with true <- is_nil(object),
159 changeset <- Object.context_mapping(context),
160 {:ok, inserted_object} <- Repo.insert(changeset) do
169 Enqueues an activity for federation if it's local
171 @spec maybe_federate(any()) :: :ok
172 def maybe_federate(%Activity{local: true} = activity) do
173 if Pleroma.Config.get!([:instance, :federating]) do
174 Pleroma.Web.Federator.publish(activity)
180 def maybe_federate(_), do: :ok
183 Adds an id and a published data if they aren't there,
184 also adds it to an included object
186 @spec lazy_put_activity_defaults(map(), boolean) :: map()
187 def lazy_put_activity_defaults(map, fake? \\ false)
189 def lazy_put_activity_defaults(map, true) do
191 |> Map.put_new("id", "pleroma:fakeid")
192 |> Map.put_new_lazy("published", &make_date/0)
193 |> Map.put_new("context", "pleroma:fakecontext")
194 |> Map.put_new("context_id", -1)
195 |> lazy_put_object_defaults(true)
198 def lazy_put_activity_defaults(map, _fake?) do
199 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
202 |> Map.put_new_lazy("id", &generate_activity_id/0)
203 |> Map.put_new_lazy("published", &make_date/0)
204 |> Map.put_new("context", context)
205 |> Map.put_new("context_id", context_id)
206 |> lazy_put_object_defaults(false)
209 # Adds an id and published date if they aren't there.
211 @spec lazy_put_object_defaults(map(), boolean()) :: map()
212 defp lazy_put_object_defaults(%{"object" => map} = activity, true)
216 |> Map.put_new("id", "pleroma:fake_object_id")
217 |> Map.put_new_lazy("published", &make_date/0)
218 |> Map.put_new("context", activity["context"])
219 |> Map.put_new("context_id", activity["context_id"])
220 |> Map.put_new("fake", true)
222 %{activity | "object" => object}
225 defp lazy_put_object_defaults(%{"object" => map} = activity, _)
229 |> Map.put_new_lazy("id", &generate_object_id/0)
230 |> Map.put_new_lazy("published", &make_date/0)
231 |> Map.put_new("context", activity["context"])
232 |> Map.put_new("context_id", activity["context_id"])
234 %{activity | "object" => object}
237 defp lazy_put_object_defaults(activity, _), do: activity
240 Inserts a full object if it is contained in an activity.
242 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
243 when is_map(object_data) and type in @supported_object_types do
244 with {:ok, object} <- Object.create(object_data) do
245 map = Map.put(map, "object", object.data["id"])
251 def insert_full_object(map), do: {:ok, map, nil}
253 #### Like-related helpers
256 Returns an existing like if a user already liked an object
258 @spec get_existing_like(String.t(), map()) :: Activity.t() | nil
259 def get_existing_like(actor, %{data: %{"id" => id}}) do
261 |> Activity.Queries.by_actor()
262 |> Activity.Queries.by_object_id(id)
263 |> Activity.Queries.by_type("Like")
269 Returns like activities targeting an object
271 def get_object_likes(%{data: %{"id" => id}}) do
273 |> Activity.Queries.by_object_id()
274 |> Activity.Queries.by_type("Like")
278 @spec make_like_data(User.t(), map(), String.t()) :: map()
280 %User{ap_id: ap_id} = actor,
281 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
284 object_actor = User.get_cached_by_ap_id(object_actor_id)
287 if Visibility.is_public?(object) do
288 [actor.follower_address, object.data["actor"]]
290 [object.data["actor"]]
294 (object.data["to"] ++ (object.data["cc"] || []))
295 |> List.delete(actor.ap_id)
296 |> List.delete(object_actor.follower_address)
304 "context" => object.data["context"]
306 |> maybe_put("id", activity_id)
309 def make_emoji_reaction_data(user, object, emoji, activity_id) do
310 make_like_data(user, object, activity_id)
311 |> Map.put("type", "EmojiReact")
312 |> Map.put("content", emoji)
315 @spec update_element_in_object(String.t(), list(any), Object.t(), integer() | nil) ::
316 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
317 def update_element_in_object(property, element, object, count \\ nil) do
325 %{"#{property}_count" => length, "#{property}s" => element}
329 |> Changeset.change(data: data)
330 |> Object.update_and_set_cache()
333 @spec add_emoji_reaction_to_object(Activity.t(), Object.t()) ::
334 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
336 def add_emoji_reaction_to_object(
337 %Activity{data: %{"content" => emoji, "actor" => actor}},
340 reactions = get_cached_emoji_reactions(object)
343 case Enum.find_index(reactions, fn [candidate, _] -> emoji == candidate end) do
345 reactions ++ [[emoji, [actor]]]
351 fn [emoji, users] -> [emoji, Enum.uniq([actor | users])] end
355 count = emoji_count(new_reactions)
357 update_element_in_object("reaction", new_reactions, object, count)
360 def emoji_count(reactions_list) do
361 Enum.reduce(reactions_list, 0, fn [_, users], acc -> acc + length(users) end)
364 def remove_emoji_reaction_from_object(
365 %Activity{data: %{"content" => emoji, "actor" => actor}},
368 reactions = get_cached_emoji_reactions(object)
371 case Enum.find_index(reactions, fn [candidate, _] -> emoji == candidate end) do
379 fn [emoji, users] -> [emoji, List.delete(users, actor)] end
381 |> Enum.reject(fn [_, users] -> Enum.empty?(users) end)
384 count = emoji_count(new_reactions)
385 update_element_in_object("reaction", new_reactions, object, count)
388 def get_cached_emoji_reactions(object) do
389 if is_list(object.data["reactions"]) do
390 object.data["reactions"]
396 @spec add_like_to_object(Activity.t(), Object.t()) ::
397 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
398 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
399 [actor | fetch_likes(object)]
401 |> update_likes_in_object(object)
404 @spec remove_like_from_object(Activity.t(), Object.t()) ::
405 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
406 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
409 |> List.delete(actor)
410 |> update_likes_in_object(object)
413 defp update_likes_in_object(likes, object) do
414 update_element_in_object("like", likes, object)
417 defp fetch_likes(object) do
418 if is_list(object.data["likes"]) do
425 #### Follow-related helpers
428 Updates a follow activity's state (for locked accounts).
430 @spec update_follow_state_for_all(Activity.t(), String.t()) :: {:ok, Activity | nil}
431 def update_follow_state_for_all(
432 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
436 |> Activity.Queries.by_type()
437 |> Activity.Queries.by_actor(actor)
438 |> Activity.Queries.by_object_id(object)
439 |> where(fragment("data->>'state' = 'pending'"))
440 |> update(set: [data: fragment("jsonb_set(data, '{state}', ?)", ^state)])
441 |> Repo.update_all([])
443 activity = Activity.get_by_id(activity.id)
448 def update_follow_state(
449 %Activity{} = activity,
452 new_data = Map.put(activity.data, "state", state)
453 changeset = Changeset.change(activity, data: new_data)
455 with {:ok, activity} <- Repo.update(changeset) do
461 Makes a follow activity data for the given follower and followed
463 def make_follow_data(
464 %User{ap_id: follower_id},
465 %User{ap_id: followed_id} = _followed,
470 "actor" => follower_id,
471 "to" => [followed_id],
472 "cc" => [Pleroma.Constants.as_public()],
473 "object" => followed_id,
476 |> maybe_put("id", activity_id)
479 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
481 |> Activity.Queries.by_type()
482 |> where(actor: ^follower_id)
483 # this is to use the index
484 |> Activity.Queries.by_object_id(followed_id)
485 |> order_by([activity], fragment("? desc nulls last", activity.id))
490 def fetch_latest_undo(%User{ap_id: ap_id}) do
492 |> Activity.Queries.by_type()
493 |> where(actor: ^ap_id)
494 |> order_by([activity], fragment("? desc nulls last", activity.id))
499 def get_latest_reaction(internal_activity_id, %{ap_id: ap_id}, emoji) do
500 %{data: %{"object" => object_ap_id}} = Activity.get_by_id(internal_activity_id)
503 |> Activity.Queries.by_type()
504 |> where(actor: ^ap_id)
505 |> where([activity], fragment("?->>'content' = ?", activity.data, ^emoji))
506 |> Activity.Queries.by_object_id(object_ap_id)
507 |> order_by([activity], fragment("? desc nulls last", activity.id))
512 #### Announce-related helpers
515 Retruns an existing announce activity if the notice has already been announced
517 @spec get_existing_announce(String.t(), map()) :: Activity.t() | nil
518 def get_existing_announce(actor, %{data: %{"id" => ap_id}}) do
520 |> Activity.Queries.by_type()
521 |> where(actor: ^actor)
522 # this is to use the index
523 |> Activity.Queries.by_object_id(ap_id)
528 Make announce activity data for the given actor and object
530 # for relayed messages, we only want to send to subscribers
531 def make_announce_data(
532 %User{ap_id: ap_id} = user,
533 %Object{data: %{"id" => id}} = object,
538 "type" => "Announce",
541 "to" => [user.follower_address],
543 "context" => object.data["context"]
545 |> maybe_put("id", activity_id)
548 def make_announce_data(
549 %User{ap_id: ap_id} = user,
550 %Object{data: %{"id" => id}} = object,
555 "type" => "Announce",
558 "to" => [user.follower_address, object.data["actor"]],
559 "cc" => [Pleroma.Constants.as_public()],
560 "context" => object.data["context"]
562 |> maybe_put("id", activity_id)
566 Make unannounce activity data for the given actor and object
568 def make_unannounce_data(
569 %User{ap_id: ap_id} = user,
570 %Activity{data: %{"context" => context, "object" => object}} = activity,
573 object = Object.normalize(object)
578 "object" => activity.data,
579 "to" => [user.follower_address, object.data["actor"]],
580 "cc" => [Pleroma.Constants.as_public()],
583 |> maybe_put("id", activity_id)
586 def make_unlike_data(
587 %User{ap_id: ap_id} = user,
588 %Activity{data: %{"context" => context, "object" => object}} = activity,
591 object = Object.normalize(object)
596 "object" => activity.data,
597 "to" => [user.follower_address, object.data["actor"]],
598 "cc" => [Pleroma.Constants.as_public()],
601 |> maybe_put("id", activity_id)
605 %User{ap_id: actor, follower_address: follower_address},
607 data: %{"id" => undone_activity_id, "context" => context},
608 actor: undone_activity_actor
615 "object" => undone_activity_id,
616 "to" => [follower_address, undone_activity_actor],
617 "cc" => [Pleroma.Constants.as_public()],
620 |> maybe_put("id", activity_id)
623 @spec add_announce_to_object(Activity.t(), Object.t()) ::
624 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
625 def add_announce_to_object(
626 %Activity{data: %{"actor" => actor}},
629 unless actor |> User.get_cached_by_ap_id() |> User.invisible?() do
630 announcements = take_announcements(object)
632 with announcements <- Enum.uniq([actor | announcements]) do
633 update_element_in_object("announcement", announcements, object)
640 def add_announce_to_object(_, object), do: {:ok, object}
642 @spec remove_announce_from_object(Activity.t(), Object.t()) ::
643 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
644 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
645 with announcements <- List.delete(take_announcements(object), actor) do
646 update_element_in_object("announcement", announcements, object)
650 defp take_announcements(%{data: %{"announcements" => announcements}} = _)
651 when is_list(announcements),
654 defp take_announcements(_), do: []
656 #### Unfollow-related helpers
658 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
661 "actor" => follower.ap_id,
662 "to" => [followed.ap_id],
663 "object" => follow_activity.data
665 |> maybe_put("id", activity_id)
668 #### Block-related helpers
669 @spec fetch_latest_block(User.t(), User.t()) :: Activity.t() | nil
670 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
672 |> Activity.Queries.by_type()
673 |> where(actor: ^blocker_id)
674 # this is to use the index
675 |> Activity.Queries.by_object_id(blocked_id)
676 |> order_by([activity], fragment("? desc nulls last", activity.id))
681 def make_block_data(blocker, blocked, activity_id) do
684 "actor" => blocker.ap_id,
685 "to" => [blocked.ap_id],
686 "object" => blocked.ap_id
688 |> maybe_put("id", activity_id)
691 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
694 "actor" => blocker.ap_id,
695 "to" => [blocked.ap_id],
696 "object" => block_activity.data
698 |> maybe_put("id", activity_id)
701 #### Create-related helpers
703 def make_create_data(params, additional) do
704 published = params.published || make_date()
708 "to" => params.to |> Enum.uniq(),
709 "actor" => params.actor.ap_id,
710 "object" => params.object,
711 "published" => published,
712 "context" => params.context
714 |> Map.merge(additional)
717 #### Listen-related helpers
718 def make_listen_data(params, additional) do
719 published = params.published || make_date()
723 "to" => params.to |> Enum.uniq(),
724 "actor" => params.actor.ap_id,
725 "object" => params.object,
726 "published" => published,
727 "context" => params.context
729 |> Map.merge(additional)
732 #### Flag-related helpers
733 @spec make_flag_data(map(), map()) :: map()
734 def make_flag_data(%{actor: actor, context: context, content: content} = params, additional) do
737 "actor" => actor.ap_id,
738 "content" => content,
739 "object" => build_flag_object(params),
740 "context" => context,
743 |> Map.merge(additional)
746 def make_flag_data(_, _), do: %{}
748 defp build_flag_object(%{account: account, statuses: statuses} = _) do
749 [account.ap_id] ++ build_flag_object(%{statuses: statuses})
752 defp build_flag_object(%{statuses: statuses}) do
753 Enum.map(statuses || [], &build_flag_object/1)
756 defp build_flag_object(act) when is_map(act) or is_binary(act) do
759 %Activity{} = act -> act.data["id"]
760 act when is_map(act) -> act["id"]
761 act when is_binary(act) -> act
764 case Activity.get_by_ap_id_with_object(id) do
765 %Activity{} = activity ->
768 "id" => activity.data["id"],
769 "content" => activity.object.data["content"],
770 "published" => activity.object.data["published"],
772 AccountView.render("show.json", %{
773 user: User.get_by_ap_id(activity.object.data["actor"])
778 %{"id" => id, "deleted" => true}
782 defp build_flag_object(_), do: []
784 #### Report-related helpers
785 def get_reports(params, page, page_size) do
788 |> Map.put("type", "Flag")
789 |> Map.put("skip_preload", true)
790 |> Map.put("preload_report_notes", true)
791 |> Map.put("total", true)
792 |> Map.put("limit", page_size)
793 |> Map.put("offset", (page - 1) * page_size)
795 ActivityPub.fetch_activities([], params, :offset)
798 def update_report_state(%Activity{} = activity, state)
799 when state in @strip_status_report_states do
800 {:ok, stripped_activity} = strip_report_status_data(activity)
804 |> Map.put("state", state)
805 |> Map.put("object", stripped_activity.data["object"])
808 |> Changeset.change(data: new_data)
812 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
813 new_data = Map.put(activity.data, "state", state)
816 |> Changeset.change(data: new_data)
820 def update_report_state(activity_ids, state) when state in @supported_report_states do
821 activities_num = length(activity_ids)
823 from(a in Activity, where: a.id in ^activity_ids)
824 |> update(set: [data: fragment("jsonb_set(data, '{state}', ?)", ^state)])
825 |> Repo.update_all([])
827 {^activities_num, _} -> :ok
828 _ -> {:error, activity_ids}
832 def update_report_state(_, _), do: {:error, "Unsupported state"}
834 def strip_report_status_data(activity) do
835 [actor | reported_activities] = activity.data["object"]
837 stripped_activities =
838 Enum.map(reported_activities, fn
839 act when is_map(act) -> act["id"]
840 act when is_binary(act) -> act
843 new_data = put_in(activity.data, ["object"], [actor | stripped_activities])
845 {:ok, %{activity | data: new_data}}
848 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
849 [to, cc, recipients] =
851 |> get_updated_targets(visibility)
852 |> Enum.map(&Enum.uniq/1)
861 |> Object.change(%{data: object_data})
862 |> Object.update_and_set_cache()
870 |> Map.put(:object, object)
871 |> Activity.change(%{data: activity_data, recipients: recipients})
875 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
877 defp get_updated_targets(
878 %Activity{data: %{"to" => to} = data, recipients: recipients},
881 cc = Map.get(data, "cc", [])
882 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
883 public = Pleroma.Constants.as_public()
887 to = [public | List.delete(to, follower_address)]
888 cc = [follower_address | List.delete(cc, public)]
889 recipients = [public | recipients]
893 to = [follower_address | List.delete(to, public)]
894 cc = List.delete(cc, public)
895 recipients = List.delete(recipients, public)
899 to = [follower_address | List.delete(to, public)]
900 cc = [public | List.delete(cc, follower_address)]
901 recipients = recipients ++ [follower_address, public]
909 def get_existing_votes(actor, %{data: %{"id" => id}}) do
911 |> Activity.Queries.by_actor()
912 |> Activity.Queries.by_type("Create")
913 |> Activity.with_preloaded_object()
914 |> where([a, object: o], fragment("(?)->>'inReplyTo' = ?", o.data, ^to_string(id)))
915 |> where([a, object: o], fragment("(?)->>'type' = 'Answer'", o.data))
919 def maybe_put(map, _key, nil), do: map
920 def maybe_put(map, key, value), do: Map.put(map, key, value)