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   require "xml/libxml"
  49
  50   has_many :traces, -> { where(:visible => true) }
  51   has_many :diary_entries, -> { order(:created_at => :desc) }
  52   has_many :diary_comments, -> { order(:created_at => :desc) }
  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) }
  63   has_many :changeset_comments, :foreign_key => :author_id
  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
  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"
  70
  71   has_many :blocks, :class_name => "UserBlock"
  72   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
  73   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
  74
  75   has_many :roles, :class_name => "UserRole"
  76
  77   has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id
  78   has_many :issue_comments
  79
  80   has_many :reports
  81
  82   scope :visible, -> { where(:status => %w[pending active confirmed]) }
  83   scope :active, -> { where(:status => %w[active confirmed]) }
  84   scope :identifiable, -> { where(:data_public => true) }
  85
  86   has_one_attached :avatar
  87
  88   validates :display_name, :presence => true, :length => 3..255,
  89                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
  90   validates :display_name, :if => proc { |u| u.display_name_changed? },
  91                            :uniqueness => { :case_sensitive => false }
  92   validates :display_name, :if => proc { |u| u.display_name_changed? },
  93                            :characters => { :url_safe => true },
  94                            :whitespace => { :leading => false, :trailing => false }
  95   validates :email, :presence => true, :confirmation => true, :characters => true
  96   validates :email, :if => proc { |u| u.email_changed? },
  97                     :uniqueness => { :case_sensitive => false }
  98   validates :email, :if => proc { |u| u.email_changed? },
  99                     :whitespace => { :leading => false, :trailing => false }
 100   validates :pass_crypt, :confirmation => true, :length => 8..255
 101   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
 102   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
 103   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
 104   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
 105   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
 106                        :uniqueness => { :scope => :auth_provider }
 107   validates :avatar, :if => proc { |u| u.attachment_changes["avatar"] },
 108                      :image => true
 109
 110   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
 111   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
 112
 113   after_initialize :set_defaults
 114   before_save :encrypt_password
 115   before_save :update_tile
 116   after_save :spam_check
 117   after_save :reset_preferred_languages
 118
 119   def to_param
 120     display_name
 121   end
 122
 123   def self.authenticate(options)
 124     if options[:username] && options[:password]
 125       user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])
 126
 127       if user.nil?
 128         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username].strip, options[:username])
 129
 130         user = users.first if users.count == 1
 131       end
 132
 133       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
 134         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
 135           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
 136           user.save
 137         end
 138       else
 139         user = nil
 140       end
 141     elsif options[:token]
 142       token = UserToken.find_by(:token => options[:token])
 143       user = token.user if token
 144     end
 145
 146     if user &&
 147        (user.status == "deleted" ||
 148          (user.status == "pending" && !options[:pending]) ||
 149          (user.status == "suspended" && !options[:suspended]))
 150       user = nil
 151     end
 152
 153     token.update(:expiry => 1.week.from_now) if token && user
 154
 155     user
 156   end
 157
 158   def description
 159     RichText.new(self[:description_format], self[:description])
 160   end
 161
 162   def languages
 163     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
 164   end
 165
 166   def languages=(languages)
 167     self[:languages] = languages.join(",")
 168   end
 169
 170   def preferred_language
 171     languages.find { |l| Language.exists?(:code => l) }
 172   end
 173
 174   def preferred_languages
 175     @preferred_languages ||= Locale.list(languages)
 176   end
 177
 178   def reset_preferred_languages
 179     @preferred_languages = nil
 180   end
 181
 182   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
 183     if home_lon && home_lat
 184       gc = OSM::GreatCircle.new(home_lat, home_lon)
 185       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
 186       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
 187       nearby = User.active.identifiable
 188                    .where.not(:id => id)
 189                    .where(sql_for_area)
 190                    .where("#{sql_for_distance} <= ?", radius)
 191                    .order(Arel.sql(sql_for_distance))
 192                    .limit(num)
 193     else
 194       nearby = []
 195     end
 196     nearby
 197   end
 198
 199   def distance(nearby_user)
 200     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
 201   end
 202
 203   def is_friends_with?(new_friend)
 204     friendships.exists?(:befriendee => new_friend)
 205   end
 206
 207   ##
 208   # returns true if a user is visible
 209   def visible?
 210     %w[pending active confirmed].include? status
 211   end
 212
 213   ##
 214   # returns true if a user is active
 215   def active?
 216     %w[active confirmed].include? status
 217   end
 218
 219   ##
 220   # returns true if the user has the moderator role, false otherwise
 221   def moderator?
 222     has_role? "moderator"
 223   end
 224
 225   ##
 226   # returns true if the user has the administrator role, false otherwise
 227   def administrator?
 228     has_role? "administrator"
 229   end
 230
 231   ##
 232   # returns true if the user has the requested role
 233   def has_role?(role)
 234     roles.any? { |r| r.role == role }
 235   end
 236
 237   ##
 238   # returns the first active block which would require users to view
 239   # a message, or nil if there are none.
 240   def blocked_on_view
 241     blocks.active.detect(&:needs_view?)
 242   end
 243
 244   ##
 245   # delete a user - leave the account but purge most personal data
 246   def delete
 247     avatar.purge_later
 248
 249     self.display_name = "user_#{id}"
 250     self.description = ""
 251     self.home_lat = nil
 252     self.home_lon = nil
 253     self.email_valid = false
 254     self.new_email = nil
 255     self.auth_provider = nil
 256     self.auth_uid = nil
 257     self.status = "deleted"
 258
 259     save
 260   end
 261
 262   ##
 263   # return a spam score for a user
 264   def spam_score
 265     changeset_score = changesets.size * 50
 266     trace_score = traces.size * 50
 267     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 268     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 269
 270     score = description.spam_score / 4.0
 271     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
 272     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
 273     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
 274     score -= changeset_score
 275     score -= trace_score
 276
 277     score.to_i
 278   end
 279
 280   ##
 281   # perform a spam check on a user
 282   def spam_check
 283     update(:status => "suspended") if status == "active" && spam_score > Settings.spam_threshold
 284   end
 285
 286   ##
 287   # return an oauth access token for a specified application
 288   def access_token(application_key)
 289     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
 290   end
 291
 292   def fingerprint
 293     digest = Digest::SHA256.new
 294     digest.update(email)
 295     digest.update(pass_crypt)
 296     digest.hexdigest
 297   end
 298
 299   def max_messages_per_hour
 300     account_age_in_seconds = Time.now.utc - creation_time
 301     account_age_in_hours = account_age_in_seconds / 3600
 302     recent_messages = messages.where("sent_on >= ?", Time.now.utc - 3600).count
 303     active_reports = issues.with_status(:open).sum(:reports_count)
 304     max_messages = account_age_in_hours.ceil + recent_messages - active_reports * 10
 305     max_messages.clamp(0, Settings.max_messages_per_hour)
 306   end
 307
 308   def max_friends_per_hour
 309     account_age_in_seconds = Time.now.utc - creation_time
 310     account_age_in_hours = account_age_in_seconds / 3600
 311     recent_friends = friendships.where("created_at >= ?", Time.now.utc - 3600).count
 312     active_reports = issues.with_status(:open).sum(:reports_count)
 313     max_messages = account_age_in_hours.ceil + recent_friends - active_reports * 10
 314     max_messages.clamp(0, Settings.max_friends_per_hour)
 315   end
 316
 317   private
 318
 319   def set_defaults
 320     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
 321   end
 322
 323   def encrypt_password
 324     if pass_crypt_confirmation
 325       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
 326       self.pass_crypt_confirmation = nil
 327     end
 328   end
 329
 330   def update_tile
 331     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
 332   end
 333 end