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