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
6 alias Pleroma.{Repo, Web, Object, Activity, User, Notification}
7 alias Pleroma.Web.Router.Helpers
8 alias Pleroma.Web.Endpoint
9 alias Ecto.{Changeset, UUID}
13 @supported_object_types ["Article", "Note", "Video", "Page"]
15 # Some implementations send the actor URI as the actor field, others send the entire actor object,
16 # so figure out what the actor's URI is based on what we have.
17 def get_ap_id(object) do
24 def normalize_params(params) do
25 Map.put(params, "actor", get_ap_id(params["actor"]))
28 def determine_explicit_mentions(%{"tag" => tag} = _object) when is_list(tag) do
30 |> Enum.filter(fn x -> is_map(x) end)
31 |> Enum.filter(fn x -> x["type"] == "Mention" end)
32 |> Enum.map(fn x -> x["href"] end)
35 def determine_explicit_mentions(%{"tag" => tag} = object) when is_map(tag) do
36 Map.put(object, "tag", [tag])
37 |> determine_explicit_mentions()
40 def determine_explicit_mentions(_), do: []
42 defp recipient_in_collection(ap_id, coll) when is_binary(coll), do: ap_id == coll
43 defp recipient_in_collection(ap_id, coll) when is_list(coll), do: ap_id in coll
44 defp recipient_in_collection(_, _), do: false
46 def recipient_in_message(ap_id, params) do
48 recipient_in_collection(ap_id, params["to"]) ->
51 recipient_in_collection(ap_id, params["cc"]) ->
54 recipient_in_collection(ap_id, params["bto"]) ->
57 recipient_in_collection(ap_id, params["bcc"]) ->
60 # if the message is unaddressed at all, then assume it is directly addressed
62 !params["to"] && !params["cc"] && !params["bto"] && !params["bcc"] ->
70 defp extract_list(target) when is_binary(target), do: [target]
71 defp extract_list(lst) when is_list(lst), do: lst
72 defp extract_list(_), do: []
74 def maybe_splice_recipient(ap_id, params) do
76 !recipient_in_collection(ap_id, params["to"]) &&
77 !recipient_in_collection(ap_id, params["cc"])
79 cc_list = extract_list(params["cc"])
83 |> Map.put("cc", [ap_id | cc_list])
89 def make_json_ld_header do
92 "https://www.w3.org/ns/activitystreams",
93 "#{Web.base_url()}/schemas/litepub-0.1.jsonld"
99 DateTime.utc_now() |> DateTime.to_iso8601()
102 def generate_activity_id do
103 generate_id("activities")
106 def generate_context_id do
107 generate_id("contexts")
110 def generate_object_id do
111 Helpers.o_status_url(Endpoint, :object, UUID.generate())
114 def generate_id(type) do
115 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
118 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
119 fake_create_activity = %{
120 "to" => object["to"],
121 "cc" => object["cc"],
126 Notification.get_notified_from_activity(%Activity{data: fake_create_activity}, false)
129 def get_notified_from_object(object) do
130 Notification.get_notified_from_activity(%Activity{data: object}, false)
133 def create_context(context) do
134 context = context || generate_id("contexts")
135 changeset = Object.context_mapping(context)
137 with {:ok, object} <- Object.insert_or_get(changeset) do
143 Enqueues an activity for federation if it's local
145 def maybe_federate(%Activity{local: true} = activity) do
147 case activity.data["type"] do
153 Pleroma.Web.Federator.enqueue(:publish, activity, priority)
157 def maybe_federate(_), do: :ok
160 Adds an id and a published data if they aren't there,
161 also adds it to an included object
163 def lazy_put_activity_defaults(map) do
164 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
168 |> Map.put_new_lazy("id", &generate_activity_id/0)
169 |> Map.put_new_lazy("published", &make_date/0)
170 |> Map.put_new("context", context)
171 |> Map.put_new("context_id", context_id)
173 if is_map(map["object"]) do
174 object = lazy_put_object_defaults(map["object"], map)
175 %{map | "object" => object}
182 Adds an id and published date if they aren't there.
184 def lazy_put_object_defaults(map, activity \\ %{}) do
186 |> Map.put_new_lazy("id", &generate_object_id/0)
187 |> Map.put_new_lazy("published", &make_date/0)
188 |> Map.put_new("context", activity["context"])
189 |> Map.put_new("context_id", activity["context_id"])
193 Inserts a full object if it is contained in an activity.
195 def insert_full_object(%{"object" => %{"type" => type} = object_data})
196 when is_map(object_data) and type in @supported_object_types do
197 with {:ok, _} <- Object.create(object_data) do
202 def insert_full_object(_), do: :ok
204 def update_object_in_activities(%{data: %{"id" => id}} = object) do
206 # Update activities that already had this. Could be done in a seperate process.
207 # Alternatively, just don't do this and fetch the current object each time. Most
208 # could probably be taken from cache.
209 relevant_activities = Activity.get_all_create_by_object_ap_id(id)
211 Enum.map(relevant_activities, fn activity ->
212 new_activity_data = activity.data |> Map.put("object", object.data)
213 changeset = Changeset.change(activity, data: new_activity_data)
214 Repo.update(changeset)
218 #### Like-related helpers
221 Returns an existing like if a user already liked an object
223 def get_existing_like(actor, %{data: %{"id" => id}}) do
226 activity in Activity,
227 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
228 # this is to use the index
231 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
236 where: fragment("(?)->>'type' = 'Like'", activity.data)
243 Returns like activities targeting an object
245 def get_object_likes(%{data: %{"id" => id}}) do
248 activity in Activity,
249 # this is to use the index
252 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
257 where: fragment("(?)->>'type' = 'Like'", activity.data)
263 def make_like_data(%User{ap_id: ap_id} = actor, %{data: %{"id" => id}} = object, activity_id) do
268 "to" => [actor.follower_address, object.data["actor"]],
269 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
270 "context" => object.data["context"]
273 if activity_id, do: Map.put(data, "id", activity_id), else: data
276 def update_element_in_object(property, element, object) do
279 |> Map.put("#{property}_count", length(element))
280 |> Map.put("#{property}s", element),
281 changeset <- Changeset.change(object, data: new_data),
282 {:ok, object} <- Object.update_and_set_cache(changeset),
283 _ <- update_object_in_activities(object) do
288 def update_likes_in_object(likes, object) do
289 update_element_in_object("like", likes, object)
292 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
293 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
295 with likes <- [actor | likes] |> Enum.uniq() do
296 update_likes_in_object(likes, object)
300 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
301 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
303 with likes <- likes |> List.delete(actor) do
304 update_likes_in_object(likes, object)
308 #### Follow-related helpers
311 Updates a follow activity's state (for locked accounts).
313 def update_follow_state(
314 %Activity{data: %{"actor" => actor, "object" => object, "state" => "pending"}} = activity,
318 Ecto.Adapters.SQL.query!(
320 "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'",
321 [state, actor, object]
324 activity = Repo.get(Activity, activity.id)
332 def update_follow_state(%Activity{} = activity, state) do
335 |> Map.put("state", state),
336 changeset <- Changeset.change(activity, data: new_data),
337 {:ok, activity} <- Repo.update(changeset) do
343 Makes a follow activity data for the given follower and followed
345 def make_follow_data(
346 %User{ap_id: follower_id},
347 %User{ap_id: followed_id} = _followed,
352 "actor" => follower_id,
353 "to" => [followed_id],
354 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
355 "object" => followed_id,
359 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
364 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
367 activity in Activity,
370 "? ->> 'type' = 'Follow'",
373 where: activity.actor == ^follower_id,
378 ^%{object: followed_id}
380 order_by: [desc: :id],
387 #### Announce-related helpers
390 Retruns an existing announce activity if the notice has already been announced
392 def get_existing_announce(actor, %{data: %{"id" => id}}) do
395 activity in Activity,
396 where: activity.actor == ^actor,
397 # this is to use the index
400 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
405 where: fragment("(?)->>'type' = 'Announce'", activity.data)
412 Make announce activity data for the given actor and object
414 # for relayed messages, we only want to send to subscribers
415 def make_announce_data(
416 %User{ap_id: ap_id} = user,
417 %Object{data: %{"id" => id}} = object,
422 "type" => "Announce",
425 "to" => [user.follower_address],
427 "context" => object.data["context"]
430 if activity_id, do: Map.put(data, "id", activity_id), else: data
433 def make_announce_data(
434 %User{ap_id: ap_id} = user,
435 %Object{data: %{"id" => id}} = object,
440 "type" => "Announce",
443 "to" => [user.follower_address, object.data["actor"]],
444 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
445 "context" => object.data["context"]
448 if activity_id, do: Map.put(data, "id", activity_id), else: data
452 Make unannounce activity data for the given actor and object
454 def make_unannounce_data(
455 %User{ap_id: ap_id} = user,
456 %Activity{data: %{"context" => context}} = activity,
462 "object" => activity.data,
463 "to" => [user.follower_address, activity.data["actor"]],
464 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
468 if activity_id, do: Map.put(data, "id", activity_id), else: data
471 def make_unlike_data(
472 %User{ap_id: ap_id} = user,
473 %Activity{data: %{"context" => context}} = activity,
479 "object" => activity.data,
480 "to" => [user.follower_address, activity.data["actor"]],
481 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
485 if activity_id, do: Map.put(data, "id", activity_id), else: data
488 def add_announce_to_object(
490 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
495 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
497 with announcements <- [actor | announcements] |> Enum.uniq() do
498 update_element_in_object("announcement", announcements, object)
502 def add_announce_to_object(_, object), do: {:ok, object}
504 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
506 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
508 with announcements <- announcements |> List.delete(actor) do
509 update_element_in_object("announcement", announcements, object)
513 #### Unfollow-related helpers
515 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
518 "actor" => follower.ap_id,
519 "to" => [followed.ap_id],
520 "object" => follow_activity.data
523 if activity_id, do: Map.put(data, "id", activity_id), else: data
526 #### Block-related helpers
527 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
530 activity in Activity,
533 "? ->> 'type' = 'Block'",
536 where: activity.actor == ^blocker_id,
541 ^%{object: blocked_id}
543 order_by: [desc: :id],
550 def make_block_data(blocker, blocked, activity_id) do
553 "actor" => blocker.ap_id,
554 "to" => [blocked.ap_id],
555 "object" => blocked.ap_id
558 if activity_id, do: Map.put(data, "id", activity_id), else: data
561 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
564 "actor" => blocker.ap_id,
565 "to" => [blocked.ap_id],
566 "object" => block_activity.data
569 if activity_id, do: Map.put(data, "id", activity_id), else: data
572 #### Create-related helpers
574 def make_create_data(params, additional) do
575 published = params.published || make_date()
579 "to" => params.to |> Enum.uniq(),
580 "actor" => params.actor.ap_id,
581 "object" => params.object,
582 "published" => published,
583 "context" => params.context
585 |> Map.merge(additional)