1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.ActivityPub.Transmogrifier do
7 A module to handle coding from internal to wire ActivityPub and back.
10 alias Pleroma.EctoType.ActivityPub.ObjectValidators
13 alias Pleroma.Object.Containment
16 alias Pleroma.Web.ActivityPub.ActivityPub
17 alias Pleroma.Web.ActivityPub.Builder
18 alias Pleroma.Web.ActivityPub.ObjectValidator
19 alias Pleroma.Web.ActivityPub.Pipeline
20 alias Pleroma.Web.ActivityPub.Utils
21 alias Pleroma.Web.ActivityPub.Visibility
22 alias Pleroma.Web.Federator
23 alias Pleroma.Workers.TransmogrifierWorker
28 require Pleroma.Constants
31 Modifies an incoming AP object (mastodon format) to our internal format.
33 def fix_object(object, options \\ []) do
35 |> strip_internal_fields()
40 |> fix_in_reply_to(options)
49 def fix_summary(%{"summary" => nil} = object) do
50 Map.put(object, "summary", "")
53 def fix_summary(%{"summary" => _} = object) do
54 # summary is present, nothing to do
58 def fix_summary(object), do: Map.put(object, "summary", "")
60 def fix_addressing_list(map, field) do
65 Map.put(map, field, Enum.filter(addrs, &is_binary/1))
68 Map.put(map, field, [addrs])
71 Map.put(map, field, [])
75 def fix_explicit_addressing(
76 %{"to" => to, "cc" => cc} = object,
80 explicit_to = Enum.filter(to, fn x -> x in explicit_mentions end)
82 explicit_cc = Enum.filter(to, fn x -> x not in explicit_mentions end)
86 |> Enum.reject(fn x -> String.ends_with?(x, "/followers") and x != follower_collection end)
90 |> Map.put("to", explicit_to)
91 |> Map.put("cc", final_cc)
94 def fix_explicit_addressing(object, _explicit_mentions, _followers_collection), do: object
96 # if directMessage flag is set to true, leave the addressing alone
97 def fix_explicit_addressing(%{"directMessage" => true} = object), do: object
99 def fix_explicit_addressing(object) do
100 explicit_mentions = Utils.determine_explicit_mentions(object)
102 %User{follower_address: follower_collection} =
104 |> Containment.get_actor()
105 |> User.get_cached_by_ap_id()
110 Pleroma.Constants.as_public(),
114 fix_explicit_addressing(object, explicit_mentions, follower_collection)
117 # if as:Public is addressed, then make sure the followers collection is also addressed
118 # so that the activities will be delivered to local users.
119 def fix_implicit_addressing(%{"to" => to, "cc" => cc} = object, followers_collection) do
120 recipients = to ++ cc
122 if followers_collection not in recipients do
124 Pleroma.Constants.as_public() in cc ->
125 to = to ++ [followers_collection]
126 Map.put(object, "to", to)
128 Pleroma.Constants.as_public() in to ->
129 cc = cc ++ [followers_collection]
130 Map.put(object, "cc", cc)
140 def fix_implicit_addressing(object, _), do: object
142 def fix_addressing(object) do
143 {:ok, %User{} = user} = User.get_or_fetch_by_ap_id(object["actor"])
144 followers_collection = User.ap_followers(user)
147 |> fix_addressing_list("to")
148 |> fix_addressing_list("cc")
149 |> fix_addressing_list("bto")
150 |> fix_addressing_list("bcc")
151 |> fix_explicit_addressing()
152 |> fix_implicit_addressing(followers_collection)
155 def fix_actor(%{"attributedTo" => actor} = object) do
156 actor = Containment.get_actor(%{"actor" => actor})
158 # TODO: Remove actor field for Objects
160 |> Map.put("actor", actor)
161 |> Map.put("attributedTo", actor)
164 def fix_in_reply_to(object, options \\ [])
166 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object, options)
167 when not is_nil(in_reply_to) do
168 in_reply_to_id = prepare_in_reply_to(in_reply_to)
169 depth = (options[:depth] || 0) + 1
171 if Federator.allowed_thread_distance?(depth) do
172 with {:ok, replied_object} <- get_obj_helper(in_reply_to_id, options),
173 %Activity{} <- Activity.get_create_by_object_ap_id(replied_object.data["id"]) do
175 |> Map.put("inReplyTo", replied_object.data["id"])
176 |> Map.put("context", replied_object.data["context"] || object["conversation"])
177 |> Map.drop(["conversation", "inReplyToAtomUri"])
180 Logger.warn("Couldn't fetch #{inspect(in_reply_to_id)}, error: #{inspect(e)}")
188 def fix_in_reply_to(object, _options), do: object
190 defp prepare_in_reply_to(in_reply_to) do
192 is_bitstring(in_reply_to) ->
195 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
198 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
199 Enum.at(in_reply_to, 0)
206 def fix_context(object) do
207 context = object["context"] || object["conversation"] || Utils.generate_context_id()
210 |> Map.put("context", context)
211 |> Map.drop(["conversation"])
214 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
216 Enum.map(attachment, fn data ->
219 is_list(data["url"]) -> List.first(data["url"])
220 is_map(data["url"]) -> data["url"]
226 is_map(url) && MIME.valid?(url["mediaType"]) -> url["mediaType"]
227 MIME.valid?(data["mediaType"]) -> data["mediaType"]
228 MIME.valid?(data["mimeType"]) -> data["mimeType"]
234 is_map(url) && is_binary(url["href"]) -> url["href"]
235 is_binary(data["url"]) -> data["url"]
236 is_binary(data["href"]) -> data["href"]
244 "type" => Map.get(url || %{}, "type", "Link")
246 |> Maps.put_if_present("mediaType", media_type)
247 |> Maps.put_if_present("width", (url || %{})["width"] || data["width"])
248 |> Maps.put_if_present("height", (url || %{})["height"] || data["height"])
251 "url" => [attachment_url],
252 "type" => data["type"] || "Document"
254 |> Maps.put_if_present("mediaType", media_type)
255 |> Maps.put_if_present("name", data["name"])
256 |> Maps.put_if_present("blurhash", data["blurhash"])
263 Map.put(object, "attachment", attachments)
266 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
268 |> Map.put("attachment", [attachment])
272 def fix_attachments(object), do: object
274 def fix_url(%{"url" => url} = object) when is_map(url) do
275 Map.put(object, "url", url["href"])
278 def fix_url(%{"url" => url} = object) when is_list(url) do
279 first_element = Enum.at(url, 0)
283 is_bitstring(first_element) -> first_element
284 is_map(first_element) -> first_element["href"] || ""
288 Map.put(object, "url", url_string)
291 def fix_url(object), do: object
293 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
296 |> Enum.filter(fn data -> is_map(data) and data["type"] == "Emoji" and data["icon"] end)
297 |> Enum.reduce(%{}, fn data, mapping ->
298 name = String.trim(data["name"], ":")
300 Map.put(mapping, name, data["icon"]["url"])
303 Map.put(object, "emoji", emoji)
306 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
307 name = String.trim(tag["name"], ":")
308 emoji = %{name => tag["icon"]["url"]}
310 Map.put(object, "emoji", emoji)
313 def fix_emoji(object), do: object
315 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
318 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
320 %{"name" => "#" <> hashtag} -> String.downcase(hashtag)
321 %{"name" => hashtag} -> String.downcase(hashtag)
324 Map.put(object, "tag", tag ++ tags)
327 def fix_tag(%{"tag" => %{} = tag} = object) do
329 |> Map.put("tag", [tag])
333 def fix_tag(object), do: object
335 # content map usually only has one language so this will do for now.
336 def fix_content_map(%{"contentMap" => content_map} = object) do
337 content_groups = Map.to_list(content_map)
338 {_, content} = Enum.at(content_groups, 0)
340 Map.put(object, "content", content)
343 def fix_content_map(object), do: object
345 def fix_type(object, options \\ [])
347 def fix_type(%{"inReplyTo" => reply_id, "name" => _} = object, options)
348 when is_binary(reply_id) do
349 with true <- Federator.allowed_thread_distance?(options[:depth]),
350 {:ok, %{data: %{"type" => "Question"} = _} = _} <- get_obj_helper(reply_id, options) do
351 Map.put(object, "type", "Answer")
357 def fix_type(object, _), do: object
359 # Reduce the object list to find the reported user.
360 defp get_reported(objects) do
361 Enum.reduce_while(objects, nil, fn ap_id, _ ->
362 with %User{} = user <- User.get_cached_by_ap_id(ap_id) do
370 # Compatibility wrapper for Mastodon votes
371 defp handle_create(%{"object" => %{"type" => "Answer"}} = data, _user) do
372 handle_incoming(data)
375 defp handle_create(%{"object" => object} = data, user) do
380 context: object["context"],
382 published: data["published"],
390 |> ActivityPub.create()
393 def handle_incoming(data, options \\ [])
395 # Flag objects are placed ahead of the ID check because Mastodon 2.8 and earlier send them
397 def handle_incoming(%{"type" => "Flag", "object" => objects, "actor" => actor} = data, _options) do
398 with context <- data["context"] || Utils.generate_context_id(),
399 content <- data["content"] || "",
400 %User{} = actor <- User.get_cached_by_ap_id(actor),
401 # Reduce the object list to find the reported user.
402 %User{} = account <- get_reported(objects),
403 # Remove the reported user from the object list.
404 statuses <- Enum.filter(objects, fn ap_id -> ap_id != account.ap_id end) do
411 additional: %{"cc" => [account.ap_id]}
413 |> ActivityPub.flag()
417 # disallow objects with bogus IDs
418 def handle_incoming(%{"id" => nil}, _options), do: :error
419 def handle_incoming(%{"id" => ""}, _options), do: :error
420 # length of https:// = 8, should validate better, but good enough for now.
421 def handle_incoming(%{"id" => id}, _options) when is_binary(id) and byte_size(id) < 8,
424 # TODO: validate those with a Ecto scheme
428 %{"type" => "Create", "object" => %{"type" => objtype} = object} = data,
431 when objtype in ~w{Note Page} do
432 actor = Containment.get_actor(data)
434 with nil <- Activity.get_create_by_object_ap_id(object["id"]),
435 {:ok, %User{} = user} <- User.get_or_fetch_by_ap_id(actor) do
438 |> Map.put("object", fix_object(object, options))
439 |> Map.put("actor", actor)
442 with {:ok, created_activity} <- handle_create(data, user) do
443 reply_depth = (options[:depth] || 0) + 1
445 if Federator.allowed_thread_distance?(reply_depth) do
446 for reply_id <- replies(object) do
447 Pleroma.Workers.RemoteFetcherWorker.enqueue("fetch_remote", %{
449 "depth" => reply_depth
454 {:ok, created_activity}
457 %Activity{} = activity -> {:ok, activity}
463 %{"type" => "Listen", "object" => %{"type" => "Audio"} = object} = data,
466 actor = Containment.get_actor(data)
469 Map.put(data, "actor", actor)
472 with {:ok, %User{} = user} <- User.get_or_fetch_by_ap_id(data["actor"]) do
473 reply_depth = (options[:depth] || 0) + 1
474 options = Keyword.put(options, :depth, reply_depth)
475 object = fix_object(object, options)
483 published: data["published"],
484 additional: Map.take(data, ["cc", "id"])
487 ActivityPub.listen(params)
493 @misskey_reactions %{
507 @doc "Rewrite misskey likes into EmojiReacts"
511 "_misskey_reaction" => reaction
516 |> Map.put("type", "EmojiReact")
517 |> Map.put("content", @misskey_reactions[reaction] || reaction)
518 |> handle_incoming(options)
522 %{"type" => "Create", "object" => %{"type" => objtype, "id" => obj_id}} = data,
525 when objtype in ~w{Question Answer ChatMessage Audio Video Event Article} do
526 data = Map.put(data, "object", strip_internal_fields(data["object"]))
528 with {:ok, %User{}} <- ObjectValidator.fetch_actor(data),
529 nil <- Activity.get_create_by_object_ap_id(obj_id),
530 {:ok, activity, _} <- Pipeline.common_pipeline(data, local: false) do
533 %Activity{} = activity -> {:ok, activity}
538 def handle_incoming(%{"type" => type} = data, _options)
539 when type in ~w{Like EmojiReact Announce Add Remove} do
540 with :ok <- ObjectValidator.fetch_actor_and_object(data),
541 {:ok, activity, _meta} <-
542 Pipeline.common_pipeline(data, local: false) do
550 %{"type" => type} = data,
553 when type in ~w{Update Block Follow Accept Reject} do
554 with {:ok, %User{}} <- ObjectValidator.fetch_actor(data),
555 {:ok, activity, _} <-
556 Pipeline.common_pipeline(data, local: false) do
562 %{"type" => "Delete"} = data,
565 with {:ok, activity, _} <-
566 Pipeline.common_pipeline(data, local: false) do
569 {:error, {:validate, _}} = e ->
570 # Check if we have a create activity for this
571 with {:ok, object_id} <- ObjectValidators.ObjectID.cast(data["object"]),
572 %Activity{data: %{"actor" => actor}} <-
573 Activity.create_by_object_ap_id(object_id) |> Repo.one(),
574 # We have one, insert a tombstone and retry
575 {:ok, tombstone_data, _} <- Builder.tombstone(actor, object_id),
576 {:ok, _tombstone} <- Object.create(tombstone_data) do
577 handle_incoming(data)
587 "object" => %{"type" => "Follow", "object" => followed},
593 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
594 {:ok, %User{} = follower} <- User.get_or_fetch_by_ap_id(follower),
595 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
596 User.unfollow(follower, followed)
606 "object" => %{"type" => type}
610 when type in ["Like", "EmojiReact", "Announce", "Block"] do
611 with {:ok, activity, _} <- Pipeline.common_pipeline(data, local: false) do
616 # For Undos that don't have the complete object attached, try to find it in our database.
624 when is_binary(object) do
625 with %Activity{data: data} <- Activity.get_by_ap_id(object) do
627 |> Map.put("object", data)
628 |> handle_incoming(options)
637 "actor" => origin_actor,
638 "object" => origin_actor,
639 "target" => target_actor
643 with %User{} = origin_user <- User.get_cached_by_ap_id(origin_actor),
644 {:ok, %User{} = target_user} <- User.get_or_fetch_by_ap_id(target_actor),
645 true <- origin_actor in target_user.also_known_as do
646 ActivityPub.move(origin_user, target_user, false)
652 def handle_incoming(_, _), do: :error
654 @spec get_obj_helper(String.t(), Keyword.t()) :: {:ok, Object.t()} | nil
655 def get_obj_helper(id, options \\ []) do
656 options = Keyword.put(options, :fetch, true)
658 case Object.normalize(id, options) do
659 %Object{} = object -> {:ok, object}
664 @spec get_embedded_obj_helper(String.t() | Object.t(), User.t()) :: {:ok, Object.t()} | nil
665 def get_embedded_obj_helper(%{"attributedTo" => attributed_to, "id" => object_id} = data, %User{
668 when attributed_to == ap_id do
669 with {:ok, activity} <-
674 "actor" => attributed_to,
677 {:ok, Object.normalize(activity, fetch: false)}
679 _ -> get_obj_helper(object_id)
683 def get_embedded_obj_helper(object_id, _) do
684 get_obj_helper(object_id)
687 def set_reply_to_uri(%{"inReplyTo" => in_reply_to} = object) when is_binary(in_reply_to) do
688 with false <- String.starts_with?(in_reply_to, "http"),
689 {:ok, %{data: replied_to_object}} <- get_obj_helper(in_reply_to) do
690 Map.put(object, "inReplyTo", replied_to_object["external_url"] || in_reply_to)
696 def set_reply_to_uri(obj), do: obj
699 Serialized Mastodon-compatible `replies` collection containing _self-replies_.
700 Based on Mastodon's ActivityPub::NoteSerializer#replies.
702 def set_replies(obj_data) do
704 with limit when limit > 0 <-
705 Pleroma.Config.get([:activitypub, :note_replies_output_limit], 0),
706 %Object{} = object <- Object.get_cached_by_ap_id(obj_data["id"]) do
708 |> Object.self_replies()
709 |> select([o], fragment("?->>'id'", o.data))
716 set_replies(obj_data, replies_uris)
719 defp set_replies(obj, []) do
723 defp set_replies(obj, replies_uris) do
724 replies_collection = %{
725 "type" => "Collection",
726 "items" => replies_uris
729 Map.merge(obj, %{"replies" => replies_collection})
732 def replies(%{"replies" => %{"first" => %{"items" => items}}}) when not is_nil(items) do
736 def replies(%{"replies" => %{"items" => items}}) when not is_nil(items) do
740 def replies(_), do: []
742 # Prepares the object of an outgoing create activity.
743 def prepare_object(object) do
749 |> prepare_attachments
753 |> strip_internal_fields
754 |> strip_internal_tags
760 # internal -> Mastodon
763 def prepare_outgoing(%{"type" => activity_type, "object" => object_id} = data)
764 when activity_type in ["Create", "Listen"] do
767 |> Object.normalize(fetch: false)
773 |> Map.put("object", object)
774 |> Map.merge(Utils.make_json_ld_header())
780 def prepare_outgoing(%{"type" => "Announce", "actor" => ap_id, "object" => object_id} = data) do
783 |> Object.normalize(fetch: false)
786 if Visibility.is_private?(object) && object.data["actor"] == ap_id do
787 data |> Map.put("object", object |> Map.get(:data) |> prepare_object)
789 data |> maybe_fix_object_url
794 |> strip_internal_fields
795 |> Map.merge(Utils.make_json_ld_header())
801 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
802 # because of course it does.
803 def prepare_outgoing(%{"type" => "Accept"} = data) do
804 with follow_activity <- Activity.normalize(data["object"]) do
806 "actor" => follow_activity.actor,
807 "object" => follow_activity.data["object"],
808 "id" => follow_activity.data["id"],
814 |> Map.put("object", object)
815 |> Map.merge(Utils.make_json_ld_header())
821 def prepare_outgoing(%{"type" => "Reject"} = data) do
822 with follow_activity <- Activity.normalize(data["object"]) do
824 "actor" => follow_activity.actor,
825 "object" => follow_activity.data["object"],
826 "id" => follow_activity.data["id"],
832 |> Map.put("object", object)
833 |> Map.merge(Utils.make_json_ld_header())
839 def prepare_outgoing(%{"type" => _type} = data) do
842 |> strip_internal_fields
843 |> maybe_fix_object_url
844 |> Map.merge(Utils.make_json_ld_header())
849 def maybe_fix_object_url(%{"object" => object} = data) when is_binary(object) do
850 with false <- String.starts_with?(object, "http"),
851 {:fetch, {:ok, relative_object}} <- {:fetch, get_obj_helper(object)},
852 %{data: %{"external_url" => external_url}} when not is_nil(external_url) <-
854 Map.put(data, "object", external_url)
857 Logger.error("Couldn't fetch #{object} #{inspect(e)}")
865 def maybe_fix_object_url(data), do: data
867 def add_hashtags(object) do
869 (object["tag"] || [])
871 # Expand internal representation tags into AS2 tags.
872 tag when is_binary(tag) ->
874 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
879 # Do not process tags which are already AS2 tag objects.
880 tag when is_map(tag) ->
884 Map.put(object, "tag", tags)
887 # TODO These should be added on our side on insertion, it doesn't make much
888 # sense to regenerate these all the time
889 def add_mention_tags(object) do
890 to = object["to"] || []
891 cc = object["cc"] || []
892 mentioned = User.get_users_from_set(to ++ cc, local_only: false)
894 mentions = Enum.map(mentioned, &build_mention_tag/1)
896 tags = object["tag"] || []
897 Map.put(object, "tag", tags ++ mentions)
900 defp build_mention_tag(%{ap_id: ap_id, nickname: nickname} = _) do
901 %{"type" => "Mention", "href" => ap_id, "name" => "@#{nickname}"}
904 def take_emoji_tags(%User{emoji: emoji}) do
907 |> Enum.map(&build_emoji_tag/1)
910 # TODO: we should probably send mtime instead of unix epoch time for updated
911 def add_emoji_tags(%{"emoji" => emoji} = object) do
912 tags = object["tag"] || []
914 out = Enum.map(emoji, &build_emoji_tag/1)
916 Map.put(object, "tag", tags ++ out)
919 def add_emoji_tags(object), do: object
921 defp build_emoji_tag({name, url}) do
923 "icon" => %{"url" => "#{URI.encode(url)}", "type" => "Image"},
924 "name" => ":" <> name <> ":",
926 "updated" => "1970-01-01T00:00:00Z",
931 def set_conversation(object) do
932 Map.put(object, "conversation", object["context"])
935 def set_type(%{"type" => "Answer"} = object) do
936 Map.put(object, "type", "Note")
939 def set_type(object), do: object
941 def add_attributed_to(object) do
942 attributed_to = object["attributedTo"] || object["actor"]
943 Map.put(object, "attributedTo", attributed_to)
947 def prepare_attachments(%{"type" => "ChatMessage"} = object), do: object
949 def prepare_attachments(object) do
952 |> Map.get("attachment", [])
953 |> Enum.map(fn data ->
954 [%{"mediaType" => media_type, "href" => href} = url | _] = data["url"]
958 "mediaType" => media_type,
959 "name" => data["name"],
962 |> Maps.put_if_present("width", url["width"])
963 |> Maps.put_if_present("height", url["height"])
964 |> Maps.put_if_present("blurhash", data["blurhash"])
967 Map.put(object, "attachment", attachments)
970 def strip_internal_fields(object) do
971 Map.drop(object, Pleroma.Constants.object_internal_fields())
974 defp strip_internal_tags(%{"tag" => tags} = object) do
975 tags = Enum.filter(tags, fn x -> is_map(x) end)
977 Map.put(object, "tag", tags)
980 defp strip_internal_tags(object), do: object
982 def perform(:user_upgrade, user) do
983 # we pass a fake user so that the followers collection is stripped away
984 old_follower_address = User.ap_followers(%User{nickname: user.nickname})
988 where: ^old_follower_address in a.recipients,
993 "array_replace(?,?,?)",
995 ^old_follower_address,
996 ^user.follower_address
1001 |> Repo.update_all([])
1004 def upgrade_user_from_ap_id(ap_id) do
1005 with %User{local: false} = user <- User.get_cached_by_ap_id(ap_id),
1006 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id),
1007 {:ok, user} <- update_user(user, data) do
1008 {:ok, _pid} = Task.start(fn -> ActivityPub.pinned_fetch_task(user) end)
1009 TransmogrifierWorker.enqueue("user_upgrade", %{"user_id" => user.id})
1012 %User{} = user -> {:ok, user}
1017 defp update_user(user, data) do
1019 |> User.remote_user_changeset(data)
1020 |> User.update_and_set_cache()
1023 def maybe_fix_user_url(%{"url" => url} = data) when is_map(url) do
1024 Map.put(data, "url", url["href"])
1027 def maybe_fix_user_url(data), do: data
1029 def maybe_fix_user_object(data), do: maybe_fix_user_url(data)