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 fetch_obj_helper(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 \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
134 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{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
162 Map.put(object, "attachment", [attachment])
166 def fix_attachments(object), do: object
168 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
169 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
173 |> Enum.reduce(%{}, fn data, mapping ->
174 name = String.trim(data["name"], ":")
176 mapping |> Map.put(name, data["icon"]["url"])
179 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
180 emoji = Map.merge(object["emoji"] || %{}, emoji)
183 |> Map.put("emoji", emoji)
186 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
187 name = String.trim(tag["name"], ":")
188 emoji = %{name => tag["icon"]["url"]}
191 |> Map.put("emoji", emoji)
194 def fix_emoji(object), do: object
196 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
199 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
200 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
202 combined = tag ++ tags
205 |> Map.put("tag", combined)
208 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
209 combined = [tag, String.slice(hashtag, 1..-1)]
212 |> Map.put("tag", combined)
215 def fix_tag(object), do: object
217 # content map usually only has one language so this will do for now.
218 def fix_content_map(%{"contentMap" => content_map} = object) do
219 content_groups = Map.to_list(content_map)
220 {_, content} = Enum.at(content_groups, 0)
223 |> Map.put("content", content)
226 def fix_content_map(object), do: object
228 # disallow objects with bogus IDs
229 def handle_incoming(%{"id" => nil}), do: :error
230 def handle_incoming(%{"id" => ""}), do: :error
231 # length of https:// = 8, should validate better, but good enough for now.
232 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
234 # TODO: validate those with a Ecto scheme
237 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
238 when objtype in ["Article", "Note", "Video"] do
239 actor = get_actor(data)
242 Map.put(data, "actor", actor)
245 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
246 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
247 object = fix_object(data["object"])
253 context: object["conversation"],
255 published: data["published"],
263 ActivityPub.create(params)
265 %Activity{} = activity -> {:ok, activity}
271 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
273 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
274 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
275 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
276 if not User.locked?(followed) do
277 ActivityPub.accept(%{
278 to: [follower.ap_id],
279 actor: followed.ap_id,
284 User.follow(follower, followed)
293 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
294 with true <- id =~ "follows",
295 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
296 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
303 defp mastodon_follow_hack(_), do: {:error, nil}
305 defp get_follow_activity(follow_object, followed) do
306 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
307 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
310 # Can't find the activity. This might a Mastodon 2.3 "Accept"
312 mastodon_follow_hack(follow_object, followed)
320 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
322 with actor <- get_actor(data),
323 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
324 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
325 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
327 ActivityPub.accept(%{
328 to: follow_activity.data["to"],
330 actor: followed.ap_id,
331 object: follow_activity.data["id"],
334 if not User.following?(follower, followed) do
335 {:ok, follower} = User.follow(follower, followed)
345 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
347 with actor <- get_actor(data),
348 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
349 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
350 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
352 ActivityPub.accept(%{
353 to: follow_activity.data["to"],
355 actor: followed.ap_id,
356 object: follow_activity.data["id"],
359 User.unfollow(follower, followed)
368 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = data
370 with actor <- get_actor(data),
371 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
372 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
373 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
381 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = data
383 with actor <- get_actor(data),
384 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
385 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
386 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
394 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
397 when object_type in ["Person", "Application", "Service", "Organization"] do
398 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
399 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
401 banner = new_user_data[:info]["banner"]
402 locked = new_user_data[:info]["locked"] || false
406 |> Map.take([:name, :bio, :avatar])
407 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
410 |> User.upgrade_changeset(update_data)
411 |> User.update_and_set_cache()
413 ActivityPub.update(%{
415 to: data["to"] || [],
416 cc: data["cc"] || [],
429 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = data
431 object_id = Utils.get_ap_id(object_id)
433 with actor <- get_actor(data),
434 %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
435 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
436 {:ok, activity} <- ActivityPub.delete(object, false) do
446 "object" => %{"type" => "Announce", "object" => object_id},
451 with actor <- get_actor(data),
452 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
453 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
454 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
464 "object" => %{"type" => "Follow", "object" => followed},
469 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
470 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
471 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
472 User.unfollow(follower, followed)
479 @ap_config Application.get_env(:pleroma, :activitypub)
480 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
485 "object" => %{"type" => "Block", "object" => blocked},
490 with true <- @accept_blocks,
491 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
492 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
493 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
494 User.unblock(blocker, blocked)
502 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
504 with true <- @accept_blocks,
505 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
506 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
507 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
508 User.unfollow(blocker, blocked)
509 User.block(blocker, blocked)
519 "object" => %{"type" => "Like", "object" => object_id},
524 with actor <- get_actor(data),
525 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
526 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
527 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
534 def handle_incoming(_), do: :error
536 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
537 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
539 def get_obj_helper(id) do
540 if object = Object.normalize(id), do: {:ok, object}, else: nil
543 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
544 with false <- String.starts_with?(inReplyTo, "http"),
545 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
546 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
552 def set_reply_to_uri(obj), do: obj
554 # Prepares the object of an outgoing create activity.
555 def prepare_object(object) do
562 |> prepare_attachments
569 # internal -> Mastodon
572 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
579 |> Map.put("object", object)
580 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
585 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
586 # because of course it does.
587 def prepare_outgoing(%{"type" => "Accept"} = data) do
588 with follow_activity <- Activity.normalize(data["object"]) do
590 "actor" => follow_activity.actor,
591 "object" => follow_activity.data["object"],
592 "id" => follow_activity.data["id"],
598 |> Map.put("object", object)
599 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
605 def prepare_outgoing(%{"type" => "Reject"} = data) do
606 with follow_activity <- Activity.normalize(data["object"]) do
608 "actor" => follow_activity.actor,
609 "object" => follow_activity.data["object"],
610 "id" => follow_activity.data["id"],
616 |> Map.put("object", object)
617 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
623 def prepare_outgoing(%{"type" => _type} = data) do
626 |> maybe_fix_object_url
627 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
632 def maybe_fix_object_url(data) do
633 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
634 case fetch_obj_helper(data["object"]) do
635 {:ok, relative_object} ->
636 if relative_object.data["external_url"] do
639 |> Map.put("object", relative_object.data["external_url"])
645 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
653 def add_hashtags(object) do
655 (object["tag"] || [])
656 |> Enum.map(fn tag ->
658 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
665 |> Map.put("tag", tags)
668 def add_mention_tags(object) do
669 recipients = object["to"] ++ (object["cc"] || [])
673 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
675 |> Enum.map(fn user ->
676 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
679 tags = object["tag"] || []
682 |> Map.put("tag", tags ++ mentions)
685 # TODO: we should probably send mtime instead of unix epoch time for updated
686 def add_emoji_tags(object) do
687 tags = object["tag"] || []
688 emoji = object["emoji"] || []
692 |> Enum.map(fn {name, url} ->
694 "icon" => %{"url" => url, "type" => "Image"},
695 "name" => ":" <> name <> ":",
697 "updated" => "1970-01-01T00:00:00Z",
703 |> Map.put("tag", tags ++ out)
706 def set_conversation(object) do
707 Map.put(object, "conversation", object["context"])
710 def set_sensitive(object) do
711 tags = object["tag"] || []
712 Map.put(object, "sensitive", "nsfw" in tags)
715 def add_attributed_to(object) do
716 attributedTo = object["attributedTo"] || object["actor"]
719 |> Map.put("attributedTo", attributedTo)
722 def prepare_attachments(object) do
724 (object["attachment"] || [])
725 |> Enum.map(fn data ->
726 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
727 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
731 |> Map.put("attachment", attachments)
734 defp user_upgrade_task(user) do
735 old_follower_address = User.ap_followers(user)
740 where: ^old_follower_address in u.following,
745 "array_replace(?,?,?)",
747 ^old_follower_address,
748 ^user.follower_address
754 Repo.update_all(q, [])
756 maybe_retire_websub(user.ap_id)
758 # Only do this for recent activties, don't go through the whole db.
759 # Only look at the last 1000 activities.
760 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
765 where: ^old_follower_address in a.recipients,
766 where: a.id > ^since,
771 "array_replace(?,?,?)",
773 ^old_follower_address,
774 ^user.follower_address
780 Repo.update_all(q, [])
783 def upgrade_user_from_ap_id(ap_id, async \\ true) do
784 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
785 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
788 |> Map.put(:info, Map.merge(user.info, data[:info]))
790 already_ap = User.ap_enabled?(user)
793 User.upgrade_changeset(user, data)
797 # This could potentially take a long time, do it in the background
800 user_upgrade_task(user)
803 user_upgrade_task(user)
813 def maybe_retire_websub(ap_id) do
815 if is_binary(ap_id) && String.length(ap_id) > 8 do
818 ws in Pleroma.Web.Websub.WebsubClientSubscription,
819 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
826 def maybe_fix_user_url(data) do
827 if is_map(data["url"]) do
828 Map.put(data, "url", data["url"]["href"])
834 def maybe_fix_user_object(data) do
836 |> maybe_fix_user_url