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.
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 # if directMessage flag is set to true, leave the addressing alone
117 def fix_explicit_addressing(%{"directMessage" => true} = object), do: object
119 def fix_explicit_addressing(object) do
122 |> Utils.determine_explicit_mentions()
124 explicit_mentions = explicit_mentions ++ ["https://www.w3.org/ns/activitystreams#Public"]
127 |> fix_explicit_addressing(explicit_mentions)
130 def fix_addressing(object) do
132 |> fix_addressing_list("to")
133 |> fix_addressing_list("cc")
134 |> fix_addressing_list("bto")
135 |> fix_addressing_list("bcc")
136 |> fix_explicit_addressing
139 def fix_actor(%{"attributedTo" => actor} = object) do
141 |> Map.put("actor", get_actor(%{"actor" => actor}))
144 # Check for standardisation
145 # This is what Peertube does
146 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
147 # Prismo returns only an integer (count) as "likes"
148 def fix_likes(%{"likes" => likes} = object) when not is_map(likes) do
150 |> Map.put("likes", [])
151 |> Map.put("like_count", 0)
154 def fix_likes(object) do
158 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
159 when not is_nil(in_reply_to) do
162 is_bitstring(in_reply_to) ->
165 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
168 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
169 Enum.at(in_reply_to, 0)
171 # Maybe I should output an error too?
176 case fetch_obj_helper(in_reply_to_id) do
177 {:ok, replied_object} ->
178 with %Activity{} = activity <-
179 Activity.get_create_by_object_ap_id(replied_object.data["id"]) do
181 |> Map.put("inReplyTo", replied_object.data["id"])
182 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
183 |> Map.put("inReplyToStatusId", activity.id)
184 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
185 |> Map.put("context", replied_object.data["context"] || object["conversation"])
188 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
193 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
198 def fix_in_reply_to(object), do: object
200 def fix_context(object) do
201 context = object["context"] || object["conversation"] || Utils.generate_context_id()
204 |> Map.put("context", context)
205 |> Map.put("conversation", context)
208 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
211 |> Enum.map(fn data ->
212 media_type = data["mediaType"] || data["mimeType"]
213 href = data["url"] || data["href"]
215 url = [%{"type" => "Link", "mediaType" => media_type, "href" => href}]
218 |> Map.put("mediaType", media_type)
219 |> Map.put("url", url)
223 |> Map.put("attachment", attachments)
226 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
227 Map.put(object, "attachment", [attachment])
231 def fix_attachments(object), do: object
233 def fix_url(%{"url" => url} = object) when is_map(url) do
235 |> Map.put("url", url["href"])
238 def fix_url(%{"type" => "Video", "url" => url} = object) when is_list(url) do
239 first_element = Enum.at(url, 0)
243 |> Enum.filter(fn x -> is_map(x) end)
244 |> Enum.filter(fn x -> x["mimeType"] == "text/html" end)
248 |> Map.put("attachment", [first_element])
249 |> Map.put("url", link_element["href"])
252 def fix_url(%{"type" => object_type, "url" => url} = object)
253 when object_type != "Video" and is_list(url) do
254 first_element = Enum.at(url, 0)
258 is_bitstring(first_element) -> first_element
259 is_map(first_element) -> first_element["href"] || ""
264 |> Map.put("url", url_string)
267 def fix_url(object), do: object
269 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
270 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
274 |> Enum.reduce(%{}, fn data, mapping ->
275 name = String.trim(data["name"], ":")
277 mapping |> Map.put(name, data["icon"]["url"])
280 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
281 emoji = Map.merge(object["emoji"] || %{}, emoji)
284 |> Map.put("emoji", emoji)
287 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
288 name = String.trim(tag["name"], ":")
289 emoji = %{name => tag["icon"]["url"]}
292 |> Map.put("emoji", emoji)
295 def fix_emoji(object), do: object
297 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
300 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
301 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
303 combined = tag ++ tags
306 |> Map.put("tag", combined)
309 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
310 combined = [tag, String.slice(hashtag, 1..-1)]
313 |> Map.put("tag", combined)
316 def fix_tag(%{"tag" => %{} = tag} = object), do: Map.put(object, "tag", [tag])
318 def fix_tag(object), do: object
320 # content map usually only has one language so this will do for now.
321 def fix_content_map(%{"contentMap" => content_map} = object) do
322 content_groups = Map.to_list(content_map)
323 {_, content} = Enum.at(content_groups, 0)
326 |> Map.put("content", content)
329 def fix_content_map(object), do: object
331 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
332 with true <- id =~ "follows",
333 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
334 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
341 defp mastodon_follow_hack(_, _), do: {:error, nil}
343 defp get_follow_activity(follow_object, followed) do
344 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
345 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
348 # Can't find the activity. This might a Mastodon 2.3 "Accept"
350 mastodon_follow_hack(follow_object, followed)
357 # disallow objects with bogus IDs
358 def handle_incoming(%{"id" => nil}), do: :error
359 def handle_incoming(%{"id" => ""}), do: :error
360 # length of https:// = 8, should validate better, but good enough for now.
361 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
363 # TODO: validate those with a Ecto scheme
366 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
367 when objtype in ["Article", "Note", "Video", "Page"] do
368 actor = get_actor(data)
371 Map.put(data, "actor", actor)
374 with nil <- Activity.get_create_by_object_ap_id(object["id"]),
375 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
376 object = fix_object(data["object"])
382 context: object["conversation"],
384 published: data["published"],
393 ActivityPub.create(params)
395 %Activity{} = activity -> {:ok, activity}
401 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
403 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
404 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
405 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
406 if not User.locked?(followed) do
407 ActivityPub.accept(%{
408 to: [follower.ap_id],
409 actor: followed.ap_id,
414 User.follow(follower, followed)
424 %{"type" => "Accept", "object" => follow_object, "actor" => _actor, "id" => _id} = data
426 with actor <- get_actor(data),
427 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
428 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
429 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
430 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
432 ActivityPub.accept(%{
433 to: follow_activity.data["to"],
435 actor: followed.ap_id,
436 object: follow_activity.data["id"],
439 if not User.following?(follower, followed) do
440 {:ok, _follower} = User.follow(follower, followed)
450 %{"type" => "Reject", "object" => follow_object, "actor" => _actor, "id" => _id} = data
452 with actor <- get_actor(data),
453 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
454 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
455 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
456 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
458 ActivityPub.reject(%{
459 to: follow_activity.data["to"],
461 actor: followed.ap_id,
462 object: follow_activity.data["id"],
465 User.unfollow(follower, followed)
474 %{"type" => "Like", "object" => object_id, "actor" => _actor, "id" => id} = data
476 with actor <- get_actor(data),
477 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
478 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
479 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
487 %{"type" => "Announce", "object" => object_id, "actor" => _actor, "id" => id} = data
489 with actor <- get_actor(data),
490 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
491 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
492 public <- ActivityPub.is_public?(data),
493 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false, public) do
501 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
504 when object_type in ["Person", "Application", "Service", "Organization"] do
505 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
506 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
508 banner = new_user_data[:info]["banner"]
509 locked = new_user_data[:info]["locked"] || false
513 |> Map.take([:name, :bio, :avatar])
514 |> Map.put(:info, %{"banner" => banner, "locked" => locked})
517 |> User.upgrade_changeset(update_data)
518 |> User.update_and_set_cache()
520 ActivityPub.update(%{
522 to: data["to"] || [],
523 cc: data["cc"] || [],
534 # TODO: We presently assume that any actor on the same origin domain as the object being
535 # deleted has the rights to delete that object. A better way to validate whether or not
536 # the object should be deleted is to refetch the object URI, which should return either
537 # an error or a tombstone. This would allow us to verify that a deletion actually took
540 %{"type" => "Delete", "object" => object_id, "actor" => _actor, "id" => _id} = data
542 object_id = Utils.get_ap_id(object_id)
544 with actor <- get_actor(data),
545 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
546 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
547 :ok <- contain_origin(actor.ap_id, object.data),
548 {:ok, activity} <- ActivityPub.delete(object, false) do
558 "object" => %{"type" => "Announce", "object" => object_id},
563 with actor <- get_actor(data),
564 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
565 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
566 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
576 "object" => %{"type" => "Follow", "object" => followed},
581 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
582 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
583 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
584 User.unfollow(follower, followed)
594 "object" => %{"type" => "Block", "object" => blocked},
599 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
600 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
601 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
602 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
603 User.unblock(blocker, blocked)
611 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = _data
613 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
614 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
615 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
616 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
617 User.unfollow(blocker, blocked)
618 User.block(blocker, blocked)
628 "object" => %{"type" => "Like", "object" => object_id},
633 with actor <- get_actor(data),
634 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
635 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
636 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
643 def handle_incoming(_), do: :error
645 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
646 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
648 def get_obj_helper(id) do
649 if object = Object.normalize(id), do: {:ok, object}, else: nil
652 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
653 with false <- String.starts_with?(inReplyTo, "http"),
654 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
655 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
661 def set_reply_to_uri(obj), do: obj
663 # Prepares the object of an outgoing create activity.
664 def prepare_object(object) do
672 |> prepare_attachments
675 |> strip_internal_fields
676 |> strip_internal_tags
681 # internal -> Mastodon
684 def prepare_outgoing(%{"type" => "Create", "object" => object} = data) do
691 |> Map.put("object", object)
692 |> Map.merge(Utils.make_json_ld_header())
697 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
698 # because of course it does.
699 def prepare_outgoing(%{"type" => "Accept"} = data) do
700 with follow_activity <- Activity.normalize(data["object"]) do
702 "actor" => follow_activity.actor,
703 "object" => follow_activity.data["object"],
704 "id" => follow_activity.data["id"],
710 |> Map.put("object", object)
711 |> Map.merge(Utils.make_json_ld_header())
717 def prepare_outgoing(%{"type" => "Reject"} = data) do
718 with follow_activity <- Activity.normalize(data["object"]) do
720 "actor" => follow_activity.actor,
721 "object" => follow_activity.data["object"],
722 "id" => follow_activity.data["id"],
728 |> Map.put("object", object)
729 |> Map.merge(Utils.make_json_ld_header())
735 def prepare_outgoing(%{"type" => _type} = data) do
738 |> maybe_fix_object_url
739 |> Map.merge(Utils.make_json_ld_header())
744 def maybe_fix_object_url(data) do
745 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
746 case fetch_obj_helper(data["object"]) do
747 {:ok, relative_object} ->
748 if relative_object.data["external_url"] do
751 |> Map.put("object", relative_object.data["external_url"])
757 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
765 def add_hashtags(object) do
767 (object["tag"] || [])
768 |> Enum.map(fn tag ->
770 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
777 |> Map.put("tag", tags)
780 def add_mention_tags(object) do
783 |> Utils.get_notified_from_object()
784 |> Enum.map(fn user ->
785 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
788 tags = object["tag"] || []
791 |> Map.put("tag", tags ++ mentions)
794 # TODO: we should probably send mtime instead of unix epoch time for updated
795 def add_emoji_tags(object) do
796 tags = object["tag"] || []
797 emoji = object["emoji"] || []
801 |> Enum.map(fn {name, url} ->
803 "icon" => %{"url" => url, "type" => "Image"},
804 "name" => ":" <> name <> ":",
806 "updated" => "1970-01-01T00:00:00Z",
812 |> Map.put("tag", tags ++ out)
815 def set_conversation(object) do
816 Map.put(object, "conversation", object["context"])
819 def set_sensitive(object) do
820 tags = object["tag"] || []
821 Map.put(object, "sensitive", "nsfw" in tags)
824 def add_attributed_to(object) do
825 attributedTo = object["attributedTo"] || object["actor"]
828 |> Map.put("attributedTo", attributedTo)
831 def add_likes(%{"id" => id, "like_count" => likes} = object) do
833 "id" => "#{id}/likes",
834 "first" => "#{id}/likes?page=1",
835 "type" => "OrderedCollection",
836 "totalItems" => likes
840 |> Map.put("likes", likes)
843 def add_likes(object) do
847 def prepare_attachments(object) do
849 (object["attachment"] || [])
850 |> Enum.map(fn data ->
851 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
852 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
856 |> Map.put("attachment", attachments)
859 defp strip_internal_fields(object) do
864 "announcement_count",
870 defp strip_internal_tags(%{"tag" => tags} = object) do
873 |> Enum.filter(fn x -> is_map(x) end)
876 |> Map.put("tag", tags)
879 defp strip_internal_tags(object), do: object
881 defp user_upgrade_task(user) do
882 old_follower_address = User.ap_followers(user)
887 where: ^old_follower_address in u.following,
892 "array_replace(?,?,?)",
894 ^old_follower_address,
895 ^user.follower_address
901 Repo.update_all(q, [])
903 maybe_retire_websub(user.ap_id)
908 where: ^old_follower_address in a.recipients,
913 "array_replace(?,?,?)",
915 ^old_follower_address,
916 ^user.follower_address
922 Repo.update_all(q, [])
925 def upgrade_user_from_ap_id(ap_id, async \\ true) do
926 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
927 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
928 already_ap = User.ap_enabled?(user)
931 User.upgrade_changeset(user, data)
935 # This could potentially take a long time, do it in the background
938 user_upgrade_task(user)
941 user_upgrade_task(user)
951 def maybe_retire_websub(ap_id) do
953 if is_binary(ap_id) && String.length(ap_id) > 8 do
956 ws in Pleroma.Web.Websub.WebsubClientSubscription,
957 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
964 def maybe_fix_user_url(data) do
965 if is_map(data["url"]) do
966 Map.put(data, "url", data["url"]["href"])
972 def maybe_fix_user_object(data) do
974 |> maybe_fix_user_url