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