git.squeep.com Git - akkoma/blob - lib/pleroma/web/activity_pub/transmogrifier.ex

   1 defmodule Pleroma.Web.ActivityPub.Transmogrifier do
   2   @moduledoc """
   3   A module to handle coding from internal to wire ActivityPub and back.
   4   """
   5   alias Pleroma.User
   6   alias Pleroma.Object
   7   alias Pleroma.Activity
   8   alias Pleroma.Repo
   9   alias Pleroma.Web.ActivityPub.ActivityPub
  10   alias Pleroma.Web.ActivityPub.Utils
  11
  12   import Ecto.Query
  13
  14   require Logger
  15
  16   @doc """
  17   Modifies an incoming AP object (mastodon format) to our internal format.
  18   """
  19   def fix_object(object) do
  20     object
  21     |> Map.put("actor", object["attributedTo"])
  22     |> fix_attachments
  23     |> fix_context
  24     |> fix_in_reply_to
  25     |> fix_emoji
  26     |> fix_tag
  27   end
  28
  29   def fix_in_reply_to(%{"inReplyTo" => in_reply_to_id} = object)
  30       when not is_nil(in_reply_to_id) do
  31     case ActivityPub.fetch_object_from_id(in_reply_to_id) do
  32       {:ok, replied_object} ->
  33         activity = Activity.get_create_activity_by_object_ap_id(replied_object.data["id"])
  34
  35         object
  36         |> Map.put("inReplyTo", replied_object.data["id"])
  37         |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
  38         |> Map.put("inReplyToStatusId", activity.id)
  39         |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
  40         |> Map.put("context", replied_object.data["context"] || object["conversation"])
  41
  42       e ->
  43         Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
  44         object
  45     end
  46   end
  47
  48   def fix_in_reply_to(object), do: object
  49
  50   def fix_context(object) do
  51     object
  52     |> Map.put("context", object["conversation"])
  53   end
  54
  55   def fix_attachments(object) do
  56     attachments =
  57       (object["attachment"] || [])
  58       |> Enum.map(fn data ->
  59         url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
  60         Map.put(data, "url", url)
  61       end)
  62
  63     object
  64     |> Map.put("attachment", attachments)
  65   end
  66
  67   def fix_emoji(object) do
  68     tags = object["tag"] || []
  69     emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)
  70
  71     emoji =
  72       emoji
  73       |> Enum.reduce(%{}, fn data, mapping ->
  74         name = data["name"]
  75
  76         name =
  77           if String.starts_with?(name, ":") do
  78             name |> String.slice(1..-2)
  79           else
  80             name
  81           end
  82
  83         mapping |> Map.put(name, data["icon"]["url"])
  84       end)
  85
  86     # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
  87     emoji = Map.merge(object["emoji"] || %{}, emoji)
  88
  89     object
  90     |> Map.put("emoji", emoji)
  91   end
  92
  93   def fix_tag(object) do
  94     tags =
  95       (object["tag"] || [])
  96       |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
  97       |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
  98
  99     combined = (object["tag"] || []) ++ tags
 100
 101     object
 102     |> Map.put("tag", combined)
 103   end
 104
 105   # TODO: validate those with a Ecto scheme
 106   # - tags
 107   # - emoji
 108   def handle_incoming(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
 109     with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
 110          %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
 111       object = fix_object(data["object"])
 112
 113       params = %{
 114         to: data["to"],
 115         object: object,
 116         actor: user,
 117         context: object["conversation"],
 118         local: false,
 119         published: data["published"],
 120         additional:
 121           Map.take(data, [
 122             "cc",
 123             "id"
 124           ])
 125       }
 126
 127       ActivityPub.create(params)
 128     else
 129       %Activity{} = activity -> {:ok, activity}
 130       _e -> :error
 131     end
 132   end
 133
 134   def handle_incoming(
 135         %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
 136       ) do
 137     with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
 138          %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
 139          {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
 140       ActivityPub.accept(%{to: [follower.ap_id], actor: followed.ap_id, object: data, local: true})
 141
 142       User.follow(follower, followed)
 143       {:ok, activity}
 144     else
 145       _e -> :error
 146     end
 147   end
 148
 149   defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
 150     with true <- id =~ "follows",
 151          %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
 152          %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
 153       {:ok, activity}
 154     else
 155       _ -> {:error, nil}
 156     end
 157   end
 158
 159   defp mastodon_follow_hack(_), do: {:error, nil}
 160
 161   defp get_follow_activity(follow_object, followed) do
 162     with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
 163          {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
 164       {:ok, activity}
 165     else
 166       # Can't find the activity. This might a Mastodon 2.3 "Accept"
 167       {:activity, nil} ->
 168         mastodon_follow_hack(follow_object, followed)
 169
 170       _ ->
 171         {:error, nil}
 172     end
 173   end
 174
 175   def handle_incoming(
 176         %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
 177       ) do
 178     with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
 179          {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
 180          %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
 181          {:ok, activity} <-
 182            ActivityPub.accept(%{
 183              to: follow_activity.data["to"],
 184              type: "Accept",
 185              actor: followed.ap_id,
 186              object: follow_activity.data["id"],
 187              local: false
 188            }) do
 189       if not User.following?(follower, followed) do
 190         {:ok, follower} = User.follow(follower, followed)
 191       end
 192
 193       {:ok, activity}
 194     else
 195       _e -> :error
 196     end
 197   end
 198
 199   def handle_incoming(
 200         %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
 201       ) do
 202     with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
 203          {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
 204          %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
 205          {:ok, activity} <-
 206            ActivityPub.accept(%{
 207              to: follow_activity.data["to"],
 208              type: "Accept",
 209              actor: followed.ap_id,
 210              object: follow_activity.data["id"],
 211              local: false
 212            }) do
 213       User.unfollow(follower, followed)
 214
 215       {:ok, activity}
 216     else
 217       _e -> :error
 218     end
 219   end
 220
 221   def handle_incoming(
 222         %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
 223       ) do
 224     with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
 225          {:ok, object} <-
 226            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 227          {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
 228       {:ok, activity}
 229     else
 230       _e -> :error
 231     end
 232   end
 233
 234   def handle_incoming(
 235         %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
 236       ) do
 237     with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
 238          {:ok, object} <-
 239            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 240          {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
 241       {:ok, activity}
 242     else
 243       _e -> :error
 244     end
 245   end
 246
 247   def handle_incoming(
 248         %{"type" => "Update", "object" => %{"type" => "Person"} = object, "actor" => actor_id} =
 249           data
 250       ) do
 251     with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
 252       {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
 253
 254       banner = new_user_data[:info]["banner"]
 255       locked = new_user_data[:info]["locked"]
 256
 257       update_data =
 258         new_user_data
 259         |> Map.take([:name, :bio, :avatar])
 260         |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
 261
 262       actor
 263       |> User.upgrade_changeset(update_data)
 264       |> User.update_and_set_cache()
 265
 266       ActivityPub.update(%{
 267         local: false,
 268         to: data["to"] || [],
 269         cc: data["cc"] || [],
 270         object: object,
 271         actor: actor_id
 272       })
 273     else
 274       e ->
 275         Logger.error(e)
 276         :error
 277     end
 278   end
 279
 280   # TODO: Make secure.
 281   def handle_incoming(
 282         %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
 283       ) do
 284     object_id = Utils.get_ap_id(object_id)
 285
 286     with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
 287          {:ok, object} <-
 288            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 289          {:ok, activity} <- ActivityPub.delete(object, false) do
 290       {:ok, activity}
 291     else
 292       _e -> :error
 293     end
 294   end
 295
 296   def handle_incoming(
 297         %{
 298           "type" => "Undo",
 299           "object" => %{"type" => "Announce", "object" => object_id},
 300           "actor" => actor,
 301           "id" => id
 302         } = _data
 303       ) do
 304     with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
 305          {:ok, object} <-
 306            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 307          {:ok, activity, _, _} <- ActivityPub.unannounce(actor, object, id, false) do
 308       {:ok, activity}
 309     else
 310       _e -> :error
 311     end
 312   end
 313
 314   def handle_incoming(
 315         %{
 316           "type" => "Undo",
 317           "object" => %{"type" => "Follow", "object" => followed},
 318           "actor" => follower,
 319           "id" => id
 320         } = _data
 321       ) do
 322     with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
 323          %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
 324          {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
 325       User.unfollow(follower, followed)
 326       {:ok, activity}
 327     else
 328       e -> :error
 329     end
 330   end
 331
 332   @ap_config Application.get_env(:pleroma, :activitypub)
 333   @accept_blocks Keyword.get(@ap_config, :accept_blocks)
 334
 335   def handle_incoming(
 336         %{
 337           "type" => "Undo",
 338           "object" => %{"type" => "Block", "object" => blocked},
 339           "actor" => blocker,
 340           "id" => id
 341         } = _data
 342       ) do
 343     with true <- @accept_blocks,
 344          %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
 345          %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
 346          {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
 347       User.unblock(blocker, blocked)
 348       {:ok, activity}
 349     else
 350       e -> :error
 351     end
 352   end
 353
 354   def handle_incoming(
 355         %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
 356       ) do
 357     with true <- @accept_blocks,
 358          %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
 359          %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
 360          {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
 361       User.unfollow(blocker, blocked)
 362       User.block(blocker, blocked)
 363       {:ok, activity}
 364     else
 365       e -> :error
 366     end
 367   end
 368
 369   def handle_incoming(
 370         %{
 371           "type" => "Undo",
 372           "object" => %{"type" => "Like", "object" => object_id},
 373           "actor" => actor,
 374           "id" => id
 375         } = _data
 376       ) do
 377     with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
 378          {:ok, object} <-
 379            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 380          {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
 381       {:ok, activity}
 382     else
 383       _e -> :error
 384     end
 385   end
 386
 387   def handle_incoming(_), do: :error
 388
 389   def get_obj_helper(id) do
 390     if object = Object.get_by_ap_id(id), do: {:ok, object}, else: nil
 391   end
 392
 393   def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
 394     with false <- String.starts_with?(inReplyTo, "http"),
 395          {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
 396       Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
 397     else
 398       _e -> object
 399     end
 400   end
 401
 402   def set_reply_to_uri(obj), do: obj
 403
 404   # Prepares the object of an outgoing create activity.
 405   def prepare_object(object) do
 406     object
 407     |> set_sensitive
 408     |> add_hashtags
 409     |> add_mention_tags
 410     |> add_emoji_tags
 411     |> add_attributed_to
 412     |> prepare_attachments
 413     |> set_conversation
 414     |> set_reply_to_uri
 415   end
 416
 417   #  @doc
 418   #  """
 419   #  internal -> Mastodon
 420   #  """
 421
 422   def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
 423     object =
 424       object
 425       |> prepare_object
 426
 427     data =
 428       data
 429       |> Map.put("object", object)
 430       |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
 431
 432     {:ok, data}
 433   end
 434
 435   def prepare_outgoing(%{"type" => _type} = data) do
 436     data =
 437       data
 438       |> maybe_fix_object_url
 439       |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
 440
 441     {:ok, data}
 442   end
 443
 444   def maybe_fix_object_url(data) do
 445     if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
 446       case ActivityPub.fetch_object_from_id(data["object"]) do
 447         {:ok, relative_object} ->
 448           if relative_object.data["external_url"] do
 449             _data =
 450               data
 451               |> Map.put("object", relative_object.data["external_url"])
 452           else
 453             data
 454           end
 455
 456         e ->
 457           Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
 458           data
 459       end
 460     else
 461       data
 462     end
 463   end
 464
 465   def add_hashtags(object) do
 466     tags =
 467       (object["tag"] || [])
 468       |> Enum.map(fn tag ->
 469         %{
 470           "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
 471           "name" => "##{tag}",
 472           "type" => "Hashtag"
 473         }
 474       end)
 475
 476     object
 477     |> Map.put("tag", tags)
 478   end
 479
 480   def add_mention_tags(object) do
 481     recipients = object["to"] ++ (object["cc"] || [])
 482
 483     mentions =
 484       recipients
 485       |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
 486       |> Enum.filter(& &1)
 487       |> Enum.map(fn user ->
 488         %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
 489       end)
 490
 491     tags = object["tag"] || []
 492
 493     object
 494     |> Map.put("tag", tags ++ mentions)
 495   end
 496
 497   # TODO: we should probably send mtime instead of unix epoch time for updated
 498   def add_emoji_tags(object) do
 499     tags = object["tag"] || []
 500     emoji = object["emoji"] || []
 501
 502     out =
 503       emoji
 504       |> Enum.map(fn {name, url} ->
 505         %{
 506           "icon" => %{"url" => url, "type" => "Image"},
 507           "name" => ":" <> name <> ":",
 508           "type" => "Emoji",
 509           "updated" => "1970-01-01T00:00:00Z",
 510           "id" => url
 511         }
 512       end)
 513
 514     object
 515     |> Map.put("tag", tags ++ out)
 516   end
 517
 518   def set_conversation(object) do
 519     Map.put(object, "conversation", object["context"])
 520   end
 521
 522   def set_sensitive(object) do
 523     tags = object["tag"] || []
 524     Map.put(object, "sensitive", "nsfw" in tags)
 525   end
 526
 527   def add_attributed_to(object) do
 528     attributedTo = object["attributedTo"] || object["actor"]
 529
 530     object
 531     |> Map.put("attributedTo", attributedTo)
 532   end
 533
 534   def prepare_attachments(object) do
 535     attachments =
 536       (object["attachment"] || [])
 537       |> Enum.map(fn data ->
 538         [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
 539         %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
 540       end)
 541
 542     object
 543     |> Map.put("attachment", attachments)
 544   end
 545
 546   defp user_upgrade_task(user) do
 547     old_follower_address = User.ap_followers(user)
 548
 549     q =
 550       from(
 551         u in User,
 552         where: ^old_follower_address in u.following,
 553         update: [
 554           set: [
 555             following:
 556               fragment(
 557                 "array_replace(?,?,?)",
 558                 u.following,
 559                 ^old_follower_address,
 560                 ^user.follower_address
 561               )
 562           ]
 563         ]
 564       )
 565
 566     Repo.update_all(q, [])
 567
 568     maybe_retire_websub(user.ap_id)
 569
 570     # Only do this for recent activties, don't go through the whole db.
 571     # Only look at the last 1000 activities.
 572     since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
 573
 574     q =
 575       from(
 576         a in Activity,
 577         where: ^old_follower_address in a.recipients,
 578         where: a.id > ^since,
 579         update: [
 580           set: [
 581             recipients:
 582               fragment(
 583                 "array_replace(?,?,?)",
 584                 a.recipients,
 585                 ^old_follower_address,
 586                 ^user.follower_address
 587               )
 588           ]
 589         ]
 590       )
 591
 592     Repo.update_all(q, [])
 593   end
 594
 595   def upgrade_user_from_ap_id(ap_id, async \\ true) do
 596     with %User{local: false} = user <- User.get_by_ap_id(ap_id),
 597          {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
 598       data =
 599         data
 600         |> Map.put(:info, Map.merge(user.info, data[:info]))
 601
 602       already_ap = User.ap_enabled?(user)
 603
 604       {:ok, user} =
 605         User.upgrade_changeset(user, data)
 606         |> Repo.update()
 607
 608       if !already_ap do
 609         # This could potentially take a long time, do it in the background
 610         if async do
 611           Task.start(fn ->
 612             user_upgrade_task(user)
 613           end)
 614         else
 615           user_upgrade_task(user)
 616         end
 617       end
 618
 619       {:ok, user}
 620     else
 621       e -> e
 622     end
 623   end
 624
 625   def maybe_retire_websub(ap_id) do
 626     # some sanity checks
 627     if is_binary(ap_id) && String.length(ap_id) > 8 do
 628       q =
 629         from(
 630           ws in Pleroma.Web.Websub.WebsubClientSubscription,
 631           where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
 632         )
 633
 634       Repo.delete_all(q)
 635     end
 636   end
 637
 638   def maybe_fix_user_url(data) do
 639     if is_map(data["url"]) do
 640       Map.put(data, "url", data["url"]["href"])
 641     else
 642       data
 643     end
 644   end
 645
 646   def maybe_fix_user_object(data) do
 647     data
 648     |> maybe_fix_user_url
 649   end
 650 end