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
17 Modifies an incoming AP object (mastodon format) to our internal format.
19 def fix_object(object) do
30 def fix_actor(%{"attributedTo" => actor} = object) do
31 # attributedTo can be a list in the case of peertube or plume
40 |> Map.put("actor", actor)
43 def fix_in_reply_to(%{"inReplyTo" => in_reply_to_id} = object)
44 when not is_nil(in_reply_to_id) do
45 case ActivityPub.fetch_object_from_id(in_reply_to_id) do
46 {:ok, replied_object} ->
47 with %Activity{} = activity <-
48 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
50 |> Map.put("inReplyTo", replied_object.data["id"])
51 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
52 |> Map.put("inReplyToStatusId", activity.id)
53 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
54 |> Map.put("context", replied_object.data["context"] || object["conversation"])
57 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
62 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
67 def fix_in_reply_to(object), do: object
69 def fix_context(object) do
71 |> Map.put("context", object["conversation"])
74 def fix_attachments(object) do
76 (object["attachment"] || [])
77 |> Enum.map(fn data ->
78 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
79 Map.put(data, "url", url)
83 |> Map.put("attachment", attachments)
86 def fix_emoji(object) do
87 tags = object["tag"] || []
88 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
92 |> Enum.reduce(%{}, fn data, mapping ->
96 if String.starts_with?(name, ":") do
97 name |> String.slice(1..-2)
102 mapping |> Map.put(name, data["icon"]["url"])
105 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
106 emoji = Map.merge(object["emoji"] || %{}, emoji)
109 |> Map.put("emoji", emoji)
112 def fix_tag(object) do
114 (object["tag"] || [])
115 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
116 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
118 combined = (object["tag"] || []) ++ tags
121 |> Map.put("tag", combined)
124 # content map usually only has one language so this will do for now.
125 def fix_content_map(%{"contentMap" => content_map} = object) do
126 content_groups = Map.to_list(content_map)
127 {_, content} = Enum.at(content_groups, 0)
130 |> Map.put("content", content)
133 def fix_content_map(object), do: object
135 # TODO: validate those with a Ecto scheme
138 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
139 when objtype in ["Article", "Note"] do
140 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
141 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
142 # prefer the activity's actor instead of attributedTo
144 fix_object(data["object"])
145 |> Map.put("actor", data["actor"])
151 context: object["conversation"],
153 published: data["published"],
161 ActivityPub.create(params)
163 %Activity{} = activity -> {:ok, activity}
169 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
171 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
172 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
173 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
174 if not User.locked?(followed) do
175 ActivityPub.accept(%{
176 to: [follower.ap_id],
177 actor: followed.ap_id,
182 User.follow(follower, followed)
191 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
192 with true <- id =~ "follows",
193 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
194 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
201 defp mastodon_follow_hack(_), do: {:error, nil}
203 defp get_follow_activity(follow_object, followed) do
204 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
205 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
208 # Can't find the activity. This might a Mastodon 2.3 "Accept"
210 mastodon_follow_hack(follow_object, followed)
218 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
220 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
221 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
222 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
224 ActivityPub.accept(%{
225 to: follow_activity.data["to"],
227 actor: followed.ap_id,
228 object: follow_activity.data["id"],
231 if not User.following?(follower, followed) do
232 {:ok, follower} = User.follow(follower, followed)
242 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
244 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
245 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
246 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
248 ActivityPub.accept(%{
249 to: follow_activity.data["to"],
251 actor: followed.ap_id,
252 object: follow_activity.data["id"],
255 User.unfollow(follower, followed)
264 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
266 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
268 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
269 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
277 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
279 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
281 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
282 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
290 %{"type" => "Update", "object" => %{"type" => "Person"} = object, "actor" => actor_id} =
293 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
294 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
296 banner = new_user_data[:info]["banner"]
297 locked = new_user_data[:info]["locked"] || false
301 |> Map.take([:name, :bio, :avatar])
302 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
305 |> User.upgrade_changeset(update_data)
306 |> User.update_and_set_cache()
308 ActivityPub.update(%{
310 to: data["to"] || [],
311 cc: data["cc"] || [],
324 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
326 object_id = Utils.get_ap_id(object_id)
328 with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
330 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
331 {:ok, activity} <- ActivityPub.delete(object, false) do
341 "object" => %{"type" => "Announce", "object" => object_id},
346 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
348 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
349 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
359 "object" => %{"type" => "Follow", "object" => followed},
364 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
365 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
366 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
367 User.unfollow(follower, followed)
374 @ap_config Application.get_env(:pleroma, :activitypub)
375 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
380 "object" => %{"type" => "Block", "object" => blocked},
385 with true <- @accept_blocks,
386 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
387 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
388 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
389 User.unblock(blocker, blocked)
397 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
399 with true <- @accept_blocks,
400 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
401 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
402 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
403 User.unfollow(blocker, blocked)
404 User.block(blocker, blocked)
414 "object" => %{"type" => "Like", "object" => object_id},
419 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
421 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
422 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
429 def handle_incoming(_), do: :error
431 def get_obj_helper(id) do
432 if object = Object.normalize(id), do: {:ok, object}, else: nil
435 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
436 with false <- String.starts_with?(inReplyTo, "http"),
437 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
438 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
444 def set_reply_to_uri(obj), do: obj
446 # Prepares the object of an outgoing create activity.
447 def prepare_object(object) do
454 |> prepare_attachments
461 # internal -> Mastodon
464 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
471 |> Map.put("object", object)
472 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
477 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
478 # because of course it does.
479 def prepare_outgoing(%{"type" => "Accept"} = data) do
480 with follow_activity <- Activity.normalize(data["object"]) do
482 "actor" => follow_activity.actor,
483 "object" => follow_activity.data["object"],
484 "id" => follow_activity.data["id"],
490 |> Map.put("object", object)
491 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
497 def prepare_outgoing(%{"type" => "Reject"} = data) do
498 with follow_activity <- Activity.normalize(data["object"]) do
500 "actor" => follow_activity.actor,
501 "object" => follow_activity.data["object"],
502 "id" => follow_activity.data["id"],
508 |> Map.put("object", object)
509 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
515 def prepare_outgoing(%{"type" => _type} = data) do
518 |> maybe_fix_object_url
519 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
524 def maybe_fix_object_url(data) do
525 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
526 case ActivityPub.fetch_object_from_id(data["object"]) do
527 {:ok, relative_object} ->
528 if relative_object.data["external_url"] do
531 |> Map.put("object", relative_object.data["external_url"])
537 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
545 def add_hashtags(object) do
547 (object["tag"] || [])
548 |> Enum.map(fn tag ->
550 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
557 |> Map.put("tag", tags)
560 def add_mention_tags(object) do
561 recipients = object["to"] ++ (object["cc"] || [])
565 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
567 |> Enum.map(fn user ->
568 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
571 tags = object["tag"] || []
574 |> Map.put("tag", tags ++ mentions)
577 # TODO: we should probably send mtime instead of unix epoch time for updated
578 def add_emoji_tags(object) do
579 tags = object["tag"] || []
580 emoji = object["emoji"] || []
584 |> Enum.map(fn {name, url} ->
586 "icon" => %{"url" => url, "type" => "Image"},
587 "name" => ":" <> name <> ":",
589 "updated" => "1970-01-01T00:00:00Z",
595 |> Map.put("tag", tags ++ out)
598 def set_conversation(object) do
599 Map.put(object, "conversation", object["context"])
602 def set_sensitive(object) do
603 tags = object["tag"] || []
604 Map.put(object, "sensitive", "nsfw" in tags)
607 def add_attributed_to(object) do
608 attributedTo = object["attributedTo"] || object["actor"]
611 |> Map.put("attributedTo", attributedTo)
614 def prepare_attachments(object) do
616 (object["attachment"] || [])
617 |> Enum.map(fn data ->
618 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
619 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
623 |> Map.put("attachment", attachments)
626 defp user_upgrade_task(user) do
627 old_follower_address = User.ap_followers(user)
632 where: ^old_follower_address in u.following,
637 "array_replace(?,?,?)",
639 ^old_follower_address,
640 ^user.follower_address
646 Repo.update_all(q, [])
648 maybe_retire_websub(user.ap_id)
650 # Only do this for recent activties, don't go through the whole db.
651 # Only look at the last 1000 activities.
652 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
657 where: ^old_follower_address in a.recipients,
658 where: a.id > ^since,
663 "array_replace(?,?,?)",
665 ^old_follower_address,
666 ^user.follower_address
672 Repo.update_all(q, [])
675 def upgrade_user_from_ap_id(ap_id, async \\ true) do
676 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
677 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
680 |> Map.put(:info, Map.merge(user.info, data[:info]))
682 already_ap = User.ap_enabled?(user)
685 User.upgrade_changeset(user, data)
689 # This could potentially take a long time, do it in the background
692 user_upgrade_task(user)
695 user_upgrade_task(user)
705 def maybe_retire_websub(ap_id) do
707 if is_binary(ap_id) && String.length(ap_id) > 8 do
710 ws in Pleroma.Web.Websub.WebsubClientSubscription,
711 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
718 def maybe_fix_user_url(data) do
719 if is_map(data["url"]) do
720 Map.put(data, "url", data["url"]["href"])
726 def maybe_fix_user_object(data) do
728 |> maybe_fix_user_url