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 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
174 Map.put(data, "url", url)
178 |> Map.put("attachment", attachments)
181 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
182 Map.put(object, "attachment", [attachment])
186 def fix_attachments(object), do: object
188 def fix_url(%{"url" => url} = object) when is_map(url) do
190 |> Map.put("url", url["href"])
193 def fix_url(%{"url" => url} = object) when is_list(url) do
194 first_element = Enum.at(url, 0)
198 is_bitstring(first_element) -> first_element
199 is_map(first_element) -> first_element["href"] || ""
203 if Map.get(object, "type") == "Video" do
206 |> Map.put("attachment", url_string)
209 |> Map.put("url", url_string)
213 def fix_url(object), do: object
215 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
216 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
220 |> Enum.reduce(%{}, fn data, mapping ->
221 name = String.trim(data["name"], ":")
223 mapping |> Map.put(name, data["icon"]["url"])
226 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
227 emoji = Map.merge(object["emoji"] || %{}, emoji)
230 |> Map.put("emoji", emoji)
233 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
234 name = String.trim(tag["name"], ":")
235 emoji = %{name => tag["icon"]["url"]}
238 |> Map.put("emoji", emoji)
241 def fix_emoji(object), do: object
243 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
246 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
247 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
249 combined = tag ++ tags
252 |> Map.put("tag", combined)
255 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
256 combined = [tag, String.slice(hashtag, 1..-1)]
259 |> Map.put("tag", combined)
262 def fix_tag(object), do: object
264 # content map usually only has one language so this will do for now.
265 def fix_content_map(%{"contentMap" => content_map} = object) do
266 content_groups = Map.to_list(content_map)
267 {_, content} = Enum.at(content_groups, 0)
270 |> Map.put("content", content)
273 def fix_content_map(object), do: object
275 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
276 with true <- id =~ "follows",
277 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
278 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
285 defp mastodon_follow_hack(_, _), do: {:error, nil}
287 defp get_follow_activity(follow_object, followed) do
288 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
289 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
292 # Can't find the activity. This might a Mastodon 2.3 "Accept"
294 mastodon_follow_hack(follow_object, followed)
301 # disallow objects with bogus IDs
302 def handle_incoming(%{"id" => nil}), do: :error
303 def handle_incoming(%{"id" => ""}), do: :error
304 # length of https:// = 8, should validate better, but good enough for now.
305 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
307 # TODO: validate those with a Ecto scheme
310 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
311 when objtype in ["Article", "Note", "Video", "Page"] do
312 actor = get_actor(data)
315 Map.put(data, "actor", actor)
318 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
319 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
320 object = fix_object(data["object"])
326 context: object["conversation"],
328 published: data["published"],
336 ActivityPub.create(params)
338 %Activity{} = activity -> {:ok, activity}
344 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
346 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
347 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
348 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
349 if not User.locked?(followed) do
350 ActivityPub.accept(%{
351 to: [follower.ap_id],
352 actor: followed.ap_id,
357 User.follow(follower, followed)
367 %{"type" => "Accept", "object" => follow_object, "actor" => _actor, "id" => _id} = data
369 with actor <- get_actor(data),
370 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
371 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
372 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
373 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
375 ActivityPub.accept(%{
376 to: follow_activity.data["to"],
378 actor: followed.ap_id,
379 object: follow_activity.data["id"],
382 if not User.following?(follower, followed) do
383 {:ok, _follower} = User.follow(follower, followed)
393 %{"type" => "Reject", "object" => follow_object, "actor" => _actor, "id" => _id} = data
395 with actor <- get_actor(data),
396 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
397 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
398 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
399 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
401 ActivityPub.accept(%{
402 to: follow_activity.data["to"],
404 actor: followed.ap_id,
405 object: follow_activity.data["id"],
408 User.unfollow(follower, followed)
417 %{"type" => "Like", "object" => object_id, "actor" => _actor, "id" => id} = data
419 with actor <- get_actor(data),
420 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
421 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
422 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
430 %{"type" => "Announce", "object" => object_id, "actor" => _actor, "id" => id} = data
432 with actor <- get_actor(data),
433 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
434 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
435 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
443 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
446 when object_type in ["Person", "Application", "Service", "Organization"] do
447 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
448 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
450 banner = new_user_data[:info]["banner"]
451 locked = new_user_data[:info]["locked"] || false
455 |> Map.take([:name, :bio, :avatar])
456 |> Map.put(:info, %{"banner" => banner, "locked" => locked})
459 |> User.upgrade_changeset(update_data)
460 |> User.update_and_set_cache()
462 ActivityPub.update(%{
464 to: data["to"] || [],
465 cc: data["cc"] || [],
476 # TODO: We presently assume that any actor on the same origin domain as the object being
477 # deleted has the rights to delete that object. A better way to validate whether or not
478 # the object should be deleted is to refetch the object URI, which should return either
479 # an error or a tombstone. This would allow us to verify that a deletion actually took
482 %{"type" => "Delete", "object" => object_id, "actor" => _actor, "id" => _id} = data
484 object_id = Utils.get_ap_id(object_id)
486 with actor <- get_actor(data),
487 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
488 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
489 :ok <- contain_origin(actor.ap_id, object.data),
490 {:ok, activity} <- ActivityPub.delete(object, false) do
500 "object" => %{"type" => "Announce", "object" => object_id},
505 with actor <- get_actor(data),
506 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
507 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
508 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
518 "object" => %{"type" => "Follow", "object" => followed},
523 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
524 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
525 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
526 User.unfollow(follower, followed)
536 "object" => %{"type" => "Block", "object" => blocked},
541 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
542 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
543 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
544 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
545 User.unblock(blocker, blocked)
553 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = _data
555 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
556 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
557 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
558 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
559 User.unfollow(blocker, blocked)
560 User.block(blocker, blocked)
570 "object" => %{"type" => "Like", "object" => object_id},
575 with actor <- get_actor(data),
576 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
577 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
578 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
585 def handle_incoming(_), do: :error
587 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
588 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
590 def get_obj_helper(id) do
591 if object = Object.normalize(id), do: {:ok, object}, else: nil
594 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
595 with false <- String.starts_with?(inReplyTo, "http"),
596 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
597 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
603 def set_reply_to_uri(obj), do: obj
605 # Prepares the object of an outgoing create activity.
606 def prepare_object(object) do
613 |> prepare_attachments
616 |> strip_internal_fields
617 |> strip_internal_tags
622 # internal -> Mastodon
625 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
632 |> Map.put("object", object)
633 |> Map.merge(Utils.make_json_ld_header())
638 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
639 # because of course it does.
640 def prepare_outgoing(%{"type" => "Accept"} = data) do
641 with follow_activity <- Activity.normalize(data["object"]) do
643 "actor" => follow_activity.actor,
644 "object" => follow_activity.data["object"],
645 "id" => follow_activity.data["id"],
651 |> Map.put("object", object)
652 |> Map.merge(Utils.make_json_ld_header())
658 def prepare_outgoing(%{"type" => "Reject"} = data) do
659 with follow_activity <- Activity.normalize(data["object"]) do
661 "actor" => follow_activity.actor,
662 "object" => follow_activity.data["object"],
663 "id" => follow_activity.data["id"],
669 |> Map.put("object", object)
670 |> Map.merge(Utils.make_json_ld_header())
676 def prepare_outgoing(%{"type" => _type} = data) do
679 |> maybe_fix_object_url
680 |> Map.merge(Utils.make_json_ld_header())
685 def maybe_fix_object_url(data) do
686 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
687 case fetch_obj_helper(data["object"]) do
688 {:ok, relative_object} ->
689 if relative_object.data["external_url"] do
692 |> Map.put("object", relative_object.data["external_url"])
698 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
706 def add_hashtags(object) do
708 (object["tag"] || [])
709 |> Enum.map(fn tag ->
711 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
718 |> Map.put("tag", tags)
721 def add_mention_tags(object) do
724 |> Utils.get_notified_from_object()
725 |> Enum.map(fn user ->
726 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
729 tags = object["tag"] || []
732 |> Map.put("tag", tags ++ mentions)
735 # TODO: we should probably send mtime instead of unix epoch time for updated
736 def add_emoji_tags(object) do
737 tags = object["tag"] || []
738 emoji = object["emoji"] || []
742 |> Enum.map(fn {name, url} ->
744 "icon" => %{"url" => url, "type" => "Image"},
745 "name" => ":" <> name <> ":",
747 "updated" => "1970-01-01T00:00:00Z",
753 |> Map.put("tag", tags ++ out)
756 def set_conversation(object) do
757 Map.put(object, "conversation", object["context"])
760 def set_sensitive(object) do
761 tags = object["tag"] || []
762 Map.put(object, "sensitive", "nsfw" in tags)
765 def add_attributed_to(object) do
766 attributedTo = object["attributedTo"] || object["actor"]
769 |> Map.put("attributedTo", attributedTo)
772 def prepare_attachments(object) do
774 (object["attachment"] || [])
775 |> Enum.map(fn data ->
776 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
777 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
781 |> Map.put("attachment", attachments)
784 defp strip_internal_fields(object) do
790 "announcement_count",
796 defp strip_internal_tags(%{"tag" => tags} = object) do
799 |> Enum.filter(fn x -> is_map(x) end)
802 |> Map.put("tag", tags)
805 defp strip_internal_tags(object), do: object
807 defp user_upgrade_task(user) do
808 old_follower_address = User.ap_followers(user)
813 where: ^old_follower_address in u.following,
818 "array_replace(?,?,?)",
820 ^old_follower_address,
821 ^user.follower_address
827 Repo.update_all(q, [])
829 maybe_retire_websub(user.ap_id)
831 # Only do this for recent activties, don't go through the whole db.
832 # Only look at the last 1000 activities.
833 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
838 where: ^old_follower_address in a.recipients,
839 where: a.id > ^since,
844 "array_replace(?,?,?)",
846 ^old_follower_address,
847 ^user.follower_address
853 Repo.update_all(q, [])
856 def upgrade_user_from_ap_id(ap_id, async \\ true) do
857 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
858 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
859 already_ap = User.ap_enabled?(user)
862 User.upgrade_changeset(user, data)
866 # This could potentially take a long time, do it in the background
869 user_upgrade_task(user)
872 user_upgrade_task(user)
882 def maybe_retire_websub(ap_id) do
884 if is_binary(ap_id) && String.length(ap_id) > 8 do
887 ws in Pleroma.Web.Websub.WebsubClientSubscription,
888 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
895 def maybe_fix_user_url(data) do
896 if is_map(data["url"]) do
897 Map.put(data, "url", data["url"]["href"])
903 def maybe_fix_user_object(data) do
905 |> maybe_fix_user_url