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
54 Modifies an incoming AP object (mastodon format) to our internal format.
56 def fix_object(object) do
70 def fix_addressing_list(map, field) do
71 if is_binary(map[field]) do
73 |> Map.put(field, [map[field]])
79 def fix_addressing(map) do
81 |> fix_addressing_list("to")
82 |> fix_addressing_list("cc")
83 |> fix_addressing_list("bto")
84 |> fix_addressing_list("bcc")
87 def fix_actor(%{"attributedTo" => actor} = object) do
89 |> Map.put("actor", get_actor(%{"actor" => actor}))
92 def fix_likes(%{"likes" => likes} = object)
93 when is_bitstring(likes) do
94 # Check for standardisation
95 # This is what Peertube does
96 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
98 |> Map.put("likes", [])
99 |> Map.put("like_count", 0)
102 def fix_likes(object) do
106 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
107 when not is_nil(in_reply_to) do
110 is_bitstring(in_reply_to) ->
113 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
116 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
117 Enum.at(in_reply_to, 0)
119 # Maybe I should output an error too?
124 case fetch_obj_helper(in_reply_to_id) do
125 {:ok, replied_object} ->
126 with %Activity{} = activity <-
127 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
129 |> Map.put("inReplyTo", replied_object.data["id"])
130 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
131 |> Map.put("inReplyToStatusId", activity.id)
132 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
133 |> Map.put("context", replied_object.data["context"] || object["conversation"])
136 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
141 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
146 def fix_in_reply_to(object), do: object
148 def fix_context(object) do
149 context = object["context"] || object["conversation"] || Utils.generate_context_id()
152 |> Map.put("context", context)
153 |> Map.put("conversation", context)
156 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
159 |> Enum.map(fn data ->
160 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
161 Map.put(data, "url", url)
165 |> Map.put("attachment", attachments)
168 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
169 Map.put(object, "attachment", [attachment])
173 def fix_attachments(object), do: object
175 def fix_url(%{"url" => url} = object) when is_map(url) do
177 |> Map.put("url", url["href"])
180 def fix_url(%{"url" => url} = object) when is_list(url) do
181 first_element = Enum.at(url, 0)
185 is_bitstring(first_element) -> first_element
186 is_map(first_element) -> first_element["href"] || ""
191 |> Map.put("url", url_string)
194 def fix_url(object), do: object
196 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
197 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
201 |> Enum.reduce(%{}, fn data, mapping ->
202 name = String.trim(data["name"], ":")
204 mapping |> Map.put(name, data["icon"]["url"])
207 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
208 emoji = Map.merge(object["emoji"] || %{}, emoji)
211 |> Map.put("emoji", emoji)
214 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
215 name = String.trim(tag["name"], ":")
216 emoji = %{name => tag["icon"]["url"]}
219 |> Map.put("emoji", emoji)
222 def fix_emoji(object), do: object
224 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
227 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
228 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
230 combined = tag ++ tags
233 |> Map.put("tag", combined)
236 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
237 combined = [tag, String.slice(hashtag, 1..-1)]
240 |> Map.put("tag", combined)
243 def fix_tag(object), do: object
245 # content map usually only has one language so this will do for now.
246 def fix_content_map(%{"contentMap" => content_map} = object) do
247 content_groups = Map.to_list(content_map)
248 {_, content} = Enum.at(content_groups, 0)
251 |> Map.put("content", content)
254 def fix_content_map(object), do: object
256 # disallow objects with bogus IDs
257 def handle_incoming(%{"id" => nil}), do: :error
258 def handle_incoming(%{"id" => ""}), do: :error
259 # length of https:// = 8, should validate better, but good enough for now.
260 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
262 # TODO: validate those with a Ecto scheme
265 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
266 when objtype in ["Article", "Note", "Video", "Page"] do
267 actor = get_actor(data)
270 Map.put(data, "actor", actor)
273 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
274 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
275 object = fix_object(data["object"])
281 context: object["conversation"],
283 published: data["published"],
291 ActivityPub.create(params)
293 %Activity{} = activity -> {:ok, activity}
299 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
301 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
302 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
303 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
304 if not User.locked?(followed) do
305 ActivityPub.accept(%{
306 to: [follower.ap_id],
307 actor: followed.ap_id,
312 User.follow(follower, followed)
321 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
322 with true <- id =~ "follows",
323 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
324 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
331 defp mastodon_follow_hack(_), do: {:error, nil}
333 defp get_follow_activity(follow_object, followed) do
334 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
335 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
338 # Can't find the activity. This might a Mastodon 2.3 "Accept"
340 mastodon_follow_hack(follow_object, followed)
348 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
350 with actor <- get_actor(data),
351 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
352 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
353 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
354 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
356 ActivityPub.accept(%{
357 to: follow_activity.data["to"],
359 actor: followed.ap_id,
360 object: follow_activity.data["id"],
363 if not User.following?(follower, followed) do
364 {:ok, follower} = User.follow(follower, followed)
374 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
376 with actor <- get_actor(data),
377 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
378 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
379 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
380 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
382 ActivityPub.accept(%{
383 to: follow_activity.data["to"],
385 actor: followed.ap_id,
386 object: follow_activity.data["id"],
389 User.unfollow(follower, followed)
398 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = data
400 with actor <- get_actor(data),
401 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
402 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
403 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
411 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = data
413 with actor <- get_actor(data),
414 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
415 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
416 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
424 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
427 when object_type in ["Person", "Application", "Service", "Organization"] do
428 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
429 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
431 banner = new_user_data[:info]["banner"]
432 locked = new_user_data[:info]["locked"] || false
436 |> Map.take([:name, :bio, :avatar])
437 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
440 |> User.upgrade_changeset(update_data)
441 |> User.update_and_set_cache()
443 ActivityPub.update(%{
445 to: data["to"] || [],
446 cc: data["cc"] || [],
459 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = data
461 object_id = Utils.get_ap_id(object_id)
463 with actor <- get_actor(data),
464 %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
465 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
466 {:ok, activity} <- ActivityPub.delete(object, false) do
476 "object" => %{"type" => "Announce", "object" => object_id},
481 with actor <- get_actor(data),
482 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
483 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
484 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
494 "object" => %{"type" => "Follow", "object" => followed},
499 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
500 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
501 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
502 User.unfollow(follower, followed)
509 @ap_config Application.get_env(:pleroma, :activitypub)
510 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
515 "object" => %{"type" => "Block", "object" => blocked},
520 with true <- @accept_blocks,
521 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
522 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
523 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
524 User.unblock(blocker, blocked)
532 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
534 with true <- @accept_blocks,
535 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
536 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
537 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
538 User.unfollow(blocker, blocked)
539 User.block(blocker, blocked)
549 "object" => %{"type" => "Like", "object" => object_id},
554 with actor <- get_actor(data),
555 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
556 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
557 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
564 def handle_incoming(_), do: :error
566 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
567 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
569 def get_obj_helper(id) do
570 if object = Object.normalize(id), do: {:ok, object}, else: nil
573 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
574 with false <- String.starts_with?(inReplyTo, "http"),
575 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
576 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
582 def set_reply_to_uri(obj), do: obj
584 # Prepares the object of an outgoing create activity.
585 def prepare_object(object) do
592 |> prepare_attachments
599 # internal -> Mastodon
602 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
609 |> Map.put("object", object)
610 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
615 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
616 # because of course it does.
617 def prepare_outgoing(%{"type" => "Accept"} = data) do
618 with follow_activity <- Activity.normalize(data["object"]) do
620 "actor" => follow_activity.actor,
621 "object" => follow_activity.data["object"],
622 "id" => follow_activity.data["id"],
628 |> Map.put("object", object)
629 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
635 def prepare_outgoing(%{"type" => "Reject"} = data) do
636 with follow_activity <- Activity.normalize(data["object"]) do
638 "actor" => follow_activity.actor,
639 "object" => follow_activity.data["object"],
640 "id" => follow_activity.data["id"],
646 |> Map.put("object", object)
647 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
653 def prepare_outgoing(%{"type" => _type} = data) do
656 |> maybe_fix_object_url
657 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
662 def maybe_fix_object_url(data) do
663 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
664 case fetch_obj_helper(data["object"]) do
665 {:ok, relative_object} ->
666 if relative_object.data["external_url"] do
669 |> Map.put("object", relative_object.data["external_url"])
675 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
683 def add_hashtags(object) do
685 (object["tag"] || [])
686 |> Enum.map(fn tag ->
688 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
695 |> Map.put("tag", tags)
698 def add_mention_tags(object) do
699 recipients = object["to"] ++ (object["cc"] || [])
703 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
705 |> Enum.map(fn user ->
706 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
709 tags = object["tag"] || []
712 |> Map.put("tag", tags ++ mentions)
715 # TODO: we should probably send mtime instead of unix epoch time for updated
716 def add_emoji_tags(object) do
717 tags = object["tag"] || []
718 emoji = object["emoji"] || []
722 |> Enum.map(fn {name, url} ->
724 "icon" => %{"url" => url, "type" => "Image"},
725 "name" => ":" <> name <> ":",
727 "updated" => "1970-01-01T00:00:00Z",
733 |> Map.put("tag", tags ++ out)
736 def set_conversation(object) do
737 Map.put(object, "conversation", object["context"])
740 def set_sensitive(object) do
741 tags = object["tag"] || []
742 Map.put(object, "sensitive", "nsfw" in tags)
745 def add_attributed_to(object) do
746 attributedTo = object["attributedTo"] || object["actor"]
749 |> Map.put("attributedTo", attributedTo)
752 def prepare_attachments(object) do
754 (object["attachment"] || [])
755 |> Enum.map(fn data ->
756 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
757 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
761 |> Map.put("attachment", attachments)
764 defp user_upgrade_task(user) do
765 old_follower_address = User.ap_followers(user)
770 where: ^old_follower_address in u.following,
775 "array_replace(?,?,?)",
777 ^old_follower_address,
778 ^user.follower_address
784 Repo.update_all(q, [])
786 maybe_retire_websub(user.ap_id)
788 # Only do this for recent activties, don't go through the whole db.
789 # Only look at the last 1000 activities.
790 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
795 where: ^old_follower_address in a.recipients,
796 where: a.id > ^since,
801 "array_replace(?,?,?)",
803 ^old_follower_address,
804 ^user.follower_address
810 Repo.update_all(q, [])
813 def upgrade_user_from_ap_id(ap_id, async \\ true) do
814 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
815 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
818 |> Map.put(:info, Map.merge(user.info, data[:info]))
820 already_ap = User.ap_enabled?(user)
823 User.upgrade_changeset(user, data)
827 # This could potentially take a long time, do it in the background
830 user_upgrade_task(user)
833 user_upgrade_task(user)
843 def maybe_retire_websub(ap_id) do
845 if is_binary(ap_id) && String.length(ap_id) > 8 do
848 ws in Pleroma.Web.Websub.WebsubClientSubscription,
849 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
856 def maybe_fix_user_url(data) do
857 if is_map(data["url"]) do
858 Map.put(data, "url", data["url"]["href"])
864 def maybe_fix_user_object(data) do
866 |> maybe_fix_user_url