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 @spec make_like_data(User.t(), map(), String.t()) :: map()
282 %User{ap_id: ap_id} = actor,
283 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
286 object_actor = User.get_cached_by_ap_id(object_actor_id)
289 if Visibility.is_public?(object) do
290 [actor.follower_address, object.data["actor"]]
292 [object.data["actor"]]
296 (object.data["to"] ++ (object.data["cc"] || []))
297 |> List.delete(actor.ap_id)
298 |> List.delete(object_actor.follower_address)
306 "context" => object.data["context"]
308 |> maybe_put("id", activity_id)
311 @spec update_element_in_object(String.t(), list(any), Object.t()) ::
312 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
313 def update_element_in_object(property, element, object) do
317 %{"#{property}_count" => length(element), "#{property}s" => element}
321 |> Changeset.change(data: data)
322 |> Object.update_and_set_cache()
325 @spec add_like_to_object(Activity.t(), Object.t()) ::
326 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
327 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
328 [actor | fetch_likes(object)]
330 |> update_likes_in_object(object)
333 @spec remove_like_from_object(Activity.t(), Object.t()) ::
334 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
335 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
338 |> List.delete(actor)
339 |> update_likes_in_object(object)
342 defp update_likes_in_object(likes, object) do
343 update_element_in_object("like", likes, object)
346 defp fetch_likes(object) do
347 if is_list(object.data["likes"]) do
354 #### Follow-related helpers
357 Updates a follow activity's state (for locked accounts).
359 def update_follow_state_for_all(
360 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
364 Ecto.Adapters.SQL.query!(
366 "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'",
367 [state, actor, object]
370 User.set_follow_state_cache(actor, object, state)
371 activity = Activity.get_by_id(activity.id)
379 def update_follow_state(
380 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
385 |> Map.put("state", state),
386 changeset <- Changeset.change(activity, data: new_data),
387 {:ok, activity} <- Repo.update(changeset),
388 _ <- User.set_follow_state_cache(actor, object, state) do
394 Makes a follow activity data for the given follower and followed
396 def make_follow_data(
397 %User{ap_id: follower_id},
398 %User{ap_id: followed_id} = _followed,
403 "actor" => follower_id,
404 "to" => [followed_id],
405 "cc" => [Pleroma.Constants.as_public()],
406 "object" => followed_id,
409 |> maybe_put("id", activity_id)
412 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
415 activity in Activity,
418 "? ->> 'type' = 'Follow'",
421 where: activity.actor == ^follower_id,
422 # this is to use the index
425 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
430 order_by: [fragment("? desc nulls last", activity.id)],
437 #### Announce-related helpers
440 Retruns an existing announce activity if the notice has already been announced
442 def get_existing_announce(actor, %{data: %{"id" => id}}) do
445 activity in Activity,
446 where: activity.actor == ^actor,
447 # this is to use the index
450 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
455 where: fragment("(?)->>'type' = 'Announce'", activity.data)
462 Make announce activity data for the given actor and object
464 # for relayed messages, we only want to send to subscribers
465 def make_announce_data(
466 %User{ap_id: ap_id} = user,
467 %Object{data: %{"id" => id}} = object,
472 "type" => "Announce",
475 "to" => [user.follower_address],
477 "context" => object.data["context"]
479 |> maybe_put("id", activity_id)
482 def make_announce_data(
483 %User{ap_id: ap_id} = user,
484 %Object{data: %{"id" => id}} = object,
489 "type" => "Announce",
492 "to" => [user.follower_address, object.data["actor"]],
493 "cc" => [Pleroma.Constants.as_public()],
494 "context" => object.data["context"]
496 |> maybe_put("id", activity_id)
500 Make unannounce activity data for the given actor and object
502 def make_unannounce_data(
503 %User{ap_id: ap_id} = user,
504 %Activity{data: %{"context" => context}} = activity,
510 "object" => activity.data,
511 "to" => [user.follower_address, activity.data["actor"]],
512 "cc" => [Pleroma.Constants.as_public()],
515 |> maybe_put("id", activity_id)
518 def make_unlike_data(
519 %User{ap_id: ap_id} = user,
520 %Activity{data: %{"context" => context}} = activity,
526 "object" => activity.data,
527 "to" => [user.follower_address, activity.data["actor"]],
528 "cc" => [Pleroma.Constants.as_public()],
531 |> maybe_put("id", activity_id)
534 def add_announce_to_object(
536 data: %{"actor" => actor, "cc" => [Pleroma.Constants.as_public()]}
541 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
543 with announcements <- [actor | announcements] |> Enum.uniq() do
544 update_element_in_object("announcement", announcements, object)
548 def add_announce_to_object(_, object), do: {:ok, object}
550 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
552 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
554 with announcements <- announcements |> List.delete(actor) do
555 update_element_in_object("announcement", announcements, object)
559 #### Unfollow-related helpers
561 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
564 "actor" => follower.ap_id,
565 "to" => [followed.ap_id],
566 "object" => follow_activity.data
568 |> maybe_put("id", activity_id)
571 #### Block-related helpers
572 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
575 activity in Activity,
578 "? ->> 'type' = 'Block'",
581 where: activity.actor == ^blocker_id,
582 # this is to use the index
585 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
590 order_by: [fragment("? desc nulls last", activity.id)],
597 def make_block_data(blocker, blocked, activity_id) do
600 "actor" => blocker.ap_id,
601 "to" => [blocked.ap_id],
602 "object" => blocked.ap_id
604 |> maybe_put("id", activity_id)
607 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
610 "actor" => blocker.ap_id,
611 "to" => [blocked.ap_id],
612 "object" => block_activity.data
614 |> maybe_put("id", activity_id)
617 #### Create-related helpers
619 def make_create_data(params, additional) do
620 published = params.published || make_date()
624 "to" => params.to |> Enum.uniq(),
625 "actor" => params.actor.ap_id,
626 "object" => params.object,
627 "published" => published,
628 "context" => params.context
630 |> Map.merge(additional)
633 #### Flag-related helpers
635 def make_flag_data(params, additional) do
637 Enum.map(params.statuses || [], fn
638 %Activity{} = act -> act.data["id"]
639 act when is_map(act) -> act["id"]
640 act when is_binary(act) -> act
643 object = [params.account.ap_id] ++ status_ap_ids
647 "actor" => params.actor.ap_id,
648 "content" => params.content,
650 "context" => params.context,
653 |> Map.merge(additional)
657 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
658 the first one to `pages_left` pages.
659 If the amount of pages is higher than the collection has, it returns whatever was there.
661 def fetch_ordered_collection(from, pages_left, acc \\ []) do
662 with {:ok, response} <- Tesla.get(from),
663 {:ok, collection} <- Jason.decode(response.body) do
664 case collection["type"] do
665 "OrderedCollection" ->
666 # If we've encountered the OrderedCollection and not the page,
667 # just call the same function on the page address
668 fetch_ordered_collection(collection["first"], pages_left)
670 "OrderedCollectionPage" ->
672 # There are still more pages
673 if Map.has_key?(collection, "next") do
674 # There are still more pages, go deeper saving what we have into the accumulator
675 fetch_ordered_collection(
678 acc ++ collection["orderedItems"]
681 # No more pages left, just return whatever we already have
682 acc ++ collection["orderedItems"]
685 # Got the amount of pages needed, add them all to the accumulator
686 acc ++ collection["orderedItems"]
690 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
695 #### Report-related helpers
697 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
698 with new_data <- Map.put(activity.data, "state", state),
699 changeset <- Changeset.change(activity, data: new_data),
700 {:ok, activity} <- Repo.update(changeset) do
705 def update_report_state(_, _), do: {:error, "Unsupported state"}
707 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
708 [to, cc, recipients] =
710 |> get_updated_targets(visibility)
711 |> Enum.map(&Enum.uniq/1)
720 |> Object.change(%{data: object_data})
721 |> Object.update_and_set_cache()
729 |> Map.put(:object, object)
730 |> Activity.change(%{data: activity_data, recipients: recipients})
734 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
736 defp get_updated_targets(
737 %Activity{data: %{"to" => to} = data, recipients: recipients},
740 cc = Map.get(data, "cc", [])
741 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
742 public = Pleroma.Constants.as_public()
746 to = [public | List.delete(to, follower_address)]
747 cc = [follower_address | List.delete(cc, public)]
748 recipients = [public | recipients]
752 to = [follower_address | List.delete(to, public)]
753 cc = List.delete(cc, public)
754 recipients = List.delete(recipients, public)
758 to = [follower_address | List.delete(to, public)]
759 cc = [public | List.delete(cc, follower_address)]
760 recipients = recipients ++ [follower_address, public]
768 def get_existing_votes(actor, %{data: %{"id" => id}}) do
771 [activity, object: object] in Activity.with_preloaded_object(Activity),
772 where: fragment("(?)->>'type' = 'Create'", activity.data),
773 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
776 "(?)->>'inReplyTo' = ?",
780 where: fragment("(?)->>'type' = 'Answer'", object.data)
786 defp maybe_put(map, _key, nil), do: map
787 defp maybe_put(map, key, value), do: Map.put(map, key, value)