about summary refs log tree commit diff
path: root/app/models/user.rb
blob: 2ee304e81039b50e33c4b85ed72e9e891f5b3ab8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
# frozen_string_literal: true
# == Schema Information
#
# Table name: users
#
#  id                        :bigint(8)        not null, primary key
#  email                     :string           default(""), not null
#  created_at                :datetime         not null
#  updated_at                :datetime         not null
#  encrypted_password        :string           default(""), not null
#  reset_password_token      :string
#  reset_password_sent_at    :datetime
#  remember_created_at       :datetime
#  sign_in_count             :integer          default(0), not null
#  current_sign_in_at        :datetime
#  last_sign_in_at           :datetime
#  current_sign_in_ip        :inet
#  last_sign_in_ip           :inet
#  admin                     :boolean          default(FALSE), not null
#  confirmation_token        :string
#  confirmed_at              :datetime
#  confirmation_sent_at      :datetime
#  unconfirmed_email         :string
#  locale                    :string
#  encrypted_otp_secret      :string
#  encrypted_otp_secret_iv   :string
#  encrypted_otp_secret_salt :string
#  consumed_timestep         :integer
#  otp_required_for_login    :boolean          default(FALSE), not null
#  last_emailed_at           :datetime
#  otp_backup_codes          :string           is an Array
#  filtered_languages        :string           default([]), not null, is an Array
#  account_id                :bigint(8)        not null
#  disabled                  :boolean          default(FALSE), not null
#  moderator                 :boolean          default(FALSE), not null
#  invite_id                 :bigint(8)
#  remember_token            :string
#  chosen_languages          :string           is an Array
#  created_by_application_id :bigint(8)
#  approved                  :boolean          default(TRUE), not null
#  vars                      :jsonb            not null
#  hide_boosts               :boolean
#  only_known                :boolean
#  invert_filters            :boolean          default(FALSE), not null
#  filter_timelines_only     :boolean          default(FALSE), not null
#

class User < ApplicationRecord
  include Settings::Extend
  include UserRoles
  include LogHelper

  # The home and list feeds will be stored in Redis for this amount
  # of time, and status fan-out to followers will include only people
  # within this time frame. Lowering the duration may improve performance
  # if lots of people sign up, but not a lot of them check their feed
  # every day. Raising the duration reduces the amount of expensive
  # RegenerationWorker jobs that need to be run when those people come
  # to check their feed
  ACTIVE_DURATION = ENV.fetch('USER_ACTIVE_DAYS', 7).to_i.days.freeze

  spam_triggers = ENV.fetch('REGISTRATION_SPAM_TRIGGERS', '').split('|').map { |phrase| Regexp.escape(phrase.strip) }
  spam_triggers = spam_triggers.empty? ? /(?!)/ : /\b#{Regexp.union(spam_triggers)}\b/i

  SPAM_TRIGGERS = spam_triggers.freeze


  devise :two_factor_authenticatable,
         otp_secret_encryption_key: Rails.configuration.x.otp_secret

  devise :two_factor_backupable,
         otp_number_of_backup_codes: 10

  devise :registerable, :recoverable, :rememberable, :trackable, :validatable,
         :confirmable

  include Omniauthable
  include PamAuthenticable
  include LdapAuthenticable

  belongs_to :account, inverse_of: :user
  belongs_to :invite, counter_cache: :uses, optional: true
  belongs_to :created_by_application, class_name: 'Doorkeeper::Application', optional: true
  accepts_nested_attributes_for :account

  has_many :applications, class_name: 'Doorkeeper::Application', as: :owner
  has_many :backups, inverse_of: :user

  has_many :user_links, class_name: 'LinkedUser', foreign_key: :target_user_id, dependent: :destroy, inverse_of: :user
  has_many :linked_users, through: :user_links, source: :user

  has_one :invite_request, class_name: 'UserInviteRequest', inverse_of: :user, dependent: :destroy
  accepts_nested_attributes_for :invite_request, reject_if: ->(attributes) { attributes['text'].blank? }

  validates :locale, inclusion: I18n.available_locales.map(&:to_s), if: :locale?
  validates_with BlacklistedEmailValidator, on: :create
  validates_with EmailMxValidator, if: :validate_email_dns?
  validates :agreement, acceptance: { allow_nil: false, accept: [true, 'true', '1'] }, on: :create

  scope :recent, -> { order(id: :desc) }
  scope :pending, -> { where(approved: false) }
  scope :approved, -> { where(approved: true) }
  scope :confirmed, -> { where.not(confirmed_at: nil) }
  scope :enabled, -> { where(disabled: false) }
  scope :inactive, -> { where(arel_table[:current_sign_in_at].lt(ACTIVE_DURATION.ago)) }
  scope :active, -> { confirmed.where(arel_table[:current_sign_in_at].gteq(ACTIVE_DURATION.ago)).joins(:account).where.not(accounts: { suspended_at: nil }) }
  scope :matches_email, ->(value) { where(arel_table[:email].matches("#{value}%")) }
  scope :emailable, -> { confirmed.enabled.joins(:account).merge(Account.searchable) }

  before_validation :sanitize_languages
  before_create :set_approved

  # This avoids a deprecation warning from Rails 5.1
  # It seems possible that a future release of devise-two-factor will
  # handle this itself, and this can be removed from our User class.
  attribute :otp_secret

  has_many :session_activations, dependent: :destroy

  delegate :default_local,
    :always_local,
    :rawr_federated,
    :hide_stats,
    :force_lowercase,
    :hide_captions,
    :larger_menus,
    :larger_buttons,
    :larger_drawer,
    :larger_emoji,
    :filter_mentions,
    :hide_replies_muted,
    :hide_replies_blocked,
    :hide_replies_blocker,
    :hide_mntions_muted,
    :hide_mntions_blocked,
    :hide_mntions_blocker,
    :hide_mntions_packm8,
    :hide_mascot,
    :hide_interactions,
    :hide_public_profile,
    :hide_public_outbox,
    :max_public_history,
    :roar_lifespan,
    :delayed_roars,
    :delayed_for,
    :boost_interval,
    :boost_random,
    :boost_interval_from,
    :boost_interval_to,
    :show_cursor,

    :auto_play_gif,
    :default_sensitive,
    :unfollow_modal,
    :boost_modal,
    :favourite_modal,
    :delete_modal,
    :reduce_motion,
    :system_font_ui,
    :noindex,
    :flavour,
    :skin,
    :display_media,
    :hide_network,
    :hide_followers_count,
    :expand_spoilers,
    :default_language,
    :aggregate_reblogs,
    :show_application,
    :default_content_type,

    :theme,
    :advanced_layout,
    to: :settings,
    prefix: :setting,
    allow_nil: false

  attr_reader :invite_code
  attr_writer :external

  def vars
    self[:vars]
  end

  def confirmed?
    confirmed_at.present?
  end

  def invited?
    invite_id.present?
  end

  def valid_invitation?
    invite_id.present? && invite.valid_for_use?
  end

  def disable!
    update!(disabled: true,
            last_sign_in_at: current_sign_in_at,
            current_sign_in_at: nil)
  end

  def enable!
    update!(disabled: false)
  end

  def confirm
    new_user      = !confirmed?
    self.approved = true if open_registrations?

    super

    if new_user && approved?
      prepare_new_user!
    elsif new_user
      notify_staff_about_pending_account!
    end
  end

  def confirm!
    new_user      = !confirmed?
    self.approved = true if open_registrations?

    skip_confirmation!
    save!

    prepare_new_user! if new_user && approved?
  end

  def pending?
    !approved?
  end

  def active_for_authentication?
    super && approved?
  end

  def inactive_message
    !approved? ? :pending : super
  end

  def approve!
    return if approved?

    update!(approved: true)
    prepare_new_user!
  end

  def update_tracked_fields!(request)
    super
    prepare_returning_user!
  end

  def disable_two_factor!
    self.otp_required_for_login = false
    otp_backup_codes&.clear
    save!
  end

  def wants_larger_menus?
    @wants_larger_menus ||= (settings.larger_menus || false)
  end

  def wants_larger_buttons?
    @wants_larger_buttons ||= (settings.larger_buttons || false)
  end

  def wants_larger_drawer?
    @wants_larger_drawer ||= (settings.larger_drawer || false)
  end

  def wants_larger_emoji?
    @wants_larger_emoji ||= (settings.larger_emoji || false)
  end

  def filters_mentions?
    @filters_mentions ||= (settings.filter_mentions || false)
  end

  def hides_replies_of_muted?
    @hides_replies_of_muted ||= (settings.hide_replies_muted || true)
  end

  def hides_replies_of_blocked?
    @hides_replies_of_blocked ||= (settings.hide_replies_blocked || true)
  end

  def hides_replies_of_blocker?
    @hides_replies_of_blocker ||= (settings.hide_replies_blocker || true)
  end

  def hides_mentions_of_muted?
    @hides_mentions_of_muted ||= (settings.hide_mntions_muted || true)
  end

  def hides_mentions_of_blocked?
    @hides_mentions_of_blocked ||= (settings.hide_mntions_blocked || true)
  end

  def hides_mentions_of_blocker?
    @hides_mentions_of_blocker ||= (settings.hide_mntions_blocker || true)
  end

  def hides_mentions_outside_scope?
    @hides_mentions_outside_scope ||= (settings.hide_mntions_packm8 || true)
  end

  def hides_mascot?
    @hides_mascot ||= (settings.hide_mascot || false)
  end

  def hides_interactions?
    @hides_interactions ||= (settings.hide_interactions || false)
  end

  def hides_public_profile?
    @hides_public_profile ||= (settings.hide_public_profile || false)
  end

  def hides_public_outbox?
    @hides_public_outbox ||= (settings.hide_public_outbox || false)
  end

  def max_public_history
    @_max_public_history ||= [1, (settings.max_public_history || 6).to_i].max
  end

  def roar_lifespan
    @_roar_lifespan ||= [0, (settings.roar_lifespan || 0).to_i].max
  end

  def delayed_roars?
    @delayed_roars ||= (settings.delayed_roars || false)
  end

  def delayed_for
    @_delayed_for ||= [5, (settings.delayed_for || 60).to_i].max
  end

  def boost_interval?
    @boost_interval ||= (settings.boost_interval || false)
  end

  def boost_random?
    @boost_random ||= (settings.boost_random || false)
  end

  def boost_interval_from
    @boost_interval_from ||= [1, (settings.boost_interval_from || 1).to_i].max
  end

  def boost_interval_to
    @boost_interval_to ||= [2, (settings.boost_interval_to || 15).to_i].max
  end

  def shows_cursor?
    @show_cursor ||= (settings.show_cursor || false)
  end

  def defaults_to_local_only?
    @defaults_to_local_only ||= (settings.default_local || false)
  end

  def always_local_only?
    @always_local_only ||= (settings.always_local || false)
  end

  def wants_raw_federated?
    @wants_raw_federated ||= (settings.rawr_federated || false)
  end

  def hides_stats?
    @hides_stats ||= (settings.hide_stats || false)
  end

  def forces_lowercase?
    @force_lowercase ||= (settings.force_lowercase || false)
  end

  def hides_captions?
    @hides_captions ||= (settings.hide_captions || false)
  end

  def defaults_to_sensitive?
    @defaults_to_sensitive ||= settings.default_sensitive
  end

  def default_visibility
    @default_visibility ||= setting_default_privacy
  end

  def default_language
    @_default_language ||= (settings.default_language || 'en')
  end

  def setting_default_privacy
    settings.default_privacy || 'local'
  end

  def allows_digest_emails?
    settings.notification_emails['digest']
  end

  def allows_report_emails?
    settings.notification_emails['report']
  end

  def allows_pending_account_emails?
    settings.notification_emails['pending_account']
  end

  def hides_network?
    @hides_network ||= settings.hide_network
  end

  def aggregates_reblogs?
    @aggregates_reblogs ||= settings.aggregate_reblogs
  end

  def shows_application?
    @shows_application ||= settings.show_application
  end

  def token_for_app(a)
    return nil if a.nil? || a.owner != self
    Doorkeeper::AccessToken
      .find_or_create_by(application_id: a.id, resource_owner_id: id) do |t|

      t.scopes = a.scopes
      t.expires_in = Doorkeeper.configuration.access_token_expires_in
      t.use_refresh_token = Doorkeeper.configuration.refresh_token_enabled?
    end
  end

  def activate_session(request)
    session_activations.activate(session_id: SecureRandom.hex,
                                 user_agent: request.user_agent,
                                 ip: request.remote_ip).session_id
  end

  def exclusive_session(id)
    session_activations.exclusive(id)
  end

  def session_active?(id)
    session_activations.active? id
  end

  def web_push_subscription(session)
    session.web_push_subscription.nil? ? nil : session.web_push_subscription
  end

  def invite_code=(code)
    self.invite  = Invite.find_by(code: code) if code.present?
    @invite_code = code
  end

  def password_required?
    return false if Devise.pam_authentication || Devise.ldap_authentication
    super
  end

  def send_confirmation_instructions
    return false if detect_spam!
    super
  end

  def send_reset_password_instructions
    return false if encrypted_password.blank? && (Devise.pam_authentication || Devise.ldap_authentication)
    super
  end

  def reset_password!(new_password, new_password_confirmation)
    return false if encrypted_password.blank? && (Devise.pam_authentication || Devise.ldap_authentication)
    super
  end

  def show_all_media?
    setting_display_media == 'show_all'
  end

  def hide_all_media?
    setting_display_media == 'hide_all'
  end

  protected

  def send_devise_notification(notification, *args)
    devise_mailer.send(notification, self, *args).deliver_later
  end

  private

  def set_approved
    self.approved = open_registrations? || valid_invitation? || external?
  end

  def open_registrations?
    Setting.registrations_mode == 'open'
  end

  def external?
    !!@external
  end

  def sanitize_languages
    return if chosen_languages.nil?
    chosen_languages.reject!(&:blank?)
    self.chosen_languages = nil if chosen_languages.empty?
  end

  def prepare_new_user!
    BootstrapTimelineWorker.perform_async(account_id)
    ActivityTracker.increment('activity:accounts:local')
    UserMailer.welcome(self).deliver_later
  end

  def prepare_returning_user!
    ActivityTracker.record('activity:logins', id)
    regenerate_feed! if needs_feed_update?
  end

  def notify_staff_about_pending_account!
    LogWorker.perform_async("\xf0\x9f\x86\x95 New account <#{self.account.username}> is awaiting admin approval.\n\nReview (moderators only): https://#{Rails.configuration.x.web_domain || Rails.configuration.x.local_domain}/admin/pending_accounts")
    User.staff.includes(:account).each do |u|
      next unless u.allows_pending_account_emails?
      AdminMailer.new_pending_account(u.account, self).deliver_later
    end
  end

  def detect_spam!
    return false if valid_invitation? || external?

    janitor = janitor_account || Account.representative

    intro = self.invite_request&.text
    # normalize it
    intro = intro.gsub(/[\u200b-\u200d\ufeff\u200e\u200f]/, '').strip.downcase unless intro.nil?

    return false unless intro.blank? || intro.split.count < 5 || SPAM_TRIGGERS.match?(intro)

    user_friendly_action_log(janitor, :reject_registration, self.account.username, "Registration was spam filtered.")
    Form::AccountBatch.new(current_account: janitor, account_ids: account_id, action: 'reject').save

    true
  rescue ActiveRecord::RecordNotFound, ActiveRecord::RecordInvalid
    false
  end

  def janitor_account
    account_id = ENV.fetch('JANITOR_USER', '').to_i
    return if account_id == 0
    Account.find_by(id: account_id)
  end

  def regenerate_feed!
    return unless Redis.current.setnx("account:#{account_id}:regeneration", true)
    Redis.current.expire("account:#{account_id}:regeneration", 1.day.seconds)
    RegenerationWorker.perform_async(account_id)
  end

  def needs_feed_update?
    last_sign_in_at < ACTIVE_DURATION.ago
  end

  def validate_email_dns?
    email_changed? && !(Rails.env.test? || Rails.env.development?)
  end
end