1 defmodule Pleroma.Web.ActivityPub.Transmogrifier do
3 A module to handle coding from internal to wire ActivityPub and back.
7 alias Pleroma.Object.Containment
10 alias Pleroma.Web.ActivityPub.ActivityPub
11 alias Pleroma.Web.ActivityPub.Utils
18 Modifies an incoming AP object (mastodon format) to our internal format.
20 def fix_object(object) do
34 def fix_addressing_list(map, field) do
35 if is_binary(map[field]) do
37 |> Map.put(field, [map[field]])
43 def fix_addressing(map) do
45 |> fix_addressing_list("to")
46 |> fix_addressing_list("cc")
47 |> fix_addressing_list("bto")
48 |> fix_addressing_list("bcc")
51 def fix_actor(%{"attributedTo" => actor} = object) do
53 |> Map.put("actor", Containment.get_actor(%{"actor" => actor}))
56 def fix_likes(%{"likes" => likes} = object)
57 when is_bitstring(likes) do
58 # Check for standardisation
59 # This is what Peertube does
60 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
62 |> Map.put("likes", [])
63 |> Map.put("like_count", 0)
66 def fix_likes(object) do
70 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
71 when not is_nil(in_reply_to) do
74 is_bitstring(in_reply_to) ->
77 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
80 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
81 Enum.at(in_reply_to, 0)
83 # Maybe I should output an error too?
88 case fetch_obj_helper(in_reply_to_id) do
89 {:ok, replied_object} ->
90 with %Activity{} = activity <-
91 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
93 |> Map.put("inReplyTo", replied_object.data["id"])
94 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
95 |> Map.put("inReplyToStatusId", activity.id)
96 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
97 |> Map.put("context", replied_object.data["context"] || object["conversation"])
100 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
105 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
110 def fix_in_reply_to(object), do: object
112 def fix_context(object) do
113 context = object["context"] || object["conversation"] || Utils.generate_context_id()
116 |> Map.put("context", context)
117 |> Map.put("conversation", context)
120 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
123 |> Enum.map(fn data ->
124 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
125 Map.put(data, "url", url)
129 |> Map.put("attachment", attachments)
132 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
133 Map.put(object, "attachment", [attachment])
137 def fix_attachments(object), do: object
139 def fix_url(%{"url" => url} = object) when is_map(url) do
141 |> Map.put("url", url["href"])
144 def fix_url(%{"url" => url} = object) when is_list(url) do
145 first_element = Enum.at(url, 0)
149 is_bitstring(first_element) -> first_element
150 is_map(first_element) -> first_element["href"] || ""
155 |> Map.put("url", url_string)
158 def fix_url(object), do: object
160 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
161 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
165 |> Enum.reduce(%{}, fn data, mapping ->
166 name = String.trim(data["name"], ":")
168 mapping |> Map.put(name, data["icon"]["url"])
171 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
172 emoji = Map.merge(object["emoji"] || %{}, emoji)
175 |> Map.put("emoji", emoji)
178 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
179 name = String.trim(tag["name"], ":")
180 emoji = %{name => tag["icon"]["url"]}
183 |> Map.put("emoji", emoji)
186 def fix_emoji(object), do: object
188 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
191 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
192 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
194 combined = tag ++ tags
197 |> Map.put("tag", combined)
200 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
201 combined = [tag, String.slice(hashtag, 1..-1)]
204 |> Map.put("tag", combined)
207 def fix_tag(object), do: object
209 # content map usually only has one language so this will do for now.
210 def fix_content_map(%{"contentMap" => content_map} = object) do
211 content_groups = Map.to_list(content_map)
212 {_, content} = Enum.at(content_groups, 0)
215 |> Map.put("content", content)
218 def fix_content_map(object), do: object
220 # disallow objects with bogus IDs
221 def handle_incoming(%{"id" => nil}), do: :error
222 def handle_incoming(%{"id" => ""}), do: :error
223 # length of https:// = 8, should validate better, but good enough for now.
224 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
226 # TODO: validate those with a Ecto scheme
229 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
230 when objtype in ["Article", "Note", "Video", "Page"] do
231 actor = Containment.get_actor(data)
234 Map.put(data, "actor", actor)
237 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
238 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
239 object = fix_object(data["object"])
245 context: object["conversation"],
247 published: data["published"],
255 ActivityPub.create(params)
257 %Activity{} = activity -> {:ok, activity}
263 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
265 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
266 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
267 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
268 if not User.locked?(followed) do
269 ActivityPub.accept(%{
270 to: [follower.ap_id],
271 actor: followed.ap_id,
276 User.follow(follower, followed)
285 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
286 with true <- id =~ "follows",
287 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
288 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
295 defp mastodon_follow_hack(_), do: {:error, nil}
297 defp get_follow_activity(follow_object, followed) do
298 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
299 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
302 # Can't find the activity. This might a Mastodon 2.3 "Accept"
304 mastodon_follow_hack(follow_object, followed)
312 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
314 with actor <- Containment.get_actor(data),
315 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
316 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
317 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
318 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
320 ActivityPub.accept(%{
321 to: follow_activity.data["to"],
323 actor: followed.ap_id,
324 object: follow_activity.data["id"],
327 if not User.following?(follower, followed) do
328 {:ok, follower} = User.follow(follower, followed)
338 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
340 with actor <- Containment.get_actor(data),
341 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
342 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
343 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
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 actor <- Containment.get_actor(data),
365 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
366 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(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 actor <- Containment.get_actor(data),
378 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
379 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(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, %{"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"] || [],
421 # TODO: We presently assume that any actor on the same origin domain as the object being
422 # deleted has the rights to delete that object. A better way to validate whether or not
423 # the object should be deleted is to refetch the object URI, which should return either
424 # an error or a tombstone. This would allow us to verify that a deletion actually took
427 %{"type" => "Delete", "object" => object_id, "actor" => _actor, "id" => _id} = data
429 object_id = Utils.get_ap_id(object_id)
431 with actor <- Containment.get_actor(data),
432 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
433 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
434 :ok <- Containment.contain_origin(actor.ap_id, object.data),
435 {:ok, activity} <- ActivityPub.delete(object, false) do
445 "object" => %{"type" => "Announce", "object" => object_id},
450 with actor <- Containment.get_actor(data),
451 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
452 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
453 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
463 "object" => %{"type" => "Follow", "object" => followed},
468 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
469 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
470 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
471 User.unfollow(follower, followed)
481 "object" => %{"type" => "Block", "object" => blocked},
486 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
487 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
488 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
489 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
490 User.unblock(blocker, blocked)
498 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
500 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
501 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
502 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
503 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
504 User.unfollow(blocker, blocked)
505 User.block(blocker, blocked)
515 "object" => %{"type" => "Like", "object" => object_id},
520 with actor <- Containment.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.unlike(actor, object, id, false) do
530 def handle_incoming(_), do: :error
532 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
533 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
535 def get_obj_helper(id) do
536 if object = Object.normalize(id), do: {:ok, object}, else: nil
539 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
540 with false <- String.starts_with?(inReplyTo, "http"),
541 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
542 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
548 def set_reply_to_uri(obj), do: obj
550 # Prepares the object of an outgoing create activity.
551 def prepare_object(object) do
558 |> prepare_attachments
561 |> strip_internal_fields
562 |> strip_internal_tags
567 # internal -> Mastodon
570 def prepare_outgoing(%{"type" => "Create", "object" => object_id} = data) do
572 Object.normalize(object_id).data
577 |> Map.put("object", object)
578 |> Map.merge(Utils.make_json_ld_header())
583 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
584 # because of course it does.
585 def prepare_outgoing(%{"type" => "Accept"} = data) do
586 with follow_activity <- Activity.normalize(data["object"]) do
588 "actor" => follow_activity.actor,
589 "object" => follow_activity.data["object"],
590 "id" => follow_activity.data["id"],
596 |> Map.put("object", object)
597 |> Map.merge(Utils.make_json_ld_header())
603 def prepare_outgoing(%{"type" => "Reject"} = data) do
604 with follow_activity <- Activity.normalize(data["object"]) do
606 "actor" => follow_activity.actor,
607 "object" => follow_activity.data["object"],
608 "id" => follow_activity.data["id"],
614 |> Map.put("object", object)
615 |> Map.merge(Utils.make_json_ld_header())
621 def prepare_outgoing(%{"type" => _type} = data) do
624 |> maybe_fix_object_url
625 |> Map.merge(Utils.make_json_ld_header())
630 def maybe_fix_object_url(data) do
631 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
632 case fetch_obj_helper(data["object"]) do
633 {:ok, relative_object} ->
634 if relative_object.data["external_url"] do
637 |> Map.put("object", relative_object.data["external_url"])
643 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
651 def add_hashtags(object) do
653 (object["tag"] || [])
654 |> Enum.map(fn tag ->
656 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
663 |> Map.put("tag", tags)
666 def add_mention_tags(object) do
669 |> Utils.get_notified_from_object()
670 |> Enum.map(fn user ->
671 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
674 tags = object["tag"] || []
677 |> Map.put("tag", tags ++ mentions)
680 # TODO: we should probably send mtime instead of unix epoch time for updated
681 def add_emoji_tags(object) do
682 tags = object["tag"] || []
683 emoji = object["emoji"] || []
687 |> Enum.map(fn {name, url} ->
689 "icon" => %{"url" => url, "type" => "Image"},
690 "name" => ":" <> name <> ":",
692 "updated" => "1970-01-01T00:00:00Z",
698 |> Map.put("tag", tags ++ out)
701 def set_conversation(object) do
702 Map.put(object, "conversation", object["context"])
705 def set_sensitive(object) do
706 tags = object["tag"] || []
707 Map.put(object, "sensitive", "nsfw" in tags)
710 def add_attributed_to(object) do
711 attributedTo = object["attributedTo"] || object["actor"]
714 |> Map.put("attributedTo", attributedTo)
717 def prepare_attachments(object) do
719 (object["attachment"] || [])
720 |> Enum.map(fn data ->
721 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
722 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
726 |> Map.put("attachment", attachments)
729 defp strip_internal_fields(object) do
735 "announcement_count",
741 defp strip_internal_tags(%{"tag" => tags} = object) do
744 |> Enum.filter(fn x -> is_map(x) end)
747 |> Map.put("tag", tags)
750 defp strip_internal_tags(object), do: object
752 defp user_upgrade_task(user) do
753 old_follower_address = User.ap_followers(user)
758 where: ^old_follower_address in u.following,
763 "array_replace(?,?,?)",
765 ^old_follower_address,
766 ^user.follower_address
772 Repo.update_all(q, [])
774 maybe_retire_websub(user.ap_id)
776 # Only do this for recent activties, don't go through the whole db.
777 # Only look at the last 1000 activities.
778 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
783 where: ^old_follower_address in a.recipients,
784 where: a.id > ^since,
789 "array_replace(?,?,?)",
791 ^old_follower_address,
792 ^user.follower_address
798 Repo.update_all(q, [])
801 def upgrade_user_from_ap_id(ap_id, async \\ true) do
802 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
803 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
804 already_ap = User.ap_enabled?(user)
807 User.upgrade_changeset(user, data)
811 # This could potentially take a long time, do it in the background
814 user_upgrade_task(user)
817 user_upgrade_task(user)
827 def maybe_retire_websub(ap_id) do
829 if is_binary(ap_id) && String.length(ap_id) > 8 do
832 ws in Pleroma.Web.Websub.WebsubClientSubscription,
833 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
840 def maybe_fix_user_url(data) do
841 if is_map(data["url"]) do
842 Map.put(data, "url", data["url"]["href"])
848 def maybe_fix_user_object(data) do
850 |> maybe_fix_user_url