mastodon/app/models/user.rb

575 lines
16 KiB
Ruby

# 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
# media_only :boolean default(FALSE), not null
# filter_undescribed :boolean default(FALSE), not null
# filters_enabled :boolean default(FALSE), not null
# monsterfork_api :integer default("full"), not null
# allow_unknown_follows :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
enum monsterfork_api: [:vanilla, :basic, :full]
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,
:max_public_access,
:roar_lifespan,
:roar_lifespan_old,
:roar_defederate,
:roar_defederate_old,
: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,
:use_blurhash,
:use_pending_items,
: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 max_public_access
@_max_public_access ||= [1, (settings.max_public_access || 90).to_i].max
end
def roar_lifespan
@_roar_lifespan ||= [0, (settings.roar_lifespan || 0).to_i].max
end
def roar_lifespan_old
@_roar_lifespan_old ||= (settings.roar_lifespan_old || false)
end
def roar_defederate
@_roar_defederate ||= [0, (settings.roar_defederate || 0).to_i].max
end
def roar_defederate_old
@_roar_defederate_old ||= (settings.roar_defederate_old || false)
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_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 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