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
172 Pleroma.Web.Federator.publish(activity)
178 def maybe_federate(_), do: :ok
181 Adds an id and a published data if they aren't there,
182 also adds it to an included object
184 def lazy_put_activity_defaults(map, fake \\ false) do
187 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
190 |> Map.put_new_lazy("id", &generate_activity_id/0)
191 |> Map.put_new_lazy("published", &make_date/0)
192 |> Map.put_new("context", context)
193 |> Map.put_new("context_id", context_id)
196 |> Map.put_new("id", "pleroma:fakeid")
197 |> Map.put_new_lazy("published", &make_date/0)
198 |> Map.put_new("context", "pleroma:fakecontext")
199 |> Map.put_new("context_id", -1)
202 if is_map(map["object"]) do
203 object = lazy_put_object_defaults(map["object"], map, fake)
204 %{map | "object" => object}
211 Adds an id and published date if they aren't there.
213 def lazy_put_object_defaults(map, activity \\ %{}, fake)
215 def lazy_put_object_defaults(map, activity, true = _fake) do
217 |> Map.put_new_lazy("published", &make_date/0)
218 |> Map.put_new("id", "pleroma:fake_object_id")
219 |> Map.put_new("context", activity["context"])
220 |> Map.put_new("fake", true)
221 |> Map.put_new("context_id", activity["context_id"])
224 def lazy_put_object_defaults(map, activity, _fake) do
226 |> Map.put_new_lazy("id", &generate_object_id/0)
227 |> Map.put_new_lazy("published", &make_date/0)
228 |> Map.put_new("context", activity["context"])
229 |> Map.put_new("context_id", activity["context_id"])
233 Inserts a full object if it is contained in an activity.
235 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
236 when is_map(object_data) and type in @supported_object_types do
237 with {:ok, object} <- Object.create(object_data) do
240 |> Map.put("object", object.data["id"])
246 def insert_full_object(map), do: {:ok, map, nil}
248 #### Like-related helpers
251 Returns an existing like if a user already liked an object
253 @spec get_existing_like(String.t(), map()) :: Activity.t() | nil
254 def get_existing_like(actor, %{data: %{"id" => id}}) do
256 |> Activity.Queries.by_actor()
257 |> Activity.Queries.by_object_id(id)
258 |> Activity.Queries.by_type("Like")
259 |> Activity.Queries.limit(1)
264 Returns like activities targeting an object
266 def get_object_likes(%{data: %{"id" => id}}) do
268 |> Activity.Queries.by_object_id()
269 |> Activity.Queries.by_type("Like")
273 @spec make_like_data(User.t(), map(), String.t()) :: map()
275 %User{ap_id: ap_id} = actor,
276 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
279 object_actor = User.get_cached_by_ap_id(object_actor_id)
282 if Visibility.is_public?(object) do
283 [actor.follower_address, object.data["actor"]]
285 [object.data["actor"]]
289 (object.data["to"] ++ (object.data["cc"] || []))
290 |> List.delete(actor.ap_id)
291 |> List.delete(object_actor.follower_address)
299 "context" => object.data["context"]
301 |> maybe_put("id", activity_id)
304 @spec update_element_in_object(String.t(), list(any), Object.t()) ::
305 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
306 def update_element_in_object(property, element, object) do
310 %{"#{property}_count" => length(element), "#{property}s" => element}
314 |> Changeset.change(data: data)
315 |> Object.update_and_set_cache()
318 @spec add_like_to_object(Activity.t(), Object.t()) ::
319 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
320 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
321 [actor | fetch_likes(object)]
323 |> update_likes_in_object(object)
326 @spec remove_like_from_object(Activity.t(), Object.t()) ::
327 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
328 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
331 |> List.delete(actor)
332 |> update_likes_in_object(object)
335 defp update_likes_in_object(likes, object) do
336 update_element_in_object("like", likes, object)
339 defp fetch_likes(object) do
340 if is_list(object.data["likes"]) do
347 #### Follow-related helpers
350 Updates a follow activity's state (for locked accounts).
352 def update_follow_state_for_all(
353 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
357 Ecto.Adapters.SQL.query!(
359 "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'",
360 [state, actor, object]
363 User.set_follow_state_cache(actor, object, state)
364 activity = Activity.get_by_id(activity.id)
372 def update_follow_state(
373 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
378 |> Map.put("state", state),
379 changeset <- Changeset.change(activity, data: new_data),
380 {:ok, activity} <- Repo.update(changeset),
381 _ <- User.set_follow_state_cache(actor, object, state) do
387 Makes a follow activity data for the given follower and followed
389 def make_follow_data(
390 %User{ap_id: follower_id},
391 %User{ap_id: followed_id} = _followed,
396 "actor" => follower_id,
397 "to" => [followed_id],
398 "cc" => [Pleroma.Constants.as_public()],
399 "object" => followed_id,
402 |> maybe_put("id", activity_id)
405 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
408 activity in Activity,
411 "? ->> 'type' = 'Follow'",
414 where: activity.actor == ^follower_id,
415 # this is to use the index
418 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
423 order_by: [fragment("? desc nulls last", activity.id)],
430 #### Announce-related helpers
433 Retruns an existing announce activity if the notice has already been announced
435 def get_existing_announce(actor, %{data: %{"id" => id}}) do
438 activity in Activity,
439 where: activity.actor == ^actor,
440 # this is to use the index
443 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
448 where: fragment("(?)->>'type' = 'Announce'", activity.data)
455 Make announce activity data for the given actor and object
457 # for relayed messages, we only want to send to subscribers
458 def make_announce_data(
459 %User{ap_id: ap_id} = user,
460 %Object{data: %{"id" => id}} = object,
465 "type" => "Announce",
468 "to" => [user.follower_address],
470 "context" => object.data["context"]
472 |> maybe_put("id", activity_id)
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, object.data["actor"]],
486 "cc" => [Pleroma.Constants.as_public()],
487 "context" => object.data["context"]
489 |> maybe_put("id", activity_id)
493 Make unannounce activity data for the given actor and object
495 def make_unannounce_data(
496 %User{ap_id: ap_id} = user,
497 %Activity{data: %{"context" => context}} = activity,
503 "object" => activity.data,
504 "to" => [user.follower_address, activity.data["actor"]],
505 "cc" => [Pleroma.Constants.as_public()],
508 |> maybe_put("id", activity_id)
511 def make_unlike_data(
512 %User{ap_id: ap_id} = user,
513 %Activity{data: %{"context" => context}} = activity,
519 "object" => activity.data,
520 "to" => [user.follower_address, activity.data["actor"]],
521 "cc" => [Pleroma.Constants.as_public()],
524 |> maybe_put("id", activity_id)
527 def add_announce_to_object(
529 data: %{"actor" => actor, "cc" => [Pleroma.Constants.as_public()]}
534 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
536 with announcements <- [actor | announcements] |> Enum.uniq() do
537 update_element_in_object("announcement", announcements, object)
541 def add_announce_to_object(_, object), do: {:ok, object}
543 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
545 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
547 with announcements <- announcements |> List.delete(actor) do
548 update_element_in_object("announcement", announcements, object)
552 #### Unfollow-related helpers
554 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
557 "actor" => follower.ap_id,
558 "to" => [followed.ap_id],
559 "object" => follow_activity.data
561 |> maybe_put("id", activity_id)
564 #### Block-related helpers
565 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
568 activity in Activity,
571 "? ->> 'type' = 'Block'",
574 where: activity.actor == ^blocker_id,
575 # this is to use the index
578 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
583 order_by: [fragment("? desc nulls last", activity.id)],
590 def make_block_data(blocker, blocked, activity_id) do
593 "actor" => blocker.ap_id,
594 "to" => [blocked.ap_id],
595 "object" => blocked.ap_id
597 |> maybe_put("id", activity_id)
600 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
603 "actor" => blocker.ap_id,
604 "to" => [blocked.ap_id],
605 "object" => block_activity.data
607 |> maybe_put("id", activity_id)
610 #### Create-related helpers
612 def make_create_data(params, additional) do
613 published = params.published || make_date()
617 "to" => params.to |> Enum.uniq(),
618 "actor" => params.actor.ap_id,
619 "object" => params.object,
620 "published" => published,
621 "context" => params.context
623 |> Map.merge(additional)
626 #### Flag-related helpers
628 def make_flag_data(params, additional) do
630 Enum.map(params.statuses || [], fn
631 %Activity{} = act -> act.data["id"]
632 act when is_map(act) -> act["id"]
633 act when is_binary(act) -> act
636 object = [params.account.ap_id] ++ status_ap_ids
640 "actor" => params.actor.ap_id,
641 "content" => params.content,
643 "context" => params.context,
646 |> Map.merge(additional)
650 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
651 the first one to `pages_left` pages.
652 If the amount of pages is higher than the collection has, it returns whatever was there.
654 def fetch_ordered_collection(from, pages_left, acc \\ []) do
655 with {:ok, response} <- Tesla.get(from),
656 {:ok, collection} <- Jason.decode(response.body) do
657 case collection["type"] do
658 "OrderedCollection" ->
659 # If we've encountered the OrderedCollection and not the page,
660 # just call the same function on the page address
661 fetch_ordered_collection(collection["first"], pages_left)
663 "OrderedCollectionPage" ->
665 # There are still more pages
666 if Map.has_key?(collection, "next") do
667 # There are still more pages, go deeper saving what we have into the accumulator
668 fetch_ordered_collection(
671 acc ++ collection["orderedItems"]
674 # No more pages left, just return whatever we already have
675 acc ++ collection["orderedItems"]
678 # Got the amount of pages needed, add them all to the accumulator
679 acc ++ collection["orderedItems"]
683 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
688 #### Report-related helpers
690 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
691 with new_data <- Map.put(activity.data, "state", state),
692 changeset <- Changeset.change(activity, data: new_data),
693 {:ok, activity} <- Repo.update(changeset) do
698 def update_report_state(_, _), do: {:error, "Unsupported state"}
700 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
701 [to, cc, recipients] =
703 |> get_updated_targets(visibility)
704 |> Enum.map(&Enum.uniq/1)
713 |> Object.change(%{data: object_data})
714 |> Object.update_and_set_cache()
722 |> Map.put(:object, object)
723 |> Activity.change(%{data: activity_data, recipients: recipients})
727 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
729 defp get_updated_targets(
730 %Activity{data: %{"to" => to} = data, recipients: recipients},
733 cc = Map.get(data, "cc", [])
734 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
735 public = Pleroma.Constants.as_public()
739 to = [public | List.delete(to, follower_address)]
740 cc = [follower_address | List.delete(cc, public)]
741 recipients = [public | recipients]
745 to = [follower_address | List.delete(to, public)]
746 cc = List.delete(cc, public)
747 recipients = List.delete(recipients, public)
751 to = [follower_address | List.delete(to, public)]
752 cc = [public | List.delete(cc, follower_address)]
753 recipients = recipients ++ [follower_address, public]
761 def get_existing_votes(actor, %{data: %{"id" => id}}) do
764 [activity, object: object] in Activity.with_preloaded_object(Activity),
765 where: fragment("(?)->>'type' = 'Create'", activity.data),
766 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
769 "(?)->>'inReplyTo' = ?",
773 where: fragment("(?)->>'type' = 'Answer'", object.data)
779 defp maybe_put(map, _key, nil), do: map
780 defp maybe_put(map, key, value), do: Map.put(map, key, value)