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 @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"])
82 cc_list = extract_list(params["cc"])
86 |> Map.put("cc", [ap_id | cc_list])
92 def make_json_ld_header do
95 "https://www.w3.org/ns/activitystreams",
96 "#{Web.base_url()}/schemas/litepub-0.1.jsonld",
105 DateTime.utc_now() |> DateTime.to_iso8601()
108 def generate_activity_id do
109 generate_id("activities")
112 def generate_context_id do
113 generate_id("contexts")
116 def generate_object_id do
117 Helpers.o_status_url(Endpoint, :object, UUID.generate())
120 def generate_id(type) do
121 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
124 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
125 fake_create_activity = %{
126 "to" => object["to"],
127 "cc" => object["cc"],
132 Notification.get_notified_from_activity(%Activity{data: fake_create_activity}, false)
135 def get_notified_from_object(object) do
136 Notification.get_notified_from_activity(%Activity{data: object}, false)
139 def create_context(context) do
140 context = context || generate_id("contexts")
142 # Ecto has problems accessing the constraint inside the jsonb,
143 # so we explicitly check for the existed object before insert
144 object = Object.get_cached_by_ap_id(context)
146 with true <- is_nil(object),
147 changeset <- Object.context_mapping(context),
148 {:ok, inserted_object} <- Repo.insert(changeset) do
157 Enqueues an activity for federation if it's local
159 @spec maybe_federate(any()) :: :ok
160 def maybe_federate(%Activity{local: true} = activity) do
161 if Pleroma.Config.get!([:instance, :federating]) do
163 case activity.data["type"] do
169 Pleroma.Web.Federator.publish(activity, priority)
175 def maybe_federate(_), do: :ok
178 Adds an id and a published data if they aren't there,
179 also adds it to an included object
181 @spec lazy_put_activity_defaults(map(), boolean) :: map()
182 def lazy_put_activity_defaults(map, fake \\ false)
184 def lazy_put_activity_defaults(map, true) do
186 |> Map.put_new("id", "pleroma:fakeid")
187 |> Map.put_new_lazy("published", &make_date/0)
188 |> Map.put_new("context", "pleroma:fakecontext")
189 |> Map.put_new("context_id", -1)
190 |> lazy_put_object_defaults(true)
193 def lazy_put_activity_defaults(map, _fake) 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)
201 |> lazy_put_object_defaults(false)
204 # Adds an id and published date if they aren't there.
206 @spec lazy_put_object_defaults(map(), boolean()) :: map()
207 defp lazy_put_object_defaults(%{"object" => map} = activity, true)
211 |> Map.put_new("id", "pleroma:fake_object_id")
212 |> Map.put_new_lazy("published", &make_date/0)
213 |> Map.put_new("context", activity["context"])
214 |> Map.put_new("context_id", activity["context_id"])
215 |> Map.put_new("fake", true)
217 %{activity | "object" => object}
220 defp lazy_put_object_defaults(%{"object" => map} = activity, _)
224 |> Map.put_new_lazy("id", &generate_object_id/0)
225 |> Map.put_new_lazy("published", &make_date/0)
226 |> Map.put_new("context", activity["context"])
227 |> Map.put_new("context_id", activity["context_id"])
229 %{activity | "object" => object}
232 defp lazy_put_object_defaults(activity, _), do: activity
235 Inserts a full object if it is contained in an activity.
237 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
238 when is_map(object_data) and type in @supported_object_types do
239 with {:ok, object} <- Object.create(object_data) do
242 |> Map.put("object", object.data["id"])
248 def insert_full_object(map), do: {:ok, map, nil}
250 #### Like-related helpers
253 Returns an existing like if a user already liked an object
255 @spec get_existing_like(String.t(), map()) :: Activity.t() | nil
256 def get_existing_like(actor, %{data: %{"id" => id}}) do
258 |> Activity.Queries.by_actor()
259 |> Activity.Queries.by_object_id(id)
260 |> Activity.Queries.by_type("Like")
261 |> Activity.Queries.limit(1)
266 Returns like activities targeting an object
268 def get_object_likes(%{data: %{"id" => id}}) do
270 |> Activity.Queries.by_object_id()
271 |> Activity.Queries.by_type("Like")
275 @spec make_like_data(User.t(), map(), String.t()) :: map()
277 %User{ap_id: ap_id} = actor,
278 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
281 object_actor = User.get_cached_by_ap_id(object_actor_id)
284 if Visibility.is_public?(object) do
285 [actor.follower_address, object.data["actor"]]
287 [object.data["actor"]]
291 (object.data["to"] ++ (object.data["cc"] || []))
292 |> List.delete(actor.ap_id)
293 |> List.delete(object_actor.follower_address)
301 "context" => object.data["context"]
303 |> maybe_put("id", activity_id)
306 @spec update_element_in_object(String.t(), list(any), Object.t()) ::
307 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
308 def update_element_in_object(property, element, object) do
312 %{"#{property}_count" => length(element), "#{property}s" => element}
316 |> Changeset.change(data: data)
317 |> Object.update_and_set_cache()
320 @spec add_like_to_object(Activity.t(), Object.t()) ::
321 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
322 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
323 [actor | fetch_likes(object)]
325 |> update_likes_in_object(object)
328 @spec remove_like_from_object(Activity.t(), Object.t()) ::
329 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
330 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
333 |> List.delete(actor)
334 |> update_likes_in_object(object)
337 defp update_likes_in_object(likes, object) do
338 update_element_in_object("like", likes, object)
341 defp fetch_likes(object) do
342 if is_list(object.data["likes"]) do
349 #### Follow-related helpers
352 Updates a follow activity's state (for locked accounts).
354 @spec update_follow_state_for_all(Activity.t(), String.t()) :: {:ok, Activity} | {:error, any()}
355 def update_follow_state_for_all(
356 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
360 from(activity in Activity,
361 where: fragment("data->>'type' = 'Follow'"),
362 where: fragment("data->>'state' = 'pending'"),
363 where: fragment("data->>'actor' = ?", ^actor),
364 where: fragment("data->>'object' = ?", ^object),
367 data: fragment("jsonb_set(data, '{state}', ?)", ^state)
372 with {_, _} <- Repo.update_all(query, []),
373 {_, _} <- User.set_follow_state_cache(actor, object, state),
374 %Activity{} = activity <- Activity.get_by_id(activity.id) do
381 def update_follow_state(
382 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
385 with new_data <- Map.put(activity.data, "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.Queries.by_actor()
416 |> Activity.Queries.by_type("Follow")
417 |> Activity.Queries.by_object_id(followed_id)
418 |> Activity.Queries.limit(1)
422 order_by: [fragment("? desc nulls last", activity.id)]
427 #### Announce-related helpers
430 Retruns an existing announce activity if the notice has already been announced
432 @spec get_existing_announce(String.t(), map()) :: Activity.t() | nil
433 def get_existing_announce(actor, %{data: %{"id" => id}}) do
435 |> Activity.Queries.by_actor()
436 |> Activity.Queries.by_type("Announce")
437 |> Activity.Queries.by_object_id(id)
438 |> Activity.Queries.limit(1)
443 Make announce activity data for the given actor and object
445 # for relayed messages, we only want to send to subscribers
446 def make_announce_data(
447 %User{ap_id: ap_id} = user,
448 %Object{data: %{"id" => id}} = object,
453 "type" => "Announce",
456 "to" => [user.follower_address],
458 "context" => object.data["context"]
460 |> maybe_put("id", activity_id)
463 def make_announce_data(
464 %User{ap_id: ap_id} = user,
465 %Object{data: %{"id" => id}} = object,
470 "type" => "Announce",
473 "to" => [user.follower_address, object.data["actor"]],
474 "cc" => [Pleroma.Constants.as_public()],
475 "context" => object.data["context"]
477 |> maybe_put("id", activity_id)
481 Make unannounce activity data for the given actor and object
483 def make_unannounce_data(
484 %User{ap_id: ap_id} = user,
485 %Activity{data: %{"context" => context}} = activity,
491 "object" => activity.data,
492 "to" => [user.follower_address, activity.data["actor"]],
493 "cc" => [Pleroma.Constants.as_public()],
496 |> maybe_put("id", activity_id)
499 def make_unlike_data(
500 %User{ap_id: ap_id} = user,
501 %Activity{data: %{"context" => context}} = activity,
507 "object" => activity.data,
508 "to" => [user.follower_address, activity.data["actor"]],
509 "cc" => [Pleroma.Constants.as_public()],
512 |> maybe_put("id", activity_id)
515 @spec add_announce_to_object(Activity.t(), Object.t()) ::
516 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
517 def add_announce_to_object(
518 %Activity{data: %{"actor" => actor, "cc" => [Pleroma.Constants.as_public()]}},
521 announcements = take_announcements(object)
523 with announcements <- Enum.uniq([actor | announcements]) do
524 update_element_in_object("announcement", announcements, object)
528 def add_announce_to_object(_, object), do: {:ok, object}
530 @spec remove_announce_from_object(Activity.t(), Object.t()) ::
531 {:ok, Object.t()} | {:error, Ecto.Changeset.t()}
532 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
533 with announcements <- List.delete(take_announcements(object), actor) do
534 update_element_in_object("announcement", announcements, object)
538 defp take_announcements(%{data: %{"announcements" => announcements}} = _)
539 when is_list(announcements),
542 defp take_announcements(_), do: []
544 #### Unfollow-related helpers
546 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
549 "actor" => follower.ap_id,
550 "to" => [followed.ap_id],
551 "object" => follow_activity.data
553 |> maybe_put("id", activity_id)
556 #### Block-related helpers
557 @spec fetch_latest_block(User.t(), User.t()) :: Activity.t() | nil
558 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
561 |> Activity.Queries.by_actor()
562 |> Activity.Queries.by_type("Block")
563 |> Activity.Queries.by_object_id(blocked_id)
564 |> Activity.Queries.limit(1)
568 order_by: [fragment("? desc nulls last", activity.id)]
573 def make_block_data(blocker, blocked, activity_id) do
576 "actor" => blocker.ap_id,
577 "to" => [blocked.ap_id],
578 "object" => blocked.ap_id
580 |> maybe_put("id", activity_id)
583 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
586 "actor" => blocker.ap_id,
587 "to" => [blocked.ap_id],
588 "object" => block_activity.data
590 |> maybe_put("id", activity_id)
593 #### Create-related helpers
595 def make_create_data(params, additional) do
596 published = params.published || make_date()
600 "to" => params.to |> Enum.uniq(),
601 "actor" => params.actor.ap_id,
602 "object" => params.object,
603 "published" => published,
604 "context" => params.context
606 |> Map.merge(additional)
609 #### Flag-related helpers
610 @spec make_flag_data(map(), map()) :: map()
611 def make_flag_data(%{actor: actor, context: context, content: content} = params, additional) do
614 "actor" => actor.ap_id,
615 "content" => content,
616 "object" => build_flag_object(params),
617 "context" => context,
620 |> Map.merge(additional)
623 def make_flag_data(_, _), do: %{}
625 defp build_flag_object(%{account: account, statuses: statuses} = _) do
627 Enum.map(statuses || [], fn
628 %Activity{} = act -> act.data["id"]
629 act when is_map(act) -> act["id"]
630 act when is_binary(act) -> act
634 defp build_flag_object(_), do: []
637 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
638 the first one to `pages_left` pages.
639 If the amount of pages is higher than the collection has, it returns whatever was there.
641 def fetch_ordered_collection(from, pages_left, acc \\ []) do
642 with {:ok, response} <- Tesla.get(from),
643 {:ok, collection} <- Jason.decode(response.body) do
644 case collection["type"] do
645 "OrderedCollection" ->
646 # If we've encountered the OrderedCollection and not the page,
647 # just call the same function on the page address
648 fetch_ordered_collection(collection["first"], pages_left)
650 "OrderedCollectionPage" ->
652 # There are still more pages
653 if Map.has_key?(collection, "next") do
654 # There are still more pages, go deeper saving what we have into the accumulator
655 fetch_ordered_collection(
658 acc ++ collection["orderedItems"]
661 # No more pages left, just return whatever we already have
662 acc ++ collection["orderedItems"]
665 # Got the amount of pages needed, add them all to the accumulator
666 acc ++ collection["orderedItems"]
670 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
675 #### Report-related helpers
677 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
678 with new_data <- Map.put(activity.data, "state", state),
679 changeset <- Changeset.change(activity, data: new_data),
680 {:ok, activity} <- Repo.update(changeset) do
685 def update_report_state(_, _), do: {:error, "Unsupported state"}
687 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
688 [to, cc, recipients] =
690 |> get_updated_targets(visibility)
691 |> Enum.map(&Enum.uniq/1)
700 |> Object.change(%{data: object_data})
701 |> Object.update_and_set_cache()
709 |> Map.put(:object, object)
710 |> Activity.change(%{data: activity_data, recipients: recipients})
714 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
716 defp get_updated_targets(
717 %Activity{data: %{"to" => to} = data, recipients: recipients},
720 cc = Map.get(data, "cc", [])
721 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
722 public = Pleroma.Constants.as_public()
726 to = [public | List.delete(to, follower_address)]
727 cc = [follower_address | List.delete(cc, public)]
728 recipients = [public | recipients]
732 to = [follower_address | List.delete(to, public)]
733 cc = List.delete(cc, public)
734 recipients = List.delete(recipients, public)
738 to = [follower_address | List.delete(to, public)]
739 cc = [public | List.delete(cc, follower_address)]
740 recipients = recipients ++ [follower_address, public]
748 def get_existing_votes(actor, %{data: %{"id" => id}}) do
751 [activity, object: object] in Activity.with_preloaded_object(Activity),
752 where: fragment("(?)->>'type' = 'Create'", activity.data),
753 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
756 "(?)->>'inReplyTo' = ?",
760 where: fragment("(?)->>'type' = 'Answer'", object.data)
766 defp maybe_put(map, _key, nil), do: map
767 defp maybe_put(map, key, value), do: Map.put(map, key, value)