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 def make_json_ld_header do
25 "https://www.w3.org/ns/activitystreams",
26 "https://w3id.org/security/v1",
28 "manuallyApprovesFollowers" => "as:manuallyApprovesFollowers",
29 "sensitive" => "as:sensitive",
30 "Hashtag" => "as:Hashtag",
31 "ostatus" => "http://ostatus.org#",
32 "atomUri" => "ostatus:atomUri",
33 "inReplyToAtomUri" => "ostatus:inReplyToAtomUri",
34 "conversation" => "ostatus:conversation",
35 "toot" => "http://joinmastodon.org/ns#",
36 "Emoji" => "toot:Emoji"
43 DateTime.utc_now() |> DateTime.to_iso8601()
46 def generate_activity_id do
47 generate_id("activities")
50 def generate_context_id do
51 generate_id("contexts")
54 def generate_object_id do
55 Helpers.o_status_url(Endpoint, :object, UUID.generate())
58 def generate_id(type) do
59 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
62 def create_context(context) do
63 context = context || generate_id("contexts")
64 changeset = Object.context_mapping(context)
66 case Repo.insert(changeset) do
70 # This should be solved by an upsert, but it seems ecto
71 # has problems accessing the constraint inside the jsonb.
73 Object.get_cached_by_ap_id(context)
78 Enqueues an activity for federation if it's local
80 def maybe_federate(%Activity{local: true} = activity) do
82 case activity.data["type"] do
88 Pleroma.Web.Federator.enqueue(:publish, activity, priority)
92 def maybe_federate(_), do: :ok
95 Adds an id and a published data if they aren't there,
96 also adds it to an included object
98 def lazy_put_activity_defaults(map) do
99 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
103 |> Map.put_new_lazy("id", &generate_activity_id/0)
104 |> Map.put_new_lazy("published", &make_date/0)
105 |> Map.put_new("context", context)
106 |> Map.put_new("context_id", context_id)
108 if is_map(map["object"]) do
109 object = lazy_put_object_defaults(map["object"], map)
110 %{map | "object" => object}
117 Adds an id and published date if they aren't there.
119 def lazy_put_object_defaults(map, activity \\ %{}) do
121 |> Map.put_new_lazy("id", &generate_object_id/0)
122 |> Map.put_new_lazy("published", &make_date/0)
123 |> Map.put_new("context", activity["context"])
124 |> Map.put_new("context_id", activity["context_id"])
128 Inserts a full object if it is contained in an activity.
130 def insert_full_object(%{"object" => %{"type" => type} = object_data})
131 when is_map(object_data) and type in ["Article", "Note", "Video"] do
132 with {:ok, _} <- Object.create(object_data) do
137 def insert_full_object(_), do: :ok
139 def update_object_in_activities(%{data: %{"id" => id}} = object) do
141 # Update activities that already had this. Could be done in a seperate process.
142 # Alternatively, just don't do this and fetch the current object each time. Most
143 # could probably be taken from cache.
144 relevant_activities = Activity.all_by_object_ap_id(id)
146 Enum.map(relevant_activities, fn activity ->
147 new_activity_data = activity.data |> Map.put("object", object.data)
148 changeset = Changeset.change(activity, data: new_activity_data)
149 Repo.update(changeset)
153 #### Like-related helpers
156 Returns an existing like if a user already liked an object
158 def get_existing_like(actor, %{data: %{"id" => id}}) do
161 activity in Activity,
162 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
163 # this is to use the index
166 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
171 where: fragment("(?)->>'type' = 'Like'", activity.data)
177 def make_like_data(%User{ap_id: ap_id} = actor, %{data: %{"id" => id}} = object, activity_id) do
182 "to" => [actor.follower_address, object.data["actor"]],
183 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
184 "context" => object.data["context"]
187 if activity_id, do: Map.put(data, "id", activity_id), else: data
190 def update_element_in_object(property, element, object) do
193 |> Map.put("#{property}_count", length(element))
194 |> Map.put("#{property}s", element),
195 changeset <- Changeset.change(object, data: new_data),
196 {:ok, object} <- Repo.update(changeset),
197 _ <- update_object_in_activities(object) do
202 def update_likes_in_object(likes, object) do
203 update_element_in_object("like", likes, object)
206 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
207 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
209 with likes <- [actor | likes] |> Enum.uniq() do
210 update_likes_in_object(likes, object)
214 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
215 likes = if is_list(object.data["likes"]), do: object.data["likes"], else: []
217 with likes <- likes |> List.delete(actor) do
218 update_likes_in_object(likes, object)
222 #### Follow-related helpers
225 Updates a follow activity's state (for locked accounts).
227 def update_follow_state(%Activity{} = activity, state) do
230 |> Map.put("state", state),
231 changeset <- Changeset.change(activity, data: new_data),
232 {:ok, activity} <- Repo.update(changeset) do
238 Makes a follow activity data for the given follower and followed
240 def make_follow_data(
241 %User{ap_id: follower_id},
242 %User{ap_id: followed_id} = followed,
247 "actor" => follower_id,
248 "to" => [followed_id],
249 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
250 "object" => followed_id
253 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
254 data = if User.locked?(followed), do: Map.put(data, "state", "pending"), else: data
259 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
262 activity in Activity,
265 "? ->> 'type' = 'Follow'",
268 where: activity.actor == ^follower_id,
273 ^%{object: followed_id}
275 order_by: [desc: :id],
282 #### Announce-related helpers
285 Retruns an existing announce activity if the notice has already been announced
287 def get_existing_announce(actor, %{data: %{"id" => id}}) do
290 activity in Activity,
291 where: activity.actor == ^actor,
292 # this is to use the index
295 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
300 where: fragment("(?)->>'type' = 'Announce'", activity.data)
307 Make announce activity data for the given actor and object
309 # for relayed messages, we only want to send to subscribers
310 def make_announce_data(
311 %User{ap_id: ap_id, nickname: nil} = user,
312 %Object{data: %{"id" => id}} = object,
316 "type" => "Announce",
319 "to" => [user.follower_address],
321 "context" => object.data["context"]
324 if activity_id, do: Map.put(data, "id", activity_id), else: data
327 def make_announce_data(
328 %User{ap_id: ap_id} = user,
329 %Object{data: %{"id" => id}} = object,
333 "type" => "Announce",
336 "to" => [user.follower_address, object.data["actor"]],
337 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
338 "context" => object.data["context"]
341 if activity_id, do: Map.put(data, "id", activity_id), else: data
345 Make unannounce activity data for the given actor and object
347 def make_unannounce_data(
348 %User{ap_id: ap_id} = user,
349 %Activity{data: %{"context" => context}} = activity,
355 "object" => activity.data,
356 "to" => [user.follower_address, activity.data["actor"]],
357 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
361 if activity_id, do: Map.put(data, "id", activity_id), else: data
364 def make_unlike_data(
365 %User{ap_id: ap_id} = user,
366 %Activity{data: %{"context" => context}} = activity,
372 "object" => activity.data,
373 "to" => [user.follower_address, activity.data["actor"]],
374 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
378 if activity_id, do: Map.put(data, "id", activity_id), else: data
381 def add_announce_to_object(
383 data: %{"actor" => actor, "cc" => ["https://www.w3.org/ns/activitystreams#Public"]}
388 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
390 with announcements <- [actor | announcements] |> Enum.uniq() do
391 update_element_in_object("announcement", announcements, object)
395 def add_announce_to_object(_, object), do: {:ok, object}
397 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
399 if is_list(object.data["announcements"]), do: object.data["announcements"], else: []
401 with announcements <- announcements |> List.delete(actor) do
402 update_element_in_object("announcement", announcements, object)
406 #### Unfollow-related helpers
408 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
411 "actor" => follower.ap_id,
412 "to" => [followed.ap_id],
413 "object" => follow_activity.data
416 if activity_id, do: Map.put(data, "id", activity_id), else: data
419 #### Block-related helpers
420 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
423 activity in Activity,
426 "? ->> 'type' = 'Block'",
429 where: activity.actor == ^blocker_id,
434 ^%{object: blocked_id}
436 order_by: [desc: :id],
443 def make_block_data(blocker, blocked, activity_id) do
446 "actor" => blocker.ap_id,
447 "to" => [blocked.ap_id],
448 "object" => blocked.ap_id
451 if activity_id, do: Map.put(data, "id", activity_id), else: data
454 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
457 "actor" => blocker.ap_id,
458 "to" => [blocked.ap_id],
459 "object" => block_activity.data
462 if activity_id, do: Map.put(data, "id", activity_id), else: data
465 #### Create-related helpers
467 def make_create_data(params, additional) do
468 published = params.published || make_date()
472 "to" => params.to |> Enum.uniq(),
473 "actor" => params.actor.ap_id,
474 "object" => params.object,
475 "published" => published,
476 "context" => params.context
478 |> Map.merge(additional)