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.
9 alias Pleroma.{Activity, User, Object, Repo}
10 alias Pleroma.Web.ActivityPub.{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 in ["Person", "Service", "Application"] end)
29 def get_actor(%{"actor" => %{"id" => id}}) when is_bitstring(id) do
33 def get_actor(%{"actor" => nil, "attributedTo" => actor}) when not is_nil(actor) do
34 get_actor(%{"actor" => actor})
38 Checks that an imported AP object's actor matches the domain it came from.
40 def contain_origin(_id, %{"actor" => nil}), do: :error
42 def contain_origin(id, %{"actor" => _actor} = params) do
43 id_uri = URI.parse(id)
44 actor_uri = URI.parse(get_actor(params))
46 if id_uri.host == actor_uri.host do
53 def contain_origin_from_id(_id, %{"id" => nil}), do: :error
55 def contain_origin_from_id(id, %{"id" => other_id} = _params) do
56 id_uri = URI.parse(id)
57 other_uri = URI.parse(other_id)
59 if id_uri.host == other_uri.host do
67 Modifies an incoming AP object (mastodon format) to our internal format.
69 def fix_object(object) do
83 def fix_addressing_list(map, field) do
84 if is_binary(map[field]) do
86 |> Map.put(field, [map[field]])
92 def fix_explicit_addressing(%{"to" => to, "cc" => cc} = object, explicit_mentions) do
95 |> Enum.filter(fn x -> x in explicit_mentions end)
99 |> Enum.filter(fn x -> x not in explicit_mentions end)
106 |> Map.put("to", explicit_to)
107 |> Map.put("cc", final_cc)
110 def fix_explicit_addressing(object, _explicit_mentions), do: object
112 # if directMessage flag is set to true, leave the addressing alone
113 def fix_explicit_addressing(%{"directMessage" => true} = object), do: object
115 def fix_explicit_addressing(object) do
118 |> Utils.determine_explicit_mentions()
120 explicit_mentions = explicit_mentions ++ ["https://www.w3.org/ns/activitystreams#Public"]
123 |> fix_explicit_addressing(explicit_mentions)
126 def fix_addressing(object) do
128 |> fix_addressing_list("to")
129 |> fix_addressing_list("cc")
130 |> fix_addressing_list("bto")
131 |> fix_addressing_list("bcc")
132 |> fix_explicit_addressing
135 def fix_actor(%{"attributedTo" => actor} = object) do
137 |> Map.put("actor", get_actor(%{"actor" => actor}))
140 # Check for standardisation
141 # This is what Peertube does
142 # curl -H 'Accept: application/activity+json' $likes | jq .totalItems
143 # Prismo returns only an integer (count) as "likes"
144 def fix_likes(%{"likes" => likes} = object) when not is_map(likes) do
146 |> Map.put("likes", [])
147 |> Map.put("like_count", 0)
150 def fix_likes(object) do
154 def fix_in_reply_to(%{"inReplyTo" => in_reply_to} = object)
155 when not is_nil(in_reply_to) do
158 is_bitstring(in_reply_to) ->
161 is_map(in_reply_to) && is_bitstring(in_reply_to["id"]) ->
164 is_list(in_reply_to) && is_bitstring(Enum.at(in_reply_to, 0)) ->
165 Enum.at(in_reply_to, 0)
167 # Maybe I should output an error too?
172 case fetch_obj_helper(in_reply_to_id) do
173 {:ok, replied_object} ->
174 with %Activity{} = activity <-
175 Activity.get_create_by_object_ap_id(replied_object.data["id"]) do
177 |> Map.put("inReplyTo", replied_object.data["id"])
178 |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
179 |> Map.put("inReplyToStatusId", activity.id)
180 |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
181 |> Map.put("context", replied_object.data["context"] || object["conversation"])
184 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
189 Logger.error("Couldn't fetch \"#{inspect(in_reply_to_id)}\", error: #{inspect(e)}")
194 def fix_in_reply_to(object), do: object
196 def fix_context(object) do
197 context = object["context"] || object["conversation"] || Utils.generate_context_id()
200 |> Map.put("context", context)
201 |> Map.put("conversation", context)
204 def fix_attachments(%{"attachment" => attachment} = object) when is_list(attachment) do
207 |> Enum.map(fn data ->
208 media_type = data["mediaType"] || data["mimeType"]
209 href = data["url"] || data["href"]
211 url = [%{"type" => "Link", "mediaType" => media_type, "href" => href}]
214 |> Map.put("mediaType", media_type)
215 |> Map.put("url", url)
219 |> Map.put("attachment", attachments)
222 def fix_attachments(%{"attachment" => attachment} = object) when is_map(attachment) do
223 Map.put(object, "attachment", [attachment])
227 def fix_attachments(object), do: object
229 def fix_url(%{"url" => url} = object) when is_map(url) do
231 |> Map.put("url", url["href"])
234 def fix_url(%{"type" => "Video", "url" => url} = object) when is_list(url) do
235 first_element = Enum.at(url, 0)
239 |> Enum.filter(fn x -> is_map(x) end)
240 |> Enum.filter(fn x -> x["mimeType"] == "text/html" end)
244 |> Map.put("attachment", [first_element])
245 |> Map.put("url", link_element["href"])
248 def fix_url(%{"type" => object_type, "url" => url} = object)
249 when object_type != "Video" and is_list(url) do
250 first_element = Enum.at(url, 0)
254 is_bitstring(first_element) -> first_element
255 is_map(first_element) -> first_element["href"] || ""
260 |> Map.put("url", url_string)
263 def fix_url(object), do: object
265 def fix_emoji(%{"tag" => tags} = object) when is_list(tags) do
266 emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
270 |> Enum.reduce(%{}, fn data, mapping ->
271 name = String.trim(data["name"], ":")
273 mapping |> Map.put(name, data["icon"]["url"])
276 # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
277 emoji = Map.merge(object["emoji"] || %{}, emoji)
280 |> Map.put("emoji", emoji)
283 def fix_emoji(%{"tag" => %{"type" => "Emoji"} = tag} = object) do
284 name = String.trim(tag["name"], ":")
285 emoji = %{name => tag["icon"]["url"]}
288 |> Map.put("emoji", emoji)
291 def fix_emoji(object), do: object
293 def fix_tag(%{"tag" => tag} = object) when is_list(tag) do
296 |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
297 |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
299 combined = tag ++ tags
302 |> Map.put("tag", combined)
305 def fix_tag(%{"tag" => %{"type" => "Hashtag", "name" => hashtag} = tag} = object) do
306 combined = [tag, String.slice(hashtag, 1..-1)]
309 |> Map.put("tag", combined)
312 def fix_tag(%{"tag" => %{} = tag} = object), do: Map.put(object, "tag", [tag])
314 def fix_tag(object), do: object
316 # content map usually only has one language so this will do for now.
317 def fix_content_map(%{"contentMap" => content_map} = object) do
318 content_groups = Map.to_list(content_map)
319 {_, content} = Enum.at(content_groups, 0)
322 |> Map.put("content", content)
325 def fix_content_map(object), do: object
327 defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
328 with true <- id =~ "follows",
329 %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
330 %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
337 defp mastodon_follow_hack(_, _), do: {:error, nil}
339 defp get_follow_activity(follow_object, followed) do
340 with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
341 {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
344 # Can't find the activity. This might a Mastodon 2.3 "Accept"
346 mastodon_follow_hack(follow_object, followed)
353 # disallow objects with bogus IDs
354 def handle_incoming(%{"id" => nil}), do: :error
355 def handle_incoming(%{"id" => ""}), do: :error
356 # length of https:// = 8, should validate better, but good enough for now.
357 def handle_incoming(%{"id" => id}) when not (is_binary(id) and length(id) > 8), do: :error
359 # TODO: validate those with a Ecto scheme
362 def handle_incoming(%{"type" => "Create", "object" => %{"type" => objtype} = object} = data)
363 when objtype in ["Article", "Note", "Video", "Page"] do
364 actor = get_actor(data)
367 Map.put(data, "actor", actor)
370 with nil <- Activity.get_create_by_object_ap_id(object["id"]),
371 %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
372 object = fix_object(data["object"])
378 context: object["conversation"],
380 published: data["published"],
389 ActivityPub.create(params)
391 %Activity{} = activity -> {:ok, activity}
397 %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
399 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
400 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
401 {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
402 if not User.locked?(followed) do
403 ActivityPub.accept(%{
404 to: [follower.ap_id],
405 actor: followed.ap_id,
410 User.follow(follower, followed)
420 %{"type" => "Accept", "object" => follow_object, "actor" => _actor, "id" => _id} = data
422 with actor <- get_actor(data),
423 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
424 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
425 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "accept"),
426 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
428 ActivityPub.accept(%{
429 to: follow_activity.data["to"],
431 actor: followed.ap_id,
432 object: follow_activity.data["id"],
435 if not User.following?(follower, followed) do
436 {:ok, _follower} = User.follow(follower, followed)
446 %{"type" => "Reject", "object" => follow_object, "actor" => _actor, "id" => _id} = data
448 with actor <- get_actor(data),
449 %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
450 {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
451 {:ok, follow_activity} <- Utils.update_follow_state(follow_activity, "reject"),
452 %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
454 ActivityPub.reject(%{
455 to: follow_activity.data["to"],
457 actor: followed.ap_id,
458 object: follow_activity.data["id"],
461 User.unfollow(follower, followed)
470 %{"type" => "Like", "object" => object_id, "actor" => _actor, "id" => id} = data
472 with actor <- get_actor(data),
473 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
474 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
475 {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
483 %{"type" => "Announce", "object" => object_id, "actor" => _actor, "id" => id} = data
485 with actor <- get_actor(data),
486 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
487 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
488 public <- ActivityPub.is_public?(data),
489 {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false, public) do
497 %{"type" => "Update", "object" => %{"type" => object_type} = object, "actor" => actor_id} =
500 when object_type in ["Person", "Application", "Service", "Organization"] do
501 with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
502 {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
504 banner = new_user_data[:info]["banner"]
505 locked = new_user_data[:info]["locked"] || false
509 |> Map.take([:name, :bio, :avatar])
510 |> Map.put(:info, %{"banner" => banner, "locked" => locked})
513 |> User.upgrade_changeset(update_data)
514 |> User.update_and_set_cache()
516 ActivityPub.update(%{
518 to: data["to"] || [],
519 cc: data["cc"] || [],
530 # TODO: We presently assume that any actor on the same origin domain as the object being
531 # deleted has the rights to delete that object. A better way to validate whether or not
532 # the object should be deleted is to refetch the object URI, which should return either
533 # an error or a tombstone. This would allow us to verify that a deletion actually took
536 %{"type" => "Delete", "object" => object_id, "actor" => _actor, "id" => _id} = data
538 object_id = Utils.get_ap_id(object_id)
540 with actor <- get_actor(data),
541 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
542 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
543 :ok <- contain_origin(actor.ap_id, object.data),
544 {:ok, activity} <- ActivityPub.delete(object, false) do
554 "object" => %{"type" => "Announce", "object" => object_id},
559 with actor <- get_actor(data),
560 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
561 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
562 {:ok, activity, _} <- ActivityPub.unannounce(actor, object, id, false) do
572 "object" => %{"type" => "Follow", "object" => followed},
577 with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
578 %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
579 {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
580 User.unfollow(follower, followed)
590 "object" => %{"type" => "Block", "object" => blocked},
595 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
596 %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
597 %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
598 {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
599 User.unblock(blocker, blocked)
607 %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = _data
609 with true <- Pleroma.Config.get([:activitypub, :accept_blocks]),
610 %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
611 %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
612 {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
613 User.unfollow(blocker, blocked)
614 User.block(blocker, blocked)
624 "object" => %{"type" => "Like", "object" => object_id},
629 with actor <- get_actor(data),
630 %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
631 {:ok, object} <- get_obj_helper(object_id) || fetch_obj_helper(object_id),
632 {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
639 def handle_incoming(_), do: :error
641 def fetch_obj_helper(id) when is_bitstring(id), do: ActivityPub.fetch_object_from_id(id)
642 def fetch_obj_helper(obj) when is_map(obj), do: ActivityPub.fetch_object_from_id(obj["id"])
644 def get_obj_helper(id) do
645 if object = Object.normalize(id), do: {:ok, object}, else: nil
648 def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
649 with false <- String.starts_with?(inReplyTo, "http"),
650 {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
651 Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
657 def set_reply_to_uri(obj), do: obj
659 # Prepares the object of an outgoing create activity.
660 def prepare_object(object) do
668 |> prepare_attachments
671 |> strip_internal_fields
672 |> strip_internal_tags
677 # internal -> Mastodon
680 def prepare_outgoing(%{"type" => "Create", "object" => object} = data) do
687 |> Map.put("object", object)
688 |> Map.merge(Utils.make_json_ld_header())
693 # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
694 # because of course it does.
695 def prepare_outgoing(%{"type" => "Accept"} = data) do
696 with follow_activity <- Activity.normalize(data["object"]) do
698 "actor" => follow_activity.actor,
699 "object" => follow_activity.data["object"],
700 "id" => follow_activity.data["id"],
706 |> Map.put("object", object)
707 |> Map.merge(Utils.make_json_ld_header())
713 def prepare_outgoing(%{"type" => "Reject"} = data) do
714 with follow_activity <- Activity.normalize(data["object"]) do
716 "actor" => follow_activity.actor,
717 "object" => follow_activity.data["object"],
718 "id" => follow_activity.data["id"],
724 |> Map.put("object", object)
725 |> Map.merge(Utils.make_json_ld_header())
731 def prepare_outgoing(%{"type" => _type} = data) do
734 |> maybe_fix_object_url
735 |> Map.merge(Utils.make_json_ld_header())
740 def maybe_fix_object_url(data) do
741 if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
742 case fetch_obj_helper(data["object"]) do
743 {:ok, relative_object} ->
744 if relative_object.data["external_url"] do
747 |> Map.put("object", relative_object.data["external_url"])
753 Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
761 def add_hashtags(object) do
763 (object["tag"] || [])
764 |> Enum.map(fn tag ->
766 "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
773 |> Map.put("tag", tags)
776 def add_mention_tags(object) do
779 |> Utils.get_notified_from_object()
780 |> Enum.map(fn user ->
781 %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
784 tags = object["tag"] || []
787 |> Map.put("tag", tags ++ mentions)
790 # TODO: we should probably send mtime instead of unix epoch time for updated
791 def add_emoji_tags(object) do
792 tags = object["tag"] || []
793 emoji = object["emoji"] || []
797 |> Enum.map(fn {name, url} ->
799 "icon" => %{"url" => url, "type" => "Image"},
800 "name" => ":" <> name <> ":",
802 "updated" => "1970-01-01T00:00:00Z",
808 |> Map.put("tag", tags ++ out)
811 def set_conversation(object) do
812 Map.put(object, "conversation", object["context"])
815 def set_sensitive(object) do
816 tags = object["tag"] || []
817 Map.put(object, "sensitive", "nsfw" in tags)
820 def add_attributed_to(object) do
821 attributedTo = object["attributedTo"] || object["actor"]
824 |> Map.put("attributedTo", attributedTo)
827 def add_likes(%{"id" => id, "like_count" => likes} = object) do
829 "id" => "#{id}/likes",
830 "first" => "#{id}/likes?page=1",
831 "type" => "OrderedCollection",
832 "totalItems" => likes
836 |> Map.put("likes", likes)
839 def add_likes(object) do
843 def prepare_attachments(object) do
845 (object["attachment"] || [])
846 |> Enum.map(fn data ->
847 [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
848 %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
852 |> Map.put("attachment", attachments)
855 defp strip_internal_fields(object) do
860 "announcement_count",
866 defp strip_internal_tags(%{"tag" => tags} = object) do
869 |> Enum.filter(fn x -> is_map(x) end)
872 |> Map.put("tag", tags)
875 defp strip_internal_tags(object), do: object
877 defp user_upgrade_task(user) do
878 old_follower_address = User.ap_followers(user)
883 where: ^old_follower_address in u.following,
888 "array_replace(?,?,?)",
890 ^old_follower_address,
891 ^user.follower_address
897 Repo.update_all(q, [])
899 maybe_retire_websub(user.ap_id)
904 where: ^old_follower_address in a.recipients,
909 "array_replace(?,?,?)",
911 ^old_follower_address,
912 ^user.follower_address
918 Repo.update_all(q, [])
921 def upgrade_user_from_ap_id(ap_id, async \\ true) do
922 with %User{local: false} = user <- User.get_by_ap_id(ap_id),
923 {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
924 already_ap = User.ap_enabled?(user)
927 User.upgrade_changeset(user, data)
931 # This could potentially take a long time, do it in the background
934 user_upgrade_task(user)
937 user_upgrade_task(user)
947 def maybe_retire_websub(ap_id) do
949 if is_binary(ap_id) && String.length(ap_id) > 8 do
952 ws in Pleroma.Web.Websub.WebsubClientSubscription,
953 where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
960 def maybe_fix_user_url(data) do
961 if is_map(data["url"]) do
962 Map.put(data, "url", data["url"]["href"])
968 def maybe_fix_user_object(data) do
970 |> maybe_fix_user_url