user.ex 36 KB
Newer Older
1
# Pleroma: A lightweight social networking server
kaniini's avatar
kaniini committed
2
# Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3
4
# SPDX-License-Identifier: AGPL-3.0-only

lain's avatar
lain committed
5
6
defmodule Pleroma.User do
  use Ecto.Schema
7

Haelwenn's avatar
Haelwenn committed
8
9
10
  import Ecto.Changeset
  import Ecto.Query

11
12
13
14
15
  alias Comeonin.Pbkdf2
  alias Pleroma.Activity
  alias Pleroma.Formatter
  alias Pleroma.Notification
  alias Pleroma.Object
Haelwenn's avatar
Haelwenn committed
16
17
18
  alias Pleroma.Repo
  alias Pleroma.User
  alias Pleroma.Web
19
20
  alias Pleroma.Web.ActivityPub.ActivityPub
  alias Pleroma.Web.ActivityPub.Utils
Maxim Filippov's avatar
Maxim Filippov committed
21
  alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
Haelwenn's avatar
Haelwenn committed
22
  alias Pleroma.Web.OAuth
23
  alias Pleroma.Web.OStatus
24
  alias Pleroma.Web.RelMe
25
  alias Pleroma.Web.Websub
lain's avatar
lain committed
26

27
28
  require Logger

Maksim's avatar
Maksim committed
29
30
  @type t :: %__MODULE__{}

href's avatar
href committed
31
32
  @primary_key {:id, Pleroma.FlakeId, autogenerate: true}

33
  # credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
href's avatar
href committed
34
35
36
  @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])?)*$/

  @strict_local_nickname_regex ~r/^[a-zA-Z\d]+$/
href's avatar
href committed
37
  @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
href's avatar
href committed
38

lain's avatar
lain committed
39
  schema "users" do
lain's avatar
lain committed
40
41
42
43
44
45
46
47
48
49
50
51
    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(:follower_address, :string)
52
    field(:search_rank, :float, virtual: true)
53
    field(:tags, {:array, :string}, default: [])
Haelwenn's avatar
Haelwenn committed
54
    field(:bookmarks, {:array, :string}, default: [])
55
    field(:last_refreshed_at, :naive_datetime)
lain's avatar
lain committed
56
    has_many(:notifications, Notification)
lain's avatar
lain committed
57
    embeds_one(:info, Pleroma.User.Info)
lain's avatar
lain committed
58
59
60

    timestamps()
  end
lain's avatar
lain committed
61

62
  def auth_active?(%User{local: false}), do: true
63

64
65
66
67
  def auth_active?(%User{info: %User.Info{confirmation_pending: false}}), do: true

  def auth_active?(%User{info: %User.Info{confirmation_pending: true}}),
    do: !Pleroma.Config.get([:instance, :account_activation_required])
68

69
  def auth_active?(_), do: false
70

71
72
73
74
75
  def visible_for?(user, for_user \\ nil)

  def visible_for?(%User{id: user_id}, %User{id: for_id}) when user_id == for_id, do: true

  def visible_for?(%User{} = user, for_user) do
76
    auth_active?(user) || superuser?(for_user)
77
78
  end

79
80
  def visible_for?(_, _), do: false

81
82
  def superuser?(%User{local: true, info: %User.Info{is_admin: true}}), do: true
  def superuser?(%User{local: true, info: %User.Info{is_moderator: true}}), do: true
83
  def superuser?(_), do: false
84

lain's avatar
lain committed
85
86
87
  def avatar_url(user) do
    case user.avatar do
      %{"url" => [%{"href" => href} | _]} -> href
88
      _ -> "#{Web.base_url()}/images/avi.png"
lain's avatar
lain committed
89
90
91
    end
  end

lain's avatar
lain committed
92
  def banner_url(user) do
lain's avatar
lain committed
93
    case user.info.banner do
lain's avatar
lain committed
94
      %{"url" => [%{"href" => href} | _]} -> href
95
      _ -> "#{Web.base_url()}/images/banner.png"
lain's avatar
lain committed
96
97
98
    end
  end

lain's avatar
lain committed
99
  def profile_url(%User{info: %{source_data: %{"url" => url}}}), do: url
100
101
102
  def profile_url(%User{ap_id: ap_id}), do: ap_id
  def profile_url(_), do: nil

lain's avatar
lain committed
103
  def ap_id(%User{nickname: nickname}) do
lain's avatar
lain committed
104
    "#{Web.base_url()}/users/#{nickname}"
lain's avatar
lain committed
105
106
107
108
109
  end

  def ap_followers(%User{} = user) do
    "#{ap_id(user)}/followers"
  end
lain's avatar
lain committed
110

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

lain's avatar
lain committed
114
    %{
115
      following_count: length(user.following) - oneself,
lain's avatar
lain committed
116
117
118
      note_count: user.info.note_count,
      follower_count: user.info.follower_count,
      locked: user.info.locked,
Ivan Tashkinov's avatar
Ivan Tashkinov committed
119
      confirmation_pending: user.info.confirmation_pending,
lain's avatar
lain committed
120
      default_scope: user.info.default_scope
lain's avatar
lain committed
121
122
123
    }
  end

lain's avatar
lain committed
124
  def remote_user_creation(params) do
lain's avatar
lain committed
125
126
127
    params =
      params
      |> Map.put(:info, params[:info] || %{})
lain's avatar
lain committed
128
129
130

    info_cng = User.Info.remote_user_creation(%User.Info{}, params[:info])

lain's avatar
lain committed
131
    changes =
lain's avatar
lain committed
132
      %User{}
lain's avatar
lain committed
133
      |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
134
      |> validate_required([:name, :ap_id])
lain's avatar
lain committed
135
136
137
138
139
      |> unique_constraint(:nickname)
      |> validate_format(:nickname, @email_regex)
      |> validate_length(:bio, max: 5000)
      |> validate_length(:name, max: 100)
      |> put_change(:local, false)
lain's avatar
lain committed
140
      |> put_embed(:info, info_cng)
lain's avatar
lain committed
141

142
    if changes.valid? do
lain's avatar
lain committed
143
      case info_cng.changes[:source_data] do
lain's avatar
lain committed
144
145
146
        %{"followers" => followers} ->
          changes
          |> put_change(:follower_address, followers)
lain's avatar
lain committed
147

lain's avatar
lain committed
148
149
        _ ->
          followers = User.ap_followers(%User{nickname: changes.changes[:nickname]})
lain's avatar
lain committed
150

lain's avatar
lain committed
151
152
153
          changes
          |> put_change(:follower_address, followers)
      end
154
155
156
    else
      changes
    end
lain's avatar
lain committed
157
158
  end

lain's avatar
lain committed
159
  def update_changeset(struct, params \\ %{}) do
Thog's avatar
Thog committed
160
    struct
lain's avatar
lain committed
161
    |> cast(params, [:bio, :name, :avatar])
lain's avatar
lain committed
162
    |> unique_constraint(:nickname)
href's avatar
href committed
163
    |> validate_format(:nickname, local_nickname_regex())
lain's avatar
lain committed
164
    |> validate_length(:bio, max: 5000)
lain's avatar
lain committed
165
166
167
    |> validate_length(:name, min: 1, max: 100)
  end

lain's avatar
lain committed
168
  def upgrade_changeset(struct, params \\ %{}) do
169
170
171
172
    params =
      params
      |> Map.put(:last_refreshed_at, NaiveDateTime.utc_now())

lain's avatar
lain committed
173
174
175
176
    info_cng =
      struct.info
      |> User.Info.user_upgrade(params[:info])

lain's avatar
lain committed
177
    struct
lain's avatar
lain committed
178
    |> cast(params, [:bio, :name, :follower_address, :avatar, :last_refreshed_at])
lain's avatar
lain committed
179
    |> unique_constraint(:nickname)
href's avatar
href committed
180
    |> validate_format(:nickname, local_nickname_regex())
lain's avatar
lain committed
181
182
    |> validate_length(:bio, max: 5000)
    |> validate_length(:name, max: 100)
lain's avatar
lain committed
183
    |> put_embed(:info, info_cng)
lain's avatar
lain committed
184
185
  end

Roger Braun's avatar
Roger Braun committed
186
  def password_update_changeset(struct, params) do
lain's avatar
lain committed
187
188
189
190
191
    changeset =
      struct
      |> cast(params, [:password, :password_confirmation])
      |> validate_required([:password, :password_confirmation])
      |> validate_confirmation(:password)
Roger Braun's avatar
Roger Braun committed
192

193
194
195
    OAuth.Token.delete_user_tokens(struct)
    OAuth.Authorization.delete_user_authorizations(struct)

Roger Braun's avatar
Roger Braun committed
196
197
    if changeset.valid? do
      hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
lain's avatar
lain committed
198

Roger Braun's avatar
Roger Braun committed
199
200
201
202
203
204
205
206
      changeset
      |> put_change(:password_hash, hashed)
    else
      changeset
    end
  end

  def reset_password(user, data) do
lain's avatar
lain committed
207
    update_and_set_cache(password_update_changeset(user, data))
Roger Braun's avatar
Roger Braun committed
208
209
  end

210
211
212
213
214
215
216
217
  def register_changeset(struct, params \\ %{}, opts \\ []) do
    confirmation_status =
      if opts[:confirmed] || !Pleroma.Config.get([:instance, :account_activation_required]) do
        :confirmed
      else
        :unconfirmed
      end

Ivan Tashkinov's avatar
Ivan Tashkinov committed
218
219
    info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)

lain's avatar
lain committed
220
221
222
223
224
225
226
    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)
lain's avatar
lain committed
227
      |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
href's avatar
href committed
228
      |> validate_format(:nickname, local_nickname_regex())
lain's avatar
lain committed
229
230
231
      |> validate_format(:email, @email_regex)
      |> validate_length(:bio, max: 1000)
      |> validate_length(:name, min: 1, max: 100)
Ivan Tashkinov's avatar
Ivan Tashkinov committed
232
      |> put_change(:info, info_change)
lain's avatar
lain committed
233
234

    if changeset.valid? do
235
      hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
lain's avatar
lain committed
236
237
      ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
      followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
lain's avatar
lain committed
238

lain's avatar
lain committed
239
240
241
      changeset
      |> put_change(:password_hash, hashed)
      |> put_change(:ap_id, ap_id)
rinpatch's avatar
rinpatch committed
242
      |> unique_constraint(:ap_id)
lain's avatar
lain committed
243
      |> put_change(:following, [followers])
244
      |> put_change(:follower_address, followers)
lain's avatar
lain committed
245
246
247
248
249
    else
      changeset
    end
  end

250
251
252
253
254
255
256
257
258
259
  defp autofollow_users(user) do
    candidates = Pleroma.Config.get([:instance, :autofollowed_nicknames])

    autofollowed_users =
      from(u in User,
        where: u.local == true,
        where: u.nickname in ^candidates
      )
      |> Repo.all()

lain's avatar
lain committed
260
    follow_all(user, autofollowed_users)
261
262
  end

263
264
  @doc "Inserts provided changeset, performs post-registration actions (confirmation email sending etc.)"
  def register(%Ecto.Changeset{} = changeset) do
Ivan Tashkinov's avatar
Ivan Tashkinov committed
265
    with {:ok, user} <- Repo.insert(changeset),
lain's avatar
lain committed
266
         {:ok, user} <- autofollow_users(user),
lain's avatar
lain committed
267
         {:ok, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
lain's avatar
lain committed
268
         {:ok, _} <- try_send_confirmation_email(user) do
269
270
271
272
      {:ok, user}
    end
  end

273
  def try_send_confirmation_email(%User{} = user) do
274
275
    if user.info.confirmation_pending &&
         Pleroma.Config.get([:instance, :account_activation_required]) do
276
277
      user
      |> Pleroma.UserEmail.account_confirmation_email()
minibikini's avatar
Reports    
minibikini committed
278
      |> Pleroma.Mailer.deliver_async()
279
280
281
282
283
    else
      {:ok, :noop}
    end
  end

284
285
286
287
288
  def needs_update?(%User{local: true}), do: false

  def needs_update?(%User{local: false, last_refreshed_at: nil}), do: true

  def needs_update?(%User{local: false} = user) do
289
    NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
290
291
292
293
  end

  def needs_update?(_), do: true

lain's avatar
lain committed
294
  def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
295
296
297
298
299
300
301
302
    {:ok, follower}
  end

  def maybe_direct_follow(%User{} = follower, %User{local: true} = followed) do
    follow(follower, followed)
  end

  def maybe_direct_follow(%User{} = follower, %User{} = followed) do
Maksim's avatar
Maksim committed
303
    if not User.ap_enabled?(followed) do
304
      follow(follower, followed)
305
306
307
308
309
    else
      {:ok, follower}
    end
  end

Maksim's avatar
Maksim committed
310
  def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
311
312
    if not following?(follower, followed) do
      follow(follower, followed)
313
    else
314
      {:ok, follower}
315
316
317
    end
  end

318
  @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
lain's avatar
lain committed
319
320
  @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
  def follow_all(follower, followeds) do
lain's avatar
lain committed
321
322
    followed_addresses =
      followeds
323
      |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
lain's avatar
lain committed
324
      |> Enum.map(fn %{follower_address: fa} -> fa end)
lain's avatar
lain committed
325

lain's avatar
lain committed
326
327
328
    q =
      from(u in User,
        where: u.id == ^follower.id,
329
330
331
332
333
334
335
336
337
338
        update: [
          set: [
            following:
              fragment(
                "array(select distinct unnest (array_cat(?, ?)))",
                u.following,
                ^followed_addresses
              )
          ]
        ]
lain's avatar
lain committed
339
340
341
      )

    {1, [follower]} = Repo.update_all(q, [], returning: true)
lain's avatar
lain committed
342
343
344
345
346

    Enum.each(followeds, fn followed ->
      update_follower_count(followed)
    end)

lain's avatar
lain committed
347
    set_cache(follower)
lain's avatar
lain committed
348
349
  end

lain's avatar
lain committed
350
  def follow(%User{} = follower, %User{info: info} = followed) do
351
352
    user_config = Application.get_env(:pleroma, :user)
    deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
353

354
    ap_followers = followed.follower_address
355

356
    cond do
lain's avatar
lain committed
357
      following?(follower, followed) or info.deactivated ->
358
        {:error, "Could not follow user: #{followed.nickname} is already on your list."}
lain's avatar
lain committed
359

360
      deny_follow_blocked and blocks?(followed, follower) ->
361
        {:error, "Could not follow user: #{followed.nickname} blocked you."}
lain's avatar
lain committed
362

363
364
365
366
367
      true ->
        if !followed.local && follower.local && !ap_enabled?(followed) do
          Websub.subscribe(follower, followed)
        end

368
369
370
371
372
        q =
          from(u in User,
            where: u.id == ^follower.id,
            update: [push: [following: ^ap_followers]]
          )
373

374
        {1, [follower]} = Repo.update_all(q, [], returning: true)
375

376
377
        {:ok, _} = update_follower_count(followed)

378
        set_cache(follower)
379
    end
lain's avatar
lain committed
380
  end
lain's avatar
lain committed
381
382

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

385
    if following?(follower, followed) and follower.ap_id != followed.ap_id do
386
387
388
389
390
      q =
        from(u in User,
          where: u.id == ^follower.id,
          update: [pull: [following: ^ap_followers]]
        )
lain's avatar
lain committed
391

392
      {1, [follower]} = Repo.update_all(q, [], returning: true)
393
394
395

      {:ok, followed} = update_follower_count(followed)

396
397
      set_cache(follower)

398
      {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
399
    else
400
      {:error, "Not subscribed!"}
401
    end
lain's avatar
lain committed
402
  end
403

Maksim's avatar
Maksim committed
404
  @spec following?(User.t(), User.t()) :: boolean
405
  def following?(%User{} = follower, %User{} = followed) do
406
    Enum.member?(follower.following, followed.follower_address)
407
  end
lain's avatar
lain committed
408

409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
  def follow_import(%User{} = follower, followed_identifiers)
      when is_list(followed_identifiers) do
    Enum.map(
      followed_identifiers,
      fn followed_identifier ->
        with %User{} = followed <- get_or_fetch(followed_identifier),
             {:ok, follower} <- maybe_direct_follow(follower, followed),
             {:ok, _} <- ActivityPub.follow(follower, followed) do
          followed
        else
          err ->
            Logger.debug("follow_import failed for #{followed_identifier} with: #{inspect(err)}")
            err
        end
      end
    )
  end

427
  def locked?(%User{} = user) do
428
    user.info.locked || false
429
430
  end

431
432
433
434
  def get_by_id(id) do
    Repo.get_by(User, id: id)
  end

lain's avatar
lain committed
435
436
437
438
  def get_by_ap_id(ap_id) do
    Repo.get_by(User, ap_id: ap_id)
  end

439
440
  # This is mostly an SPC migration fix. This guesses the user nickname by taking the last part
  # of the ap_id and the domain and tries to get that user
441
442
443
444
445
446
447
448
  def get_by_guessed_nickname(ap_id) do
    domain = URI.parse(ap_id).host
    name = List.last(String.split(ap_id, "/"))
    nickname = "#{name}@#{domain}"

    get_by_nickname(nickname)
  end

449
450
451
452
453
454
455
  def set_cache(user) do
    Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
    Cachex.put(:user_cache, "nickname:#{user.nickname}", user)
    Cachex.put(:user_cache, "user_info:#{user.id}", user_info(user))
    {:ok, user}
  end

lain's avatar
lain committed
456
457
  def update_and_set_cache(changeset) do
    with {:ok, user} <- Repo.update(changeset) do
458
      set_cache(user)
lain's avatar
lain committed
459
460
461
462
463
    else
      e -> e
    end
  end

lain's avatar
lain committed
464
465
466
  def invalidate_cache(user) do
    Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
    Cachex.del(:user_cache, "nickname:#{user.nickname}")
467
    Cachex.del(:user_cache, "user_info:#{user.id}")
lain's avatar
lain committed
468
469
  end

lain's avatar
lain committed
470
  def get_cached_by_ap_id(ap_id) do
471
    key = "ap_id:#{ap_id}"
Thog's avatar
Thog committed
472
    Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
lain's avatar
lain committed
473
474
  end

475
476
  def get_cached_by_id(id) do
    key = "id:#{id}"
477
478
479
480

    ap_id =
      Cachex.fetch!(:user_cache, key, fn _ ->
        user = get_by_id(id)
481
482
483
484
485
486
487

        if user do
          Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
          {:commit, user.ap_id}
        else
          {:ignore, ""}
        end
488
489
490
      end)

    get_cached_by_ap_id(ap_id)
491
492
  end

lain's avatar
lain committed
493
  def get_cached_by_nickname(nickname) do
494
    key = "nickname:#{nickname}"
Thog's avatar
Thog committed
495
    Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
lain's avatar
lain committed
496
  end
lain's avatar
lain committed
497

498
  def get_cached_by_nickname_or_id(nickname_or_id) do
499
    get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
500
501
  end

lain's avatar
lain committed
502
  def get_by_nickname(nickname) do
503
    Repo.get_by(User, nickname: nickname) ||
504
      if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
505
        Repo.get_by(User, nickname: local_nickname(nickname))
506
      end
507
508
  end

509
510
511
512
513
514
515
  def get_by_nickname_or_email(nickname_or_email) do
    case user = Repo.get_by(User, nickname: nickname_or_email) do
      %User{} -> user
      nil -> Repo.get_by(User, email: nickname_or_email)
    end
  end

lain's avatar
lain committed
516
517
  def get_cached_user_info(user) do
    key = "user_info:#{user.id}"
Thog's avatar
Thog committed
518
    Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
lain's avatar
lain committed
519
  end
lain's avatar
lain committed
520

lain's avatar
lain committed
521
522
523
524
525
526
527
528
529
  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
530
  def get_or_fetch_by_nickname(nickname) do
lain's avatar
lain committed
531
    with %User{} = user <- get_by_nickname(nickname) do
lain's avatar
lain committed
532
      user
lain's avatar
lain committed
533
534
535
536
    else
      _e ->
        with [_nick, _domain] <- String.split(nickname, "@"),
             {:ok, user} <- fetch_by_nickname(nickname) do
537
538
539
540
          if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
            {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
          end

lain's avatar
lain committed
541
542
543
544
          user
        else
          _e -> nil
        end
lain's avatar
lain committed
545
    end
lain's avatar
lain committed
546
  end
lain's avatar
lain committed
547

548
549
550
551
552
553
554
555
556
557
558
  @doc "Fetch some posts when the user has just been federated with"
  def fetch_initial_posts(user) do
    pages = Pleroma.Config.get!([:fetch_initial_posts, :pages])

    Enum.each(
      # Insert all the posts in reverse order, so they're in the right order on the timeline
      Enum.reverse(Utils.fetch_ordered_collection(user.info.source_data["outbox"], pages)),
      &Pleroma.Web.Federator.incoming_ap_doc/1
    )
  end

559
  def get_followers_query(%User{id: id, follower_address: follower_address}, nil) do
560
561
562
563
564
565
566
    from(
      u in User,
      where: fragment("? <@ ?", ^[follower_address], u.following),
      where: u.id != ^id
    )
  end

567
  def get_followers_query(user, page) do
Maxim Filippov's avatar
Maxim Filippov committed
568
569
    from(u in get_followers_query(user, nil))
    |> paginate(page, 20)
570
571
572
573
574
575
  end

  def get_followers_query(user), do: get_followers_query(user, nil)

  def get_followers(user, page \\ nil) do
    q = get_followers_query(user, page)
lain's avatar
lain committed
576
577
578
579

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

580
581
582
583
584
585
  def get_followers_ids(user, page \\ nil) do
    q = get_followers_query(user, page)

    Repo.all(from(u in q, select: u.id))
  end

586
  def get_friends_query(%User{id: id, following: following}, nil) do
587
588
589
590
591
592
593
    from(
      u in User,
      where: u.follower_address in ^following,
      where: u.id != ^id
    )
  end

594
  def get_friends_query(user, page) do
Maxim Filippov's avatar
Maxim Filippov committed
595
596
    from(u in get_friends_query(user, nil))
    |> paginate(page, 20)
597
598
599
600
601
602
  end

  def get_friends_query(user), do: get_friends_query(user, nil)

  def get_friends(user, page \\ nil) do
    q = get_friends_query(user, page)
lain's avatar
lain committed
603
604
605

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

607
608
609
610
611
612
  def get_friends_ids(user, page \\ nil) do
    q = get_friends_query(user, page)

    Repo.all(from(u in q, select: u.id))
  end

613
614
615
  def get_follow_requests_query(%User{} = user) do
    from(
      a in Activity,
kaniini's avatar
kaniini committed
616
617
618
619
620
621
622
623
624
625
626
627
      where:
        fragment(
          "? ->> 'type' = 'Follow'",
          a.data
        ),
      where:
        fragment(
          "? ->> 'state' = 'pending'",
          a.data
        ),
      where:
        fragment(
628
          "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
kaniini's avatar
kaniini committed
629
          a.data,
630
631
          a.data,
          ^user.ap_id
kaniini's avatar
kaniini committed
632
        )
633
634
635
636
637
    )
  end

  def get_follow_requests(%User{} = user) do
    users =
638
639
      user
      |> User.get_follow_requests_query()
640
641
642
643
644
      |> join(:inner, [a], u in User, a.actor == u.ap_id)
      |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
      |> group_by([a, u], u.id)
      |> select([a, u], u)
      |> Repo.all()
645
646
647
648

    {:ok, users}
  end

649
  def increase_note_count(%User{} = user) do
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
    User
    |> where(id: ^user.id)
    |> update([u],
      set: [
        info:
          fragment(
            "jsonb_set(?, '{note_count}', ((?->>'note_count')::int + 1)::varchar::jsonb, true)",
            u.info,
            u.info
          )
      ]
    )
    |> Repo.update_all([], returning: true)
    |> case do
      {1, [user]} -> set_cache(user)
      _ -> {:error, user}
    end
667
668
  end

669
  def decrease_note_count(%User{} = user) do
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
    User
    |> where(id: ^user.id)
    |> update([u],
      set: [
        info:
          fragment(
            "jsonb_set(?, '{note_count}', (greatest(0, (?->>'note_count')::int - 1))::varchar::jsonb, true)",
            u.info,
            u.info
          )
      ]
    )
    |> Repo.update_all([], returning: true)
    |> case do
      {1, [user]} -> set_cache(user)
      _ -> {:error, user}
    end
687
688
  end

689
  def update_note_count(%User{} = user) do
lain's avatar
lain committed
690
691
692
693
694
695
    note_count_query =
      from(
        a in Object,
        where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
        select: count(a.id)
      )
696
697
698

    note_count = Repo.one(note_count_query)

lain's avatar
lain committed
699
    info_cng = User.Info.set_note_count(user.info, note_count)
700

lain's avatar
lain committed
701
702
703
    cng =
      change(user)
      |> put_embed(:info, info_cng)
704

lain's avatar
lain committed
705
    update_and_set_cache(cng)
706
707
708
  end

  def update_follower_count(%User{} = user) do
lain's avatar
lain committed
709
    follower_count_query =
710
711
712
713
      User
      |> where([u], ^user.follower_address in u.following)
      |> where([u], u.id != ^user.id)
      |> select([u], %{count: count(u.id)})
714

715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
    User
    |> where(id: ^user.id)
    |> join(:inner, [u], s in subquery(follower_count_query))
    |> update([u, s],
      set: [
        info:
          fragment(
            "jsonb_set(?, '{follower_count}', ?::varchar::jsonb, true)",
            u.info,
            s.count
          )
      ]
    )
    |> Repo.update_all([], returning: true)
    |> case do
      {1, [user]} -> set_cache(user)
      _ -> {:error, user}
    end
733
  end
734

735
  def get_users_from_set_query(ap_ids, false) do
736
737
    from(
      u in User,
738
      where: u.ap_id in ^ap_ids
739
740
741
    )
  end

742
743
  def get_users_from_set_query(ap_ids, true) do
    query = get_users_from_set_query(ap_ids, false)
744
745
746

    from(
      u in query,
747
748
749
750
      where: u.local == true
    )
  end

751
752
753
754
755
  def get_users_from_set(ap_ids, local_only \\ true) do
    get_users_from_set_query(ap_ids, local_only)
    |> Repo.all()
  end

756
  def get_recipients_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
757
758
759
760
761
762
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        or_where: fragment("? && ?", u.following, ^to)
      )
763

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

766
767
768
    Repo.all(query)
  end

769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
  @spec search_for_admin(%{
          local: boolean(),
          page: number(),
          page_size: number()
        }) :: {:ok, [Pleroma.User.t()], number()}
  def search_for_admin(%{query: nil, local: local, page: page, page_size: page_size}) do
    query =
      from(u in User, order_by: u.id)
      |> maybe_local_user_query(local)

    paginated_query =
      query
      |> paginate(page, page_size)

    count =
      query
      |> Repo.aggregate(:count, :id)

    {:ok, Repo.all(paginated_query), count}
  end

  @spec search_for_admin(%{
          query: binary(),
Maxim Filippov's avatar
Maxim Filippov committed
792
793
794
795
796
          admin: Pleroma.User.t(),
          local: boolean(),
          page: number(),
          page_size: number()
        }) :: {:ok, [Pleroma.User.t()], number()}
797
798
799
800
801
802
803
  def search_for_admin(%{
        query: term,
        admin: admin,
        local: local,
        page: page,
        page_size: page_size
      }) do
804
    term = String.trim_leading(term, "@")
805

Maxim Filippov's avatar
Maxim Filippov committed
806
807
808
809
    local_paginated_query =
      User
      |> maybe_local_user_query(local)
      |> paginate(page, page_size)
lain's avatar
lain committed
810

Maxim Filippov's avatar
Maxim Filippov committed
811
    search_query = fts_search_subquery(term, local_paginated_query)
812

Maxim Filippov's avatar
Maxim Filippov committed
813
814
815
816
817
    count =
      term
      |> fts_search_subquery()
      |> maybe_local_user_query(local)
      |> Repo.aggregate(:count, :id)
lain's avatar
lain committed
818

Maxim Filippov's avatar
Maxim Filippov committed
819
    {:ok, do_search(search_query, admin), count}
820
  end
lain's avatar
lain committed
821

822
  def search(query, resolve \\ false, for_user \\ nil) do
823
    # Strip the beginning @ off if there is a query
824
825
    query = String.trim_leading(query, "@")

826
    if resolve, do: get_or_fetch(query)
lain's avatar
lain committed
827

828
    fts_results = do_search(fts_search_subquery(query), for_user)
829

lain's avatar
lain committed
830
831
832
833
834
    {:ok, trigram_results} =
      Repo.transaction(fn ->
        Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
        do_search(trigram_search_subquery(query), for_user)
      end)
lain's avatar
lain committed
835

836
837
    Enum.uniq_by(fts_results ++ trigram_results, & &1.id)
  end
lain's avatar
lain committed
838

839
  defp do_search(subquery, for_user, options \\ []) do
kaniini's avatar
kaniini committed
840
841
    q =
      from(
842
        s in subquery(subquery),
843
        order_by: [desc: s.search_rank],
844
        limit: ^(options[:limit] || 20)
kaniini's avatar
kaniini committed
845
      )
lain's avatar
lain committed
846

847
848
849
850
851
    results =
      q
      |> Repo.all()
      |> Enum.filter(&(&1.search_rank > 0))

852
853
    boost_search_results(results, for_user)
  end
854

Maxim Filippov's avatar
Maxim Filippov committed
855
  defp fts_search_subquery(term, query \\ User) do
856
    processed_query =
857
      term
858
859
860
861
862
      |> String.replace(~r/\W+/, " ")
      |> String.trim()
      |> String.split()
      |> Enum.map(&(&1 <> ":*"))
      |> Enum.join(" | ")
863

864
    from(
865
      u in query,
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
      select_merge: %{
        search_rank:
          fragment(
            """
            ts_rank_cd(
              setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
              setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B'),
              to_tsquery('simple', ?),
              32
            )
            """,
            u.nickname,
            u.name,
            ^processed_query
          )
      },
lain's avatar
lain committed
882
883
884
885
886
887
888
889
890
891
      where:
        fragment(
          """
            (setweight(to_tsvector('simple', regexp_replace(?, '\\W', ' ', 'g')), 'A') ||
            setweight(to_tsvector('simple', regexp_replace(coalesce(?, ''), '\\W', ' ', 'g')), 'B')) @@ to_tsquery('simple', ?)
          """,
          u.nickname,
          u.name,
          ^processed_query
        )
892
893
    )
  end
894

Maxim Filippov's avatar
Maxim Filippov committed
895
  defp trigram_search_subquery(term) do
896
897
898
899
900
    from(
      u in User,
      select_merge: %{
        search_rank:
          fragment(
901
            "similarity(?, trim(? || ' ' || coalesce(?, '')))",
902
            ^term,
903
904
905
906
            u.nickname,
            u.name
          )
      },
907
      where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
908
909
910
911
912
913
914
915
    )
  end

  defp boost_search_results(results, nil), do: results

  defp boost_search_results(results, for_user) do
    friends_ids = get_friends_ids(for_user)
    followers_ids = get_followers_ids(for_user)
916

917
918
919
920
921
922
923
924
925
926
927
928
929
    Enum.map(
      results,
      fn u ->
        search_rank_coef =
          cond do
            u.id in friends_ids ->
              1.2

            u.id in followers_ids ->
              1.1

            true ->
              1
930
931
          end

932
933
934
935
        Map.put(u, :search_rank, u.search_rank * search_rank_coef)
      end
    )
    |> Enum.sort_by(&(-&1.search_rank))
lain's avatar
lain committed
936
  end
lain's avatar
lain committed
937

938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
  def blocks_import(%User{} = blocker, blocked_identifiers) when is_list(blocked_identifiers) do
    Enum.map(
      blocked_identifiers,
      fn blocked_identifier ->
        with %User{} = blocked <- get_or_fetch(blocked_identifier),
             {:ok, blocker} <- block(blocker, blocked),
             {:ok, _} <- ActivityPub.block(blocker, blocked) do
          blocked
        else
          err ->
            Logger.debug("blocks_import failed for #{blocked_identifier} with: #{inspect(err)}")
            err
        end
      end
    )
  end

955
  def mute(muter, %User{ap_id: ap_id}) do
956
957
958
959
960
961
962
    info_cng =
      muter.info
      |> User.Info.add_to_mutes(ap_id)

    cng =
      change(muter)
      |> put_embed(:info, info_cng)
963

964
    update_and_set_cache(cng)
965
966
  end

967
968
969
970
  def unmute(muter, %{ap_id: ap_id}) do
    info_cng =
      muter.info
      |> User.Info.remove_from_mutes(ap_id)
971

972
973
974
975
976
    cng =
      change(muter)
      |> put_embed(:info, info_cng)

    update_and_set_cache(cng)
977
978
  end

979
980
981
982
983
984
985
986
987
988
989
990
991
992
  def block(blocker, %User{ap_id: ap_id} = blocked) do
    # sever any follow relationships to prevent leaks per activitypub (Pleroma issue #213)
    blocker =
      if following?(blocker, blocked) do
        {:ok, blocker, _} = unfollow(blocker, blocked)
        blocker
      else
        blocker
      end

    if following?(blocked, blocker) do
      unfollow(blocked, blocker)
    end

lain's avatar
lain committed
993
994
995
    info_cng =
      blocker.info
      |> User.Info.add_to_block(ap_id)
lain's avatar
lain committed
996

lain's avatar
lain committed
997
998
999
1000
1001
    cng =
      change(blocker)
      |> put_embed(:info, info_cng)

    update_and_set_cache(cng)
lain's avatar
lain committed
1002
1003
  end

1004
1005
1006
1007
1008
  # helper to handle the block given only an actor's AP id
  def block(blocker, %{ap_id: ap_id}) do
    block(blocker, User.get_by_ap_id(ap_id))
  end

lain's avatar
lain committed
1009
1010
1011
1012
  def unblock(blocker, %{ap_id: ap_id}) do
    info_cng =
      blocker.info
      |> User.Info.remove_from_block(ap_id)
lain's avatar
lain committed
1013

lain's avatar
lain committed
1014
1015
1016
1017
1018
    cng =
      change(blocker)
      |> put_embed(:info, info_cng)

    update_and_set_cache(cng)
lain's avatar
lain committed
1019
1020
  end

1021
  def mutes?(nil, _), do: false
1022
  def mutes?(user, %{ap_id: ap_id}), do: Enum.member?(user.info.mutes, ap_id)
1023

lain's avatar
lain committed
1024
  def blocks?(user, %{ap_id: ap_id}) do
lain's avatar
lain committed
1025
1026
    blocks = user.info.blocks
    domain_blocks = user.info.domain_blocks
eal's avatar
eal committed
1027
    %{host: host} = URI.parse(ap_id)
eal's avatar
eal committed
1028
1029
1030
1031
1032

    Enum.member?(blocks, ap_id) ||
      Enum.any?(domain_blocks, fn domain ->
        host == domain
      end)
eal's avatar
eal committed
1033
1034
  end

1035
1036
1037
  def muted_users(user),
    do: Repo.all(from(u in User, where: u.ap_id in ^user.info.mutes))

1038
1039
1040
  def blocked_users(user),
    do: Repo.all(from(u in User, where: u.ap_id in ^user.info.blocks))

eal's avatar
eal committed
1041
  def block_domain(user, domain) do
lain's avatar
lain committed
1042
1043
1044
    info_cng =
      user.info
      |> User.Info.add_to_domain_block(domain)
eal's avatar
eal committed
1045

lain's avatar
lain committed
1046
1047
1048
    cng =
      change(user)
      |> put_embed(:info, info_cng)
lain's avatar
lain committed
1049
1050

    update_and_set_cache(cng)
eal's avatar
eal committed
1051
1052
1053
  end

  def unblock_domain(user, domain) do
lain's avatar
lain committed
1054
1055
1056
    info_cng =
      user.info
      |> User.Info.remove_from_domain_block(domain)
eal's avatar
eal committed
1057

lain's avatar
lain committed
1058
1059
1060
    cng =
      change(user)
      |> put_embed(:info, info_cng)
lain's avatar
lain committed
1061
1062

    update_and_set_cache(cng)
lain's avatar
lain committed