where i deviate from standard mastodon assets
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

user.rb 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  1. # frozen_string_literal: true
  2. # == Schema Information
  3. #
  4. # Table name: users
  5. #
  6. # id :bigint(8) not null, primary key
  7. # email :string default(""), not null
  8. # created_at :datetime not null
  9. # updated_at :datetime not null
  10. # encrypted_password :string default(""), not null
  11. # reset_password_token :string
  12. # reset_password_sent_at :datetime
  13. # remember_created_at :datetime
  14. # sign_in_count :integer default(0), not null
  15. # current_sign_in_at :datetime
  16. # last_sign_in_at :datetime
  17. # current_sign_in_ip :inet
  18. # last_sign_in_ip :inet
  19. # admin :boolean default(FALSE), not null
  20. # confirmation_token :string
  21. # confirmed_at :datetime
  22. # confirmation_sent_at :datetime
  23. # unconfirmed_email :string
  24. # locale :string
  25. # encrypted_otp_secret :string
  26. # encrypted_otp_secret_iv :string
  27. # encrypted_otp_secret_salt :string
  28. # consumed_timestep :integer
  29. # otp_required_for_login :boolean default(FALSE), not null
  30. # last_emailed_at :datetime
  31. # otp_backup_codes :string is an Array
  32. # filtered_languages :string default([]), not null, is an Array
  33. # account_id :bigint(8) not null
  34. # disabled :boolean default(FALSE), not null
  35. # moderator :boolean default(FALSE), not null
  36. # invite_id :bigint(8)
  37. # remember_token :string
  38. # chosen_languages :string is an Array
  39. # created_by_application_id :bigint(8)
  40. # approved :boolean default(TRUE), not null
  41. #
  42. class User < ApplicationRecord
  43. include Settings::Extend
  44. include UserRoles
  45. # The home and list feeds will be stored in Redis for this amount
  46. # of time, and status fan-out to followers will include only people
  47. # within this time frame. Lowering the duration may improve performance
  48. # if lots of people sign up, but not a lot of them check their feed
  49. # every day. Raising the duration reduces the amount of expensive
  50. # RegenerationWorker jobs that need to be run when those people come
  51. # to check their feed
  52. ACTIVE_DURATION = ENV.fetch('USER_ACTIVE_DAYS', 7).to_i.days.freeze
  53. devise :two_factor_authenticatable,
  54. otp_secret_encryption_key: Rails.configuration.x.otp_secret
  55. devise :two_factor_backupable,
  56. otp_number_of_backup_codes: 10
  57. devise :registerable, :recoverable, :rememberable, :trackable, :validatable,
  58. :confirmable
  59. include Omniauthable
  60. include PamAuthenticable
  61. include LdapAuthenticable
  62. belongs_to :account, inverse_of: :user
  63. belongs_to :invite, counter_cache: :uses, optional: true
  64. belongs_to :created_by_application, class_name: 'Doorkeeper::Application', optional: true
  65. accepts_nested_attributes_for :account
  66. has_many :applications, class_name: 'Doorkeeper::Application', as: :owner
  67. has_many :backups, inverse_of: :user
  68. has_many :invites, inverse_of: :user
  69. has_one :invite_request, class_name: 'UserInviteRequest', inverse_of: :user, dependent: :destroy
  70. accepts_nested_attributes_for :invite_request, reject_if: ->(attributes) { attributes['text'].blank? }
  71. validates :locale, inclusion: I18n.available_locales.map(&:to_s), if: :locale?
  72. validates_with BlacklistedEmailValidator, on: :create
  73. validates_with EmailMxValidator, if: :validate_email_dns?
  74. validates :agreement, acceptance: { allow_nil: false, accept: [true, 'true', '1'] }, on: :create
  75. scope :recent, -> { order(id: :desc) }
  76. scope :pending, -> { where(approved: false) }
  77. scope :approved, -> { where(approved: true) }
  78. scope :confirmed, -> { where.not(confirmed_at: nil) }
  79. scope :enabled, -> { where(disabled: false) }
  80. scope :disabled, -> { where(disabled: true) }
  81. scope :inactive, -> { where(arel_table[:current_sign_in_at].lt(ACTIVE_DURATION.ago)) }
  82. scope :active, -> { confirmed.where(arel_table[:current_sign_in_at].gteq(ACTIVE_DURATION.ago)).joins(:account).where(accounts: { suspended_at: nil }) }
  83. scope :matches_email, ->(value) { where(arel_table[:email].matches("#{value}%")) }
  84. scope :emailable, -> { confirmed.enabled.joins(:account).merge(Account.searchable) }
  85. before_validation :sanitize_languages
  86. before_create :set_approved
  87. # This avoids a deprecation warning from Rails 5.1
  88. # It seems possible that a future release of devise-two-factor will
  89. # handle this itself, and this can be removed from our User class.
  90. attribute :otp_secret
  91. has_many :session_activations, dependent: :destroy
  92. delegate :auto_play_gif, :default_sensitive, :unfollow_modal, :boost_modal, :favourite_modal, :delete_modal,
  93. :reduce_motion, :system_font_ui, :noindex, :flavour, :skin, :display_media, :hide_network, :hide_followers_count,
  94. :expand_spoilers, :default_language, :aggregate_reblogs, :show_application,
  95. :advanced_layout, :default_content_type, :use_blurhash, :use_pending_items, :use_pending_items, to: :settings, prefix: :setting, allow_nil: false
  96. attr_reader :invite_code
  97. attr_writer :external
  98. def confirmed?
  99. confirmed_at.present?
  100. end
  101. def invited?
  102. invite_id.present?
  103. end
  104. def valid_invitation?
  105. invite_id.present? && invite.valid_for_use?
  106. end
  107. def disable!
  108. update!(disabled: true,
  109. last_sign_in_at: current_sign_in_at,
  110. current_sign_in_at: nil)
  111. end
  112. def enable!
  113. update!(disabled: false)
  114. end
  115. def confirm
  116. new_user = !confirmed?
  117. self.approved = true if open_registrations?
  118. super
  119. if new_user && approved?
  120. prepare_new_user!
  121. elsif new_user
  122. notify_staff_about_pending_account!
  123. end
  124. end
  125. def confirm!
  126. new_user = !confirmed?
  127. self.approved = true if open_registrations?
  128. skip_confirmation!
  129. save!
  130. prepare_new_user! if new_user && approved?
  131. end
  132. def pending?
  133. !approved?
  134. end
  135. def active_for_authentication?
  136. true
  137. end
  138. def functional?
  139. confirmed? && approved? && !disabled? && !account.suspended?
  140. end
  141. def inactive_message
  142. !approved? ? :pending : super
  143. end
  144. def approve!
  145. return if approved?
  146. update!(approved: true)
  147. prepare_new_user!
  148. end
  149. def update_tracked_fields!(request)
  150. super
  151. prepare_returning_user!
  152. end
  153. def disable_two_factor!
  154. self.otp_required_for_login = false
  155. otp_backup_codes&.clear
  156. save!
  157. end
  158. def setting_default_privacy
  159. settings.default_privacy || (account.locked? ? 'private' : 'public')
  160. end
  161. def allows_digest_emails?
  162. settings.notification_emails['digest']
  163. end
  164. def allows_report_emails?
  165. settings.notification_emails['report']
  166. end
  167. def allows_pending_account_emails?
  168. settings.notification_emails['pending_account']
  169. end
  170. def allows_trending_tag_emails?
  171. settings.notification_emails['trending_tag']
  172. end
  173. def hides_network?
  174. @hides_network ||= settings.hide_network
  175. end
  176. def aggregates_reblogs?
  177. @aggregates_reblogs ||= settings.aggregate_reblogs
  178. end
  179. def shows_application?
  180. @shows_application ||= settings.show_application
  181. end
  182. def token_for_app(a)
  183. return nil if a.nil? || a.owner != self
  184. Doorkeeper::AccessToken
  185. .find_or_create_by(application_id: a.id, resource_owner_id: id) do |t|
  186. t.scopes = a.scopes
  187. t.expires_in = Doorkeeper.configuration.access_token_expires_in
  188. t.use_refresh_token = Doorkeeper.configuration.refresh_token_enabled?
  189. end
  190. end
  191. def activate_session(request)
  192. session_activations.activate(session_id: SecureRandom.hex,
  193. user_agent: request.user_agent,
  194. ip: request.remote_ip).session_id
  195. end
  196. def exclusive_session(id)
  197. session_activations.exclusive(id)
  198. end
  199. def session_active?(id)
  200. session_activations.active? id
  201. end
  202. def web_push_subscription(session)
  203. session.web_push_subscription.nil? ? nil : session.web_push_subscription
  204. end
  205. def invite_code=(code)
  206. self.invite = Invite.find_by(code: code) if code.present?
  207. @invite_code = code
  208. end
  209. def password_required?
  210. return false if Devise.pam_authentication || Devise.ldap_authentication
  211. super
  212. end
  213. def send_reset_password_instructions
  214. return false if encrypted_password.blank? && (Devise.pam_authentication || Devise.ldap_authentication)
  215. super
  216. end
  217. def reset_password!(new_password, new_password_confirmation)
  218. return false if encrypted_password.blank? && (Devise.pam_authentication || Devise.ldap_authentication)
  219. super
  220. end
  221. def show_all_media?
  222. setting_display_media == 'show_all'
  223. end
  224. def hide_all_media?
  225. setting_display_media == 'hide_all'
  226. end
  227. protected
  228. def send_devise_notification(notification, *args)
  229. devise_mailer.send(notification, self, *args).deliver_later
  230. end
  231. private
  232. def set_approved
  233. self.approved = open_registrations? || valid_invitation? || external?
  234. end
  235. def open_registrations?
  236. Setting.registrations_mode == 'open'
  237. end
  238. def external?
  239. !!@external
  240. end
  241. def sanitize_languages
  242. return if chosen_languages.nil?
  243. chosen_languages.reject!(&:blank?)
  244. self.chosen_languages = nil if chosen_languages.empty?
  245. end
  246. def prepare_new_user!
  247. BootstrapTimelineWorker.perform_async(account_id)
  248. ActivityTracker.increment('activity:accounts:local')
  249. UserMailer.welcome(self).deliver_later
  250. end
  251. def prepare_returning_user!
  252. ActivityTracker.record('activity:logins', id)
  253. regenerate_feed! if needs_feed_update?
  254. end
  255. def notify_staff_about_pending_account!
  256. User.staff.includes(:account).each do |u|
  257. next unless u.allows_pending_account_emails?
  258. AdminMailer.new_pending_account(u.account, self).deliver_later
  259. end
  260. end
  261. def regenerate_feed!
  262. return unless Redis.current.setnx("account:#{account_id}:regeneration", true)
  263. Redis.current.expire("account:#{account_id}:regeneration", 1.day.seconds)
  264. RegenerationWorker.perform_async(account_id)
  265. end
  266. def needs_feed_update?
  267. last_sign_in_at < ACTIVE_DURATION.ago
  268. end
  269. def validate_email_dns?
  270. email_changed? && !(Rails.env.test? || Rails.env.development?)
  271. end
  272. end