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"]) ->
45 defp extract_list(target) when is_binary(target), do: [target]
46 defp extract_list(lst) when is_list(lst), do: lst
47 defp extract_list(_), do: []
49 def maybe_splice_recipient(ap_id, params) do
51 !recipient_in_collection(ap_id, params["to"]) &&
52 !recipient_in_collection(ap_id, params["cc"])
54 cc_list = extract_list(params["cc"])
58 |> Map.put("cc", [ap_id | cc_list])
64 def make_json_ld_header do
67 "https://www.w3.org/ns/activitystreams",
68 "https://w3id.org/security/v1",
70 "manuallyApprovesFollowers" => "as:manuallyApprovesFollowers",
71 "sensitive" => "as:sensitive",
72 "Hashtag" => "as:Hashtag",
73 "ostatus" => "http://ostatus.org#",
74 "atomUri" => "ostatus:atomUri",
75 "inReplyToAtomUri" => "ostatus:inReplyToAtomUri",
76 "conversation" => "ostatus:conversation",
77 "toot" => "http://joinmastodon.org/ns#",
78 "Emoji" => "toot:Emoji"
85 DateTime.utc_now() |> DateTime.to_iso8601()
88 def generate_activity_id do
89 generate_id("activities")
92 def generate_context_id do
93 generate_id("contexts")
96 def generate_object_id do
97 Helpers.o_status_url(Endpoint, :object, UUID.generate())
100 def generate_id(type) do
101 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
104 def create_context(context) do
105 context = context || generate_id("contexts")
106 changeset = Object.context_mapping(context)
108 case Repo.insert(changeset) do
112 # This should be solved by an upsert, but it seems ecto
113 # has problems accessing the constraint inside the jsonb.
115 Object.get_cached_by_ap_id(context)
120 Enqueues an activity for federation if it's local
122 def maybe_federate(%Activity{local: true} = activity) do
124 case activity.data["type"] do
130 Pleroma.Web.Federator.enqueue(:publish, activity, priority)
134 def maybe_federate(_), do: :ok
137 Adds an id and a published data if they aren't there,
138 also adds it to an included object
140 def lazy_put_activity_defaults(map) do
141 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
145 |> Map.put_new_lazy("id", &generate_activity_id/0)
146 |> Map.put_new_lazy("published", &make_date/0)
147 |> Map.put_new("context", context)
148 |> Map.put_new("context_id", context_id)
150 if is_map(map["object"]) do
151 object = lazy_put_object_defaults(map["object"], map)
152 %{map | "object" => object}
159 Adds an id and published date if they aren't there.
161 def lazy_put_object_defaults(map, activity \\ %{}) do
163 |> Map.put_new_lazy("id", &generate_object_id/0)
164 |> Map.put_new_lazy("published", &make_date/0)
165 |> Map.put_new("context", activity["context"])
166 |> Map.put_new("context_id", activity["context_id"])
170 Inserts a full object if it is contained in an activity.
172 def insert_full_object(%{"object" => %{"type" => type} = object_data})
173 when is_map(object_data) and type in ["Article", "Note", "Video"] do
174 with {:ok, _} <- Object.create(object_data) do
179 def insert_full_object(_), do: :ok
181 def update_object_in_activities(%{data: %{"id" => id}} = object) do
183 # Update activities that already had this. Could be done in a seperate process.
184 # Alternatively, just don't do this and fetch the current object each time. Most
185 # could probably be taken from cache.
186 relevant_activities = Activity.all_by_object_ap_id(id)
188 Enum.map(relevant_activities, fn activity ->
189 new_activity_data = activity.data |> Map.put("object", object.data)
190 changeset = Changeset.change(activity, data: new_activity_data)
191 Repo.update(changeset)
195 #### Like-related helpers
198 Returns an existing like if a user already liked an object
200 def get_existing_like(actor, %{data: %{"id" => id}}) do
203 activity in Activity,
204 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
205 # this is to use the index
208 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
213 where: fragment("(?)->>'type' = 'Like'", activity.data)
219 def make_like_data(%User{ap_id: ap_id} = actor, %{data: %{"id" => id}} = object, activity_id) do
224 "to" => [actor.follower_address, object.data["actor"]],
225 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
226 "context" => object.data["context"]
229 if activity_id, do: Map.put(data, "id", activity_id), else: data
232 def update_element_in_object(property, element, object) do
235 |> Map.put("#{property}_count", length(element))
236 |> Map.put("#{property}s", element),
237 changeset <- Changeset.change(object, data: new_data),
238 {:ok, object} <- Repo.update(changeset),
239 _ <- update_object_in_activities(object) do
244 def update_likes_in_object(likes, object) do
245 update_element_in_object("like", likes, object)
248 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
249 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
251 with likes <- [actor | likes] |> Enum.uniq() do
252 update_likes_in_object(likes, object)
256 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
257 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
259 with likes <- likes |> List.delete(actor) do
260 update_likes_in_object(likes, object)
264 #### Follow-related helpers
267 Updates a follow activity's state (for locked accounts).
269 def update_follow_state(%Activity{} = activity, state) do
272 |> Map.put("state", state),
273 changeset <- Changeset.change(activity, data: new_data),
274 {:ok, activity} <- Repo.update(changeset) do
280 Makes a follow activity data for the given follower and followed
282 def make_follow_data(
283 %User{ap_id: follower_id},
284 %User{ap_id: followed_id} = followed,
289 "actor" => follower_id,
290 "to" => [followed_id],
291 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
292 "object" => followed_id,
296 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
301 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
304 activity in Activity,
307 "? ->> 'type' = 'Follow'",
310 where: activity.actor == ^follower_id,
315 ^%{object: followed_id}
317 order_by: [desc: :id],
324 #### Announce-related helpers
327 Retruns an existing announce activity if the notice has already been announced
329 def get_existing_announce(actor, %{data: %{"id" => id}}) do
332 activity in Activity,
333 where: activity.actor == ^actor,
334 # this is to use the index
337 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
342 where: fragment("(?)->>'type' = 'Announce'", activity.data)
349 Make announce activity data for the given actor and object
351 # for relayed messages, we only want to send to subscribers
352 def make_announce_data(
353 %User{ap_id: ap_id, nickname: nil} = user,
354 %Object{data: %{"id" => id}} = object,
358 "type" => "Announce",
361 "to" => [user.follower_address],
363 "context" => object.data["context"]
366 if activity_id, do: Map.put(data, "id", activity_id), else: data
369 def make_announce_data(
370 %User{ap_id: ap_id} = user,
371 %Object{data: %{"id" => id}} = object,
375 "type" => "Announce",
378 "to" => [user.follower_address, object.data["actor"]],
379 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
380 "context" => object.data["context"]
383 if activity_id, do: Map.put(data, "id", activity_id), else: data
387 Make unannounce activity data for the given actor and object
389 def make_unannounce_data(
390 %User{ap_id: ap_id} = user,
391 %Activity{data: %{"context" => context}} = activity,
397 "object" => activity.data,
398 "to" => [user.follower_address, activity.data["actor"]],
399 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
403 if activity_id, do: Map.put(data, "id", activity_id), else: data
406 def make_unlike_data(
407 %User{ap_id: ap_id} = user,
408 %Activity{data: %{"context" => context}} = activity,
414 "object" => activity.data,
415 "to" => [user.follower_address, activity.data["actor"]],
416 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
420 if activity_id, do: Map.put(data, "id", activity_id), else: data
423 def add_announce_to_object(
425 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
430 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
432 with announcements <- [actor | announcements] |> Enum.uniq() do
433 update_element_in_object("announcement", announcements, object)
437 def add_announce_to_object(_, object), do: {:ok, object}
439 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
441 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
443 with announcements <- announcements |> List.delete(actor) do
444 update_element_in_object("announcement", announcements, object)
448 #### Unfollow-related helpers
450 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
453 "actor" => follower.ap_id,
454 "to" => [followed.ap_id],
455 "object" => follow_activity.data
458 if activity_id, do: Map.put(data, "id", activity_id), else: data
461 #### Block-related helpers
462 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
465 activity in Activity,
468 "? ->> 'type' = 'Block'",
471 where: activity.actor == ^blocker_id,
476 ^%{object: blocked_id}
478 order_by: [desc: :id],
485 def make_block_data(blocker, blocked, activity_id) do
488 "actor" => blocker.ap_id,
489 "to" => [blocked.ap_id],
490 "object" => blocked.ap_id
493 if activity_id, do: Map.put(data, "id", activity_id), else: data
496 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
499 "actor" => blocker.ap_id,
500 "to" => [blocked.ap_id],
501 "object" => block_activity.data
504 if activity_id, do: Map.put(data, "id", activity_id), else: data
507 #### Create-related helpers
509 def make_create_data(params, additional) do
510 published = params.published || make_date()
514 "to" => params.to |> Enum.uniq(),
515 "actor" => params.actor.ap_id,
516 "object" => params.object,
517 "published" => published,
518 "context" => params.context
520 |> Map.merge(additional)