1 defmodule Pleroma.Web.ActivityPub.Utils do
2 alias Pleroma.{Repo, Web, Object, Activity, User, Notification}
3 alias Pleroma.Web.Router.Helpers
4 alias Pleroma.Web.Endpoint
5 alias Ecto.{Changeset, UUID}
9 @supported_object_types ["Article", "Note", "Video", "Page"]
11 # Some implementations send the actor URI as the actor field, others send the entire actor object,
12 # so figure out what the actor's URI is based on what we have.
13 def get_ap_id(object) do
20 def normalize_params(params) do
21 Map.put(params, "actor", get_ap_id(params["actor"]))
24 defp recipient_in_collection(ap_id, coll) when is_binary(coll), do: ap_id == coll
25 defp recipient_in_collection(ap_id, coll) when is_list(coll), do: ap_id in coll
26 defp recipient_in_collection(_, _), do: false
28 def recipient_in_message(ap_id, params) do
30 recipient_in_collection(ap_id, params["to"]) ->
33 recipient_in_collection(ap_id, params["cc"]) ->
36 recipient_in_collection(ap_id, params["bto"]) ->
39 recipient_in_collection(ap_id, params["bcc"]) ->
42 # if the message is unaddressed at all, then assume it is directly addressed
44 !params["to"] && !params["cc"] && !params["bto"] && !params["bcc"] ->
52 defp extract_list(target) when is_binary(target), do: [target]
53 defp extract_list(lst) when is_list(lst), do: lst
54 defp extract_list(_), do: []
56 def maybe_splice_recipient(ap_id, params) do
58 !recipient_in_collection(ap_id, params["to"]) &&
59 !recipient_in_collection(ap_id, params["cc"])
61 cc_list = extract_list(params["cc"])
65 |> Map.put("cc", [ap_id | cc_list])
71 def make_json_ld_header do
74 "https://www.w3.org/ns/activitystreams",
75 "#{Web.base_url()}/schemas/litepub-0.1.jsonld"
81 DateTime.utc_now() |> DateTime.to_iso8601()
84 def generate_activity_id do
85 generate_id("activities")
88 def generate_context_id do
89 generate_id("contexts")
92 def generate_object_id do
93 Helpers.o_status_url(Endpoint, :object, UUID.generate())
96 def generate_id(type) do
97 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
100 def get_notified_from_object(%{"type" => type} = object) when type in @supported_object_types do
101 fake_create_activity = %{
102 "to" => object["to"],
103 "cc" => object["cc"],
108 Notification.get_notified_from_activity(%Activity{data: fake_create_activity}, false)
111 def get_notified_from_object(object) do
112 Notification.get_notified_from_activity(%Activity{data: object}, false)
115 def create_context(context) do
116 context = context || generate_id("contexts")
117 changeset = Object.context_mapping(context)
119 case Repo.insert(changeset) do
123 # This should be solved by an upsert, but it seems ecto
124 # has problems accessing the constraint inside the jsonb.
126 Object.get_cached_by_ap_id(context)
131 Enqueues an activity for federation if it's local
133 def maybe_federate(%Activity{local: true} = activity) do
135 case activity.data["type"] do
141 Pleroma.Web.Federator.enqueue(:publish, activity, priority)
145 def maybe_federate(_), do: :ok
148 Adds an id and a published data if they aren't there,
149 also adds it to an included object
151 def lazy_put_activity_defaults(map) do
152 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
156 |> Map.put_new_lazy("id", &generate_activity_id/0)
157 |> Map.put_new_lazy("published", &make_date/0)
158 |> Map.put_new("context", context)
159 |> Map.put_new("context_id", context_id)
161 if is_map(map["object"]) do
162 object = lazy_put_object_defaults(map["object"], map)
163 %{map | "object" => object}
170 Adds an id and published date if they aren't there.
172 def lazy_put_object_defaults(map, activity \\ %{}) do
174 |> Map.put_new_lazy("id", &generate_object_id/0)
175 |> Map.put_new_lazy("published", &make_date/0)
176 |> Map.put_new("context", activity["context"])
177 |> Map.put_new("context_id", activity["context_id"])
181 Inserts a full object if it is contained in an activity.
183 def insert_full_object(%{"object" => %{"type" => type} = object_data} = map)
184 when is_map(object_data) and type in @supported_object_types do
185 with {:ok, object} <- Object.create(object_data) do
188 |> Map.put("object", object.data["id"])
194 def insert_full_object(map), do: {:ok, map}
196 def update_object_in_activities(%{data: %{"id" => id}} = object) do
198 # Update activities that already had this. Could be done in a seperate process.
199 # Alternatively, just don't do this and fetch the current object each time. Most
200 # could probably be taken from cache.
201 relevant_activities = Activity.all_by_object_ap_id(id)
203 Enum.map(relevant_activities, fn activity ->
204 new_activity_data = activity.data |> Map.put("object", object.data)
205 changeset = Changeset.change(activity, data: new_activity_data)
206 Repo.update(changeset)
210 #### Like-related helpers
213 Returns an existing like if a user already liked an object
215 def get_existing_like(actor, %{data: %{"id" => id}}) do
218 activity in Activity,
219 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
220 # this is to use the index
223 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
228 where: fragment("(?)->>'type' = 'Like'", activity.data)
234 def make_like_data(%User{ap_id: ap_id} = actor, %{data: %{"id" => id}} = object, activity_id) do
239 "to" => [actor.follower_address, object.data["actor"]],
240 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
241 "context" => object.data["context"]
244 if activity_id, do: Map.put(data, "id", activity_id), else: data
247 def update_element_in_object(property, element, object) do
250 |> Map.put("#{property}_count", length(element))
251 |> Map.put("#{property}s", element),
252 changeset <- Changeset.change(object, data: new_data),
253 {:ok, object} <- Repo.update(changeset),
254 _ <- update_object_in_activities(object) do
259 def update_likes_in_object(likes, object) do
260 update_element_in_object("like", likes, object)
263 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
264 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
266 with likes <- [actor | likes] |> Enum.uniq() do
267 update_likes_in_object(likes, object)
271 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
272 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
274 with likes <- likes |> List.delete(actor) do
275 update_likes_in_object(likes, object)
279 #### Follow-related helpers
282 Updates a follow activity's state (for locked accounts).
284 def update_follow_state(%Activity{} = activity, state) do
287 |> Map.put("state", state),
288 changeset <- Changeset.change(activity, data: new_data),
289 {:ok, activity} <- Repo.update(changeset) do
295 Makes a follow activity data for the given follower and followed
297 def make_follow_data(
298 %User{ap_id: follower_id},
299 %User{ap_id: followed_id} = followed,
304 "actor" => follower_id,
305 "to" => [followed_id],
306 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
307 "object" => followed_id,
311 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
316 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
319 activity in Activity,
322 "? ->> 'type' = 'Follow'",
325 where: activity.actor == ^follower_id,
330 ^%{object: followed_id}
332 order_by: [desc: :id],
339 #### Announce-related helpers
342 Retruns an existing announce activity if the notice has already been announced
344 def get_existing_announce(actor, %{data: %{"id" => id}}) do
347 activity in Activity,
348 where: activity.actor == ^actor,
349 # this is to use the index
352 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
357 where: fragment("(?)->>'type' = 'Announce'", activity.data)
364 Make announce activity data for the given actor and object
366 # for relayed messages, we only want to send to subscribers
367 def make_announce_data(
368 %User{ap_id: ap_id, nickname: nil} = user,
369 %Object{data: %{"id" => id}} = object,
373 "type" => "Announce",
376 "to" => [user.follower_address],
378 "context" => object.data["context"]
381 if activity_id, do: Map.put(data, "id", activity_id), else: data
384 def make_announce_data(
385 %User{ap_id: ap_id} = user,
386 %Object{data: %{"id" => id}} = object,
390 "type" => "Announce",
393 "to" => [user.follower_address, object.data["actor"]],
394 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
395 "context" => object.data["context"]
398 if activity_id, do: Map.put(data, "id", activity_id), else: data
402 Make unannounce activity data for the given actor and object
404 def make_unannounce_data(
405 %User{ap_id: ap_id} = user,
406 %Activity{data: %{"context" => context}} = activity,
412 "object" => activity.data,
413 "to" => [user.follower_address, activity.data["actor"]],
414 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
418 if activity_id, do: Map.put(data, "id", activity_id), else: data
421 def make_unlike_data(
422 %User{ap_id: ap_id} = user,
423 %Activity{data: %{"context" => context}} = activity,
429 "object" => activity.data,
430 "to" => [user.follower_address, activity.data["actor"]],
431 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
435 if activity_id, do: Map.put(data, "id", activity_id), else: data
438 def add_announce_to_object(
440 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
445 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
447 with announcements <- [actor | announcements] |> Enum.uniq() do
448 update_element_in_object("announcement", announcements, object)
452 def add_announce_to_object(_, object), do: {:ok, object}
454 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
456 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
458 with announcements <- announcements |> List.delete(actor) do
459 update_element_in_object("announcement", announcements, object)
463 #### Unfollow-related helpers
465 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
468 "actor" => follower.ap_id,
469 "to" => [followed.ap_id],
470 "object" => follow_activity.data
473 if activity_id, do: Map.put(data, "id", activity_id), else: data
476 #### Block-related helpers
477 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
480 activity in Activity,
483 "? ->> 'type' = 'Block'",
486 where: activity.actor == ^blocker_id,
491 ^%{object: blocked_id}
493 order_by: [desc: :id],
500 def make_block_data(blocker, blocked, activity_id) do
503 "actor" => blocker.ap_id,
504 "to" => [blocked.ap_id],
505 "object" => blocked.ap_id
508 if activity_id, do: Map.put(data, "id", activity_id), else: data
511 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
514 "actor" => blocker.ap_id,
515 "to" => [blocked.ap_id],
516 "object" => block_activity.data
519 if activity_id, do: Map.put(data, "id", activity_id), else: data
522 #### Create-related helpers
524 def make_create_data(params, additional) do
525 published = params.published || make_date()
529 "to" => params.to |> Enum.uniq(),
530 "actor" => params.actor.ap_id,
531 "object" => params.object,
532 "published" => published,
533 "context" => params.context
535 |> Map.merge(additional)