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
11 alias Pleroma.Notification
12 alias Pleroma.Web.Router.Helpers
13 alias Pleroma.Web.Endpoint
21 @supported_object_types ["Article", "Note", "Video", "Page"]
23 # Some implementations send the actor URI as the actor field, others send the entire actor object,
24 # so figure out what the actor's URI is based on what we have.
25 def get_ap_id(object) do
32 def normalize_params(params) do
33 Map.put(params, "actor", get_ap_id(params["actor"]))
36 def determine_explicit_mentions(%{"tag" => tag} = _object) when is_list(tag) do
38 |> Enum.filter(fn x -> is_map(x) end)
39 |> Enum.filter(fn x -> x["type"] == "Mention" end)
40 |> Enum.map(fn x -> x["href"] end)
43 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
44 Map.put(object, "tag", [tag])
45 |> determine_explicit_mentions()
48 def determine_explicit_mentions(_), do: []
50 defp recipient_in_collection(ap_id, coll) when is_binary(coll), do: ap_id == coll
51 defp recipient_in_collection(ap_id, coll) when is_list(coll), do: ap_id in coll
52 defp recipient_in_collection(_, _), do: false
54 def recipient_in_message(ap_id, params) do
56 recipient_in_collection(ap_id, params["to"]) ->
59 recipient_in_collection(ap_id, params["cc"]) ->
62 recipient_in_collection(ap_id, params["bto"]) ->
65 recipient_in_collection(ap_id, params["bcc"]) ->
68 # if the message is unaddressed at all, then assume it is directly addressed
70 !params["to"] && !params["cc"] && !params["bto"] && !params["bcc"] ->
78 defp extract_list(target) when is_binary(target), do: [target]
79 defp extract_list(lst) when is_list(lst), do: lst
80 defp extract_list(_), do: []
82 def maybe_splice_recipient(ap_id, params) do
84 !recipient_in_collection(ap_id, params["to"]) &&
85 !recipient_in_collection(ap_id, params["cc"])
87 cc_list = extract_list(params["cc"])
91 |> Map.put("cc", [ap_id | cc_list])
97 def make_json_ld_header do
100 "https://www.w3.org/ns/activitystreams",
101 "#{Web.base_url()}/schemas/litepub-0.1.jsonld"
107 DateTime.utc_now() |> DateTime.to_iso8601()
110 def generate_activity_id do
111 generate_id("activities")
114 def generate_context_id do
115 generate_id("contexts")
118 def generate_object_id do
119 Helpers.o_status_url(Endpoint, :object, UUID.generate())
122 def generate_id(type) do
123 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
126 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
127 fake_create_activity = %{
128 "to" => object["to"],
129 "cc" => object["cc"],
134 Notification.get_notified_from_activity(%Activity{data: fake_create_activity}, false)
137 def get_notified_from_object(object) do
138 Notification.get_notified_from_activity(%Activity{data: object}, false)
141 def create_context(context) do
142 context = context || generate_id("contexts")
143 changeset = Object.context_mapping(context)
145 with {:ok, object} <- Object.insert_or_get(changeset) do
151 Enqueues an activity for federation if it's local
153 def maybe_federate(%Activity{local: true} = activity) do
155 case activity.data["type"] do
161 Pleroma.Web.Federator.enqueue(:publish, activity, priority)
165 def maybe_federate(_), do: :ok
168 Adds an id and a published data if they aren't there,
169 also adds it to an included object
171 def lazy_put_activity_defaults(map) do
172 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
176 |> Map.put_new_lazy("id", &generate_activity_id/0)
177 |> Map.put_new_lazy("published", &make_date/0)
178 |> Map.put_new("context", context)
179 |> Map.put_new("context_id", context_id)
181 if is_map(map["object"]) do
182 object = lazy_put_object_defaults(map["object"], map)
183 %{map | "object" => object}
190 Adds an id and published date if they aren't there.
192 def lazy_put_object_defaults(map, activity \\ %{}) do
194 |> Map.put_new_lazy("id", &generate_object_id/0)
195 |> Map.put_new_lazy("published", &make_date/0)
196 |> Map.put_new("context", activity["context"])
197 |> Map.put_new("context_id", activity["context_id"])
201 Inserts a full object if it is contained in an activity.
203 def insert_full_object(%{"object" => %{"type" => type} = object_data})
204 when is_map(object_data) and type in @supported_object_types do
205 with {:ok, _} <- Object.create(object_data) do
210 def insert_full_object(_), do: :ok
212 def update_object_in_activities(%{data: %{"id" => id}} = object) do
214 # Update activities that already had this. Could be done in a seperate process.
215 # Alternatively, just don't do this and fetch the current object each time. Most
216 # could probably be taken from cache.
217 relevant_activities = Activity.get_all_create_by_object_ap_id(id)
219 Enum.map(relevant_activities, fn activity ->
220 new_activity_data = activity.data |> Map.put("object", object.data)
221 changeset = Changeset.change(activity, data: new_activity_data)
222 Repo.update(changeset)
226 #### Like-related helpers
229 Returns an existing like if a user already liked an object
231 def get_existing_like(actor, %{data: %{"id" => id}}) do
234 activity in Activity,
235 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
236 # this is to use the index
239 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
244 where: fragment("(?)->>'type' = 'Like'", activity.data)
251 Returns like activities targeting an object
253 def get_object_likes(%{data: %{"id" => id}}) do
256 activity in Activity,
257 # this is to use the index
260 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
265 where: fragment("(?)->>'type' = 'Like'", activity.data)
271 def make_like_data(%User{ap_id: ap_id} = actor, %{data: %{"id" => id}} = object, activity_id) do
276 "to" => [actor.follower_address, object.data["actor"]],
277 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
278 "context" => object.data["context"]
281 if activity_id, do: Map.put(data, "id", activity_id), else: data
284 def update_element_in_object(property, element, object) do
287 |> Map.put("#{property}_count", length(element))
288 |> Map.put("#{property}s", element),
289 changeset <- Changeset.change(object, data: new_data),
290 {:ok, object} <- Object.update_and_set_cache(changeset),
291 _ <- update_object_in_activities(object) do
296 def update_likes_in_object(likes, object) do
297 update_element_in_object("like", likes, object)
300 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
301 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
303 with likes <- [actor | likes] |> Enum.uniq() do
304 update_likes_in_object(likes, object)
308 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
309 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
311 with likes <- likes |> List.delete(actor) do
312 update_likes_in_object(likes, object)
316 #### Follow-related helpers
319 Updates a follow activity's state (for locked accounts).
321 def update_follow_state(
322 %Activity{data: %{"actor" => actor, "object" => object, "state" => "pending"}} = activity,
326 Ecto.Adapters.SQL.query!(
328 "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'",
329 [state, actor, object]
332 activity = Repo.get(Activity, activity.id)
340 def update_follow_state(%Activity{} = activity, state) do
343 |> Map.put("state", state),
344 changeset <- Changeset.change(activity, data: new_data),
345 {:ok, activity} <- Repo.update(changeset) do
351 Makes a follow activity data for the given follower and followed
353 def make_follow_data(
354 %User{ap_id: follower_id},
355 %User{ap_id: followed_id} = _followed,
360 "actor" => follower_id,
361 "to" => [followed_id],
362 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
363 "object" => followed_id,
367 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
372 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
375 activity in Activity,
378 "? ->> 'type' = 'Follow'",
381 where: activity.actor == ^follower_id,
386 ^%{object: followed_id}
388 order_by: [desc: :id],
395 #### Announce-related helpers
398 Retruns an existing announce activity if the notice has already been announced
400 def get_existing_announce(actor, %{data: %{"id" => id}}) do
403 activity in Activity,
404 where: activity.actor == ^actor,
405 # this is to use the index
408 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
413 where: fragment("(?)->>'type' = 'Announce'", activity.data)
420 Make announce activity data for the given actor and object
422 # for relayed messages, we only want to send to subscribers
423 def make_announce_data(
424 %User{ap_id: ap_id} = user,
425 %Object{data: %{"id" => id}} = object,
430 "type" => "Announce",
433 "to" => [user.follower_address],
435 "context" => object.data["context"]
438 if activity_id, do: Map.put(data, "id", activity_id), else: data
441 def make_announce_data(
442 %User{ap_id: ap_id} = user,
443 %Object{data: %{"id" => id}} = object,
448 "type" => "Announce",
451 "to" => [user.follower_address, object.data["actor"]],
452 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
453 "context" => object.data["context"]
456 if activity_id, do: Map.put(data, "id", activity_id), else: data
460 Make unannounce activity data for the given actor and object
462 def make_unannounce_data(
463 %User{ap_id: ap_id} = user,
464 %Activity{data: %{"context" => context}} = activity,
470 "object" => activity.data,
471 "to" => [user.follower_address, activity.data["actor"]],
472 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
476 if activity_id, do: Map.put(data, "id", activity_id), else: data
479 def make_unlike_data(
480 %User{ap_id: ap_id} = user,
481 %Activity{data: %{"context" => context}} = activity,
487 "object" => activity.data,
488 "to" => [user.follower_address, activity.data["actor"]],
489 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
493 if activity_id, do: Map.put(data, "id", activity_id), else: data
496 def add_announce_to_object(
498 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
503 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
505 with announcements <- [actor | announcements] |> Enum.uniq() do
506 update_element_in_object("announcement", announcements, object)
510 def add_announce_to_object(_, object), do: {:ok, object}
512 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
514 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
516 with announcements <- announcements |> List.delete(actor) do
517 update_element_in_object("announcement", announcements, object)
521 #### Unfollow-related helpers
523 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
526 "actor" => follower.ap_id,
527 "to" => [followed.ap_id],
528 "object" => follow_activity.data
531 if activity_id, do: Map.put(data, "id", activity_id), else: data
534 #### Block-related helpers
535 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
538 activity in Activity,
541 "? ->> 'type' = 'Block'",
544 where: activity.actor == ^blocker_id,
549 ^%{object: blocked_id}
551 order_by: [desc: :id],
558 def make_block_data(blocker, blocked, activity_id) do
561 "actor" => blocker.ap_id,
562 "to" => [blocked.ap_id],
563 "object" => blocked.ap_id
566 if activity_id, do: Map.put(data, "id", activity_id), else: data
569 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
572 "actor" => blocker.ap_id,
573 "to" => [blocked.ap_id],
574 "object" => block_activity.data
577 if activity_id, do: Map.put(data, "id", activity_id), else: data
580 #### Create-related helpers
582 def make_create_data(params, additional) do
583 published = params.published || make_date()
587 "to" => params.to |> Enum.uniq(),
588 "actor" => params.actor.ap_id,
589 "object" => params.object,
590 "published" => published,
591 "context" => params.context
593 |> Map.merge(additional)