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.ActivityPub.ObjectValidators.CommonFixes
23 alias Pleroma.Web.Federator
24 alias Pleroma.Workers.TransmogrifierWorker
29 require Pleroma.Constants
32 Modifies an incoming AP object (mastodon format) to our internal format.
34 def fix_object(object, options \\ []) do
36 |> strip_internal_fields()
41 |> fix_in_reply_to(options)
42 |> fix_quote_url(options)
50 def fix_summary(%{"summary" => nil} = object) do
51 Map.put(object, "summary", "")
54 def fix_summary(%{"summary" => _} = object) do
55 # summary is present, nothing to do
59 def fix_summary(object), do: Map.put(object, "summary", "")
61 def fix_addressing_list(map, field) do
66 Map.put(map, field, Enum.filter(addrs, &is_binary/1))
69 Map.put(map, field, [addrs])
72 Map.put(map, field, [])
76 # if directMessage flag is set to true, leave the addressing alone
77 def fix_explicit_addressing(%{"directMessage" => true} = object, _follower_collection),
80 def fix_explicit_addressing(%{"to" => to, "cc" => cc} = object, follower_collection) do
82 Utils.determine_explicit_mentions(object) ++
83 [Pleroma.Constants.as_public(), follower_collection]
85 explicit_to = Enum.filter(to, fn x -> x in explicit_mentions end)
86 explicit_cc = Enum.filter(to, fn x -> x not in explicit_mentions end)
91 |> Enum.reject(fn x -> String.ends_with?(x, "/followers") and x != follower_collection end)
95 |> Map.put("to", explicit_to)
96 |> Map.put("cc", final_cc)
99 def fix_addressing(object) do
100 {:ok, %User{follower_address: follower_collection}} =
102 |> Containment.get_actor()
103 |> User.get_or_fetch_by_ap_id()
106 |> fix_addressing_list("to")
107 |> fix_addressing_list("cc")
108 |> fix_addressing_list("bto")
109 |> fix_addressing_list("bcc")
110 |> fix_explicit_addressing(follower_collection)
111 |> CommonFixes.fix_implicit_addressing(follower_collection)
114 def fix_actor(%{"attributedTo" => actor} = object) do
115 actor = Containment.get_actor(%{"actor" => actor})
117 # TODO: Remove actor field for Objects
119 |> Map.put("actor", actor)
120 |> Map.put("attributedTo", actor)
123 def fix_in_reply_to(object, options \\ [])
125 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object, options)
126 when not is_nil(in_reply_to) do
127 in_reply_to_id = prepare_in_reply_to(in_reply_to)
128 depth = (options[:depth] || 0) + 1
130 if Federator.allowed_thread_distance?(depth) do
131 with {:ok, replied_object} <- get_obj_helper(in_reply_to_id, options),
132 %Activity{} <- Activity.get_create_by_object_ap_id(replied_object.data["id"]) do
134 |> Map.put("inReplyTo", replied_object.data["id"])
135 |> Map.put("context", replied_object.data["context"] || object["conversation"])
136 |> Map.drop(["conversation", "inReplyToAtomUri"])
139 Logger.warn("Couldn't fetch reply@#{inspect(in_reply_to_id)}, error: #{inspect(e)}")
147 def fix_in_reply_to(object, _options), do: object
149 def fix_quote_url(object, options \\ [])
151 def fix_quote_url(%{"quoteUri" => quote_url} = object, options)
152 when not is_nil(quote_url) do
153 depth = (options[:depth] || 0) + 1
155 if Federator.allowed_thread_distance?(depth) do
156 with {:ok, quoted_object} <- get_obj_helper(quote_url, options),
157 %Activity{} <- Activity.get_create_by_object_ap_id(quoted_object.data["id"]) do
159 |> Map.put("quoteUri", quoted_object.data["id"])
162 Logger.warn("Couldn't fetch quote@#{inspect(quote_url)}, error: #{inspect(e)}")
171 def fix_quote_url(%{"quoteUrl" => quote_url} = object, options) do
173 |> Map.put("quoteUri", quote_url)
174 |> Map.delete("quoteUrl")
175 |> fix_quote_url(options)
179 # https://github.com/fedibird/mastodon/issues/9
180 def fix_quote_url(%{"quoteURL" => quote_url} = object, options) do
182 |> Map.put("quoteUri", quote_url)
183 |> Map.delete("quoteURL")
184 |> fix_quote_url(options)
187 def fix_quote_url(%{"_misskey_quote" => quote_url} = object, options) do
189 |> Map.put("quoteUri", quote_url)
190 |> Map.delete("_misskey_quote")
191 |> fix_quote_url(options)
194 def fix_quote_url(object, _), do: object
196 defp prepare_in_reply_to(in_reply_to) do
198 is_bitstring(in_reply_to) ->
201 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
204 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
205 Enum.at(in_reply_to, 0)
212 def fix_context(object) do
213 context = object["context"] || object["conversation"] || Utils.generate_context_id()
216 |> Map.put("context", context)
217 |> Map.drop(["conversation"])
220 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
222 Enum.map(attachment, fn data ->
225 is_list(data["url"]) -> List.first(data["url"])
226 is_map(data["url"]) -> data["url"]
232 is_map(url) && MIME.extensions(url["mediaType"]) != [] ->
235 is_bitstring(data["mediaType"]) && MIME.extensions(data["mediaType"]) != [] ->
238 is_bitstring(data["mimeType"]) && MIME.extensions(data["mimeType"]) != [] ->
247 is_map(url) && is_binary(url["href"]) -> url["href"]
248 is_binary(data["url"]) -> data["url"]
249 is_binary(data["href"]) -> data["href"]
257 "type" => Map.get(url || %{}, "type", "Link")
259 |> Maps.put_if_present("mediaType", media_type)
260 |> Maps.put_if_present("width", (url || %{})["width"] || data["width"])
261 |> Maps.put_if_present("height", (url || %{})["height"] || data["height"])
264 "url" => [attachment_url],
265 "type" => data["type"] || "Document"
267 |> Maps.put_if_present("mediaType", media_type)
268 |> Maps.put_if_present("name", data["name"])
269 |> Maps.put_if_present("blurhash", data["blurhash"])
276 Map.put(object, "attachment", attachments)
279 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
281 |> Map.put("attachment", [attachment])
285 def fix_attachments(object), do: object
287 def fix_url(%{"url" => url} = object) when is_map(url) do
288 Map.put(object, "url", url["href"])
291 def fix_url(%{"url" => url} = object) when is_list(url) do
292 first_element = Enum.at(url, 0)
296 is_bitstring(first_element) -> first_element
297 is_map(first_element) -> first_element["href"] || ""
301 Map.put(object, "url", url_string)
304 def fix_url(object), do: object
306 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
309 |> Enum.filter(fn data -> is_map(data) and data["type"] == "Emoji" and data["icon"] end)
310 |> Enum.reduce(%{}, fn data, mapping ->
311 name = String.trim(data["name"], ":")
313 Map.put(mapping, name, data["icon"]["url"])
316 Map.put(object, "emoji", emoji)
319 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
320 name = String.trim(tag["name"], ":")
321 emoji = %{name => tag["icon"]["url"]}
323 Map.put(object, "emoji", emoji)
326 def fix_emoji(object), do: object
328 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
331 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
333 %{"name" => "#" <> hashtag} -> String.downcase(hashtag)
334 %{"name" => hashtag} -> String.downcase(hashtag)
337 Map.put(object, "tag", tag ++ tags)
340 def fix_tag(%{"tag" => %{} = tag} = object) do
342 |> Map.put("tag", [tag])
346 def fix_tag(object), do: object
348 # content map usually only has one language so this will do for now.
349 def fix_content_map(%{"contentMap" => content_map} = object) when is_map(content_map) do
350 content_groups = Map.to_list(content_map)
352 if Enum.empty?(content_groups) do
355 {_, content} = Enum.at(content_groups, 0)
357 Map.put(object, "content", content)
361 def fix_content_map(object), do: object
363 defp fix_type(%{"type" => "Note", "inReplyTo" => reply_id, "name" => _} = object, options)
364 when is_binary(reply_id) do
365 options = Keyword.put(options, :fetch, true)
367 with %Object{data: %{"type" => "Question"}} <- Object.normalize(reply_id, options) do
368 Map.put(object, "type", "Answer")
374 defp fix_type(object, _options), do: object
376 # Reduce the object list to find the reported user.
377 defp get_reported(objects) do
378 Enum.reduce_while(objects, nil, fn ap_id, _ ->
379 with %User{} = user <- User.get_cached_by_ap_id(ap_id) do
387 def handle_incoming(data, options \\ [])
389 # Flag objects are placed ahead of the ID check because Mastodon 2.8 and earlier send them
391 def handle_incoming(%{"type" => "Flag", "object" => objects, "actor" => actor} = data, _options) do
392 with context <- data["context"] || Utils.generate_context_id(),
393 content <- data["content"] || "",
394 %User{} = actor <- User.get_cached_by_ap_id(actor),
395 # Reduce the object list to find the reported user.
396 %User{} = account <- get_reported(objects),
397 # Remove the reported user from the object list.
398 statuses <- Enum.filter(objects, fn ap_id -> ap_id != account.ap_id end) do
405 additional: %{"cc" => [account.ap_id]}
407 |> ActivityPub.flag()
411 # disallow objects with bogus IDs
412 def handle_incoming(%{"id" => nil}, _options), do: :error
413 def handle_incoming(%{"id" => ""}, _options), do: :error
414 # length of https:// = 8, should validate better, but good enough for now.
415 def handle_incoming(%{"id" => id}, _options) when is_binary(id) and byte_size(id) < 8,
418 @doc "Rewrite misskey likes into EmojiReacts"
422 "content" => reaction
426 if Pleroma.Emoji.is_unicode_emoji?(reaction) or Pleroma.Emoji.matches_shortcode?(reaction) do
428 |> Map.put("type", "EmojiReact")
429 |> handle_incoming(options)
432 |> Map.delete("content")
433 |> handle_incoming(options)
438 %{"type" => "Create", "object" => %{"type" => objtype, "id" => obj_id}} = data,
441 when objtype in ~w{Question Answer Audio Video Event Article Note Page} do
442 fetch_options = Keyword.put(options, :depth, (options[:depth] || 0) + 1)
446 |> strip_internal_fields()
447 |> fix_type(fetch_options)
448 |> fix_in_reply_to(fetch_options)
449 |> fix_quote_url(fetch_options)
451 # Only change the Create's context if the object's context has been modified.
453 if data["object"]["context"] != object["context"] do
455 |> Map.put("object", object)
456 |> Map.put("context", object["context"])
458 Map.put(data, "object", object)
461 options = Keyword.put(options, :local, false)
463 with {:ok, %User{}} <- ObjectValidator.fetch_actor(data),
464 nil <- Activity.get_create_by_object_ap_id(obj_id),
465 {:ok, activity, _} <- Pipeline.common_pipeline(data, options) do
468 %Activity{} = activity -> {:ok, activity}
473 def handle_incoming(%{"type" => type} = data, _options)
474 when type in ~w{Like EmojiReact Announce Add Remove} do
475 with :ok <- ObjectValidator.fetch_actor_and_object(data),
476 {:ok, activity, _meta} <- Pipeline.common_pipeline(data, local: false) do
485 %{"type" => type} = data,
488 when type in ~w{Update Block Follow Accept Reject} do
489 with {:ok, %User{}} <- ObjectValidator.fetch_actor(data),
490 {:ok, activity, _} <-
491 Pipeline.common_pipeline(data, local: false) do
497 %{"type" => "Delete"} = data,
500 with {:ok, activity, _} <-
501 Pipeline.common_pipeline(data, local: false) do
504 {:error, {:validate, _}} = e ->
505 # Check if we have a create activity for this
506 with {:ok, object_id} <- ObjectValidators.ObjectID.cast(data["object"]),
507 %Activity{data: %{"actor" => actor}} <-
508 Activity.create_by_object_ap_id(object_id) |> Repo.one(),
509 # We have one, insert a tombstone and retry
510 {:ok, tombstone_data, _} <- Builder.tombstone(actor, object_id),
511 {:ok, _tombstone} <- Object.create(tombstone_data) do
512 handle_incoming(data)
522 "object" => %{"type" => "Follow", "object" => followed},
528 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
529 {:ok, %User{} = follower} <- User.get_or_fetch_by_ap_id(follower),
530 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
531 User.unfollow(follower, followed)
541 "object" => %{"type" => type}
545 when type in ["Like", "EmojiReact", "Announce", "Block"] do
546 with {:ok, activity, _} <- Pipeline.common_pipeline(data, local: false) do
551 # For Undos that don't have the complete object attached, try to find it in our database.
559 when is_binary(object) do
560 with %Activity{data: data} <- Activity.get_by_ap_id(object) do
562 |> Map.put("object", data)
563 |> handle_incoming(options)
572 "actor" => origin_actor,
573 "object" => origin_actor,
574 "target" => target_actor
578 with %User{} = origin_user <- User.get_cached_by_ap_id(origin_actor),
579 {:ok, %User{} = target_user} <- User.get_or_fetch_by_ap_id(target_actor),
580 true <- origin_actor in target_user.also_known_as do
581 ActivityPub.move(origin_user, target_user, false)
587 def handle_incoming(_, _), do: :error
589 @spec get_obj_helper(String.t(), Keyword.t()) :: {:ok, Object.t()} | nil
590 def get_obj_helper(id, options \\ []) do
591 options = Keyword.put(options, :fetch, true)
593 case Object.normalize(id, options) do
594 %Object{} = object -> {:ok, object}
599 @spec get_embedded_obj_helper(String.t() | Object.t(), User.t()) :: {:ok, Object.t()} | nil
600 def get_embedded_obj_helper(%{"attributedTo" => attributed_to, "id" => object_id} = data, %User{
603 when attributed_to == ap_id do
604 with {:ok, activity} <-
609 "actor" => attributed_to,
612 {:ok, Object.normalize(activity, fetch: false)}
614 _ -> get_obj_helper(object_id)
618 def get_embedded_obj_helper(object_id, _) do
619 get_obj_helper(object_id)
622 def set_reply_to_uri(%{"inReplyTo" => in_reply_to} = object) when is_binary(in_reply_to) do
623 with false <- String.starts_with?(in_reply_to, "http"),
624 {:ok, %{data: replied_to_object}} <- get_obj_helper(in_reply_to) do
625 Map.put(object, "inReplyTo", replied_to_object["external_url"] || in_reply_to)
631 def set_reply_to_uri(obj), do: obj
633 def set_quote_url(%{"quoteUri" => quote} = object) when is_binary(quote) do
634 Map.put(object, "quoteUrl", quote)
637 def set_quote_url(obj), do: obj
640 Serialized Mastodon-compatible `replies` collection containing _self-replies_.
641 Based on Mastodon's ActivityPub::NoteSerializer#replies.
643 def set_replies(obj_data) do
645 with limit when limit > 0 <-
646 Pleroma.Config.get([:activitypub, :note_replies_output_limit], 0),
647 %Object{} = object <- Object.get_cached_by_ap_id(obj_data["id"]) do
649 |> Object.self_replies()
650 |> select([o], fragment("?->>'id'", o.data))
657 set_replies(obj_data, replies_uris)
660 defp set_replies(obj, []) do
664 defp set_replies(obj, replies_uris) do
665 replies_collection = %{
666 "type" => "Collection",
667 "items" => replies_uris
670 Map.merge(obj, %{"replies" => replies_collection})
673 def replies(%{"replies" => %{"first" => %{"items" => items}}}) when not is_nil(items) do
677 def replies(%{"replies" => %{"items" => items}}) when not is_nil(items) do
681 def replies(_), do: []
683 # Prepares the object of an outgoing create activity.
684 def prepare_object(object) do
690 |> prepare_attachments
695 |> strip_internal_fields
696 |> strip_internal_tags
698 |> maybe_process_history
701 defp maybe_process_history(%{"formerRepresentations" => %{"orderedItems" => history}} = object) do
706 item when is_map(item) -> prepare_object(item)
711 put_in(object, ["formerRepresentations", "orderedItems"], processed_history)
714 defp maybe_process_history(object) do
720 # internal -> Mastodon
723 def prepare_outgoing(%{"type" => activity_type, "object" => object_id} = data)
724 when activity_type in ["Create"] do
727 |> Object.normalize(fetch: false)
733 |> Map.put("object", object)
734 |> Map.merge(Utils.make_json_ld_header())
740 def prepare_outgoing(%{"type" => "Update", "object" => %{"type" => objtype} = object} = data)
741 when objtype in Pleroma.Constants.updatable_object_types() do
748 |> Map.put("object", object)
749 |> Map.merge(Utils.make_json_ld_header())
755 def prepare_outgoing(%{"type" => "Announce", "actor" => ap_id, "object" => object_id} = data) do
758 |> Object.normalize(fetch: false)
761 if Visibility.is_private?(object) && object.data["actor"] == ap_id do
762 data |> Map.put("object", object |> Map.get(:data) |> prepare_object)
764 data |> maybe_fix_object_url
769 |> strip_internal_fields
770 |> Map.merge(Utils.make_json_ld_header())
776 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
777 # because of course it does.
778 def prepare_outgoing(%{"type" => "Accept"} = data) do
779 with follow_activity <- Activity.normalize(data["object"]) do
781 "actor" => follow_activity.actor,
782 "object" => follow_activity.data["object"],
783 "id" => follow_activity.data["id"],
789 |> Map.put("object", object)
790 |> Map.merge(Utils.make_json_ld_header())
796 def prepare_outgoing(%{"type" => "Reject"} = data) do
797 with follow_activity <- Activity.normalize(data["object"]) do
799 "actor" => follow_activity.actor,
800 "object" => follow_activity.data["object"],
801 "id" => follow_activity.data["id"],
807 |> Map.put("object", object)
808 |> Map.merge(Utils.make_json_ld_header())
814 def prepare_outgoing(%{"type" => _type} = data) do
817 |> strip_internal_fields
818 |> maybe_fix_object_url
819 |> Map.merge(Utils.make_json_ld_header())
824 def maybe_fix_object_url(%{"object" => object} = data) when is_binary(object) do
825 with false <- String.starts_with?(object, "http"),
826 {:fetch, {:ok, relative_object}} <- {:fetch, get_obj_helper(object)},
827 %{data: %{"external_url" => external_url}} when not is_nil(external_url) <-
829 Map.put(data, "object", external_url)
832 Logger.error("Couldn't fetch fixed_object@#{object} #{inspect(e)}")
840 def maybe_fix_object_url(data), do: data
842 def add_hashtags(object) do
844 (object["tag"] || [])
846 # Expand internal representation tags into AS2 tags.
847 tag when is_binary(tag) ->
849 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
854 # Do not process tags which are already AS2 tag objects.
855 tag when is_map(tag) ->
859 Map.put(object, "tag", tags)
862 # TODO These should be added on our side on insertion, it doesn't make much
863 # sense to regenerate these all the time
864 def add_mention_tags(object) do
865 to = object["to"] || []
866 cc = object["cc"] || []
867 mentioned = User.get_users_from_set(to ++ cc, local_only: false)
869 mentions = Enum.map(mentioned, &build_mention_tag/1)
871 tags = object["tag"] || []
872 Map.put(object, "tag", tags ++ mentions)
875 defp build_mention_tag(%{ap_id: ap_id, nickname: nickname} = _) do
876 %{"type" => "Mention", "href" => ap_id, "name" => "@#{nickname}"}
879 def take_emoji_tags(%User{emoji: emoji}) do
882 |> Enum.map(&build_emoji_tag/1)
885 # TODO: we should probably send mtime instead of unix epoch time for updated
886 def add_emoji_tags(%{"emoji" => emoji} = object) do
887 tags = object["tag"] || []
889 out = Enum.map(emoji, &build_emoji_tag/1)
891 Map.put(object, "tag", tags ++ out)
894 def add_emoji_tags(object), do: object
896 defp build_emoji_tag({name, url}) do
898 "icon" => %{"url" => "#{URI.encode(url)}", "type" => "Image"},
899 "name" => ":" <> name <> ":",
901 "updated" => "1970-01-01T00:00:00Z",
906 def set_conversation(object) do
907 Map.put(object, "conversation", object["context"])
910 def set_type(%{"type" => "Answer"} = object) do
911 Map.put(object, "type", "Note")
914 def set_type(object), do: object
916 def add_attributed_to(object) do
917 attributed_to = object["attributedTo"] || object["actor"]
918 Map.put(object, "attributedTo", attributed_to)
921 def prepare_attachments(object) do
924 |> Map.get("attachment", [])
925 |> Enum.map(fn data ->
926 [%{"mediaType" => media_type, "href" => href} = url | _] = data["url"]
930 "mediaType" => media_type,
931 "name" => data["name"],
934 |> Maps.put_if_present("width", url["width"])
935 |> Maps.put_if_present("height", url["height"])
936 |> Maps.put_if_present("blurhash", data["blurhash"])
939 Map.put(object, "attachment", attachments)
942 def strip_internal_fields(object) do
943 Map.drop(object, Pleroma.Constants.object_internal_fields())
946 defp strip_internal_tags(%{"tag" => tags} = object) do
947 tags = Enum.filter(tags, fn x -> is_map(x) end)
949 Map.put(object, "tag", tags)
952 defp strip_internal_tags(object), do: object
954 def perform(:user_upgrade, user) do
955 # we pass a fake user so that the followers collection is stripped away
956 old_follower_address = User.ap_followers(%User{nickname: user.nickname})
960 where: ^old_follower_address in a.recipients,
965 "array_replace(?,?,?)",
967 ^old_follower_address,
968 ^user.follower_address
973 |> Repo.update_all([])
976 def upgrade_user_from_ap_id(ap_id) do
977 with %User{local: false} = user <- User.get_cached_by_ap_id(ap_id),
978 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id),
979 {:ok, user} <- update_user(user, data) do
980 {:ok, _pid} = Task.start(fn -> ActivityPub.pinned_fetch_task(user) end)
981 TransmogrifierWorker.enqueue("user_upgrade", %{"user_id" => user.id})
984 %User{} = user -> {:ok, user}
989 defp update_user(user, data) do
991 |> User.remote_user_changeset(data)
992 |> User.update_and_set_cache()
995 def maybe_fix_user_url(%{"url" => url} = data) when is_map(url) do
996 Map.put(data, "url", url["href"])
999 def maybe_fix_user_url(data), do: data
1001 def maybe_fix_user_object(data), do: maybe_fix_user_url(data)