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)
249 "url" => [attachment_url],
250 "type" => data["type"] || "Document"
252 |> Maps.put_if_present("mediaType", media_type)
253 |> Maps.put_if_present("name", data["name"])
254 |> Maps.put_if_present("blurhash", data["blurhash"])
261 Map.put(object, "attachment", attachments)
264 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
266 |> Map.put("attachment", [attachment])
270 def fix_attachments(object), do: object
272 def fix_url(%{"url" => url} = object) when is_map(url) do
273 Map.put(object, "url", url["href"])
276 def fix_url(%{"url" => url} = object) when is_list(url) do
277 first_element = Enum.at(url, 0)
281 is_bitstring(first_element) -> first_element
282 is_map(first_element) -> first_element["href"] || ""
286 Map.put(object, "url", url_string)
289 def fix_url(object), do: object
291 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
294 |> Enum.filter(fn data -> is_map(data) and data["type"] == "Emoji" and data["icon"] end)
295 |> Enum.reduce(%{}, fn data, mapping ->
296 name = String.trim(data["name"], ":")
298 Map.put(mapping, name, data["icon"]["url"])
301 Map.put(object, "emoji", emoji)
304 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
305 name = String.trim(tag["name"], ":")
306 emoji = %{name => tag["icon"]["url"]}
308 Map.put(object, "emoji", emoji)
311 def fix_emoji(object), do: object
313 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
316 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
318 %{"name" => "#" <> hashtag} -> String.downcase(hashtag)
319 %{"name" => hashtag} -> String.downcase(hashtag)
322 Map.put(object, "tag", tag ++ tags)
325 def fix_tag(%{"tag" => %{} = tag} = object) do
327 |> Map.put("tag", [tag])
331 def fix_tag(object), do: object
333 # content map usually only has one language so this will do for now.
334 def fix_content_map(%{"contentMap" => content_map} = object) do
335 content_groups = Map.to_list(content_map)
336 {_, content} = Enum.at(content_groups, 0)
338 Map.put(object, "content", content)
341 def fix_content_map(object), do: object
343 def fix_type(object, options \\ [])
345 def fix_type(%{"inReplyTo" => reply_id, "name" => _} = object, options)
346 when is_binary(reply_id) do
347 with true <- Federator.allowed_thread_distance?(options[:depth]),
348 {:ok, %{data: %{"type" => "Question"} = _} = _} <- get_obj_helper(reply_id, options) do
349 Map.put(object, "type", "Answer")
355 def fix_type(object, _), do: object
357 # Reduce the object list to find the reported user.
358 defp get_reported(objects) do
359 Enum.reduce_while(objects, nil, fn ap_id, _ ->
360 with %User{} = user <- User.get_cached_by_ap_id(ap_id) do
368 # Compatibility wrapper for Mastodon votes
369 defp handle_create(%{"object" => %{"type" => "Answer"}} = data, _user) do
370 handle_incoming(data)
373 defp handle_create(%{"object" => object} = data, user) do
378 context: object["context"],
380 published: data["published"],
388 |> ActivityPub.create()
391 def handle_incoming(data, options \\ [])
393 # Flag objects are placed ahead of the ID check because Mastodon 2.8 and earlier send them
395 def handle_incoming(%{"type" => "Flag", "object" => objects, "actor" => actor} = data, _options) do
396 with context <- data["context"] || Utils.generate_context_id(),
397 content <- data["content"] || "",
398 %User{} = actor <- User.get_cached_by_ap_id(actor),
399 # Reduce the object list to find the reported user.
400 %User{} = account <- get_reported(objects),
401 # Remove the reported user from the object list.
402 statuses <- Enum.filter(objects, fn ap_id -> ap_id != account.ap_id end) do
409 additional: %{"cc" => [account.ap_id]}
411 |> ActivityPub.flag()
415 # disallow objects with bogus IDs
416 def handle_incoming(%{"id" => nil}, _options), do: :error
417 def handle_incoming(%{"id" => ""}, _options), do: :error
418 # length of https:// = 8, should validate better, but good enough for now.
419 def handle_incoming(%{"id" => id}, _options) when is_binary(id) and byte_size(id) < 8,
422 # TODO: validate those with a Ecto scheme
426 %{"type" => "Create", "object" => %{"type" => objtype} = object} = data,
429 when objtype in ~w{Note Page} do
430 actor = Containment.get_actor(data)
432 with nil <- Activity.get_create_by_object_ap_id(object["id"]),
433 {:ok, %User{} = user} <- User.get_or_fetch_by_ap_id(actor) do
436 |> Map.put("object", fix_object(object, options))
437 |> Map.put("actor", actor)
440 with {:ok, created_activity} <- handle_create(data, user) do
441 reply_depth = (options[:depth] || 0) + 1
443 if Federator.allowed_thread_distance?(reply_depth) do
444 for reply_id <- replies(object) do
445 Pleroma.Workers.RemoteFetcherWorker.enqueue("fetch_remote", %{
447 "depth" => reply_depth
452 {:ok, created_activity}
455 %Activity{} = activity -> {:ok, activity}
461 %{"type" => "Listen", "object" => %{"type" => "Audio"} = object} = data,
464 actor = Containment.get_actor(data)
467 Map.put(data, "actor", actor)
470 with {:ok, %User{} = user} <- User.get_or_fetch_by_ap_id(data["actor"]) do
471 reply_depth = (options[:depth] || 0) + 1
472 options = Keyword.put(options, :depth, reply_depth)
473 object = fix_object(object, options)
481 published: data["published"],
482 additional: Map.take(data, ["cc", "id"])
485 ActivityPub.listen(params)
491 @misskey_reactions %{
505 @doc "Rewrite misskey likes into EmojiReacts"
509 "_misskey_reaction" => reaction
514 |> Map.put("type", "EmojiReact")
515 |> Map.put("content", @misskey_reactions[reaction] || reaction)
516 |> handle_incoming(options)
520 %{"type" => "Create", "object" => %{"type" => objtype, "id" => obj_id}} = data,
523 when objtype in ~w{Question Answer ChatMessage Audio Video Event Article} do
524 data = Map.put(data, "object", strip_internal_fields(data["object"]))
526 with {:ok, %User{}} <- ObjectValidator.fetch_actor(data),
527 nil <- Activity.get_create_by_object_ap_id(obj_id),
528 {:ok, activity, _} <- Pipeline.common_pipeline(data, local: false) do
531 %Activity{} = activity -> {:ok, activity}
536 def handle_incoming(%{"type" => type} = data, _options)
537 when type in ~w{Like EmojiReact Announce} do
538 with :ok <- ObjectValidator.fetch_actor_and_object(data),
539 {:ok, activity, _meta} <-
540 Pipeline.common_pipeline(data, local: false) do
548 %{"type" => type} = data,
551 when type in ~w{Update Block Follow Accept Reject} do
552 with {:ok, %User{}} <- ObjectValidator.fetch_actor(data),
553 {:ok, activity, _} <-
554 Pipeline.common_pipeline(data, local: false) do
559 def handle_incoming(%{"type" => type} = data, _options) when type in ~w(Add Remove) do
560 with :ok <- ObjectValidator.fetch_actor_and_object(data),
561 {:ok, actor} <- Pleroma.User.get_or_fetch_by_ap_id(data["actor"]),
562 # maybe locally user doesn't have featured_address
563 {:ok, _} <- maybe_refetch_user(actor),
564 {:ok, activity, _meta} <- Pipeline.common_pipeline(data, local: false) do
570 %{"type" => "Delete"} = data,
573 with {:ok, activity, _} <-
574 Pipeline.common_pipeline(data, local: false) do
577 {:error, {:validate_object, _}} = e ->
578 # Check if we have a create activity for this
579 with {:ok, object_id} <- ObjectValidators.ObjectID.cast(data["object"]),
580 %Activity{data: %{"actor" => actor}} <-
581 Activity.create_by_object_ap_id(object_id) |> Repo.one(),
582 # We have one, insert a tombstone and retry
583 {:ok, tombstone_data, _} <- Builder.tombstone(actor, object_id),
584 {:ok, _tombstone} <- Object.create(tombstone_data) do
585 handle_incoming(data)
595 "object" => %{"type" => "Follow", "object" => followed},
601 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
602 {:ok, %User{} = follower} <- User.get_or_fetch_by_ap_id(follower),
603 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
604 User.unfollow(follower, followed)
614 "object" => %{"type" => type}
618 when type in ["Like", "EmojiReact", "Announce", "Block"] do
619 with {:ok, activity, _} <- Pipeline.common_pipeline(data, local: false) do
624 # For Undos that don't have the complete object attached, try to find it in our database.
632 when is_binary(object) do
633 with %Activity{data: data} <- Activity.get_by_ap_id(object) do
635 |> Map.put("object", data)
636 |> handle_incoming(options)
645 "actor" => origin_actor,
646 "object" => origin_actor,
647 "target" => target_actor
651 with %User{} = origin_user <- User.get_cached_by_ap_id(origin_actor),
652 {:ok, %User{} = target_user} <- User.get_or_fetch_by_ap_id(target_actor),
653 true <- origin_actor in target_user.also_known_as do
654 ActivityPub.move(origin_user, target_user, false)
660 def handle_incoming(_, _), do: :error
662 defp maybe_refetch_user(%User{featured_address: address} = user) when is_binary(address) do
666 defp maybe_refetch_user(%User{ap_id: ap_id}), do: upgrade_user_from_ap_id(ap_id)
668 @spec get_obj_helper(String.t(), Keyword.t()) :: {:ok, Object.t()} | nil
669 def get_obj_helper(id, options \\ []) do
670 options = Keyword.put(options, :fetch, true)
672 case Object.normalize(id, options) do
673 %Object{} = object -> {:ok, object}
678 @spec get_embedded_obj_helper(String.t() | Object.t(), User.t()) :: {:ok, Object.t()} | nil
679 def get_embedded_obj_helper(%{"attributedTo" => attributed_to, "id" => object_id} = data, %User{
682 when attributed_to == ap_id do
683 with {:ok, activity} <-
688 "actor" => attributed_to,
691 {:ok, Object.normalize(activity, fetch: false)}
693 _ -> get_obj_helper(object_id)
697 def get_embedded_obj_helper(object_id, _) do
698 get_obj_helper(object_id)
701 def set_reply_to_uri(%{"inReplyTo" => in_reply_to} = object) when is_binary(in_reply_to) do
702 with false <- String.starts_with?(in_reply_to, "http"),
703 {:ok, %{data: replied_to_object}} <- get_obj_helper(in_reply_to) do
704 Map.put(object, "inReplyTo", replied_to_object["external_url"] || in_reply_to)
710 def set_reply_to_uri(obj), do: obj
713 Serialized Mastodon-compatible `replies` collection containing _self-replies_.
714 Based on Mastodon's ActivityPub::NoteSerializer#replies.
716 def set_replies(obj_data) do
718 with limit when limit > 0 <-
719 Pleroma.Config.get([:activitypub, :note_replies_output_limit], 0),
720 %Object{} = object <- Object.get_cached_by_ap_id(obj_data["id"]) do
722 |> Object.self_replies()
723 |> select([o], fragment("?->>'id'", o.data))
730 set_replies(obj_data, replies_uris)
733 defp set_replies(obj, []) do
737 defp set_replies(obj, replies_uris) do
738 replies_collection = %{
739 "type" => "Collection",
740 "items" => replies_uris
743 Map.merge(obj, %{"replies" => replies_collection})
746 def replies(%{"replies" => %{"first" => %{"items" => items}}}) when not is_nil(items) do
750 def replies(%{"replies" => %{"items" => items}}) when not is_nil(items) do
754 def replies(_), do: []
756 # Prepares the object of an outgoing create activity.
757 def prepare_object(object) do
763 |> prepare_attachments
767 |> strip_internal_fields
768 |> strip_internal_tags
774 # internal -> Mastodon
777 def prepare_outgoing(%{"type" => activity_type, "object" => object_id} = data)
778 when activity_type in ["Create", "Listen"] do
781 |> Object.normalize(fetch: false)
787 |> Map.put("object", object)
788 |> Map.merge(Utils.make_json_ld_header())
794 def prepare_outgoing(%{"type" => "Announce", "actor" => ap_id, "object" => object_id} = data) do
797 |> Object.normalize(fetch: false)
800 if Visibility.is_private?(object) && object.data["actor"] == ap_id do
801 data |> Map.put("object", object |> Map.get(:data) |> prepare_object)
803 data |> maybe_fix_object_url
808 |> strip_internal_fields
809 |> Map.merge(Utils.make_json_ld_header())
815 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
816 # because of course it does.
817 def prepare_outgoing(%{"type" => "Accept"} = data) do
818 with follow_activity <- Activity.normalize(data["object"]) do
820 "actor" => follow_activity.actor,
821 "object" => follow_activity.data["object"],
822 "id" => follow_activity.data["id"],
828 |> Map.put("object", object)
829 |> Map.merge(Utils.make_json_ld_header())
835 def prepare_outgoing(%{"type" => "Reject"} = data) do
836 with follow_activity <- Activity.normalize(data["object"]) do
838 "actor" => follow_activity.actor,
839 "object" => follow_activity.data["object"],
840 "id" => follow_activity.data["id"],
846 |> Map.put("object", object)
847 |> Map.merge(Utils.make_json_ld_header())
853 def prepare_outgoing(%{"type" => _type} = data) do
856 |> strip_internal_fields
857 |> maybe_fix_object_url
858 |> Map.merge(Utils.make_json_ld_header())
863 def maybe_fix_object_url(%{"object" => object} = data) when is_binary(object) do
864 with false <- String.starts_with?(object, "http"),
865 {:fetch, {:ok, relative_object}} <- {:fetch, get_obj_helper(object)},
866 %{data: %{"external_url" => external_url}} when not is_nil(external_url) <-
868 Map.put(data, "object", external_url)
871 Logger.error("Couldn't fetch #{object} #{inspect(e)}")
879 def maybe_fix_object_url(data), do: data
881 def add_hashtags(object) do
883 (object["tag"] || [])
885 # Expand internal representation tags into AS2 tags.
886 tag when is_binary(tag) ->
888 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
893 # Do not process tags which are already AS2 tag objects.
894 tag when is_map(tag) ->
898 Map.put(object, "tag", tags)
901 # TODO These should be added on our side on insertion, it doesn't make much
902 # sense to regenerate these all the time
903 def add_mention_tags(object) do
904 to = object["to"] || []
905 cc = object["cc"] || []
906 mentioned = User.get_users_from_set(to ++ cc, local_only: false)
908 mentions = Enum.map(mentioned, &build_mention_tag/1)
910 tags = object["tag"] || []
911 Map.put(object, "tag", tags ++ mentions)
914 defp build_mention_tag(%{ap_id: ap_id, nickname: nickname} = _) do
915 %{"type" => "Mention", "href" => ap_id, "name" => "@#{nickname}"}
918 def take_emoji_tags(%User{emoji: emoji}) do
921 |> Enum.map(&build_emoji_tag/1)
924 # TODO: we should probably send mtime instead of unix epoch time for updated
925 def add_emoji_tags(%{"emoji" => emoji} = object) do
926 tags = object["tag"] || []
928 out = Enum.map(emoji, &build_emoji_tag/1)
930 Map.put(object, "tag", tags ++ out)
933 def add_emoji_tags(object), do: object
935 defp build_emoji_tag({name, url}) do
937 "icon" => %{"url" => "#{URI.encode(url)}", "type" => "Image"},
938 "name" => ":" <> name <> ":",
940 "updated" => "1970-01-01T00:00:00Z",
945 def set_conversation(object) do
946 Map.put(object, "conversation", object["context"])
949 def set_type(%{"type" => "Answer"} = object) do
950 Map.put(object, "type", "Note")
953 def set_type(object), do: object
955 def add_attributed_to(object) do
956 attributed_to = object["attributedTo"] || object["actor"]
957 Map.put(object, "attributedTo", attributed_to)
961 def prepare_attachments(%{"type" => "ChatMessage"} = object), do: object
963 def prepare_attachments(object) do
966 |> Map.get("attachment", [])
967 |> Enum.map(fn data ->
968 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
972 "mediaType" => media_type,
973 "name" => data["name"],
978 Map.put(object, "attachment", attachments)
981 def strip_internal_fields(object) do
982 Map.drop(object, Pleroma.Constants.object_internal_fields())
985 defp strip_internal_tags(%{"tag" => tags} = object) do
986 tags = Enum.filter(tags, fn x -> is_map(x) end)
988 Map.put(object, "tag", tags)
991 defp strip_internal_tags(object), do: object
993 def perform(:user_upgrade, user) do
994 # we pass a fake user so that the followers collection is stripped away
995 old_follower_address = User.ap_followers(%User{nickname: user.nickname})
999 where: ^old_follower_address in a.recipients,
1004 "array_replace(?,?,?)",
1006 ^old_follower_address,
1007 ^user.follower_address
1012 |> Repo.update_all([])
1015 def upgrade_user_from_ap_id(ap_id) do
1016 with %User{local: false} = user <- User.get_cached_by_ap_id(ap_id),
1017 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id),
1018 {:ok, user} <- update_user(user, data) do
1019 {:ok, _pid} = Task.start(fn -> ActivityPub.pinned_fetch_task(user) end)
1020 TransmogrifierWorker.enqueue("user_upgrade", %{"user_id" => user.id})
1023 %User{} = user -> {:ok, user}
1028 defp update_user(user, data) do
1030 |> User.remote_user_changeset(data)
1031 |> User.update_and_set_cache()
1034 def maybe_fix_user_url(%{"url" => url} = data) when is_map(url) do
1035 Map.put(data, "url", url["href"])
1038 def maybe_fix_user_url(data), do: data
1040 def maybe_fix_user_object(data), do: maybe_fix_user_url(data)