app/models/user.rb

   1 # == Schema Information
   2 #
   3 # Table name: users
   4 #
   5 #  email                :string           not null
   6 #  id                   :bigint(8)        not null, primary key
   7 #  pass_crypt           :string           not null
   8 #  creation_time        :datetime         not null
   9 #  display_name         :string           default(""), not null
  10 #  data_public          :boolean          default(FALSE), not null
  11 #  description          :text             default(""), not null
  12 #  home_lat             :float
  13 #  home_lon             :float
  14 #  home_zoom            :integer          default(3)
  15 #  pass_salt            :string
  16 #  email_valid          :boolean          default(FALSE), not null
  17 #  new_email            :string
  18 #  creation_ip          :string
  19 #  languages            :string
  20 #  status               :enum             default("pending"), not null
  21 #  terms_agreed         :datetime
  22 #  consider_pd          :boolean          default(FALSE), not null
  23 #  auth_uid             :string
  24 #  preferred_editor     :string
  25 #  terms_seen           :boolean          default(FALSE), not null
  26 #  description_format   :enum             default("markdown"), not null
  27 #  changesets_count     :integer          default(0), not null
  28 #  traces_count         :integer          default(0), not null
  29 #  diary_entries_count  :integer          default(0), not null
  30 #  image_use_gravatar   :boolean          default(FALSE), not null
  31 #  auth_provider        :string
  32 #  home_tile            :bigint(8)
  33 #  tou_agreed           :datetime
  34 #  diary_comments_count :integer          default(0)
  35 #  note_comments_count  :integer          default(0)
  36 #
  37 # Indexes
  38 #
  39 #  users_auth_idx                    (auth_provider,auth_uid) UNIQUE
  40 #  users_display_name_canonical_idx  (lower(NORMALIZE(display_name, NFKC)))
  41 #  users_display_name_idx            (display_name) UNIQUE
  42 #  users_email_idx                   (email) UNIQUE
  43 #  users_email_lower_idx             (lower((email)::text))
  44 #  users_home_idx                    (home_tile)
  45 #
  46
  47 class User < ApplicationRecord
  48   require "digest"
  49   include AASM
  50
  51   has_many :traces, -> { where(:visible => true) }
  52   has_many :diary_entries, -> { order(:created_at => :desc) }, :inverse_of => :user
  53   has_many :diary_comments, -> { order(:created_at => :desc) }, :inverse_of => :user
  54   has_many :diary_entry_subscriptions, :class_name => "DiaryEntrySubscription"
  55   has_many :diary_subscriptions, :through => :diary_entry_subscriptions, :source => :diary_entry
  56   has_many :messages, -> { where(:to_user_visible => true, :muted => false).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
  57   has_many :new_messages, -> { where(:to_user_visible => true, :muted => false, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
  58   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
  59   has_many :muted_messages, -> { where(:to_user_visible => true, :muted => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :to_user_id
  60   has_many :friendships, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
  61   has_many :friends, :through => :friendships, :source => :befriendee
  62   has_many :preferences, :class_name => "UserPreference"
  63   has_many :changesets, -> { order(:created_at => :desc) }, :inverse_of => :user
  64   has_many :changeset_comments, :foreign_key => :author_id, :inverse_of => :author
  65   has_and_belongs_to_many :changeset_subscriptions, :class_name => "Changeset", :join_table => "changesets_subscribers", :foreign_key => "subscriber_id"
  66   has_many :note_comments, :foreign_key => :author_id, :inverse_of => :author
  67   has_many :notes, :through => :note_comments
  68
  69   has_many :oauth2_applications, :class_name => Doorkeeper.config.application_model.name, :as => :owner
  70   has_many :access_grants, :class_name => Doorkeeper.config.access_grant_model.name, :foreign_key => :resource_owner_id
  71   has_many :access_tokens, :class_name => Doorkeeper.config.access_token_model.name, :foreign_key => :resource_owner_id
  72
  73   has_many :blocks, :class_name => "UserBlock"
  74   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id, :inverse_of => :creator
  75   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id, :inverse_of => :revoker
  76
  77   has_many :mutes, -> { order(:created_at => :desc) }, :class_name => "UserMute", :foreign_key => :owner_id, :inverse_of => :owner
  78   has_many :muted_users, :through => :mutes, :source => :subject
  79
  80   has_many :roles, :class_name => "UserRole"
  81
  82   has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id, :inverse_of => :reported_user
  83   has_many :issue_comments
  84
  85   has_many :reports
  86
  87   scope :visible, -> { where(:status => %w[pending active confirmed]) }
  88   scope :active, -> { where(:status => %w[active confirmed]) }
  89   scope :identifiable, -> { where(:data_public => true) }
  90
  91   has_one_attached :avatar, :service => Settings.avatar_storage
  92
  93   validates :display_name, :presence => true, :length => 3..255,
  94                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
  95   validates :display_name, :if => proc { |u| u.display_name_changed? },
  96                            :normalized_uniqueness => { :case_sensitive => false }
  97   validates :display_name, :if => proc { |u| u.display_name_changed? },
  98                            :characters => { :url_safe => true },
  99                            :whitespace => { :leading => false, :trailing => false },
 100                            :width => { :minimum => 3 }
 101   validate :display_name_cannot_be_user_id_with_other_id, :if => proc { |u| u.display_name_changed? }
 102   validates :email, :presence => true, :characters => true
 103   validates :email, :if => proc { |u| u.email_changed? },
 104                     :uniqueness => { :case_sensitive => false }
 105   validates :email, :if => proc { |u| u.email_changed? },
 106                     :whitespace => { :leading => false, :trailing => false }
 107   validates :pass_crypt, :confirmation => true, :length => 8..255
 108   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
 109   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
 110   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
 111   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
 112   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
 113                        :uniqueness => { :scope => :auth_provider }
 114   validates :avatar, :if => proc { |u| u.attachment_changes["avatar"] },
 115                      :image => true
 116
 117   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
 118   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
 119
 120   alias_attribute :created_at, :creation_time
 121
 122   before_save :encrypt_password
 123   before_save :update_tile
 124   after_save :spam_check
 125
 126   generates_token_for :new_user, :expires_in => 1.week do
 127     fingerprint
 128   end
 129
 130   generates_token_for :new_email, :expires_in => 1.week do
 131     fingerprint
 132   end
 133
 134   generates_token_for :password_reset, :expires_in => 1.week do
 135     fingerprint
 136   end
 137
 138   def display_name_cannot_be_user_id_with_other_id
 139     display_name&.match(/^user_(\d+)$/i) do |m|
 140       errors.add :display_name, I18n.t("activerecord.errors.messages.display_name_is_user_n") unless m[1].to_i == id
 141     end
 142   end
 143
 144   def to_param
 145     display_name
 146   end
 147
 148   def self.authenticate(options)
 149     if options[:username] && options[:password]
 150       user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])
 151
 152       if user.nil?
 153         users = where("LOWER(email) = LOWER(?) OR LOWER(NORMALIZE(display_name, NFKC)) = LOWER(NORMALIZE(?, NFKC))", options[:username].strip, options[:username])
 154
 155         user = users.first if users.count == 1
 156       end
 157
 158       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
 159         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
 160           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
 161           user.save
 162         end
 163       else
 164         user = nil
 165       end
 166     end
 167
 168     if user &&
 169        (user.status == "deleted" ||
 170          (user.status == "pending" && !options[:pending]) ||
 171          (user.status == "suspended" && !options[:suspended]))
 172       user = nil
 173     end
 174
 175     user
 176   end
 177
 178   aasm :column => :status, :no_direct_assignment => true do
 179     state :pending, :initial => true
 180     state :active
 181     state :confirmed
 182     state :suspended
 183     state :deleted
 184
 185     # A normal account is active
 186     event :activate do
 187       transitions :from => :pending, :to => :active
 188     end
 189
 190     # Used in test suite, not something that we would normally need to do.
 191     if Rails.env.test?
 192       event :deactivate do
 193         transitions :from => :active, :to => :pending
 194       end
 195     end
 196
 197     # To confirm an account is used to override the spam scoring
 198     event :confirm do
 199       transitions :from => [:pending, :active, :suspended], :to => :confirmed
 200     end
 201
 202     # To unconfirm an account is to make it subject to future spam scoring again
 203     event :unconfirm do
 204       transitions :from => :confirmed, :to => :active
 205     end
 206
 207     # Accounts can be automatically suspended by spam_check
 208     event :suspend do
 209       transitions :from => [:pending, :active], :to => :suspended
 210     end
 211
 212     # Unsuspending an account moves it back to active without overriding the spam scoring
 213     event :unsuspend do
 214       transitions :from => :suspended, :to => :active
 215     end
 216
 217     # Mark the account as deleted but keep all data intact
 218     event :hide do
 219       transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted
 220     end
 221
 222     event :unhide do
 223       transitions :from => [:deleted], :to => :active
 224     end
 225
 226     # Mark the account as deleted and remove personal data
 227     event :soft_destroy do
 228       before do
 229         revoke_authentication_tokens
 230         remove_personal_data
 231       end
 232
 233       transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted
 234     end
 235   end
 236
 237   def description
 238     RichText.new(self[:description_format], self[:description])
 239   end
 240
 241   def languages
 242     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
 243   end
 244
 245   def languages=(languages)
 246     self[:languages] = languages.join(",")
 247   end
 248
 249   def preferred_language
 250     languages.find { |l| Language.exists?(:code => l) }
 251   end
 252
 253   def preferred_languages
 254     @preferred_languages ||= Locale.list(languages)
 255   end
 256
 257   def home_location?
 258     home_lat && home_lon
 259   end
 260
 261   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
 262     if home_location?
 263       gc = OSM::GreatCircle.new(home_lat, home_lon)
 264       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
 265       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
 266       nearby = User.active.identifiable
 267                    .where.not(:id => id)
 268                    .where(sql_for_area)
 269                    .where("#{sql_for_distance} <= ?", radius)
 270                    .order(Arel.sql(sql_for_distance))
 271                    .limit(num)
 272     else
 273       nearby = []
 274     end
 275     nearby
 276   end
 277
 278   def distance(nearby_user)
 279     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
 280   end
 281
 282   def friends_with?(new_friend)
 283     friendships.exists?(:befriendee => new_friend)
 284   end
 285
 286   ##
 287   # returns true if a user is visible
 288   def visible?
 289     %w[pending active confirmed].include? status
 290   end
 291
 292   ##
 293   # returns true if a user is active
 294   def active?
 295     %w[active confirmed].include? status
 296   end
 297
 298   ##
 299   # returns true if the user has the moderator role, false otherwise
 300   def moderator?
 301     role? "moderator"
 302   end
 303
 304   ##
 305   # returns true if the user has the administrator role, false otherwise
 306   def administrator?
 307     role? "administrator"
 308   end
 309
 310   ##
 311   # returns true if the user has the importer role, false otherwise
 312   def importer?
 313     role? "importer"
 314   end
 315
 316   ##
 317   # returns true if the user has the requested role
 318   def role?(role)
 319     roles.any? { |r| r.role == role }
 320   end
 321
 322   ##
 323   # returns the first active block which would require users to view
 324   # a message, or nil if there are none.
 325   def blocked_on_view
 326     blocks.active.detect(&:needs_view?)
 327   end
 328
 329   ##
 330   # revoke any authentication tokens
 331   def revoke_authentication_tokens
 332     access_tokens.not_expired.each(&:revoke)
 333   end
 334
 335   ##
 336   # remove personal data - leave the account but purge most personal data
 337   def remove_personal_data
 338     avatar.purge_later
 339
 340     self.display_name = "user_#{id}"
 341     self.description = ""
 342     self.home_lat = nil
 343     self.home_lon = nil
 344     self.email_valid = false
 345     self.new_email = nil
 346     self.auth_provider = nil
 347     self.auth_uid = nil
 348
 349     save
 350   end
 351
 352   ##
 353   # return a spam score for a user
 354   def spam_score
 355     changeset_score = changesets.size * 50
 356     trace_score = traces.size * 50
 357     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 358     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 359
 360     score = description.spam_score / 4.0
 361     score += diary_entries.visible.where("created_at > ?", 1.day.ago).count * 10
 362     score += diary_entry_score / diary_entries.visible.length unless diary_entries.visible.empty?
 363     score += diary_comment_score / diary_comments.visible.length unless diary_comments.visible.empty?
 364     score -= changeset_score
 365     score -= trace_score
 366
 367     score.to_i
 368   end
 369
 370   ##
 371   # perform a spam check on a user
 372   def spam_check
 373     suspend! if may_suspend? && spam_score > Settings.spam_threshold
 374   end
 375
 376   ##
 377   # return an oauth 2 access token for a specified application
 378   def oauth_token(application_id)
 379     application = Doorkeeper.config.application_model.find_by(:uid => application_id)
 380
 381     Doorkeeper.config.access_token_model.find_or_create_for(
 382       :application => application,
 383       :resource_owner => self,
 384       :scopes => application.scopes
 385     )
 386   end
 387
 388   def fingerprint
 389     digest = Digest::SHA256.new
 390     digest.update(email)
 391     digest.update(pass_crypt)
 392     digest.hexdigest
 393   end
 394
 395   def active_reports
 396     issues
 397       .with_status(:open)
 398       .joins(:reports)
 399       .where("reports.updated_at >= COALESCE(issues.resolved_at, '1970-01-01')")
 400       .count
 401   end
 402
 403   def max_messages_per_hour
 404     account_age_in_seconds = Time.now.utc - created_at
 405     account_age_in_hours = account_age_in_seconds / 3600
 406     recent_messages = messages.where(:sent_on => Time.now.utc - 3600..).count
 407     max_messages = account_age_in_hours.ceil + recent_messages - (active_reports * 10)
 408     max_messages.clamp(0, Settings.max_messages_per_hour)
 409   end
 410
 411   def max_friends_per_hour
 412     account_age_in_seconds = Time.now.utc - created_at
 413     account_age_in_hours = account_age_in_seconds / 3600
 414     recent_friends = Friendship.where(:befriendee => self).where(:created_at => Time.now.utc - 3600..).count
 415     max_friends = account_age_in_hours.ceil + recent_friends - (active_reports * 10)
 416     max_friends.clamp(0, Settings.max_friends_per_hour)
 417   end
 418
 419   def max_changeset_comments_per_hour
 420     if moderator?
 421       Settings.moderator_changeset_comments_per_hour
 422     else
 423       previous_comments = changeset_comments.limit(200).count
 424       max_comments = previous_comments / 200.0 * Settings.max_changeset_comments_per_hour
 425       max_comments = max_comments.floor.clamp(Settings.initial_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
 426       max_comments /= 2**active_reports
 427       max_comments.floor.clamp(Settings.min_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
 428     end
 429   end
 430
 431   def deletion_allowed_at
 432     unless Settings.user_account_deletion_delay.nil?
 433       last_changeset = changesets.reorder(:closed_at => :desc).first
 434       return last_changeset.closed_at.utc + Settings.user_account_deletion_delay.hours if last_changeset
 435     end
 436     creation_time.utc
 437   end
 438
 439   def deletion_allowed?
 440     deletion_allowed_at <= Time.now.utc
 441   end
 442
 443   private
 444
 445   def encrypt_password
 446     if pass_crypt_confirmation
 447       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
 448       self.pass_crypt_confirmation = nil
 449     end
 450   end
 451
 452   def update_tile
 453     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_location?
 454   end
 455 end