0bec8c4dd018711ef7f5db894c8b17cff8f403d7
[akkoma] / lib / pleroma / web / activity_pub / transmogrifier.ex
1 defmodule Pleroma.Web.ActivityPub.Transmogrifier do
2 @moduledoc """
3 A module to handle coding from internal to wire ActivityPub and back.
4 """
5 alias Pleroma.User
6 alias Pleroma.Object
7 alias Pleroma.Activity
8 alias Pleroma.Repo
9 alias Pleroma.Web.ActivityPub.ActivityPub
10
11 import Ecto.Query
12
13 require Logger
14
15 @doc """
16 Modifies an incoming AP object (mastodon format) to our internal format.
17 """
18 def fix_object(object) do
19 object
20 |> Map.put("actor", object["attributedTo"])
21 |> fix_attachments
22 |> fix_context
23 |> fix_in_reply_to
24 |> fix_emoji
25 |> fix_tag
26 end
27
28 def fix_in_reply_to(%{"inReplyTo" => in_reply_to_id} = object)
29 when not is_nil(in_reply_to_id) do
30 case ActivityPub.fetch_object_from_id(in_reply_to_id) do
31 {:ok, replied_object} ->
32 activity = Activity.get_create_activity_by_object_ap_id(replied_object.data["id"])
33
34 object
35 |> Map.put("inReplyTo", replied_object.data["id"])
36 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
37 |> Map.put("inReplyToStatusId", activity.id)
38 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
39 |> Map.put("context", replied_object.data["context"] || object["conversation"])
40
41 e ->
42 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
43 object
44 end
45 end
46
47 def fix_in_reply_to(object), do: object
48
49 def fix_context(object) do
50 object
51 |> Map.put("context", object["conversation"])
52 end
53
54 def fix_attachments(object) do
55 attachments =
56 (object["attachment"] || [])
57 |> Enum.map(fn data ->
58 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
59 Map.put(data, "url", url)
60 end)
61
62 object
63 |> Map.put("attachment", attachments)
64 end
65
66 def fix_emoji(object) do
67 tags = object["tag"] || []
68 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
69
70 emoji =
71 emoji
72 |> Enum.reduce(%{}, fn data, mapping ->
73 name = data["name"]
74
75 name =
76 if String.starts_with?(name, ":") do
77 name |> String.slice(1..-2)
78 else
79 name
80 end
81
82 mapping |> Map.put(name, data["icon"]["url"])
83 end)
84
85 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
86 emoji = Map.merge(object["emoji"] || %{}, emoji)
87
88 object
89 |> Map.put("emoji", emoji)
90 end
91
92 def fix_tag(object) do
93 tags =
94 (object["tag"] || [])
95 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
96 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
97
98 combined = (object["tag"] || []) ++ tags
99
100 object
101 |> Map.put("tag", combined)
102 end
103
104 # TODO: validate those with a Ecto scheme
105 # - tags
106 # - emoji
107 def handle_incoming(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
108 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
109 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
110 object = fix_object(data["object"])
111
112 params = %{
113 to: data["to"],
114 object: object,
115 actor: user,
116 context: object["conversation"],
117 local: false,
118 published: data["published"],
119 additional:
120 Map.take(data, [
121 "cc",
122 "id"
123 ])
124 }
125
126 ActivityPub.create(params)
127 else
128 %Activity{} = activity -> {:ok, activity}
129 _e -> :error
130 end
131 end
132
133 def handle_incoming(
134 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
135 ) do
136 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
137 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
138 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
139 ActivityPub.accept(%{to: [follower.ap_id], actor: followed.ap_id, object: data, local: true})
140
141 User.follow(follower, followed)
142 {:ok, activity}
143 else
144 _e -> :error
145 end
146 end
147
148 def handle_incoming(
149 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
150 ) do
151 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
152 {:ok, object} <-
153 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
154 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
155 {:ok, activity}
156 else
157 _e -> :error
158 end
159 end
160
161 def handle_incoming(
162 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
163 ) do
164 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
165 {:ok, object} <-
166 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
167 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
168 {:ok, activity}
169 else
170 _e -> :error
171 end
172 end
173
174 def handle_incoming(
175 %{"type" => "Update", "object" => %{"type" => "Person"} = object, "actor" => actor_id} =
176 data
177 ) do
178 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
179 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
180
181 banner = new_user_data[:info]["banner"]
182
183 update_data =
184 new_user_data
185 |> Map.take([:name, :bio, :avatar])
186 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner}))
187
188 actor
189 |> User.upgrade_changeset(update_data)
190 |> User.update_and_set_cache()
191
192 ActivityPub.update(%{
193 local: false,
194 to: data["to"] || [],
195 cc: data["cc"] || [],
196 object: object,
197 actor: actor_id
198 })
199 else
200 e ->
201 Logger.error(e)
202 :error
203 end
204 end
205
206 # TODO: Make secure.
207 def handle_incoming(
208 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
209 ) do
210 object_id =
211 case object_id do
212 %{"id" => id} -> id
213 id -> id
214 end
215
216 with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
217 {:ok, object} <-
218 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
219 {:ok, activity} <- ActivityPub.delete(object, false) do
220 {:ok, activity}
221 else
222 _e -> :error
223 end
224 end
225
226 def handle_incoming(
227 %{
228 "type" => "Undo",
229 "object" => %{"type" => "Announce", "object" => object_id},
230 "actor" => actor,
231 "id" => id
232 } = data
233 ) do
234 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
235 {:ok, object} <-
236 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
237 {:ok, activity, _, _} <- ActivityPub.unannounce(actor, object, id, false) do
238 {:ok, activity}
239 else
240 e -> :error
241 end
242 end
243
244 def handle_incoming(
245 %{
246 "type" => "Undo",
247 "object" => %{"type" => "Follow", "object" => followed},
248 "actor" => follower,
249 "id" => id
250 } = data
251 ) do
252 with %User{local: true} = followed = User.get_cached_by_ap_id(followed),
253 %User{} = follower = User.get_or_fetch_by_ap_id(follower),
254 {:ok, activity} <- ActivityPub.unfollow(follower, followed, false) do
255 User.unfollow(follower, followed)
256 {:ok, activity}
257 else
258 e -> :error
259 end
260 end
261
262 # TODO
263 # Accept
264 # Undo for non-Announce
265
266 def handle_incoming(_), do: :error
267
268 def get_obj_helper(id) do
269 if object = Object.get_by_ap_id(id), do: {:ok, object}, else: nil
270 end
271
272 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
273 with false <- String.starts_with?(inReplyTo, "http"),
274 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
275 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
276 else
277 _e -> object
278 end
279 end
280
281 def set_reply_to_uri(obj), do: obj
282
283 # Prepares the object of an outgoing create activity.
284 def prepare_object(object) do
285 object
286 |> set_sensitive
287 |> add_hashtags
288 |> add_mention_tags
289 |> add_emoji_tags
290 |> add_attributed_to
291 |> prepare_attachments
292 |> set_conversation
293 |> set_reply_to_uri
294 end
295
296 # @doc
297 # """
298 # internal -> Mastodon
299 # """
300
301 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
302 object =
303 object
304 |> prepare_object
305
306 data =
307 data
308 |> Map.put("object", object)
309 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
310
311 {:ok, data}
312 end
313
314 def prepare_outgoing(%{"type" => _type} = data) do
315 data =
316 data
317 |> maybe_fix_object_url
318 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
319
320 {:ok, data}
321 end
322
323 def maybe_fix_object_url(data) do
324 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
325 case ActivityPub.fetch_object_from_id(data["object"]) do
326 {:ok, relative_object} ->
327 if relative_object.data["external_url"] do
328 _data =
329 data
330 |> Map.put("object", relative_object.data["external_url"])
331 else
332 data
333 end
334
335 e ->
336 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
337 data
338 end
339 else
340 data
341 end
342 end
343
344 def add_hashtags(object) do
345 tags =
346 (object["tag"] || [])
347 |> Enum.map(fn tag ->
348 %{
349 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
350 "name" => "##{tag}",
351 "type" => "Hashtag"
352 }
353 end)
354
355 object
356 |> Map.put("tag", tags)
357 end
358
359 def add_mention_tags(object) do
360 recipients = object["to"] ++ (object["cc"] || [])
361
362 mentions =
363 recipients
364 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
365 |> Enum.filter(& &1)
366 |> Enum.map(fn user ->
367 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
368 end)
369
370 tags = object["tag"] || []
371
372 object
373 |> Map.put("tag", tags ++ mentions)
374 end
375
376 # TODO: we should probably send mtime instead of unix epoch time for updated
377 def add_emoji_tags(object) do
378 tags = object["tag"] || []
379 emoji = object["emoji"] || []
380
381 out =
382 emoji
383 |> Enum.map(fn {name, url} ->
384 %{
385 "icon" => %{"url" => url, "type" => "Image"},
386 "name" => ":" <> name <> ":",
387 "type" => "Emoji",
388 "updated" => "1970-01-01T00:00:00Z",
389 "id" => url
390 }
391 end)
392
393 object
394 |> Map.put("tag", tags ++ out)
395 end
396
397 def set_conversation(object) do
398 Map.put(object, "conversation", object["context"])
399 end
400
401 def set_sensitive(object) do
402 tags = object["tag"] || []
403 Map.put(object, "sensitive", "nsfw" in tags)
404 end
405
406 def add_attributed_to(object) do
407 attributedTo = object["attributedTo"] || object["actor"]
408
409 object
410 |> Map.put("attributedTo", attributedTo)
411 end
412
413 def prepare_attachments(object) do
414 attachments =
415 (object["attachment"] || [])
416 |> Enum.map(fn data ->
417 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
418 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
419 end)
420
421 object
422 |> Map.put("attachment", attachments)
423 end
424
425 defp user_upgrade_task(user) do
426 old_follower_address = User.ap_followers(user)
427
428 q =
429 from(
430 u in User,
431 where: ^old_follower_address in u.following,
432 update: [
433 set: [
434 following:
435 fragment(
436 "array_replace(?,?,?)",
437 u.following,
438 ^old_follower_address,
439 ^user.follower_address
440 )
441 ]
442 ]
443 )
444
445 Repo.update_all(q, [])
446
447 maybe_retire_websub(user.ap_id)
448
449 # Only do this for recent activties, don't go through the whole db.
450 # Only look at the last 1000 activities.
451 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
452
453 q =
454 from(
455 a in Activity,
456 where: ^old_follower_address in a.recipients,
457 where: a.id > ^since,
458 update: [
459 set: [
460 recipients:
461 fragment(
462 "array_replace(?,?,?)",
463 a.recipients,
464 ^old_follower_address,
465 ^user.follower_address
466 )
467 ]
468 ]
469 )
470
471 Repo.update_all(q, [])
472 end
473
474 def upgrade_user_from_ap_id(ap_id, async \\ true) do
475 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
476 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
477 data =
478 data
479 |> Map.put(:info, Map.merge(user.info, data[:info]))
480
481 already_ap = User.ap_enabled?(user)
482
483 {:ok, user} =
484 User.upgrade_changeset(user, data)
485 |> Repo.update()
486
487 if !already_ap do
488 # This could potentially take a long time, do it in the background
489 if async do
490 Task.start(fn ->
491 user_upgrade_task(user)
492 end)
493 else
494 user_upgrade_task(user)
495 end
496 end
497
498 {:ok, user}
499 else
500 e -> e
501 end
502 end
503
504 def maybe_retire_websub(ap_id) do
505 # some sanity checks
506 if is_binary(ap_id) && String.length(ap_id) > 8 do
507 q =
508 from(
509 ws in Pleroma.Web.Websub.WebsubClientSubscription,
510 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
511 )
512
513 Repo.delete_all(q)
514 end
515 end
516 end