transmogrifier.ex 12.2 KB
Newer Older
1
2
3
4
5
defmodule Pleroma.Web.ActivityPub.Transmogrifier do
  @moduledoc """
  A module to handle coding from internal to wire ActivityPub and back.
  """
  alias Pleroma.User
lain's avatar
lain committed
6
  alias Pleroma.Object
7
  alias Pleroma.Activity
lain's avatar
lain committed
8
  alias Pleroma.Repo
9
10
  alias Pleroma.Web.ActivityPub.ActivityPub

lain's avatar
lain committed
11
12
  import Ecto.Query

13
14
  require Logger

15
16
17
18
19
20
  @doc """
  Modifies an incoming AP object (mastodon format) to our internal format.
  """
  def fix_object(object) do
    object
    |> Map.put("actor", object["attributedTo"])
lain's avatar
lain committed
21
    |> fix_attachments
lain's avatar
lain committed
22
    |> fix_context
lain's avatar
lain committed
23
    |> fix_in_reply_to
lain's avatar
lain committed
24
    |> fix_emoji
25
    |> fix_tag
lain's avatar
lain committed
26
27
  end

lain's avatar
lain committed
28
29
  def fix_in_reply_to(%{"inReplyTo" => in_reply_to_id} = object)
      when not is_nil(in_reply_to_id) do
lain's avatar
lain committed
30
    case ActivityPub.fetch_object_from_id(in_reply_to_id) do
lain's avatar
lain committed
31
32
      {:ok, replied_object} ->
        activity = Activity.get_create_activity_by_object_ap_id(replied_object.data["id"])
lain's avatar
lain committed
33

lain's avatar
lain committed
34
35
36
37
        object
        |> Map.put("inReplyTo", replied_object.data["id"])
        |> Map.put("inReplyToAtomUri", object["inReplyToAtomUri"] || in_reply_to_id)
        |> Map.put("inReplyToStatusId", activity.id)
lain's avatar
lain committed
38
39
        |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
        |> Map.put("context", replied_object.data["context"] || object["conversation"])
lain's avatar
lain committed
40

lain's avatar
lain committed
41
42
43
44
45
      e ->
        Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
        object
    end
  end
lain's avatar
lain committed
46

lain's avatar
lain committed
47
48
  def fix_in_reply_to(object), do: object

lain's avatar
lain committed
49
50
51
  def fix_context(object) do
    object
    |> Map.put("context", object["conversation"])
lain's avatar
lain committed
52
53
54
  end

  def fix_attachments(object) do
lain's avatar
lain committed
55
56
57
58
59
60
    attachments =
      (object["attachment"] || [])
      |> Enum.map(fn data ->
        url = [%{"type" => "Link", "mediaType" => data["mediaType"], "href" => data["url"]}]
        Map.put(data, "url", url)
      end)
lain's avatar
lain committed
61
62
63

    object
    |> Map.put("attachment", attachments)
64
65
  end

lain's avatar
lain committed
66
  def fix_emoji(object) do
lain's avatar
lain committed
67
68
69
70
71
72
73
74
75
76
77
    tags = object["tag"] || []
    emoji = tags |> Enum.filter(fn data -> data["type"] == "Emoji" and data["icon"] end)

    emoji =
      emoji
      |> Enum.reduce(%{}, fn data, mapping ->
        name = data["name"]

        if String.starts_with?(name, ":") do
          name = name |> String.slice(1..-2)
        end
lain's avatar
lain committed
78

lain's avatar
lain committed
79
80
        mapping |> Map.put(name, data["icon"]["url"])
      end)
lain's avatar
lain committed
81
82
83
84
85
86
87
88

    # we merge mastodon and pleroma emoji into a single mapping, to allow for both wire formats
    emoji = Map.merge(object["emoji"] || %{}, emoji)

    object
    |> Map.put("emoji", emoji)
  end

89
  def fix_tag(object) do
lain's avatar
lain committed
90
91
92
93
    tags =
      (object["tag"] || [])
      |> Enum.filter(fn data -> data["type"] == "Hashtag" and data["name"] end)
      |> Enum.map(fn data -> String.slice(data["name"], 1..-1) end)
94
95
96
97
98
99
100

    combined = (object["tag"] || []) ++ tags

    object
    |> Map.put("tag", combined)
  end

101
102
103
104
  # TODO: validate those with a Ecto scheme
  # - tags
  # - emoji
  def handle_incoming(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
lain's avatar
lain committed
105
106
    with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
         %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
107
      object = fix_object(data["object"])
108

109
110
111
112
      params = %{
        to: data["to"],
        object: object,
        actor: user,
lain's avatar
lain committed
113
        context: object["conversation"],
114
115
        local: false,
        published: data["published"],
lain's avatar
lain committed
116
117
118
119
120
        additional:
          Map.take(data, [
            "cc",
            "id"
          ])
121
122
123
124
      }

      ActivityPub.create(params)
    else
lain's avatar
lain committed
125
      %Activity{} = activity -> {:ok, activity}
126
127
128
129
      _e -> :error
    end
  end

lain's avatar
lain committed
130
131
132
  def handle_incoming(
        %{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data
      ) do
133
    with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
134
135
         %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
         {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
136
      ActivityPub.accept(%{to: [follower.ap_id], actor: followed.ap_id, object: data, local: true})
lain's avatar
lain committed
137

138
139
140
141
142
143
144
      User.follow(follower, followed)
      {:ok, activity}
    else
      _e -> :error
    end
  end

lain's avatar
lain committed
145
  def handle_incoming(
feld's avatar
feld committed
146
        %{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = _data
lain's avatar
lain committed
147
      ) do
lain's avatar
lain committed
148
    with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
lain's avatar
lain committed
149
150
         {:ok, object} <-
           get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
feld's avatar
feld committed
151
         {:ok, activity, _object} <- ActivityPub.like(actor, object, id, false) do
lain's avatar
lain committed
152
153
154
155
156
157
      {:ok, activity}
    else
      _e -> :error
    end
  end

lain's avatar
lain committed
158
  def handle_incoming(
feld's avatar
feld committed
159
        %{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = _data
lain's avatar
lain committed
160
      ) do
lain's avatar
lain committed
161
    with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
lain's avatar
lain committed
162
163
         {:ok, object} <-
           get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
feld's avatar
feld committed
164
         {:ok, activity, _object} <- ActivityPub.announce(actor, object, id, false) do
lain's avatar
lain committed
165
166
167
168
169
170
      {:ok, activity}
    else
      _e -> :error
    end
  end

lain's avatar
lain committed
171
172
173
174
  def handle_incoming(
        %{"type" => "Update", "object" => %{"type" => "Person"} = object, "actor" => actor_id} =
          data
      ) do
lain's avatar
lain committed
175
176
177
178
    with %User{ap_id: ^actor_id} = actor <- User.get_by_ap_id(object["id"]) do
      {:ok, new_user_data} = ActivityPub.user_data_from_user_object(object)

      banner = new_user_data[:info]["banner"]
lain's avatar
lain committed
179
180
181
182
183

      update_data =
        new_user_data
        |> Map.take([:name, :bio, :avatar])
        |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner}))
lain's avatar
lain committed
184
185
186

      actor
      |> User.upgrade_changeset(update_data)
lain's avatar
lain committed
187
      |> User.update_and_set_cache()
lain's avatar
lain committed
188

lain's avatar
lain committed
189
190
191
192
193
194
195
      ActivityPub.update(%{
        local: false,
        to: data["to"] || [],
        cc: data["cc"] || [],
        object: object,
        actor: actor_id
      })
lain's avatar
lain committed
196
197
198
199
200
201
202
    else
      e ->
        Logger.error(e)
        :error
    end
  end

lain's avatar
lain committed
203
  # TODO: Make secure.
lain's avatar
lain committed
204
  def handle_incoming(
feld's avatar
feld committed
205
        %{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => _id} = _data
lain's avatar
lain committed
206
207
208
209
210
211
212
      ) do
    object_id =
      case object_id do
        %{"id" => id} -> id
        id -> id
      end

feld's avatar
feld committed
213
    with %User{} = _actor <- User.get_or_fetch_by_ap_id(actor),
lain's avatar
lain committed
214
215
         {:ok, object} <-
           get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
lain's avatar
lain committed
216
217
218
         {:ok, activity} <- ActivityPub.delete(object, false) do
      {:ok, activity}
    else
feld's avatar
feld committed
219
      _e -> :error
lain's avatar
lain committed
220
221
222
    end
  end

lain's avatar
lain committed
223
224
225
226
  # TODO
  # Accept
  # Undo

227
228
  def handle_incoming(_), do: :error

229
230
231
232
  def get_obj_helper(id) do
    if object = Object.get_by_ap_id(id), do: {:ok, object}, else: nil
  end

233
234
235
236
237
238
239
240
  def set_reply_to_uri(%{"inReplyTo" => inReplyTo} = object) do
    with false <- String.starts_with?(inReplyTo, "http"),
         {:ok, %{data: replied_to_object}} <- get_obj_helper(inReplyTo) do
      Map.put(object, "inReplyTo", replied_to_object["external_url"] || inReplyTo)
    else
      _e -> object
    end
  end
lain's avatar
lain committed
241

242
243
244
  def set_reply_to_uri(obj), do: obj

  # Prepares the object of an outgoing create activity.
lain's avatar
lain committed
245
246
  def prepare_object(object) do
    object
lain's avatar
lain committed
247
    |> set_sensitive
lain's avatar
lain committed
248
    |> add_hashtags
lain's avatar
lain committed
249
    |> add_mention_tags
lain's avatar
lain committed
250
    |> add_emoji_tags
lain's avatar
lain committed
251
    |> add_attributed_to
lain's avatar
lain committed
252
    |> prepare_attachments
lain's avatar
lain committed
253
    |> set_conversation
254
    |> set_reply_to_uri
lain's avatar
lain committed
255
256
  end

257
258
259
260
#  @doc
#  """
#  internal -> Mastodon
#  """
lain's avatar
lain committed
261

lain's avatar
lain committed
262
  def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
lain's avatar
lain committed
263
264
265
266
267
268
269
270
    object =
      object
      |> prepare_object

    data =
      data
      |> Map.put("object", object)
      |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
lain's avatar
lain committed
271
272
273
274

    {:ok, data}
  end

feld's avatar
feld committed
275
  def prepare_outgoing(%{"type" => _type} = data) do
lain's avatar
lain committed
276
277
278
279
    data =
      data
      |> maybe_fix_object_url
      |> Map.put("@context", "https://www.w3.org/ns/activitystreams")
280
281
282
283

    {:ok, data}
  end

284
285
286
287
288
  def maybe_fix_object_url(data) do
    if is_binary(data["object"]) and not String.starts_with?(data["object"], "http") do
      case ActivityPub.fetch_object_from_id(data["object"]) do
        {:ok, relative_object} ->
          if relative_object.data["external_url"] do
feld's avatar
feld committed
289
            _data =
lain's avatar
lain committed
290
291
              data
              |> Map.put("object", relative_object.data["external_url"])
292
293
294
          else
            data
          end
lain's avatar
lain committed
295

296
297
298
299
300
301
302
303
304
        e ->
          Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
          data
      end
    else
      data
    end
  end

lain's avatar
lain committed
305
  def add_hashtags(object) do
lain's avatar
lain committed
306
307
308
309
310
311
312
313
314
    tags =
      (object["tag"] || [])
      |> Enum.map(fn tag ->
        %{
          "href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}",
          "name" => "##{tag}",
          "type" => "Hashtag"
        }
      end)
lain's avatar
lain committed
315
316
317
318
319

    object
    |> Map.put("tag", tags)
  end

lain's avatar
lain committed
320
  def add_mention_tags(object) do
lain's avatar
lain committed
321
    recipients = object["to"] ++ (object["cc"] || [])
lain's avatar
lain committed
322
323
324
325
326
327
328
329

    mentions =
      recipients
      |> Enum.map(fn ap_id -> User.get_cached_by_ap_id(ap_id) end)
      |> Enum.filter(& &1)
      |> Enum.map(fn user ->
        %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"}
      end)
lain's avatar
lain committed
330

lain's avatar
lain committed
331
    tags = object["tag"] || []
lain's avatar
lain committed
332
333

    object
lain's avatar
lain committed
334
    |> Map.put("tag", tags ++ mentions)
lain's avatar
lain committed
335
336
  end

lain's avatar
lain committed
337
338
339
340
  # TODO: we should probably send mtime instead of unix epoch time for updated
  def add_emoji_tags(object) do
    tags = object["tag"] || []
    emoji = object["emoji"] || []
lain's avatar
lain committed
341
342
343
344
345
346
347
348
349
350
351
352

    out =
      emoji
      |> Enum.map(fn {name, url} ->
        %{
          "icon" => %{"url" => url, "type" => "Image"},
          "name" => ":" <> name <> ":",
          "type" => "Emoji",
          "updated" => "1970-01-01T00:00:00Z",
          "id" => url
        }
      end)
lain's avatar
lain committed
353
354
355
356
357

    object
    |> Map.put("tag", tags ++ out)
  end

lain's avatar
lain committed
358
359
360
361
  def set_conversation(object) do
    Map.put(object, "conversation", object["context"])
  end

lain's avatar
lain committed
362
363
364
365
366
  def set_sensitive(object) do
    tags = object["tag"] || []
    Map.put(object, "sensitive", "nsfw" in tags)
  end

lain's avatar
lain committed
367
368
369
370
371
  def add_attributed_to(object) do
    attributedTo = object["attributedTo"] || object["actor"]

    object
    |> Map.put("attributedTo", attributedTo)
372
  end
lain's avatar
lain committed
373
374

  def prepare_attachments(object) do
lain's avatar
lain committed
375
376
377
378
379
380
    attachments =
      (object["attachment"] || [])
      |> Enum.map(fn data ->
        [%{"mediaType" => media_type, "href" => href} | _] = data["url"]
        %{"url" => href, "mediaType" => media_type, "name" => data["name"], "type" => "Document"}
      end)
lain's avatar
lain committed
381
382
383
384

    object
    |> Map.put("attachment", attachments)
  end
lain's avatar
lain committed
385

lain's avatar
lain committed
386
387
  defp user_upgrade_task(user) do
    old_follower_address = User.ap_followers(user)
lain's avatar
lain committed
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405

    q =
      from(
        u in User,
        where: ^old_follower_address in u.following,
        update: [
          set: [
            following:
              fragment(
                "array_replace(?,?,?)",
                u.following,
                ^old_follower_address,
                ^user.follower_address
              )
          ]
        ]
      )

lain's avatar
lain committed
406
407
    Repo.update_all(q, [])

408
409
    maybe_retire_websub(user.ap_id)

lain's avatar
lain committed
410
    # Only do this for recent activties, don't go through the whole db.
lain's avatar
lain committed
411
412
    # Only look at the last 1000 activities.
    since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
lain's avatar
lain committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431

    q =
      from(
        a in Activity,
        where: ^old_follower_address in a.recipients,
        where: a.id > ^since,
        update: [
          set: [
            recipients:
              fragment(
                "array_replace(?,?,?)",
                a.recipients,
                ^old_follower_address,
                ^user.follower_address
              )
          ]
        ]
      )

lain's avatar
lain committed
432
433
434
435
    Repo.update_all(q, [])
  end

  def upgrade_user_from_ap_id(ap_id, async \\ true) do
436
    with %User{local: false} = user <- User.get_by_ap_id(ap_id),
lain's avatar
lain committed
437
         {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
lain's avatar
lain committed
438
439
440
      data =
        data
        |> Map.put(:info, Map.merge(user.info, data[:info]))
lain's avatar
lain committed
441

lain's avatar
lain committed
442
      already_ap = User.ap_enabled?(user)
lain's avatar
lain committed
443
444
445
446

      {:ok, user} =
        User.upgrade_changeset(user, data)
        |> Repo.update()
lain's avatar
lain committed
447

lain's avatar
lain committed
448
449
450
451
452
453
454
      if !already_ap do
        # This could potentially take a long time, do it in the background
        if async do
          Task.start(fn ->
            user_upgrade_task(user)
          end)
        else
lain's avatar
lain committed
455
          user_upgrade_task(user)
lain's avatar
lain committed
456
        end
lain's avatar
lain committed
457
      end
lain's avatar
lain committed
458
459
460
461
462
463

      {:ok, user}
    else
      e -> e
    end
  end
464
465
466

  def maybe_retire_websub(ap_id) do
    # some sanity checks
lain's avatar
lain committed
467
468
469
470
471
472
473
    if is_binary(ap_id) && String.length(ap_id) > 8 do
      q =
        from(
          ws in Pleroma.Web.Websub.WebsubClientSubscription,
          where: fragment("? like ?", ws.topic, ^"#{ap_id}%")
        )

474
475
476
      Repo.delete_all(q)
    end
  end
477
end