1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.Web.ActivityPub.Transmogrifier do
7 A module to handle coding from internal to wire ActivityPub and back.
11 alias Pleroma.Activity
13 alias Pleroma.Web.ActivityPub.ActivityPub
14 alias Pleroma.Web.ActivityPub.Utils
20 def get_actor(%{"actor" => actor}) when is_binary(actor) do
24 def get_actor(%{"actor" => actor}) when is_list(actor) do
25 if is_binary(Enum.at(actor, 0)) do
28 Enum.find(actor, fn %{"type" => type} -> type in ["Person", "Service", "Application"] end)
33 def get_actor(%{"actor" => %{"id" => id}}) when is_bitstring(id) do
37 def get_actor(%{"actor" => nil, "attributedTo" => actor}) when not is_nil(actor) do
38 get_actor(%{"actor" => actor})
42 Checks that an imported AP object's actor matches the domain it came from.
44 def contain_origin(_id, %{"actor" => nil}), do: :error
46 def contain_origin(id, %{"actor" => _actor} = params) do
47 id_uri = URI.parse(id)
48 actor_uri = URI.parse(get_actor(params))
50 if id_uri.host == actor_uri.host do
57 def contain_origin_from_id(_id, %{"id" => nil}), do: :error
59 def contain_origin_from_id(id, %{"id" => other_id} = _params) do
60 id_uri = URI.parse(id)
61 other_uri = URI.parse(other_id)
63 if id_uri.host == other_uri.host do
71 Modifies an incoming AP object (mastodon format) to our internal format.
73 def fix_object(object) do
87 def fix_addressing_list(map, field) do
88 if is_binary(map[field]) do
90 |> Map.put(field, [map[field]])
96 def fix_explicit_addressing(%{"to" => to, "cc" => cc} = object, explicit_mentions) do
99 |> Enum.filter(fn x -> x in explicit_mentions end)
103 |> Enum.filter(fn x -> x not in explicit_mentions end)
110 |> Map.put("to", explicit_to)
111 |> Map.put("cc", final_cc)
114 def fix_explicit_addressing(object, _explicit_mentions), do: object
116 def fix_addressing(object) do
119 |> fix_addressing_list("to")
120 |> fix_addressing_list("cc")
121 |> fix_addressing_list("bto")
122 |> fix_addressing_list("bcc")
126 |> Utils.determine_explicit_mentions()
128 explicit_mentions = explicit_mentions ++ ["https://www.w3.org/ns/activitystreams#Public"]
131 |> fix_explicit_addressing(explicit_mentions)
134 def fix_actor(%{"attributedTo" => actor} = object) do
136 |> Map.put("actor", get_actor(%{"actor" => actor}))
139 def fix_likes(%{"likes" => likes} = object)
140 when is_bitstring(likes) do
141 # Check for standardisation
142 # This is what Peertube does
143 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
145 |> Map.put("likes", [])
146 |> Map.put("like_count", 0)
149 def fix_likes(object) do
153 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
154 when not is_nil(in_reply_to) do
157 is_bitstring(in_reply_to) ->
160 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
163 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
164 Enum.at(in_reply_to, 0)
166 # Maybe I should output an error too?
171 case fetch_obj_helper(in_reply_to_id) do
172 {:ok, replied_object} ->
173 with %Activity{} = activity <-
174 Activity.get_create_activity_by_object_ap_id(replied_object.data["id"]) do
176 |> Map.put("inReplyTo", replied_object.data["id"])
177 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
178 |> Map.put("inReplyToStatusId", activity.id)
179 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
180 |> Map.put("context", replied_object.data["context"] || object["conversation"])
183 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
188 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
193 def fix_in_reply_to(object), do: object
195 def fix_context(object) do
196 context = object["context"] || object["conversation"] || Utils.generate_context_id()
199 |> Map.put("context", context)
200 |> Map.put("conversation", context)
203 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
206 |> Enum.map(fn data ->
207 media_type = data["mediaType"] || data["mimeType"]
208 href = data["url"] || data["href"]
210 url = [%{"type" => "Link", "mediaType" => media_type, "href" => href}]
213 |> Map.put("mediaType", media_type)
214 |> Map.put("url", url)
218 |> Map.put("attachment", attachments)
221 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
222 Map.put(object, "attachment", [attachment])
226 def fix_attachments(object), do: object
228 def fix_url(%{"url" => url} = object) when is_map(url) do
230 |> Map.put("url", url["href"])
233 def fix_url(%{"type" => "Video", "url" => url} = object) when is_list(url) do
234 first_element = Enum.at(url, 0)
238 |> Enum.filter(fn x -> is_map(x) end)
239 |> Enum.filter(fn x -> x["mimeType"] == "text/html" end)
243 |> Map.put("attachment", [first_element])
244 |> Map.put("url", link_element["href"])
247 def fix_url(%{"type" => object_type, "url" => url} = object)
248 when object_type != "Video" and is_list(url) do
249 first_element = Enum.at(url, 0)
253 is_bitstring(first_element) -> first_element
254 is_map(first_element) -> first_element["href"] || ""
259 |> Map.put("url", url_string)
262 def fix_url(object), do: object
264 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
265 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
269 |> Enum.reduce(%{}, fn data, mapping ->
270 name = String.trim(data["name"], ":")
272 mapping |> Map.put(name, data["icon"]["url"])
275 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
276 emoji = Map.merge(object["emoji"] || %{}, emoji)
279 |> Map.put("emoji", emoji)
282 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
283 name = String.trim(tag["name"], ":")
284 emoji = %{name => tag["icon"]["url"]}
287 |> Map.put("emoji", emoji)
290 def fix_emoji(object), do: object
292 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
295 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
296 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
298 combined = tag ++ tags
301 |> Map.put("tag", combined)
304 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
305 combined = [tag, String.slice(hashtag, 1..-1)]
308 |> Map.put("tag", combined)
311 def fix_tag(object), do: object
313 # content map usually only has one language so this will do for now.
314 def fix_content_map(%{"contentMap" => content_map} = object) do
315 content_groups = Map.to_list(content_map)
316 {_, content} = Enum.at(content_groups, 0)
319 |> Map.put("content", content)
322 def fix_content_map(object), do: object
324 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
325 with true <- id =~ "follows",
326 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
327 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
334 defp mastodon_follow_hack(_, _), do: {:error, nil}
336 defp get_follow_activity(follow_object, followed) do
337 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
338 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
341 # Can't find the activity. This might a Mastodon 2.3 "Accept"
343 mastodon_follow_hack(follow_object, followed)
350 # disallow objects with bogus IDs
351 def handle_incoming(%{"id" => nil}), do: :error
352 def handle_incoming(%{"id" => ""}), do: :error
353 # length of https:// = 8, should validate better, but good enough for now.
354 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
356 # TODO: validate those with a Ecto scheme
359 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
360 when objtype in ["Article", "Note", "Video", "Page"] do
361 actor = get_actor(data)
364 Map.put(data, "actor", actor)
367 with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
368 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
369 object = fix_object(data["object"])
375 context: object["conversation"],
377 published: data["published"],
385 ActivityPub.create(params)
387 %Activity{} = activity -> {:ok, activity}
393 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
395 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
396 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
397 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
398 if not User.locked?(followed) do
399 ActivityPub.accept(%{
400 to: [follower.ap_id],
401 actor: followed.ap_id,
406 User.follow(follower, followed)
416 %{"type" => "Accept", "object" => follow_object, "actor" => _actor, "id" => _id} = data
418 with actor <- get_actor(data),
419 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
420 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
421 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
422 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
424 ActivityPub.accept(%{
425 to: follow_activity.data["to"],
427 actor: followed.ap_id,
428 object: follow_activity.data["id"],
431 if not User.following?(follower, followed) do
432 {:ok, _follower} = User.follow(follower, followed)
442 %{"type" => "Reject", "object" => follow_object, "actor" => _actor, "id" => _id} = data
444 with actor <- get_actor(data),
445 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
446 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
447 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
448 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
450 ActivityPub.accept(%{
451 to: follow_activity.data["to"],
453 actor: followed.ap_id,
454 object: follow_activity.data["id"],
457 User.unfollow(follower, followed)
466 %{"type" => "Like", "object" => object_id, "actor" => _actor, "id" => id} = data
468 with actor <- get_actor(data),
469 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
470 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
471 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
479 %{"type" => "Announce", "object" => object_id, "actor" => _actor, "id" => id} = data
481 with actor <- get_actor(data),
482 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
483 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
484 public <- ActivityPub.is_public?(data),
485 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false, public) do
493 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
496 when object_type in ["Person", "Application", "Service", "Organization"] do
497 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
498 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
500 banner = new_user_data[:info]["banner"]
501 locked = new_user_data[:info]["locked"] || false
505 |> Map.take([:name, :bio, :avatar])
506 |> Map.put(:info, %{"banner" => banner, "locked" => locked})
509 |> User.upgrade_changeset(update_data)
510 |> User.update_and_set_cache()
512 ActivityPub.update(%{
514 to: data["to"] || [],
515 cc: data["cc"] || [],
526 # TODO: We presently assume that any actor on the same origin domain as the object being
527 # deleted has the rights to delete that object. A better way to validate whether or not
528 # the object should be deleted is to refetch the object URI, which should return either
529 # an error or a tombstone. This would allow us to verify that a deletion actually took
532 %{"type" => "Delete", "object" => object_id, "actor" => _actor, "id" => _id} = data
534 object_id = Utils.get_ap_id(object_id)
536 with actor <- get_actor(data),
537 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
538 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
539 :ok <- contain_origin(actor.ap_id, object.data),
540 {:ok, activity} <- ActivityPub.delete(object, false) do
550 "object" => %{"type" => "Announce", "object" => object_id},
555 with actor <- get_actor(data),
556 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
557 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
558 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
568 "object" => %{"type" => "Follow", "object" => followed},
573 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
574 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
575 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
576 User.unfollow(follower, followed)
586 "object" => %{"type" => "Block", "object" => blocked},
591 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
592 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
593 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
594 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
595 User.unblock(blocker, blocked)
603 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = _data
605 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
606 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
607 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
608 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
609 User.unfollow(blocker, blocked)
610 User.block(blocker, blocked)
620 "object" => %{"type" => "Like", "object" => object_id},
625 with actor <- get_actor(data),
626 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
627 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
628 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
635 def handle_incoming(_), do: :error
637 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
638 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
640 def get_obj_helper(id) do
641 if object = Object.normalize(id), do: {:ok, object}, else: nil
644 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
645 with false <- String.starts_with?(inReplyTo, "http"),
646 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
647 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
653 def set_reply_to_uri(obj), do: obj
655 # Prepares the object of an outgoing create activity.
656 def prepare_object(object) do
664 |> prepare_attachments
667 |> strip_internal_fields
668 |> strip_internal_tags
673 # internal -> Mastodon
676 def prepare_outgoing(%{"type" => "Create", "object" => object} = data) do
683 |> Map.put("object", object)
684 |> Map.merge(Utils.make_json_ld_header())
689 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
690 # because of course it does.
691 def prepare_outgoing(%{"type" => "Accept"} = data) do
692 with follow_activity <- Activity.normalize(data["object"]) do
694 "actor" => follow_activity.actor,
695 "object" => follow_activity.data["object"],
696 "id" => follow_activity.data["id"],
702 |> Map.put("object", object)
703 |> Map.merge(Utils.make_json_ld_header())
709 def prepare_outgoing(%{"type" => "Reject"} = data) do
710 with follow_activity <- Activity.normalize(data["object"]) do
712 "actor" => follow_activity.actor,
713 "object" => follow_activity.data["object"],
714 "id" => follow_activity.data["id"],
720 |> Map.put("object", object)
721 |> Map.merge(Utils.make_json_ld_header())
727 def prepare_outgoing(%{"type" => _type} = data) do
730 |> maybe_fix_object_url
731 |> Map.merge(Utils.make_json_ld_header())
736 def maybe_fix_object_url(data) do
737 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
738 case fetch_obj_helper(data["object"]) do
739 {:ok, relative_object} ->
740 if relative_object.data["external_url"] do
743 |> Map.put("object", relative_object.data["external_url"])
749 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
757 def add_hashtags(object) do
759 (object["tag"] || [])
760 |> Enum.map(fn tag ->
762 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
769 |> Map.put("tag", tags)
772 def add_mention_tags(object) do
775 |> Utils.get_notified_from_object()
776 |> Enum.map(fn user ->
777 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
780 tags = object["tag"] || []
783 |> Map.put("tag", tags ++ mentions)
786 # TODO: we should probably send mtime instead of unix epoch time for updated
787 def add_emoji_tags(object) do
788 tags = object["tag"] || []
789 emoji = object["emoji"] || []
793 |> Enum.map(fn {name, url} ->
795 "icon" => %{"url" => url, "type" => "Image"},
796 "name" => ":" <> name <> ":",
798 "updated" => "1970-01-01T00:00:00Z",
804 |> Map.put("tag", tags ++ out)
807 def set_conversation(object) do
808 Map.put(object, "conversation", object["context"])
811 def set_sensitive(object) do
812 tags = object["tag"] || []
813 Map.put(object, "sensitive", "nsfw" in tags)
816 def add_attributed_to(object) do
817 attributedTo = object["attributedTo"] || object["actor"]
820 |> Map.put("attributedTo", attributedTo)
823 def add_likes(%{"id" => id, "like_count" => likes} = object) do
825 "id" => "#{id}/likes",
826 "first" => "#{id}/likes?page=1",
827 "type" => "OrderedCollection",
828 "totalItems" => likes
832 |> Map.put("likes", likes)
835 def add_likes(object) do
839 def prepare_attachments(object) do
841 (object["attachment"] || [])
842 |> Enum.map(fn data ->
843 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
844 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
848 |> Map.put("attachment", attachments)
851 defp strip_internal_fields(object) do
856 "announcement_count",
862 defp strip_internal_tags(%{"tag" => tags} = object) do
865 |> Enum.filter(fn x -> is_map(x) end)
868 |> Map.put("tag", tags)
871 defp strip_internal_tags(object), do: object
873 defp user_upgrade_task(user) do
874 old_follower_address = User.ap_followers(user)
879 where: ^old_follower_address in u.following,
884 "array_replace(?,?,?)",
886 ^old_follower_address,
887 ^user.follower_address
893 Repo.update_all(q, [])
895 maybe_retire_websub(user.ap_id)
897 # Only do this for recent activties, don't go through the whole db.
898 # Only look at the last 1000 activities.
899 since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
904 where: ^old_follower_address in a.recipients,
905 where: a.id > ^since,
910 "array_replace(?,?,?)",
912 ^old_follower_address,
913 ^user.follower_address
919 Repo.update_all(q, [])
922 def upgrade_user_from_ap_id(ap_id, async \\ true) do
923 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
924 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
925 already_ap = User.ap_enabled?(user)
928 User.upgrade_changeset(user, data)
932 # This could potentially take a long time, do it in the background
935 user_upgrade_task(user)
938 user_upgrade_task(user)
948 def maybe_retire_websub(ap_id) do
950 if is_binary(ap_id) && String.length(ap_id) > 8 do
953 ws in Pleroma.Web.Websub.WebsubClientSubscription,
954 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
961 def maybe_fix_user_url(data) do
962 if is_map(data["url"]) do
963 Map.put(data, "url", data["url"]["href"])
969 def maybe_fix_user_object(data) do
971 |> maybe_fix_user_url