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
22 @supported_object_types ["Article", "Note", "Video", "Page", "Question", "Answer"]
23 @supported_report_states ~w(open closed resolved)
24 @valid_visibilities ~w(public unlisted private direct)
26 # Some implementations send the actor URI as the actor field, others send the entire actor object,
27 # so figure out what the actor's URI is based on what we have.
28 def get_ap_id(object) do
35 def normalize_params(params) do
36 Map.put(params, "actor", get_ap_id(params["actor"]))
39 def determine_explicit_mentions(%{"tag" => tag} = _object) when is_list(tag) do
41 |> Enum.filter(fn x -> is_map(x) end)
42 |> Enum.filter(fn x -> x["type"] == "Mention" end)
43 |> Enum.map(fn x -> x["href"] end)
46 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
47 Map.put(object, "tag", [tag])
48 |> determine_explicit_mentions()
51 def determine_explicit_mentions(_), do: []
53 defp recipient_in_collection(ap_id, coll) when is_binary(coll), do: ap_id == coll
54 defp recipient_in_collection(ap_id, coll) when is_list(coll), do: ap_id in coll
55 defp recipient_in_collection(_, _), do: false
57 def recipient_in_message(%User{ap_id: ap_id} = recipient, %User{} = actor, params) do
59 recipient_in_collection(ap_id, params["to"]) ->
62 recipient_in_collection(ap_id, params["cc"]) ->
65 recipient_in_collection(ap_id, params["bto"]) ->
68 recipient_in_collection(ap_id, params["bcc"]) ->
71 # if the message is unaddressed at all, then assume it is directly addressed
73 !params["to"] && !params["cc"] && !params["bto"] && !params["bcc"] ->
76 # if the message is sent from somebody the user is following, then assume it
77 # is addressed to the recipient
78 User.following?(recipient, actor) ->
86 defp extract_list(target) when is_binary(target), do: [target]
87 defp extract_list(lst) when is_list(lst), do: lst
88 defp extract_list(_), do: []
90 def maybe_splice_recipient(ap_id, params) do
92 !recipient_in_collection(ap_id, params["to"]) &&
93 !recipient_in_collection(ap_id, params["cc"])
95 cc_list = extract_list(params["cc"])
99 |> Map.put("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 Notification.get_notified_from_activity(%Activity{data: fake_create_activity}, false)
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 def maybe_federate(%Activity{local: true} = activity) do
173 if Pleroma.Config.get!([:instance, :federating]) do
175 case activity.data["type"] do
181 Pleroma.Web.Federator.publish(activity, priority)
187 def maybe_federate(_), do: :ok
190 Adds an id and a published data if they aren't there,
191 also adds it to an included object
193 def lazy_put_activity_defaults(map, fake \\ false) do
196 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
199 |> Map.put_new_lazy("id", &generate_activity_id/0)
200 |> Map.put_new_lazy("published", &make_date/0)
201 |> Map.put_new("context", context)
202 |> Map.put_new("context_id", context_id)
205 |> Map.put_new("id", "pleroma:fakeid")
206 |> Map.put_new_lazy("published", &make_date/0)
207 |> Map.put_new("context", "pleroma:fakecontext")
208 |> Map.put_new("context_id", -1)
211 if is_map(map["object"]) do
212 object = lazy_put_object_defaults(map["object"], map, fake)
213 %{map | "object" => object}
220 Adds an id and published date if they aren't there.
222 def lazy_put_object_defaults(map, activity \\ %{}, fake)
224 def lazy_put_object_defaults(map, activity, true = _fake) do
226 |> Map.put_new_lazy("published", &make_date/0)
227 |> Map.put_new("id", "pleroma:fake_object_id")
228 |> Map.put_new("context", activity["context"])
229 |> Map.put_new("fake", true)
230 |> Map.put_new("context_id", activity["context_id"])
233 def lazy_put_object_defaults(map, activity, _fake) do
235 |> Map.put_new_lazy("id", &generate_object_id/0)
236 |> Map.put_new_lazy("published", &make_date/0)
237 |> Map.put_new("context", activity["context"])
238 |> Map.put_new("context_id", activity["context_id"])
242 Inserts a full object if it is contained in an activity.
244 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
245 when is_map(object_data) and type in @supported_object_types do
246 with {:ok, object} <- Object.create(object_data) do
249 |> Map.put("object", object.data["id"])
255 def insert_full_object(map), do: {:ok, map, nil}
257 def update_object_in_activities(%{data: %{"id" => id}} = object) do
259 # Update activities that already had this. Could be done in a seperate process.
260 # Alternatively, just don't do this and fetch the current object each time. Most
261 # could probably be taken from cache.
262 relevant_activities = Activity.get_all_create_by_object_ap_id(id)
264 Enum.map(relevant_activities, fn activity ->
265 new_activity_data = activity.data |> Map.put("object", object.data)
266 changeset = Changeset.change(activity, data: new_activity_data)
267 Repo.update(changeset)
271 #### Like-related helpers
274 Returns an existing like if a user already liked an object
276 def get_existing_like(actor, %{data: %{"id" => id}}) do
279 activity in Activity,
280 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
281 # this is to use the index
284 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
289 where: fragment("(?)->>'type' = 'Like'", activity.data)
296 Returns like activities targeting an object
298 def get_object_likes(%{data: %{"id" => id}}) do
301 activity in Activity,
302 # this is to use the index
305 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
310 where: fragment("(?)->>'type' = 'Like'", activity.data)
317 %User{ap_id: ap_id} = actor,
318 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
321 object_actor = User.get_cached_by_ap_id(object_actor_id)
324 if Visibility.is_public?(object) do
325 [actor.follower_address, object.data["actor"]]
327 [object.data["actor"]]
331 (object.data["to"] ++ (object.data["cc"] || []))
332 |> List.delete(actor.ap_id)
333 |> List.delete(object_actor.follower_address)
341 "context" => object.data["context"]
344 if activity_id, do: Map.put(data, "id", activity_id), else: data
347 def update_element_in_object(property, element, object) do
350 |> Map.put("#{property}_count", length(element))
351 |> Map.put("#{property}s", element),
352 changeset <- Changeset.change(object, data: new_data),
353 {:ok, object} <- Object.update_and_set_cache(changeset),
354 _ <- update_object_in_activities(object) do
359 def update_likes_in_object(likes, object) do
360 update_element_in_object("like", likes, object)
363 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
364 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
366 with likes <- [actor | likes] |> Enum.uniq() do
367 update_likes_in_object(likes, object)
371 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
372 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
374 with likes <- likes |> List.delete(actor) do
375 update_likes_in_object(likes, object)
379 #### Follow-related helpers
382 Updates a follow activity's state (for locked accounts).
384 def update_follow_state_for_all(
385 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
389 Ecto.Adapters.SQL.query!(
391 "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'",
392 [state, actor, object]
395 activity = Activity.get_by_id(activity.id)
403 def update_follow_state(%Activity{} = activity, state) do
406 |> Map.put("state", state),
407 changeset <- Changeset.change(activity, data: new_data),
408 {:ok, activity} <- Repo.update(changeset) do
414 Makes a follow activity data for the given follower and followed
416 def make_follow_data(
417 %User{ap_id: follower_id},
418 %User{ap_id: followed_id} = _followed,
423 "actor" => follower_id,
424 "to" => [followed_id],
425 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
426 "object" => followed_id,
430 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
435 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
438 activity in Activity,
441 "? ->> 'type' = 'Follow'",
444 where: activity.actor == ^follower_id,
445 # this is to use the index
448 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
453 order_by: [fragment("? desc nulls last", activity.id)],
460 #### Announce-related helpers
463 Retruns an existing announce activity if the notice has already been announced
465 def get_existing_announce(actor, %{data: %{"id" => id}}) do
468 activity in Activity,
469 where: activity.actor == ^actor,
470 # this is to use the index
473 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
478 where: fragment("(?)->>'type' = 'Announce'", activity.data)
485 Make announce activity data for the given actor and object
487 # for relayed messages, we only want to send to subscribers
488 def make_announce_data(
489 %User{ap_id: ap_id} = user,
490 %Object{data: %{"id" => id}} = object,
495 "type" => "Announce",
498 "to" => [user.follower_address],
500 "context" => object.data["context"]
503 if activity_id, do: Map.put(data, "id", activity_id), else: data
506 def make_announce_data(
507 %User{ap_id: ap_id} = user,
508 %Object{data: %{"id" => id}} = object,
513 "type" => "Announce",
516 "to" => [user.follower_address, object.data["actor"]],
517 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
518 "context" => object.data["context"]
521 if activity_id, do: Map.put(data, "id", activity_id), else: data
525 Make unannounce activity data for the given actor and object
527 def make_unannounce_data(
528 %User{ap_id: ap_id} = user,
529 %Activity{data: %{"context" => context}} = activity,
535 "object" => activity.data,
536 "to" => [user.follower_address, activity.data["actor"]],
537 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
541 if activity_id, do: Map.put(data, "id", activity_id), else: data
544 def make_unlike_data(
545 %User{ap_id: ap_id} = user,
546 %Activity{data: %{"context" => context}} = activity,
552 "object" => activity.data,
553 "to" => [user.follower_address, activity.data["actor"]],
554 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
558 if activity_id, do: Map.put(data, "id", activity_id), else: data
561 def add_announce_to_object(
563 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
568 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
570 with announcements <- [actor | announcements] |> Enum.uniq() do
571 update_element_in_object("announcement", announcements, object)
575 def add_announce_to_object(_, object), do: {:ok, object}
577 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
579 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
581 with announcements <- announcements |> List.delete(actor) do
582 update_element_in_object("announcement", announcements, object)
586 #### Unfollow-related helpers
588 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
591 "actor" => follower.ap_id,
592 "to" => [followed.ap_id],
593 "object" => follow_activity.data
596 if activity_id, do: Map.put(data, "id", activity_id), else: data
599 #### Block-related helpers
600 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
603 activity in Activity,
606 "? ->> 'type' = 'Block'",
609 where: activity.actor == ^blocker_id,
610 # this is to use the index
613 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
618 order_by: [fragment("? desc nulls last", activity.id)],
625 def make_block_data(blocker, blocked, activity_id) do
628 "actor" => blocker.ap_id,
629 "to" => [blocked.ap_id],
630 "object" => blocked.ap_id
633 if activity_id, do: Map.put(data, "id", activity_id), else: data
636 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
639 "actor" => blocker.ap_id,
640 "to" => [blocked.ap_id],
641 "object" => block_activity.data
644 if activity_id, do: Map.put(data, "id", activity_id), else: data
647 #### Create-related helpers
649 def make_create_data(params, additional) do
650 published = params.published || make_date()
654 "to" => params.to |> Enum.uniq(),
655 "actor" => params.actor.ap_id,
656 "object" => params.object,
657 "published" => published,
658 "context" => params.context
660 |> Map.merge(additional)
663 #### Flag-related helpers
665 def make_flag_data(params, additional) do
667 Enum.map(params.statuses || [], fn
668 %Activity{} = act -> act.data["id"]
669 act when is_map(act) -> act["id"]
670 act when is_binary(act) -> act
673 object = [params.account.ap_id] ++ status_ap_ids
677 "actor" => params.actor.ap_id,
678 "content" => params.content,
680 "context" => params.context,
683 |> Map.merge(additional)
687 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
688 the first one to `pages_left` pages.
689 If the amount of pages is higher than the collection has, it returns whatever was there.
691 def fetch_ordered_collection(from, pages_left, acc \\ []) do
692 with {:ok, response} <- Tesla.get(from),
693 {:ok, collection} <- Jason.decode(response.body) do
694 case collection["type"] do
695 "OrderedCollection" ->
696 # If we've encountered the OrderedCollection and not the page,
697 # just call the same function on the page address
698 fetch_ordered_collection(collection["first"], pages_left)
700 "OrderedCollectionPage" ->
702 # There are still more pages
703 if Map.has_key?(collection, "next") do
704 # There are still more pages, go deeper saving what we have into the accumulator
705 fetch_ordered_collection(
708 acc ++ collection["orderedItems"]
711 # No more pages left, just return whatever we already have
712 acc ++ collection["orderedItems"]
715 # Got the amount of pages needed, add them all to the accumulator
716 acc ++ collection["orderedItems"]
720 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
725 #### Report-related helpers
727 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
728 with new_data <- Map.put(activity.data, "state", state),
729 changeset <- Changeset.change(activity, data: new_data),
730 {:ok, activity} <- Repo.update(changeset) do
735 def update_report_state(_, _), do: {:error, "Unsupported state"}
737 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
738 [to, cc, recipients] =
740 |> get_updated_targets(visibility)
741 |> Enum.map(&Enum.uniq/1)
750 |> Object.change(%{data: object_data})
751 |> Object.update_and_set_cache()
759 |> Map.put(:object, object)
760 |> Activity.change(%{data: activity_data, recipients: recipients})
764 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
766 defp get_updated_targets(
767 %Activity{data: %{"to" => to} = data, recipients: recipients},
770 cc = Map.get(data, "cc", [])
771 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
772 public = "https://www.w3.org/ns/activitystreams#Public"
776 to = [public | List.delete(to, follower_address)]
777 cc = [follower_address | List.delete(cc, public)]
778 recipients = [public | recipients]
782 to = [follower_address | List.delete(to, public)]
783 cc = List.delete(cc, public)
784 recipients = List.delete(recipients, public)
788 to = [follower_address | List.delete(to, public)]
789 cc = [public | List.delete(cc, follower_address)]
790 recipients = recipients ++ [follower_address, public]
798 def get_existing_votes(actor, %{data: %{"id" => id}}) do
801 [activity, object: object] in Activity.with_preloaded_object(Activity),
802 where: fragment("(?)->>'type' = 'Create'", activity.data),
803 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
806 "(?)->>'inReplyTo' = ?",
810 where: fragment("(?)->>'type' = 'Answer'", object.data)