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