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
24 def get_actor(%{"actor" => actor}) when is_map(actor) do
28 def get_actor(%{"actor" => actor_list}) do
29 Enum.find(actor_list, fn %{"type" => type} -> type == "Person" end)
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
98 |> Map.put("context", object["conversation"])
101 def fix_attachments(object) do
103 (object["attachment"] || [])
104 |> Enum.map(fn data ->
105 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
106 Map.put(data, "url", url)
110 |> Map.put("attachment", attachments)
113 def fix_emoji(object) do
114 tags = object["tag"] || []
115 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
119 |> Enum.reduce(%{}, fn data, mapping ->
123 if String.starts_with?(name, ":") do
124 name |> String.slice(1..-2)
129 mapping |> Map.put(name, data["icon"]["url"])
132 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
133 emoji = Map.merge(object["emoji"] || %{}, emoji)
136 |> Map.put("emoji", emoji)
139 def fix_tag(object) do
141 (object["tag"] || [])
142 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
143 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
145 combined = (object["tag"] || []) ++ tags
148 |> Map.put("tag", combined)
151 # content map usually only has one language so this will do for now.
152 def fix_content_map(%{"contentMap" => content_map} = object) do
153 content_groups = Map.to_list(content_map)
154 {_, content} = Enum.at(content_groups, 0)
157 |> Map.put("content", content)
160 def fix_content_map(object), do: object
162 # TODO: validate those with a Ecto scheme
165 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
166 when objtype in ["Article", "Note"] do
167 actor = get_actor(data)
170 Map.put(data, "actor", actor)
173 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
174 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
175 object = fix_object(data["object"])
181 context: object["conversation"],
183 published: data["published"],
191 ActivityPub.create(params)
193 %Activity{} = activity -> {:ok, activity}
199 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
201 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
202 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
203 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
204 if not User.locked?(followed) do
205 ActivityPub.accept(%{
206 to: [follower.ap_id],
207 actor: followed.ap_id,
212 User.follow(follower, followed)
221 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
222 with true <- id =~ "follows",
223 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
224 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
231 defp mastodon_follow_hack(_), do: {:error, nil}
233 defp get_follow_activity(follow_object, followed) do
234 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
235 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
238 # Can't find the activity. This might a Mastodon 2.3 "Accept"
240 mastodon_follow_hack(follow_object, followed)
248 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
250 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
251 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
252 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
254 ActivityPub.accept(%{
255 to: follow_activity.data["to"],
257 actor: followed.ap_id,
258 object: follow_activity.data["id"],
261 if not User.following?(follower, followed) do
262 {:ok, follower} = User.follow(follower, followed)
272 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
274 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
275 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
276 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
278 ActivityPub.accept(%{
279 to: follow_activity.data["to"],
281 actor: followed.ap_id,
282 object: follow_activity.data["id"],
285 User.unfollow(follower, followed)
294 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
296 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
298 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
299 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
307 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
309 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
311 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
312 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
320 %{"type" => "Update", "object" => %{"type" => "Person"} = object, "actor" => actor_id} =
323 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
324 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
326 banner = new_user_data[:info]["banner"]
327 locked = new_user_data[:info]["locked"] || false
331 |> Map.take([:name, :bio, :avatar])
332 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
335 |> User.upgrade_changeset(update_data)
336 |> User.update_and_set_cache()
338 ActivityPub.update(%{
340 to: data["to"] || [],
341 cc: data["cc"] || [],
354 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
356 object_id = Utils.get_ap_id(object_id)
358 with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
360 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
361 {:ok, activity} <- ActivityPub.delete(object, false) do
371 "object" => %{"type" => "Announce", "object" => object_id},
376 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
378 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
379 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
389 "object" => %{"type" => "Follow", "object" => followed},
394 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
395 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
396 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
397 User.unfollow(follower, followed)
404 @ap_config Application.get_env(:pleroma, :activitypub)
405 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
410 "object" => %{"type" => "Block", "object" => blocked},
415 with true <- @accept_blocks,
416 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
417 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
418 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
419 User.unblock(blocker, blocked)
427 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
429 with true <- @accept_blocks,
430 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
431 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
432 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
433 User.unfollow(blocker, blocked)
434 User.block(blocker, blocked)
444 "object" => %{"type" => "Like", "object" => object_id},
449 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
451 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
452 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
459 def handle_incoming(_), do: :error
461 def get_obj_helper(id) do
462 if object = Object.normalize(id), do: {:ok, object}, else: nil
465 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
466 with false <- String.starts_with?(inReplyTo, "http"),
467 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
468 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
474 def set_reply_to_uri(obj), do: obj
476 # Prepares the object of an outgoing create activity.
477 def prepare_object(object) do
484 |> prepare_attachments
491 # internal -> Mastodon
494 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
501 |> Map.put("object", object)
502 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
507 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
508 # because of course it does.
509 def prepare_outgoing(%{"type" => "Accept"} = data) do
510 with follow_activity <- Activity.normalize(data["object"]) do
512 "actor" => follow_activity.actor,
513 "object" => follow_activity.data["object"],
514 "id" => follow_activity.data["id"],
520 |> Map.put("object", object)
521 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
527 def prepare_outgoing(%{"type" => "Reject"} = data) do
528 with follow_activity <- Activity.normalize(data["object"]) do
530 "actor" => follow_activity.actor,
531 "object" => follow_activity.data["object"],
532 "id" => follow_activity.data["id"],
538 |> Map.put("object", object)
539 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
545 def prepare_outgoing(%{"type" => _type} = data) do
548 |> maybe_fix_object_url
549 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
554 def maybe_fix_object_url(data) do
555 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
556 case ActivityPub.fetch_object_from_id(data["object"]) do
557 {:ok, relative_object} ->
558 if relative_object.data["external_url"] do
561 |> Map.put("object", relative_object.data["external_url"])
567 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
575 def add_hashtags(object) do
577 (object["tag"] || [])
578 |> Enum.map(fn tag ->
580 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
587 |> Map.put("tag", tags)
590 def add_mention_tags(object) do
591 recipients = object["to"] ++ (object["cc"] || [])
595 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
597 |> Enum.map(fn user ->
598 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
601 tags = object["tag"] || []
604 |> Map.put("tag", tags ++ mentions)
607 # TODO: we should probably send mtime instead of unix epoch time for updated
608 def add_emoji_tags(object) do
609 tags = object["tag"] || []
610 emoji = object["emoji"] || []
614 |> Enum.map(fn {name, url} ->
616 "icon" => %{"url" => url, "type" => "Image"},
617 "name" => ":" <> name <> ":",
619 "updated" => "1970-01-01T00:00:00Z",
625 |> Map.put("tag", tags ++ out)
628 def set_conversation(object) do
629 Map.put(object, "conversation", object["context"])
632 def set_sensitive(object) do
633 tags = object["tag"] || []
634 Map.put(object, "sensitive", "nsfw" in tags)
637 def add_attributed_to(object) do
638 attributedTo = object["attributedTo"] || object["actor"]
641 |> Map.put("attributedTo", attributedTo)
644 def prepare_attachments(object) do
646 (object["attachment"] || [])
647 |> Enum.map(fn data ->
648 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
649 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
653 |> Map.put("attachment", attachments)
656 defp user_upgrade_task(user) do
657 old_follower_address = User.ap_followers(user)
662 where: ^old_follower_address in u.following,
667 "array_replace(?,?,?)",
669 ^old_follower_address,
670 ^user.follower_address
676 Repo.update_all(q, [])
678 maybe_retire_websub(user.ap_id)
680 # Only do this for recent activties, don't go through the whole db.
681 # Only look at the last 1000 activities.
682 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
687 where: ^old_follower_address in a.recipients,
688 where: a.id > ^since,
693 "array_replace(?,?,?)",
695 ^old_follower_address,
696 ^user.follower_address
702 Repo.update_all(q, [])
705 def upgrade_user_from_ap_id(ap_id, async \\ true) do
706 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
707 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
710 |> Map.put(:info, Map.merge(user.info, data[:info]))
712 already_ap = User.ap_enabled?(user)
715 User.upgrade_changeset(user, data)
719 # This could potentially take a long time, do it in the background
722 user_upgrade_task(user)
725 user_upgrade_task(user)
735 def maybe_retire_websub(ap_id) do
737 if is_binary(ap_id) && String.length(ap_id) > 8 do
740 ws in Pleroma.Web.Websub.WebsubClientSubscription,
741 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
748 def maybe_fix_user_url(data) do
749 if is_map(data["url"]) do
750 Map.put(data, "url", data["url"]["href"])
756 def maybe_fix_user_object(data) do
758 |> maybe_fix_user_url