1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2022 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)
48 def fix_summary(%{"summary" => nil} = object) do
49 Map.put(object, "summary", "")
52 def fix_summary(%{"summary" => _} = object) do
53 # summary is present, nothing to do
57 def fix_summary(object), do: Map.put(object, "summary", "")
59 def fix_addressing_list(map, field) do
64 Map.put(map, field, Enum.filter(addrs, &is_binary/1))
67 Map.put(map, field, [addrs])
70 Map.put(map, field, [])
74 # if directMessage flag is set to true, leave the addressing alone
75 def fix_explicit_addressing(%{"directMessage" => true} = object, _follower_collection),
78 def fix_explicit_addressing(%{"to" => to, "cc" => cc} = object, follower_collection) do
80 Utils.determine_explicit_mentions(object) ++
81 [Pleroma.Constants.as_public(), follower_collection]
83 explicit_to = Enum.filter(to, fn x -> x in explicit_mentions end)
84 explicit_cc = Enum.filter(to, fn x -> x not in explicit_mentions end)
89 |> Enum.reject(fn x -> String.ends_with?(x, "/followers") and x != follower_collection end)
93 |> Map.put("to", explicit_to)
94 |> Map.put("cc", final_cc)
97 # if as:Public is addressed, then make sure the followers collection is also addressed
98 # so that the activities will be delivered to local users.
99 def fix_implicit_addressing(%{"to" => to, "cc" => cc} = object, followers_collection) do
100 recipients = to ++ cc
102 if followers_collection not in recipients do
104 Pleroma.Constants.as_public() in cc ->
105 to = to ++ [followers_collection]
106 Map.put(object, "to", to)
108 Pleroma.Constants.as_public() in to ->
109 cc = cc ++ [followers_collection]
110 Map.put(object, "cc", cc)
120 def fix_addressing(object) do
121 {:ok, %User{follower_address: follower_collection}} =
123 |> Containment.get_actor()
124 |> User.get_or_fetch_by_ap_id()
127 |> fix_addressing_list("to")
128 |> fix_addressing_list("cc")
129 |> fix_addressing_list("bto")
130 |> fix_addressing_list("bcc")
131 |> fix_explicit_addressing(follower_collection)
132 |> fix_implicit_addressing(follower_collection)
135 def fix_actor(%{"attributedTo" => actor} = object) do
136 actor = Containment.get_actor(%{"actor" => actor})
138 # TODO: Remove actor field for Objects
140 |> Map.put("actor", actor)
141 |> Map.put("attributedTo", actor)
144 def fix_in_reply_to(object, options \\ [])
146 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object, options)
147 when not is_nil(in_reply_to) do
148 in_reply_to_id = prepare_in_reply_to(in_reply_to)
149 depth = (options[:depth] || 0) + 1
151 if Federator.allowed_thread_distance?(depth) do
152 with {:ok, replied_object} <- get_obj_helper(in_reply_to_id, options),
153 %Activity{} <- Activity.get_create_by_object_ap_id(replied_object.data["id"]) do
155 |> Map.put("inReplyTo", replied_object.data["id"])
156 |> Map.put("context", replied_object.data["context"] || object["conversation"])
157 |> Map.drop(["conversation", "inReplyToAtomUri"])
160 Logger.warn("Couldn't fetch #{inspect(in_reply_to_id)}, error: #{inspect(e)}")
168 def fix_in_reply_to(object, _options), do: object
170 defp prepare_in_reply_to(in_reply_to) do
172 is_bitstring(in_reply_to) ->
175 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
178 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
179 Enum.at(in_reply_to, 0)
186 def fix_context(object) do
187 context = object["context"] || object["conversation"] || Utils.generate_context_id()
190 |> Map.put("context", context)
191 |> Map.drop(["conversation"])
194 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
196 Enum.map(attachment, fn data ->
199 is_list(data["url"]) -> List.first(data["url"])
200 is_map(data["url"]) -> data["url"]
206 is_map(url) && url =~ Pleroma.Constants.mime_regex() ->
209 is_bitstring(data["mediaType"]) && data["mediaType"] =~ Pleroma.Constants.mime_regex() ->
212 is_bitstring(data["mimeType"]) && data["mimeType"] =~ Pleroma.Constants.mime_regex() ->
221 is_map(url) && is_binary(url["href"]) -> url["href"]
222 is_binary(data["url"]) -> data["url"]
223 is_binary(data["href"]) -> data["href"]
231 "type" => Map.get(url || %{}, "type", "Link")
233 |> Maps.put_if_present("mediaType", media_type)
234 |> Maps.put_if_present("width", (url || %{})["width"] || data["width"])
235 |> Maps.put_if_present("height", (url || %{})["height"] || data["height"])
238 "url" => [attachment_url],
239 "type" => data["type"] || "Document"
241 |> Maps.put_if_present("mediaType", media_type)
242 |> Maps.put_if_present("name", data["name"])
243 |> Maps.put_if_present("blurhash", data["blurhash"])
250 Map.put(object, "attachment", attachments)
253 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
255 |> Map.put("attachment", [attachment])
259 def fix_attachments(object), do: object
261 def fix_url(%{"url" => url} = object) when is_map(url) do
262 Map.put(object, "url", url["href"])
265 def fix_url(%{"url" => url} = object) when is_list(url) do
266 first_element = Enum.at(url, 0)
270 is_bitstring(first_element) -> first_element
271 is_map(first_element) -> first_element["href"] || ""
275 Map.put(object, "url", url_string)
278 def fix_url(object), do: object
280 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
283 |> Enum.filter(fn data -> is_map(data) and data["type"] == "Emoji" and data["icon"] end)
284 |> Enum.reduce(%{}, fn data, mapping ->
285 name = String.trim(data["name"], ":")
287 Map.put(mapping, name, data["icon"]["url"])
290 Map.put(object, "emoji", emoji)
293 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
294 name = String.trim(tag["name"], ":")
295 emoji = %{name => tag["icon"]["url"]}
297 Map.put(object, "emoji", emoji)
300 def fix_emoji(object), do: object
302 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
305 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
307 %{"name" => "#" <> hashtag} -> String.downcase(hashtag)
308 %{"name" => hashtag} -> String.downcase(hashtag)
311 Map.put(object, "tag", tag ++ tags)
314 def fix_tag(%{"tag" => %{} = tag} = object) do
316 |> Map.put("tag", [tag])
320 def fix_tag(object), do: object
322 # content map usually only has one language so this will do for now.
323 def fix_content_map(%{"contentMap" => content_map} = object) do
324 content_groups = Map.to_list(content_map)
325 {_, content} = Enum.at(content_groups, 0)
327 Map.put(object, "content", content)
330 def fix_content_map(object), do: object
332 defp fix_type(%{"type" => "Note", "inReplyTo" => reply_id, "name" => _} = object, options)
333 when is_binary(reply_id) do
334 options = Keyword.put(options, :fetch, true)
336 with %Object{data: %{"type" => "Question"}} <- Object.normalize(reply_id, options) do
337 Map.put(object, "type", "Answer")
343 defp fix_type(object, _options), do: object
345 # Reduce the object list to find the reported user.
346 defp get_reported(objects) do
347 Enum.reduce_while(objects, nil, fn ap_id, _ ->
348 with %User{} = user <- User.get_cached_by_ap_id(ap_id) do
356 def handle_incoming(data, options \\ [])
358 # Flag objects are placed ahead of the ID check because Mastodon 2.8 and earlier send them
360 def handle_incoming(%{"type" => "Flag", "object" => objects, "actor" => actor} = data, _options) do
361 with context <- data["context"] || Utils.generate_context_id(),
362 content <- data["content"] || "",
363 %User{} = actor <- User.get_cached_by_ap_id(actor),
364 # Reduce the object list to find the reported user.
365 %User{} = account <- get_reported(objects),
366 # Remove the reported user from the object list.
367 statuses <- Enum.filter(objects, fn ap_id -> ap_id != account.ap_id end) do
374 additional: %{"cc" => [account.ap_id]}
376 |> ActivityPub.flag()
380 # disallow objects with bogus IDs
381 def handle_incoming(%{"id" => nil}, _options), do: :error
382 def handle_incoming(%{"id" => ""}, _options), do: :error
383 # length of https:// = 8, should validate better, but good enough for now.
384 def handle_incoming(%{"id" => id}, _options) when is_binary(id) and byte_size(id) < 8,
388 %{"type" => "Listen", "object" => %{"type" => "Audio"} = object} = data,
391 actor = Containment.get_actor(data)
394 Map.put(data, "actor", actor)
397 with {:ok, %User{} = user} <- User.get_or_fetch_by_ap_id(data["actor"]) do
398 reply_depth = (options[:depth] || 0) + 1
399 options = Keyword.put(options, :depth, reply_depth)
400 object = fix_object(object, options)
408 published: data["published"],
409 additional: Map.take(data, ["cc", "id"])
412 ActivityPub.listen(params)
418 @misskey_reactions %{
432 @doc "Rewrite misskey likes into EmojiReacts"
436 "_misskey_reaction" => reaction
441 |> Map.put("type", "EmojiReact")
442 |> Map.put("content", @misskey_reactions[reaction] || reaction)
443 |> handle_incoming(options)
447 %{"type" => "Create", "object" => %{"type" => objtype, "id" => obj_id}} = data,
450 when objtype in ~w{Question Answer ChatMessage Audio Video Event Article Note Page} do
451 fetch_options = Keyword.put(options, :depth, (options[:depth] || 0) + 1)
455 |> strip_internal_fields()
456 |> fix_type(fetch_options)
457 |> fix_in_reply_to(fetch_options)
459 data = Map.put(data, "object", object)
460 options = Keyword.put(options, :local, false)
462 with {:ok, %User{}} <- ObjectValidator.fetch_actor(data),
463 nil <- Activity.get_create_by_object_ap_id(obj_id),
464 {:ok, activity, _} <- Pipeline.common_pipeline(data, options) do
467 %Activity{} = activity -> {:ok, activity}
472 def handle_incoming(%{"type" => type} = data, _options)
473 when type in ~w{Like EmojiReact Announce Add Remove} do
474 with :ok <- ObjectValidator.fetch_actor_and_object(data),
475 {:ok, activity, _meta} <-
476 Pipeline.common_pipeline(data, local: false) do
484 %{"type" => type} = data,
487 when type in ~w{Update Block Follow Accept Reject} do
488 with {:ok, %User{}} <- ObjectValidator.fetch_actor(data),
489 {:ok, activity, _} <-
490 Pipeline.common_pipeline(data, local: false) do
496 %{"type" => "Delete"} = data,
499 with {:ok, activity, _} <-
500 Pipeline.common_pipeline(data, local: false) do
503 {:error, {:validate, _}} = e ->
504 # Check if we have a create activity for this
505 with {:ok, object_id} <- ObjectValidators.ObjectID.cast(data["object"]),
506 %Activity{data: %{"actor" => actor}} <-
507 Activity.create_by_object_ap_id(object_id) |> Repo.one(),
508 # We have one, insert a tombstone and retry
509 {:ok, tombstone_data, _} <- Builder.tombstone(actor, object_id),
510 {:ok, _tombstone} <- Object.create(tombstone_data) do
511 handle_incoming(data)
521 "object" => %{"type" => "Follow", "object" => followed},
527 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
528 {:ok, %User{} = follower} <- User.get_or_fetch_by_ap_id(follower),
529 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
530 User.unfollow(follower, followed)
540 "object" => %{"type" => type}
544 when type in ["Like", "EmojiReact", "Announce", "Block"] do
545 with {:ok, activity, _} <- Pipeline.common_pipeline(data, local: false) do
550 # For Undos that don't have the complete object attached, try to find it in our database.
558 when is_binary(object) do
559 with %Activity{data: data} <- Activity.get_by_ap_id(object) do
561 |> Map.put("object", data)
562 |> handle_incoming(options)
571 "actor" => origin_actor,
572 "object" => origin_actor,
573 "target" => target_actor
577 with %User{} = origin_user <- User.get_cached_by_ap_id(origin_actor),
578 {:ok, %User{} = target_user} <- User.get_or_fetch_by_ap_id(target_actor),
579 true <- origin_actor in target_user.also_known_as do
580 ActivityPub.move(origin_user, target_user, false)
586 def handle_incoming(_, _), do: :error
588 @spec get_obj_helper(String.t(), Keyword.t()) :: {:ok, Object.t()} | nil
589 def get_obj_helper(id, options \\ []) do
590 options = Keyword.put(options, :fetch, true)
592 case Object.normalize(id, options) do
593 %Object{} = object -> {:ok, object}
598 @spec get_embedded_obj_helper(String.t() | Object.t(), User.t()) :: {:ok, Object.t()} | nil
599 def get_embedded_obj_helper(%{"attributedTo" => attributed_to, "id" => object_id} = data, %User{
602 when attributed_to == ap_id do
603 with {:ok, activity} <-
608 "actor" => attributed_to,
611 {:ok, Object.normalize(activity, fetch: false)}
613 _ -> get_obj_helper(object_id)
617 def get_embedded_obj_helper(object_id, _) do
618 get_obj_helper(object_id)
621 def set_reply_to_uri(%{"inReplyTo" => in_reply_to} = object) when is_binary(in_reply_to) do
622 with false <- String.starts_with?(in_reply_to, "http"),
623 {:ok, %{data: replied_to_object}} <- get_obj_helper(in_reply_to) do
624 Map.put(object, "inReplyTo", replied_to_object["external_url"] || in_reply_to)
630 def set_reply_to_uri(obj), do: obj
633 Serialized Mastodon-compatible `replies` collection containing _self-replies_.
634 Based on Mastodon's ActivityPub::NoteSerializer#replies.
636 def set_replies(obj_data) do
638 with limit when limit > 0 <-
639 Pleroma.Config.get([:activitypub, :note_replies_output_limit], 0),
640 %Object{} = object <- Object.get_cached_by_ap_id(obj_data["id"]) do
642 |> Object.self_replies()
643 |> select([o], fragment("?->>'id'", o.data))
650 set_replies(obj_data, replies_uris)
653 defp set_replies(obj, []) do
657 defp set_replies(obj, replies_uris) do
658 replies_collection = %{
659 "type" => "Collection",
660 "items" => replies_uris
663 Map.merge(obj, %{"replies" => replies_collection})
666 def replies(%{"replies" => %{"first" => %{"items" => items}}}) when not is_nil(items) do
670 def replies(%{"replies" => %{"items" => items}}) when not is_nil(items) do
674 def replies(_), do: []
676 # Prepares the object of an outgoing create activity.
677 def prepare_object(object) do
683 |> prepare_attachments
687 |> strip_internal_fields
688 |> strip_internal_tags
690 |> maybe_process_history
693 defp maybe_process_history(%{"formerRepresentations" => %{"orderedItems" => history}} = object) do
698 item when is_map(item) -> prepare_object(item)
703 put_in(object, ["formerRepresentations", "orderedItems"], processed_history)
706 defp maybe_process_history(object) do
712 # internal -> Mastodon
715 def prepare_outgoing(%{"type" => activity_type, "object" => object_id} = data)
716 when activity_type in ["Create", "Listen"] do
719 |> Object.normalize(fetch: false)
725 |> Map.put("object", object)
726 |> Map.merge(Utils.make_json_ld_header())
732 def prepare_outgoing(%{"type" => "Update", "object" => %{"type" => objtype} = object} = data)
733 when objtype in Pleroma.Constants.updatable_object_types() do
740 |> Map.put("object", object)
741 |> Map.merge(Utils.make_json_ld_header())
747 def prepare_outgoing(%{"type" => "Announce", "actor" => ap_id, "object" => object_id} = data) do
750 |> Object.normalize(fetch: false)
753 if Visibility.is_private?(object) && object.data["actor"] == ap_id do
754 data |> Map.put("object", object |> Map.get(:data) |> prepare_object)
756 data |> maybe_fix_object_url
761 |> strip_internal_fields
762 |> Map.merge(Utils.make_json_ld_header())
768 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
769 # because of course it does.
770 def prepare_outgoing(%{"type" => "Accept"} = data) do
771 with follow_activity <- Activity.normalize(data["object"]) do
773 "actor" => follow_activity.actor,
774 "object" => follow_activity.data["object"],
775 "id" => follow_activity.data["id"],
781 |> Map.put("object", object)
782 |> Map.merge(Utils.make_json_ld_header())
788 def prepare_outgoing(%{"type" => "Reject"} = data) do
789 with follow_activity <- Activity.normalize(data["object"]) do
791 "actor" => follow_activity.actor,
792 "object" => follow_activity.data["object"],
793 "id" => follow_activity.data["id"],
799 |> Map.put("object", object)
800 |> Map.merge(Utils.make_json_ld_header())
806 def prepare_outgoing(%{"type" => _type} = data) do
809 |> strip_internal_fields
810 |> maybe_fix_object_url
811 |> Map.merge(Utils.make_json_ld_header())
816 def maybe_fix_object_url(%{"object" => object} = data) when is_binary(object) do
817 with false <- String.starts_with?(object, "http"),
818 {:fetch, {:ok, relative_object}} <- {:fetch, get_obj_helper(object)},
819 %{data: %{"external_url" => external_url}} when not is_nil(external_url) <-
821 Map.put(data, "object", external_url)
824 Logger.error("Couldn't fetch #{object} #{inspect(e)}")
832 def maybe_fix_object_url(data), do: data
834 def add_hashtags(object) do
836 (object["tag"] || [])
838 # Expand internal representation tags into AS2 tags.
839 tag when is_binary(tag) ->
841 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
846 # Do not process tags which are already AS2 tag objects.
847 tag when is_map(tag) ->
851 Map.put(object, "tag", tags)
854 # TODO These should be added on our side on insertion, it doesn't make much
855 # sense to regenerate these all the time
856 def add_mention_tags(object) do
857 to = object["to"] || []
858 cc = object["cc"] || []
859 mentioned = User.get_users_from_set(to ++ cc, local_only: false)
861 mentions = Enum.map(mentioned, &build_mention_tag/1)
863 tags = object["tag"] || []
864 Map.put(object, "tag", tags ++ mentions)
867 defp build_mention_tag(%{ap_id: ap_id, nickname: nickname} = _) do
868 %{"type" => "Mention", "href" => ap_id, "name" => "@#{nickname}"}
871 def take_emoji_tags(%User{emoji: emoji}) do
874 |> Enum.map(&build_emoji_tag/1)
877 # TODO: we should probably send mtime instead of unix epoch time for updated
878 def add_emoji_tags(%{"emoji" => emoji} = object) do
879 tags = object["tag"] || []
881 out = Enum.map(emoji, &build_emoji_tag/1)
883 Map.put(object, "tag", tags ++ out)
886 def add_emoji_tags(object), do: object
888 defp build_emoji_tag({name, url}) do
890 "icon" => %{"url" => "#{URI.encode(url)}", "type" => "Image"},
891 "name" => ":" <> name <> ":",
893 "updated" => "1970-01-01T00:00:00Z",
898 def set_conversation(object) do
899 Map.put(object, "conversation", object["context"])
902 def set_type(%{"type" => "Answer"} = object) do
903 Map.put(object, "type", "Note")
906 def set_type(object), do: object
908 def add_attributed_to(object) do
909 attributed_to = object["attributedTo"] || object["actor"]
910 Map.put(object, "attributedTo", attributed_to)
914 def prepare_attachments(%{"type" => "ChatMessage"} = object), do: object
916 def prepare_attachments(object) do
919 |> Map.get("attachment", [])
920 |> Enum.map(fn data ->
921 [%{"mediaType" => media_type, "href" => href} = url | _] = data["url"]
925 "mediaType" => media_type,
926 "name" => data["name"],
929 |> Maps.put_if_present("width", url["width"])
930 |> Maps.put_if_present("height", url["height"])
931 |> Maps.put_if_present("blurhash", data["blurhash"])
934 Map.put(object, "attachment", attachments)
937 def strip_internal_fields(object) do
938 Map.drop(object, Pleroma.Constants.object_internal_fields())
941 defp strip_internal_tags(%{"tag" => tags} = object) do
942 tags = Enum.filter(tags, fn x -> is_map(x) end)
944 Map.put(object, "tag", tags)
947 defp strip_internal_tags(object), do: object
949 def perform(:user_upgrade, user) do
950 # we pass a fake user so that the followers collection is stripped away
951 old_follower_address = User.ap_followers(%User{nickname: user.nickname})
955 where: ^old_follower_address in a.recipients,
960 "array_replace(?,?,?)",
962 ^old_follower_address,
963 ^user.follower_address
968 |> Repo.update_all([])
971 def upgrade_user_from_ap_id(ap_id) do
972 with %User{local: false} = user <- User.get_cached_by_ap_id(ap_id),
973 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id),
974 {:ok, user} <- update_user(user, data) do
975 {:ok, _pid} = Task.start(fn -> ActivityPub.pinned_fetch_task(user) end)
976 TransmogrifierWorker.enqueue("user_upgrade", %{"user_id" => user.id})
979 %User{} = user -> {:ok, user}
984 defp update_user(user, data) do
986 |> User.remote_user_changeset(data)
987 |> User.update_and_set_cache()
990 def maybe_fix_user_url(%{"url" => url} = data) when is_map(url) do
991 Map.put(data, "url", url["href"])
994 def maybe_fix_user_url(data), do: data
996 def maybe_fix_user_object(data), do: maybe_fix_user_url(data)