1 defmodule Pleroma.Web.ActivityPub.Transmogrifier do
3 A module to handle coding from internal to wire ActivityPub and back.
9 alias Pleroma.Web.ActivityPub.ActivityPub
10 alias Pleroma.Web.ActivityPub.Utils
16 def get_actor(%{"actor" => actor}) when is_binary(actor) do
20 def get_actor(%{"actor" => actor}) when is_list(actor) do
21 if is_binary(Enum.at(actor, 0)) do
24 Enum.find(actor, fn %{"type" => type} -> type == "Person" end)
29 def get_actor(%{"actor" => actor}) when is_map(actor) do
34 Modifies an incoming AP object (mastodon format) to our internal format.
36 def fix_object(object) do
48 def fix_addressing_list(map, field) do
49 if is_binary(map[field]) do
51 |> Map.put(field, [map[field]])
57 def fix_addressing(map) do
59 |> fix_addressing_list("to")
60 |> fix_addressing_list("cc")
61 |> fix_addressing_list("bto")
62 |> fix_addressing_list("bcc")
65 def fix_actor(%{"attributedTo" => actor} = object) do
67 |> Map.put("actor", get_actor(%{"actor" => actor}))
70 def fix_in_reply_to(%{"inReplyTo" => in_reply_to_id} = object)
71 when not is_nil(in_reply_to_id) do
72 case ActivityPub.fetch_object_from_id(in_reply_to_id) do
73 {:ok, replied_object} ->
74 with %Activity{} = activity <-
75 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
77 |> Map.put("inReplyTo", replied_object.data["id"])
78 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
79 |> Map.put("inReplyToStatusId", activity.id)
80 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
81 |> Map.put("context", replied_object.data["context"] || object["conversation"])
84 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
89 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
94 def fix_in_reply_to(object), do: object
96 def fix_context(object) do
97 context = object["context"] || object["conversation"] || Utils.generate_context_id()
100 |> Map.put("context", context)
101 |> Map.put("conversation", context)
104 def fix_attachments(object) do
106 (object["attachment"] || [])
107 |> Enum.map(fn data ->
108 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
109 Map.put(data, "url", url)
113 |> Map.put("attachment", attachments)
116 def fix_emoji(object) do
117 tags = object["tag"] || []
118 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
122 |> Enum.reduce(%{}, fn data, mapping ->
126 if String.starts_with?(name, ":") do
127 name |> String.slice(1..-2)
132 mapping |> Map.put(name, data["icon"]["url"])
135 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
136 emoji = Map.merge(object["emoji"] || %{}, emoji)
139 |> Map.put("emoji", emoji)
142 def fix_tag(object) do
144 (object["tag"] || [])
145 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
146 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
148 combined = (object["tag"] || []) ++ tags
151 |> Map.put("tag", combined)
154 # content map usually only has one language so this will do for now.
155 def fix_content_map(%{"contentMap" => content_map} = object) do
156 content_groups = Map.to_list(content_map)
157 {_, content} = Enum.at(content_groups, 0)
160 |> Map.put("content", content)
163 def fix_content_map(object), do: object
165 # TODO: validate those with a Ecto scheme
168 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
169 when objtype in ["Article", "Note", "Video"] do
170 actor = get_actor(data)
173 Map.put(data, "actor", actor)
176 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
177 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
178 object = fix_object(data["object"])
184 context: object["conversation"],
186 published: data["published"],
194 ActivityPub.create(params)
196 %Activity{} = activity -> {:ok, activity}
202 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
204 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
205 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
206 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
207 if not User.locked?(followed) do
208 ActivityPub.accept(%{
209 to: [follower.ap_id],
210 actor: followed.ap_id,
215 User.follow(follower, followed)
224 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
225 with true <- id =~ "follows",
226 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
227 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
234 defp mastodon_follow_hack(_), do: {:error, nil}
236 defp get_follow_activity(follow_object, followed) do
237 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
238 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
241 # Can't find the activity. This might a Mastodon 2.3 "Accept"
243 mastodon_follow_hack(follow_object, followed)
251 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
253 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
254 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
255 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
257 ActivityPub.accept(%{
258 to: follow_activity.data["to"],
260 actor: followed.ap_id,
261 object: follow_activity.data["id"],
264 if not User.following?(follower, followed) do
265 {:ok, follower} = User.follow(follower, followed)
275 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
277 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
278 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
279 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
281 ActivityPub.accept(%{
282 to: follow_activity.data["to"],
284 actor: followed.ap_id,
285 object: follow_activity.data["id"],
288 User.unfollow(follower, followed)
297 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
299 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
301 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
302 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
310 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
312 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
314 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
315 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
323 %{"type" => "Update", "object" => %{"type" => "Person"} = object, "actor" => actor_id} =
326 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
327 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
329 banner = new_user_data[:info]["banner"]
330 locked = new_user_data[:info]["locked"] || false
334 |> Map.take([:name, :bio, :avatar])
335 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
338 |> User.upgrade_changeset(update_data)
339 |> User.update_and_set_cache()
341 ActivityPub.update(%{
343 to: data["to"] || [],
344 cc: data["cc"] || [],
357 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
359 object_id = Utils.get_ap_id(object_id)
361 with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
363 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
364 {:ok, activity} <- ActivityPub.delete(object, false) do
374 "object" => %{"type" => "Announce", "object" => object_id},
379 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
381 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
382 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
392 "object" => %{"type" => "Follow", "object" => followed},
397 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
398 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
399 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
400 User.unfollow(follower, followed)
407 @ap_config Application.get_env(:pleroma, :activitypub)
408 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
413 "object" => %{"type" => "Block", "object" => blocked},
418 with true <- @accept_blocks,
419 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
420 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
421 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
422 User.unblock(blocker, blocked)
430 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
432 with true <- @accept_blocks,
433 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
434 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
435 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
436 User.unfollow(blocker, blocked)
437 User.block(blocker, blocked)
447 "object" => %{"type" => "Like", "object" => object_id},
452 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
454 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
455 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
462 def handle_incoming(_), do: :error
464 def get_obj_helper(id) do
465 if object = Object.normalize(id), do: {:ok, object}, else: nil
468 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
469 with false <- String.starts_with?(inReplyTo, "http"),
470 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
471 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
477 def set_reply_to_uri(obj), do: obj
479 # Prepares the object of an outgoing create activity.
480 def prepare_object(object) do
487 |> prepare_attachments
494 # internal -> Mastodon
497 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
504 |> Map.put("object", object)
505 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
510 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
511 # because of course it does.
512 def prepare_outgoing(%{"type" => "Accept"} = data) do
513 with follow_activity <- Activity.normalize(data["object"]) do
515 "actor" => follow_activity.actor,
516 "object" => follow_activity.data["object"],
517 "id" => follow_activity.data["id"],
523 |> Map.put("object", object)
524 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
530 def prepare_outgoing(%{"type" => "Reject"} = data) do
531 with follow_activity <- Activity.normalize(data["object"]) do
533 "actor" => follow_activity.actor,
534 "object" => follow_activity.data["object"],
535 "id" => follow_activity.data["id"],
541 |> Map.put("object", object)
542 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
548 def prepare_outgoing(%{"type" => _type} = data) do
551 |> maybe_fix_object_url
552 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
557 def maybe_fix_object_url(data) do
558 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
559 case ActivityPub.fetch_object_from_id(data["object"]) do
560 {:ok, relative_object} ->
561 if relative_object.data["external_url"] do
564 |> Map.put("object", relative_object.data["external_url"])
570 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
578 def add_hashtags(object) do
580 (object["tag"] || [])
581 |> Enum.map(fn tag ->
583 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
590 |> Map.put("tag", tags)
593 def add_mention_tags(object) do
594 recipients = object["to"] ++ (object["cc"] || [])
598 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
600 |> Enum.map(fn user ->
601 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
604 tags = object["tag"] || []
607 |> Map.put("tag", tags ++ mentions)
610 # TODO: we should probably send mtime instead of unix epoch time for updated
611 def add_emoji_tags(object) do
612 tags = object["tag"] || []
613 emoji = object["emoji"] || []
617 |> Enum.map(fn {name, url} ->
619 "icon" => %{"url" => url, "type" => "Image"},
620 "name" => ":" <> name <> ":",
622 "updated" => "1970-01-01T00:00:00Z",
628 |> Map.put("tag", tags ++ out)
631 def set_conversation(object) do
632 Map.put(object, "conversation", object["context"])
635 def set_sensitive(object) do
636 tags = object["tag"] || []
637 Map.put(object, "sensitive", "nsfw" in tags)
640 def add_attributed_to(object) do
641 attributedTo = object["attributedTo"] || object["actor"]
644 |> Map.put("attributedTo", attributedTo)
647 def prepare_attachments(object) do
649 (object["attachment"] || [])
650 |> Enum.map(fn data ->
651 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
652 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
656 |> Map.put("attachment", attachments)
659 defp user_upgrade_task(user) do
660 old_follower_address = User.ap_followers(user)
665 where: ^old_follower_address in u.following,
670 "array_replace(?,?,?)",
672 ^old_follower_address,
673 ^user.follower_address
679 Repo.update_all(q, [])
681 maybe_retire_websub(user.ap_id)
683 # Only do this for recent activties, don't go through the whole db.
684 # Only look at the last 1000 activities.
685 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
690 where: ^old_follower_address in a.recipients,
691 where: a.id > ^since,
696 "array_replace(?,?,?)",
698 ^old_follower_address,
699 ^user.follower_address
705 Repo.update_all(q, [])
708 def upgrade_user_from_ap_id(ap_id, async \\ true) do
709 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
710 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
713 |> Map.put(:info, Map.merge(user.info, data[:info]))
715 already_ap = User.ap_enabled?(user)
718 User.upgrade_changeset(user, data)
722 # This could potentially take a long time, do it in the background
725 user_upgrade_task(user)
728 user_upgrade_task(user)
738 def maybe_retire_websub(ap_id) do
740 if is_binary(ap_id) && String.length(ap_id) > 8 do
743 ws in Pleroma.Web.Websub.WebsubClientSubscription,
744 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
751 def maybe_fix_user_url(data) do
752 if is_map(data["url"]) do
753 Map.put(data, "url", data["url"]["href"])
759 def maybe_fix_user_object(data) do
761 |> maybe_fix_user_url