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"] || ""
204 |> Map.put("url", url_string)
207 def fix_url(object), do: object
209 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
210 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
214 |> Enum.reduce(%{}, fn data, mapping ->
215 name = String.trim(data["name"], ":")
217 mapping |> Map.put(name, data["icon"]["url"])
220 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
221 emoji = Map.merge(object["emoji"] || %{}, emoji)
224 |> Map.put("emoji", emoji)
227 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
228 name = String.trim(tag["name"], ":")
229 emoji = %{name => tag["icon"]["url"]}
232 |> Map.put("emoji", emoji)
235 def fix_emoji(object), do: object
237 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
240 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
241 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
243 combined = tag ++ tags
246 |> Map.put("tag", combined)
249 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
250 combined = [tag, String.slice(hashtag, 1..-1)]
253 |> Map.put("tag", combined)
256 def fix_tag(object), do: object
258 # content map usually only has one language so this will do for now.
259 def fix_content_map(%{"contentMap" => content_map} = object) do
260 content_groups = Map.to_list(content_map)
261 {_, content} = Enum.at(content_groups, 0)
264 |> Map.put("content", content)
267 def fix_content_map(object), do: object
269 # disallow objects with bogus IDs
270 def handle_incoming(%{"id" => nil}), do: :error
271 def handle_incoming(%{"id" => ""}), do: :error
272 # length of https:// = 8, should validate better, but good enough for now.
273 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
275 # TODO: validate those with a Ecto scheme
278 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
279 when objtype in ["Article", "Note", "Video", "Page"] do
280 actor = get_actor(data)
283 Map.put(data, "actor", actor)
286 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
287 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
288 object = fix_object(data["object"])
294 context: object["conversation"],
296 published: data["published"],
304 ActivityPub.create(params)
306 %Activity{} = activity -> {:ok, activity}
312 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
314 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
315 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
316 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
317 if not User.locked?(followed) do
318 ActivityPub.accept(%{
319 to: [follower.ap_id],
320 actor: followed.ap_id,
325 User.follow(follower, followed)
334 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
335 with true <- id =~ "follows",
336 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
337 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
344 defp mastodon_follow_hack(_), do: {:error, nil}
346 defp get_follow_activity(follow_object, followed) do
347 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
348 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
351 # Can't find the activity. This might a Mastodon 2.3 "Accept"
353 mastodon_follow_hack(follow_object, followed)
361 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
363 with actor <- get_actor(data),
364 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
365 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
366 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
367 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
369 ActivityPub.accept(%{
370 to: follow_activity.data["to"],
372 actor: followed.ap_id,
373 object: follow_activity.data["id"],
376 if not User.following?(follower, followed) do
377 {:ok, follower} = User.follow(follower, followed)
387 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
389 with actor <- get_actor(data),
390 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
391 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
392 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
393 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
395 ActivityPub.accept(%{
396 to: follow_activity.data["to"],
398 actor: followed.ap_id,
399 object: follow_activity.data["id"],
402 User.unfollow(follower, followed)
411 %{"type" => "Like", "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.like(actor, object, id, false) do
424 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = data
426 with actor <- get_actor(data),
427 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
428 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
429 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
437 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
440 when object_type in ["Person", "Application", "Service", "Organization"] do
441 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
442 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
444 banner = new_user_data[:info]["banner"]
445 locked = new_user_data[:info]["locked"] || false
449 |> Map.take([:name, :bio, :avatar])
450 |> Map.put(:info, %{"banner" => banner, "locked" => locked})
453 |> User.upgrade_changeset(update_data)
454 |> User.update_and_set_cache()
456 ActivityPub.update(%{
458 to: data["to"] || [],
459 cc: data["cc"] || [],
470 # TODO: We presently assume that any actor on the same origin domain as the object being
471 # deleted has the rights to delete that object. A better way to validate whether or not
472 # the object should be deleted is to refetch the object URI, which should return either
473 # an error or a tombstone. This would allow us to verify that a deletion actually took
476 %{"type" => "Delete", "object" => object_id, "actor" => _actor, "id" => _id} = data
478 object_id = Utils.get_ap_id(object_id)
480 with actor <- get_actor(data),
481 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
482 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
483 :ok <- contain_origin(actor.ap_id, object.data),
484 {:ok, activity} <- ActivityPub.delete(object, false) do
494 "object" => %{"type" => "Announce", "object" => object_id},
499 with actor <- get_actor(data),
500 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
501 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
502 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
512 "object" => %{"type" => "Follow", "object" => followed},
517 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
518 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
519 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
520 User.unfollow(follower, followed)
530 "object" => %{"type" => "Block", "object" => blocked},
535 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
536 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
537 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
538 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
539 User.unblock(blocker, blocked)
547 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
549 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
550 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
551 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
552 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
553 User.unfollow(blocker, blocked)
554 User.block(blocker, blocked)
564 "object" => %{"type" => "Like", "object" => object_id},
569 with actor <- get_actor(data),
570 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
571 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
572 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
579 def handle_incoming(_), do: :error
581 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
582 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
584 def get_obj_helper(id) do
585 if object = Object.normalize(id), do: {:ok, object}, else: nil
588 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
589 with false <- String.starts_with?(inReplyTo, "http"),
590 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
591 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
597 def set_reply_to_uri(obj), do: obj
599 # Prepares the object of an outgoing create activity.
600 def prepare_object(object) do
607 |> prepare_attachments
610 |> strip_internal_fields
611 |> strip_internal_tags
616 # internal -> Mastodon
619 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
626 |> Map.put("object", object)
627 |> Map.merge(Utils.make_json_ld_header())
632 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
633 # because of course it does.
634 def prepare_outgoing(%{"type" => "Accept"} = data) do
635 with follow_activity <- Activity.normalize(data["object"]) do
637 "actor" => follow_activity.actor,
638 "object" => follow_activity.data["object"],
639 "id" => follow_activity.data["id"],
645 |> Map.put("object", object)
646 |> Map.merge(Utils.make_json_ld_header())
652 def prepare_outgoing(%{"type" => "Reject"} = data) do
653 with follow_activity <- Activity.normalize(data["object"]) do
655 "actor" => follow_activity.actor,
656 "object" => follow_activity.data["object"],
657 "id" => follow_activity.data["id"],
663 |> Map.put("object", object)
664 |> Map.merge(Utils.make_json_ld_header())
670 def prepare_outgoing(%{"type" => _type} = data) do
673 |> maybe_fix_object_url
674 |> Map.merge(Utils.make_json_ld_header())
679 def maybe_fix_object_url(data) do
680 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
681 case fetch_obj_helper(data["object"]) do
682 {:ok, relative_object} ->
683 if relative_object.data["external_url"] do
686 |> Map.put("object", relative_object.data["external_url"])
692 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
700 def add_hashtags(object) do
702 (object["tag"] || [])
703 |> Enum.map(fn tag ->
705 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
712 |> Map.put("tag", tags)
715 def add_mention_tags(object) do
718 |> Utils.get_notified_from_object()
719 |> Enum.map(fn user ->
720 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
723 tags = object["tag"] || []
726 |> Map.put("tag", tags ++ mentions)
729 # TODO: we should probably send mtime instead of unix epoch time for updated
730 def add_emoji_tags(object) do
731 tags = object["tag"] || []
732 emoji = object["emoji"] || []
736 |> Enum.map(fn {name, url} ->
738 "icon" => %{"url" => url, "type" => "Image"},
739 "name" => ":" <> name <> ":",
741 "updated" => "1970-01-01T00:00:00Z",
747 |> Map.put("tag", tags ++ out)
750 def set_conversation(object) do
751 Map.put(object, "conversation", object["context"])
754 def set_sensitive(object) do
755 tags = object["tag"] || []
756 Map.put(object, "sensitive", "nsfw" in tags)
759 def add_attributed_to(object) do
760 attributedTo = object["attributedTo"] || object["actor"]
763 |> Map.put("attributedTo", attributedTo)
766 def prepare_attachments(object) do
768 (object["attachment"] || [])
769 |> Enum.map(fn data ->
770 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
771 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
775 |> Map.put("attachment", attachments)
778 defp strip_internal_fields(object) do
784 "announcement_count",
790 defp strip_internal_tags(%{"tag" => tags} = object) do
793 |> Enum.filter(fn x -> is_map(x) end)
796 |> Map.put("tag", tags)
799 defp strip_internal_tags(object), do: object
801 defp user_upgrade_task(user) do
802 old_follower_address = User.ap_followers(user)
807 where: ^old_follower_address in u.following,
812 "array_replace(?,?,?)",
814 ^old_follower_address,
815 ^user.follower_address
821 Repo.update_all(q, [])
823 maybe_retire_websub(user.ap_id)
825 # Only do this for recent activties, don't go through the whole db.
826 # Only look at the last 1000 activities.
827 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
832 where: ^old_follower_address in a.recipients,
833 where: a.id > ^since,
838 "array_replace(?,?,?)",
840 ^old_follower_address,
841 ^user.follower_address
847 Repo.update_all(q, [])
850 def upgrade_user_from_ap_id(ap_id, async \\ true) do
851 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
852 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
853 already_ap = User.ap_enabled?(user)
856 User.upgrade_changeset(user, data)
860 # This could potentially take a long time, do it in the background
863 user_upgrade_task(user)
866 user_upgrade_task(user)
876 def maybe_retire_websub(ap_id) do
878 if is_binary(ap_id) && String.length(ap_id) > 8 do
881 ws in Pleroma.Web.Websub.WebsubClientSubscription,
882 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
889 def maybe_fix_user_url(data) do
890 if is_map(data["url"]) do
891 Map.put(data, "url", data["url"]["href"])
897 def maybe_fix_user_object(data) do
899 |> maybe_fix_user_url