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, fake \\ false) do
181 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
184 |> Map.put_new_lazy("id", &generate_activity_id/0)
185 |> Map.put_new_lazy("published", &make_date/0)
186 |> Map.put_new("context", context)
187 |> Map.put_new("context_id", context_id)
190 |> Map.put_new("id", "pleroma:fakeid")
191 |> Map.put_new_lazy("published", &make_date/0)
192 |> Map.put_new("context", "pleroma:fakecontext")
193 |> Map.put_new("context_id", -1)
196 if is_map(map["object"]) do
197 object = lazy_put_object_defaults(map["object"], map, fake)
198 %{map | "object" => object}
205 Adds an id and published date if they aren't there.
207 def lazy_put_object_defaults(map, activity \\ %{}, fake)
209 def lazy_put_object_defaults(map, activity, true = _fake) do
211 |> Map.put_new_lazy("published", &make_date/0)
212 |> Map.put_new("id", "pleroma:fake_object_id")
213 |> Map.put_new("context", activity["context"])
214 |> Map.put_new("fake", true)
215 |> Map.put_new("context_id", activity["context_id"])
218 def lazy_put_object_defaults(map, activity, _fake) do
220 |> Map.put_new_lazy("id", &generate_object_id/0)
221 |> Map.put_new_lazy("published", &make_date/0)
222 |> Map.put_new("context", activity["context"])
223 |> Map.put_new("context_id", activity["context_id"])
227 Inserts a full object if it is contained in an activity.
229 def insert_full_object(%{"object" => %{"type" => type} = object_data})
230 when is_map(object_data) and type in @supported_object_types do
231 with {:ok, object} <- Object.create(object_data) do
236 def insert_full_object(_), do: {:ok, nil}
238 def update_object_in_activities(%{data: %{"id" => id}} = object) do
240 # Update activities that already had this. Could be done in a seperate process.
241 # Alternatively, just don't do this and fetch the current object each time. Most
242 # could probably be taken from cache.
243 relevant_activities = Activity.get_all_create_by_object_ap_id(id)
245 Enum.map(relevant_activities, fn activity ->
246 new_activity_data = activity.data |> Map.put("object", object.data)
247 changeset = Changeset.change(activity, data: new_activity_data)
248 Repo.update(changeset)
252 #### Like-related helpers
255 Returns an existing like if a user already liked an object
257 def get_existing_like(actor, %{data: %{"id" => id}}) do
260 activity in Activity,
261 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
262 # this is to use the index
265 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
270 where: fragment("(?)->>'type' = 'Like'", activity.data)
277 Returns like activities targeting an object
279 def get_object_likes(%{data: %{"id" => id}}) do
282 activity in Activity,
283 # this is to use the index
286 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
291 where: fragment("(?)->>'type' = 'Like'", activity.data)
298 %User{ap_id: ap_id} = actor,
299 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
302 object_actor = User.get_cached_by_ap_id(object_actor_id)
305 if Visibility.is_public?(object) do
306 [actor.follower_address, object.data["actor"]]
308 [object.data["actor"]]
312 (object.data["to"] ++ (object.data["cc"] || []))
313 |> List.delete(actor.ap_id)
314 |> List.delete(object_actor.follower_address)
322 "context" => object.data["context"]
325 if activity_id, do: Map.put(data, "id", activity_id), else: data
328 def update_element_in_object(property, element, object) do
331 |> Map.put("#{property}_count", length(element))
332 |> Map.put("#{property}s", element),
333 changeset <- Changeset.change(object, data: new_data),
334 {:ok, object} <- Object.update_and_set_cache(changeset),
335 _ <- update_object_in_activities(object) do
340 def update_likes_in_object(likes, object) do
341 update_element_in_object("like", likes, object)
344 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
345 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
347 with likes <- [actor | likes] |> Enum.uniq() do
348 update_likes_in_object(likes, object)
352 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
353 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
355 with likes <- likes |> List.delete(actor) do
356 update_likes_in_object(likes, object)
360 #### Follow-related helpers
363 Updates a follow activity's state (for locked accounts).
365 def update_follow_state(
366 %Activity{data: %{"actor" => actor, "object" => object, "state" => "pending"}} = activity,
370 Ecto.Adapters.SQL.query!(
372 "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'",
373 [state, actor, object]
376 activity = Activity.get_by_id(activity.id)
384 def update_follow_state(%Activity{} = activity, state) do
387 |> Map.put("state", state),
388 changeset <- Changeset.change(activity, data: new_data),
389 {:ok, activity} <- Repo.update(changeset) do
395 Makes a follow activity data for the given follower and followed
397 def make_follow_data(
398 %User{ap_id: follower_id},
399 %User{ap_id: followed_id} = _followed,
404 "actor" => follower_id,
405 "to" => [followed_id],
406 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
407 "object" => followed_id,
411 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
416 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
419 activity in Activity,
422 "? ->> 'type' = 'Follow'",
425 where: activity.actor == ^follower_id,
426 # this is to use the index
429 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
434 order_by: [fragment("? desc nulls last", activity.id)],
441 #### Announce-related helpers
444 Retruns an existing announce activity if the notice has already been announced
446 def get_existing_announce(actor, %{data: %{"id" => id}}) do
449 activity in Activity,
450 where: activity.actor == ^actor,
451 # this is to use the index
454 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
459 where: fragment("(?)->>'type' = 'Announce'", activity.data)
466 Make announce activity data for the given actor and object
468 # for relayed messages, we only want to send to subscribers
469 def make_announce_data(
470 %User{ap_id: ap_id} = user,
471 %Object{data: %{"id" => id}} = object,
476 "type" => "Announce",
479 "to" => [user.follower_address],
481 "context" => object.data["context"]
484 if activity_id, do: Map.put(data, "id", activity_id), else: data
487 def make_announce_data(
488 %User{ap_id: ap_id} = user,
489 %Object{data: %{"id" => id}} = object,
494 "type" => "Announce",
497 "to" => [user.follower_address, object.data["actor"]],
498 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
499 "context" => object.data["context"]
502 if activity_id, do: Map.put(data, "id", activity_id), else: data
506 Make unannounce activity data for the given actor and object
508 def make_unannounce_data(
509 %User{ap_id: ap_id} = user,
510 %Activity{data: %{"context" => context}} = activity,
516 "object" => activity.data,
517 "to" => [user.follower_address, activity.data["actor"]],
518 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
522 if activity_id, do: Map.put(data, "id", activity_id), else: data
525 def make_unlike_data(
526 %User{ap_id: ap_id} = user,
527 %Activity{data: %{"context" => context}} = activity,
533 "object" => activity.data,
534 "to" => [user.follower_address, activity.data["actor"]],
535 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
539 if activity_id, do: Map.put(data, "id", activity_id), else: data
542 def add_announce_to_object(
544 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
549 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
551 with announcements <- [actor | announcements] |> Enum.uniq() do
552 update_element_in_object("announcement", announcements, object)
556 def add_announce_to_object(_, object), do: {:ok, object}
558 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
560 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
562 with announcements <- announcements |> List.delete(actor) do
563 update_element_in_object("announcement", announcements, object)
567 #### Unfollow-related helpers
569 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
572 "actor" => follower.ap_id,
573 "to" => [followed.ap_id],
574 "object" => follow_activity.data
577 if activity_id, do: Map.put(data, "id", activity_id), else: data
580 #### Block-related helpers
581 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
584 activity in Activity,
587 "? ->> 'type' = 'Block'",
590 where: activity.actor == ^blocker_id,
591 # this is to use the index
594 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
599 order_by: [fragment("? desc nulls last", activity.id)],
606 def make_block_data(blocker, blocked, activity_id) do
609 "actor" => blocker.ap_id,
610 "to" => [blocked.ap_id],
611 "object" => blocked.ap_id
614 if activity_id, do: Map.put(data, "id", activity_id), else: data
617 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
620 "actor" => blocker.ap_id,
621 "to" => [blocked.ap_id],
622 "object" => block_activity.data
625 if activity_id, do: Map.put(data, "id", activity_id), else: data
628 #### Create-related helpers
630 def make_create_data(params, additional) do
631 published = params.published || make_date()
635 "to" => params.to |> Enum.uniq(),
636 "actor" => params.actor.ap_id,
637 "object" => params.object,
638 "published" => published,
639 "context" => params.context
641 |> Map.merge(additional)
644 #### Flag-related helpers
646 def make_flag_data(params, additional) do
648 Enum.map(params.statuses || [], fn
649 %Activity{} = act -> act.data["id"]
650 act when is_map(act) -> act["id"]
651 act when is_binary(act) -> act
654 object = [params.account.ap_id] ++ status_ap_ids
658 "actor" => params.actor.ap_id,
659 "content" => params.content,
661 "context" => params.context
663 |> Map.merge(additional)
667 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
668 the first one to `pages_left` pages.
669 If the amount of pages is higher than the collection has, it returns whatever was there.
671 def fetch_ordered_collection(from, pages_left, acc \\ []) do
672 with {:ok, response} <- Tesla.get(from),
673 {:ok, collection} <- Poison.decode(response.body) do
674 case collection["type"] do
675 "OrderedCollection" ->
676 # If we've encountered the OrderedCollection and not the page,
677 # just call the same function on the page address
678 fetch_ordered_collection(collection["first"], pages_left)
680 "OrderedCollectionPage" ->
682 # There are still more pages
683 if Map.has_key?(collection, "next") do
684 # There are still more pages, go deeper saving what we have into the accumulator
685 fetch_ordered_collection(
688 acc ++ collection["orderedItems"]
691 # No more pages left, just return whatever we already have
692 acc ++ collection["orderedItems"]
695 # Got the amount of pages needed, add them all to the accumulator
696 acc ++ collection["orderedItems"]
700 {:error, "Not an OrderedCollection or OrderedCollectionPage"}