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
10 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_list = extract_list(params["cc"])
99 Map.put(params, "cc", [ap_id | cc_list])
105 def make_json_ld_header do
108 "https://www.w3.org/ns/activitystreams",
109 "#{Web.base_url()}/schemas/litepub-0.1.jsonld",
118 DateTime.utc_now() |> DateTime.to_iso8601()
121 def generate_activity_id do
122 generate_id("activities")
125 def generate_context_id do
126 generate_id("contexts")
129 def generate_object_id do
130 Helpers.o_status_url(Endpoint, :object, UUID.generate())
133 def generate_id(type) do
134 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
137 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
138 fake_create_activity = %{
139 "to" => object["to"],
140 "cc" => object["cc"],
145 get_notified_from_object(fake_create_activity)
148 def get_notified_from_object(object) do
149 Notification.get_notified_from_activity(%Activity{data: object}, false)
152 def create_context(context) do
153 context = context || generate_id("contexts")
155 # Ecto has problems accessing the constraint inside the jsonb,
156 # so we explicitly check for the existed object before insert
157 object = Object.get_cached_by_ap_id(context)
159 with true <- is_nil(object),
160 changeset <- Object.context_mapping(context),
161 {:ok, inserted_object} <- Repo.insert(changeset) do
170 Enqueues an activity for federation if it's local
172 @spec maybe_federate(any()) :: :ok
173 def maybe_federate(%Activity{local: true, data: %{"type" => type}} = activity) do
174 outgoing_blocks = Config.get([:activitypub, :outgoing_blocks])
176 with true <- Config.get!([:instance, :federating]),
177 true <- type != "Block" || outgoing_blocks do
178 Pleroma.Web.Federator.publish(activity)
184 def maybe_federate(_), do: :ok
187 Adds an id and a published data if they aren't there,
188 also adds it to an included object
190 @spec lazy_put_activity_defaults(map(), boolean) :: map()
191 def lazy_put_activity_defaults(map, fake? \\ false)
193 def lazy_put_activity_defaults(map, true) do
195 |> Map.put_new("id", "pleroma:fakeid")
196 |> Map.put_new_lazy("published", &make_date/0)
197 |> Map.put_new("context", "pleroma:fakecontext")
198 |> Map.put_new("context_id", -1)
199 |> lazy_put_object_defaults(true)
202 def lazy_put_activity_defaults(map, _fake?) do
203 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
206 |> Map.put_new_lazy("id", &generate_activity_id/0)
207 |> Map.put_new_lazy("published", &make_date/0)
208 |> Map.put_new("context", context)
209 |> Map.put_new("context_id", context_id)
210 |> lazy_put_object_defaults(false)
213 # Adds an id and published date if they aren't there.
215 @spec lazy_put_object_defaults(map(), boolean()) :: map()
216 defp lazy_put_object_defaults(%{"object" => map} = activity, true)
220 |> Map.put_new("id", "pleroma:fake_object_id")
221 |> Map.put_new_lazy("published", &make_date/0)
222 |> Map.put_new("context", activity["context"])
223 |> Map.put_new("context_id", activity["context_id"])
224 |> Map.put_new("fake", true)
226 %{activity | "object" => object}
229 defp lazy_put_object_defaults(%{"object" => map} = activity, _)
233 |> Map.put_new_lazy("id", &generate_object_id/0)
234 |> Map.put_new_lazy("published", &make_date/0)
235 |> Map.put_new("context", activity["context"])
236 |> Map.put_new("context_id", activity["context_id"])
238 %{activity | "object" => object}
241 defp lazy_put_object_defaults(activity, _), do: activity
244 Inserts a full object if it is contained in an activity.
246 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
247 when is_map(object_data) and type in @supported_object_types do
248 with {:ok, object} <- Object.create(object_data) do
249 map = Map.put(map, "object", object.data["id"])
255 def insert_full_object(map), do: {:ok, map, nil}
257 #### Like-related helpers
260 Returns an existing like if a user already liked an object
262 @spec get_existing_like(String.t(), map()) :: Activity.t() | nil
263 def get_existing_like(actor, %{data: %{"id" => id}}) do
265 |> Activity.Queries.by_actor()
266 |> Activity.Queries.by_object_id(id)
267 |> Activity.Queries.by_type("Like")
273 Returns like activities targeting an object
275 def get_object_likes(%{data: %{"id" => id}}) do
277 |> Activity.Queries.by_object_id()
278 |> Activity.Queries.by_type("Like")
282 @spec make_like_data(User.t(), map(), String.t()) :: map()
284 %User{ap_id: ap_id} = actor,
285 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
288 object_actor = User.get_cached_by_ap_id(object_actor_id)
291 if Visibility.is_public?(object) do
292 [actor.follower_address, object.data["actor"]]
294 [object.data["actor"]]
298 (object.data["to"] ++ (object.data["cc"] || []))
299 |> List.delete(actor.ap_id)
300 |> List.delete(object_actor.follower_address)
308 "context" => object.data["context"]
310 |> maybe_put("id", activity_id)
313 def make_emoji_reaction_data(user, object, emoji, activity_id) do
314 make_like_data(user, object, activity_id)
315 |> Map.put("type", "EmojiReact")
316 |> Map.put("content", emoji)
319 @spec update_element_in_object(String.t(), list(any), Object.t(), integer() | nil) ::
320 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
321 def update_element_in_object(property, element, object, count \\ nil) do
329 %{"#{property}_count" => length, "#{property}s" => element}
333 |> Changeset.change(data: data)
334 |> Object.update_and_set_cache()
337 @spec add_emoji_reaction_to_object(Activity.t(), Object.t()) ::
338 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
340 def add_emoji_reaction_to_object(
341 %Activity{data: %{"content" => emoji, "actor" => actor}},
344 reactions = get_cached_emoji_reactions(object)
347 case Enum.find_index(reactions, fn [candidate, _] -> emoji == candidate end) do
349 reactions ++ [[emoji, [actor]]]
355 fn [emoji, users] -> [emoji, Enum.uniq([actor | users])] end
359 count = emoji_count(new_reactions)
361 update_element_in_object("reaction", new_reactions, object, count)
364 def emoji_count(reactions_list) do
365 Enum.reduce(reactions_list, 0, fn [_, users], acc -> acc + length(users) end)
368 def remove_emoji_reaction_from_object(
369 %Activity{data: %{"content" => emoji, "actor" => actor}},
372 reactions = get_cached_emoji_reactions(object)
375 case Enum.find_index(reactions, fn [candidate, _] -> emoji == candidate end) do
383 fn [emoji, users] -> [emoji, List.delete(users, actor)] end
385 |> Enum.reject(fn [_, users] -> Enum.empty?(users) end)
388 count = emoji_count(new_reactions)
389 update_element_in_object("reaction", new_reactions, object, count)
392 def get_cached_emoji_reactions(object) do
393 if is_list(object.data["reactions"]) do
394 object.data["reactions"]
400 @spec add_like_to_object(Activity.t(), Object.t()) ::
401 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
402 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
403 [actor | fetch_likes(object)]
405 |> update_likes_in_object(object)
408 @spec remove_like_from_object(Activity.t(), Object.t()) ::
409 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
410 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
413 |> List.delete(actor)
414 |> update_likes_in_object(object)
417 defp update_likes_in_object(likes, object) do
418 update_element_in_object("like", likes, object)
421 defp fetch_likes(object) do
422 if is_list(object.data["likes"]) do
429 #### Follow-related helpers
432 Updates a follow activity's state (for locked accounts).
434 @spec update_follow_state_for_all(Activity.t(), String.t()) :: {:ok, Activity | nil}
435 def update_follow_state_for_all(
436 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
440 |> Activity.Queries.by_type()
441 |> Activity.Queries.by_actor(actor)
442 |> Activity.Queries.by_object_id(object)
443 |> where(fragment("data->>'state' = 'pending'"))
444 |> update(set: [data: fragment("jsonb_set(data, '{state}', ?)", ^state)])
445 |> Repo.update_all([])
447 activity = Activity.get_by_id(activity.id)
452 def update_follow_state(
453 %Activity{} = activity,
456 new_data = Map.put(activity.data, "state", state)
457 changeset = Changeset.change(activity, data: new_data)
459 with {:ok, activity} <- Repo.update(changeset) do
465 Makes a follow activity data for the given follower and followed
467 def make_follow_data(
468 %User{ap_id: follower_id},
469 %User{ap_id: followed_id} = _followed,
474 "actor" => follower_id,
475 "to" => [followed_id],
476 "cc" => [Pleroma.Constants.as_public()],
477 "object" => followed_id,
480 |> maybe_put("id", activity_id)
483 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
485 |> Activity.Queries.by_type()
486 |> where(actor: ^follower_id)
487 # this is to use the index
488 |> Activity.Queries.by_object_id(followed_id)
489 |> order_by([activity], fragment("? desc nulls last", activity.id))
494 def fetch_latest_undo(%User{ap_id: ap_id}) do
496 |> Activity.Queries.by_type()
497 |> where(actor: ^ap_id)
498 |> order_by([activity], fragment("? desc nulls last", activity.id))
503 def get_latest_reaction(internal_activity_id, %{ap_id: ap_id}, emoji) do
504 %{data: %{"object" => object_ap_id}} = Activity.get_by_id(internal_activity_id)
507 |> Activity.Queries.by_type()
508 |> where(actor: ^ap_id)
509 |> where([activity], fragment("?->>'content' = ?", activity.data, ^emoji))
510 |> Activity.Queries.by_object_id(object_ap_id)
511 |> order_by([activity], fragment("? desc nulls last", activity.id))
516 #### Announce-related helpers
519 Returns an existing announce activity if the notice has already been announced
521 @spec get_existing_announce(String.t(), map()) :: Activity.t() | nil
522 def get_existing_announce(actor, %{data: %{"id" => ap_id}}) do
524 |> Activity.Queries.by_type()
525 |> where(actor: ^actor)
526 # this is to use the index
527 |> Activity.Queries.by_object_id(ap_id)
532 Make announce activity data for the given actor and object
534 # for relayed messages, we only want to send to subscribers
535 def make_announce_data(
536 %User{ap_id: ap_id} = user,
537 %Object{data: %{"id" => id}} = object,
542 "type" => "Announce",
545 "to" => [user.follower_address],
547 "context" => object.data["context"]
549 |> maybe_put("id", activity_id)
552 def make_announce_data(
553 %User{ap_id: ap_id} = user,
554 %Object{data: %{"id" => id}} = object,
559 "type" => "Announce",
562 "to" => [user.follower_address, object.data["actor"]],
563 "cc" => [Pleroma.Constants.as_public()],
564 "context" => object.data["context"]
566 |> maybe_put("id", activity_id)
570 %User{ap_id: actor, follower_address: follower_address},
572 data: %{"id" => undone_activity_id, "context" => context},
573 actor: undone_activity_actor
580 "object" => undone_activity_id,
581 "to" => [follower_address, undone_activity_actor],
582 "cc" => [Pleroma.Constants.as_public()],
585 |> maybe_put("id", activity_id)
588 @spec add_announce_to_object(Activity.t(), Object.t()) ::
589 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
590 def add_announce_to_object(
591 %Activity{data: %{"actor" => actor}},
594 unless actor |> User.get_cached_by_ap_id() |> User.invisible?() do
595 announcements = take_announcements(object)
597 with announcements <- Enum.uniq([actor | announcements]) do
598 update_element_in_object("announcement", announcements, object)
605 def add_announce_to_object(_, object), do: {:ok, object}
607 @spec remove_announce_from_object(Activity.t(), Object.t()) ::
608 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
609 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
610 with announcements <- List.delete(take_announcements(object), actor) do
611 update_element_in_object("announcement", announcements, object)
615 defp take_announcements(%{data: %{"announcements" => announcements}} = _)
616 when is_list(announcements),
619 defp take_announcements(_), do: []
621 #### Unfollow-related helpers
623 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
626 "actor" => follower.ap_id,
627 "to" => [followed.ap_id],
628 "object" => follow_activity.data
630 |> maybe_put("id", activity_id)
633 #### Block-related helpers
634 @spec fetch_latest_block(User.t(), User.t()) :: Activity.t() | nil
635 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
637 |> Activity.Queries.by_type()
638 |> where(actor: ^blocker_id)
639 # this is to use the index
640 |> Activity.Queries.by_object_id(blocked_id)
641 |> order_by([activity], fragment("? desc nulls last", activity.id))
646 def make_block_data(blocker, blocked, activity_id) do
649 "actor" => blocker.ap_id,
650 "to" => [blocked.ap_id],
651 "object" => blocked.ap_id
653 |> maybe_put("id", activity_id)
656 #### Create-related helpers
658 def make_create_data(params, additional) do
659 published = params.published || make_date()
663 "to" => params.to |> Enum.uniq(),
664 "actor" => params.actor.ap_id,
665 "object" => params.object,
666 "published" => published,
667 "context" => params.context
669 |> Map.merge(additional)
672 #### Listen-related helpers
673 def make_listen_data(params, additional) do
674 published = params.published || make_date()
678 "to" => params.to |> Enum.uniq(),
679 "actor" => params.actor.ap_id,
680 "object" => params.object,
681 "published" => published,
682 "context" => params.context
684 |> Map.merge(additional)
687 #### Flag-related helpers
688 @spec make_flag_data(map(), map()) :: map()
689 def make_flag_data(%{actor: actor, context: context, content: content} = params, additional) do
692 "actor" => actor.ap_id,
693 "content" => content,
694 "object" => build_flag_object(params),
695 "context" => context,
698 |> Map.merge(additional)
701 def make_flag_data(_, _), do: %{}
703 defp build_flag_object(%{account: account, statuses: statuses} = _) do
704 [account.ap_id] ++ build_flag_object(%{statuses: statuses})
707 defp build_flag_object(%{statuses: statuses}) do
708 Enum.map(statuses || [], &build_flag_object/1)
711 defp build_flag_object(act) when is_map(act) or is_binary(act) do
714 %Activity{} = act -> act.data["id"]
715 act when is_map(act) -> act["id"]
716 act when is_binary(act) -> act
719 case Activity.get_by_ap_id_with_object(id) do
720 %Activity{} = activity ->
723 "id" => activity.data["id"],
724 "content" => activity.object.data["content"],
725 "published" => activity.object.data["published"],
727 AccountView.render("show.json", %{
728 user: User.get_by_ap_id(activity.object.data["actor"])
733 %{"id" => id, "deleted" => true}
737 defp build_flag_object(_), do: []
739 #### Report-related helpers
740 def get_reports(params, page, page_size) do
743 |> Map.put("type", "Flag")
744 |> Map.put("skip_preload", true)
745 |> Map.put("preload_report_notes", true)
746 |> Map.put("total", true)
747 |> Map.put("limit", page_size)
748 |> Map.put("offset", (page - 1) * page_size)
750 ActivityPub.fetch_activities([], params, :offset)
753 def update_report_state(%Activity{} = activity, state)
754 when state in @strip_status_report_states do
755 {:ok, stripped_activity} = strip_report_status_data(activity)
759 |> Map.put("state", state)
760 |> Map.put("object", stripped_activity.data["object"])
763 |> Changeset.change(data: new_data)
767 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
768 new_data = Map.put(activity.data, "state", state)
771 |> Changeset.change(data: new_data)
775 def update_report_state(activity_ids, state) when state in @supported_report_states do
776 activities_num = length(activity_ids)
778 from(a in Activity, where: a.id in ^activity_ids)
779 |> update(set: [data: fragment("jsonb_set(data, '{state}', ?)", ^state)])
780 |> Repo.update_all([])
782 {^activities_num, _} -> :ok
783 _ -> {:error, activity_ids}
787 def update_report_state(_, _), do: {:error, "Unsupported state"}
789 def strip_report_status_data(activity) do
790 [actor | reported_activities] = activity.data["object"]
792 stripped_activities =
793 Enum.map(reported_activities, fn
794 act when is_map(act) -> act["id"]
795 act when is_binary(act) -> act
798 new_data = put_in(activity.data, ["object"], [actor | stripped_activities])
800 {:ok, %{activity | data: new_data}}
803 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
804 [to, cc, recipients] =
806 |> get_updated_targets(visibility)
807 |> Enum.map(&Enum.uniq/1)
816 |> Object.change(%{data: object_data})
817 |> Object.update_and_set_cache()
825 |> Map.put(:object, object)
826 |> Activity.change(%{data: activity_data, recipients: recipients})
830 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
832 defp get_updated_targets(
833 %Activity{data: %{"to" => to} = data, recipients: recipients},
836 cc = Map.get(data, "cc", [])
837 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
838 public = Pleroma.Constants.as_public()
842 to = [public | List.delete(to, follower_address)]
843 cc = [follower_address | List.delete(cc, public)]
844 recipients = [public | recipients]
848 to = [follower_address | List.delete(to, public)]
849 cc = List.delete(cc, public)
850 recipients = List.delete(recipients, public)
854 to = [follower_address | List.delete(to, public)]
855 cc = [public | List.delete(cc, follower_address)]
856 recipients = recipients ++ [follower_address, public]
864 def get_existing_votes(actor, %{data: %{"id" => id}}) do
866 |> Activity.Queries.by_actor()
867 |> Activity.Queries.by_type("Create")
868 |> Activity.with_preloaded_object()
869 |> where([a, object: o], fragment("(?)->>'inReplyTo' = ?", o.data, ^to_string(id)))
870 |> where([a, object: o], fragment("(?)->>'type' = 'Answer'", o.data))
874 def maybe_put(map, _key, nil), do: map
875 def maybe_put(map, key, value), do: Map.put(map, key, value)