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