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"]
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")
154 changeset = Object.context_mapping(context)
156 case Repo.insert(changeset) do
160 # This should be solved by an upsert, but it seems ecto
161 # has problems accessing the constraint inside the jsonb.
163 Object.get_cached_by_ap_id(context)
168 Enqueues an activity for federation if it's local
170 def maybe_federate(%Activity{local: true} = activity) do
172 case activity.data["type"] do
178 Pleroma.Web.Federator.publish(activity, priority)
182 def maybe_federate(_), do: :ok
185 Adds an id and a published data if they aren't there,
186 also adds it to an included object
188 def lazy_put_activity_defaults(map, fake \\ false) do
191 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
194 |> Map.put_new_lazy("id", &generate_activity_id/0)
195 |> Map.put_new_lazy("published", &make_date/0)
196 |> Map.put_new("context", context)
197 |> Map.put_new("context_id", context_id)
200 |> Map.put_new("id", "pleroma:fakeid")
201 |> Map.put_new_lazy("published", &make_date/0)
202 |> Map.put_new("context", "pleroma:fakecontext")
203 |> Map.put_new("context_id", -1)
206 if is_map(map["object"]) do
207 object = lazy_put_object_defaults(map["object"], map, fake)
208 %{map | "object" => object}
215 Adds an id and published date if they aren't there.
217 def lazy_put_object_defaults(map, activity \\ %{}, fake)
219 def lazy_put_object_defaults(map, activity, true = _fake) do
221 |> Map.put_new_lazy("published", &make_date/0)
222 |> Map.put_new("id", "pleroma:fake_object_id")
223 |> Map.put_new("context", activity["context"])
224 |> Map.put_new("fake", true)
225 |> Map.put_new("context_id", activity["context_id"])
228 def lazy_put_object_defaults(map, activity, _fake) do
230 |> Map.put_new_lazy("id", &generate_object_id/0)
231 |> Map.put_new_lazy("published", &make_date/0)
232 |> Map.put_new("context", activity["context"])
233 |> Map.put_new("context_id", activity["context_id"])
237 Inserts a full object if it is contained in an activity.
239 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
240 when is_map(object_data) and type in @supported_object_types do
241 with {:ok, object} <- Object.create(object_data) do
244 |> Map.put("object", object.data["id"])
250 def insert_full_object(map), do: {:ok, map, nil}
252 def update_object_in_activities(%{data: %{"id" => id}} = object) do
254 # Update activities that already had this. Could be done in a seperate process.
255 # Alternatively, just don't do this and fetch the current object each time. Most
256 # could probably be taken from cache.
257 relevant_activities = Activity.get_all_create_by_object_ap_id(id)
259 Enum.map(relevant_activities, fn activity ->
260 new_activity_data = activity.data |> Map.put("object", object.data)
261 changeset = Changeset.change(activity, data: new_activity_data)
262 Repo.update(changeset)
266 #### Like-related helpers
269 Returns an existing like if a user already liked an object
271 def get_existing_like(actor, %{data: %{"id" => id}}) do
274 activity in Activity,
275 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
276 # this is to use the index
279 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
284 where: fragment("(?)->>'type' = 'Like'", activity.data)
291 Returns like activities targeting an object
293 def get_object_likes(%{data: %{"id" => id}}) do
296 activity in Activity,
297 # this is to use the index
300 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
305 where: fragment("(?)->>'type' = 'Like'", activity.data)
312 %User{ap_id: ap_id} = actor,
313 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
316 object_actor = User.get_cached_by_ap_id(object_actor_id)
319 if Visibility.is_public?(object) do
320 [actor.follower_address, object.data["actor"]]
322 [object.data["actor"]]
326 (object.data["to"] ++ (object.data["cc"] || []))
327 |> List.delete(actor.ap_id)
328 |> List.delete(object_actor.follower_address)
336 "context" => object.data["context"]
339 if activity_id, do: Map.put(data, "id", activity_id), else: data
342 def update_element_in_object(property, element, object) do
345 |> Map.put("#{property}_count", length(element))
346 |> Map.put("#{property}s", element),
347 changeset <- Changeset.change(object, data: new_data),
348 {:ok, object} <- Object.update_and_set_cache(changeset),
349 _ <- update_object_in_activities(object) do
354 def update_likes_in_object(likes, object) do
355 update_element_in_object("like", likes, object)
358 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
359 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
361 with likes <- [actor | likes] |> Enum.uniq() do
362 update_likes_in_object(likes, object)
366 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
367 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
369 with likes <- likes |> List.delete(actor) do
370 update_likes_in_object(likes, object)
374 #### Follow-related helpers
377 Updates a follow activity's state (for locked accounts).
379 def update_follow_state(
380 %Activity{data: %{"actor" => actor, "object" => object, "state" => "pending"}} = activity,
384 Ecto.Adapters.SQL.query!(
386 "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'",
387 [state, actor, object]
390 activity = Activity.get_by_id(activity.id)
398 def update_follow_state(%Activity{} = activity, state) do
401 |> Map.put("state", state),
402 changeset <- Changeset.change(activity, data: new_data),
403 {:ok, activity} <- Repo.update(changeset) do
409 Makes a follow activity data for the given follower and followed
411 def make_follow_data(
412 %User{ap_id: follower_id},
413 %User{ap_id: followed_id} = _followed,
418 "actor" => follower_id,
419 "to" => [followed_id],
420 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
421 "object" => followed_id,
425 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
430 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
433 activity in Activity,
436 "? ->> 'type' = 'Follow'",
439 where: activity.actor == ^follower_id,
440 # this is to use the index
443 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
448 order_by: [fragment("? desc nulls last", activity.id)],
455 #### Announce-related helpers
458 Retruns an existing announce activity if the notice has already been announced
460 def get_existing_announce(actor, %{data: %{"id" => id}}) do
463 activity in Activity,
464 where: activity.actor == ^actor,
465 # this is to use the index
468 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
473 where: fragment("(?)->>'type' = 'Announce'", activity.data)
480 Make announce activity data for the given actor and object
482 # for relayed messages, we only want to send to subscribers
483 def make_announce_data(
484 %User{ap_id: ap_id} = user,
485 %Object{data: %{"id" => id}} = object,
490 "type" => "Announce",
493 "to" => [user.follower_address],
495 "context" => object.data["context"]
498 if activity_id, do: Map.put(data, "id", activity_id), else: data
501 def make_announce_data(
502 %User{ap_id: ap_id} = user,
503 %Object{data: %{"id" => id}} = object,
508 "type" => "Announce",
511 "to" => [user.follower_address, object.data["actor"]],
512 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
513 "context" => object.data["context"]
516 if activity_id, do: Map.put(data, "id", activity_id), else: data
520 Make unannounce activity data for the given actor and object
522 def make_unannounce_data(
523 %User{ap_id: ap_id} = user,
524 %Activity{data: %{"context" => context}} = activity,
530 "object" => activity.data,
531 "to" => [user.follower_address, activity.data["actor"]],
532 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
536 if activity_id, do: Map.put(data, "id", activity_id), else: data
539 def make_unlike_data(
540 %User{ap_id: ap_id} = user,
541 %Activity{data: %{"context" => context}} = activity,
547 "object" => activity.data,
548 "to" => [user.follower_address, activity.data["actor"]],
549 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
553 if activity_id, do: Map.put(data, "id", activity_id), else: data
556 def add_announce_to_object(
558 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
563 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
565 with announcements <- [actor | announcements] |> Enum.uniq() do
566 update_element_in_object("announcement", announcements, object)
570 def add_announce_to_object(_, object), do: {:ok, object}
572 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
574 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
576 with announcements <- announcements |> List.delete(actor) do
577 update_element_in_object("announcement", announcements, object)
581 #### Unfollow-related helpers
583 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
586 "actor" => follower.ap_id,
587 "to" => [followed.ap_id],
588 "object" => follow_activity.data
591 if activity_id, do: Map.put(data, "id", activity_id), else: data
594 #### Block-related helpers
595 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
598 activity in Activity,
601 "? ->> 'type' = 'Block'",
604 where: activity.actor == ^blocker_id,
605 # this is to use the index
608 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
613 order_by: [fragment("? desc nulls last", activity.id)],
620 def make_block_data(blocker, blocked, activity_id) do
623 "actor" => blocker.ap_id,
624 "to" => [blocked.ap_id],
625 "object" => blocked.ap_id
628 if activity_id, do: Map.put(data, "id", activity_id), else: data
631 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
634 "actor" => blocker.ap_id,
635 "to" => [blocked.ap_id],
636 "object" => block_activity.data
639 if activity_id, do: Map.put(data, "id", activity_id), else: data
642 #### Create-related helpers
644 def make_create_data(params, additional) do
645 published = params.published || make_date()
649 "to" => params.to |> Enum.uniq(),
650 "actor" => params.actor.ap_id,
651 "object" => params.object,
652 "published" => published,
653 "context" => params.context
655 |> Map.merge(additional)
658 #### Flag-related helpers
660 def make_flag_data(params, additional) do
662 Enum.map(params.statuses || [], fn
663 %Activity{} = act -> act.data["id"]
664 act when is_map(act) -> act["id"]
665 act when is_binary(act) -> act
668 object = [params.account.ap_id] ++ status_ap_ids
672 "actor" => params.actor.ap_id,
673 "content" => params.content,
675 "context" => params.context,
678 |> Map.merge(additional)
682 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
683 the first one to `pages_left` pages.
684 If the amount of pages is higher than the collection has, it returns whatever was there.
686 def fetch_ordered_collection(from, pages_left, acc \\ []) do
687 with {:ok, response} <- Tesla.get(from),
688 {:ok, collection} <- Jason.decode(response.body) do
689 case collection["type"] do
690 "OrderedCollection" ->
691 # If we've encountered the OrderedCollection and not the page,
692 # just call the same function on the page address
693 fetch_ordered_collection(collection["first"], pages_left)
695 "OrderedCollectionPage" ->
697 # There are still more pages
698 if Map.has_key?(collection, "next") do
699 # There are still more pages, go deeper saving what we have into the accumulator
700 fetch_ordered_collection(
703 acc ++ collection["orderedItems"]
706 # No more pages left, just return whatever we already have
707 acc ++ collection["orderedItems"]
710 # Got the amount of pages needed, add them all to the accumulator
711 acc ++ collection["orderedItems"]
715 {:error, "Not an OrderedCollection or OrderedCollectionPage"}
720 #### Report-related helpers
722 def update_report_state(%Activity{} = activity, state) when state in @supported_report_states do
723 with new_data <- Map.put(activity.data, "state", state),
724 changeset <- Changeset.change(activity, data: new_data),
725 {:ok, activity} <- Repo.update(changeset) do
730 def update_report_state(_, _), do: {:error, "Unsupported state"}
732 def update_activity_visibility(activity, visibility) when visibility in @valid_visibilities do
733 [to, cc, recipients] =
735 |> get_updated_targets(visibility)
736 |> Enum.map(&Enum.uniq/1)
745 |> Object.change(%{data: object_data})
746 |> Object.update_and_set_cache()
754 |> Map.put(:object, object)
755 |> Activity.change(%{data: activity_data, recipients: recipients})
759 def update_activity_visibility(_, _), do: {:error, "Unsupported visibility"}
761 defp get_updated_targets(
762 %Activity{data: %{"to" => to} = data, recipients: recipients},
765 cc = Map.get(data, "cc", [])
766 follower_address = User.get_cached_by_ap_id(data["actor"]).follower_address
767 public = "https://www.w3.org/ns/activitystreams#Public"
771 to = [public | List.delete(to, follower_address)]
772 cc = [follower_address | List.delete(cc, public)]
773 recipients = [public | recipients]
777 to = [follower_address | List.delete(to, public)]
778 cc = List.delete(cc, public)
779 recipients = List.delete(recipients, public)
783 to = [follower_address | List.delete(to, public)]
784 cc = [public | List.delete(cc, follower_address)]
785 recipients = recipients ++ [follower_address, public]