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"]
24 # Some implementations send the actor URI as the actor field, others send the entire actor object,
25 # so figure out what the actor's URI is based on what we have.
26 def get_ap_id(object) do
33 def normalize_params(params) do
34 Map.put(params, "actor", get_ap_id(params["actor"]))
37 def determine_explicit_mentions(%{"tag" => tag} = _object) when is_list(tag) do
39 |> Enum.filter(fn x -> is_map(x) end)
40 |> Enum.filter(fn x -> x["type"] == "Mention" end)
41 |> Enum.map(fn x -> x["href"] end)
44 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
45 Map.put(object, "tag", [tag])
46 |> determine_explicit_mentions()
49 def determine_explicit_mentions(_), do: []
51 defp recipient_in_collection(ap_id, coll) when is_binary(coll), do: ap_id == coll
52 defp recipient_in_collection(ap_id, coll) when is_list(coll), do: ap_id in coll
53 defp recipient_in_collection(_, _), do: false
55 def recipient_in_message(ap_id, params) do
57 recipient_in_collection(ap_id, params["to"]) ->
60 recipient_in_collection(ap_id, params["cc"]) ->
63 recipient_in_collection(ap_id, params["bto"]) ->
66 recipient_in_collection(ap_id, params["bcc"]) ->
69 # if the message is unaddressed at all, then assume it is directly addressed
71 !params["to"] && !params["cc"] && !params["bto"] && !params["bcc"] ->
79 defp extract_list(target) when is_binary(target), do: [target]
80 defp extract_list(lst) when is_list(lst), do: lst
81 defp extract_list(_), do: []
83 def maybe_splice_recipient(ap_id, params) do
85 !recipient_in_collection(ap_id, params["to"]) &&
86 !recipient_in_collection(ap_id, params["cc"])
88 cc_list = extract_list(params["cc"])
92 |> Map.put("cc", [ap_id | cc_list])
98 def make_json_ld_header do
101 "https://www.w3.org/ns/activitystreams",
102 "#{Web.base_url()}/schemas/litepub-0.1.jsonld"
108 DateTime.utc_now() |> DateTime.to_iso8601()
111 def generate_activity_id do
112 generate_id("activities")
115 def generate_context_id do
116 generate_id("contexts")
119 def generate_object_id do
120 Helpers.o_status_url(Endpoint, :object, UUID.generate())
123 def generate_id(type) do
124 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
127 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
128 fake_create_activity = %{
129 "to" => object["to"],
130 "cc" => object["cc"],
135 Notification.get_notified_from_activity(%Activity{data: fake_create_activity}, false)
138 def get_notified_from_object(object) do
139 Notification.get_notified_from_activity(%Activity{data: object}, false)
142 def create_context(context) do
143 context = context || generate_id("contexts")
144 changeset = Object.context_mapping(context)
146 case Repo.insert(changeset) do
150 # This should be solved by an upsert, but it seems ecto
151 # has problems accessing the constraint inside the jsonb.
153 Object.get_cached_by_ap_id(context)
158 Enqueues an activity for federation if it's local
160 def maybe_federate(%Activity{local: true} = activity) do
162 case activity.data["type"] do
168 Pleroma.Web.Federator.publish(activity, priority)
172 def maybe_federate(_), do: :ok
175 Adds an id and a published data if they aren't there,
176 also adds it to an included object
178 def lazy_put_activity_defaults(map) do
179 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
183 |> Map.put_new_lazy("id", &generate_activity_id/0)
184 |> Map.put_new_lazy("published", &make_date/0)
185 |> Map.put_new("context", context)
186 |> Map.put_new("context_id", context_id)
188 if is_map(map["object"]) do
189 object = lazy_put_object_defaults(map["object"], map)
190 %{map | "object" => object}
197 Adds an id and published date if they aren't there.
199 def lazy_put_object_defaults(map, activity \\ %{}) do
201 |> Map.put_new_lazy("id", &generate_object_id/0)
202 |> Map.put_new_lazy("published", &make_date/0)
203 |> Map.put_new("context", activity["context"])
204 |> Map.put_new("context_id", activity["context_id"])
208 Inserts a full object if it is contained in an activity.
210 def insert_full_object(%{"object" => %{"type" => type} = object_data})
211 when is_map(object_data) and type in @supported_object_types do
212 with {:ok, object} <- Object.create(object_data) do
217 def insert_full_object(_), do: {:ok, nil}
219 def update_object_in_activities(%{data: %{"id" => id}} = object) do
221 # Update activities that already had this. Could be done in a seperate process.
222 # Alternatively, just don't do this and fetch the current object each time. Most
223 # could probably be taken from cache.
224 relevant_activities = Activity.get_all_create_by_object_ap_id(id)
226 Enum.map(relevant_activities, fn activity ->
227 new_activity_data = activity.data |> Map.put("object", object.data)
228 changeset = Changeset.change(activity, data: new_activity_data)
229 Repo.update(changeset)
233 # Only federate user icon if not nil
234 # Prevents federating instance default avatars
235 def maybe_make_icon(user) do
236 if User.avatar_url_ap(user) do
240 "url" => User.avatar_url_ap(user)
248 #### Like-related helpers
251 Returns an existing like if a user already liked an object
253 def get_existing_like(actor, %{data: %{"id" => id}}) do
256 activity in Activity,
257 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
258 # this is to use the index
261 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
266 where: fragment("(?)->>'type' = 'Like'", activity.data)
273 Returns like activities targeting an object
275 def get_object_likes(%{data: %{"id" => id}}) do
278 activity in Activity,
279 # this is to use the index
282 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
287 where: fragment("(?)->>'type' = 'Like'", activity.data)
294 %User{ap_id: ap_id} = actor,
295 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
298 object_actor = User.get_cached_by_ap_id(object_actor_id)
301 if Visibility.is_public?(object) do
302 [actor.follower_address, object.data["actor"]]
304 [object.data["actor"]]
308 (object.data["to"] ++ (object.data["cc"] || []))
309 |> List.delete(actor.ap_id)
310 |> List.delete(object_actor.follower_address)
318 "context" => object.data["context"]
321 if activity_id, do: Map.put(data, "id", activity_id), else: data
324 def update_element_in_object(property, element, object) do
327 |> Map.put("#{property}_count", length(element))
328 |> Map.put("#{property}s", element),
329 changeset <- Changeset.change(object, data: new_data),
330 {:ok, object} <- Object.update_and_set_cache(changeset),
331 _ <- update_object_in_activities(object) do
336 def update_likes_in_object(likes, object) do
337 update_element_in_object("like", likes, object)
340 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
341 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
343 with likes <- [actor | likes] |> Enum.uniq() do
344 update_likes_in_object(likes, object)
348 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
349 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
351 with likes <- likes |> List.delete(actor) do
352 update_likes_in_object(likes, object)
356 #### Follow-related helpers
359 Updates a follow activity's state (for locked accounts).
361 def update_follow_state(
362 %Activity{data: %{"actor" => actor, "object" => object, "state" => "pending"}} = activity,
366 Ecto.Adapters.SQL.query!(
368 "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'",
369 [state, actor, object]
372 activity = Repo.get(Activity, activity.id)
380 def update_follow_state(%Activity{} = activity, state) do
383 |> Map.put("state", state),
384 changeset <- Changeset.change(activity, data: new_data),
385 {:ok, activity} <- Repo.update(changeset) do
391 Makes a follow activity data for the given follower and followed
393 def make_follow_data(
394 %User{ap_id: follower_id},
395 %User{ap_id: followed_id} = _followed,
400 "actor" => follower_id,
401 "to" => [followed_id],
402 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
403 "object" => followed_id,
407 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
412 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
415 activity in Activity,
418 "? ->> 'type' = 'Follow'",
421 where: activity.actor == ^follower_id,
426 ^%{object: followed_id}
428 order_by: [desc: :id],
435 #### Announce-related helpers
438 Retruns an existing announce activity if the notice has already been announced
440 def get_existing_announce(actor, %{data: %{"id" => id}}) do
443 activity in Activity,
444 where: activity.actor == ^actor,
445 # this is to use the index
448 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
453 where: fragment("(?)->>'type' = 'Announce'", activity.data)
460 Make announce activity data for the given actor and object
462 # for relayed messages, we only want to send to subscribers
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],
475 "context" => object.data["context"]
478 if activity_id, do: Map.put(data, "id", activity_id), else: data
481 def make_announce_data(
482 %User{ap_id: ap_id} = user,
483 %Object{data: %{"id" => id}} = object,
488 "type" => "Announce",
491 "to" => [user.follower_address, object.data["actor"]],
492 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
493 "context" => object.data["context"]
496 if activity_id, do: Map.put(data, "id", activity_id), else: data
500 Make unannounce activity data for the given actor and object
502 def make_unannounce_data(
503 %User{ap_id: ap_id} = user,
504 %Activity{data: %{"context" => context}} = activity,
510 "object" => activity.data,
511 "to" => [user.follower_address, activity.data["actor"]],
512 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
516 if activity_id, do: Map.put(data, "id", activity_id), else: data
519 def make_unlike_data(
520 %User{ap_id: ap_id} = user,
521 %Activity{data: %{"context" => context}} = activity,
527 "object" => activity.data,
528 "to" => [user.follower_address, activity.data["actor"]],
529 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
533 if activity_id, do: Map.put(data, "id", activity_id), else: data
536 def add_announce_to_object(
538 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
543 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
545 with announcements <- [actor | announcements] |> Enum.uniq() do
546 update_element_in_object("announcement", announcements, object)
550 def add_announce_to_object(_, object), do: {:ok, object}
552 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
554 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
556 with announcements <- announcements |> List.delete(actor) do
557 update_element_in_object("announcement", announcements, object)
561 #### Unfollow-related helpers
563 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
566 "actor" => follower.ap_id,
567 "to" => [followed.ap_id],
568 "object" => follow_activity.data
571 if activity_id, do: Map.put(data, "id", activity_id), else: data
574 #### Block-related helpers
575 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
578 activity in Activity,
581 "? ->> 'type' = 'Block'",
584 where: activity.actor == ^blocker_id,
589 ^%{object: blocked_id}
591 order_by: [desc: :id],
598 def make_block_data(blocker, blocked, activity_id) do
601 "actor" => blocker.ap_id,
602 "to" => [blocked.ap_id],
603 "object" => blocked.ap_id
606 if activity_id, do: Map.put(data, "id", activity_id), else: data
609 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
612 "actor" => blocker.ap_id,
613 "to" => [blocked.ap_id],
614 "object" => block_activity.data
617 if activity_id, do: Map.put(data, "id", activity_id), else: data
620 #### Create-related helpers
622 def make_create_data(params, additional) do
623 published = params.published || make_date()
627 "to" => params.to |> Enum.uniq(),
628 "actor" => params.actor.ap_id,
629 "object" => params.object,
630 "published" => published,
631 "context" => params.context
633 |> Map.merge(additional)
636 #### Flag-related helpers
638 def make_flag_data(params, additional) do
640 Enum.map(params.statuses || [], fn
641 %Activity{} = act -> act.data["id"]
642 act when is_map(act) -> act["id"]
643 act when is_binary(act) -> act
646 object = [params.account.ap_id] ++ status_ap_ids
650 "actor" => params.actor.ap_id,
651 "content" => params.content,
653 "context" => params.context
655 |> Map.merge(additional)
659 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
660 the first one to `pages_left` pages.
661 If the amount of pages is higher than the collection has, it returns whatever was there.
663 def fetch_ordered_collection(from, pages_left, acc \\ []) do
664 with {:ok, response} <- Tesla.get(from),
665 {:ok, collection} <- Poison.decode(response.body) do
666 case collection["type"] do
667 "OrderedCollection" ->
668 # If we've encountered the OrderedCollection and not the page,
669 # just call the same function on the page address
670 fetch_ordered_collection(collection["first"], pages_left)
672 "OrderedCollectionPage" ->
674 # There are still more pages
675 if Map.has_key?(collection, "next") do
676 # There are still more pages, go deeper saving what we have into the accumulator
677 fetch_ordered_collection(
680 acc ++ collection["orderedItems"]
683 # No more pages left, just return whatever we already have
684 acc ++ collection["orderedItems"]
687 # Got the amount of pages needed, add them all to the accumulator
688 acc ++ collection["orderedItems"]
692 {:error, "Not an OrderedCollection or OrderedCollectionPage"}