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", "Audio"]
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 @spec determine_explicit_mentions(map()) :: map()
37 def determine_explicit_mentions(%{"tag" => tag} = _) when is_list(tag) do
39 %{"type" => "Mention", "href" => href} -> [href]
44 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
46 |> Map.put("tag", [tag])
47 |> determine_explicit_mentions()
50 def determine_explicit_mentions(_), do: []
52 @spec recipient_in_collection(any(), any()) :: boolean()
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 @spec recipient_in_message(User.t(), User.t(), map()) :: boolean()
58 def recipient_in_message(%User{ap_id: ap_id} = recipient, %User{} = actor, params) do
59 addresses = [params["to"], params["cc"], params["bto"], params["bcc"]]
62 Enum.any?(addresses, &recipient_in_collection(ap_id, &1)) -> true
63 # if the message is unaddressed at all, then assume it is directly addressed
65 Enum.all?(addresses, &is_nil(&1)) -> true
66 # if the message is sent from somebody the user is following, then assume it
67 # is addressed to the recipient
68 User.following?(recipient, actor) -> true
73 defp extract_list(target) when is_binary(target), do: [target]
74 defp extract_list(lst) when is_list(lst), do: lst
75 defp extract_list(_), do: []
77 def maybe_splice_recipient(ap_id, params) do
79 !recipient_in_collection(ap_id, params["to"]) &&
80 !recipient_in_collection(ap_id, params["cc"])
83 cc_list = extract_list(params["cc"])
84 Map.put(params, "cc", [ap_id | cc_list])
90 def make_json_ld_header do
93 "https://www.w3.org/ns/activitystreams",
94 "#{Web.base_url()}/schemas/litepub-0.1.jsonld",
103 DateTime.utc_now() |> DateTime.to_iso8601()
106 def generate_activity_id do
107 generate_id("activities")
110 def generate_context_id do
111 generate_id("contexts")
114 def generate_object_id do
115 Helpers.o_status_url(Endpoint, :object, UUID.generate())
118 def generate_id(type) do
119 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
122 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
123 fake_create_activity = %{
124 "to" => object["to"],
125 "cc" => object["cc"],
130 get_notified_from_object(fake_create_activity)
133 def get_notified_from_object(object) do
134 Notification.get_notified_from_activity(%Activity{data: object}, false)
137 def create_context(context) do
138 context = context || generate_id("contexts")
140 # Ecto has problems accessing the constraint inside the jsonb,
141 # so we explicitly check for the existed object before insert
142 object = Object.get_cached_by_ap_id(context)
144 with true <- is_nil(object),
145 changeset <- Object.context_mapping(context),
146 {:ok, inserted_object} <- Repo.insert(changeset) do
155 Enqueues an activity for federation if it's local
157 @spec maybe_federate(any()) :: :ok
158 def maybe_federate(%Activity{local: true} = activity) do
159 if Pleroma.Config.get!([:instance, :federating]) do
160 Pleroma.Web.Federator.publish(activity)
166 def maybe_federate(_), do: :ok
169 Adds an id and a published data if they aren't there,
170 also adds it to an included object
172 @spec lazy_put_activity_defaults(map(), boolean) :: map()
173 def lazy_put_activity_defaults(map, fake? \\ false)
175 def lazy_put_activity_defaults(map, true) do
177 |> Map.put_new("id", "pleroma:fakeid")
178 |> Map.put_new_lazy("published", &make_date/0)
179 |> Map.put_new("context", "pleroma:fakecontext")
180 |> Map.put_new("context_id", -1)
181 |> lazy_put_object_defaults(true)
184 def lazy_put_activity_defaults(map, _fake?) do
185 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
188 |> Map.put_new_lazy("id", &generate_activity_id/0)
189 |> Map.put_new_lazy("published", &make_date/0)
190 |> Map.put_new("context", context)
191 |> Map.put_new("context_id", context_id)
192 |> lazy_put_object_defaults(false)
195 # Adds an id and published date if they aren't there.
197 @spec lazy_put_object_defaults(map(), boolean()) :: map()
198 defp lazy_put_object_defaults(%{"object" => map} = activity, true)
202 |> Map.put_new("id", "pleroma:fake_object_id")
203 |> Map.put_new_lazy("published", &make_date/0)
204 |> Map.put_new("context", activity["context"])
205 |> Map.put_new("context_id", activity["context_id"])
206 |> Map.put_new("fake", true)
208 %{activity | "object" => object}
211 defp lazy_put_object_defaults(%{"object" => map} = activity, _)
215 |> Map.put_new_lazy("id", &generate_object_id/0)
216 |> Map.put_new_lazy("published", &make_date/0)
217 |> Map.put_new("context", activity["context"])
218 |> Map.put_new("context_id", activity["context_id"])
220 %{activity | "object" => object}
223 defp lazy_put_object_defaults(activity, _), do: activity
226 Inserts a full object if it is contained in an activity.
228 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
229 when is_map(object_data) and type in @supported_object_types do
230 with {:ok, object} <- Object.create(object_data) do
231 map = Map.put(map, "object", object.data["id"])
237 def insert_full_object(map), do: {:ok, map, nil}
239 #### Like-related helpers
242 Returns an existing like if a user already liked an object
244 @spec get_existing_like(String.t(), map()) :: Activity.t() | nil
245 def get_existing_like(actor, %{data: %{"id" => id}}) do
247 |> Activity.Queries.by_actor()
248 |> Activity.Queries.by_object_id(id)
249 |> Activity.Queries.by_type("Like")
255 Returns like activities targeting an object
257 def get_object_likes(%{data: %{"id" => id}}) do
259 |> Activity.Queries.by_object_id()
260 |> Activity.Queries.by_type("Like")
264 def make_emoji_reaction_data(user, object, emoji, activity_id) do
265 make_like_data(user, object, activity_id)
266 |> Map.put("type", "EmojiReaction")
267 |> Map.put("content", emoji)
270 @spec make_like_data(User.t(), map(), String.t()) :: map()
272 %User{ap_id: ap_id} = actor,
273 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
276 object_actor = User.get_cached_by_ap_id(object_actor_id)
279 if Visibility.is_public?(object) do
280 [actor.follower_address, object.data["actor"]]
282 [object.data["actor"]]
286 (object.data["to"] ++ (object.data["cc"] || []))
287 |> List.delete(actor.ap_id)
288 |> List.delete(object_actor.follower_address)
296 "context" => object.data["context"]
298 |> maybe_put("id", activity_id)
301 @spec update_element_in_object(String.t(), list(any), Object.t()) ::
302 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
303 def update_element_in_object(property, element, object) do
305 if is_map(element) do
318 %{"#{property}_count" => length, "#{property}s" => element}
322 |> Changeset.change(data: data)
323 |> Object.update_and_set_cache()
326 @spec add_emoji_reaction_to_object(Activity.t(), Object.t()) ::
327 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
329 def add_emoji_reaction_to_object(
330 %Activity{data: %{"content" => emoji, "actor" => actor}},
333 reactions = object.data["reactions"] || %{}
334 emoji_actors = reactions[emoji] || []
335 new_emoji_actors = [actor | emoji_actors] |> Enum.uniq()
336 new_reactions = Map.put(reactions, emoji, new_emoji_actors)
337 update_element_in_object("reaction", new_reactions, object)
340 @spec add_like_to_object(Activity.t(), Object.t()) ::
341 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
342 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
343 [actor | fetch_likes(object)]
345 |> update_likes_in_object(object)
348 @spec remove_like_from_object(Activity.t(), Object.t()) ::
349 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
350 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
353 |> List.delete(actor)
354 |> update_likes_in_object(object)
357 defp update_likes_in_object(likes, object) do
358 update_element_in_object("like", likes, object)
361 defp fetch_likes(object) do
362 if is_list(object.data["likes"]) do
369 #### Follow-related helpers
372 Updates a follow activity's state (for locked accounts).
374 @spec update_follow_state_for_all(Activity.t(), String.t()) :: {:ok, Activity} | {:error, any()}
375 def update_follow_state_for_all(
376 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
380 |> Activity.Queries.by_type()
381 |> Activity.Queries.by_actor(actor)
382 |> Activity.Queries.by_object_id(object)
383 |> where(fragment("data->>'state' = 'pending'"))
384 |> update(set: [data: fragment("jsonb_set(data, '{state}', ?)", ^state)])
385 |> Repo.update_all([])
387 User.set_follow_state_cache(actor, object, state)
389 activity = Activity.get_by_id(activity.id)
394 def update_follow_state(
395 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
398 new_data = Map.put(activity.data, "state", state)
399 changeset = Changeset.change(activity, data: new_data)
401 with {:ok, activity} <- Repo.update(changeset) do
402 User.set_follow_state_cache(actor, object, state)
408 Makes a follow activity data for the given follower and followed
410 def make_follow_data(
411 %User{ap_id: follower_id},
412 %User{ap_id: followed_id} = _followed,
417 "actor" => follower_id,
418 "to" => [followed_id],
419 "cc" => [Pleroma.Constants.as_public()],
420 "object" => followed_id,
423 |> maybe_put("id", activity_id)
426 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
428 |> Activity.Queries.by_type()
429 |> where(actor: ^follower_id)
430 # this is to use the index
431 |> Activity.Queries.by_object_id(followed_id)
432 |> order_by([activity], fragment("? desc nulls last", activity.id))
437 #### Announce-related helpers
440 Retruns an existing announce activity if the notice has already been announced
442 @spec get_existing_announce(String.t(), map()) :: Activity.t() | nil
443 def get_existing_announce(actor, %{data: %{"id" => ap_id}}) do
445 |> Activity.Queries.by_type()
446 |> where(actor: ^actor)
447 # this is to use the index
448 |> Activity.Queries.by_object_id(ap_id)
453 Make announce activity data for the given actor and object
455 # for relayed messages, we only want to send to subscribers
456 def make_announce_data(
457 %User{ap_id: ap_id} = user,
458 %Object{data: %{"id" => id}} = object,
463 "type" => "Announce",
466 "to" => [user.follower_address],
468 "context" => object.data["context"]
470 |> maybe_put("id", activity_id)
473 def make_announce_data(
474 %User{ap_id: ap_id} = user,
475 %Object{data: %{"id" => id}} = object,
480 "type" => "Announce",
483 "to" => [user.follower_address, object.data["actor"]],
484 "cc" => [Pleroma.Constants.as_public()],
485 "context" => object.data["context"]
487 |> maybe_put("id", activity_id)
491 Make unannounce activity data for the given actor and object
493 def make_unannounce_data(
494 %User{ap_id: ap_id} = user,
495 %Activity{data: %{"context" => context}} = activity,
501 "object" => activity.data,
502 "to" => [user.follower_address, activity.data["actor"]],
503 "cc" => [Pleroma.Constants.as_public()],
506 |> maybe_put("id", activity_id)
509 def make_unlike_data(
510 %User{ap_id: ap_id} = user,
511 %Activity{data: %{"context" => context}} = activity,
517 "object" => activity.data,
518 "to" => [user.follower_address, activity.data["actor"]],
519 "cc" => [Pleroma.Constants.as_public()],
522 |> maybe_put("id", activity_id)
525 @spec add_announce_to_object(Activity.t(), Object.t()) ::
526 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
527 def add_announce_to_object(
528 %Activity{data: %{"actor" => actor, "cc" => [Pleroma.Constants.as_public()]}},
531 announcements = take_announcements(object)
533 with announcements <- Enum.uniq([actor | announcements]) do
534 update_element_in_object("announcement", announcements, object)
538 def add_announce_to_object(_, object), do: {:ok, object}
540 @spec remove_announce_from_object(Activity.t(), Object.t()) ::
541 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
542 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
543 with announcements <- List.delete(take_announcements(object), actor) do
544 update_element_in_object("announcement", announcements, object)
548 defp take_announcements(%{data: %{"announcements" => announcements}} = _)
549 when is_list(announcements),
552 defp take_announcements(_), do: []
554 #### Unfollow-related helpers
556 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
559 "actor" => follower.ap_id,
560 "to" => [followed.ap_id],
561 "object" => follow_activity.data
563 |> maybe_put("id", activity_id)
566 #### Block-related helpers
567 @spec fetch_latest_block(User.t(), User.t()) :: Activity.t() | nil
568 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
570 |> Activity.Queries.by_type()
571 |> where(actor: ^blocker_id)
572 # this is to use the index
573 |> Activity.Queries.by_object_id(blocked_id)
574 |> order_by([activity], fragment("? desc nulls last", activity.id))
579 def make_block_data(blocker, blocked, activity_id) do
582 "actor" => blocker.ap_id,
583 "to" => [blocked.ap_id],
584 "object" => blocked.ap_id
586 |> maybe_put("id", activity_id)
589 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
592 "actor" => blocker.ap_id,
593 "to" => [blocked.ap_id],
594 "object" => block_activity.data
596 |> maybe_put("id", activity_id)
599 #### Create-related helpers
601 def make_create_data(params, additional) do
602 published = params.published || make_date()
606 "to" => params.to |> Enum.uniq(),
607 "actor" => params.actor.ap_id,
608 "object" => params.object,
609 "published" => published,
610 "context" => params.context
612 |> Map.merge(additional)
615 #### Listen-related helpers
616 def make_listen_data(params, additional) do
617 published = params.published || make_date()
621 "to" => params.to |> Enum.uniq(),
622 "actor" => params.actor.ap_id,
623 "object" => params.object,
624 "published" => published,
625 "context" => params.context
627 |> Map.merge(additional)
630 #### Flag-related helpers
631 @spec make_flag_data(map(), map()) :: map()
632 def make_flag_data(%{actor: actor, context: context, content: content} = params, additional) do
635 "actor" => actor.ap_id,
636 "content" => content,
637 "object" => build_flag_object(params),
638 "context" => context,
641 |> Map.merge(additional)
644 def make_flag_data(_, _), do: %{}
646 defp build_flag_object(%{account: account, statuses: statuses} = _) do
648 Enum.map(statuses || [], fn
649 %Activity{} = act -> act.data["id"]
650 act when is_map(act) -> act["id"]
651 act when is_binary(act) -> act
655 defp build_flag_object(_), do: []
658 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
659 the first one to `pages_left` pages.
660 If the amount of pages is higher than the collection has, it returns whatever was there.
662 def fetch_ordered_collection(from, pages_left, acc \\ []) do
663 with {:ok, response} <- Tesla.get(from),
664 {:ok, collection} <- Jason.decode(response.body) do
665 case collection["type"] do
666 "OrderedCollection" ->
667 # If we've encountered the OrderedCollection and not the page,
668 # just call the same function on the page address
669 fetch_ordered_collection(collection["first"], pages_left)
671 "OrderedCollectionPage" ->
673 # There are still more pages
674 if Map.has_key?(collection, "next") do
675 # There are still more pages, go deeper saving what we have into the accumulator
676 fetch_ordered_collection(
679 acc ++ collection["orderedItems"]
682 # No more pages left, just return whatever we already have
683 acc ++ collection["orderedItems"]
686 # Got the amount of pages needed, add them all to the accumulator
687 acc ++ collection["orderedItems"]
691 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
696 #### Report-related helpers
698 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
699 new_data = Map.put(activity.data, "state", state)
702 |> Changeset.change(data: new_data)
706 def update_report_state(_, _), do: {:error, "Unsupported state"}
708 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
709 [to, cc, recipients] =
711 |> get_updated_targets(visibility)
712 |> Enum.map(&Enum.uniq/1)
721 |> Object.change(%{data: object_data})
722 |> Object.update_and_set_cache()
730 |> Map.put(:object, object)
731 |> Activity.change(%{data: activity_data, recipients: recipients})
735 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
737 defp get_updated_targets(
738 %Activity{data: %{"to" => to} = data, recipients: recipients},
741 cc = Map.get(data, "cc", [])
742 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
743 public = Pleroma.Constants.as_public()
747 to = [public | List.delete(to, follower_address)]
748 cc = [follower_address | List.delete(cc, public)]
749 recipients = [public | recipients]
753 to = [follower_address | List.delete(to, public)]
754 cc = List.delete(cc, public)
755 recipients = List.delete(recipients, public)
759 to = [follower_address | List.delete(to, public)]
760 cc = [public | List.delete(cc, follower_address)]
761 recipients = recipients ++ [follower_address, public]
769 def get_existing_votes(actor, %{data: %{"id" => id}}) do
771 |> Activity.Queries.by_actor()
772 |> Activity.Queries.by_type("Create")
773 |> Activity.with_preloaded_object()
774 |> where([a, object: o], fragment("(?)->>'inReplyTo' = ?", o.data, ^to_string(id)))
775 |> where([a, object: o], fragment("(?)->>'type' = 'Answer'", o.data))
779 defp maybe_put(map, _key, nil), do: map
780 defp maybe_put(map, key, value), do: Map.put(map, key, value)