transmogrifier.ex 11.5 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
  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
29
    case ActivityPub.fetch_object_from_id(in_reply_to_id) do
lain's avatar
lain committed
30
31
32
33
34
35
      {:ok, replied_object} ->
        activity = Activity.get_create_activity_by_object_ap_id(replied_object.data["id"])
        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
36
37
        |> Map.put("conversation", replied_object.data["context"] || object["conversation"])
        |> Map.put("context", replied_object.data["context"] || object["conversation"])
lain's avatar
lain committed
38
39
40
41
42
43
44
      e ->
        Logger.error("Couldn't fetch #{object["inReplyTo"]} #{inspect(e)}")
        object
    end
  end
  def fix_in_reply_to(object), do: object

lain's avatar
lain committed
45
46
47
  def fix_context(object) do
    object
    |> Map.put("context", object["conversation"])
lain's avatar
lain committed
48
49
50
  end

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

    object
    |> Map.put("attachment", attachments)
59
60
  end

lain's avatar
lain committed
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
  def fix_emoji(object) do
    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

      mapping |> Map.put(name, data["icon"]["url"])
    end)

    # 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

80
81
82
83
84
85
86
87
88
89
90
  def fix_tag(object) do
    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)

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

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

91
92
93
94
  # 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
95
96
    with nil <- Activity.get_create_activity_by_object_ap_id(object["id"]),
         %User{} = user <- User.get_or_fetch_by_ap_id(data["actor"]) do
97
      object = fix_object(data["object"])
98

99
100
101
102
      params = %{
        to: data["to"],
        object: object,
        actor: user,
lain's avatar
lain committed
103
        context: object["conversation"],
104
105
106
107
108
109
110
111
        local: false,
        published: data["published"],
        additional: Map.take(data, [
              "cc",
              "id"
            ])
      }

112

113
114
      ActivityPub.create(params)
    else
lain's avatar
lain committed
115
      %Activity{} = activity -> {:ok, activity}
116
117
118
119
      _e -> :error
    end
  end

120
121
  def handle_incoming(%{"type" => "Follow", "object" => followed, "actor" => follower, "id" => id} = data) do
    with %User{local: true} = followed <- User.get_cached_by_ap_id(followed),
122
123
         %User{} = follower <- User.get_or_fetch_by_ap_id(follower),
         {:ok, activity} <- ActivityPub.follow(follower, followed, id, false) do
124
      ActivityPub.accept(%{to: [follower.ap_id], actor: followed.ap_id, object: data, local: true})
125
126
127
128
129
130
131
      User.follow(follower, followed)
      {:ok, activity}
    else
      _e -> :error
    end
  end

lain's avatar
lain committed
132
133
  def handle_incoming(%{"type" => "Like", "object" => object_id, "actor" => actor, "id" => id} = data) do
    with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
134
         {:ok, object} <- get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
lain's avatar
lain committed
135
136
137
138
139
140
141
         {:ok, activity, object} <- ActivityPub.like(actor, object, id, false) do
      {:ok, activity}
    else
      _e -> :error
    end
  end

lain's avatar
lain committed
142
143
  def handle_incoming(%{"type" => "Announce", "object" => object_id, "actor" => actor, "id" => id} = data) do
    with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
144
         {:ok, object} <- get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
lain's avatar
lain committed
145
146
147
148
149
150
151
         {:ok, activity, object} <- ActivityPub.announce(actor, object, id, false) do
      {:ok, activity}
    else
      _e -> :error
    end
  end

lain's avatar
lain committed
152
153
154
155
156
157
158
159
160
161
162
  def handle_incoming(%{"type" => "Update", "object" => %{"type" => "Person"} = object, "actor" => actor_id} = data) do
    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"]
      update_data = new_user_data
      |> Map.take([:name, :bio, :avatar])
      |> Map.put(:info, Map.merge(actor.info, %{"banner" => banner}))

      actor
      |> User.upgrade_changeset(update_data)
lain's avatar
lain committed
163
      |> User.update_and_set_cache()
lain's avatar
lain committed
164
165
166
167
168
169
170
171
172

      ActivityPub.update(%{local: false, to: data["to"] || [], cc: data["cc"] || [], object: object, actor: actor_id})
    else
      e ->
        Logger.error(e)
        :error
    end
  end

lain's avatar
lain committed
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
  # TODO: Make secure.
  def handle_incoming(%{"type" => "Delete", "object" => object_id, "actor" => actor, "id" => id} = data) do
    object_id = case object_id do
                  %{"id" => id} -> id
                  id -> id
                end
    with %User{} = actor <- User.get_or_fetch_by_ap_id(actor),
         {:ok, object} <- get_obj_helper(object_id) || ActivityPub.fetch_object_from_id(object_id),
         {:ok, activity} <- ActivityPub.delete(object, false) do
      {:ok, activity}
    else
      e -> :error
    end
  end

lain's avatar
lain committed
188
189
190
191
  # TODO
  # Accept
  # Undo

192
193
  def handle_incoming(_), do: :error

194
195
196
197
  def get_obj_helper(id) do
    if object = Object.get_by_ap_id(id), do: {:ok, object}, else: nil
  end

198
199
200
201
202
203
204
205
206
207
208
  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
  def set_reply_to_uri(obj), do: obj

  # Prepares the object of an outgoing create activity.
lain's avatar
lain committed
209
210
  def prepare_object(object) do
    object
lain's avatar
lain committed
211
    |> set_sensitive
lain's avatar
lain committed
212
    |> add_hashtags
lain's avatar
lain committed
213
    |> add_mention_tags
lain's avatar
lain committed
214
    |> add_emoji_tags
lain's avatar
lain committed
215
    |> add_attributed_to
lain's avatar
lain committed
216
    |> prepare_attachments
lain's avatar
lain committed
217
    |> set_conversation
218
    |> set_reply_to_uri
lain's avatar
lain committed
219
220
221
222
223
224
225
226
227
  end

  @doc
  """
  internal -> Mastodon
  """
  def prepare_outgoing(%{"type" => "Create", "object" => %{"type" => "Note"} = object} = data) do
    object = object
    |> prepare_object
lain's avatar
lain committed
228
229
230
231
232
233
234
    data = data
    |> Map.put("object", object)
    |> Map.put("@context", "https://www.w3.org/ns/activitystreams")

    {:ok, data}
  end

235
  def prepare_outgoing(%{"type" => type} = data) do
236
    data = data
237
    |> maybe_fix_object_url
238
239
240
241
242
    |> Map.put("@context", "https://www.w3.org/ns/activitystreams")

    {:ok, data}
  end

243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
  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
            data = data
            |> Map.put("object", relative_object.data["external_url"])
          else
            data
          end
        e ->
          Logger.error("Couldn't fetch #{data["object"]} #{inspect(e)}")
          data
      end
    else
      data
    end
  end

lain's avatar
lain committed
262
263
264
265
266
267
268
269
  def add_hashtags(object) do
    tags = (object["tag"] || [])
    |> Enum.map fn (tag) -> %{"href" => Pleroma.Web.Endpoint.url() <> "/tags/#{tag}", "name" => "##{tag}", "type" => "Hashtag"} end

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

lain's avatar
lain committed
270
  def add_mention_tags(object) do
lain's avatar
lain committed
271
272
    recipients = object["to"] ++ (object["cc"] || [])
    mentions = recipients
lain's avatar
lain committed
273
274
    |> Enum.map(fn (ap_id) -> User.get_cached_by_ap_id(ap_id) end)
    |> Enum.filter(&(&1))
lain's avatar
lain committed
275
    |> Enum.map(fn(user) -> %{"type" => "Mention", "href" => user.ap_id, "name" => "@#{user.nickname}"} end)
lain's avatar
lain committed
276

lain's avatar
lain committed
277
    tags = object["tag"] || []
lain's avatar
lain committed
278
279

    object
lain's avatar
lain committed
280
    |> Map.put("tag", tags ++ mentions)
lain's avatar
lain committed
281
282
  end

lain's avatar
lain committed
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
  # 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"] || []
    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)

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

lain's avatar
lain committed
299
300
301
302
  def set_conversation(object) do
    Map.put(object, "conversation", object["context"])
  end

lain's avatar
lain committed
303
304
305
306
307
  def set_sensitive(object) do
    tags = object["tag"] || []
    Map.put(object, "sensitive", "nsfw" in tags)
  end

lain's avatar
lain committed
308
309
310
311
312
  def add_attributed_to(object) do
    attributedTo = object["attributedTo"] || object["actor"]

    object
    |> Map.put("attributedTo", attributedTo)
313
  end
lain's avatar
lain committed
314
315
316
317
318
319
320
321
322
323
324

  def prepare_attachments(object) do
    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)

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

lain's avatar
lain committed
326
327
328
329
330
331
332
  defp user_upgrade_task(user) do
    old_follower_address = User.ap_followers(user)
    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)]]
    Repo.update_all(q, [])

333
334
    maybe_retire_websub(user.ap_id)

lain's avatar
lain committed
335
    # Only do this for recent activties, don't go through the whole db.
lain's avatar
lain committed
336
337
    # Only look at the last 1000 activities.
    since = (Repo.aggregate(Activity, :max, :id) || 0) - 1_000
lain's avatar
lain committed
338
339
340
341
342
343
344
345
    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)]]
    Repo.update_all(q, [])
  end

  def upgrade_user_from_ap_id(ap_id, async \\ true) do
346
    with %User{local: false} = user <- User.get_by_ap_id(ap_id),
lain's avatar
lain committed
347
348
349
350
         {:ok, data} <- ActivityPub.fetch_and_prepare_user_from_ap_id(ap_id) do
      data = data
      |> Map.put(:info, Map.merge(user.info, data[:info]))

lain's avatar
lain committed
351
      already_ap = User.ap_enabled?(user)
lain's avatar
lain committed
352
353
354
      {:ok, user} = User.upgrade_changeset(user, data)
      |> Repo.update()

lain's avatar
lain committed
355
356
357
358
359
360
361
      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
362
          user_upgrade_task(user)
lain's avatar
lain committed
363
        end
lain's avatar
lain committed
364
      end
lain's avatar
lain committed
365
366
367
368
369
370

      {:ok, user}
    else
      e -> e
    end
  end
371
372
373
374
375
376
377
378
379

  def maybe_retire_websub(ap_id) do
    # some sanity checks
    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}%")
      Repo.delete_all(q)
    end
  end
380
end