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 "#{Web.base_url()}/litepub-1.0.jsonld"
79 DateTime.utc_now() |> DateTime.to_iso8601()
82 def generate_activity_id do
83 generate_id("activities")
86 def generate_context_id do
87 generate_id("contexts")
90 def generate_object_id do
91 Helpers.o_status_url(Endpoint, :object, UUID.generate())
94 def generate_id(type) do
95 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
98 def create_context(context) do
99 context = context || generate_id("contexts")
100 changeset = Object.context_mapping(context)
102 case Repo.insert(changeset) do
106 # This should be solved by an upsert, but it seems ecto
107 # has problems accessing the constraint inside the jsonb.
109 Object.get_cached_by_ap_id(context)
114 Enqueues an activity for federation if it's local
116 def maybe_federate(%Activity{local: true} = activity) do
118 case activity.data["type"] do
124 Pleroma.Web.Federator.enqueue(:publish, activity, priority)
128 def maybe_federate(_), do: :ok
131 Adds an id and a published data if they aren't there,
132 also adds it to an included object
134 def lazy_put_activity_defaults(map) do
135 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
139 |> Map.put_new_lazy("id", &generate_activity_id/0)
140 |> Map.put_new_lazy("published", &make_date/0)
141 |> Map.put_new("context", context)
142 |> Map.put_new("context_id", context_id)
144 if is_map(map["object"]) do
145 object = lazy_put_object_defaults(map["object"], map)
146 %{map | "object" => object}
153 Adds an id and published date if they aren't there.
155 def lazy_put_object_defaults(map, activity \\ %{}) do
157 |> Map.put_new_lazy("id", &generate_object_id/0)
158 |> Map.put_new_lazy("published", &make_date/0)
159 |> Map.put_new("context", activity["context"])
160 |> Map.put_new("context_id", activity["context_id"])
164 Inserts a full object if it is contained in an activity.
166 def insert_full_object(%{"object" => %{"type" => type} = object_data})
167 when is_map(object_data) and type in ["Article", "Note", "Video", "Page"] do
168 with {:ok, _} <- Object.create(object_data) do
173 def insert_full_object(_), do: :ok
175 def update_object_in_activities(%{data: %{"id" => id}} = object) do
177 # Update activities that already had this. Could be done in a seperate process.
178 # Alternatively, just don't do this and fetch the current object each time. Most
179 # could probably be taken from cache.
180 relevant_activities = Activity.all_by_object_ap_id(id)
182 Enum.map(relevant_activities, fn activity ->
183 new_activity_data = activity.data |> Map.put("object", object.data)
184 changeset = Changeset.change(activity, data: new_activity_data)
185 Repo.update(changeset)
189 #### Like-related helpers
192 Returns an existing like if a user already liked an object
194 def get_existing_like(actor, %{data: %{"id" => id}}) do
197 activity in Activity,
198 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
199 # this is to use the index
202 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
207 where: fragment("(?)->>'type' = 'Like'", activity.data)
213 def make_like_data(%User{ap_id: ap_id} = actor, %{data: %{"id" => id}} = object, activity_id) do
218 "to" => [actor.follower_address, object.data["actor"]],
219 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
220 "context" => object.data["context"]
223 if activity_id, do: Map.put(data, "id", activity_id), else: data
226 def update_element_in_object(property, element, object) do
229 |> Map.put("#{property}_count", length(element))
230 |> Map.put("#{property}s", element),
231 changeset <- Changeset.change(object, data: new_data),
232 {:ok, object} <- Repo.update(changeset),
233 _ <- update_object_in_activities(object) do
238 def update_likes_in_object(likes, object) do
239 update_element_in_object("like", likes, object)
242 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
243 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
245 with likes <- [actor | likes] |> Enum.uniq() do
246 update_likes_in_object(likes, object)
250 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
251 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
253 with likes <- likes |> List.delete(actor) do
254 update_likes_in_object(likes, object)
258 #### Follow-related helpers
261 Updates a follow activity's state (for locked accounts).
263 def update_follow_state(%Activity{} = activity, state) do
266 |> Map.put("state", state),
267 changeset <- Changeset.change(activity, data: new_data),
268 {:ok, activity} <- Repo.update(changeset) do
274 Makes a follow activity data for the given follower and followed
276 def make_follow_data(
277 %User{ap_id: follower_id},
278 %User{ap_id: followed_id} = followed,
283 "actor" => follower_id,
284 "to" => [followed_id],
285 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
286 "object" => followed_id,
290 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
295 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
298 activity in Activity,
301 "? ->> 'type' = 'Follow'",
304 where: activity.actor == ^follower_id,
309 ^%{object: followed_id}
311 order_by: [desc: :id],
318 #### Announce-related helpers
321 Retruns an existing announce activity if the notice has already been announced
323 def get_existing_announce(actor, %{data: %{"id" => id}}) do
326 activity in Activity,
327 where: activity.actor == ^actor,
328 # this is to use the index
331 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
336 where: fragment("(?)->>'type' = 'Announce'", activity.data)
343 Make announce activity data for the given actor and object
345 # for relayed messages, we only want to send to subscribers
346 def make_announce_data(
347 %User{ap_id: ap_id, nickname: nil} = user,
348 %Object{data: %{"id" => id}} = object,
352 "type" => "Announce",
355 "to" => [user.follower_address],
357 "context" => object.data["context"]
360 if activity_id, do: Map.put(data, "id", activity_id), else: data
363 def make_announce_data(
364 %User{ap_id: ap_id} = user,
365 %Object{data: %{"id" => id}} = object,
369 "type" => "Announce",
372 "to" => [user.follower_address, object.data["actor"]],
373 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
374 "context" => object.data["context"]
377 if activity_id, do: Map.put(data, "id", activity_id), else: data
381 Make unannounce activity data for the given actor and object
383 def make_unannounce_data(
384 %User{ap_id: ap_id} = user,
385 %Activity{data: %{"context" => context}} = activity,
391 "object" => activity.data,
392 "to" => [user.follower_address, activity.data["actor"]],
393 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
397 if activity_id, do: Map.put(data, "id", activity_id), else: data
400 def make_unlike_data(
401 %User{ap_id: ap_id} = user,
402 %Activity{data: %{"context" => context}} = activity,
408 "object" => activity.data,
409 "to" => [user.follower_address, activity.data["actor"]],
410 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
414 if activity_id, do: Map.put(data, "id", activity_id), else: data
417 def add_announce_to_object(
419 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
424 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
426 with announcements <- [actor | announcements] |> Enum.uniq() do
427 update_element_in_object("announcement", announcements, object)
431 def add_announce_to_object(_, object), do: {:ok, object}
433 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
435 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
437 with announcements <- announcements |> List.delete(actor) do
438 update_element_in_object("announcement", announcements, object)
442 #### Unfollow-related helpers
444 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
447 "actor" => follower.ap_id,
448 "to" => [followed.ap_id],
449 "object" => follow_activity.data
452 if activity_id, do: Map.put(data, "id", activity_id), else: data
455 #### Block-related helpers
456 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
459 activity in Activity,
462 "? ->> 'type' = 'Block'",
465 where: activity.actor == ^blocker_id,
470 ^%{object: blocked_id}
472 order_by: [desc: :id],
479 def make_block_data(blocker, blocked, activity_id) do
482 "actor" => blocker.ap_id,
483 "to" => [blocked.ap_id],
484 "object" => blocked.ap_id
487 if activity_id, do: Map.put(data, "id", activity_id), else: data
490 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
493 "actor" => blocker.ap_id,
494 "to" => [blocked.ap_id],
495 "object" => block_activity.data
498 if activity_id, do: Map.put(data, "id", activity_id), else: data
501 #### Create-related helpers
503 def make_create_data(params, additional) do
504 published = params.published || make_date()
508 "to" => params.to |> Enum.uniq(),
509 "actor" => params.actor.ap_id,
510 "object" => params.object,
511 "published" => published,
512 "context" => params.context
514 |> Map.merge(additional)