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
69 def fix_addressing_list(map, field) do
70 if is_binary(map[field]) do
72 |> Map.put(field, [map[field]])
78 def fix_addressing(map) do
80 |> fix_addressing_list("to")
81 |> fix_addressing_list("cc")
82 |> fix_addressing_list("bto")
83 |> fix_addressing_list("bcc")
86 def fix_actor(%{"attributedTo" => actor} = object) do
88 |> Map.put("actor", get_actor(%{"actor" => actor}))
91 def fix_likes(%{"likes" => likes} = object)
92 when is_bitstring(likes) do
93 # Check for standardisation
94 # This is what Peertube does
95 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
97 |> Map.put("likes", [])
98 |> Map.put("like_count", 0)
101 def fix_likes(object) do
105 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
106 when not is_nil(in_reply_to) do
109 is_bitstring(in_reply_to) ->
112 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
115 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
116 Enum.at(in_reply_to, 0)
118 # Maybe I should output an error too?
123 case fetch_obj_helper(in_reply_to_id) do
124 {:ok, replied_object} ->
125 with %Activity{} = activity <-
126 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
128 |> Map.put("inReplyTo", replied_object.data["id"])
129 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
130 |> Map.put("inReplyToStatusId", activity.id)
131 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
132 |> Map.put("context", replied_object.data["context"] || object["conversation"])
135 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
140 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
145 def fix_in_reply_to(object), do: object
147 def fix_context(object) do
148 context = object["context"] || object["conversation"] || Utils.generate_context_id()
151 |> Map.put("context", context)
152 |> Map.put("conversation", context)
155 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
158 |> Enum.map(fn data ->
159 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
160 Map.put(data, "url", url)
164 |> Map.put("attachment", attachments)
167 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
168 Map.put(object, "attachment", [attachment])
172 def fix_attachments(object), do: object
174 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
175 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
179 |> Enum.reduce(%{}, fn data, mapping ->
180 name = String.trim(data["name"], ":")
182 mapping |> Map.put(name, data["icon"]["url"])
185 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
186 emoji = Map.merge(object["emoji"] || %{}, emoji)
189 |> Map.put("emoji", emoji)
192 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
193 name = String.trim(tag["name"], ":")
194 emoji = %{name => tag["icon"]["url"]}
197 |> Map.put("emoji", emoji)
200 def fix_emoji(object), do: object
202 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
205 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
206 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
208 combined = tag ++ tags
211 |> Map.put("tag", combined)
214 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
215 combined = [tag, String.slice(hashtag, 1..-1)]
218 |> Map.put("tag", combined)
221 def fix_tag(object), do: object
223 # content map usually only has one language so this will do for now.
224 def fix_content_map(%{"contentMap" => content_map} = object) do
225 content_groups = Map.to_list(content_map)
226 {_, content} = Enum.at(content_groups, 0)
229 |> Map.put("content", content)
232 def fix_content_map(object), do: object
234 # disallow objects with bogus IDs
235 def handle_incoming(%{"id" => nil}), do: :error
236 def handle_incoming(%{"id" => ""}), do: :error
237 # length of https:// = 8, should validate better, but good enough for now.
238 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
240 # TODO: validate those with a Ecto scheme
243 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
244 when objtype in ["Article", "Note", "Video"] do
245 actor = get_actor(data)
248 Map.put(data, "actor", actor)
251 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
252 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
253 object = fix_object(data["object"])
259 context: object["conversation"],
261 published: data["published"],
269 ActivityPub.create(params)
271 %Activity{} = activity -> {:ok, activity}
277 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
279 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
280 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
281 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
282 if not User.locked?(followed) do
283 ActivityPub.accept(%{
284 to: [follower.ap_id],
285 actor: followed.ap_id,
290 User.follow(follower, followed)
299 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
300 with true <- id =~ "follows",
301 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
302 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
309 defp mastodon_follow_hack(_), do: {:error, nil}
311 defp get_follow_activity(follow_object, followed) do
312 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
313 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
316 # Can't find the activity. This might a Mastodon 2.3 "Accept"
318 mastodon_follow_hack(follow_object, followed)
326 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
328 with actor <- get_actor(data),
329 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
330 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
331 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
332 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
334 ActivityPub.accept(%{
335 to: follow_activity.data["to"],
337 actor: followed.ap_id,
338 object: follow_activity.data["id"],
341 if not User.following?(follower, followed) do
342 {:ok, follower} = User.follow(follower, followed)
352 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
354 with actor <- get_actor(data),
355 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
356 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
357 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
358 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
360 ActivityPub.accept(%{
361 to: follow_activity.data["to"],
363 actor: followed.ap_id,
364 object: follow_activity.data["id"],
367 User.unfollow(follower, followed)
376 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = data
378 with actor <- get_actor(data),
379 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
380 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
381 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
389 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = data
391 with actor <- get_actor(data),
392 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
393 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
394 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
402 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
405 when object_type in ["Person", "Application", "Service", "Organization"] do
406 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
407 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
409 banner = new_user_data[:info]["banner"]
410 locked = new_user_data[:info]["locked"] || false
414 |> Map.take([:name, :bio, :avatar])
415 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
418 |> User.upgrade_changeset(update_data)
419 |> User.update_and_set_cache()
421 ActivityPub.update(%{
423 to: data["to"] || [],
424 cc: data["cc"] || [],
437 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = data
439 object_id = Utils.get_ap_id(object_id)
441 with actor <- get_actor(data),
442 %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
443 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
444 {:ok, activity} <- ActivityPub.delete(object, false) do
454 "object" => %{"type" => "Announce", "object" => object_id},
459 with actor <- get_actor(data),
460 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
461 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
462 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
472 "object" => %{"type" => "Follow", "object" => followed},
477 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
478 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
479 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
480 User.unfollow(follower, followed)
487 @ap_config Application.get_env(:pleroma, :activitypub)
488 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
493 "object" => %{"type" => "Block", "object" => blocked},
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.unblock(blocker, blocked, id, false) do
502 User.unblock(blocker, blocked)
510 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
512 with true <- @accept_blocks,
513 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
514 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
515 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
516 User.unfollow(blocker, blocked)
517 User.block(blocker, blocked)
527 "object" => %{"type" => "Like", "object" => object_id},
532 with actor <- get_actor(data),
533 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
534 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
535 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
542 def handle_incoming(_), do: :error
544 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
545 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
547 def get_obj_helper(id) do
548 if object = Object.normalize(id), do: {:ok, object}, else: nil
551 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
552 with false <- String.starts_with?(inReplyTo, "http"),
553 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
554 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
560 def set_reply_to_uri(obj), do: obj
562 # Prepares the object of an outgoing create activity.
563 def prepare_object(object) do
570 |> prepare_attachments
577 # internal -> Mastodon
580 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
587 |> Map.put("object", object)
588 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
593 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
594 # because of course it does.
595 def prepare_outgoing(%{"type" => "Accept"} = data) do
596 with follow_activity <- Activity.normalize(data["object"]) do
598 "actor" => follow_activity.actor,
599 "object" => follow_activity.data["object"],
600 "id" => follow_activity.data["id"],
606 |> Map.put("object", object)
607 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
613 def prepare_outgoing(%{"type" => "Reject"} = data) do
614 with follow_activity <- Activity.normalize(data["object"]) do
616 "actor" => follow_activity.actor,
617 "object" => follow_activity.data["object"],
618 "id" => follow_activity.data["id"],
624 |> Map.put("object", object)
625 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
631 def prepare_outgoing(%{"type" => _type} = data) do
634 |> maybe_fix_object_url
635 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
640 def maybe_fix_object_url(data) do
641 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
642 case fetch_obj_helper(data["object"]) do
643 {:ok, relative_object} ->
644 if relative_object.data["external_url"] do
647 |> Map.put("object", relative_object.data["external_url"])
653 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
661 def add_hashtags(object) do
663 (object["tag"] || [])
664 |> Enum.map(fn tag ->
666 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
673 |> Map.put("tag", tags)
676 def add_mention_tags(object) do
677 recipients = object["to"] ++ (object["cc"] || [])
681 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
683 |> Enum.map(fn user ->
684 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
687 tags = object["tag"] || []
690 |> Map.put("tag", tags ++ mentions)
693 # TODO: we should probably send mtime instead of unix epoch time for updated
694 def add_emoji_tags(object) do
695 tags = object["tag"] || []
696 emoji = object["emoji"] || []
700 |> Enum.map(fn {name, url} ->
702 "icon" => %{"url" => url, "type" => "Image"},
703 "name" => ":" <> name <> ":",
705 "updated" => "1970-01-01T00:00:00Z",
711 |> Map.put("tag", tags ++ out)
714 def set_conversation(object) do
715 Map.put(object, "conversation", object["context"])
718 def set_sensitive(object) do
719 tags = object["tag"] || []
720 Map.put(object, "sensitive", "nsfw" in tags)
723 def add_attributed_to(object) do
724 attributedTo = object["attributedTo"] || object["actor"]
727 |> Map.put("attributedTo", attributedTo)
730 def prepare_attachments(object) do
732 (object["attachment"] || [])
733 |> Enum.map(fn data ->
734 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
735 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
739 |> Map.put("attachment", attachments)
742 defp user_upgrade_task(user) do
743 old_follower_address = User.ap_followers(user)
748 where: ^old_follower_address in u.following,
753 "array_replace(?,?,?)",
755 ^old_follower_address,
756 ^user.follower_address
762 Repo.update_all(q, [])
764 maybe_retire_websub(user.ap_id)
766 # Only do this for recent activties, don't go through the whole db.
767 # Only look at the last 1000 activities.
768 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
773 where: ^old_follower_address in a.recipients,
774 where: a.id > ^since,
779 "array_replace(?,?,?)",
781 ^old_follower_address,
782 ^user.follower_address
788 Repo.update_all(q, [])
791 def upgrade_user_from_ap_id(ap_id, async \\ true) do
792 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
793 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
796 |> Map.put(:info, Map.merge(user.info, data[:info]))
798 already_ap = User.ap_enabled?(user)
801 User.upgrade_changeset(user, data)
805 # This could potentially take a long time, do it in the background
808 user_upgrade_task(user)
811 user_upgrade_task(user)
821 def maybe_retire_websub(ap_id) do
823 if is_binary(ap_id) && String.length(ap_id) > 8 do
826 ws in Pleroma.Web.Websub.WebsubClientSubscription,
827 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
834 def maybe_fix_user_url(data) do
835 if is_map(data["url"]) do
836 Map.put(data, "url", data["url"]["href"])
842 def maybe_fix_user_object(data) do
844 |> maybe_fix_user_url