user.ex 13.6 KB
Newer Older
lain's avatar
lain committed
1
2
defmodule Pleroma.User do
  use Ecto.Schema
3

4
  import Ecto.{Changeset, Query}
5
  alias Pleroma.{Repo, User, Object, Web, Activity, Notification}
6
  alias Comeonin.Pbkdf2
lain's avatar
lain committed
7
  alias Pleroma.Web.{OStatus, Websub}
lain's avatar
lain committed
8
  alias Pleroma.Web.ActivityPub.{Utils, ActivityPub}
lain's avatar
lain committed
9
10

  schema "users" do
lain's avatar
lain committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
    field(:bio, :string)
    field(:email, :string)
    field(:name, :string)
    field(:nickname, :string)
    field(:password_hash, :string)
    field(:password, :string, virtual: true)
    field(:password_confirmation, :string, virtual: true)
    field(:following, {:array, :string}, default: [])
    field(:ap_id, :string)
    field(:avatar, :map)
    field(:local, :boolean, default: true)
    field(:info, :map, default: %{})
    field(:follower_address, :string)
    has_many(:notifications, Notification)
lain's avatar
lain committed
25
26
27

    timestamps()
  end
lain's avatar
lain committed
28

lain's avatar
lain committed
29
30
31
  def avatar_url(user) do
    case user.avatar do
      %{"url" => [%{"href" => href} | _]} -> href
32
      _ -> "#{Web.base_url()}/images/avi.png"
lain's avatar
lain committed
33
34
35
    end
  end

lain's avatar
lain committed
36
37
38
  def banner_url(user) do
    case user.info["banner"] do
      %{"url" => [%{"href" => href} | _]} -> href
39
      _ -> "#{Web.base_url()}/images/banner.png"
lain's avatar
lain committed
40
41
42
    end
  end

lain's avatar
lain committed
43
  def ap_id(%User{nickname: nickname}) do
lain's avatar
lain committed
44
    "#{Web.base_url()}/users/#{nickname}"
lain's avatar
lain committed
45
46
47
48
49
  end

  def ap_followers(%User{} = user) do
    "#{ap_id(user)}/followers"
  end
lain's avatar
lain committed
50
51
52
53
54
55
56

  def follow_changeset(struct, params \\ %{}) do
    struct
    |> cast(params, [:following])
    |> validate_required([:following])
  end

57
58
59
60
61
62
  def info_changeset(struct, params \\ %{}) do
    struct
    |> cast(params, [:info])
    |> validate_required([:info])
  end

lain's avatar
lain committed
63
  def user_info(%User{} = user) do
64
    oneself = if user.local, do: 1, else: 0
lain's avatar
lain committed
65

lain's avatar
lain committed
66
    %{
67
      following_count: length(user.following) - oneself,
68
69
      note_count: user.info["note_count"] || 0,
      follower_count: user.info["follower_count"] || 0
lain's avatar
lain committed
70
71
72
    }
  end

lain's avatar
lain committed
73
74
  @email_regex ~r/^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/
  def remote_user_creation(params) do
lain's avatar
lain committed
75
76
77
78
79
80
81
82
83
84
    changes =
      %User{}
      |> cast(params, [:bio, :name, :ap_id, :nickname, :info, :avatar])
      |> validate_required([:name, :ap_id, :nickname])
      |> unique_constraint(:nickname)
      |> validate_format(:nickname, @email_regex)
      |> validate_length(:bio, max: 5000)
      |> validate_length(:name, max: 100)
      |> put_change(:local, false)

85
    if changes.valid? do
lain's avatar
lain committed
86
87
88
89
      case changes.changes[:info]["source_data"] do
        %{"followers" => followers} ->
          changes
          |> put_change(:follower_address, followers)
lain's avatar
lain committed
90

lain's avatar
lain committed
91
92
        _ ->
          followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
lain's avatar
lain committed
93

lain's avatar
lain committed
94
95
96
          changes
          |> put_change(:follower_address, followers)
      end
97
98
99
    else
      changes
    end
lain's avatar
lain committed
100
101
  end

lain's avatar
lain committed
102
  def update_changeset(struct, params \\ %{}) do
Thog's avatar
Thog committed
103
    struct
lain's avatar
lain committed
104
105
106
    |> cast(params, [:bio, :name])
    |> unique_constraint(:nickname)
    |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
vaartis's avatar
vaartis committed
107
    |> validate_length(:bio, max: 1000)
lain's avatar
lain committed
108
109
110
    |> validate_length(:name, min: 1, max: 100)
  end

lain's avatar
lain committed
111
112
  def upgrade_changeset(struct, params \\ %{}) do
    struct
lain's avatar
lain committed
113
    |> cast(params, [:bio, :name, :info, :follower_address, :avatar])
lain's avatar
lain committed
114
115
    |> unique_constraint(:nickname)
    |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
lain's avatar
lain committed
116
117
    |> validate_length(:bio, max: 5000)
    |> validate_length(:name, max: 100)
lain's avatar
lain committed
118
119
  end

Roger Braun's avatar
Roger Braun committed
120
  def password_update_changeset(struct, params) do
lain's avatar
lain committed
121
122
123
124
125
    changeset =
      struct
      |> cast(params, [:password, :password_confirmation])
      |> validate_required([:password, :password_confirmation])
      |> validate_confirmation(:password)
Roger Braun's avatar
Roger Braun committed
126
127
128

    if changeset.valid? do
      hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
lain's avatar
lain committed
129

Roger Braun's avatar
Roger Braun committed
130
131
132
133
134
135
136
137
      changeset
      |> put_change(:password_hash, hashed)
    else
      changeset
    end
  end

  def reset_password(user, data) do
lain's avatar
lain committed
138
    update_and_set_cache(password_update_changeset(user, data))
Roger Braun's avatar
Roger Braun committed
139
140
  end

lain's avatar
lain committed
141
  def register_changeset(struct, params \\ %{}) do
lain's avatar
lain committed
142
143
144
145
146
147
148
149
150
151
152
    changeset =
      struct
      |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
      |> validate_required([:email, :name, :nickname, :password, :password_confirmation])
      |> validate_confirmation(:password)
      |> unique_constraint(:email)
      |> unique_constraint(:nickname)
      |> validate_format(:nickname, ~r/^[a-zA-Z\d]+$/)
      |> validate_format(:email, @email_regex)
      |> validate_length(:bio, max: 1000)
      |> validate_length(:name, min: 1, max: 100)
lain's avatar
lain committed
153
154

    if changeset.valid? do
155
      hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
lain's avatar
lain committed
156
157
      ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
      followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
lain's avatar
lain committed
158

lain's avatar
lain committed
159
160
161
162
      changeset
      |> put_change(:password_hash, hashed)
      |> put_change(:ap_id, ap_id)
      |> put_change(:following, [followers])
163
      |> put_change(:follower_address, followers)
lain's avatar
lain committed
164
165
166
167
168
    else
      changeset
    end
  end

lain's avatar
lain committed
169
  def follow(%User{} = follower, %User{info: info} = followed) do
170
    ap_followers = followed.follower_address
171

lain's avatar
lain committed
172
    if following?(follower, followed) or info["deactivated"] do
lain's avatar
lain committed
173
      {:error, "Could not follow user: #{followed.nickname} is already on your list."}
174
    else
175
      if !followed.local && follower.local && !ap_enabled?(followed) do
lain's avatar
lain committed
176
177
178
        Websub.subscribe(follower, followed)
      end

lain's avatar
lain committed
179
180
181
      following =
        [ap_followers | follower.following]
        |> Enum.uniq()
lain's avatar
lain committed
182

lain's avatar
lain committed
183
184
185
186
      follower =
        follower
        |> follow_changeset(%{following: following})
        |> update_and_set_cache
187

Thog's avatar
Thog committed
188
      {:ok, _} = update_follower_count(followed)
189
190

      follower
191
    end
lain's avatar
lain committed
192
  end
lain's avatar
lain committed
193
194

  def unfollow(%User{} = follower, %User{} = followed) do
195
    ap_followers = followed.follower_address
lain's avatar
lain committed
196

197
    if following?(follower, followed) and follower.ap_id != followed.ap_id do
lain's avatar
lain committed
198
199
200
      following =
        follower.following
        |> List.delete(ap_followers)
lain's avatar
lain committed
201

lain's avatar
lain committed
202
203
204
205
      {:ok, follower} =
        follower
        |> follow_changeset(%{following: following})
        |> update_and_set_cache
206
207
208
209

      {:ok, followed} = update_follower_count(followed)

      {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
210
    else
211
      {:error, "Not subscribed!"}
212
    end
lain's avatar
lain committed
213
  end
214
215

  def following?(%User{} = follower, %User{} = followed) do
216
    Enum.member?(follower.following, followed.follower_address)
217
  end
lain's avatar
lain committed
218

lain's avatar
lain committed
219
220
221
222
  def get_by_ap_id(ap_id) do
    Repo.get_by(User, ap_id: ap_id)
  end

lain's avatar
lain committed
223
224
225
226
227
228
229
230
231
232
233
  def update_and_set_cache(changeset) do
    with {:ok, user} <- Repo.update(changeset) do
      Cachex.set(:user_cache, "ap_id:#{user.ap_id}", user)
      Cachex.set(:user_cache, "nickname:#{user.nickname}", user)
      Cachex.set(:user_cache, "user_info:#{user.id}", user_info(user))
      {:ok, user}
    else
      e -> e
    end
  end

lain's avatar
lain committed
234
235
236
237
238
  def invalidate_cache(user) do
    Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
    Cachex.del(:user_cache, "nickname:#{user.nickname}")
  end

lain's avatar
lain committed
239
  def get_cached_by_ap_id(ap_id) do
240
    key = "ap_id:#{ap_id}"
lain's avatar
lain committed
241
    Cachex.get!(:user_cache, key, fallback: fn _ -> get_by_ap_id(ap_id) end)
lain's avatar
lain committed
242
243
244
  end

  def get_cached_by_nickname(nickname) do
245
    key = "nickname:#{nickname}"
lain's avatar
lain committed
246
    Cachex.get!(:user_cache, key, fallback: fn _ -> get_or_fetch_by_nickname(nickname) end)
lain's avatar
lain committed
247
  end
lain's avatar
lain committed
248

lain's avatar
lain committed
249
  def get_by_nickname(nickname) do
250
251
252
    Repo.get_by(User, nickname: nickname)
  end

lain's avatar
lain committed
253
254
  def get_cached_user_info(user) do
    key = "user_info:#{user.id}"
lain's avatar
lain committed
255
    Cachex.get!(:user_cache, key, fallback: fn _ -> user_info(user) end)
lain's avatar
lain committed
256
  end
lain's avatar
lain committed
257

lain's avatar
lain committed
258
259
260
261
262
263
264
265
266
  def fetch_by_nickname(nickname) do
    ap_try = ActivityPub.make_user_from_nickname(nickname)

    case ap_try do
      {:ok, user} -> {:ok, user}
      _ -> OStatus.make_user(nickname)
    end
  end

lain's avatar
lain committed
267
  def get_or_fetch_by_nickname(nickname) do
lain's avatar
lain committed
268
    with %User{} = user <- get_by_nickname(nickname) do
lain's avatar
lain committed
269
      user
lain's avatar
lain committed
270
271
272
273
274
275
276
277
    else
      _e ->
        with [_nick, _domain] <- String.split(nickname, "@"),
             {:ok, user} <- fetch_by_nickname(nickname) do
          user
        else
          _e -> nil
        end
lain's avatar
lain committed
278
    end
lain's avatar
lain committed
279
  end
lain's avatar
lain committed
280

281
282
283
284
285
286
287
288
289
290
  def get_followers_query(%User{id: id, follower_address: follower_address}) do
    from(
      u in User,
      where: fragment("? <@ ?", ^[follower_address], u.following),
      where: u.id != ^id
    )
  end

  def get_followers(user) do
    q = get_followers_query(user)
lain's avatar
lain committed
291
292
293
294

    {:ok, Repo.all(q)}
  end

295
296
297
298
299
300
301
302
303
304
  def get_friends_query(%User{id: id, following: following}) do
    from(
      u in User,
      where: u.follower_address in ^following,
      where: u.id != ^id
    )
  end

  def get_friends(user) do
    q = get_friends_query(user)
lain's avatar
lain committed
305
306
307

    {:ok, Repo.all(q)}
  end
308

309
310
311
312
313
314
  def increase_note_count(%User{} = user) do
    note_count = (user.info["note_count"] || 0) + 1
    new_info = Map.put(user.info, "note_count", note_count)

    cs = info_changeset(user, %{info: new_info})

lain's avatar
lain committed
315
    update_and_set_cache(cs)
316
317
  end

318
  def update_note_count(%User{} = user) do
lain's avatar
lain committed
319
320
321
322
323
324
    note_count_query =
      from(
        a in Object,
        where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
        select: count(a.id)
      )
325
326
327
328
329
330
331

    note_count = Repo.one(note_count_query)

    new_info = Map.put(user.info, "note_count", note_count)

    cs = info_changeset(user, %{info: new_info})

lain's avatar
lain committed
332
    update_and_set_cache(cs)
333
334
335
  end

  def update_follower_count(%User{} = user) do
lain's avatar
lain committed
336
337
338
339
340
341
342
    follower_count_query =
      from(
        u in User,
        where: ^user.follower_address in u.following,
        where: u.id != ^user.id,
        select: count(u.id)
      )
343
344
345
346
347
348
349

    follower_count = Repo.one(follower_count_query)

    new_info = Map.put(user.info, "follower_count", follower_count)

    cs = info_changeset(user, %{info: new_info})

lain's avatar
lain committed
350
    update_and_set_cache(cs)
351
  end
352

353
  def get_notified_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
354
355
356
357
358
359
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        where: u.local == true
      )
360
361
362

    Repo.all(query)
  end
lain's avatar
lain committed
363

364
  def get_recipients_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
365
366
367
368
369
370
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        or_where: fragment("? && ?", u.following, ^to)
      )
371

lain's avatar
lain committed
372
    query = from(u in query, where: u.local == true)
373

374
375
376
    Repo.all(query)
  end

lain's avatar
lain committed
377
378
379
380
  def search(query, resolve) do
    if resolve do
      User.get_or_fetch_by_nickname(query)
    end
lain's avatar
lain committed
381
382
383
384
385
386
387
388
389
390
391
392
393
394

    q =
      from(
        u in User,
        where:
          fragment(
            "(to_tsvector('english', ?) || to_tsvector('english', ?)) @@ plainto_tsquery('english', ?)",
            u.nickname,
            u.name,
            ^query
          ),
        limit: 20
      )

lain's avatar
lain committed
395
396
    Repo.all(q)
  end
lain's avatar
lain committed
397
398
399
400
401
402
403

  def block(user, %{ap_id: ap_id}) do
    blocks = user.info["blocks"] || []
    new_blocks = Enum.uniq([ap_id | blocks])
    new_info = Map.put(user.info, "blocks", new_blocks)

    cs = User.info_changeset(user, %{info: new_info})
lain's avatar
lain committed
404
    update_and_set_cache(cs)
lain's avatar
lain committed
405
406
407
408
409
410
411
412
  end

  def unblock(user, %{ap_id: ap_id}) do
    blocks = user.info["blocks"] || []
    new_blocks = List.delete(blocks, ap_id)
    new_info = Map.put(user.info, "blocks", new_blocks)

    cs = User.info_changeset(user, %{info: new_info})
lain's avatar
lain committed
413
    update_and_set_cache(cs)
lain's avatar
lain committed
414
415
416
417
418
419
420
  end

  def blocks?(user, %{ap_id: ap_id}) do
    blocks = user.info["blocks"] || []
    Enum.member?(blocks, ap_id)
  end

lain's avatar
lain committed
421
  def local_user_query() do
lain's avatar
lain committed
422
    from(u in User, where: u.local == true)
lain's avatar
lain committed
423
424
  end

lain's avatar
lain committed
425
  def deactivate(%User{} = user) do
lain's avatar
lain committed
426
427
    new_info = Map.put(user.info, "deactivated", true)
    cs = User.info_changeset(user, %{info: new_info})
lain's avatar
lain committed
428
    update_and_set_cache(cs)
lain's avatar
lain committed
429
  end
lain's avatar
lain committed
430

lain's avatar
lain committed
431
  def delete(%User{} = user) do
lain's avatar
lain committed
432
433
434
    {:ok, user} = User.deactivate(user)

    # Remove all relationships
lain's avatar
lain committed
435
436
    {:ok, followers} = User.get_followers(user)

lain's avatar
lain committed
437
    followers
lain's avatar
lain committed
438
    |> Enum.each(fn follower -> User.unfollow(follower, user) end)
lain's avatar
lain committed
439
440

    {:ok, friends} = User.get_friends(user)
lain's avatar
lain committed
441

lain's avatar
lain committed
442
    friends
lain's avatar
lain committed
443
    |> Enum.each(fn followed -> User.unfollow(user, followed) end)
lain's avatar
lain committed
444

lain's avatar
lain committed
445
    query = from(a in Activity, where: a.actor == ^user.ap_id)
lain's avatar
lain committed
446
447

    Repo.all(query)
lain's avatar
lain committed
448
    |> Enum.each(fn activity ->
lain's avatar
lain committed
449
      case activity.data["type"] do
lain's avatar
lain committed
450
451
452
453
454
455
        "Create" ->
          ActivityPub.delete(Object.get_by_ap_id(activity.data["object"]["id"]))

        # TODO: Do something with likes, follows, repeats.
        _ ->
          "Doing nothing"
lain's avatar
lain committed
456
457
458
      end
    end)

lain's avatar
lain committed
459
460
    :ok
  end
461

462
463
464
465
  def get_or_fetch_by_ap_id(ap_id) do
    if user = get_by_ap_id(ap_id) do
      user
    else
lain's avatar
lain committed
466
467
468
      ap_try = ActivityPub.make_user_from_ap_id(ap_id)

      case ap_try do
lain's avatar
lain committed
469
470
471
        {:ok, user} ->
          user

lain's avatar
lain committed
472
473
474
        _ ->
          case OStatus.make_user(ap_id) do
            {:ok, user} -> user
feld's avatar
feld committed
475
            _ -> {:error, "Could not fetch by AP id"}
lain's avatar
lain committed
476
          end
477
478
479
480
481
      end
    end
  end

  # AP style
lain's avatar
lain committed
482
483
484
485
486
487
488
  def public_key_from_info(%{
        "source_data" => %{"publicKey" => %{"publicKeyPem" => public_key_pem}}
      }) do
    key =
      :public_key.pem_decode(public_key_pem)
      |> hd()
      |> :public_key.pem_entry_decode()
489

lain's avatar
lain committed
490
    {:ok, key}
491
492
493
494
495
496
497
  end

  # OStatus Magic Key
  def public_key_from_info(%{"magic_key" => magic_key}) do
    {:ok, Pleroma.Web.Salmon.decode_key(magic_key)}
  end

498
  def get_public_key_for_ap_id(ap_id) do
499
500
    with %User{} = user <- get_or_fetch_by_ap_id(ap_id),
         {:ok, public_key} <- public_key_from_info(user.info) do
501
502
503
504
505
      {:ok, public_key}
    else
      _ -> :error
    end
  end
lain's avatar
lain committed
506

507
508
509
  defp blank?(""), do: nil
  defp blank?(n), do: n

lain's avatar
lain committed
510
  def insert_or_update_user(data) do
lain's avatar
lain committed
511
512
513
514
    data =
      data
      |> Map.put(:name, blank?(data[:name]) || data[:nickname])

lain's avatar
lain committed
515
516
517
    cs = User.remote_user_creation(data)
    Repo.insert(cs, on_conflict: :replace_all, conflict_target: :nickname)
  end
518

519
  def ap_enabled?(%User{info: info}), do: info["ap_enabled"]
lain's avatar
lain committed
520
  def ap_enabled?(_), do: false
lain's avatar
lain committed
521
522
523
524
525
526
527
528

  def get_or_fetch(uri_or_nickname) do
    if String.starts_with?(uri_or_nickname, "http") do
      get_or_fetch_by_ap_id(uri_or_nickname)
    else
      get_or_fetch_by_nickname(uri_or_nickname)
    end
  end
lain's avatar
lain committed
529
end