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