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
180 %{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)
189 if is_map(map["object"]) do
190 object = lazy_put_object_defaults(map["object"], map)
191 %{map | "object" => object}
197 |> Map.put_new("id", "pleroma:fakeid")
198 |> Map.put_new_lazy("published", &make_date/0)
199 |> Map.put_new("context", "pleroma:fakecontext")
200 |> Map.put_new("context_id", -1)
205 Adds an id and published date if they aren't there.
207 def lazy_put_object_defaults(map, activity \\ %{}) do
209 |> Map.put_new_lazy("id", &generate_object_id/0)
210 |> Map.put_new_lazy("published", &make_date/0)
211 |> Map.put_new("context", activity["context"])
212 |> Map.put_new("context_id", activity["context_id"])
216 Inserts a full object if it is contained in an activity.
218 def insert_full_object(%{"object" => %{"type" => type} = object_data})
219 when is_map(object_data) and type in @supported_object_types do
220 with {:ok, object} <- Object.create(object_data) do
225 def insert_full_object(_), do: {:ok, nil}
227 def update_object_in_activities(%{data: %{"id" => id}} = object) do
229 # Update activities that already had this. Could be done in a seperate process.
230 # Alternatively, just don't do this and fetch the current object each time. Most
231 # could probably be taken from cache.
232 relevant_activities = Activity.get_all_create_by_object_ap_id(id)
234 Enum.map(relevant_activities, fn activity ->
235 new_activity_data = activity.data |> Map.put("object", object.data)
236 changeset = Changeset.change(activity, data: new_activity_data)
237 Repo.update(changeset)
241 #### Like-related helpers
244 Returns an existing like if a user already liked an object
246 def get_existing_like(actor, %{data: %{"id" => id}}) do
249 activity in Activity,
250 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
251 # this is to use the index
254 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
259 where: fragment("(?)->>'type' = 'Like'", activity.data)
266 Returns like activities targeting an object
268 def get_object_likes(%{data: %{"id" => id}}) do
271 activity in Activity,
272 # this is to use the index
275 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
280 where: fragment("(?)->>'type' = 'Like'", activity.data)
287 %User{ap_id: ap_id} = actor,
288 %{data: %{"actor" => object_actor_id, "id" => id}} = object,
291 object_actor = User.get_cached_by_ap_id(object_actor_id)
294 if Visibility.is_public?(object) do
295 [actor.follower_address, object.data["actor"]]
297 [object.data["actor"]]
301 (object.data["to"] ++ (object.data["cc"] || []))
302 |> List.delete(actor.ap_id)
303 |> List.delete(object_actor.follower_address)
311 "context" => object.data["context"]
314 if activity_id, do: Map.put(data, "id", activity_id), else: data
317 def update_element_in_object(property, element, object) do
320 |> Map.put("#{property}_count", length(element))
321 |> Map.put("#{property}s", element),
322 changeset <- Changeset.change(object, data: new_data),
323 {:ok, object} <- Object.update_and_set_cache(changeset),
324 _ <- update_object_in_activities(object) do
329 def update_likes_in_object(likes, object) do
330 update_element_in_object("like", likes, object)
333 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
334 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
336 with likes <- [actor | likes] |> Enum.uniq() do
337 update_likes_in_object(likes, object)
341 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
342 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
344 with likes <- likes |> List.delete(actor) do
345 update_likes_in_object(likes, object)
349 #### Follow-related helpers
352 Updates a follow activity's state (for locked accounts).
354 def update_follow_state(
355 %Activity{data: %{"actor" => actor, "object" => object, "state" => "pending"}} = activity,
359 Ecto.Adapters.SQL.query!(
361 "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'",
362 [state, actor, object]
365 activity = Repo.get(Activity, activity.id)
373 def update_follow_state(%Activity{} = activity, state) do
376 |> Map.put("state", state),
377 changeset <- Changeset.change(activity, data: new_data),
378 {:ok, activity} <- Repo.update(changeset) do
384 Makes a follow activity data for the given follower and followed
386 def make_follow_data(
387 %User{ap_id: follower_id},
388 %User{ap_id: followed_id} = _followed,
393 "actor" => follower_id,
394 "to" => [followed_id],
395 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
396 "object" => followed_id,
400 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
405 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
408 activity in Activity,
411 "? ->> 'type' = 'Follow'",
414 where: activity.actor == ^follower_id,
419 ^%{object: followed_id}
421 order_by: [desc: :id],
428 #### Announce-related helpers
431 Retruns an existing announce activity if the notice has already been announced
433 def get_existing_announce(actor, %{data: %{"id" => id}}) do
436 activity in Activity,
437 where: activity.actor == ^actor,
438 # this is to use the index
441 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
446 where: fragment("(?)->>'type' = 'Announce'", activity.data)
453 Make announce activity data for the given actor and object
455 # for relayed messages, we only want to send to subscribers
456 def make_announce_data(
457 %User{ap_id: ap_id} = user,
458 %Object{data: %{"id" => id}} = object,
463 "type" => "Announce",
466 "to" => [user.follower_address],
468 "context" => object.data["context"]
471 if activity_id, do: Map.put(data, "id", activity_id), else: data
474 def make_announce_data(
475 %User{ap_id: ap_id} = user,
476 %Object{data: %{"id" => id}} = object,
481 "type" => "Announce",
484 "to" => [user.follower_address, object.data["actor"]],
485 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
486 "context" => object.data["context"]
489 if activity_id, do: Map.put(data, "id", activity_id), else: data
493 Make unannounce activity data for the given actor and object
495 def make_unannounce_data(
496 %User{ap_id: ap_id} = user,
497 %Activity{data: %{"context" => context}} = activity,
503 "object" => activity.data,
504 "to" => [user.follower_address, activity.data["actor"]],
505 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
509 if activity_id, do: Map.put(data, "id", activity_id), else: data
512 def make_unlike_data(
513 %User{ap_id: ap_id} = user,
514 %Activity{data: %{"context" => context}} = activity,
520 "object" => activity.data,
521 "to" => [user.follower_address, activity.data["actor"]],
522 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
526 if activity_id, do: Map.put(data, "id", activity_id), else: data
529 def add_announce_to_object(
531 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
536 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
538 with announcements <- [actor | announcements] |> Enum.uniq() do
539 update_element_in_object("announcement", announcements, object)
543 def add_announce_to_object(_, object), do: {:ok, object}
545 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
547 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
549 with announcements <- announcements |> List.delete(actor) do
550 update_element_in_object("announcement", announcements, object)
554 #### Unfollow-related helpers
556 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
559 "actor" => follower.ap_id,
560 "to" => [followed.ap_id],
561 "object" => follow_activity.data
564 if activity_id, do: Map.put(data, "id", activity_id), else: data
567 #### Block-related helpers
568 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
571 activity in Activity,
574 "? ->> 'type' = 'Block'",
577 where: activity.actor == ^blocker_id,
582 ^%{object: blocked_id}
584 order_by: [desc: :id],
591 def make_block_data(blocker, blocked, activity_id) do
594 "actor" => blocker.ap_id,
595 "to" => [blocked.ap_id],
596 "object" => blocked.ap_id
599 if activity_id, do: Map.put(data, "id", activity_id), else: data
602 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
605 "actor" => blocker.ap_id,
606 "to" => [blocked.ap_id],
607 "object" => block_activity.data
610 if activity_id, do: Map.put(data, "id", activity_id), else: data
613 #### Create-related helpers
615 def make_create_data(params, additional) do
616 published = params.published || make_date()
620 "to" => params.to |> Enum.uniq(),
621 "actor" => params.actor.ap_id,
622 "object" => params.object,
623 "published" => published,
624 "context" => params.context
626 |> Map.merge(additional)
629 #### Flag-related helpers
631 def make_flag_data(params, additional) do
633 Enum.map(params.statuses || [], fn
634 %Activity{} = act -> act.data["id"]
635 act when is_map(act) -> act["id"]
636 act when is_binary(act) -> act
639 object = [params.account.ap_id] ++ status_ap_ids
643 "actor" => params.actor.ap_id,
644 "content" => params.content,
646 "context" => params.context
648 |> Map.merge(additional)
652 Fetches the OrderedCollection/OrderedCollectionPage from `from`, limiting the amount of pages fetched after
653 the first one to `pages_left` pages.
654 If the amount of pages is higher than the collection has, it returns whatever was there.
656 def fetch_ordered_collection(from, pages_left, acc \\ []) do
657 with {:ok, response} <- Tesla.get(from),
658 {:ok, collection} <- Poison.decode(response.body) do
659 case collection["type"] do
660 "OrderedCollection" ->
661 # If we've encountered the OrderedCollection and not the page,
662 # just call the same function on the page address
663 fetch_ordered_collection(collection["first"], pages_left)
665 "OrderedCollectionPage" ->
667 # There are still more pages
668 if Map.has_key?(collection, "next") do
669 # There are still more pages, go deeper saving what we have into the accumulator
670 fetch_ordered_collection(
673 acc ++ collection["orderedItems"]
676 # No more pages left, just return whatever we already have
677 acc ++ collection["orderedItems"]
680 # Got the amount of pages needed, add them all to the accumulator
681 acc ++ collection["orderedItems"]
685 {:error, "Not an OrderedCollection or OrderedCollectionPage"}