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(%User{ap_id: ap_id} = recipient, %User{} = actor, 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"] ->
74 # if the message is sent from somebody the user is following, then assume it
75 # is addressed to the recipient
76 User.following?(recipient, actor) ->
84 defp extract_list(target) when is_binary(target), do: [target]
85 defp extract_list(lst) when is_list(lst), do: lst
86 defp extract_list(_), do: []
88 def maybe_splice_recipient(ap_id, params) do
90 !recipient_in_collection(ap_id, params["to"]) &&
91 !recipient_in_collection(ap_id, params["cc"])
93 cc_list = extract_list(params["cc"])
97 |> Map.put("cc", [ap_id | cc_list])
103 def make_json_ld_header do
106 "https://www.w3.org/ns/activitystreams",
107 "#{Web.base_url()}/schemas/litepub-0.1.jsonld",
116 DateTime.utc_now() |> DateTime.to_iso8601()
119 def generate_activity_id do
120 generate_id("activities")
123 def generate_context_id do
124 generate_id("contexts")
127 def generate_object_id do
128 Helpers.o_status_url(Endpoint, :object, UUID.generate())
131 def generate_id(type) do
132 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
135 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
136 fake_create_activity = %{
137 "to" => object["to"],
138 "cc" => object["cc"],
143 Notification.get_notified_from_activity(%Activity{data: fake_create_activity}, false)
146 def get_notified_from_object(object) do
147 Notification.get_notified_from_activity(%Activity{data: object}, false)
150 def create_context(context) do
151 context = context || generate_id("contexts")
152 changeset = Object.context_mapping(context)
154 case Repo.insert(changeset) do
158 # This should be solved by an upsert, but it seems ecto
159 # has problems accessing the constraint inside the jsonb.
161 Object.get_cached_by_ap_id(context)
166 Enqueues an activity for federation if it's local
168 def maybe_federate(%Activity{local: true} = activity) do
170 case activity.data["type"] do
176 Pleroma.Web.Federator.publish(activity, priority)
180 def maybe_federate(_), do: :ok
183 Adds an id and a published data if they aren't there,
184 also adds it to an included object
186 def lazy_put_activity_defaults(map, fake \\ false) do
189 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
192 |> Map.put_new_lazy("id", &generate_activity_id/0)
193 |> Map.put_new_lazy("published", &make_date/0)
194 |> Map.put_new("context", context)
195 |> Map.put_new("context_id", context_id)
198 |> Map.put_new("id", "pleroma:fakeid")
199 |> Map.put_new_lazy("published", &make_date/0)
200 |> Map.put_new("context", "pleroma:fakecontext")
201 |> Map.put_new("context_id", -1)
204 if is_map(map["object"]) do
205 object = lazy_put_object_defaults(map["object"], map, fake)
206 %{map | "object" => object}
213 Adds an id and published date if they aren't there.
215 def lazy_put_object_defaults(map, activity \\ %{}, fake)
217 def lazy_put_object_defaults(map, activity, true = _fake) do
219 |> Map.put_new_lazy("published", &make_date/0)
220 |> Map.put_new("id", "pleroma:fake_object_id")
221 |> Map.put_new("context", activity["context"])
222 |> Map.put_new("fake", true)
223 |> Map.put_new("context_id", activity["context_id"])
226 def lazy_put_object_defaults(map, activity, _fake) do
228 |> Map.put_new_lazy("id", &generate_object_id/0)
229 |> Map.put_new_lazy("published", &make_date/0)
230 |> Map.put_new("context", activity["context"])
231 |> Map.put_new("context_id", activity["context_id"])
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 def update_object_in_activities(%{data: %{"id" => id}} = object) do
252 # Update activities that already had this. Could be done in a seperate process.
253 # Alternatively, just don't do this and fetch the current object each time. Most
254 # could probably be taken from cache.
255 relevant_activities = Activity.get_all_create_by_object_ap_id(id)
257 Enum.map(relevant_activities, fn activity ->
258 new_activity_data = activity.data |> Map.put("object", object.data)
259 changeset = Changeset.change(activity, data: new_activity_data)
260 Repo.update(changeset)
264 #### Like-related helpers
267 Returns an existing like if a user already liked an object
269 def get_existing_like(actor, %{data: %{"id" => id}}) do
272 activity in Activity,
273 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
274 # this is to use the index
277 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
282 where: fragment("(?)->>'type' = 'Like'", activity.data)
289 Returns like activities targeting an object
291 def get_object_likes(%{data: %{"id" => id}}) do
294 activity in Activity,
295 # this is to use the index
298 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
303 where: fragment("(?)->>'type' = 'Like'", activity.data)
310 %User{ap_id: ap_id} = actor,
311 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
314 object_actor = User.get_cached_by_ap_id(object_actor_id)
317 if Visibility.is_public?(object) do
318 [actor.follower_address, object.data["actor"]]
320 [object.data["actor"]]
324 (object.data["to"] ++ (object.data["cc"] || []))
325 |> List.delete(actor.ap_id)
326 |> List.delete(object_actor.follower_address)
334 "context" => object.data["context"]
337 if activity_id, do: Map.put(data, "id", activity_id), else: data
340 def update_element_in_object(property, element, object) do
343 |> Map.put("#{property}_count", length(element))
344 |> Map.put("#{property}s", element),
345 changeset <- Changeset.change(object, data: new_data),
346 {:ok, object} <- Object.update_and_set_cache(changeset),
347 _ <- update_object_in_activities(object) do
352 def update_likes_in_object(likes, object) do
353 update_element_in_object("like", likes, object)
356 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
357 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
359 with likes <- [actor | likes] |> Enum.uniq() do
360 update_likes_in_object(likes, object)
364 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
365 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
367 with likes <- likes |> List.delete(actor) do
368 update_likes_in_object(likes, object)
372 #### Follow-related helpers
375 Updates a follow activity's state (for locked accounts).
377 def update_follow_state(
378 %Activity{data: %{"actor" => actor, "object" => object, "state" => "pending"}} = activity,
382 Ecto.Adapters.SQL.query!(
384 "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'",
385 [state, actor, object]
388 activity = Activity.get_by_id(activity.id)
396 def update_follow_state(%Activity{} = activity, state) do
399 |> Map.put("state", state),
400 changeset <- Changeset.change(activity, data: new_data),
401 {:ok, activity} <- Repo.update(changeset) do
407 Makes a follow activity data for the given follower and followed
409 def make_follow_data(
410 %User{ap_id: follower_id},
411 %User{ap_id: followed_id} = _followed,
416 "actor" => follower_id,
417 "to" => [followed_id],
418 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
419 "object" => followed_id,
423 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
428 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
431 activity in Activity,
434 "? ->> 'type' = 'Follow'",
437 where: activity.actor == ^follower_id,
438 # this is to use the index
441 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
446 order_by: [fragment("? desc nulls last", activity.id)],
453 #### Announce-related helpers
456 Retruns an existing announce activity if the notice has already been announced
458 def get_existing_announce(actor, %{data: %{"id" => id}}) do
461 activity in Activity,
462 where: activity.actor == ^actor,
463 # this is to use the index
466 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
471 where: fragment("(?)->>'type' = 'Announce'", activity.data)
478 Make announce activity data for the given actor and object
480 # for relayed messages, we only want to send to subscribers
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],
493 "context" => object.data["context"]
496 if activity_id, do: Map.put(data, "id", activity_id), else: data
499 def make_announce_data(
500 %User{ap_id: ap_id} = user,
501 %Object{data: %{"id" => id}} = object,
506 "type" => "Announce",
509 "to" => [user.follower_address, object.data["actor"]],
510 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
511 "context" => object.data["context"]
514 if activity_id, do: Map.put(data, "id", activity_id), else: data
518 Make unannounce activity data for the given actor and object
520 def make_unannounce_data(
521 %User{ap_id: ap_id} = user,
522 %Activity{data: %{"context" => context}} = activity,
528 "object" => activity.data,
529 "to" => [user.follower_address, activity.data["actor"]],
530 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
534 if activity_id, do: Map.put(data, "id", activity_id), else: data
537 def make_unlike_data(
538 %User{ap_id: ap_id} = user,
539 %Activity{data: %{"context" => context}} = activity,
545 "object" => activity.data,
546 "to" => [user.follower_address, activity.data["actor"]],
547 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
551 if activity_id, do: Map.put(data, "id", activity_id), else: data
554 def add_announce_to_object(
556 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
561 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
563 with announcements <- [actor | announcements] |> Enum.uniq() do
564 update_element_in_object("announcement", announcements, object)
568 def add_announce_to_object(_, object), do: {:ok, object}
570 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
572 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
574 with announcements <- announcements |> List.delete(actor) do
575 update_element_in_object("announcement", announcements, object)
579 #### Unfollow-related helpers
581 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
584 "actor" => follower.ap_id,
585 "to" => [followed.ap_id],
586 "object" => follow_activity.data
589 if activity_id, do: Map.put(data, "id", activity_id), else: data
592 #### Block-related helpers
593 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
596 activity in Activity,
599 "? ->> 'type' = 'Block'",
602 where: activity.actor == ^blocker_id,
603 # this is to use the index
606 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
611 order_by: [fragment("? desc nulls last", activity.id)],
618 def make_block_data(blocker, blocked, activity_id) do
621 "actor" => blocker.ap_id,
622 "to" => [blocked.ap_id],
623 "object" => blocked.ap_id
626 if activity_id, do: Map.put(data, "id", activity_id), else: data
629 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
632 "actor" => blocker.ap_id,
633 "to" => [blocked.ap_id],
634 "object" => block_activity.data
637 if activity_id, do: Map.put(data, "id", activity_id), else: data
640 #### Create-related helpers
642 def make_create_data(params, additional) do
643 published = params.published || make_date()
647 "to" => params.to |> Enum.uniq(),
648 "actor" => params.actor.ap_id,
649 "object" => params.object,
650 "published" => published,
651 "context" => params.context
653 |> Map.merge(additional)
656 #### Flag-related helpers
658 def make_flag_data(params, additional) do
660 Enum.map(params.statuses || [], fn
661 %Activity{} = act -> act.data["id"]
662 act when is_map(act) -> act["id"]
663 act when is_binary(act) -> act
666 object = [params.account.ap_id] ++ status_ap_ids
670 "actor" => params.actor.ap_id,
671 "content" => params.content,
673 "context" => params.context
675 |> Map.merge(additional)
679 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
680 the first one to `pages_left` pages.
681 If the amount of pages is higher than the collection has, it returns whatever was there.
683 def fetch_ordered_collection(from, pages_left, acc \\ []) do
684 with {:ok, response} <- Tesla.get(from),
685 {:ok, collection} <- Jason.decode(response.body) do
686 case collection["type"] do
687 "OrderedCollection" ->
688 # If we've encountered the OrderedCollection and not the page,
689 # just call the same function on the page address
690 fetch_ordered_collection(collection["first"], pages_left)
692 "OrderedCollectionPage" ->
694 # There are still more pages
695 if Map.has_key?(collection, "next") do
696 # There are still more pages, go deeper saving what we have into the accumulator
697 fetch_ordered_collection(
700 acc ++ collection["orderedItems"]
703 # No more pages left, just return whatever we already have
704 acc ++ collection["orderedItems"]
707 # Got the amount of pages needed, add them all to the accumulator
708 acc ++ collection["orderedItems"]
712 {:error, "Not an OrderedCollection or OrderedCollectionPage"}