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 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_id} = object)
100 when not is_nil(in_reply_to_id) do
101 case ActivityPub.fetch_object_from_id(in_reply_to_id) do
102 {:ok, replied_object} ->
103 with %Activity{} = activity <-
104 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
106 |> Map.put("inReplyTo", replied_object.data["id"])
107 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
108 |> Map.put("inReplyToStatusId", activity.id)
109 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
110 |> Map.put("context", replied_object.data["context"] || object["conversation"])
113 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
118 Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
123 def fix_in_reply_to(object), do: object
125 def fix_context(object) do
126 context = object["context"] || object["conversation"] || Utils.generate_context_id()
129 |> Map.put("context", context)
130 |> Map.put("conversation", context)
133 def fix_attachments(object) do
135 (object["attachment"] || [])
136 |> Enum.map(fn data ->
137 url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
138 Map.put(data, "url", url)
142 |> Map.put("attachment", attachments)
145 def fix_emoji(object) do
146 tags = object["tag"] || []
147 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
151 |> Enum.reduce(%{}, fn data, mapping ->
155 if String.starts_with?(name, ":") do
156 name |> String.slice(1..-2)
161 mapping |> Map.put(name, data["icon"]["url"])
164 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
165 emoji = Map.merge(object["emoji"] || %{}, emoji)
168 |> Map.put("emoji", emoji)
171 def fix_tag(object) do
173 (object["tag"] || [])
174 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
175 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
177 combined = (object["tag"] || []) ++ tags
180 |> Map.put("tag", combined)
183 # content map usually only has one language so this will do for now.
184 def fix_content_map(%{"contentMap" => content_map} = object) do
185 content_groups = Map.to_list(content_map)
186 {_, content} = Enum.at(content_groups, 0)
189 |> Map.put("content", content)
192 def fix_content_map(object), do: object
194 # disallow objects with bogus IDs
195 def handle_incoming(%{"id" => nil}), do: :error
196 def handle_incoming(%{"id" => ""}), do: :error
197 # length of https:// = 8, should validate better, but good enough for now.
198 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
200 # TODO: validate those with a Ecto scheme
203 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
204 when objtype in ["Article", "Note", "Video"] do
205 actor = get_actor(data)
208 Map.put(data, "actor", actor)
211 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
212 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
213 object = fix_object(data["object"])
219 context: object["conversation"],
221 published: data["published"],
229 ActivityPub.create(params)
231 %Activity{} = activity -> {:ok, activity}
237 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
239 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
240 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
241 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
242 if not User.locked?(followed) do
243 ActivityPub.accept(%{
244 to: [follower.ap_id],
245 actor: followed.ap_id,
250 User.follow(follower, followed)
259 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
260 with true <- id =~ "follows",
261 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
262 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
269 defp mastodon_follow_hack(_), do: {:error, nil}
271 defp get_follow_activity(follow_object, followed) do
272 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
273 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
276 # Can't find the activity. This might a Mastodon 2.3 "Accept"
278 mastodon_follow_hack(follow_object, followed)
286 %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
288 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
289 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
290 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
292 ActivityPub.accept(%{
293 to: follow_activity.data["to"],
295 actor: followed.ap_id,
296 object: follow_activity.data["id"],
299 if not User.following?(follower, followed) do
300 {:ok, follower} = User.follow(follower, followed)
310 %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
312 with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
313 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
314 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
316 ActivityPub.accept(%{
317 to: follow_activity.data["to"],
319 actor: followed.ap_id,
320 object: follow_activity.data["id"],
323 User.unfollow(follower, followed)
332 %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
334 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
336 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
337 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
345 %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
347 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
349 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
350 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
358 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
361 when object_type in ["Person", "Application", "Service", "Organization"] do
362 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
363 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
365 banner = new_user_data[:info]["banner"]
366 locked = new_user_data[:info]["locked"] || false
370 |> Map.take([:name, :bio, :avatar])
371 |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
374 |> User.upgrade_changeset(update_data)
375 |> User.update_and_set_cache()
377 ActivityPub.update(%{
379 to: data["to"] || [],
380 cc: data["cc"] || [],
393 %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
395 object_id = Utils.get_ap_id(object_id)
397 with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
399 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
400 {:ok, activity} <- ActivityPub.delete(object, false) do
410 "object" => %{"type" => "Announce", "object" => object_id},
415 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
417 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
418 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
428 "object" => %{"type" => "Follow", "object" => followed},
433 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
434 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
435 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
436 User.unfollow(follower, followed)
443 @ap_config Application.get_env(:pleroma, :activitypub)
444 @accept_blocks Keyword.get(@ap_config, :accept_blocks)
449 "object" => %{"type" => "Block", "object" => blocked},
454 with true <- @accept_blocks,
455 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
456 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
457 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
458 User.unblock(blocker, blocked)
466 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
468 with true <- @accept_blocks,
469 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
470 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
471 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
472 User.unfollow(blocker, blocked)
473 User.block(blocker, blocked)
483 "object" => %{"type" => "Like", "object" => object_id},
488 with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
490 get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
491 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
498 def handle_incoming(_), do: :error
500 def get_obj_helper(id) do
501 if object = Object.normalize(id), do: {:ok, object}, else: nil
504 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
505 with false <- String.starts_with?(inReplyTo, "http"),
506 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
507 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
513 def set_reply_to_uri(obj), do: obj
515 # Prepares the object of an outgoing create activity.
516 def prepare_object(object) do
523 |> prepare_attachments
530 # internal -> Mastodon
533 def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
540 |> Map.put("object", object)
541 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
546 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
547 # because of course it does.
548 def prepare_outgoing(%{"type" => "Accept"} = data) do
549 with follow_activity <- Activity.normalize(data["object"]) do
551 "actor" => follow_activity.actor,
552 "object" => follow_activity.data["object"],
553 "id" => follow_activity.data["id"],
559 |> Map.put("object", object)
560 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
566 def prepare_outgoing(%{"type" => "Reject"} = data) do
567 with follow_activity <- Activity.normalize(data["object"]) do
569 "actor" => follow_activity.actor,
570 "object" => follow_activity.data["object"],
571 "id" => follow_activity.data["id"],
577 |> Map.put("object", object)
578 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
584 def prepare_outgoing(%{"type" => _type} = data) do
587 |> maybe_fix_object_url
588 |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
593 def maybe_fix_object_url(data) do
594 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
595 case ActivityPub.fetch_object_from_id(data["object"]) do
596 {:ok, relative_object} ->
597 if relative_object.data["external_url"] do
600 |> Map.put("object", relative_object.data["external_url"])
606 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
614 def add_hashtags(object) do
616 (object["tag"] || [])
617 |> Enum.map(fn tag ->
619 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
626 |> Map.put("tag", tags)
629 def add_mention_tags(object) do
630 recipients = object["to"] ++ (object["cc"] || [])
634 |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
636 |> Enum.map(fn user ->
637 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
640 tags = object["tag"] || []
643 |> Map.put("tag", tags ++ mentions)
646 # TODO: we should probably send mtime instead of unix epoch time for updated
647 def add_emoji_tags(object) do
648 tags = object["tag"] || []
649 emoji = object["emoji"] || []
653 |> Enum.map(fn {name, url} ->
655 "icon" => %{"url" => url, "type" => "Image"},
656 "name" => ":" <> name <> ":",
658 "updated" => "1970-01-01T00:00:00Z",
664 |> Map.put("tag", tags ++ out)
667 def set_conversation(object) do
668 Map.put(object, "conversation", object["context"])
671 def set_sensitive(object) do
672 tags = object["tag"] || []
673 Map.put(object, "sensitive", "nsfw" in tags)
676 def add_attributed_to(object) do
677 attributedTo = object["attributedTo"] || object["actor"]
680 |> Map.put("attributedTo", attributedTo)
683 def prepare_attachments(object) do
685 (object["attachment"] || [])
686 |> Enum.map(fn data ->
687 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
688 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
692 |> Map.put("attachment", attachments)
695 defp user_upgrade_task(user) do
696 old_follower_address = User.ap_followers(user)
701 where: ^old_follower_address in u.following,
706 "array_replace(?,?,?)",
708 ^old_follower_address,
709 ^user.follower_address
715 Repo.update_all(q, [])
717 maybe_retire_websub(user.ap_id)
719 # Only do this for recent activties, don't go through the whole db.
720 # Only look at the last 1000 activities.
721 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
726 where: ^old_follower_address in a.recipients,
727 where: a.id > ^since,
732 "array_replace(?,?,?)",
734 ^old_follower_address,
735 ^user.follower_address
741 Repo.update_all(q, [])
744 def upgrade_user_from_ap_id(ap_id, async \\ true) do
745 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
746 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
749 |> Map.put(:info, Map.merge(user.info, data[:info]))
751 already_ap = User.ap_enabled?(user)
754 User.upgrade_changeset(user, data)
758 # This could potentially take a long time, do it in the background
761 user_upgrade_task(user)
764 user_upgrade_task(user)
774 def maybe_retire_websub(ap_id) do
776 if is_binary(ap_id) && String.length(ap_id) > 8 do
779 ws in Pleroma.Web.Websub.WebsubClientSubscription,
780 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
787 def maybe_fix_user_url(data) do
788 if is_map(data["url"]) do
789 Map.put(data, "url", data["url"]["href"])
795 def maybe_fix_user_object(data) do
797 |> maybe_fix_user_url