add allow_followersonly and allow_direct options for configuring mrf_rejectnonpublic
[akkoma] / lib / pleroma / web / activity_pub / utils.ex
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}
6 import Ecto.Query
7
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
11 case object do
12 %{"id" => id} -> id
13 id -> id
14 end
15 end
16
17 def normalize_params(params) do
18 Map.put(params, "actor", get_ap_id(params["actor"]))
19 end
20
21 def make_json_ld_header do
22 %{
23 "@context" => [
24 "https://www.w3.org/ns/activitystreams",
25 "https://w3id.org/security/v1",
26 %{
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"
36 }
37 ]
38 }
39 end
40
41 def make_date do
42 DateTime.utc_now() |> DateTime.to_iso8601()
43 end
44
45 def generate_activity_id do
46 generate_id("activities")
47 end
48
49 def generate_context_id do
50 generate_id("contexts")
51 end
52
53 def generate_object_id do
54 Helpers.o_status_url(Endpoint, :object, UUID.generate())
55 end
56
57 def generate_id(type) do
58 "#{Web.base_url()}/#{type}/#{UUID.generate()}"
59 end
60
61 def create_context(context) do
62 context = context || generate_id("contexts")
63 changeset = Object.context_mapping(context)
64
65 case Repo.insert(changeset) do
66 {:ok, object} ->
67 object
68
69 # This should be solved by an upsert, but it seems ecto
70 # has problems accessing the constraint inside the jsonb.
71 {:error, _} ->
72 Object.get_cached_by_ap_id(context)
73 end
74 end
75
76 @doc """
77 Enqueues an activity for federation if it's local
78 """
79 def maybe_federate(%Activity{local: true} = activity) do
80 priority =
81 case activity.data["type"] do
82 "Delete" -> 10
83 "Create" -> 1
84 _ -> 5
85 end
86
87 Pleroma.Web.Federator.enqueue(:publish, activity, priority)
88 :ok
89 end
90
91 def maybe_federate(_), do: :ok
92
93 @doc """
94 Adds an id and a published data if they aren't there,
95 also adds it to an included object
96 """
97 def lazy_put_activity_defaults(map) do
98 %{data: %{"id" => context}, id: context_id} = create_context(map["context"])
99
100 map =
101 map
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)
106
107 if is_map(map["object"]) do
108 object = lazy_put_object_defaults(map["object"], map)
109 %{map | "object" => object}
110 else
111 map
112 end
113 end
114
115 @doc """
116 Adds an id and published date if they aren't there.
117 """
118 def lazy_put_object_defaults(map, activity \\ %{}) do
119 map
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"])
124 end
125
126 @doc """
127 Inserts a full object if it is contained in an activity.
128 """
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
132 :ok
133 end
134 end
135
136 def insert_full_object(_), do: :ok
137
138 def update_object_in_activities(%{data: %{"id" => id}} = object) do
139 # TODO
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)
144
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)
149 end)
150 end
151
152 #### Like-related helpers
153
154 @doc """
155 Returns an existing like if a user already liked an object
156 """
157 def get_existing_like(actor, %{data: %{"id" => id}}) do
158 query =
159 from(
160 activity in Activity,
161 where: fragment("(?)->>'actor' = ?", activity.data, ^actor),
162 # this is to use the index
163 where:
164 fragment(
165 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
166 activity.data,
167 activity.data,
168 ^id
169 ),
170 where: fragment("(?)->>'type' = 'Like'", activity.data)
171 )
172
173 Repo.one(query)
174 end
175
176 def make_like_data(%User{ap_id: ap_id} = actor, %{data: %{"id" => id}} = object, activity_id) do
177 data = %{
178 "type" => "Like",
179 "actor" => ap_id,
180 "object" => id,
181 "to" => [actor.follower_address, object.data["actor"]],
182 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
183 "context" => object.data["context"]
184 }
185
186 if activity_id, do: Map.put(data, "id", activity_id), else: data
187 end
188
189 def update_element_in_object(property, element, object) do
190 with new_data <-
191 object.data
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
197 {:ok, object}
198 end
199 end
200
201 def update_likes_in_object(likes, object) do
202 update_element_in_object("like", likes, object)
203 end
204
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)
208 end
209 end
210
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)
214 end
215 end
216
217 #### Follow-related helpers
218
219 @doc """
220 Makes a follow activity data for the given follower and followed
221 """
222 def make_follow_data(%User{ap_id: follower_id}, %User{ap_id: followed_id}, activity_id) do
223 data = %{
224 "type" => "Follow",
225 "actor" => follower_id,
226 "to" => [followed_id],
227 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
228 "object" => followed_id
229 }
230
231 if activity_id, do: Map.put(data, "id", activity_id), else: data
232 end
233
234 def fetch_latest_follow(%User{ap_id: follower_id}, %User{ap_id: followed_id}) do
235 query =
236 from(
237 activity in Activity,
238 where:
239 fragment(
240 "? ->> 'type' = 'Follow'",
241 activity.data
242 ),
243 where: activity.actor == ^follower_id,
244 where:
245 fragment(
246 "? @> ?",
247 activity.data,
248 ^%{object: followed_id}
249 ),
250 order_by: [desc: :id],
251 limit: 1
252 )
253
254 Repo.one(query)
255 end
256
257 #### Announce-related helpers
258
259 @doc """
260 Retruns an existing announce activity if the notice has already been announced
261 """
262 def get_existing_announce(actor, %{data: %{"id" => id}}) do
263 query =
264 from(
265 activity in Activity,
266 where: activity.actor == ^actor,
267 # this is to use the index
268 where:
269 fragment(
270 "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
271 activity.data,
272 activity.data,
273 ^id
274 ),
275 where: fragment("(?)->>'type' = 'Announce'", activity.data)
276 )
277
278 Repo.one(query)
279 end
280
281 @doc """
282 Make announce activity data for the given actor and object
283 """
284 def make_announce_data(
285 %User{ap_id: ap_id} = user,
286 %Object{data: %{"id" => id}} = object,
287 activity_id
288 ) do
289 data = %{
290 "type" => "Announce",
291 "actor" => ap_id,
292 "object" => id,
293 "to" => [user.follower_address, object.data["actor"]],
294 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
295 "context" => object.data["context"]
296 }
297
298 if activity_id, do: Map.put(data, "id", activity_id), else: data
299 end
300
301 @doc """
302 Make unannounce activity data for the given actor and object
303 """
304 def make_unannounce_data(
305 %User{ap_id: ap_id} = user,
306 %Activity{data: %{"context" => context}} = activity,
307 activity_id
308 ) do
309 data = %{
310 "type" => "Undo",
311 "actor" => ap_id,
312 "object" => activity.data,
313 "to" => [user.follower_address, activity.data["actor"]],
314 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
315 "context" => context
316 }
317
318 if activity_id, do: Map.put(data, "id", activity_id), else: data
319 end
320
321 def make_unlike_data(
322 %User{ap_id: ap_id} = user,
323 %Activity{data: %{"context" => context}} = activity,
324 activity_id
325 ) do
326 data = %{
327 "type" => "Undo",
328 "actor" => ap_id,
329 "object" => activity.data,
330 "to" => [user.follower_address, activity.data["actor"]],
331 "cc" => ["https://www.w3.org/ns/activitystreams#Public"],
332 "context" => context
333 }
334
335 if activity_id, do: Map.put(data, "id", activity_id), else: data
336 end
337
338 def add_announce_to_object(%Activity{data: %{"actor" => actor}}, object) do
339 with announcements <- [actor | object.data["announcements"] || []] |> Enum.uniq() do
340 update_element_in_object("announcement", announcements, object)
341 end
342 end
343
344 def remove_announce_from_object(%Activity{data: %{"actor" => actor}}, object) do
345 with announcements <- (object.data["announcements"] || []) |> List.delete(actor) do
346 update_element_in_object("announcement", announcements, object)
347 end
348 end
349
350 #### Unfollow-related helpers
351
352 def make_unfollow_data(follower, followed, follow_activity, activity_id) do
353 data = %{
354 "type" => "Undo",
355 "actor" => follower.ap_id,
356 "to" => [followed.ap_id],
357 "object" => follow_activity.data
358 }
359
360 if activity_id, do: Map.put(data, "id", activity_id), else: data
361 end
362
363 #### Block-related helpers
364 def fetch_latest_block(%User{ap_id: blocker_id}, %User{ap_id: blocked_id}) do
365 query =
366 from(
367 activity in Activity,
368 where:
369 fragment(
370 "? ->> 'type' = 'Block'",
371 activity.data
372 ),
373 where: activity.actor == ^blocker_id,
374 where:
375 fragment(
376 "? @> ?",
377 activity.data,
378 ^%{object: blocked_id}
379 ),
380 order_by: [desc: :id],
381 limit: 1
382 )
383
384 Repo.one(query)
385 end
386
387 def make_block_data(blocker, blocked, activity_id) do
388 data = %{
389 "type" => "Block",
390 "actor" => blocker.ap_id,
391 "to" => [blocked.ap_id],
392 "object" => blocked.ap_id
393 }
394
395 if activity_id, do: Map.put(data, "id", activity_id), else: data
396 end
397
398 def make_unblock_data(blocker, blocked, block_activity, activity_id) do
399 data = %{
400 "type" => "Undo",
401 "actor" => blocker.ap_id,
402 "to" => [blocked.ap_id],
403 "object" => block_activity.data
404 }
405
406 if activity_id, do: Map.put(data, "id", activity_id), else: data
407 end
408
409 #### Create-related helpers
410
411 def make_create_data(params, additional) do
412 published = params.published || make_date()
413
414 %{
415 "type" => "Create",
416 "to" => params.to |> Enum.uniq(),
417 "actor" => params.actor.ap_id,
418 "object" => params.object,
419 "published" => published,
420 "context" => params.context
421 }
422 |> Map.merge(additional)
423 end
424 end