1 defmodule Pleroma.Web.ActivityPub.Utils do
2 alias Pleroma.{Repo, Web, Object, Activity, User}
3 alias Pleroma.Web.Router.Helpers
4 alias Pleroma.Web.Endpoint
5 alias Ecto.{Changeset, UUID}
9 # Some implementations send the actor URI as the actor field, others send the entire actor object,
10 # so figure out what the actor's URI is based on what we have.
11 def get_ap_id(object) do
18 def normalize_params(params) do
19 Map.put(params, "actor", get_ap_id(params["actor"]))
22 defp recipient_in_collection(ap_id, coll) when is_binary(coll), do: ap_id == coll
23 defp recipient_in_collection(ap_id, coll) when is_list(coll), do: ap_id in coll
24 defp recipient_in_collection(_, _), do: false
26 def recipient_in_message(ap_id, params) do
28 recipient_in_collection(ap_id, params["to"]) ->
31 recipient_in_collection(ap_id, params["cc"]) ->
34 recipient_in_collection(ap_id, params["bto"]) ->
37 recipient_in_collection(ap_id, params["bcc"]) ->
40 # if the message is unaddressed at all, then assume it is directly addressed
42 !params["to"] && !params["cc"] && !params["bto"] && !params["bcc"] ->
50 defp extract_list(target) when is_binary(target), do: [target]
51 defp extract_list(lst) when is_list(lst), do: lst
52 defp extract_list(_), do: []
54 def maybe_splice_recipient(ap_id, params) do
56 !recipient_in_collection(ap_id, params["to"]) &&
57 !recipient_in_collection(ap_id, params["cc"])
59 cc_list = extract_list(params["cc"])
63 |> Map.put("cc", [ap_id | cc_list])
69 def make_json_ld_header do
72 "https://www.w3.org/ns/activitystreams",
73 "https://w3id.org/security/v1",
75 "manuallyApprovesFollowers" => "as:manuallyApprovesFollowers",
76 "sensitive" => "as:sensitive",
77 "Hashtag" => "as:Hashtag",
78 "ostatus" => "http://ostatus.org#",
79 "atomUri" => "ostatus:atomUri",
80 "inReplyToAtomUri" => "ostatus:inReplyToAtomUri",
81 "conversation" => "ostatus:conversation",
82 "toot" => "http://joinmastodon.org/ns#",
83 "Emoji" => "toot:Emoji"
90 DateTime.utc_now() |> DateTime.to_iso8601()
93 def generate_activity_id do
94 generate_id("activities")
97 def generate_context_id do
98 generate_id("contexts")
101 def generate_object_id do
102 Helpers.o_status_url(Endpoint, :object, UUID.generate())
105 def generate_id(type) do
106 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
109 def create_context(context) do
110 context = context || generate_id("contexts")
111 changeset = Object.context_mapping(context)
113 case Repo.insert(changeset) do
117 # This should be solved by an upsert, but it seems ecto
118 # has problems accessing the constraint inside the jsonb.
120 Object.get_cached_by_ap_id(context)
125 Enqueues an activity for federation if it's local
127 def maybe_federate(%Activity{local: true} = activity) do
129 case activity.data["type"] do
135 Pleroma.Web.Federator.enqueue(:publish, activity, priority)
139 def maybe_federate(_), do: :ok
142 Adds an id and a published data if they aren't there,
143 also adds it to an included object
145 def lazy_put_activity_defaults(map) do
146 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
150 |> Map.put_new_lazy("id", &generate_activity_id/0)
151 |> Map.put_new_lazy("published", &make_date/0)
152 |> Map.put_new("context", context)
153 |> Map.put_new("context_id", context_id)
155 if is_map(map["object"]) do
156 object = lazy_put_object_defaults(map["object"], map)
157 %{map | "object" => object}
164 Adds an id and published date if they aren't there.
166 def lazy_put_object_defaults(map, activity \\ %{}) do
168 |> Map.put_new_lazy("id", &generate_object_id/0)
169 |> Map.put_new_lazy("published", &make_date/0)
170 |> Map.put_new("context", activity["context"])
171 |> Map.put_new("context_id", activity["context_id"])
175 Inserts a full object if it is contained in an activity.
177 def insert_full_object(%{"object" => %{"type" => type} = object_data})
178 when is_map(object_data) and type in ["Article", "Note", "Video"] do
179 with {:ok, _} <- Object.create(object_data) do
184 def insert_full_object(_), do: :ok
186 def update_object_in_activities(%{data: %{"id" => id}} = object) do
188 # Update activities that already had this. Could be done in a seperate process.
189 # Alternatively, just don't do this and fetch the current object each time. Most
190 # could probably be taken from cache.
191 relevant_activities = Activity.all_by_object_ap_id(id)
193 Enum.map(relevant_activities, fn activity ->
194 new_activity_data = activity.data |> Map.put("object", object.data)
195 changeset = Changeset.change(activity, data: new_activity_data)
196 Repo.update(changeset)
200 #### Like-related helpers
203 Returns an existing like if a user already liked an object
205 def get_existing_like(actor, %{data: %{"id" => id}}) do
208 activity in Activity,
209 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
210 # this is to use the index
213 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
218 where: fragment("(?)->>'type' = 'Like'", activity.data)
224 def make_like_data(%User{ap_id: ap_id} = actor, %{data: %{"id" => id}} = object, activity_id) do
229 "to" => [actor.follower_address, object.data["actor"]],
230 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
231 "context" => object.data["context"]
234 if activity_id, do: Map.put(data, "id", activity_id), else: data
237 def update_element_in_object(property, element, object) do
240 |> Map.put("#{property}_count", length(element))
241 |> Map.put("#{property}s", element),
242 changeset <- Changeset.change(object, data: new_data),
243 {:ok, object} <- Repo.update(changeset),
244 _ <- update_object_in_activities(object) do
249 def update_likes_in_object(likes, object) do
250 update_element_in_object("like", likes, object)
253 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
254 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
256 with likes <- [actor | likes] |> Enum.uniq() do
257 update_likes_in_object(likes, object)
261 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
262 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
264 with likes <- likes |> List.delete(actor) do
265 update_likes_in_object(likes, object)
269 #### Follow-related helpers
272 Updates a follow activity's state (for locked accounts).
274 def update_follow_state(%Activity{} = activity, state) do
277 |> Map.put("state", state),
278 changeset <- Changeset.change(activity, data: new_data),
279 {:ok, activity} <- Repo.update(changeset) do
285 Makes a follow activity data for the given follower and followed
287 def make_follow_data(
288 %User{ap_id: follower_id},
289 %User{ap_id: followed_id} = followed,
294 "actor" => follower_id,
295 "to" => [followed_id],
296 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
297 "object" => followed_id,
301 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
306 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
309 activity in Activity,
312 "? ->> 'type' = 'Follow'",
315 where: activity.actor == ^follower_id,
320 ^%{object: followed_id}
322 order_by: [desc: :id],
329 #### Announce-related helpers
332 Retruns an existing announce activity if the notice has already been announced
334 def get_existing_announce(actor, %{data: %{"id" => id}}) do
337 activity in Activity,
338 where: activity.actor == ^actor,
339 # this is to use the index
342 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
347 where: fragment("(?)->>'type' = 'Announce'", activity.data)
354 Make announce activity data for the given actor and object
356 # for relayed messages, we only want to send to subscribers
357 def make_announce_data(
358 %User{ap_id: ap_id, nickname: nil} = user,
359 %Object{data: %{"id" => id}} = object,
363 "type" => "Announce",
366 "to" => [user.follower_address],
368 "context" => object.data["context"]
371 if activity_id, do: Map.put(data, "id", activity_id), else: data
374 def make_announce_data(
375 %User{ap_id: ap_id} = user,
376 %Object{data: %{"id" => id}} = object,
380 "type" => "Announce",
383 "to" => [user.follower_address, object.data["actor"]],
384 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
385 "context" => object.data["context"]
388 if activity_id, do: Map.put(data, "id", activity_id), else: data
392 Make unannounce activity data for the given actor and object
394 def make_unannounce_data(
395 %User{ap_id: ap_id} = user,
396 %Activity{data: %{"context" => context}} = activity,
402 "object" => activity.data,
403 "to" => [user.follower_address, activity.data["actor"]],
404 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
408 if activity_id, do: Map.put(data, "id", activity_id), else: data
411 def make_unlike_data(
412 %User{ap_id: ap_id} = user,
413 %Activity{data: %{"context" => context}} = activity,
419 "object" => activity.data,
420 "to" => [user.follower_address, activity.data["actor"]],
421 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
425 if activity_id, do: Map.put(data, "id", activity_id), else: data
428 def add_announce_to_object(
430 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
435 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
437 with announcements <- [actor | announcements] |> Enum.uniq() do
438 update_element_in_object("announcement", announcements, object)
442 def add_announce_to_object(_, object), do: {:ok, object}
444 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
446 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
448 with announcements <- announcements |> List.delete(actor) do
449 update_element_in_object("announcement", announcements, object)
453 #### Unfollow-related helpers
455 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
458 "actor" => follower.ap_id,
459 "to" => [followed.ap_id],
460 "object" => follow_activity.data
463 if activity_id, do: Map.put(data, "id", activity_id), else: data
466 #### Block-related helpers
467 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
470 activity in Activity,
473 "? ->> 'type' = 'Block'",
476 where: activity.actor == ^blocker_id,
481 ^%{object: blocked_id}
483 order_by: [desc: :id],
490 def make_block_data(blocker, blocked, activity_id) do
493 "actor" => blocker.ap_id,
494 "to" => [blocked.ap_id],
495 "object" => blocked.ap_id
498 if activity_id, do: Map.put(data, "id", activity_id), else: data
501 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
504 "actor" => blocker.ap_id,
505 "to" => [blocked.ap_id],
506 "object" => block_activity.data
509 if activity_id, do: Map.put(data, "id", activity_id), else: data
512 #### Create-related helpers
514 def make_create_data(params, additional) do
515 published = params.published || make_date()
519 "to" => params.to |> Enum.uniq(),
520 "actor" => params.actor.ap_id,
521 "object" => params.object,
522 "published" => published,
523 "context" => params.context
525 |> Map.merge(additional)