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 == "Person" end)
29 def get_actor(%{"actor" => actor}) when is_map(actor) do
34 Modifies an incoming AP object (mastodon format) to our internal format.
36 def fix_object(object) do
49 def fix_addressing_list(map, field) do
50 if is_binary(map[field]) do
52 |> Map.put(field, [map[field]])
58 def fix_addressing(map) do
60 |> fix_addressing_list("to")
61 |> fix_addressing_list("cc")
62 |> fix_addressing_list("bto")
63 |> fix_addressing_list("bcc")
66 def fix_actor(%{"attributedTo" => actor} = object) do
68 |> Map.put("actor", get_actor(%{"actor" => actor}))
71 def fix_likes(%{"likes" => likes} = object)
72 when is_bitstring(likes) do
73 # Check for standardisation
74 # This is what Peertube does
75 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
77 |> Map.put("likes", [])
78 |> Map.put("like_count", 0)
81 def fix_likes(object) do
85 def fix_in_reply_to(%{"inReplyTo" => in_reply_to_id} = object)
86 when not is_nil(in_reply_to_id) do
87 case ActivityPub.fetch_object_from_id(in_reply_to_id) do
88 {:ok, replied_object} ->
89 with %Activity{} = activity <-
90 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
92 |> Map.put("inReplyTo", replied_object.data["id"])
93 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
94 |> Map.put("inReplyToStatusId", activity.id)
95 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
96 |> Map.put("context", replied_object.data["context"] || object["conversation"])
99 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
104 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
109 def fix_in_reply_to(object), do: object
111 def fix_context(object) do
112 context = object["context"] || object["conversation"] || Utils.generate_context_id()
115 |> Map.put("context", context)
116 |> Map.put("conversation", context)
119 def fix_attachments(object) do
121 (object["attachment"] || [])
122 |> Enum.map(fn data ->
123 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
124 Map.put(data, "url", url)
128 |> Map.put("attachment", attachments)
131 def fix_emoji(object) do
132 tags = object["tag"] || []
133 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
137 |> Enum.reduce(%{}, fn data, mapping ->
141 if String.starts_with?(name, ":") do
142 name |> String.slice(1..-2)
147 mapping |> Map.put(name, data["icon"]["url"])
150 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
151 emoji = Map.merge(object["emoji"] || %{}, emoji)
154 |> Map.put("emoji", emoji)
157 def fix_tag(object) do
159 (object["tag"] || [])
160 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
161 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
163 combined = (object["tag"] || []) ++ tags
166 |> Map.put("tag", combined)
169 # content map usually only has one language so this will do for now.
170 def fix_content_map(%{"contentMap" => content_map} = object) do
171 content_groups = Map.to_list(content_map)
172 {_, content} = Enum.at(content_groups, 0)
175 |> Map.put("content", content)
178 def fix_content_map(object), do: object
180 # TODO: validate those with a Ecto scheme
183 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
184 when objtype in ["Article", "Note", "Video"] do
185 actor = get_actor(data)
188 Map.put(data, "actor", actor)
191 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
192 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
193 object = fix_object(data["object"])
199 context: object["conversation"],
201 published: data["published"],
209 ActivityPub.create(params)
211 %Activity{} = activity -> {:ok, activity}
217 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
219 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
220 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
221 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
222 if not User.locked?(followed) do
223 ActivityPub.accept(%{
224 to: [follower.ap_id],
225 actor: followed.ap_id,
230 User.follow(follower, followed)
239 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
240 with true <- id =~ "follows",
241 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
242 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
249 defp mastodon_follow_hack(_), do: {:error, nil}
251 defp get_follow_activity(follow_object, followed) do
252 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
253 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
256 # Can't find the activity. This might a Mastodon 2.3 "Accept"
258 mastodon_follow_hack(follow_object, followed)
266 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
268 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
269 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
270 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
272 ActivityPub.accept(%{
273 to: follow_activity.data["to"],
275 actor: followed.ap_id,
276 object: follow_activity.data["id"],
279 if not User.following?(follower, followed) do
280 {:ok, follower} = User.follow(follower, followed)
290 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
292 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
293 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
294 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
296 ActivityPub.accept(%{
297 to: follow_activity.data["to"],
299 actor: followed.ap_id,
300 object: follow_activity.data["id"],
303 User.unfollow(follower, followed)
312 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
314 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
316 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
317 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
325 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
327 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
329 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
330 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
338 %{"type" => "Update", "object" => %{"type" => "Person"} = object, "actor" => actor_id} =
341 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
342 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
344 banner = new_user_data[:info]["banner"]
345 locked = new_user_data[:info]["locked"] || false
349 |> Map.take([:name, :bio, :avatar])
350 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
353 |> User.upgrade_changeset(update_data)
354 |> User.update_and_set_cache()
356 ActivityPub.update(%{
358 to: data["to"] || [],
359 cc: data["cc"] || [],
372 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
374 object_id = Utils.get_ap_id(object_id)
376 with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
378 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
379 {:ok, activity} <- ActivityPub.delete(object, false) do
389 "object" => %{"type" => "Announce", "object" => object_id},
394 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
396 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
397 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
407 "object" => %{"type" => "Follow", "object" => followed},
412 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
413 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
414 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
415 User.unfollow(follower, followed)
422 @ap_config Application.get_env(:pleroma, :activitypub)
423 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
428 "object" => %{"type" => "Block", "object" => blocked},
433 with true <- @accept_blocks,
434 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
435 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
436 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
437 User.unblock(blocker, blocked)
445 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
447 with true <- @accept_blocks,
448 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
449 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
450 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
451 User.unfollow(blocker, blocked)
452 User.block(blocker, blocked)
462 "object" => %{"type" => "Like", "object" => object_id},
467 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
469 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
470 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
477 def handle_incoming(_), do: :error
479 def get_obj_helper(id) do
480 if object = Object.normalize(id), do: {:ok, object}, else: nil
483 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
484 with false <- String.starts_with?(inReplyTo, "http"),
485 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
486 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
492 def set_reply_to_uri(obj), do: obj
494 # Prepares the object of an outgoing create activity.
495 def prepare_object(object) do
502 |> prepare_attachments
509 # internal -> Mastodon
512 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
519 |> Map.put("object", object)
520 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
525 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
526 # because of course it does.
527 def prepare_outgoing(%{"type" => "Accept"} = data) do
528 with follow_activity <- Activity.normalize(data["object"]) do
530 "actor" => follow_activity.actor,
531 "object" => follow_activity.data["object"],
532 "id" => follow_activity.data["id"],
538 |> Map.put("object", object)
539 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
545 def prepare_outgoing(%{"type" => "Reject"} = data) do
546 with follow_activity <- Activity.normalize(data["object"]) do
548 "actor" => follow_activity.actor,
549 "object" => follow_activity.data["object"],
550 "id" => follow_activity.data["id"],
556 |> Map.put("object", object)
557 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
563 def prepare_outgoing(%{"type" => _type} = data) do
566 |> maybe_fix_object_url
567 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
572 def maybe_fix_object_url(data) do
573 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
574 case ActivityPub.fetch_object_from_id(data["object"]) do
575 {:ok, relative_object} ->
576 if relative_object.data["external_url"] do
579 |> Map.put("object", relative_object.data["external_url"])
585 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
593 def add_hashtags(object) do
595 (object["tag"] || [])
596 |> Enum.map(fn tag ->
598 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
605 |> Map.put("tag", tags)
608 def add_mention_tags(object) do
609 recipients = object["to"] ++ (object["cc"] || [])
613 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
615 |> Enum.map(fn user ->
616 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
619 tags = object["tag"] || []
622 |> Map.put("tag", tags ++ mentions)
625 # TODO: we should probably send mtime instead of unix epoch time for updated
626 def add_emoji_tags(object) do
627 tags = object["tag"] || []
628 emoji = object["emoji"] || []
632 |> Enum.map(fn {name, url} ->
634 "icon" => %{"url" => url, "type" => "Image"},
635 "name" => ":" <> name <> ":",
637 "updated" => "1970-01-01T00:00:00Z",
643 |> Map.put("tag", tags ++ out)
646 def set_conversation(object) do
647 Map.put(object, "conversation", object["context"])
650 def set_sensitive(object) do
651 tags = object["tag"] || []
652 Map.put(object, "sensitive", "nsfw" in tags)
655 def add_attributed_to(object) do
656 attributedTo = object["attributedTo"] || object["actor"]
659 |> Map.put("attributedTo", attributedTo)
662 def prepare_attachments(object) do
664 (object["attachment"] || [])
665 |> Enum.map(fn data ->
666 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
667 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
671 |> Map.put("attachment", attachments)
674 defp user_upgrade_task(user) do
675 old_follower_address = User.ap_followers(user)
680 where: ^old_follower_address in u.following,
685 "array_replace(?,?,?)",
687 ^old_follower_address,
688 ^user.follower_address
694 Repo.update_all(q, [])
696 maybe_retire_websub(user.ap_id)
698 # Only do this for recent activties, don't go through the whole db.
699 # Only look at the last 1000 activities.
700 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
705 where: ^old_follower_address in a.recipients,
706 where: a.id > ^since,
711 "array_replace(?,?,?)",
713 ^old_follower_address,
714 ^user.follower_address
720 Repo.update_all(q, [])
723 def upgrade_user_from_ap_id(ap_id, async \\ true) do
724 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
725 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
728 |> Map.put(:info, Map.merge(user.info, data[:info]))
730 already_ap = User.ap_enabled?(user)
733 User.upgrade_changeset(user, data)
737 # This could potentially take a long time, do it in the background
740 user_upgrade_task(user)
743 user_upgrade_task(user)
753 def maybe_retire_websub(ap_id) do
755 if is_binary(ap_id) && String.length(ap_id) > 8 do
758 ws in Pleroma.Web.Websub.WebsubClientSubscription,
759 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
766 def maybe_fix_user_url(data) do
767 if is_map(data["url"]) do
768 Map.put(data, "url", data["url"]["href"])
774 def maybe_fix_user_object(data) do
776 |> maybe_fix_user_url