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 ["Note"] 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 with likes <- [actor | object.data["likes"] || []] |> Enum.uniq() do
208 update_likes_in_object(likes, object)
212 def remove_like_from_object(%Activity{data: %{"actor" => actor}}, object) do
213 with likes <- (object.data["likes"] || []) |> List.delete(actor) do
214 update_likes_in_object(likes, object)
218 #### Follow-related helpers
221 Updates a follow activity's state (for locked accounts).
223 def update_follow_state(%Activity{} = activity, state) do
226 |> Map.put("state", state),
227 changeset <- Changeset.change(activity, data: new_data),
228 {:ok, activity} <- Repo.update(changeset) do
234 Makes a follow activity data for the given follower and followed
236 def make_follow_data(%User{ap_id: follower_id}, %User{ap_id: followed_id} = followed, activity_id) do
239 "actor" => follower_id,
240 "to" => [followed_id],
241 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
242 "object" => followed_id
245 data = if activity_id, do: Map.put(data, "id", activity_id), else: data
246 data = if User.locked?(followed), do: Map.put(data, "state", "pending"), else: data
251 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
254 activity in Activity,
257 "? ->> 'type' = 'Follow'",
260 where: activity.actor == ^follower_id,
265 ^%{object: followed_id}
267 order_by: [desc: :id],
274 #### Announce-related helpers
277 Retruns an existing announce activity if the notice has already been announced
279 def get_existing_announce(actor, %{data: %{"id" => id}}) do
282 activity in Activity,
283 where: activity.actor == ^actor,
284 # this is to use the index
287 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
292 where: fragment("(?)->>'type' = 'Announce'", activity.data)
299 Make announce activity data for the given actor and object
301 def make_announce_data(
302 %User{ap_id: ap_id} = user,
303 %Object{data: %{"id" => id}} = object,
307 "type" => "Announce",
310 "to" => [user.follower_address, object.data["actor"]],
311 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
312 "context" => object.data["context"]
315 if activity_id, do: Map.put(data, "id", activity_id), else: data
319 Make unannounce activity data for the given actor and object
321 def make_unannounce_data(
322 %User{ap_id: ap_id} = user,
323 %Activity{data: %{"context" => context}} = activity,
329 "object" => activity.data,
330 "to" => [user.follower_address, activity.data["actor"]],
331 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
335 if activity_id, do: Map.put(data, "id", activity_id), else: data
338 def make_unlike_data(
339 %User{ap_id: ap_id} = user,
340 %Activity{data: %{"context" => context}} = activity,
346 "object" => activity.data,
347 "to" => [user.follower_address, activity.data["actor"]],
348 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
352 if activity_id, do: Map.put(data, "id", activity_id), else: data
355 def add_announce_to_object(%Activity{data: %{"actor" => actor}}, object) do
356 with announcements <- [actor | object.data["announcements"] || []] |> Enum.uniq() do
357 update_element_in_object("announcement", announcements, object)
361 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
362 with announcements <- (object.data["announcements"] || []) |> List.delete(actor) do
363 update_element_in_object("announcement", announcements, object)
367 #### Unfollow-related helpers
369 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
372 "actor" => follower.ap_id,
373 "to" => [followed.ap_id],
374 "object" => follow_activity.data
377 if activity_id, do: Map.put(data, "id", activity_id), else: data
380 #### Block-related helpers
381 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
384 activity in Activity,
387 "? ->> 'type' = 'Block'",
390 where: activity.actor == ^blocker_id,
395 ^%{object: blocked_id}
397 order_by: [desc: :id],
404 def make_block_data(blocker, blocked, activity_id) do
407 "actor" => blocker.ap_id,
408 "to" => [blocked.ap_id],
409 "object" => blocked.ap_id
412 if activity_id, do: Map.put(data, "id", activity_id), else: data
415 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
418 "actor" => blocker.ap_id,
419 "to" => [blocked.ap_id],
420 "object" => block_activity.data
423 if activity_id, do: Map.put(data, "id", activity_id), else: data
426 #### Create-related helpers
428 def make_create_data(params, additional) do
429 published = params.published || make_date()
433 "to" => params.to |> Enum.uniq(),
434 "actor" => params.actor.ap_id,
435 "object" => params.object,
436 "published" => published,
437 "context" => params.context
439 |> Map.merge(additional)