1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 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.Visibility
15 alias Pleroma.Web.Endpoint
16 alias Pleroma.Web.Router.Helpers
21 require Pleroma.Constants
23 @supported_object_types ["Article", "Note", "Video", "Page", "Question", "Answer"]
24 @supported_report_states ~w(open closed resolved)
25 @valid_visibilities ~w(public unlisted private direct)
27 # Some implementations send the actor URI as the actor field, others send the entire actor object,
28 # so figure out what the actor's URI is based on what we have.
29 def get_ap_id(%{"id" => id} = _), do: id
30 def get_ap_id(id), do: id
32 def normalize_params(params) do
33 Map.put(params, "actor", get_ap_id(params["actor"]))
36 def determine_explicit_mentions(%{"tag" => tag} = _object) when is_list(tag) do
38 |> Enum.filter(fn x -> is_map(x) end)
39 |> Enum.filter(fn x -> x["type"] == "Mention" end)
40 |> Enum.map(fn x -> x["href"] end)
43 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
44 Map.put(object, "tag", [tag])
45 |> determine_explicit_mentions()
48 def determine_explicit_mentions(_), do: []
50 defp recipient_in_collection(ap_id, coll) when is_binary(coll), do: ap_id == coll
51 defp recipient_in_collection(ap_id, coll) when is_list(coll), do: ap_id in coll
52 defp recipient_in_collection(_, _), do: false
54 def recipient_in_message(%User{ap_id: ap_id} = recipient, %User{} = actor, params) do
56 recipient_in_collection(ap_id, params["to"]) ->
59 recipient_in_collection(ap_id, params["cc"]) ->
62 recipient_in_collection(ap_id, params["bto"]) ->
65 recipient_in_collection(ap_id, params["bcc"]) ->
68 # if the message is unaddressed at all, then assume it is directly addressed
70 !params["to"] && !params["cc"] && !params["bto"] && !params["bcc"] ->
73 # if the message is sent from somebody the user is following, then assume it
74 # is addressed to the recipient
75 User.following?(recipient, actor) ->
83 defp extract_list(target) when is_binary(target), do: [target]
84 defp extract_list(lst) when is_list(lst), do: lst
85 defp extract_list(_), do: []
87 def maybe_splice_recipient(ap_id, params) do
89 !recipient_in_collection(ap_id, params["to"]) &&
90 !recipient_in_collection(ap_id, params["cc"])
92 cc_list = extract_list(params["cc"])
96 |> Map.put("cc", [ap_id | cc_list])
102 def make_json_ld_header do
105 "https://www.w3.org/ns/activitystreams",
106 "#{Web.base_url()}/schemas/litepub-0.1.jsonld",
115 DateTime.utc_now() |> DateTime.to_iso8601()
118 def generate_activity_id do
119 generate_id("activities")
122 def generate_context_id do
123 generate_id("contexts")
126 def generate_object_id do
127 Helpers.o_status_url(Endpoint, :object, UUID.generate())
130 def generate_id(type) do
131 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
134 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
135 fake_create_activity = %{
136 "to" => object["to"],
137 "cc" => object["cc"],
142 Notification.get_notified_from_activity(%Activity{data: fake_create_activity}, false)
145 def get_notified_from_object(object) do
146 Notification.get_notified_from_activity(%Activity{data: object}, false)
149 def create_context(context) do
150 context = context || generate_id("contexts")
152 # Ecto has problems accessing the constraint inside the jsonb,
153 # so we explicitly check for the existed object before insert
154 object = Object.get_cached_by_ap_id(context)
156 with true <- is_nil(object),
157 changeset <- Object.context_mapping(context),
158 {:ok, inserted_object} <- Repo.insert(changeset) do
167 Enqueues an activity for federation if it's local
169 @spec maybe_federate(any()) :: :ok
170 def maybe_federate(%Activity{local: true} = activity) do
171 if Pleroma.Config.get!([:instance, :federating]) do
173 case activity.data["type"] do
179 Pleroma.Web.Federator.publish(activity, priority)
185 def maybe_federate(_), do: :ok
188 Adds an id and a published data if they aren't there,
189 also adds it to an included object
191 def lazy_put_activity_defaults(map, fake \\ false) do
194 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
197 |> Map.put_new_lazy("id", &generate_activity_id/0)
198 |> Map.put_new_lazy("published", &make_date/0)
199 |> Map.put_new("context", context)
200 |> Map.put_new("context_id", context_id)
203 |> Map.put_new("id", "pleroma:fakeid")
204 |> Map.put_new_lazy("published", &make_date/0)
205 |> Map.put_new("context", "pleroma:fakecontext")
206 |> Map.put_new("context_id", -1)
209 if is_map(map["object"]) do
210 object = lazy_put_object_defaults(map["object"], map, fake)
211 %{map | "object" => object}
218 Adds an id and published date if they aren't there.
220 def lazy_put_object_defaults(map, activity \\ %{}, fake)
222 def lazy_put_object_defaults(map, activity, true = _fake) do
224 |> Map.put_new_lazy("published", &make_date/0)
225 |> Map.put_new("id", "pleroma:fake_object_id")
226 |> Map.put_new("context", activity["context"])
227 |> Map.put_new("fake", true)
228 |> Map.put_new("context_id", activity["context_id"])
231 def lazy_put_object_defaults(map, activity, _fake) do
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"])
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
247 |> Map.put("object", object.data["id"])
253 def insert_full_object(map), do: {:ok, map, nil}
255 #### Like-related helpers
258 Returns an existing like if a user already liked an object
260 @spec get_existing_like(String.t(), map()) :: Activity.t() | nil
261 def get_existing_like(actor, %{data: %{"id" => id}}) do
263 |> Activity.Queries.by_actor()
264 |> Activity.Queries.by_object_id(id)
265 |> Activity.Queries.by_type("Like")
266 |> Activity.Queries.limit(1)
271 Returns like activities targeting an object
273 def get_object_likes(%{data: %{"id" => id}}) do
275 |> Activity.Queries.by_object_id()
276 |> Activity.Queries.by_type("Like")
280 def is_emoji?(emoji) do
281 String.length(emoji) == 1
284 def make_emoji_reaction_data(user, object, emoji, activity_id) do
285 make_like_data(user, object, activity_id)
286 |> Map.put("type", "EmojiReaction")
287 |> Map.put("content", emoji)
290 @spec make_like_data(User.t(), map(), String.t()) :: map()
292 %User{ap_id: ap_id} = actor,
293 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
296 object_actor = User.get_cached_by_ap_id(object_actor_id)
299 if Visibility.is_public?(object) do
300 [actor.follower_address, object.data["actor"]]
302 [object.data["actor"]]
306 (object.data["to"] ++ (object.data["cc"] || []))
307 |> List.delete(actor.ap_id)
308 |> List.delete(object_actor.follower_address)
316 "context" => object.data["context"]
318 |> maybe_put("id", activity_id)
321 @spec update_element_in_object(String.t(), list(any), Object.t()) ::
322 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
323 def update_element_in_object(property, element, object) do
327 %{"#{property}_count" => length(element), "#{property}s" => element}
331 |> Changeset.change(data: data)
332 |> Object.update_and_set_cache()
335 @spec add_like_to_object(Activity.t(), Object.t()) ::
336 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
337 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
338 [actor | fetch_likes(object)]
340 |> update_likes_in_object(object)
343 @spec remove_like_from_object(Activity.t(), Object.t()) ::
344 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
345 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
348 |> List.delete(actor)
349 |> update_likes_in_object(object)
352 defp update_likes_in_object(likes, object) do
353 update_element_in_object("like", likes, object)
356 defp fetch_likes(object) do
357 if is_list(object.data["likes"]) do
364 #### Follow-related helpers
367 Updates a follow activity's state (for locked accounts).
369 def update_follow_state_for_all(
370 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
374 Ecto.Adapters.SQL.query!(
376 "UPDATE activities SET data = jsonb_set(data, '{state}', $1) WHERE data->>'type' = 'Follow' AND data->>'actor' = $2 AND data->>'object' = $3 AND data->>'state' = 'pending'",
377 [state, actor, object]
380 User.set_follow_state_cache(actor, object, state)
381 activity = Activity.get_by_id(activity.id)
389 def update_follow_state(
390 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
395 |> Map.put("state", state),
396 changeset <- Changeset.change(activity, data: new_data),
397 {:ok, activity} <- Repo.update(changeset),
398 _ <- User.set_follow_state_cache(actor, object, state) do
404 Makes a follow activity data for the given follower and followed
406 def make_follow_data(
407 %User{ap_id: follower_id},
408 %User{ap_id: followed_id} = _followed,
413 "actor" => follower_id,
414 "to" => [followed_id],
415 "cc" => [Pleroma.Constants.as_public()],
416 "object" => followed_id,
419 |> maybe_put("id", activity_id)
422 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
425 activity in Activity,
428 "? ->> 'type' = 'Follow'",
431 where: activity.actor == ^follower_id,
432 # this is to use the index
435 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
440 order_by: [fragment("? desc nulls last", activity.id)],
447 #### Announce-related helpers
450 Retruns an existing announce activity if the notice has already been announced
452 def get_existing_announce(actor, %{data: %{"id" => id}}) do
455 activity in Activity,
456 where: activity.actor == ^actor,
457 # this is to use the index
460 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
465 where: fragment("(?)->>'type' = 'Announce'", activity.data)
472 Make announce activity data for the given actor and object
474 # for relayed messages, we only want to send to subscribers
475 def make_announce_data(
476 %User{ap_id: ap_id} = user,
477 %Object{data: %{"id" => id}} = object,
482 "type" => "Announce",
485 "to" => [user.follower_address],
487 "context" => object.data["context"]
489 |> maybe_put("id", activity_id)
492 def make_announce_data(
493 %User{ap_id: ap_id} = user,
494 %Object{data: %{"id" => id}} = object,
499 "type" => "Announce",
502 "to" => [user.follower_address, object.data["actor"]],
503 "cc" => [Pleroma.Constants.as_public()],
504 "context" => object.data["context"]
506 |> maybe_put("id", activity_id)
510 Make unannounce activity data for the given actor and object
512 def make_unannounce_data(
513 %User{ap_id: ap_id} = user,
514 %Activity{data: %{"context" => context}} = activity,
520 "object" => activity.data,
521 "to" => [user.follower_address, activity.data["actor"]],
522 "cc" => [Pleroma.Constants.as_public()],
525 |> maybe_put("id", activity_id)
528 def make_unlike_data(
529 %User{ap_id: ap_id} = user,
530 %Activity{data: %{"context" => context}} = activity,
536 "object" => activity.data,
537 "to" => [user.follower_address, activity.data["actor"]],
538 "cc" => [Pleroma.Constants.as_public()],
541 |> maybe_put("id", activity_id)
544 def add_announce_to_object(
546 data: %{"actor" => actor, "cc" => [Pleroma.Constants.as_public()]}
551 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
553 with announcements <- [actor | announcements] |> Enum.uniq() do
554 update_element_in_object("announcement", announcements, object)
558 def add_announce_to_object(_, object), do: {:ok, object}
560 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
562 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
564 with announcements <- announcements |> List.delete(actor) do
565 update_element_in_object("announcement", announcements, object)
569 #### Unfollow-related helpers
571 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
574 "actor" => follower.ap_id,
575 "to" => [followed.ap_id],
576 "object" => follow_activity.data
578 |> maybe_put("id", activity_id)
581 #### Block-related helpers
582 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
585 activity in Activity,
588 "? ->> 'type' = 'Block'",
591 where: activity.actor == ^blocker_id,
592 # this is to use the index
595 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
600 order_by: [fragment("? desc nulls last", activity.id)],
607 def make_block_data(blocker, blocked, activity_id) do
610 "actor" => blocker.ap_id,
611 "to" => [blocked.ap_id],
612 "object" => blocked.ap_id
614 |> maybe_put("id", activity_id)
617 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
620 "actor" => blocker.ap_id,
621 "to" => [blocked.ap_id],
622 "object" => block_activity.data
624 |> maybe_put("id", activity_id)
627 #### Create-related helpers
629 def make_create_data(params, additional) do
630 published = params.published || make_date()
634 "to" => params.to |> Enum.uniq(),
635 "actor" => params.actor.ap_id,
636 "object" => params.object,
637 "published" => published,
638 "context" => params.context
640 |> Map.merge(additional)
643 #### Flag-related helpers
645 def make_flag_data(params, additional) do
647 Enum.map(params.statuses || [], fn
648 %Activity{} = act -> act.data["id"]
649 act when is_map(act) -> act["id"]
650 act when is_binary(act) -> act
653 object = [params.account.ap_id] ++ status_ap_ids
657 "actor" => params.actor.ap_id,
658 "content" => params.content,
660 "context" => params.context,
663 |> Map.merge(additional)
667 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
668 the first one to `pages_left` pages.
669 If the amount of pages is higher than the collection has, it returns whatever was there.
671 def fetch_ordered_collection(from, pages_left, acc \\ []) do
672 with {:ok, response} <- Tesla.get(from),
673 {:ok, collection} <- Jason.decode(response.body) do
674 case collection["type"] do
675 "OrderedCollection" ->
676 # If we've encountered the OrderedCollection and not the page,
677 # just call the same function on the page address
678 fetch_ordered_collection(collection["first"], pages_left)
680 "OrderedCollectionPage" ->
682 # There are still more pages
683 if Map.has_key?(collection, "next") do
684 # There are still more pages, go deeper saving what we have into the accumulator
685 fetch_ordered_collection(
688 acc ++ collection["orderedItems"]
691 # No more pages left, just return whatever we already have
692 acc ++ collection["orderedItems"]
695 # Got the amount of pages needed, add them all to the accumulator
696 acc ++ collection["orderedItems"]
700 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
705 #### Report-related helpers
707 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
708 with new_data <- Map.put(activity.data, "state", state),
709 changeset <- Changeset.change(activity, data: new_data),
710 {:ok, activity} <- Repo.update(changeset) do
715 def update_report_state(_, _), do: {:error, "Unsupported state"}
717 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
718 [to, cc, recipients] =
720 |> get_updated_targets(visibility)
721 |> Enum.map(&Enum.uniq/1)
730 |> Object.change(%{data: object_data})
731 |> Object.update_and_set_cache()
739 |> Map.put(:object, object)
740 |> Activity.change(%{data: activity_data, recipients: recipients})
744 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
746 defp get_updated_targets(
747 %Activity{data: %{"to" => to} = data, recipients: recipients},
750 cc = Map.get(data, "cc", [])
751 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
752 public = Pleroma.Constants.as_public()
756 to = [public | List.delete(to, follower_address)]
757 cc = [follower_address | List.delete(cc, public)]
758 recipients = [public | recipients]
762 to = [follower_address | List.delete(to, public)]
763 cc = List.delete(cc, public)
764 recipients = List.delete(recipients, public)
768 to = [follower_address | List.delete(to, public)]
769 cc = [public | List.delete(cc, follower_address)]
770 recipients = recipients ++ [follower_address, public]
778 def get_existing_votes(actor, %{data: %{"id" => id}}) do
781 [activity, object: object] in Activity.with_preloaded_object(Activity),
782 where: fragment("(?)->>'type' = 'Create'", activity.data),
783 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
786 "(?)->>'inReplyTo' = ?",
790 where: fragment("(?)->>'type' = 'Answer'", object.data)
796 defp maybe_put(map, _key, nil), do: map
797 defp maybe_put(map, key, value), do: Map.put(map, key, value)