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
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) ->
106 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
109 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
110 Enum.at(in_reply_to, 0)
112 # Maybe I should output an error too?
117 case ActivityPub.fetch_object_from_id(in_reply_to_id) do
118 {:ok, replied_object} ->
119 with %Activity{} = activity <-
120 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
122 |> Map.put("inReplyTo", replied_object.data["id"])
123 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
124 |> Map.put("inReplyToStatusId", activity.id)
125 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
126 |> Map.put("context", replied_object.data["context"] || object["conversation"])
129 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
134 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
139 def fix_in_reply_to(object), do: object
141 def fix_context(object) do
142 context = object["context"] || object["conversation"] || Utils.generate_context_id()
145 |> Map.put("context", context)
146 |> Map.put("conversation", context)
149 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
152 |> Enum.map(fn data ->
153 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
154 Map.put(data, "url", url)
158 |> Map.put("attachment", attachments)
161 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
163 Map.put(attachment, "url", [
164 %{"type" => "Link", "mediaType" => attachment["mediaType"], "href" => attachment["url"]}
167 Map.put(object, "attachment", attachment)
170 def fix_attachments(object), do: object
172 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
173 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
177 |> Enum.reduce(%{}, fn data, mapping ->
178 name = String.trim(data["name"], ":")
180 mapping |> Map.put(name, data["icon"]["url"])
183 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
184 emoji = Map.merge(object["emoji"] || %{}, emoji)
187 |> Map.put("emoji", emoji)
190 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
191 name = String.trim(tag["name"], ":")
192 emoji = %{name => tag["icon"]["url"]}
195 |> Map.put("emoji", emoji)
198 def fix_emoji(object), do: object
200 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
203 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
204 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
206 combined = tag ++ tags
209 |> Map.put("tag", combined)
212 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
213 combined = [tag, String.slice(hashtag, 1..-1)]
216 |> Map.put("tag", combined)
219 def fix_tag(object), do: object
221 # content map usually only has one language so this will do for now.
222 def fix_content_map(%{"contentMap" => content_map} = object) do
223 content_groups = Map.to_list(content_map)
224 {_, content} = Enum.at(content_groups, 0)
227 |> Map.put("content", content)
230 def fix_content_map(object), do: object
232 # disallow objects with bogus IDs
233 def handle_incoming(%{"id" => nil}), do: :error
234 def handle_incoming(%{"id" => ""}), do: :error
235 # length of https:// = 8, should validate better, but good enough for now.
236 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
238 # TODO: validate those with a Ecto scheme
241 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
242 when objtype in ["Article", "Note", "Video"] do
243 actor = get_actor(data)
246 Map.put(data, "actor", actor)
249 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
250 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
251 object = fix_object(data["object"])
257 context: object["conversation"],
259 published: data["published"],
267 ActivityPub.create(params)
269 %Activity{} = activity -> {:ok, activity}
275 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
277 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
278 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
279 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
280 if not User.locked?(followed) do
281 ActivityPub.accept(%{
282 to: [follower.ap_id],
283 actor: followed.ap_id,
288 User.follow(follower, followed)
297 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
298 with true <- id =~ "follows",
299 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
300 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
307 defp mastodon_follow_hack(_), do: {:error, nil}
309 defp get_follow_activity(follow_object, followed) do
310 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
311 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
314 # Can't find the activity. This might a Mastodon 2.3 "Accept"
316 mastodon_follow_hack(follow_object, followed)
324 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
326 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
327 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
328 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
330 ActivityPub.accept(%{
331 to: follow_activity.data["to"],
333 actor: followed.ap_id,
334 object: follow_activity.data["id"],
337 if not User.following?(follower, followed) do
338 {:ok, follower} = User.follow(follower, followed)
348 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
350 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
351 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
352 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
354 ActivityPub.accept(%{
355 to: follow_activity.data["to"],
357 actor: followed.ap_id,
358 object: follow_activity.data["id"],
361 User.unfollow(follower, followed)
370 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
372 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
374 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
375 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
383 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
385 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
387 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
388 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
396 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
399 when object_type in ["Person", "Application", "Service", "Organization"] do
400 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
401 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
403 banner = new_user_data[:info]["banner"]
404 locked = new_user_data[:info]["locked"] || false
408 |> Map.take([:name, :bio, :avatar])
409 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
412 |> User.upgrade_changeset(update_data)
413 |> User.update_and_set_cache()
415 ActivityPub.update(%{
417 to: data["to"] || [],
418 cc: data["cc"] || [],
431 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
433 object_id = Utils.get_ap_id(object_id)
435 with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
437 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
438 {:ok, activity} <- ActivityPub.delete(object, false) do
448 "object" => %{"type" => "Announce", "object" => object_id},
453 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
455 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
456 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
466 "object" => %{"type" => "Follow", "object" => followed},
471 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
472 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
473 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
474 User.unfollow(follower, followed)
481 @ap_config Application.get_env(:pleroma, :activitypub)
482 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
487 "object" => %{"type" => "Block", "object" => blocked},
492 with true <- @accept_blocks,
493 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
494 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
495 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
496 User.unblock(blocker, blocked)
504 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
506 with true <- @accept_blocks,
507 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
508 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
509 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
510 User.unfollow(blocker, blocked)
511 User.block(blocker, blocked)
521 "object" => %{"type" => "Like", "object" => object_id},
526 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
528 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
529 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
536 def handle_incoming(_), do: :error
538 def get_obj_helper(id) do
539 if object = Object.normalize(id), do: {:ok, object}, else: nil
542 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
543 with false <- String.starts_with?(inReplyTo, "http"),
544 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
545 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
551 def set_reply_to_uri(obj), do: obj
553 # Prepares the object of an outgoing create activity.
554 def prepare_object(object) do
561 |> prepare_attachments
568 # internal -> Mastodon
571 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
578 |> Map.put("object", object)
579 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
584 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
585 # because of course it does.
586 def prepare_outgoing(%{"type" => "Accept"} = data) do
587 with follow_activity <- Activity.normalize(data["object"]) do
589 "actor" => follow_activity.actor,
590 "object" => follow_activity.data["object"],
591 "id" => follow_activity.data["id"],
597 |> Map.put("object", object)
598 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
604 def prepare_outgoing(%{"type" => "Reject"} = data) do
605 with follow_activity <- Activity.normalize(data["object"]) do
607 "actor" => follow_activity.actor,
608 "object" => follow_activity.data["object"],
609 "id" => follow_activity.data["id"],
615 |> Map.put("object", object)
616 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
622 def prepare_outgoing(%{"type" => _type} = data) do
625 |> maybe_fix_object_url
626 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
631 def maybe_fix_object_url(data) do
632 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
633 case ActivityPub.fetch_object_from_id(data["object"]) do
634 {:ok, relative_object} ->
635 if relative_object.data["external_url"] do
638 |> Map.put("object", relative_object.data["external_url"])
644 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
652 def add_hashtags(object) do
654 (object["tag"] || [])
655 |> Enum.map(fn tag ->
657 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
664 |> Map.put("tag", tags)
667 def add_mention_tags(object) do
668 recipients = object["to"] ++ (object["cc"] || [])
672 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
674 |> Enum.map(fn user ->
675 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
678 tags = object["tag"] || []
681 |> Map.put("tag", tags ++ mentions)
684 # TODO: we should probably send mtime instead of unix epoch time for updated
685 def add_emoji_tags(object) do
686 tags = object["tag"] || []
687 emoji = object["emoji"] || []
691 |> Enum.map(fn {name, url} ->
693 "icon" => %{"url" => url, "type" => "Image"},
694 "name" => ":" <> name <> ":",
696 "updated" => "1970-01-01T00:00:00Z",
702 |> Map.put("tag", tags ++ out)
705 def set_conversation(object) do
706 Map.put(object, "conversation", object["context"])
709 def set_sensitive(object) do
710 tags = object["tag"] || []
711 Map.put(object, "sensitive", "nsfw" in tags)
714 def add_attributed_to(object) do
715 attributedTo = object["attributedTo"] || object["actor"]
718 |> Map.put("attributedTo", attributedTo)
721 def prepare_attachments(object) do
723 (object["attachment"] || [])
724 |> Enum.map(fn data ->
725 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
726 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
730 |> Map.put("attachment", attachments)
733 defp user_upgrade_task(user) do
734 old_follower_address = User.ap_followers(user)
739 where: ^old_follower_address in u.following,
744 "array_replace(?,?,?)",
746 ^old_follower_address,
747 ^user.follower_address
753 Repo.update_all(q, [])
755 maybe_retire_websub(user.ap_id)
757 # Only do this for recent activties, don't go through the whole db.
758 # Only look at the last 1000 activities.
759 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
764 where: ^old_follower_address in a.recipients,
765 where: a.id > ^since,
770 "array_replace(?,?,?)",
772 ^old_follower_address,
773 ^user.follower_address
779 Repo.update_all(q, [])
782 def upgrade_user_from_ap_id(ap_id, async \\ true) do
783 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
784 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
787 |> Map.put(:info, Map.merge(user.info, data[:info]))
789 already_ap = User.ap_enabled?(user)
792 User.upgrade_changeset(user, data)
796 # This could potentially take a long time, do it in the background
799 user_upgrade_task(user)
802 user_upgrade_task(user)
812 def maybe_retire_websub(ap_id) do
814 if is_binary(ap_id) && String.length(ap_id) > 8 do
817 ws in Pleroma.Web.Websub.WebsubClientSubscription,
818 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
825 def maybe_fix_user_url(data) do
826 if is_map(data["url"]) do
827 Map.put(data, "url", data["url"]["href"])
833 def maybe_fix_user_object(data) do
835 |> maybe_fix_user_url