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       if not User.locked?(followed) do
 141         ActivityPub.accept(%{
 142           to: [follower.ap_id],
 143           actor: followed.ap_id,
 144           object: data,
 145           local: true
 146         })
 147
 148         User.follow(follower, followed)
 149       end
 150
 151       {:ok, activity}
 152     else
 153       _e -> :error
 154     end
 155   end
 156
 157   defp mastodon_follow_hack(%{"id" => id, "actor" => follower_id}, followed) do
 158     with true <- id =~ "follows",
 159          %User{local: true} = follower <- User.get_cached_by_ap_id(follower_id),
 160          %Activity{} = activity <- Utils.fetch_latest_follow(follower, followed) do
 161       {:ok, activity}
 162     else
 163       _ -> {:error, nil}
 164     end
 165   end
 166
 167   defp mastodon_follow_hack(_), do: {:error, nil}
 168
 169   defp get_follow_activity(follow_object, followed) do
 170     with object_id when not is_nil(object_id) <- Utils.get_ap_id(follow_object),
 171          {_, %Activity{} = activity} <- {:activity, Activity.get_by_ap_id(object_id)} do
 172       {:ok, activity}
 173     else
 174       # Can't find the activity. This might a Mastodon 2.3 "Accept"
 175       {:activity, nil} ->
 176         mastodon_follow_hack(follow_object, followed)
 177
 178       _ ->
 179         {:error, nil}
 180     end
 181   end
 182
 183   def handle_incoming(
 184         %{"type" => "Accept", "object" => follow_object, "actor" => actor, "id" => id} = data
 185       ) do
 186     with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
 187          {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
 188          %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
 189          {:ok, activity} <-
 190            ActivityPub.accept(%{
 191              to: follow_activity.data["to"],
 192              type: "Accept",
 193              actor: followed.ap_id,
 194              object: follow_activity.data["id"],
 195              local: false
 196            }) do
 197       if not User.following?(follower, followed) do
 198         {:ok, follower} = User.follow(follower, followed)
 199       end
 200
 201       {:ok, activity}
 202     else
 203       _e -> :error
 204     end
 205   end
 206
 207   def handle_incoming(
 208         %{"type" => "Reject", "object" => follow_object, "actor" => actor, "id" => id} = data
 209       ) do
 210     with %User{} = followed <- User.get_or_fetch_by_ap_id(actor),
 211          {:ok, follow_activity} <- get_follow_activity(follow_object, followed),
 212          %User{local: true} = follower <- User.get_cached_by_ap_id(follow_activity.data["actor"]),
 213          {:ok, activity} <-
 214            ActivityPub.accept(%{
 215              to: follow_activity.data["to"],
 216              type: "Accept",
 217              actor: followed.ap_id,
 218              object: follow_activity.data["id"],
 219              local: false
 220            }) do
 221       User.unfollow(follower, followed)
 222
 223       {:ok, activity}
 224     else
 225       _e -> :error
 226     end
 227   end
 228
 229   def handle_incoming(
 230         %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
 231       ) do
 232     with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
 233          {:ok, object} <-
 234            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 235          {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
 236       {:ok, activity}
 237     else
 238       _e -> :error
 239     end
 240   end
 241
 242   def handle_incoming(
 243         %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
 244       ) do
 245     with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
 246          {:ok, object} <-
 247            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 248          {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
 249       {:ok, activity}
 250     else
 251       _e -> :error
 252     end
 253   end
 254
 255   def handle_incoming(
 256         %{"type" => "Update", "object" => %{"type" => "Person"} = object, "actor" => actor_id} =
 257           data
 258       ) do
 259     with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
 260       {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)
 261
 262       banner = new_user_data[:info]["banner"]
 263       locked = new_user_data[:info]["locked"] || false
 264
 265       update_data =
 266         new_user_data
 267         |> Map.take([:name, :bio, :avatar])
 268         |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner, "locked" => locked}))
 269
 270       actor
 271       |> User.upgrade_changeset(update_data)
 272       |> User.update_and_set_cache()
 273
 274       ActivityPub.update(%{
 275         local: false,
 276         to: data["to"] || [],
 277         cc: data["cc"] || [],
 278         object: object,
 279         actor: actor_id
 280       })
 281     else
 282       e ->
 283         Logger.error(e)
 284         :error
 285     end
 286   end
 287
 288   # TODO: Make secure.
 289   def handle_incoming(
 290         %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
 291       ) do
 292     object_id = Utils.get_ap_id(object_id)
 293
 294     with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
 295          {:ok, object} <-
 296            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 297          {:ok, activity} <- ActivityPub.delete(object, false) do
 298       {:ok, activity}
 299     else
 300       _e -> :error
 301     end
 302   end
 303
 304   def handle_incoming(
 305         %{
 306           "type" => "Undo",
 307           "object" => %{"type" => "Announce", "object" => object_id},
 308           "actor" => actor,
 309           "id" => id
 310         } = _data
 311       ) do
 312     with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
 313          {:ok, object} <-
 314            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 315          {:ok, activity, _, _} <- ActivityPub.unannounce(actor, object, id, false) do
 316       {:ok, activity}
 317     else
 318       _e -> :error
 319     end
 320   end
 321
 322   def handle_incoming(
 323         %{
 324           "type" => "Undo",
 325           "object" => %{"type" => "Follow", "object" => followed},
 326           "actor" => follower,
 327           "id" => id
 328         } = _data
 329       ) do
 330     with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
 331          %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
 332          {:ok, activity} <- ActivityPub.unfollow(follower, followed, id, false) do
 333       User.unfollow(follower, followed)
 334       {:ok, activity}
 335     else
 336       e -> :error
 337     end
 338   end
 339
 340   @ap_config Application.get_env(:pleroma, :activitypub)
 341   @accept_blocks Keyword.get(@ap_config, :accept_blocks)
 342
 343   def handle_incoming(
 344         %{
 345           "type" => "Undo",
 346           "object" => %{"type" => "Block", "object" => blocked},
 347           "actor" => blocker,
 348           "id" => id
 349         } = _data
 350       ) do
 351     with true <- @accept_blocks,
 352          %User{local: true} = blocked <- User.get_cached_by_ap_id(blocked),
 353          %User{} = blocker <- User.get_or_fetch_by_ap_id(blocker),
 354          {:ok, activity} <- ActivityPub.unblock(blocker, blocked, id, false) do
 355       User.unblock(blocker, blocked)
 356       {:ok, activity}
 357     else
 358       e -> :error
 359     end
 360   end
 361
 362   def handle_incoming(
 363         %{"type" => "Block", "object" => blocked, "actor" => blocker, "id" => id} = data
 364       ) do
 365     with true <- @accept_blocks,
 366          %User{local: true} = blocked = User.get_cached_by_ap_id(blocked),
 367          %User{} = blocker = User.get_or_fetch_by_ap_id(blocker),
 368          {:ok, activity} <- ActivityPub.block(blocker, blocked, id, false) do
 369       User.unfollow(blocker, blocked)
 370       User.block(blocker, blocked)
 371       {:ok, activity}
 372     else
 373       e -> :error
 374     end
 375   end
 376
 377   def handle_incoming(
 378         %{
 379           "type" => "Undo",
 380           "object" => %{"type" => "Like", "object" => object_id},
 381           "actor" => actor,
 382           "id" => id
 383         } = _data
 384       ) do
 385     with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
 386          {:ok, object} <-
 387            get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
 388          {:ok, activity, _, _} <- ActivityPub.unlike(actor, object, id, false) do
 389       {:ok, activity}
 390     else
 391       _e -> :error
 392     end
 393   end
 394
 395   def handle_incoming(_), do: :error
 396
 397   def get_obj_helper(id) do
 398     if object = Object.get_by_ap_id(id), do: {:ok, object}, else: nil
 399   end
 400
 401   def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
 402     with false <- String.starts_with?(inReplyTo, "http"),
 403          {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
 404       Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
 405     else
 406       _e -> object
 407     end
 408   end
 409
 410   def set_reply_to_uri(obj), do: obj
 411
 412   # Prepares the object of an outgoing create activity.
 413   def prepare_object(object) do
 414     object
 415     |> set_sensitive
 416     |> add_hashtags
 417     |> add_mention_tags
 418     |> add_emoji_tags
 419     |> add_attributed_to
 420     |> prepare_attachments
 421     |> set_conversation
 422     |> set_reply_to_uri
 423   end
 424
 425   #  @doc
 426   #  """
 427   #  internal -> Mastodon
 428   #  """
 429
 430   def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
 431     object =
 432       object
 433       |> prepare_object
 434
 435     data =
 436       data
 437       |> Map.put("object", object)
 438       |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
 439
 440     {:ok, data}
 441   end
 442
 443   # Mastodon Accept/Reject requires a non-normalized object containing the actor URIs,
 444   # because of course it does.
 445   def prepare_outgoing(%{"type" => "Accept"} = data) do
 446     follow_activity_id =
 447       if is_binary(data["object"]) do
 448         data["object"]
 449       else
 450         data["object"]["id"]
 451       end
 452
 453     with follow_activity <- Activity.get_by_ap_id(follow_activity_id) do
 454       object = %{
 455         "actor" => follow_activity.actor,
 456         "object" => follow_activity.data["object"],
 457         "id" => follow_activity.data["id"],
 458         "type" => "Follow"
 459       }
 460
 461       data =
 462         data
 463         |> Map.put("object", object)
 464         |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
 465
 466       {:ok, data}
 467     end
 468   end
 469
 470   def prepare_outgoing(%{"type" => "Reject"} = data) do
 471     follow_activity_id =
 472       if is_binary(data["object"]) do
 473         data["object"]
 474       else
 475         data["object"]["id"]
 476       end
 477
 478     with follow_activity <- Activity.get_by_ap_id(follow_activity_id) do
 479       object = %{
 480         "actor" => follow_activity.actor,
 481         "object" => follow_activity.data["object"],
 482         "id" => follow_activity.data["id"],
 483         "type" => "Follow"
 484       }
 485
 486       data =
 487         data
 488         |> Map.put("object", object)
 489         |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
 490
 491       {:ok, data}
 492     end
 493   end
 494
 495   def prepare_outgoing(%{"type" => _type} = data) do
 496     data =
 497       data
 498       |> maybe_fix_object_url
 499       |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
 500
 501     {:ok, data}
 502   end
 503
 504   def maybe_fix_object_url(data) do
 505     if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
 506       case ActivityPub.fetch_object_from_id(data["object"]) do
 507         {:ok, relative_object} ->
 508           if relative_object.data["external_url"] do
 509             _data =
 510               data
 511               |> Map.put("object", relative_object.data["external_url"])
 512           else
 513             data
 514           end
 515
 516         e ->
 517           Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
 518           data
 519       end
 520     else
 521       data
 522     end
 523   end
 524
 525   def add_hashtags(object) do
 526     tags =
 527       (object["tag"] || [])
 528       |> Enum.map(fn tag ->
 529         %{
 530           "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
 531           "name" => "##{tag}",
 532           "type" => "Hashtag"
 533         }
 534       end)
 535
 536     object
 537     |> Map.put("tag", tags)
 538   end
 539
 540   def add_mention_tags(object) do
 541     recipients = object["to"] ++ (object["cc"] || [])
 542
 543     mentions =
 544       recipients
 545       |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
 546       |> Enum.filter(& &1)
 547       |> Enum.map(fn user ->
 548         %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
 549       end)
 550
 551     tags = object["tag"] || []
 552
 553     object
 554     |> Map.put("tag", tags ++ mentions)
 555   end
 556
 557   # TODO: we should probably send mtime instead of unix epoch time for updated
 558   def add_emoji_tags(object) do
 559     tags = object["tag"] || []
 560     emoji = object["emoji"] || []
 561
 562     out =
 563       emoji
 564       |> Enum.map(fn {name, url} ->
 565         %{
 566           "icon" => %{"url" => url, "type" => "Image"},
 567           "name" => ":" <> name <> ":",
 568           "type" => "Emoji",
 569           "updated" => "1970-01-01T00:00:00Z",
 570           "id" => url
 571         }
 572       end)
 573
 574     object
 575     |> Map.put("tag", tags ++ out)
 576   end
 577
 578   def set_conversation(object) do
 579     Map.put(object, "conversation", object["context"])
 580   end
 581
 582   def set_sensitive(object) do
 583     tags = object["tag"] || []
 584     Map.put(object, "sensitive", "nsfw" in tags)
 585   end
 586
 587   def add_attributed_to(object) do
 588     attributedTo = object["attributedTo"] || object["actor"]
 589
 590     object
 591     |> Map.put("attributedTo", attributedTo)
 592   end
 593
 594   def prepare_attachments(object) do
 595     attachments =
 596       (object["attachment"] || [])
 597       |> Enum.map(fn data ->
 598         [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
 599         %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
 600       end)
 601
 602     object
 603     |> Map.put("attachment", attachments)
 604   end
 605
 606   defp user_upgrade_task(user) do
 607     old_follower_address = User.ap_followers(user)
 608
 609     q =
 610       from(
 611         u in User,
 612         where: ^old_follower_address in u.following,
 613         update: [
 614           set: [
 615             following:
 616               fragment(
 617                 "array_replace(?,?,?)",
 618                 u.following,
 619                 ^old_follower_address,
 620                 ^user.follower_address
 621               )
 622           ]
 623         ]
 624       )
 625
 626     Repo.update_all(q, [])
 627
 628     maybe_retire_websub(user.ap_id)
 629
 630     # Only do this for recent activties, don't go through the whole db.
 631     # Only look at the last 1000 activities.
 632     since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
 633
 634     q =
 635       from(
 636         a in Activity,
 637         where: ^old_follower_address in a.recipients,
 638         where: a.id > ^since,
 639         update: [
 640           set: [
 641             recipients:
 642               fragment(
 643                 "array_replace(?,?,?)",
 644                 a.recipients,
 645                 ^old_follower_address,
 646                 ^user.follower_address
 647               )
 648           ]
 649         ]
 650       )
 651
 652     Repo.update_all(q, [])
 653   end
 654
 655   def upgrade_user_from_ap_id(ap_id, async \\ true) do
 656     with %User{local: false} = user <- User.get_by_ap_id(ap_id),
 657          {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
 658       data =
 659         data
 660         |> Map.put(:info, Map.merge(user.info, data[:info]))
 661
 662       already_ap = User.ap_enabled?(user)
 663
 664       {:ok, user} =
 665         User.upgrade_changeset(user, data)
 666         |> Repo.update()
 667
 668       if !already_ap do
 669         # This could potentially take a long time, do it in the background
 670         if async do
 671           Task.start(fn ->
 672             user_upgrade_task(user)
 673           end)
 674         else
 675           user_upgrade_task(user)
 676         end
 677       end
 678
 679       {:ok, user}
 680     else
 681       e -> e
 682     end
 683   end
 684
 685   def maybe_retire_websub(ap_id) do
 686     # some sanity checks
 687     if is_binary(ap_id) && String.length(ap_id) > 8 do
 688       q =
 689         from(
 690           ws in Pleroma.Web.Websub.WebsubClientSubscription,
 691           where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
 692         )
 693
 694       Repo.delete_all(q)
 695     end
 696   end
 697
 698   def maybe_fix_user_url(data) do
 699     if is_map(data["url"]) do
 700       Map.put(data, "url", data["url"]["href"])
 701     else
 702       data
 703     end
 704   end
 705
 706   def maybe_fix_user_object(data) do
 707     data
 708     |> maybe_fix_user_url
 709   end
 710 end