user.ex 38 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
16
  alias Pleroma.Registration
Haelwenn's avatar
Haelwenn committed
17
18
19
  alias Pleroma.Repo
  alias Pleroma.User
  alias Pleroma.Web
20
21
  alias Pleroma.Web.ActivityPub.ActivityPub
  alias Pleroma.Web.ActivityPub.Utils
Maxim Filippov's avatar
Maxim Filippov committed
22
  alias Pleroma.Web.CommonAPI.Utils, as: CommonUtils
Haelwenn's avatar
Haelwenn committed
23
  alias Pleroma.Web.OAuth
24
  alias Pleroma.Web.OStatus
25
  alias Pleroma.Web.RelMe
26
  alias Pleroma.Web.Websub
lain's avatar
lain committed
27

28
29
  require Logger

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

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

34
  # credo:disable-for-next-line Credo.Check.Readability.MaxLineLength
href's avatar
href committed
35
36
37
  @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
38
  @extended_local_nickname_regex ~r/^[a-zA-Z\d_-]+$/
href's avatar
href committed
39

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

    timestamps()
  end
lain's avatar
lain committed
64

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

68
  def auth_active?(%User{}), do: true
69

70
71
72
73
74
  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
75
    auth_active?(user) || superuser?(for_user)
76
77
  end

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

80
81
  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
82
  def superuser?(_), do: false
83

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

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

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

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

106
107
  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
108

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

lain's avatar
lain committed
218
219
220
    changeset =
      struct
      |> cast(params, [:bio, :email, :name, :nickname, :password, :password_confirmation])
221
      |> validate_required([:name, :nickname, :password, :password_confirmation])
lain's avatar
lain committed
222
223
224
      |> validate_confirmation(:password)
      |> unique_constraint(:email)
      |> unique_constraint(:nickname)
lain's avatar
lain committed
225
      |> validate_exclusion(:nickname, Pleroma.Config.get([Pleroma.User, :restricted_nicknames]))
href's avatar
href committed
226
      |> validate_format(:nickname, local_nickname_regex())
lain's avatar
lain committed
227
228
229
      |> validate_format(:email, @email_regex)
      |> validate_length(:bio, max: 1000)
      |> validate_length(:name, min: 1, max: 100)
Ivan Tashkinov's avatar
Ivan Tashkinov committed
230
      |> put_change(:info, info_change)
lain's avatar
lain committed
231

232
233
234
235
236
237
238
    changeset =
      if opts[:external] do
        changeset
      else
        validate_required(changeset, [:email])
      end

lain's avatar
lain committed
239
    if changeset.valid? do
240
      hashed = Pbkdf2.hashpwsalt(changeset.changes[:password])
lain's avatar
lain committed
241
242
      ap_id = User.ap_id(%User{nickname: changeset.changes[:nickname]})
      followers = User.ap_followers(%User{nickname: changeset.changes[:nickname]})
lain's avatar
lain committed
243

lain's avatar
lain committed
244
245
246
      changeset
      |> put_change(:password_hash, hashed)
      |> put_change(:ap_id, ap_id)
rinpatch's avatar
rinpatch committed
247
      |> unique_constraint(:ap_id)
lain's avatar
lain committed
248
      |> put_change(:following, [followers])
249
      |> put_change(:follower_address, followers)
lain's avatar
lain committed
250
251
252
253
254
    else
      changeset
    end
  end

255
256
257
258
259
260
261
262
263
264
  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
265
    follow_all(user, autofollowed_users)
266
267
  end

268
269
  @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
270
    with {:ok, user} <- Repo.insert(changeset),
lain's avatar
lain committed
271
         {:ok, user} <- autofollow_users(user),
lain's avatar
lain committed
272
         {:ok, _} <- Pleroma.User.WelcomeMessage.post_welcome_message_to_user(user),
273
         {:ok, _} <- try_send_confirmation_email(user) do
274
275
276
277
      {:ok, user}
    end
  end

278
  def try_send_confirmation_email(%User{} = user) do
279
280
    if user.info.confirmation_pending &&
         Pleroma.Config.get([:instance, :account_activation_required]) do
281
282
283
284
      :ok =
        user
        |> Pleroma.Emails.UserEmail.account_confirmation_email()
        |> Pleroma.Emails.Mailer.deliver_async()
285
286

      {:ok, :enqueued}
287
288
289
290
291
    else
      {:ok, :noop}
    end
  end

292
293
294
295
296
  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
297
    NaiveDateTime.diff(NaiveDateTime.utc_now(), user.last_refreshed_at) >= 86_400
298
299
300
301
  end

  def needs_update?(_), do: true

lain's avatar
lain committed
302
  def maybe_direct_follow(%User{} = follower, %User{local: true, info: %{locked: true}}) do
303
304
305
306
307
308
309
310
    {: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
311
    if not User.ap_enabled?(followed) do
312
      follow(follower, followed)
313
314
315
316
317
    else
      {:ok, follower}
    end
  end

Maksim's avatar
Maksim committed
318
  def maybe_follow(%User{} = follower, %User{info: _info} = followed) do
319
320
    if not following?(follower, followed) do
      follow(follower, followed)
321
    else
322
      {:ok, follower}
323
324
325
    end
  end

326
  @doc "A mass follow for local users. Respects blocks in both directions but does not create activities."
lain's avatar
lain committed
327
328
  @spec follow_all(User.t(), list(User.t())) :: {atom(), User.t()}
  def follow_all(follower, followeds) do
lain's avatar
lain committed
329
330
    followed_addresses =
      followeds
331
      |> Enum.reject(fn followed -> blocks?(follower, followed) || blocks?(followed, follower) end)
lain's avatar
lain committed
332
      |> Enum.map(fn %{follower_address: fa} -> fa end)
lain's avatar
lain committed
333

lain's avatar
lain committed
334
335
336
    q =
      from(u in User,
        where: u.id == ^follower.id,
337
338
339
340
341
342
343
344
345
        update: [
          set: [
            following:
              fragment(
                "array(select distinct unnest (array_cat(?, ?)))",
                u.following,
                ^followed_addresses
              )
          ]
rinpatch's avatar
rinpatch committed
346
347
        ],
        select: u
lain's avatar
lain committed
348
349
      )

rinpatch's avatar
rinpatch committed
350
    {1, [follower]} = Repo.update_all(q, [])
lain's avatar
lain committed
351
352
353
354
355

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

lain's avatar
lain committed
356
    set_cache(follower)
lain's avatar
lain committed
357
358
  end

lain's avatar
lain committed
359
  def follow(%User{} = follower, %User{info: info} = followed) do
360
361
    user_config = Application.get_env(:pleroma, :user)
    deny_follow_blocked = Keyword.get(user_config, :deny_follow_blocked)
362

363
    ap_followers = followed.follower_address
364

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

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

372
373
374
375
376
      true ->
        if !followed.local && follower.local && !ap_enabled?(followed) do
          Websub.subscribe(follower, followed)
        end

377
378
379
        q =
          from(u in User,
            where: u.id == ^follower.id,
rinpatch's avatar
rinpatch committed
380
381
            update: [push: [following: ^ap_followers]],
            select: u
382
          )
383

rinpatch's avatar
rinpatch committed
384
        {1, [follower]} = Repo.update_all(q, [])
385

386
387
        {:ok, _} = update_follower_count(followed)

388
        set_cache(follower)
389
    end
lain's avatar
lain committed
390
  end
lain's avatar
lain committed
391
392

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

395
    if following?(follower, followed) and follower.ap_id != followed.ap_id do
396
397
398
      q =
        from(u in User,
          where: u.id == ^follower.id,
rinpatch's avatar
rinpatch committed
399
400
          update: [pull: [following: ^ap_followers]],
          select: u
401
        )
lain's avatar
lain committed
402

rinpatch's avatar
rinpatch committed
403
      {1, [follower]} = Repo.update_all(q, [])
404
405
406

      {:ok, followed} = update_follower_count(followed)

407
408
      set_cache(follower)

409
      {:ok, follower, Utils.fetch_latest_follow(follower, followed)}
410
    else
411
      {:error, "Not subscribed!"}
412
    end
lain's avatar
lain committed
413
  end
414

Maksim's avatar
Maksim committed
415
  @spec following?(User.t(), User.t()) :: boolean
416
  def following?(%User{} = follower, %User{} = followed) do
417
    Enum.member?(follower.following, followed.follower_address)
418
  end
lain's avatar
lain committed
419

420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
  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

438
  def locked?(%User{} = user) do
439
    user.info.locked || false
440
441
  end

442
443
444
445
  def get_by_id(id) do
    Repo.get_by(User, id: id)
  end

lain's avatar
lain committed
446
447
448
449
  def get_by_ap_id(ap_id) do
    Repo.get_by(User, ap_id: ap_id)
  end

450
451
  # 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
452
453
454
455
456
457
458
459
  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

460
461
462
463
464
465
466
  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
467
468
  def update_and_set_cache(changeset) do
    with {:ok, user} <- Repo.update(changeset) do
469
      set_cache(user)
lain's avatar
lain committed
470
471
472
473
474
    else
      e -> e
    end
  end

lain's avatar
lain committed
475
476
477
  def invalidate_cache(user) do
    Cachex.del(:user_cache, "ap_id:#{user.ap_id}")
    Cachex.del(:user_cache, "nickname:#{user.nickname}")
478
    Cachex.del(:user_cache, "user_info:#{user.id}")
lain's avatar
lain committed
479
480
  end

lain's avatar
lain committed
481
  def get_cached_by_ap_id(ap_id) do
482
    key = "ap_id:#{ap_id}"
Thog's avatar
Thog committed
483
    Cachex.fetch!(:user_cache, key, fn _ -> get_by_ap_id(ap_id) end)
lain's avatar
lain committed
484
485
  end

486
487
  def get_cached_by_id(id) do
    key = "id:#{id}"
488
489
490
491

    ap_id =
      Cachex.fetch!(:user_cache, key, fn _ ->
        user = get_by_id(id)
492
493
494
495
496
497
498

        if user do
          Cachex.put(:user_cache, "ap_id:#{user.ap_id}", user)
          {:commit, user.ap_id}
        else
          {:ignore, ""}
        end
499
500
501
      end)

    get_cached_by_ap_id(ap_id)
502
503
  end

lain's avatar
lain committed
504
  def get_cached_by_nickname(nickname) do
505
    key = "nickname:#{nickname}"
Thog's avatar
Thog committed
506
    Cachex.fetch!(:user_cache, key, fn _ -> get_or_fetch_by_nickname(nickname) end)
lain's avatar
lain committed
507
  end
lain's avatar
lain committed
508

509
  def get_cached_by_nickname_or_id(nickname_or_id) do
510
    get_cached_by_id(nickname_or_id) || get_cached_by_nickname(nickname_or_id)
511
512
  end

lain's avatar
lain committed
513
  def get_by_nickname(nickname) do
514
    Repo.get_by(User, nickname: nickname) ||
515
      if Regex.match?(~r(@#{Pleroma.Web.Endpoint.host()})i, nickname) do
516
        Repo.get_by(User, nickname: local_nickname(nickname))
517
      end
518
519
  end

520
521
  def get_by_email(email), do: Repo.get_by(User, email: email)

522
  def get_by_nickname_or_email(nickname_or_email) do
523
    get_by_nickname(nickname_or_email) || get_by_email(nickname_or_email)
524
525
  end

lain's avatar
lain committed
526
527
  def get_cached_user_info(user) do
    key = "user_info:#{user.id}"
Thog's avatar
Thog committed
528
    Cachex.fetch!(:user_cache, key, fn _ -> user_info(user) end)
lain's avatar
lain committed
529
  end
lain's avatar
lain committed
530

lain's avatar
lain committed
531
532
533
534
535
536
537
538
539
  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
540
  def get_or_fetch_by_nickname(nickname) do
lain's avatar
lain committed
541
    with %User{} = user <- get_by_nickname(nickname) do
lain's avatar
lain committed
542
      user
lain's avatar
lain committed
543
544
545
546
    else
      _e ->
        with [_nick, _domain] <- String.split(nickname, "@"),
             {:ok, user} <- fetch_by_nickname(nickname) do
547
548
549
550
          if Pleroma.Config.get([:fetch_initial_posts, :enabled]) do
            {:ok, _} = Task.start(__MODULE__, :fetch_initial_posts, [user])
          end

lain's avatar
lain committed
551
552
553
554
          user
        else
          _e -> nil
        end
lain's avatar
lain committed
555
    end
lain's avatar
lain committed
556
  end
lain's avatar
lain committed
557

558
559
560
561
562
563
564
565
566
567
568
  @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

569
  def get_followers_query(%User{id: id, follower_address: follower_address}, nil) do
570
571
572
573
574
575
576
    from(
      u in User,
      where: fragment("? <@ ?", ^[follower_address], u.following),
      where: u.id != ^id
    )
  end

577
  def get_followers_query(user, page) do
Maxim Filippov's avatar
Maxim Filippov committed
578
579
    from(u in get_followers_query(user, nil))
    |> paginate(page, 20)
580
581
582
583
584
585
  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
586
587
588
589

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

590
591
592
593
594
595
  def get_followers_ids(user, page \\ nil) do
    q = get_followers_query(user, page)

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

596
  def get_friends_query(%User{id: id, following: following}, nil) do
597
598
599
600
601
602
603
    from(
      u in User,
      where: u.follower_address in ^following,
      where: u.id != ^id
    )
  end

604
  def get_friends_query(user, page) do
Maxim Filippov's avatar
Maxim Filippov committed
605
606
    from(u in get_friends_query(user, nil))
    |> paginate(page, 20)
607
608
609
610
611
612
  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
613
614
615

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

617
618
619
620
621
622
  def get_friends_ids(user, page \\ nil) do
    q = get_friends_query(user, page)

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

623
624
625
  def get_follow_requests_query(%User{} = user) do
    from(
      a in Activity,
kaniini's avatar
kaniini committed
626
627
628
629
630
631
632
633
634
635
636
637
      where:
        fragment(
          "? ->> 'type' = 'Follow'",
          a.data
        ),
      where:
        fragment(
          "? ->> 'state' = 'pending'",
          a.data
        ),
      where:
        fragment(
638
          "coalesce((?)->'object'->>'id', (?)->>'object') = ?",
kaniini's avatar
kaniini committed
639
          a.data,
640
641
          a.data,
          ^user.ap_id
kaniini's avatar
kaniini committed
642
        )
643
644
645
646
647
    )
  end

  def get_follow_requests(%User{} = user) do
    users =
648
649
      user
      |> User.get_follow_requests_query()
rinpatch's avatar
rinpatch committed
650
      |> join(:inner, [a], u in User, on: a.actor == u.ap_id)
651
652
653
654
      |> where([a, u], not fragment("? @> ?", u.following, ^[user.follower_address]))
      |> group_by([a, u], u.id)
      |> select([a, u], u)
      |> Repo.all()
655
656
657
658

    {:ok, users}
  end

659
  def increase_note_count(%User{} = user) do
660
661
662
663
664
665
666
667
668
669
670
671
    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
          )
      ]
    )
rinpatch's avatar
rinpatch committed
672
673
    |> select([u], u)
    |> Repo.update_all([])
674
675
676
677
    |> case do
      {1, [user]} -> set_cache(user)
      _ -> {:error, user}
    end
678
679
  end

680
  def decrease_note_count(%User{} = user) do
681
682
683
684
685
686
687
688
689
690
691
692
    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
          )
      ]
    )
rinpatch's avatar
rinpatch committed
693
694
    |> select([u], u)
    |> Repo.update_all([])
695
696
697
698
    |> case do
      {1, [user]} -> set_cache(user)
      _ -> {:error, user}
    end
699
700
  end

701
  def update_note_count(%User{} = user) do
lain's avatar
lain committed
702
703
704
705
706
707
    note_count_query =
      from(
        a in Object,
        where: fragment("?->>'actor' = ? and ?->>'type' = 'Note'", a.data, ^user.ap_id, a.data),
        select: count(a.id)
      )
708
709
710

    note_count = Repo.one(note_count_query)

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

lain's avatar
lain committed
713
714
715
    cng =
      change(user)
      |> put_embed(:info, info_cng)
716

lain's avatar
lain committed
717
    update_and_set_cache(cng)
718
719
720
  end

  def update_follower_count(%User{} = user) do
lain's avatar
lain committed
721
    follower_count_query =
722
723
724
725
      User
      |> where([u], ^user.follower_address in u.following)
      |> where([u], u.id != ^user.id)
      |> select([u], %{count: count(u.id)})
726

727
728
729
730
731
732
733
734
735
736
737
738
739
    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
          )
      ]
    )
rinpatch's avatar
rinpatch committed
740
741
    |> select([u], u)
    |> Repo.update_all([])
742
743
744
745
    |> case do
      {1, [user]} -> set_cache(user)
      _ -> {:error, user}
    end
746
  end
747

748
  def get_users_from_set_query(ap_ids, false) do
749
750
    from(
      u in User,
751
      where: u.ap_id in ^ap_ids
752
753
754
    )
  end

755
756
  def get_users_from_set_query(ap_ids, true) do
    query = get_users_from_set_query(ap_ids, false)
757
758
759

    from(
      u in query,
760
761
762
763
      where: u.local == true
    )
  end

764
765
766
767
768
  def get_users_from_set(ap_ids, local_only \\ true) do
    get_users_from_set_query(ap_ids, local_only)
    |> Repo.all()
  end

769
  def get_recipients_from_activity(%Activity{recipients: to}) do
lain's avatar
lain committed
770
771
772
773
774
775
    query =
      from(
        u in User,
        where: u.ap_id in ^to,
        or_where: fragment("? && ?", u.following, ^to)
      )
776

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

779
780
781
    Repo.all(query)
  end

782
  def search(query, resolve \\ false, for_user \\ nil) do
783
    # Strip the beginning @ off if there is a query
784
785
    query = String.trim_leading(query, "@")

786
    if resolve, do: get_or_fetch(query)
lain's avatar
lain committed
787

788
    {:ok, results} =
lain's avatar
lain committed
789
790
      Repo.transaction(fn ->
        Ecto.Adapters.SQL.query(Repo, "select set_limit(0.25)", [])
791
        Repo.all(search_query(query, for_user))
lain's avatar
lain committed
792
      end)
lain's avatar
lain committed
793

794
    results
795
  end
lain's avatar
lain committed
796

797
798
799
  def search_query(query, for_user) do
    fts_subquery = fts_search_subquery(query)
    trigram_subquery = trigram_search_subquery(query)
800
801
    union_query = from(s in trigram_subquery, union_all: ^fts_subquery)
    distinct_query = from(s in subquery(union_query), order_by: s.search_type, distinct: s.id)
lain's avatar
lain committed
802

803
804
805
806
807
    from(s in subquery(boost_search_rank_query(distinct_query, for_user)),
      order_by: [desc: s.search_rank],
      limit: 20
    )
  end
808

809
810
811
812
813
814
815
816
817
818
819
  defp boost_search_rank_query(query, nil), do: query

  defp boost_search_rank_query(query, for_user) do
    friends_ids = get_friends_ids(for_user)
    followers_ids = get_followers_ids(for_user)

    from(u in subquery(query),
      select_merge: %{
        search_rank:
          fragment(
            """
820
             CASE WHEN (?) THEN (?) * 1.3
821
822
823
824
825
826
827
828
829
830
831
832
833
834
             WHEN (?) THEN (?) * 1.2
             WHEN (?) THEN (?) * 1.1
             ELSE (?) END
            """,
            u.id in ^friends_ids and u.id in ^followers_ids,
            u.search_rank,
            u.id in ^friends_ids,
            u.search_rank,
            u.id in ^followers_ids,
            u.search_rank,
            u.search_rank
          )
      }
    )
835
  end
836

Maxim Filippov's avatar
Maxim Filippov committed
837
  defp fts_search_subquery(term, query \\ User) do
838
    processed_query =
839
      term
840
841
842
843
844
      |> String.replace(~r/\W+/, " ")
      |> String.trim()
      |> String.split()
      |> Enum.map(&(&1 <> ":*"))
      |> Enum.join(" | ")
845

846
    from(
847
      u in query,
848
      select_merge: %{
849
        search_type: ^0,
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
        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
865
866
867
868
869
870
871
872
873
874
      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
        )
875
876
    )
  end
877

Maxim Filippov's avatar
Maxim Filippov committed
878
  defp trigram_search_subquery(term) do
879
880
881
    from(
      u in User,
      select_merge: %{
882
883
        # ^1 gives 'Postgrex expected a binary, got 1' for some weird reason
        search_type: fragment("?", 1),
884
885
        search_rank:
          fragment(
886
            "similarity(?, trim(? || ' ' || coalesce(?, '')))",
887
            ^term,
888
889
890
891
            u.nickname,
            u.name
          )
      },
892
      where: fragment("trim(? || ' ' || coalesce(?, '')) % ?", u.nickname, u.name, ^term)
893
894
895
    )
  end

896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
  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

913
  def mute(muter, %User{ap_id: ap_id}) do
914
915
916
917
918
919
920
    info_cng =
      muter.info
      |> User.Info.add_to_mutes(ap_id)

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

922
    update_and_set_cache(cng)
923
924
  end

925
926
927
928
  def unmute(muter, %{ap_id: ap_id}) do
    info_cng =
      muter.info
      |> User.Info.remove_from_mutes(ap_id)
929

930
931
932
933
934
    cng =
      change(muter)
      |> put_embed(:info, info_cng)

    update_and_set_cache(cng)
935
936
  end

937
  def subscribe(subscriber, %{ap_id: ap_id}) do
938
    deny_follow_blocked = Pleroma.Config.get([:user, :deny_follow_blocked])
939

940
    with %User{} = subscribed <- get_cached_by_ap_id(ap_id) do
941
942
943
944
945
946
947
948
949
950
951
952
953
      blocked = blocks?(subscribed, subscriber) and deny_follow_blocked

      if blocked do
        {:error, "Could not subscribe: #{subscribed.nickname} is blocking you"}
      else
        info_cng =
          subscribed.info
          |> User.Info.add_to_subscribers(subscriber.ap_id)

        change(subscribed)
        |> put_embed(:info, info_cng)
        |> update_and_set_cache()
      end
954
    end
955
956
957
  end

  def unsubscribe(unsubscriber, %{ap_id: ap_id}) do
958
    with %User{} = user <- get_cached_by_ap_id(ap_id) do
959
960
961
      info_cng =
        user.info
        |> User.Info.remove_from_subscribers(unsubscriber.ap_id)
962

963
964
965
966
      change(user)
      |> put_embed(:info, info_cng)
      |> update_and_set_cache()
    end
967
968
  end

969
970
971
972
973
974
975
976
977
978
  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

979
980
981
982
983
984
985
986
    blocker =
      if subscribed_to?(blocked, blocker) do
        {:ok, blocker} = unsubscribe(blocked, blocker)
        blocker
      else
        blocker
      end

987
988
989
990
    if following?(blocked, blocker) do
      unfollow(blocked, blocker)
    end

991
992
    {:ok, blocker} = update_follower_count(blocker)

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
    cng =
      change(blocker)
      |> put_embed(:info, info_cng)

For faster browsing, not all history is shown. View entire blame