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" => actor} = params) do
41 id_uri = URI.parse(id)
42 actor_uri = URI.parse(get_actor(params))
44 if id_uri.host == actor_uri.host do
52 Modifies an incoming AP object (mastodon format) to our internal format.
54 def fix_object(object) do
67 def fix_addressing_list(map, field) do
68 if is_binary(map[field]) do
70 |> Map.put(field, [map[field]])
76 def fix_addressing(map) do
78 |> fix_addressing_list("to")
79 |> fix_addressing_list("cc")
80 |> fix_addressing_list("bto")
81 |> fix_addressing_list("bcc")
84 def fix_actor(%{"attributedTo" => actor} = object) do
86 |> Map.put("actor", get_actor(%{"actor" => actor}))
89 def fix_likes(%{"likes" => likes} = object)
90 when is_bitstring(likes) do
91 # Check for standardisation
92 # This is what Peertube does
93 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
95 |> Map.put("likes", [])
96 |> Map.put("like_count", 0)
99 def fix_likes(object) do
103 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
104 when not is_nil(in_reply_to) do
107 is_bitstring(in_reply_to) ->
110 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
113 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
114 Enum.at(in_reply_to, 0)
116 # Maybe I should output an error too?
121 case fetch_obj_helper(in_reply_to_id) do
122 {:ok, replied_object} ->
123 with %Activity{} = activity <-
124 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
126 |> Map.put("inReplyTo", replied_object.data["id"])
127 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
128 |> Map.put("inReplyToStatusId", activity.id)
129 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
130 |> Map.put("context", replied_object.data["context"] || object["conversation"])
133 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
138 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
143 def fix_in_reply_to(object), do: object
145 def fix_context(object) do
146 context = object["context"] || object["conversation"] || Utils.generate_context_id()
149 |> Map.put("context", context)
150 |> Map.put("conversation", context)
153 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
156 |> Enum.map(fn data ->
157 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
158 Map.put(data, "url", url)
162 |> Map.put("attachment", attachments)
165 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
166 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 actor <- get_actor(data),
327 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
328 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
329 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
330 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
332 ActivityPub.accept(%{
333 to: follow_activity.data["to"],
335 actor: followed.ap_id,
336 object: follow_activity.data["id"],
339 if not User.following?(follower, followed) do
340 {:ok, follower} = User.follow(follower, followed)
350 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
352 with actor <- get_actor(data),
353 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
354 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
355 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
356 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
358 ActivityPub.accept(%{
359 to: follow_activity.data["to"],
361 actor: followed.ap_id,
362 object: follow_activity.data["id"],
365 User.unfollow(follower, followed)
374 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = data
376 with actor <- get_actor(data),
377 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
378 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
379 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
387 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = data
389 with actor <- get_actor(data),
390 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
391 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
392 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
400 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
403 when object_type in ["Person", "Application", "Service", "Organization"] do
404 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
405 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
407 banner = new_user_data[:info]["banner"]
408 locked = new_user_data[:info]["locked"] || false
412 |> Map.take([:name, :bio, :avatar])
413 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
416 |> User.upgrade_changeset(update_data)
417 |> User.update_and_set_cache()
419 ActivityPub.update(%{
421 to: data["to"] || [],
422 cc: data["cc"] || [],
435 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = data
437 object_id = Utils.get_ap_id(object_id)
439 with actor <- get_actor(data),
440 %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
441 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
442 {:ok, activity} <- ActivityPub.delete(object, false) do
452 "object" => %{"type" => "Announce", "object" => object_id},
457 with actor <- get_actor(data),
458 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
459 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
460 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
470 "object" => %{"type" => "Follow", "object" => followed},
475 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
476 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
477 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
478 User.unfollow(follower, followed)
485 @ap_config Application.get_env(:pleroma, :activitypub)
486 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
491 "object" => %{"type" => "Block", "object" => blocked},
496 with true <- @accept_blocks,
497 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
498 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
499 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
500 User.unblock(blocker, blocked)
508 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
510 with true <- @accept_blocks,
511 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
512 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
513 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
514 User.unfollow(blocker, blocked)
515 User.block(blocker, blocked)
525 "object" => %{"type" => "Like", "object" => object_id},
530 with actor <- get_actor(data),
531 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
532 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
533 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
540 def handle_incoming(_), do: :error
542 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
543 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
545 def get_obj_helper(id) do
546 if object = Object.normalize(id), do: {:ok, object}, else: nil
549 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
550 with false <- String.starts_with?(inReplyTo, "http"),
551 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
552 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
558 def set_reply_to_uri(obj), do: obj
560 # Prepares the object of an outgoing create activity.
561 def prepare_object(object) do
568 |> prepare_attachments
575 # internal -> Mastodon
578 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
585 |> Map.put("object", object)
586 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
591 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
592 # because of course it does.
593 def prepare_outgoing(%{"type" => "Accept"} = data) do
594 with follow_activity <- Activity.normalize(data["object"]) do
596 "actor" => follow_activity.actor,
597 "object" => follow_activity.data["object"],
598 "id" => follow_activity.data["id"],
604 |> Map.put("object", object)
605 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
611 def prepare_outgoing(%{"type" => "Reject"} = data) do
612 with follow_activity <- Activity.normalize(data["object"]) do
614 "actor" => follow_activity.actor,
615 "object" => follow_activity.data["object"],
616 "id" => follow_activity.data["id"],
622 |> Map.put("object", object)
623 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
629 def prepare_outgoing(%{"type" => _type} = data) do
632 |> maybe_fix_object_url
633 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
638 def maybe_fix_object_url(data) do
639 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
640 case fetch_obj_helper(data["object"]) do
641 {:ok, relative_object} ->
642 if relative_object.data["external_url"] do
645 |> Map.put("object", relative_object.data["external_url"])
651 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
659 def add_hashtags(object) do
661 (object["tag"] || [])
662 |> Enum.map(fn tag ->
664 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
671 |> Map.put("tag", tags)
674 def add_mention_tags(object) do
675 recipients = object["to"] ++ (object["cc"] || [])
679 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
681 |> Enum.map(fn user ->
682 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
685 tags = object["tag"] || []
688 |> Map.put("tag", tags ++ mentions)
691 # TODO: we should probably send mtime instead of unix epoch time for updated
692 def add_emoji_tags(object) do
693 tags = object["tag"] || []
694 emoji = object["emoji"] || []
698 |> Enum.map(fn {name, url} ->
700 "icon" => %{"url" => url, "type" => "Image"},
701 "name" => ":" <> name <> ":",
703 "updated" => "1970-01-01T00:00:00Z",
709 |> Map.put("tag", tags ++ out)
712 def set_conversation(object) do
713 Map.put(object, "conversation", object["context"])
716 def set_sensitive(object) do
717 tags = object["tag"] || []
718 Map.put(object, "sensitive", "nsfw" in tags)
721 def add_attributed_to(object) do
722 attributedTo = object["attributedTo"] || object["actor"]
725 |> Map.put("attributedTo", attributedTo)
728 def prepare_attachments(object) do
730 (object["attachment"] || [])
731 |> Enum.map(fn data ->
732 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
733 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
737 |> Map.put("attachment", attachments)
740 defp user_upgrade_task(user) do
741 old_follower_address = User.ap_followers(user)
746 where: ^old_follower_address in u.following,
751 "array_replace(?,?,?)",
753 ^old_follower_address,
754 ^user.follower_address
760 Repo.update_all(q, [])
762 maybe_retire_websub(user.ap_id)
764 # Only do this for recent activties, don't go through the whole db.
765 # Only look at the last 1000 activities.
766 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
771 where: ^old_follower_address in a.recipients,
772 where: a.id > ^since,
777 "array_replace(?,?,?)",
779 ^old_follower_address,
780 ^user.follower_address
786 Repo.update_all(q, [])
789 def upgrade_user_from_ap_id(ap_id, async \\ true) do
790 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
791 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
794 |> Map.put(:info, Map.merge(user.info, data[:info]))
796 already_ap = User.ap_enabled?(user)
799 User.upgrade_changeset(user, data)
803 # This could potentially take a long time, do it in the background
806 user_upgrade_task(user)
809 user_upgrade_task(user)
819 def maybe_retire_websub(ap_id) do
821 if is_binary(ap_id) && String.length(ap_id) > 8 do
824 ws in Pleroma.Web.Websub.WebsubClientSubscription,
825 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
832 def maybe_fix_user_url(data) do
833 if is_map(data["url"]) do
834 Map.put(data, "url", data["url"]["href"])
840 def maybe_fix_user_object(data) do
842 |> maybe_fix_user_url