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_canonical_idx  (lower(NORMALIZE(display_name, NFKC)))
  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                            :normalized_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   after_initialize :encrypt_password
 120   before_save :encrypt_password
 121   before_save :update_tile
 122   after_save :spam_check
 123
 124   def to_param
 125     display_name
 126   end
 127
 128   def self.authenticate(options)
 129     if options[:username] && options[:password]
 130       user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])
 131
 132       if user.nil?
 133         users = where("LOWER(email) = LOWER(?) OR LOWER(NORMALIZE(display_name, NFKC)) = LOWER(NORMALIZE(?, NFKC))", options[:username].strip, options[:username])
 134
 135         user = users.first if users.count == 1
 136       end
 137
 138       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
 139         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
 140           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
 141           user.save
 142         end
 143       else
 144         user = nil
 145       end
 146     elsif options[:token]
 147       token = UserToken.find_by(:token => options[:token])
 148       user = token.user if token
 149     end
 150
 151     if user &&
 152        (user.status == "deleted" ||
 153          (user.status == "pending" && !options[:pending]) ||
 154          (user.status == "suspended" && !options[:suspended]))
 155       user = nil
 156     end
 157
 158     token.update(:expiry => 1.week.from_now) if token && user
 159
 160     user
 161   end
 162
 163   aasm :column => :status, :no_direct_assignment => true do
 164     state :pending, :initial => true
 165     state :active
 166     state :confirmed
 167     state :suspended
 168     state :deleted
 169
 170     # A normal account is active
 171     event :activate do
 172       transitions :from => :pending, :to => :active
 173     end
 174
 175     # Used in test suite, not something that we would normally need to do.
 176     if Rails.env.test?
 177       event :deactivate do
 178         transitions :from => :active, :to => :pending
 179       end
 180     end
 181
 182     # To confirm an account is used to override the spam scoring
 183     event :confirm do
 184       transitions :from => [:pending, :active, :suspended], :to => :confirmed
 185     end
 186
 187     # To unconfirm an account is to make it subject to future spam scoring again
 188     event :unconfirm do
 189       transitions :from => :confirmed, :to => :active
 190     end
 191
 192     # Accounts can be automatically suspended by spam_check
 193     event :suspend do
 194       transitions :from => [:pending, :active], :to => :suspended
 195     end
 196
 197     # Unsuspending an account moves it back to active without overriding the spam scoring
 198     event :unsuspend do
 199       transitions :from => :suspended, :to => :active
 200     end
 201
 202     # Mark the account as deleted but keep all data intact
 203     event :hide do
 204       transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted
 205     end
 206
 207     event :unhide do
 208       transitions :from => [:deleted], :to => :active
 209     end
 210
 211     # Mark the account as deleted and remove personal data
 212     event :soft_destroy do
 213       before do
 214         revoke_authentication_tokens
 215         remove_personal_data
 216       end
 217
 218       transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted
 219     end
 220   end
 221
 222   def description
 223     RichText.new(self[:description_format], self[:description])
 224   end
 225
 226   def languages
 227     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
 228   end
 229
 230   def languages=(languages)
 231     self[:languages] = languages.join(",")
 232   end
 233
 234   def preferred_language
 235     languages.find { |l| Language.exists?(:code => l) }
 236   end
 237
 238   def preferred_languages
 239     @preferred_languages ||= Locale.list(languages)
 240   end
 241
 242   def home_location?
 243     home_lat && home_lon
 244   end
 245
 246   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
 247     if home_location?
 248       gc = OSM::GreatCircle.new(home_lat, home_lon)
 249       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
 250       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
 251       nearby = User.active.identifiable
 252                    .where.not(:id => id)
 253                    .where(sql_for_area)
 254                    .where("#{sql_for_distance} <= ?", radius)
 255                    .order(Arel.sql(sql_for_distance))
 256                    .limit(num)
 257     else
 258       nearby = []
 259     end
 260     nearby
 261   end
 262
 263   def distance(nearby_user)
 264     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
 265   end
 266
 267   def friends_with?(new_friend)
 268     friendships.exists?(:befriendee => new_friend)
 269   end
 270
 271   ##
 272   # returns true if a user is visible
 273   def visible?
 274     %w[pending active confirmed].include? status
 275   end
 276
 277   ##
 278   # returns true if a user is active
 279   def active?
 280     %w[active confirmed].include? status
 281   end
 282
 283   ##
 284   # returns true if the user has the moderator role, false otherwise
 285   def moderator?
 286     role? "moderator"
 287   end
 288
 289   ##
 290   # returns true if the user has the administrator role, false otherwise
 291   def administrator?
 292     role? "administrator"
 293   end
 294
 295   ##
 296   # returns true if the user has the importer role, false otherwise
 297   def importer?
 298     role? "importer"
 299   end
 300
 301   ##
 302   # returns true if the user has the requested role
 303   def role?(role)
 304     roles.any? { |r| r.role == role }
 305   end
 306
 307   ##
 308   # returns the first active block which would require users to view
 309   # a message, or nil if there are none.
 310   def blocked_on_view
 311     blocks.active.detect(&:needs_view?)
 312   end
 313
 314   ##
 315   # revoke any authentication tokens
 316   def revoke_authentication_tokens
 317     oauth_tokens.authorized.each(&:invalidate!)
 318     access_tokens.not_expired.each(&:revoke)
 319   end
 320
 321   ##
 322   # remove personal data - leave the account but purge most personal data
 323   def remove_personal_data
 324     avatar.purge_later
 325
 326     self.display_name = "user_#{id}"
 327     self.description = ""
 328     self.home_lat = nil
 329     self.home_lon = nil
 330     self.email_valid = false
 331     self.new_email = nil
 332     self.auth_provider = nil
 333     self.auth_uid = nil
 334
 335     save
 336   end
 337
 338   ##
 339   # return a spam score for a user
 340   def spam_score
 341     changeset_score = changesets.size * 50
 342     trace_score = traces.size * 50
 343     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 344     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 345
 346     score = description.spam_score / 4.0
 347     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
 348     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
 349     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
 350     score -= changeset_score
 351     score -= trace_score
 352
 353     score.to_i
 354   end
 355
 356   ##
 357   # perform a spam check on a user
 358   def spam_check
 359     suspend! if may_suspend? && spam_score > Settings.spam_threshold
 360   end
 361
 362   ##
 363   # return an oauth 1 access token for a specified application
 364   def access_token(application_key)
 365     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
 366   end
 367
 368   ##
 369   # return an oauth 2 access token for a specified application
 370   def oauth_token(application_id)
 371     application = Doorkeeper.config.application_model.find_by(:uid => application_id)
 372
 373     Doorkeeper.config.access_token_model.find_or_create_for(
 374       :application => application,
 375       :resource_owner => self,
 376       :scopes => application.scopes
 377     )
 378   end
 379
 380   def fingerprint
 381     digest = Digest::SHA256.new
 382     digest.update(email)
 383     digest.update(pass_crypt)
 384     digest.hexdigest
 385   end
 386
 387   def active_reports
 388     issues
 389       .with_status(:open)
 390       .joins(:reports)
 391       .where("reports.updated_at >= COALESCE(issues.resolved_at, '1970-01-01')")
 392       .count
 393   end
 394
 395   def max_messages_per_hour
 396     account_age_in_seconds = Time.now.utc - created_at
 397     account_age_in_hours = account_age_in_seconds / 3600
 398     recent_messages = messages.where("sent_on >= ?", Time.now.utc - 3600).count
 399     max_messages = account_age_in_hours.ceil + recent_messages - (active_reports * 10)
 400     max_messages.clamp(0, Settings.max_messages_per_hour)
 401   end
 402
 403   def max_friends_per_hour
 404     account_age_in_seconds = Time.now.utc - created_at
 405     account_age_in_hours = account_age_in_seconds / 3600
 406     recent_friends = Friendship.where(:befriendee => self).where("created_at >= ?", Time.now.utc - 3600).count
 407     max_friends = account_age_in_hours.ceil + recent_friends - (active_reports * 10)
 408     max_friends.clamp(0, Settings.max_friends_per_hour)
 409   end
 410
 411   def max_changeset_comments_per_hour
 412     if moderator?
 413       Settings.moderator_changeset_comments_per_hour
 414     else
 415       previous_comments = changeset_comments.limit(200).count
 416       max_comments = previous_comments / 200.0 * Settings.max_changeset_comments_per_hour
 417       max_comments = max_comments.floor.clamp(Settings.initial_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
 418       max_comments /= 2**active_reports
 419       max_comments.floor.clamp(Settings.min_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
 420     end
 421   end
 422
 423   def deletion_allowed_at
 424     unless Settings.user_account_deletion_delay.nil?
 425       last_changeset = changesets.reorder(:closed_at => :desc).first
 426       return last_changeset.closed_at.utc + Settings.user_account_deletion_delay.hours if last_changeset
 427     end
 428     creation_time.utc
 429   end
 430
 431   def deletion_allowed?
 432     deletion_allowed_at <= Time.now.utc
 433   end
 434
 435   private
 436
 437   def encrypt_password
 438     if pass_crypt_confirmation
 439       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
 440       self.pass_crypt_confirmation = nil
 441     end
 442   end
 443
 444   def update_tile
 445     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_location?
 446   end
 447 end