1 defmodule Pleroma.Web.ActivityPub.Transmogrifier do
3 A module to handle coding from internal to wire ActivityPub and back.
9 alias Pleroma.Web.ActivityPub.ActivityPub
10 alias Pleroma.Web.ActivityPub.Utils
16 def get_actor(%{"actor" => actor}) when is_binary(actor) do
20 def get_actor(%{"actor" => actor}) when is_list(actor) do
21 if is_binary(Enum.at(actor, 0)) do
24 Enum.find(actor, fn %{"type" => type} -> type in ["Person", "Service", "Application"] end)
29 def get_actor(%{"actor" => %{"id" => id}}) when is_bitstring(id) do
33 def get_actor(%{"actor" => nil, "attributedTo" => actor}) when not is_nil(actor) do
34 get_actor(%{"actor" => actor})
38 Checks that an imported AP object's actor matches the domain it came from.
40 def contain_origin(_id, %{"actor" => nil}), do: :error
42 def contain_origin(id, %{"actor" => _actor} = params) do
43 id_uri = URI.parse(id)
44 actor_uri = URI.parse(get_actor(params))
46 if id_uri.host == actor_uri.host do
53 def contain_origin_from_id(_id, %{"id" => nil}), do: :error
55 def contain_origin_from_id(id, %{"id" => other_id} = _params) do
56 id_uri = URI.parse(id)
57 other_uri = URI.parse(other_id)
59 if id_uri.host == other_uri.host do
67 Modifies an incoming AP object (mastodon format) to our internal format.
69 def fix_object(object) do
83 def fix_addressing_list(map, field) do
84 if is_binary(map[field]) do
86 |> Map.put(field, [map[field]])
92 def fix_addressing(map) do
94 |> fix_addressing_list("to")
95 |> fix_addressing_list("cc")
96 |> fix_addressing_list("bto")
97 |> fix_addressing_list("bcc")
100 def fix_actor(%{"attributedTo" => actor} = object) do
102 |> Map.put("actor", get_actor(%{"actor" => actor}))
105 def fix_likes(%{"likes" => likes} = object)
106 when is_bitstring(likes) do
107 # Check for standardisation
108 # This is what Peertube does
109 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
111 |> Map.put("likes", [])
112 |> Map.put("like_count", 0)
115 def fix_likes(object) do
119 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
120 when not is_nil(in_reply_to) do
123 is_bitstring(in_reply_to) ->
126 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
129 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
130 Enum.at(in_reply_to, 0)
132 # Maybe I should output an error too?
137 case fetch_obj_helper(in_reply_to_id) do
138 {:ok, replied_object} ->
139 with %Activity{} = activity <-
140 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
142 |> Map.put("inReplyTo", replied_object.data["id"])
143 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
144 |> Map.put("inReplyToStatusId", activity.id)
145 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
146 |> Map.put("context", replied_object.data["context"] || object["conversation"])
149 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
154 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
159 def fix_in_reply_to(object), do: object
161 def fix_context(object) do
162 context = object["context"] || object["conversation"] || Utils.generate_context_id()
165 |> Map.put("context", context)
166 |> Map.put("conversation", context)
169 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
172 |> Enum.map(fn data ->
173 media_type = data["mediaType"] || data["mimeType"]
174 href = data["url"] || data["href"]
176 url = [%{"type" => "Link", "mediaType" => media_type, "href" => href}]
179 |> Map.put("mediaType", media_type)
180 |> Map.put("url", url)
184 |> Map.put("attachment", attachments)
187 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
188 Map.put(object, "attachment", [attachment])
192 def fix_attachments(object), do: object
194 def fix_url(%{"url" => url} = object) when is_map(url) do
196 |> Map.put("url", url["href"])
199 def fix_url(%{"type" => "Video", "url" => url} = object) when is_list(url) do
200 first_element = Enum.at(url, 0)
204 |> Enum.filter(fn x -> is_map(x) end)
205 |> Enum.filter(fn x -> x["mimeType"] == "text/html" end)
209 |> Map.put("attachment", [first_element])
210 |> Map.put("url", link_element["href"])
213 def fix_url(%{"type" => object_type, "url" => url} = object)
214 when object_type != "Video" and is_list(url) do
215 first_element = Enum.at(url, 0)
219 is_bitstring(first_element) -> first_element
220 is_map(first_element) -> first_element["href"] || ""
225 |> Map.put("url", url_string)
228 def fix_url(object), do: object
230 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
231 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
235 |> Enum.reduce(%{}, fn data, mapping ->
236 name = String.trim(data["name"], ":")
238 mapping |> Map.put(name, data["icon"]["url"])
241 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
242 emoji = Map.merge(object["emoji"] || %{}, emoji)
245 |> Map.put("emoji", emoji)
248 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
249 name = String.trim(tag["name"], ":")
250 emoji = %{name => tag["icon"]["url"]}
253 |> Map.put("emoji", emoji)
256 def fix_emoji(object), do: object
258 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
261 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
262 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
264 combined = tag ++ tags
267 |> Map.put("tag", combined)
270 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
271 combined = [tag, String.slice(hashtag, 1..-1)]
274 |> Map.put("tag", combined)
277 def fix_tag(object), do: object
279 # content map usually only has one language so this will do for now.
280 def fix_content_map(%{"contentMap" => content_map} = object) do
281 content_groups = Map.to_list(content_map)
282 {_, content} = Enum.at(content_groups, 0)
285 |> Map.put("content", content)
288 def fix_content_map(object), do: object
290 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
291 with true <- id =~ "follows",
292 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
293 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
300 defp mastodon_follow_hack(_, _), do: {:error, nil}
302 defp get_follow_activity(follow_object, followed) do
303 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
304 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
307 # Can't find the activity. This might a Mastodon 2.3 "Accept"
309 mastodon_follow_hack(follow_object, followed)
316 # disallow objects with bogus IDs
317 def handle_incoming(%{"id" => nil}), do: :error
318 def handle_incoming(%{"id" => ""}), do: :error
319 # length of https:// = 8, should validate better, but good enough for now.
320 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
322 # TODO: validate those with a Ecto scheme
325 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
326 when objtype in ["Article", "Note", "Video", "Page"] do
327 actor = get_actor(data)
330 Map.put(data, "actor", actor)
333 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
334 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
335 object = fix_object(data["object"])
341 context: object["conversation"],
343 published: data["published"],
351 ActivityPub.create(params)
353 %Activity{} = activity -> {:ok, activity}
359 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
361 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
362 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
363 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
364 if not User.locked?(followed) do
365 ActivityPub.accept(%{
366 to: [follower.ap_id],
367 actor: followed.ap_id,
372 User.follow(follower, followed)
382 %{"type" => "Accept", "object" => follow_object, "actor" => _actor, "id" => _id} = data
384 with actor <- get_actor(data),
385 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
386 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
387 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
388 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
390 ActivityPub.accept(%{
391 to: follow_activity.data["to"],
393 actor: followed.ap_id,
394 object: follow_activity.data["id"],
397 if not User.following?(follower, followed) do
398 {:ok, _follower} = User.follow(follower, followed)
408 %{"type" => "Reject", "object" => follow_object, "actor" => _actor, "id" => _id} = data
410 with actor <- get_actor(data),
411 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
412 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
413 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
414 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
416 ActivityPub.accept(%{
417 to: follow_activity.data["to"],
419 actor: followed.ap_id,
420 object: follow_activity.data["id"],
423 User.unfollow(follower, followed)
432 %{"type" => "Like", "object" => object_id, "actor" => _actor, "id" => id} = data
434 with actor <- get_actor(data),
435 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
436 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
437 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
445 %{"type" => "Announce", "object" => object_id, "actor" => _actor, "id" => id} = data
447 with actor <- get_actor(data),
448 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
449 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
450 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
458 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
461 when object_type in ["Person", "Application", "Service", "Organization"] do
462 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
463 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
465 banner = new_user_data[:info]["banner"]
466 locked = new_user_data[:info]["locked"] || false
470 |> Map.take([:name, :bio, :avatar])
471 |> Map.put(:info, %{"banner" => banner, "locked" => locked})
474 |> User.upgrade_changeset(update_data)
475 |> User.update_and_set_cache()
477 ActivityPub.update(%{
479 to: data["to"] || [],
480 cc: data["cc"] || [],
491 # TODO: We presently assume that any actor on the same origin domain as the object being
492 # deleted has the rights to delete that object. A better way to validate whether or not
493 # the object should be deleted is to refetch the object URI, which should return either
494 # an error or a tombstone. This would allow us to verify that a deletion actually took
497 %{"type" => "Delete", "object" => object_id, "actor" => _actor, "id" => _id} = data
499 object_id = Utils.get_ap_id(object_id)
501 with actor <- get_actor(data),
502 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
503 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
504 :ok <- contain_origin(actor.ap_id, object.data),
505 {:ok, activity} <- ActivityPub.delete(object, false) do
515 "object" => %{"type" => "Announce", "object" => object_id},
520 with actor <- get_actor(data),
521 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
522 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
523 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
533 "object" => %{"type" => "Follow", "object" => followed},
538 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
539 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
540 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
541 User.unfollow(follower, followed)
551 "object" => %{"type" => "Block", "object" => blocked},
556 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
557 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
558 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
559 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
560 User.unblock(blocker, blocked)
568 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = _data
570 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
571 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
572 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
573 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
574 User.unfollow(blocker, blocked)
575 User.block(blocker, blocked)
585 "object" => %{"type" => "Like", "object" => object_id},
590 with actor <- get_actor(data),
591 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
592 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
593 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
600 def handle_incoming(_), do: :error
602 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
603 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
605 def get_obj_helper(id) do
606 if object = Object.normalize(id), do: {:ok, object}, else: nil
609 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
610 with false <- String.starts_with?(inReplyTo, "http"),
611 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
612 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
618 def set_reply_to_uri(obj), do: obj
620 # Prepares the object of an outgoing create activity.
621 def prepare_object(object) do
628 |> prepare_attachments
631 |> strip_internal_fields
632 |> strip_internal_tags
637 # internal -> Mastodon
640 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
647 |> Map.put("object", object)
648 |> Map.merge(Utils.make_json_ld_header())
653 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
654 # because of course it does.
655 def prepare_outgoing(%{"type" => "Accept"} = data) do
656 with follow_activity <- Activity.normalize(data["object"]) do
658 "actor" => follow_activity.actor,
659 "object" => follow_activity.data["object"],
660 "id" => follow_activity.data["id"],
666 |> Map.put("object", object)
667 |> Map.merge(Utils.make_json_ld_header())
673 def prepare_outgoing(%{"type" => "Reject"} = data) do
674 with follow_activity <- Activity.normalize(data["object"]) do
676 "actor" => follow_activity.actor,
677 "object" => follow_activity.data["object"],
678 "id" => follow_activity.data["id"],
684 |> Map.put("object", object)
685 |> Map.merge(Utils.make_json_ld_header())
691 def prepare_outgoing(%{"type" => _type} = data) do
694 |> maybe_fix_object_url
695 |> Map.merge(Utils.make_json_ld_header())
700 def maybe_fix_object_url(data) do
701 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
702 case fetch_obj_helper(data["object"]) do
703 {:ok, relative_object} ->
704 if relative_object.data["external_url"] do
707 |> Map.put("object", relative_object.data["external_url"])
713 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
721 def add_hashtags(object) do
723 (object["tag"] || [])
724 |> Enum.map(fn tag ->
726 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
733 |> Map.put("tag", tags)
736 def add_mention_tags(object) do
739 |> Utils.get_notified_from_object()
740 |> Enum.map(fn user ->
741 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
744 tags = object["tag"] || []
747 |> Map.put("tag", tags ++ mentions)
750 # TODO: we should probably send mtime instead of unix epoch time for updated
751 def add_emoji_tags(object) do
752 tags = object["tag"] || []
753 emoji = object["emoji"] || []
757 |> Enum.map(fn {name, url} ->
759 "icon" => %{"url" => url, "type" => "Image"},
760 "name" => ":" <> name <> ":",
762 "updated" => "1970-01-01T00:00:00Z",
768 |> Map.put("tag", tags ++ out)
771 def set_conversation(object) do
772 Map.put(object, "conversation", object["context"])
775 def set_sensitive(object) do
776 tags = object["tag"] || []
777 Map.put(object, "sensitive", "nsfw" in tags)
780 def add_attributed_to(object) do
781 attributedTo = object["attributedTo"] || object["actor"]
784 |> Map.put("attributedTo", attributedTo)
787 def prepare_attachments(object) do
789 (object["attachment"] || [])
790 |> Enum.map(fn data ->
791 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
792 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
796 |> Map.put("attachment", attachments)
799 defp strip_internal_fields(object) do
805 "announcement_count",
811 defp strip_internal_tags(%{"tag" => tags} = object) do
814 |> Enum.filter(fn x -> is_map(x) end)
817 |> Map.put("tag", tags)
820 defp strip_internal_tags(object), do: object
822 defp user_upgrade_task(user) do
823 old_follower_address = User.ap_followers(user)
828 where: ^old_follower_address in u.following,
833 "array_replace(?,?,?)",
835 ^old_follower_address,
836 ^user.follower_address
842 Repo.update_all(q, [])
844 maybe_retire_websub(user.ap_id)
846 # Only do this for recent activties, don't go through the whole db.
847 # Only look at the last 1000 activities.
848 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
853 where: ^old_follower_address in a.recipients,
854 where: a.id > ^since,
859 "array_replace(?,?,?)",
861 ^old_follower_address,
862 ^user.follower_address
868 Repo.update_all(q, [])
871 def upgrade_user_from_ap_id(ap_id, async \\ true) do
872 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
873 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
874 already_ap = User.ap_enabled?(user)
877 User.upgrade_changeset(user, data)
881 # This could potentially take a long time, do it in the background
884 user_upgrade_task(user)
887 user_upgrade_task(user)
897 def maybe_retire_websub(ap_id) do
899 if is_binary(ap_id) && String.length(ap_id) > 8 do
902 ws in Pleroma.Web.Websub.WebsubClientSubscription,
903 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
910 def maybe_fix_user_url(data) do
911 if is_map(data["url"]) do
912 Map.put(data, "url", data["url"]["href"])
918 def maybe_fix_user_object(data) do
920 |> maybe_fix_user_url