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 == "Person" end)
29 def get_actor(%{"actor" => actor}) when is_map(actor) do
34 Checks that an imported AP object's actor matches the domain it came from.
36 def contain_origin(id, %{"actor" => actor} = params) do
37 id_uri = URI.parse(id)
38 actor_uri = URI.parse(get_actor(params))
40 if id_uri.host == actor_uri.host do
48 Modifies an incoming AP object (mastodon format) to our internal format.
50 def fix_object(object) do
63 def fix_addressing_list(map, field) do
64 if is_binary(map[field]) do
66 |> Map.put(field, [map[field]])
72 def fix_addressing(map) do
74 |> fix_addressing_list("to")
75 |> fix_addressing_list("cc")
76 |> fix_addressing_list("bto")
77 |> fix_addressing_list("bcc")
80 def fix_actor(%{"attributedTo" => actor} = object) do
82 |> Map.put("actor", get_actor(%{"actor" => actor}))
85 def fix_likes(%{"likes" => likes} = object)
86 when is_bitstring(likes) do
87 # Check for standardisation
88 # This is what Peertube does
89 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
91 |> Map.put("likes", [])
92 |> Map.put("like_count", 0)
95 def fix_likes(object) do
99 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
100 when not is_nil(in_reply_to) do
103 is_bitstring(in_reply_to) -> in_reply_to
104 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) -> in_reply_to["id"]
105 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) -> Enum.at(in_reply_to, 0)
106 # Maybe I should output an error too?
110 case ActivityPub.fetch_object_from_id(in_reply_to_id) do
111 {:ok, replied_object} ->
112 with %Activity{} = activity <-
113 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
115 |> Map.put("inReplyTo", replied_object.data["id"])
116 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
117 |> Map.put("inReplyToStatusId", activity.id)
118 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
119 |> Map.put("context", replied_object.data["context"] || object["conversation"])
122 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
127 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
132 def fix_in_reply_to(object), do: object
134 def fix_context(object) do
135 context = object["context"] || object["conversation"] || Utils.generate_context_id()
138 |> Map.put("context", context)
139 |> Map.put("conversation", context)
142 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
145 |> Enum.map(fn data ->
146 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
147 Map.put(data, "url", url)
151 |> Map.put("attachment", attachments)
154 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
156 Map.put(attachment, "url", [
157 %{"type" => "Link", "mediaType" => attachment["mediaType"], "href" => attachment["url"]}
160 Map.put(object, "attachment", attachment)
163 def fix_attachments(object) do
167 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
168 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
172 |> Enum.reduce(%{}, fn data, mapping ->
173 name = String.trim(data["name"], ":")
175 mapping |> Map.put(name, data["icon"]["url"])
178 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
179 emoji = Map.merge(object["emoji"] || %{}, emoji)
182 |> Map.put("emoji", emoji)
185 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
186 name = String.trim(tag["name"], ":")
187 emoji = %{name => tag["icon"]["url"]}
190 |> Map.put("emoji", emoji)
193 def fix_emoji(object) do
197 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
200 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
201 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
203 combined = tag ++ tags
206 |> Map.put("tag", combined)
209 def fix_tag(object) do
213 # content map usually only has one language so this will do for now.
214 def fix_content_map(%{"contentMap" => content_map} = object) do
215 content_groups = Map.to_list(content_map)
216 {_, content} = Enum.at(content_groups, 0)
219 |> Map.put("content", content)
222 def fix_content_map(object), do: object
224 # disallow objects with bogus IDs
225 def handle_incoming(%{"id" => nil}), do: :error
226 def handle_incoming(%{"id" => ""}), do: :error
227 # length of https:// = 8, should validate better, but good enough for now.
228 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
230 # TODO: validate those with a Ecto scheme
233 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
234 when objtype in ["Article", "Note", "Video"] do
235 actor = get_actor(data)
238 Map.put(data, "actor", actor)
241 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
242 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
243 object = fix_object(data["object"])
249 context: object["conversation"],
251 published: data["published"],
259 ActivityPub.create(params)
261 %Activity{} = activity -> {:ok, activity}
267 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
269 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
270 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
271 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
272 if not User.locked?(followed) do
273 ActivityPub.accept(%{
274 to: [follower.ap_id],
275 actor: followed.ap_id,
280 User.follow(follower, followed)
289 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
290 with true <- id =~ "follows",
291 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
292 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
299 defp mastodon_follow_hack(_), do: {:error, nil}
301 defp get_follow_activity(follow_object, followed) do
302 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
303 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
306 # Can't find the activity. This might a Mastodon 2.3 "Accept"
308 mastodon_follow_hack(follow_object, followed)
316 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
318 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
319 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
320 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
322 ActivityPub.accept(%{
323 to: follow_activity.data["to"],
325 actor: followed.ap_id,
326 object: follow_activity.data["id"],
329 if not User.following?(follower, followed) do
330 {:ok, follower} = User.follow(follower, followed)
340 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
342 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
343 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
344 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
346 ActivityPub.accept(%{
347 to: follow_activity.data["to"],
349 actor: followed.ap_id,
350 object: follow_activity.data["id"],
353 User.unfollow(follower, followed)
362 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
364 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
366 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
367 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
375 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
377 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
379 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
380 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
388 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
391 when object_type in ["Person", "Application", "Service", "Organization"] do
392 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
393 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
395 banner = new_user_data[:info]["banner"]
396 locked = new_user_data[:info]["locked"] || false
400 |> Map.take([:name, :bio, :avatar])
401 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
404 |> User.upgrade_changeset(update_data)
405 |> User.update_and_set_cache()
407 ActivityPub.update(%{
409 to: data["to"] || [],
410 cc: data["cc"] || [],
423 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
425 object_id = Utils.get_ap_id(object_id)
427 with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
429 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
430 {:ok, activity} <- ActivityPub.delete(object, false) do
440 "object" => %{"type" => "Announce", "object" => object_id},
445 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
447 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
448 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
458 "object" => %{"type" => "Follow", "object" => followed},
463 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
464 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
465 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
466 User.unfollow(follower, followed)
473 @ap_config Application.get_env(:pleroma, :activitypub)
474 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
479 "object" => %{"type" => "Block", "object" => blocked},
484 with true <- @accept_blocks,
485 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
486 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
487 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
488 User.unblock(blocker, blocked)
496 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
498 with true <- @accept_blocks,
499 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
500 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
501 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
502 User.unfollow(blocker, blocked)
503 User.block(blocker, blocked)
513 "object" => %{"type" => "Like", "object" => object_id},
518 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
520 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
521 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
528 def handle_incoming(_), do: :error
530 def get_obj_helper(id) do
531 if object = Object.normalize(id), do: {:ok, object}, else: nil
534 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
535 with false <- String.starts_with?(inReplyTo, "http"),
536 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
537 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
543 def set_reply_to_uri(obj), do: obj
545 # Prepares the object of an outgoing create activity.
546 def prepare_object(object) do
553 |> prepare_attachments
560 # internal -> Mastodon
563 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
570 |> Map.put("object", object)
571 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
576 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
577 # because of course it does.
578 def prepare_outgoing(%{"type" => "Accept"} = data) do
579 with follow_activity <- Activity.normalize(data["object"]) do
581 "actor" => follow_activity.actor,
582 "object" => follow_activity.data["object"],
583 "id" => follow_activity.data["id"],
589 |> Map.put("object", object)
590 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
596 def prepare_outgoing(%{"type" => "Reject"} = data) do
597 with follow_activity <- Activity.normalize(data["object"]) do
599 "actor" => follow_activity.actor,
600 "object" => follow_activity.data["object"],
601 "id" => follow_activity.data["id"],
607 |> Map.put("object", object)
608 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
614 def prepare_outgoing(%{"type" => _type} = data) do
617 |> maybe_fix_object_url
618 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
623 def maybe_fix_object_url(data) do
624 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
625 case ActivityPub.fetch_object_from_id(data["object"]) do
626 {:ok, relative_object} ->
627 if relative_object.data["external_url"] do
630 |> Map.put("object", relative_object.data["external_url"])
636 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
644 def add_hashtags(object) do
646 (object["tag"] || [])
647 |> Enum.map(fn tag ->
649 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
656 |> Map.put("tag", tags)
659 def add_mention_tags(object) do
660 recipients = object["to"] ++ (object["cc"] || [])
664 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
666 |> Enum.map(fn user ->
667 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
670 tags = object["tag"] || []
673 |> Map.put("tag", tags ++ mentions)
676 # TODO: we should probably send mtime instead of unix epoch time for updated
677 def add_emoji_tags(object) do
678 tags = object["tag"] || []
679 emoji = object["emoji"] || []
683 |> Enum.map(fn {name, url} ->
685 "icon" => %{"url" => url, "type" => "Image"},
686 "name" => ":" <> name <> ":",
688 "updated" => "1970-01-01T00:00:00Z",
694 |> Map.put("tag", tags ++ out)
697 def set_conversation(object) do
698 Map.put(object, "conversation", object["context"])
701 def set_sensitive(object) do
702 tags = object["tag"] || []
703 Map.put(object, "sensitive", "nsfw" in tags)
706 def add_attributed_to(object) do
707 attributedTo = object["attributedTo"] || object["actor"]
710 |> Map.put("attributedTo", attributedTo)
713 def prepare_attachments(object) do
715 (object["attachment"] || [])
716 |> Enum.map(fn data ->
717 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
718 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
722 |> Map.put("attachment", attachments)
725 defp user_upgrade_task(user) do
726 old_follower_address = User.ap_followers(user)
731 where: ^old_follower_address in u.following,
736 "array_replace(?,?,?)",
738 ^old_follower_address,
739 ^user.follower_address
745 Repo.update_all(q, [])
747 maybe_retire_websub(user.ap_id)
749 # Only do this for recent activties, don't go through the whole db.
750 # Only look at the last 1000 activities.
751 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
756 where: ^old_follower_address in a.recipients,
757 where: a.id > ^since,
762 "array_replace(?,?,?)",
764 ^old_follower_address,
765 ^user.follower_address
771 Repo.update_all(q, [])
774 def upgrade_user_from_ap_id(ap_id, async \\ true) do
775 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
776 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
779 |> Map.put(:info, Map.merge(user.info, data[:info]))
781 already_ap = User.ap_enabled?(user)
784 User.upgrade_changeset(user, data)
788 # This could potentially take a long time, do it in the background
791 user_upgrade_task(user)
794 user_upgrade_task(user)
804 def maybe_retire_websub(ap_id) do
806 if is_binary(ap_id) && String.length(ap_id) > 8 do
809 ws in Pleroma.Web.Websub.WebsubClientSubscription,
810 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
817 def maybe_fix_user_url(data) do
818 if is_map(data["url"]) do
819 Map.put(data, "url", data["url"]["href"])
825 def maybe_fix_user_object(data) do
827 |> maybe_fix_user_url