user.ex 36.2 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
  end

107
108
  def ap_followers(%User{follower_address: fa}) when is_binary(fa), do: fa
  def ap_followers(%User{} = user), do: "#{ap_id(user)}/followers"
lain's avatar
lain committed
109

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

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

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

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

lain's avatar
lain committed
130
    changes =
lain's avatar
lain committed
131
      %User{}
lain's avatar
lain committed
132
      |> cast(params, [:bio, :name, :ap_id, :nickname, :avatar])
133
      |> validate_required([:name, :ap_id])
lain's avatar
lain committed
134
135
136
137
138
      |> 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
139
      |> put_embed(:info, info_cng)
lain's avatar
lain committed
140

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

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

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

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

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

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

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

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

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

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

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

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

209
210
211
212
213
214
215
216
  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
217
218
    info_change = User.Info.confirmation_changeset(%User.Info{}, confirmation_status)

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

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

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

249
250
251
252
253
254
255
256
257
258
  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
259
    follow_all(user, autofollowed_users)
260
261
  end

262
263
  @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
264
    with {:ok, user} <- Repo.insert(changeset),
lain's avatar
lain committed
265
         {:ok, user} <- autofollow_users(user),
lain's avatar
lain committed
266
         {:ok, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
lain's avatar
lain committed
267
         {:ok, _} <- try_send_confirmation_email(user) do
268
269
270
271
      {:ok, user}
    end
  end

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

283
284
285
286
287
  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
288
    NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
289
290
291
292
  end

  def needs_update?(_), do: true

lain's avatar
lain committed
293
  def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
294
295
296
297
298
299
300
301
    {: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
302
    if not User.ap_enabled?(followed) do
303
      follow(follower, followed)
304
305
306
307
308
    else
      {:ok, follower}
    end
  end

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

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

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

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

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

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

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

353
    ap_followers = followed.follower_address
354

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

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

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

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

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

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

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

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

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

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

      {:ok, followed} = update_follower_count(followed)

395
396
      set_cache(follower)

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

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

408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
  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

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

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

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

438
439
  # 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
440
441
442
443
444
445
446
447
  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

448
449
450
451
452
453
454
  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
455
456
  def update_and_set_cache(changeset) do
    with {:ok, user} <- Repo.update(changeset) do
457
      set_cache(user)
lain's avatar
lain committed
458
459
460
461
462
    else
      e -> e
    end
  end

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

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

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

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

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

    get_cached_by_ap_id(ap_id)
490
491
  end

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

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

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

508
509
510
511
512
513
514
  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
515
516
  def get_cached_user_info(user) do
    key = "user_info:#{user.id}"
Thog's avatar
Thog committed
517
    Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
lain's avatar
lain committed
518
  end
lain's avatar
lain committed
519

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

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

547
548
549
550
551
552
553
554
555
556
557
  @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

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

566
  def get_followers_query(user, page) do
Maxim Filippov's avatar
Maxim Filippov committed
567
568
    from(u in get_followers_query(user, nil))
    |> paginate(page, 20)
569
570
571
572
573
574
  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
575
576
577
578

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

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

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

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

593
  def get_friends_query(user, page) do
Maxim Filippov's avatar
Maxim Filippov committed
594
595
    from(u in get_friends_query(user, nil))
    |> paginate(page, 20)
596
597
598
599
600
601
  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
602
603
604

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

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

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

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

  def get_follow_requests(%User{} = user) do
    users =
637
638
      user
      |> User.get_follow_requests_query()
639
640
641
642
643
      |> 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()
644
645
646
647

    {:ok, users}
  end

648
  def increase_note_count(%User{} = user) do
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
    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
666
667
  end

668
  def decrease_note_count(%User{} = user) do
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
    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
686
687
  end

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

    note_count = Repo.one(note_count_query)

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

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

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

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

714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
    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
732
  end
733

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

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

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

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

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

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

765
766
767
    Repo.all(query)
  end

768
769
770
771
772
773
774
  @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 =
Maxim Filippov's avatar
Maxim Filippov committed
775
      from(u in User, order_by: u.nickname)
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
      |> 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
791
792
793
794
795
          admin: Pleroma.User.t(),
          local: boolean(),
          page: number(),
          page_size: number()
        }) :: {:ok, [Pleroma.User.t()], number()}
796
797
798
799
800
801
802
  def search_for_admin(%{
        query: term,
        admin: admin,
        local: local,
        page: page,
        page_size: page_size
      }) do
803
    term = String.trim_leading(term, "@")
804

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

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

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

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

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

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

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

lain's avatar
lain committed
829
830
831
832
833
    {: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
834

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

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

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

851
852
    boost_search_results(results, for_user)
  end
853

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

863
    from(
864
      u in query,
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
      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
881
882
883
884
885
886
887
888
889
890
      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
        )
891
892
    )
  end
893

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

916
917
918
919
920
921
922
923
924
925
926
927
928
    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
929
930
          end

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

937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
  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

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

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

963
    update_and_set_cache(cng)
964
965
  end

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

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

    update_and_set_cache(cng)
976
977
  end

978
979
980
981
982
983
984
985
986
987
988
989
990
991
  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
992
993
994
    info_cng =
      blocker.info
      |> User.Info.add_to_block(ap_id)
lain's avatar
lain committed
995

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

    update_and_set_cache(cng)
For faster browsing, not all history is shown. View entire blame