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 #  image_file_name     :text
  18 #  email_valid         :boolean          default(FALSE), not null
  19 #  new_email           :string
  20 #  creation_ip         :string
  21 #  languages           :string
  22 #  status              :enum             default("pending"), not null
  23 #  terms_agreed        :datetime
  24 #  consider_pd         :boolean          default(FALSE), not null
  25 #  auth_uid            :string
  26 #  preferred_editor    :string
  27 #  terms_seen          :boolean          default(FALSE), not null
  28 #  description_format  :enum             default("markdown"), not null
  29 #  image_fingerprint   :string
  30 #  changesets_count    :integer          default(0), not null
  31 #  traces_count        :integer          default(0), not null
  32 #  diary_entries_count :integer          default(0), not null
  33 #  image_use_gravatar  :boolean          default(FALSE), not null
  34 #  image_content_type  :string
  35 #  auth_provider       :string
  36 #  home_tile           :bigint(8)
  37 #  tou_agreed          :datetime
  38 #
  39 # Indexes
  40 #
  41 #  users_auth_idx                (auth_provider,auth_uid) UNIQUE
  42 #  users_display_name_idx        (display_name) UNIQUE
  43 #  users_display_name_lower_idx  (lower((display_name)::text))
  44 #  users_email_idx               (email) UNIQUE
  45 #  users_email_lower_idx         (lower((email)::text))
  46 #  users_home_idx                (home_tile)
  47 #
  48
  49 class User < ActiveRecord::Base
  50   require "xml/libxml"
  51
  52   has_many :traces, -> { where(:visible => true) }
  53   has_many :diary_entries, -> { order(:created_at => :desc) }
  54   has_many :diary_comments, -> { order(:created_at => :desc) }
  55   has_many :diary_entry_subscriptions, :class_name => "DiaryEntrySubscription"
  56   has_many :diary_subscriptions, :through => :diary_entry_subscriptions, :source => :diary_entry
  57   has_many :messages, -> { where(:to_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
  58   has_many :new_messages, -> { where(:to_user_visible => true, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
  59   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
  60   has_many :friendships, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
  61   has_many :friends, :through => :friendships, :source => :befriendee
  62   has_many :tokens, :class_name => "UserToken"
  63   has_many :preferences, :class_name => "UserPreference"
  64   has_many :changesets, -> { order(:created_at => :desc) }
  65   has_many :changeset_comments, :foreign_key => :author_id
  66   has_and_belongs_to_many :changeset_subscriptions, :class_name => "Changeset", :join_table => "changesets_subscribers", :foreign_key => "subscriber_id"
  67   has_many :note_comments, :foreign_key => :author_id
  68   has_many :notes, :through => :note_comments
  69
  70   has_many :client_applications
  71   has_many :oauth_tokens, -> { order(:authorized_at => :desc).preload(:client_application) }, :class_name => "OauthToken"
  72
  73   has_many :blocks, :class_name => "UserBlock"
  74   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
  75   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
  76
  77   has_many :roles, :class_name => "UserRole"
  78
  79   has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id
  80   has_many :issue_comments
  81
  82   has_many :reports
  83
  84   scope :visible, -> { where(:status => %w[pending active confirmed]) }
  85   scope :active, -> { where(:status => %w[active confirmed]) }
  86   scope :identifiable, -> { where(:data_public => true) }
  87
  88   has_one_attached :avatar
  89
  90   has_attached_file :image,
  91                     :default_url => "/assets/:class/:attachment/:style.png",
  92                     :styles => { :large => "100x100>", :small => "50x50>" }
  93
  94   validates :display_name, :presence => true, :length => 3..255,
  95                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
  96   validates :display_name, :if => proc { |u| u.display_name_changed? },
  97                            :uniqueness => { :case_sensitive => false }
  98   validates :display_name, :if => proc { |u| u.display_name_changed? },
  99                            :characters => { :url_safe => true },
 100                            :whitespace => { :leading => false, :trailing => false }
 101   validates :email, :presence => true, :confirmation => true, :characters => true
 102   validates :email, :if => proc { |u| u.email_changed? },
 103                     :uniqueness => { :case_sensitive => false }
 104   validates :email, :if => proc { |u| u.email_changed? },
 105                     :whitespace => { :leading => false, :trailing => false }
 106   validates :pass_crypt, :confirmation => true, :length => 8..255
 107   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
 108   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
 109   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
 110   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
 111   validates :image, :attachment_content_type => { :content_type => %r{\Aimage/.*\Z} }
 112   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
 113                        :uniqueness => { :scope => :auth_provider }
 114
 115   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
 116   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
 117
 118   after_initialize :set_defaults
 119   before_save :encrypt_password
 120   before_save :update_tile
 121   after_save :spam_check
 122   after_save :reset_preferred_languages
 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(display_name) = LOWER(?)", 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   def to_xml
 164     doc = OSM::API.new.get_xml_doc
 165     doc.root << to_xml_node
 166     doc
 167   end
 168
 169   def to_xml_node
 170     el1 = XML::Node.new "user"
 171     el1["display_name"] = display_name.to_s
 172     el1["account_created"] = creation_time.xmlschema
 173     if home_lat && home_lon
 174       home = XML::Node.new "home"
 175       home["lat"] = home_lat.to_s
 176       home["lon"] = home_lon.to_s
 177       home["zoom"] = home_zoom.to_s
 178       el1 << home
 179     end
 180     el1
 181   end
 182
 183   def description
 184     RichText.new(self[:description_format], self[:description])
 185   end
 186
 187   def languages
 188     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
 189   end
 190
 191   def languages=(languages)
 192     self[:languages] = languages.join(",")
 193   end
 194
 195   def preferred_language
 196     languages.find { |l| Language.exists?(:code => l) }
 197   end
 198
 199   def preferred_languages
 200     @preferred_languages ||= Locale.list(languages)
 201   end
 202
 203   def reset_preferred_languages
 204     @preferred_languages = nil
 205   end
 206
 207   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
 208     if home_lon && home_lat
 209       gc = OSM::GreatCircle.new(home_lat, home_lon)
 210       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
 211       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
 212       nearby = User.active.identifiable
 213                    .where("id != ?", id)
 214                    .where(sql_for_area)
 215                    .where("#{sql_for_distance} <= ?", radius)
 216                    .order(Arel.sql(sql_for_distance))
 217                    .limit(num)
 218     else
 219       nearby = []
 220     end
 221     nearby
 222   end
 223
 224   def distance(nearby_user)
 225     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
 226   end
 227
 228   def is_friends_with?(new_friend)
 229     friendships.where(:befriendee => new_friend).exists?
 230   end
 231
 232   ##
 233   # returns true if a user is visible
 234   def visible?
 235     %w[pending active confirmed].include? status
 236   end
 237
 238   ##
 239   # returns true if a user is active
 240   def active?
 241     %w[active confirmed].include? status
 242   end
 243
 244   ##
 245   # returns true if the user has the moderator role, false otherwise
 246   def moderator?
 247     has_role? "moderator"
 248   end
 249
 250   ##
 251   # returns true if the user has the administrator role, false otherwise
 252   def administrator?
 253     has_role? "administrator"
 254   end
 255
 256   ##
 257   # returns true if the user has the requested role
 258   def has_role?(role)
 259     roles.any? { |r| r.role == role }
 260   end
 261
 262   ##
 263   # returns the first active block which would require users to view
 264   # a message, or nil if there are none.
 265   def blocked_on_view
 266     blocks.active.detect(&:needs_view?)
 267   end
 268
 269   ##
 270   # delete a user - leave the account but purge most personal data
 271   def delete
 272     avatar.purge
 273
 274     self.display_name = "user_#{id}"
 275     self.description = ""
 276     self.home_lat = nil
 277     self.home_lon = nil
 278     self.image = nil
 279     self.email_valid = false
 280     self.new_email = nil
 281     self.auth_provider = nil
 282     self.auth_uid = nil
 283     self.status = "deleted"
 284
 285     save
 286   end
 287
 288   ##
 289   # return a spam score for a user
 290   def spam_score
 291     changeset_score = changesets.size * 50
 292     trace_score = traces.size * 50
 293     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 294     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 295
 296     score = description.spam_score / 4.0
 297     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
 298     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
 299     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
 300     score -= changeset_score
 301     score -= trace_score
 302
 303     score.to_i
 304   end
 305
 306   ##
 307   # perform a spam check on a user
 308   def spam_check
 309     update(:status => "suspended") if status == "active" && spam_score > Settings.spam_threshold
 310   end
 311
 312   ##
 313   # return an oauth access token for a specified application
 314   def access_token(application_key)
 315     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
 316   end
 317
 318   private
 319
 320   def set_defaults
 321     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
 322   end
 323
 324   def encrypt_password
 325     if pass_crypt_confirmation
 326       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
 327       self.pass_crypt_confirmation = nil
 328     end
 329   end
 330
 331   def update_tile
 332     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
 333   end
 334 end