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}
8 # Some implementations send the actor URI as the actor field, others send the entire actor object,
9 # so figure out what the actor's URI is based on what we have.
10 def get_ap_id(object) do
17 def normalize_params(params) do
18 Map.put(params, "actor", get_ap_id(params["actor"]))
21 def make_json_ld_header do
24 "https://www.w3.org/ns/activitystreams",
25 "https://w3id.org/security/v1",
27 "manuallyApprovesFollowers" => "as:manuallyApprovesFollowers",
28 "sensitive" => "as:sensitive",
29 "Hashtag" => "as:Hashtag",
30 "ostatus" => "http://ostatus.org#",
31 "atomUri" => "ostatus:atomUri",
32 "inReplyToAtomUri" => "ostatus:inReplyToAtomUri",
33 "conversation" => "ostatus:conversation",
34 "toot" => "http://joinmastodon.org/ns#",
35 "Emoji" => "toot:Emoji"
42 DateTime.utc_now() |> DateTime.to_iso8601()
45 def generate_activity_id do
46 generate_id("activities")
49 def generate_context_id do
50 generate_id("contexts")
53 def generate_object_id do
54 Helpers.o_status_url(Endpoint, :object, UUID.generate())
57 def generate_id(type) do
58 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
61 def create_context(context) do
62 context = context || generate_id("contexts")
63 changeset = Object.context_mapping(context)
65 case Repo.insert(changeset) do
69 # This should be solved by an upsert, but it seems ecto
70 # has problems accessing the constraint inside the jsonb.
72 Object.get_cached_by_ap_id(context)
77 Enqueues an activity for federation if it's local
79 def maybe_federate(%Activity{local: true} = activity) do
81 case activity.data["type"] do
87 Pleroma.Web.Federator.enqueue(:publish, activity, priority)
91 def maybe_federate(_), do: :ok
94 Adds an id and a published data if they aren't there,
95 also adds it to an included object
97 def lazy_put_activity_defaults(map) do
98 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
102 |> Map.put_new_lazy("id", &generate_activity_id/0)
103 |> Map.put_new_lazy("published", &make_date/0)
104 |> Map.put_new("context", context)
105 |> Map.put_new("context_id", context_id)
107 if is_map(map["object"]) do
108 object = lazy_put_object_defaults(map["object"], map)
109 %{map | "object" => object}
116 Adds an id and published date if they aren't there.
118 def lazy_put_object_defaults(map, activity \\ %{}) do
120 |> Map.put_new_lazy("id", &generate_object_id/0)
121 |> Map.put_new_lazy("published", &make_date/0)
122 |> Map.put_new("context", activity["context"])
123 |> Map.put_new("context_id", activity["context_id"])
127 Inserts a full object if it is contained in an activity.
129 def insert_full_object(%{"object" => %{"type" => type} = object_data})
130 when is_map(object_data) and type in ["Note"] do
131 with {:ok, _} <- Object.create(object_data) do
136 def insert_full_object(_), do: :ok
138 def update_object_in_activities(%{data: %{"id" => id}} = object) do
140 # Update activities that already had this. Could be done in a seperate process.
141 # Alternatively, just don't do this and fetch the current object each time. Most
142 # could probably be taken from cache.
143 relevant_activities = Activity.all_by_object_ap_id(id)
145 Enum.map(relevant_activities, fn activity ->
146 new_activity_data = activity.data |> Map.put("object", object.data)
147 changeset = Changeset.change(activity, data: new_activity_data)
148 Repo.update(changeset)
152 #### Like-related helpers
155 Returns an existing like if a user already liked an object
157 def get_existing_like(actor, %{data: %{"id" => id}}) do
160 activity in Activity,
161 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
162 # this is to use the index
165 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
170 where: fragment("(?)->>'type' = 'Like'", activity.data)
176 def make_like_data(%User{ap_id: ap_id} = actor, %{data: %{"id" => id}} = object, activity_id) do
181 "to" => [actor.follower_address, object.data["actor"]],
182 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
183 "context" => object.data["context"]
186 if activity_id, do: Map.put(data, "id", activity_id), else: data
189 def update_element_in_object(property, element, object) do
192 |> Map.put("#{property}_count", length(element))
193 |> Map.put("#{property}s", element),
194 changeset <- Changeset.change(object, data: new_data),
195 {:ok, object} <- Repo.update(changeset),
196 _ <- update_object_in_activities(object) do
201 def update_likes_in_object(likes, object) do
202 update_element_in_object("like", likes, object)
205 def add_like_to_object(%Activity{data: %{"actor" => actor}}, object) do
206 with likes <- [actor | object.data["likes"] || []] |> Enum.uniq() do
207 update_likes_in_object(likes, object)
211 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
212 with likes <- (object.data["likes"] || []) |> List.delete(actor) do
213 update_likes_in_object(likes, object)
217 #### Follow-related helpers
220 Makes a follow activity data for the given follower and followed
222 def make_follow_data(%User{ap_id: follower_id}, %User{ap_id: followed_id} = followed, activity_id) do
225 "actor" => follower_id,
226 "to" => [followed_id],
227 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
228 "object" => followed_id
231 if activity_id, do: Map.put(data, "id", activity_id), else: data
232 if User.locked?(followed), do: Map.put(data, "state", "pending"), else: data
235 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
238 activity in Activity,
241 "? ->> 'type' = 'Follow'",
244 where: activity.actor == ^follower_id,
249 ^%{object: followed_id}
251 order_by: [desc: :id],
258 #### Announce-related helpers
261 Retruns an existing announce activity if the notice has already been announced
263 def get_existing_announce(actor, %{data: %{"id" => id}}) do
266 activity in Activity,
267 where: activity.actor == ^actor,
268 # this is to use the index
271 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
276 where: fragment("(?)->>'type' = 'Announce'", activity.data)
283 Make announce activity data for the given actor and object
285 def make_announce_data(
286 %User{ap_id: ap_id} = user,
287 %Object{data: %{"id" => id}} = object,
291 "type" => "Announce",
294 "to" => [user.follower_address, object.data["actor"]],
295 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
296 "context" => object.data["context"]
299 if activity_id, do: Map.put(data, "id", activity_id), else: data
303 Make unannounce activity data for the given actor and object
305 def make_unannounce_data(
306 %User{ap_id: ap_id} = user,
307 %Activity{data: %{"context" => context}} = activity,
313 "object" => activity.data,
314 "to" => [user.follower_address, activity.data["actor"]],
315 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
319 if activity_id, do: Map.put(data, "id", activity_id), else: data
322 def make_unlike_data(
323 %User{ap_id: ap_id} = user,
324 %Activity{data: %{"context" => context}} = activity,
330 "object" => activity.data,
331 "to" => [user.follower_address, activity.data["actor"]],
332 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
336 if activity_id, do: Map.put(data, "id", activity_id), else: data
339 def add_announce_to_object(%Activity{data: %{"actor" => actor}}, object) do
340 with announcements <- [actor | object.data["announcements"] || []] |> Enum.uniq() do
341 update_element_in_object("announcement", announcements, object)
345 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
346 with announcements <- (object.data["announcements"] || []) |> List.delete(actor) do
347 update_element_in_object("announcement", announcements, object)
351 #### Unfollow-related helpers
353 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
356 "actor" => follower.ap_id,
357 "to" => [followed.ap_id],
358 "object" => follow_activity.data
361 if activity_id, do: Map.put(data, "id", activity_id), else: data
364 #### Block-related helpers
365 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
368 activity in Activity,
371 "? ->> 'type' = 'Block'",
374 where: activity.actor == ^blocker_id,
379 ^%{object: blocked_id}
381 order_by: [desc: :id],
388 def make_block_data(blocker, blocked, activity_id) do
391 "actor" => blocker.ap_id,
392 "to" => [blocked.ap_id],
393 "object" => blocked.ap_id
396 if activity_id, do: Map.put(data, "id", activity_id), else: data
399 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
402 "actor" => blocker.ap_id,
403 "to" => [blocked.ap_id],
404 "object" => block_activity.data
407 if activity_id, do: Map.put(data, "id", activity_id), else: data
410 #### Create-related helpers
412 def make_create_data(params, additional) do
413 published = params.published || make_date()
417 "to" => params.to |> Enum.uniq(),
418 "actor" => params.actor.ap_id,
419 "object" => params.object,
420 "published" => published,
421 "context" => params.context
423 |> Map.merge(additional)