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 def maybe_federate(%Activity{local: true} = activity) do
170 if Pleroma.Config.get!([:instance, :federating]) do
172 case activity.data["type"] do
178 Pleroma.Web.Federator.publish(activity, priority)
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 def lazy_put_activity_defaults(map, fake \\ false) do
193 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
196 |> Map.put_new_lazy("id", &generate_activity_id/0)
197 |> Map.put_new_lazy("published", &make_date/0)
198 |> Map.put_new("context", context)
199 |> Map.put_new("context_id", context_id)
202 |> Map.put_new("id", "pleroma:fakeid")
203 |> Map.put_new_lazy("published", &make_date/0)
204 |> Map.put_new("context", "pleroma:fakecontext")
205 |> Map.put_new("context_id", -1)
208 if is_map(map["object"]) do
209 object = lazy_put_object_defaults(map["object"], map, fake)
210 %{map | "object" => object}
217 Adds an id and published date if they aren't there.
219 def lazy_put_object_defaults(map, activity \\ %{}, fake)
221 def lazy_put_object_defaults(map, activity, true = _fake) do
223 |> Map.put_new_lazy("published", &make_date/0)
224 |> Map.put_new("id", "pleroma:fake_object_id")
225 |> Map.put_new("context", activity["context"])
226 |> Map.put_new("fake", true)
227 |> Map.put_new("context_id", activity["context_id"])
230 def lazy_put_object_defaults(map, activity, _fake) do
232 |> Map.put_new_lazy("id", &generate_object_id/0)
233 |> Map.put_new_lazy("published", &make_date/0)
234 |> Map.put_new("context", activity["context"])
235 |> Map.put_new("context_id", activity["context_id"])
239 Inserts a full object if it is contained in an activity.
241 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
242 when is_map(object_data) and type in @supported_object_types do
243 with {:ok, object} <- Object.create(object_data) do
246 |> Map.put("object", object.data["id"])
252 def insert_full_object(map), do: {:ok, map, nil}
254 #### Like-related helpers
257 Returns an existing like if a user already liked an object
259 def get_existing_like(actor, %{data: %{"id" => id}}) do
262 activity in Activity,
263 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
264 # this is to use the index
267 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
272 where: fragment("(?)->>'type' = 'Like'", activity.data)
279 Returns like activities targeting an object
281 def get_object_likes(%{data: %{"id" => id}}) do
284 activity in Activity,
285 # this is to use the index
288 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
293 where: fragment("(?)->>'type' = 'Like'", activity.data)
300 %User{ap_id: ap_id} = actor,
301 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
304 object_actor = User.get_cached_by_ap_id(object_actor_id)
307 if Visibility.is_public?(object) do
308 [actor.follower_address, object.data["actor"]]
310 [object.data["actor"]]
314 (object.data["to"] ++ (object.data["cc"] || []))
315 |> List.delete(actor.ap_id)
316 |> List.delete(object_actor.follower_address)
324 "context" => object.data["context"]
327 if activity_id, do: Map.put(data, "id", activity_id), else: data
330 def update_element_in_object(property, element, object) do
333 |> Map.put("#{property}_count", length(element))
334 |> Map.put("#{property}s", element),
335 changeset <- Changeset.change(object, data: new_data),
336 {:ok, object} <- Object.update_and_set_cache(changeset) do
341 def update_likes_in_object(likes, object) do
342 update_element_in_object("like", likes, object)
345 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
346 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
348 with likes <- [actor | likes] |> Enum.uniq() do
349 update_likes_in_object(likes, object)
353 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
354 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
356 with likes <- likes |> List.delete(actor) do
357 update_likes_in_object(likes, object)
361 #### Follow-related helpers
364 Updates a follow activity's state (for locked accounts).
366 def update_follow_state_for_all(
367 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
371 Ecto.Adapters.SQL.query!(
373 "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'",
374 [state, actor, object]
377 User.set_follow_state_cache(actor, object, state)
378 activity = Activity.get_by_id(activity.id)
386 def update_follow_state(
387 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
392 |> Map.put("state", state),
393 changeset <- Changeset.change(activity, data: new_data),
394 {:ok, activity} <- Repo.update(changeset),
395 _ <- User.set_follow_state_cache(actor, object, state) do
401 Makes a follow activity data for the given follower and followed
403 def make_follow_data(
404 %User{ap_id: follower_id},
405 %User{ap_id: followed_id} = _followed,
410 "actor" => follower_id,
411 "to" => [followed_id],
412 "cc" => [Pleroma.Constants.as_public()],
413 "object" => followed_id,
417 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
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"]
490 if activity_id, do: Map.put(data, "id", activity_id), else: data
493 def make_announce_data(
494 %User{ap_id: ap_id} = user,
495 %Object{data: %{"id" => id}} = object,
500 "type" => "Announce",
503 "to" => [user.follower_address, object.data["actor"]],
504 "cc" => [Pleroma.Constants.as_public()],
505 "context" => object.data["context"]
508 if activity_id, do: Map.put(data, "id", activity_id), else: data
512 Make unannounce activity data for the given actor and object
514 def make_unannounce_data(
515 %User{ap_id: ap_id} = user,
516 %Activity{data: %{"context" => context}} = activity,
522 "object" => activity.data,
523 "to" => [user.follower_address, activity.data["actor"]],
524 "cc" => [Pleroma.Constants.as_public()],
528 if activity_id, do: Map.put(data, "id", activity_id), else: data
531 def make_unlike_data(
532 %User{ap_id: ap_id} = user,
533 %Activity{data: %{"context" => context}} = activity,
539 "object" => activity.data,
540 "to" => [user.follower_address, activity.data["actor"]],
541 "cc" => [Pleroma.Constants.as_public()],
545 if activity_id, do: Map.put(data, "id", activity_id), else: data
548 def add_announce_to_object(
550 data: %{"actor" => actor, "cc" => [Pleroma.Constants.as_public()]}
555 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
557 with announcements <- [actor | announcements] |> Enum.uniq() do
558 update_element_in_object("announcement", announcements, object)
562 def add_announce_to_object(_, object), do: {:ok, object}
564 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
566 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
568 with announcements <- announcements |> List.delete(actor) do
569 update_element_in_object("announcement", announcements, object)
573 #### Unfollow-related helpers
575 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
578 "actor" => follower.ap_id,
579 "to" => [followed.ap_id],
580 "object" => follow_activity.data
583 if activity_id, do: Map.put(data, "id", activity_id), else: data
586 #### Block-related helpers
587 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
590 activity in Activity,
593 "? ->> 'type' = 'Block'",
596 where: activity.actor == ^blocker_id,
597 # this is to use the index
600 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
605 order_by: [fragment("? desc nulls last", activity.id)],
612 def make_block_data(blocker, blocked, activity_id) do
615 "actor" => blocker.ap_id,
616 "to" => [blocked.ap_id],
617 "object" => blocked.ap_id
620 if activity_id, do: Map.put(data, "id", activity_id), else: data
623 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
626 "actor" => blocker.ap_id,
627 "to" => [blocked.ap_id],
628 "object" => block_activity.data
631 if activity_id, do: Map.put(data, "id", activity_id), else: data
634 #### Create-related helpers
636 def make_create_data(params, additional) do
637 published = params.published || make_date()
641 "to" => params.to |> Enum.uniq(),
642 "actor" => params.actor.ap_id,
643 "object" => params.object,
644 "published" => published,
645 "context" => params.context
647 |> Map.merge(additional)
650 #### Flag-related helpers
652 def make_flag_data(params, additional) do
654 Enum.map(params.statuses || [], fn
655 %Activity{} = act -> act.data["id"]
656 act when is_map(act) -> act["id"]
657 act when is_binary(act) -> act
660 object = [params.account.ap_id] ++ status_ap_ids
664 "actor" => params.actor.ap_id,
665 "content" => params.content,
667 "context" => params.context,
670 |> Map.merge(additional)
674 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
675 the first one to `pages_left` pages.
676 If the amount of pages is higher than the collection has, it returns whatever was there.
678 def fetch_ordered_collection(from, pages_left, acc \\ []) do
679 with {:ok, response} <- Tesla.get(from),
680 {:ok, collection} <- Jason.decode(response.body) do
681 case collection["type"] do
682 "OrderedCollection" ->
683 # If we've encountered the OrderedCollection and not the page,
684 # just call the same function on the page address
685 fetch_ordered_collection(collection["first"], pages_left)
687 "OrderedCollectionPage" ->
689 # There are still more pages
690 if Map.has_key?(collection, "next") do
691 # There are still more pages, go deeper saving what we have into the accumulator
692 fetch_ordered_collection(
695 acc ++ collection["orderedItems"]
698 # No more pages left, just return whatever we already have
699 acc ++ collection["orderedItems"]
702 # Got the amount of pages needed, add them all to the accumulator
703 acc ++ collection["orderedItems"]
707 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
712 #### Report-related helpers
714 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
715 with new_data <- Map.put(activity.data, "state", state),
716 changeset <- Changeset.change(activity, data: new_data),
717 {:ok, activity} <- Repo.update(changeset) do
722 def update_report_state(_, _), do: {:error, "Unsupported state"}
724 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
725 [to, cc, recipients] =
727 |> get_updated_targets(visibility)
728 |> Enum.map(&Enum.uniq/1)
737 |> Object.change(%{data: object_data})
738 |> Object.update_and_set_cache()
746 |> Map.put(:object, object)
747 |> Activity.change(%{data: activity_data, recipients: recipients})
751 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
753 defp get_updated_targets(
754 %Activity{data: %{"to" => to} = data, recipients: recipients},
757 cc = Map.get(data, "cc", [])
758 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
759 public = Pleroma.Constants.as_public()
763 to = [public | List.delete(to, follower_address)]
764 cc = [follower_address | List.delete(cc, public)]
765 recipients = [public | recipients]
769 to = [follower_address | List.delete(to, public)]
770 cc = List.delete(cc, public)
771 recipients = List.delete(recipients, public)
775 to = [follower_address | List.delete(to, public)]
776 cc = [public | List.delete(cc, follower_address)]
777 recipients = recipients ++ [follower_address, public]
785 def get_existing_votes(actor, %{data: %{"id" => id}}) do
788 [activity, object: object] in Activity.with_preloaded_object(Activity),
789 where: fragment("(?)->>'type' = 'Create'", activity.data),
790 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
793 "(?)->>'inReplyTo' = ?",
797 where: fragment("(?)->>'type' = 'Answer'", object.data)