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(%{"id" => id} = _), do: id
29 def get_ap_id(id), do: id
31 def normalize_params(params) do
32 Map.put(params, "actor", get_ap_id(params["actor"]))
35 def determine_explicit_mentions(%{"tag" => tag} = _object) when is_list(tag) do
37 |> Enum.filter(fn x -> is_map(x) end)
38 |> Enum.filter(fn x -> x["type"] == "Mention" end)
39 |> Enum.map(fn x -> x["href"] end)
42 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
43 Map.put(object, "tag", [tag])
44 |> determine_explicit_mentions()
47 def determine_explicit_mentions(_), do: []
49 defp recipient_in_collection(ap_id, coll) when is_binary(coll), do: ap_id == coll
50 defp recipient_in_collection(ap_id, coll) when is_list(coll), do: ap_id in coll
51 defp recipient_in_collection(_, _), do: false
53 def recipient_in_message(%User{ap_id: ap_id} = recipient, %User{} = actor, params) do
55 recipient_in_collection(ap_id, params["to"]) ->
58 recipient_in_collection(ap_id, params["cc"]) ->
61 recipient_in_collection(ap_id, params["bto"]) ->
64 recipient_in_collection(ap_id, params["bcc"]) ->
67 # if the message is unaddressed at all, then assume it is directly addressed
69 !params["to"] && !params["cc"] && !params["bto"] && !params["bcc"] ->
72 # if the message is sent from somebody the user is following, then assume it
73 # is addressed to the recipient
74 User.following?(recipient, actor) ->
82 defp extract_list(target) when is_binary(target), do: [target]
83 defp extract_list(lst) when is_list(lst), do: lst
84 defp extract_list(_), do: []
86 def maybe_splice_recipient(ap_id, params) do
88 !recipient_in_collection(ap_id, params["to"]) &&
89 !recipient_in_collection(ap_id, params["cc"])
91 cc_list = extract_list(params["cc"])
95 |> Map.put("cc", [ap_id | cc_list])
101 def make_json_ld_header do
104 "https://www.w3.org/ns/activitystreams",
105 "#{Web.base_url()}/schemas/litepub-0.1.jsonld",
114 DateTime.utc_now() |> DateTime.to_iso8601()
117 def generate_activity_id do
118 generate_id("activities")
121 def generate_context_id do
122 generate_id("contexts")
125 def generate_object_id do
126 Helpers.o_status_url(Endpoint, :object, UUID.generate())
129 def generate_id(type) do
130 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
133 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
134 fake_create_activity = %{
135 "to" => object["to"],
136 "cc" => object["cc"],
141 Notification.get_notified_from_activity(%Activity{data: fake_create_activity}, false)
144 def get_notified_from_object(object) do
145 Notification.get_notified_from_activity(%Activity{data: object}, false)
148 def create_context(context) do
149 context = context || generate_id("contexts")
151 # Ecto has problems accessing the constraint inside the jsonb,
152 # so we explicitly check for the existed object before insert
153 object = Object.get_cached_by_ap_id(context)
155 with true <- is_nil(object),
156 changeset <- Object.context_mapping(context),
157 {:ok, inserted_object} <- Repo.insert(changeset) do
166 Enqueues an activity for federation if it's local
168 def maybe_federate(%Activity{local: true} = activity) do
169 if Pleroma.Config.get!([:instance, :federating]) do
171 case activity.data["type"] do
177 Pleroma.Web.Federator.publish(activity, priority)
183 def maybe_federate(_), do: :ok
186 Adds an id and a published data if they aren't there,
187 also adds it to an included object
189 def lazy_put_activity_defaults(map, fake \\ false) do
192 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
195 |> Map.put_new_lazy("id", &generate_activity_id/0)
196 |> Map.put_new_lazy("published", &make_date/0)
197 |> Map.put_new("context", context)
198 |> Map.put_new("context_id", context_id)
201 |> Map.put_new("id", "pleroma:fakeid")
202 |> Map.put_new_lazy("published", &make_date/0)
203 |> Map.put_new("context", "pleroma:fakecontext")
204 |> Map.put_new("context_id", -1)
207 if is_map(map["object"]) do
208 object = lazy_put_object_defaults(map["object"], map, fake)
209 %{map | "object" => object}
216 Adds an id and published date if they aren't there.
218 def lazy_put_object_defaults(map, activity \\ %{}, fake)
220 def lazy_put_object_defaults(map, activity, true = _fake) do
222 |> Map.put_new_lazy("published", &make_date/0)
223 |> Map.put_new("id", "pleroma:fake_object_id")
224 |> Map.put_new("context", activity["context"])
225 |> Map.put_new("fake", true)
226 |> Map.put_new("context_id", activity["context_id"])
229 def lazy_put_object_defaults(map, activity, _fake) do
231 |> Map.put_new_lazy("id", &generate_object_id/0)
232 |> Map.put_new_lazy("published", &make_date/0)
233 |> Map.put_new("context", activity["context"])
234 |> Map.put_new("context_id", activity["context_id"])
238 Inserts a full object if it is contained in an activity.
240 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
241 when is_map(object_data) and type in @supported_object_types do
242 with {:ok, object} <- Object.create(object_data) do
245 |> Map.put("object", object.data["id"])
251 def insert_full_object(map), do: {:ok, map, nil}
253 def update_object_in_activities(%{data: %{"id" => id}} = object) do
255 # Update activities that already had this. Could be done in a seperate process.
256 # Alternatively, just don't do this and fetch the current object each time. Most
257 # could probably be taken from cache.
258 relevant_activities = Activity.get_all_create_by_object_ap_id(id)
260 Enum.map(relevant_activities, fn activity ->
261 new_activity_data = activity.data |> Map.put("object", object.data)
262 changeset = Changeset.change(activity, data: new_activity_data)
263 Repo.update(changeset)
267 #### Like-related helpers
270 Returns an existing like if a user already liked an object
272 def get_existing_like(actor, %{data: %{"id" => id}}) do
275 activity in Activity,
276 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
277 # this is to use the index
280 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
285 where: fragment("(?)->>'type' = 'Like'", activity.data)
292 Returns like activities targeting an object
294 def get_object_likes(%{data: %{"id" => id}}) do
297 activity in Activity,
298 # this is to use the index
301 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
306 where: fragment("(?)->>'type' = 'Like'", activity.data)
313 %User{ap_id: ap_id} = actor,
314 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
317 object_actor = User.get_cached_by_ap_id(object_actor_id)
320 if Visibility.is_public?(object) do
321 [actor.follower_address, object.data["actor"]]
323 [object.data["actor"]]
327 (object.data["to"] ++ (object.data["cc"] || []))
328 |> List.delete(actor.ap_id)
329 |> List.delete(object_actor.follower_address)
337 "context" => object.data["context"]
340 if activity_id, do: Map.put(data, "id", activity_id), else: data
343 def update_element_in_object(property, element, object) do
346 |> Map.put("#{property}_count", length(element))
347 |> Map.put("#{property}s", element),
348 changeset <- Changeset.change(object, data: new_data),
349 {:ok, object} <- Object.update_and_set_cache(changeset),
350 _ <- update_object_in_activities(object) do
355 def update_likes_in_object(likes, object) do
356 update_element_in_object("like", likes, object)
359 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
360 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
362 with likes <- [actor | likes] |> Enum.uniq() do
363 update_likes_in_object(likes, object)
367 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
368 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
370 with likes <- likes |> List.delete(actor) do
371 update_likes_in_object(likes, object)
375 #### Follow-related helpers
378 Updates a follow activity's state (for locked accounts).
380 def update_follow_state_for_all(
381 %Activity{data: %{"actor" => actor, "object" => object}} = activity,
385 Ecto.Adapters.SQL.query!(
387 "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'",
388 [state, actor, object]
391 activity = Activity.get_by_id(activity.id)
399 def update_follow_state(%Activity{} = activity, state) do
402 |> Map.put("state", state),
403 changeset <- Changeset.change(activity, data: new_data),
404 {:ok, activity} <- Repo.update(changeset) do
410 Makes a follow activity data for the given follower and followed
412 def make_follow_data(
413 %User{ap_id: follower_id},
414 %User{ap_id: followed_id} = _followed,
419 "actor" => follower_id,
420 "to" => [followed_id],
421 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
422 "object" => followed_id,
426 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
431 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
434 activity in Activity,
437 "? ->> 'type' = 'Follow'",
440 where: activity.actor == ^follower_id,
441 # this is to use the index
444 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
449 order_by: [fragment("? desc nulls last", activity.id)],
456 #### Announce-related helpers
459 Retruns an existing announce activity if the notice has already been announced
461 def get_existing_announce(actor, %{data: %{"id" => id}}) do
464 activity in Activity,
465 where: activity.actor == ^actor,
466 # this is to use the index
469 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
474 where: fragment("(?)->>'type' = 'Announce'", activity.data)
481 Make announce activity data for the given actor and object
483 # for relayed messages, we only want to send to subscribers
484 def make_announce_data(
485 %User{ap_id: ap_id} = user,
486 %Object{data: %{"id" => id}} = object,
491 "type" => "Announce",
494 "to" => [user.follower_address],
496 "context" => object.data["context"]
499 if activity_id, do: Map.put(data, "id", activity_id), else: data
502 def make_announce_data(
503 %User{ap_id: ap_id} = user,
504 %Object{data: %{"id" => id}} = object,
509 "type" => "Announce",
512 "to" => [user.follower_address, object.data["actor"]],
513 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
514 "context" => object.data["context"]
517 if activity_id, do: Map.put(data, "id", activity_id), else: data
521 Make unannounce activity data for the given actor and object
523 def make_unannounce_data(
524 %User{ap_id: ap_id} = user,
525 %Activity{data: %{"context" => context}} = activity,
531 "object" => activity.data,
532 "to" => [user.follower_address, activity.data["actor"]],
533 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
537 if activity_id, do: Map.put(data, "id", activity_id), else: data
540 def make_unlike_data(
541 %User{ap_id: ap_id} = user,
542 %Activity{data: %{"context" => context}} = activity,
548 "object" => activity.data,
549 "to" => [user.follower_address, activity.data["actor"]],
550 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
554 if activity_id, do: Map.put(data, "id", activity_id), else: data
557 def add_announce_to_object(
559 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
564 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
566 with announcements <- [actor | announcements] |> Enum.uniq() do
567 update_element_in_object("announcement", announcements, object)
571 def add_announce_to_object(_, object), do: {:ok, object}
573 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
575 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
577 with announcements <- announcements |> List.delete(actor) do
578 update_element_in_object("announcement", announcements, object)
582 #### Unfollow-related helpers
584 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
587 "actor" => follower.ap_id,
588 "to" => [followed.ap_id],
589 "object" => follow_activity.data
592 if activity_id, do: Map.put(data, "id", activity_id), else: data
595 #### Block-related helpers
596 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
599 activity in Activity,
602 "? ->> 'type' = 'Block'",
605 where: activity.actor == ^blocker_id,
606 # this is to use the index
609 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
614 order_by: [fragment("? desc nulls last", activity.id)],
621 def make_block_data(blocker, blocked, activity_id) do
624 "actor" => blocker.ap_id,
625 "to" => [blocked.ap_id],
626 "object" => blocked.ap_id
629 if activity_id, do: Map.put(data, "id", activity_id), else: data
632 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
635 "actor" => blocker.ap_id,
636 "to" => [blocked.ap_id],
637 "object" => block_activity.data
640 if activity_id, do: Map.put(data, "id", activity_id), else: data
643 #### Create-related helpers
645 def make_create_data(params, additional) do
646 published = params.published || make_date()
650 "to" => params.to |> Enum.uniq(),
651 "actor" => params.actor.ap_id,
652 "object" => params.object,
653 "published" => published,
654 "context" => params.context
656 |> Map.merge(additional)
659 #### Flag-related helpers
661 def make_flag_data(params, additional) do
663 Enum.map(params.statuses || [], fn
664 %Activity{} = act -> act.data["id"]
665 act when is_map(act) -> act["id"]
666 act when is_binary(act) -> act
669 object = [params.account.ap_id] ++ status_ap_ids
673 "actor" => params.actor.ap_id,
674 "content" => params.content,
676 "context" => params.context,
679 |> Map.merge(additional)
683 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
684 the first one to `pages_left` pages.
685 If the amount of pages is higher than the collection has, it returns whatever was there.
687 def fetch_ordered_collection(from, pages_left, acc \\ []) do
688 with {:ok, response} <- Tesla.get(from),
689 {:ok, collection} <- Jason.decode(response.body) do
690 case collection["type"] do
691 "OrderedCollection" ->
692 # If we've encountered the OrderedCollection and not the page,
693 # just call the same function on the page address
694 fetch_ordered_collection(collection["first"], pages_left)
696 "OrderedCollectionPage" ->
698 # There are still more pages
699 if Map.has_key?(collection, "next") do
700 # There are still more pages, go deeper saving what we have into the accumulator
701 fetch_ordered_collection(
704 acc ++ collection["orderedItems"]
707 # No more pages left, just return whatever we already have
708 acc ++ collection["orderedItems"]
711 # Got the amount of pages needed, add them all to the accumulator
712 acc ++ collection["orderedItems"]
716 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
721 #### Report-related helpers
723 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
724 with new_data <- Map.put(activity.data, "state", state),
725 changeset <- Changeset.change(activity, data: new_data),
726 {:ok, activity} <- Repo.update(changeset) do
731 def update_report_state(_, _), do: {:error, "Unsupported state"}
733 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
734 [to, cc, recipients] =
736 |> get_updated_targets(visibility)
737 |> Enum.map(&Enum.uniq/1)
746 |> Object.change(%{data: object_data})
747 |> Object.update_and_set_cache()
755 |> Map.put(:object, object)
756 |> Activity.change(%{data: activity_data, recipients: recipients})
760 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
762 defp get_updated_targets(
763 %Activity{data: %{"to" => to} = data, recipients: recipients},
766 cc = Map.get(data, "cc", [])
767 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
768 public = "https://www.w3.org/ns/activitystreams#Public"
772 to = [public | List.delete(to, follower_address)]
773 cc = [follower_address | List.delete(cc, public)]
774 recipients = [public | recipients]
778 to = [follower_address | List.delete(to, public)]
779 cc = List.delete(cc, public)
780 recipients = List.delete(recipients, public)
784 to = [follower_address | List.delete(to, public)]
785 cc = [public | List.delete(cc, follower_address)]
786 recipients = recipients ++ [follower_address, public]
794 def get_existing_votes(actor, %{data: %{"id" => id}}) do
797 [activity, object: object] in Activity.with_preloaded_object(Activity),
798 where: fragment("(?)->>'type' = 'Create'", activity.data),
799 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
802 "(?)->>'inReplyTo' = ?",
806 where: fragment("(?)->>'type' = 'Answer'", object.data)