1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 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.
13 alias Pleroma.Web.ActivityPub.ActivityPub
14 alias Pleroma.Web.ActivityPub.Utils
15 alias Pleroma.Web.ActivityPub.Visibility
21 def get_actor(%{"actor" => actor}) when is_binary(actor) do
25 def get_actor(%{"actor" => actor}) when is_list(actor) do
26 if is_binary(Enum.at(actor, 0)) do
29 Enum.find(actor, fn %{"type" => type} -> type in ["Person", "Service", "Application"] end)
34 def get_actor(%{"actor" => %{"id" => id}}) when is_bitstring(id) do
38 def get_actor(%{"actor" => nil, "attributedTo" => actor}) when not is_nil(actor) do
39 get_actor(%{"actor" => actor})
43 Checks that an imported AP object's actor matches the domain it came from.
45 def contain_origin(_id, %{"actor" => nil}), do: :error
47 def contain_origin(id, %{"actor" => _actor} = params) do
48 id_uri = URI.parse(id)
49 actor_uri = URI.parse(get_actor(params))
51 if id_uri.host == actor_uri.host do
58 def contain_origin_from_id(_id, %{"id" => nil}), do: :error
60 def contain_origin_from_id(id, %{"id" => other_id} = _params) do
61 id_uri = URI.parse(id)
62 other_uri = URI.parse(other_id)
64 if id_uri.host == other_uri.host do
72 Modifies an incoming AP object (mastodon format) to our internal format.
74 def fix_object(object) do
89 def fix_summary(%{"summary" => nil} = object) do
91 |> Map.put("summary", "")
94 def fix_summary(%{"summary" => _} = object) do
95 # summary is present, nothing to do
99 def fix_summary(object) do
101 |> Map.put("summary", "")
104 def fix_addressing_list(map, field) do
106 is_binary(map[field]) ->
107 Map.put(map, field, [map[field]])
109 is_nil(map[field]) ->
110 Map.put(map, field, [])
117 def fix_explicit_addressing(%{"to" => to, "cc" => cc} = object, explicit_mentions) do
120 |> Enum.filter(fn x -> x in explicit_mentions end)
124 |> Enum.filter(fn x -> x not in explicit_mentions end)
131 |> Map.put("to", explicit_to)
132 |> Map.put("cc", final_cc)
135 def fix_explicit_addressing(object, _explicit_mentions), do: object
137 # if directMessage flag is set to true, leave the addressing alone
138 def fix_explicit_addressing(%{"directMessage" => true} = object), do: object
140 def fix_explicit_addressing(object) do
143 |> Utils.determine_explicit_mentions()
145 explicit_mentions = explicit_mentions ++ ["https://www.w3.org/ns/activitystreams#Public"]
148 |> fix_explicit_addressing(explicit_mentions)
151 # if as:Public is addressed, then make sure the followers collection is also addressed
152 # so that the activities will be delivered to local users.
153 def fix_implicit_addressing(%{"to" => to, "cc" => cc} = object, followers_collection) do
154 recipients = to ++ cc
156 if followers_collection not in recipients do
158 "https://www.w3.org/ns/activitystreams#Public" in cc ->
159 to = to ++ [followers_collection]
160 Map.put(object, "to", to)
162 "https://www.w3.org/ns/activitystreams#Public" in to ->
163 cc = cc ++ [followers_collection]
164 Map.put(object, "cc", cc)
174 def fix_implicit_addressing(object, _), do: object
176 def fix_addressing(object) do
177 %User{} = user = User.get_or_fetch_by_ap_id(object["actor"])
178 followers_collection = User.ap_followers(user)
181 |> fix_addressing_list("to")
182 |> fix_addressing_list("cc")
183 |> fix_addressing_list("bto")
184 |> fix_addressing_list("bcc")
185 |> fix_explicit_addressing
186 |> fix_implicit_addressing(followers_collection)
189 def fix_actor(%{"attributedTo" => actor} = object) do
191 |> Map.put("actor", get_actor(%{"actor" => actor}))
194 # Check for standardisation
195 # This is what Peertube does
196 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
197 # Prismo returns only an integer (count) as "likes"
198 def fix_likes(%{"likes" => likes} = object) when not is_map(likes) do
200 |> Map.put("likes", [])
201 |> Map.put("like_count", 0)
204 def fix_likes(object) do
208 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
209 when not is_nil(in_reply_to) do
212 is_bitstring(in_reply_to) ->
215 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
218 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
219 Enum.at(in_reply_to, 0)
221 # Maybe I should output an error too?
226 case fetch_obj_helper(in_reply_to_id) do
227 {:ok, replied_object} ->
228 with %Activity{} = activity <-
229 Activity.get_create_by_object_ap_id(replied_object.data["id"]) do
231 |> Map.put("inReplyTo", replied_object.data["id"])
232 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
233 |> Map.put("inReplyToStatusId", activity.id)
234 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
235 |> Map.put("context", replied_object.data["context"] || object["conversation"])
238 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
243 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
248 def fix_in_reply_to(object), do: object
250 def fix_context(object) do
251 context = object["context"] || object["conversation"] || Utils.generate_context_id()
254 |> Map.put("context", context)
255 |> Map.put("conversation", context)
258 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
261 |> Enum.map(fn data ->
262 media_type = data["mediaType"] || data["mimeType"]
263 href = data["url"] || data["href"]
265 url = [%{"type" => "Link", "mediaType" => media_type, "href" => href}]
268 |> Map.put("mediaType", media_type)
269 |> Map.put("url", url)
273 |> Map.put("attachment", attachments)
276 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
277 Map.put(object, "attachment", [attachment])
281 def fix_attachments(object), do: object
283 def fix_url(%{"url" => url} = object) when is_map(url) do
285 |> Map.put("url", url["href"])
288 def fix_url(%{"type" => "Video", "url" => url} = object) when is_list(url) do
289 first_element = Enum.at(url, 0)
293 |> Enum.filter(fn x -> is_map(x) end)
294 |> Enum.filter(fn x -> x["mimeType"] == "text/html" end)
298 |> Map.put("attachment", [first_element])
299 |> Map.put("url", link_element["href"])
302 def fix_url(%{"type" => object_type, "url" => url} = object)
303 when object_type != "Video" and is_list(url) do
304 first_element = Enum.at(url, 0)
308 is_bitstring(first_element) -> first_element
309 is_map(first_element) -> first_element["href"] || ""
314 |> Map.put("url", url_string)
317 def fix_url(object), do: object
319 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
320 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
324 |> Enum.reduce(%{}, fn data, mapping ->
325 name = String.trim(data["name"], ":")
327 mapping |> Map.put(name, data["icon"]["url"])
330 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
331 emoji = Map.merge(object["emoji"] || %{}, emoji)
334 |> Map.put("emoji", emoji)
337 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
338 name = String.trim(tag["name"], ":")
339 emoji = %{name => tag["icon"]["url"]}
342 |> Map.put("emoji", emoji)
345 def fix_emoji(object), do: object
347 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
350 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
351 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
353 combined = tag ++ tags
356 |> Map.put("tag", combined)
359 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
360 combined = [tag, String.slice(hashtag, 1..-1)]
363 |> Map.put("tag", combined)
366 def fix_tag(%{"tag" => %{} = tag} = object), do: Map.put(object, "tag", [tag])
368 def fix_tag(object), do: object
370 # content map usually only has one language so this will do for now.
371 def fix_content_map(%{"contentMap" => content_map} = object) do
372 content_groups = Map.to_list(content_map)
373 {_, content} = Enum.at(content_groups, 0)
376 |> Map.put("content", content)
379 def fix_content_map(object), do: object
381 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
382 with true <- id =~ "follows",
383 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
384 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
391 defp mastodon_follow_hack(_, _), do: {:error, nil}
393 defp get_follow_activity(follow_object, followed) do
394 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
395 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
398 # Can't find the activity. This might a Mastodon 2.3 "Accept"
400 mastodon_follow_hack(follow_object, followed)
407 # Flag objects are placed ahead of the ID check because Mastodon 2.8 and earlier send them
409 def handle_incoming(%{"type" => "Flag", "object" => objects, "actor" => actor} = data) do
410 with context <- data["context"] || Utils.generate_context_id(),
411 content <- data["content"] || "",
412 %User{} = actor <- User.get_cached_by_ap_id(actor),
414 # Reduce the object list to find the reported user.
416 Enum.reduce_while(objects, nil, fn ap_id, _ ->
417 with %User{} = user <- User.get_cached_by_ap_id(ap_id) do
424 # Remove the reported user from the object list.
425 statuses <- Enum.filter(objects, fn ap_id -> ap_id != account.ap_id end) do
433 "cc" => [account.ap_id]
437 ActivityPub.flag(params)
441 # disallow objects with bogus IDs
442 def handle_incoming(%{"id" => nil}), do: :error
443 def handle_incoming(%{"id" => ""}), do: :error
444 # length of https:// = 8, should validate better, but good enough for now.
445 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
447 # TODO: validate those with a Ecto scheme
450 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
451 when objtype in ["Article", "Note", "Video", "Page"] do
452 actor = get_actor(data)
455 Map.put(data, "actor", actor)
458 with nil <- Activity.get_create_by_object_ap_id(object["id"]),
459 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
460 object = fix_object(data["object"])
466 context: object["conversation"],
468 published: data["published"],
477 ActivityPub.create(params)
479 %Activity{} = activity -> {:ok, activity}
485 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
487 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
488 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
489 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
490 if not User.locked?(followed) do
491 ActivityPub.accept(%{
492 to: [follower.ap_id],
498 User.follow(follower, followed)
508 %{"type" => "Accept", "object" => follow_object, "actor" => _actor, "id" => _id} = data
510 with actor <- get_actor(data),
511 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
512 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
513 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
514 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
516 ActivityPub.accept(%{
517 to: follow_activity.data["to"],
520 object: follow_activity.data["id"],
523 if not User.following?(follower, followed) do
524 {:ok, _follower} = User.follow(follower, followed)
534 %{"type" => "Reject", "object" => follow_object, "actor" => _actor, "id" => _id} = data
536 with actor <- get_actor(data),
537 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
538 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
539 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
540 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
542 ActivityPub.reject(%{
543 to: follow_activity.data["to"],
546 object: follow_activity.data["id"],
549 User.unfollow(follower, followed)
558 %{"type" => "Like", "object" => object_id, "actor" => _actor, "id" => id} = data
560 with actor <- get_actor(data),
561 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
562 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
563 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
571 %{"type" => "Announce", "object" => object_id, "actor" => _actor, "id" => id} = data
573 with actor <- get_actor(data),
574 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
575 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
576 public <- Visibility.is_public?(data),
577 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false, public) do
585 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
588 when object_type in ["Person", "Application", "Service", "Organization"] do
589 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
590 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
592 banner = new_user_data[:info]["banner"]
593 locked = new_user_data[:info]["locked"] || false
597 |> Map.take([:name, :bio, :avatar])
598 |> Map.put(:info, %{"banner" => banner, "locked" => locked})
601 |> User.upgrade_changeset(update_data)
602 |> User.update_and_set_cache()
604 ActivityPub.update(%{
606 to: data["to"] || [],
607 cc: data["cc"] || [],
618 # TODO: We presently assume that any actor on the same origin domain as the object being
619 # deleted has the rights to delete that object. A better way to validate whether or not
620 # the object should be deleted is to refetch the object URI, which should return either
621 # an error or a tombstone. This would allow us to verify that a deletion actually took
624 %{"type" => "Delete", "object" => object_id, "actor" => _actor, "id" => _id} = data
626 object_id = Utils.get_ap_id(object_id)
628 with actor <- get_actor(data),
629 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
630 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
631 :ok <- contain_origin(actor.ap_id, object.data),
632 {:ok, activity} <- ActivityPub.delete(object, false) do
642 "object" => %{"type" => "Announce", "object" => object_id},
647 with actor <- get_actor(data),
648 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
649 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
650 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
660 "object" => %{"type" => "Follow", "object" => followed},
665 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
666 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
667 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
668 User.unfollow(follower, followed)
678 "object" => %{"type" => "Block", "object" => blocked},
683 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
684 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
685 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
686 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
687 User.unblock(blocker, blocked)
695 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = _data
697 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
698 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
699 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
700 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
701 User.unfollow(blocker, blocked)
702 User.block(blocker, blocked)
712 "object" => %{"type" => "Like", "object" => object_id},
717 with actor <- get_actor(data),
718 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
719 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
720 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
727 def handle_incoming(_), do: :error
729 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
730 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
732 def get_obj_helper(id) do
733 if object = Object.normalize(id), do: {:ok, object}, else: nil
736 def set_reply_to_uri(%{"inReplyTo" => in_reply_to} = object) when is_binary(in_reply_to) do
737 with false <- String.starts_with?(in_reply_to, "http"),
738 {:ok, %{data: replied_to_object}} <- get_obj_helper(in_reply_to) do
739 Map.put(object, "inReplyTo", replied_to_object["external_url"] || in_reply_to)
745 def set_reply_to_uri(obj), do: obj
747 # Prepares the object of an outgoing create activity.
748 def prepare_object(object) do
756 |> prepare_attachments
759 |> strip_internal_fields
760 |> strip_internal_tags
765 # internal -> Mastodon
768 def prepare_outgoing(%{"type" => "Create", "object" => object} = data) do
775 |> Map.put("object", object)
776 |> Map.merge(Utils.make_json_ld_header())
781 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
782 # because of course it does.
783 def prepare_outgoing(%{"type" => "Accept"} = data) do
784 with follow_activity <- Activity.normalize(data["object"]) do
786 "actor" => follow_activity.actor,
787 "object" => follow_activity.data["object"],
788 "id" => follow_activity.data["id"],
794 |> Map.put("object", object)
795 |> Map.merge(Utils.make_json_ld_header())
801 def prepare_outgoing(%{"type" => "Reject"} = data) do
802 with follow_activity <- Activity.normalize(data["object"]) do
804 "actor" => follow_activity.actor,
805 "object" => follow_activity.data["object"],
806 "id" => follow_activity.data["id"],
812 |> Map.put("object", object)
813 |> Map.merge(Utils.make_json_ld_header())
819 def prepare_outgoing(%{"type" => _type} = data) do
822 |> strip_internal_fields
823 |> maybe_fix_object_url
824 |> Map.merge(Utils.make_json_ld_header())
829 def maybe_fix_object_url(data) do
830 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
831 case fetch_obj_helper(data["object"]) do
832 {:ok, relative_object} ->
833 if relative_object.data["external_url"] do
836 |> Map.put("object", relative_object.data["external_url"])
842 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
850 def add_hashtags(object) do
852 (object["tag"] || [])
854 # Expand internal representation tags into AS2 tags.
855 tag when is_binary(tag) ->
857 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
862 # Do not process tags which are already AS2 tag objects.
863 tag when is_map(tag) ->
868 |> Map.put("tag", tags)
871 def add_mention_tags(object) do
874 |> Utils.get_notified_from_object()
875 |> Enum.map(fn user ->
876 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
879 tags = object["tag"] || []
882 |> Map.put("tag", tags ++ mentions)
885 # TODO: we should probably send mtime instead of unix epoch time for updated
886 def add_emoji_tags(object) do
887 tags = object["tag"] || []
888 emoji = object["emoji"] || []
892 |> Enum.map(fn {name, url} ->
894 "icon" => %{"url" => url, "type" => "Image"},
895 "name" => ":" <> name <> ":",
897 "updated" => "1970-01-01T00:00:00Z",
903 |> Map.put("tag", tags ++ out)
906 def set_conversation(object) do
907 Map.put(object, "conversation", object["context"])
910 def set_sensitive(object) do
911 tags = object["tag"] || []
912 Map.put(object, "sensitive", "nsfw" in tags)
915 def add_attributed_to(object) do
916 attributed_to = object["attributedTo"] || object["actor"]
919 |> Map.put("attributedTo", attributed_to)
922 def add_likes(%{"id" => id, "like_count" => likes} = object) do
924 "id" => "#{id}/likes",
925 "first" => "#{id}/likes?page=1",
926 "type" => "OrderedCollection",
927 "totalItems" => likes
931 |> Map.put("likes", likes)
934 def add_likes(object) do
938 def prepare_attachments(object) do
940 (object["attachment"] || [])
941 |> Enum.map(fn data ->
942 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
943 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
947 |> Map.put("attachment", attachments)
950 defp strip_internal_fields(object) do
955 "announcement_count",
958 "deleted_activity_id"
962 defp strip_internal_tags(%{"tag" => tags} = object) do
965 |> Enum.filter(fn x -> is_map(x) end)
968 |> Map.put("tag", tags)
971 defp strip_internal_tags(object), do: object
973 def perform(:user_upgrade, user) do
974 # we pass a fake user so that the followers collection is stripped away
975 old_follower_address = User.ap_followers(%User{nickname: user.nickname})
980 where: ^old_follower_address in u.following,
985 "array_replace(?,?,?)",
987 ^old_follower_address,
988 ^user.follower_address
994 Repo.update_all(q, [])
996 maybe_retire_websub(user.ap_id)
1001 where: ^old_follower_address in a.recipients,
1006 "array_replace(?,?,?)",
1008 ^old_follower_address,
1009 ^user.follower_address
1015 Repo.update_all(q, [])
1018 def upgrade_user_from_ap_id(ap_id) do
1019 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
1020 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id),
1021 already_ap <- User.ap_enabled?(user),
1022 {:ok, user} <- user |> User.upgrade_changeset(data) |> User.update_and_set_cache() do
1023 unless already_ap do
1024 PleromaJobQueue.enqueue(:transmogrifier, __MODULE__, [:user_upgrade, user])
1029 %User{} = user -> {:ok, user}
1034 def maybe_retire_websub(ap_id) do
1035 # some sanity checks
1036 if is_binary(ap_id) && String.length(ap_id) > 8 do
1039 ws in Pleroma.Web.Websub.WebsubClientSubscription,
1040 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
1047 def maybe_fix_user_url(data) do
1048 if is_map(data["url"]) do
1049 Map.put(data, "url", data["url"]["href"])
1055 def maybe_fix_user_object(data) do
1057 |> maybe_fix_user_url