app/models/user.rb

   1 # == Schema Information
   2 #
   3 # Table name: users
   4 #
   5 #  email               :string           not null
   6 #  id                  :integer          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           :integer
  37 #
  38 # Indexes
  39 #
  40 #  users_auth_idx                (auth_provider,auth_uid) UNIQUE
  41 #  users_display_name_idx        (display_name) UNIQUE
  42 #  users_display_name_lower_idx  (lower((display_name)::text))
  43 #  users_email_idx               (email) UNIQUE
  44 #  users_email_lower_idx         (lower((email)::text))
  45 #  users_home_idx                (home_tile)
  46 #
  47
  48 class User < ActiveRecord::Base
  49   require "xml/libxml"
  50
  51   has_many :traces, -> { where(:visible => true) }
  52   has_many :diary_entries, -> { order(:created_at => :desc) }
  53   has_many :diary_comments, -> { order(:created_at => :desc) }
  54   has_many :diary_entry_subscriptions, :class_name => "DiaryEntrySubscription"
  55   has_many :diary_subscriptions, :through => :diary_entry_subscriptions, :source => :diary_entry
  56   has_many :messages, -> { where(:to_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
  57   has_many :new_messages, -> { where(:to_user_visible => true, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
  58   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
  59   has_many :friends, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
  60   has_many :friend_users, :through => :friends, :source => :befriendee
  61   has_many :tokens, :class_name => "UserToken"
  62   has_many :preferences, :class_name => "UserPreference"
  63   has_many :changesets, -> { order(:created_at => :desc) }
  64   has_many :changeset_comments, :foreign_key => :author_id
  65   has_and_belongs_to_many :changeset_subscriptions, :class_name => "Changeset", :join_table => "changesets_subscribers", :foreign_key => "subscriber_id"
  66   has_many :note_comments, :foreign_key => :author_id
  67   has_many :notes, :through => :note_comments
  68
  69   has_many :client_applications
  70   has_many :oauth_tokens, -> { order(:authorized_at => :desc).preload(:client_application) }, :class_name => "OauthToken"
  71
  72   has_many :blocks, :class_name => "UserBlock"
  73   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
  74   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
  75
  76   has_many :roles, :class_name => "UserRole"
  77
  78   scope :visible, -> { where(:status => %w[pending active confirmed]) }
  79   scope :active, -> { where(:status => %w[active confirmed]) }
  80   scope :identifiable, -> { where(:data_public => true) }
  81
  82   has_attached_file :image,
  83                     :default_url => "/assets/:class/:attachment/:style.png",
  84                     :styles => { :large => "100x100>", :small => "50x50>" }
  85
  86   validates :display_name, :presence => true, :allow_nil => true, :length => 3..255,
  87                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
  88   validates :display_name, :if => proc { |u| u.display_name_changed? },
  89                            :uniqueness => { :case_sensitive => false }
  90   validates :display_name, :if => proc { |u| u.display_name_changed? },
  91                            :format => { :with => %r{\A[^\x00-\x1f\x7f\ufffe\uffff/;.,?%#]*\z} }
  92   validates :display_name, :if => proc { |u| u.display_name_changed? },
  93                            :format => { :with => /\A\S/, :message => "has leading whitespace" }
  94   validates :display_name, :if => proc { |u| u.display_name_changed? },
  95                            :format => { :with => /\S\z/, :message => "has trailing whitespace" }
  96   validates :email, :presence => true, :confirmation => true
  97   validates :email, :if => proc { |u| u.email_changed? },
  98                     :uniqueness => { :case_sensitive => false }
  99   validates :pass_crypt, :confirmation => true, :length => 8..255
 100   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
 101   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
 102   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
 103   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
 104   validates :image, :attachment_content_type => { :content_type => %r{\Aimage/.*\Z} }
 105   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
 106                        :uniqueness => { :scope => :auth_provider }
 107
 108   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
 109   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
 110
 111   after_initialize :set_defaults
 112   before_save :encrypt_password
 113   before_save :update_tile
 114   after_save :spam_check
 115
 116   def to_param
 117     display_name
 118   end
 119
 120   def self.authenticate(options)
 121     if options[:username] && options[:password]
 122       user = find_by("email = ? OR display_name = ?", options[:username], options[:username])
 123
 124       if user.nil?
 125         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username], options[:username])
 126
 127         user = users.first if users.count == 1
 128       end
 129
 130       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
 131         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
 132           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
 133           user.save
 134         end
 135       else
 136         user = nil
 137       end
 138     elsif options[:token]
 139       token = UserToken.find_by(:token => options[:token])
 140       user = token.user if token
 141     end
 142
 143     if user &&
 144        (user.status == "deleted" ||
 145          (user.status == "pending" && !options[:pending]) ||
 146          (user.status == "suspended" && !options[:suspended]))
 147       user = nil
 148     end
 149
 150     token.update(:expiry => 1.week.from_now) if token && user
 151
 152     user
 153   end
 154
 155   def to_xml
 156     doc = OSM::API.new.get_xml_doc
 157     doc.root << to_xml_node
 158     doc
 159   end
 160
 161   def to_xml_node
 162     el1 = XML::Node.new "user"
 163     el1["display_name"] = display_name.to_s
 164     el1["account_created"] = creation_time.xmlschema
 165     if home_lat && home_lon
 166       home = XML::Node.new "home"
 167       home["lat"] = home_lat.to_s
 168       home["lon"] = home_lon.to_s
 169       home["zoom"] = home_zoom.to_s
 170       el1 << home
 171     end
 172     el1
 173   end
 174
 175   def description
 176     RichText.new(self[:description_format], self[:description])
 177   end
 178
 179   def languages
 180     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
 181   end
 182
 183   def languages=(languages)
 184     self[:languages] = languages.join(",")
 185   end
 186
 187   def preferred_language
 188     languages.find { |l| Language.exists?(:code => l) }
 189   end
 190
 191   def preferred_languages
 192     @preferred_languages ||= Locale.list(languages)
 193   end
 194
 195   def nearby(radius = NEARBY_RADIUS, num = NEARBY_USERS)
 196     if home_lon && home_lat
 197       gc = OSM::GreatCircle.new(home_lat, home_lon)
 198       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
 199       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
 200       nearby = User.active.identifiable
 201                    .where("id != ?", id)
 202                    .where(sql_for_area)
 203                    .where("#{sql_for_distance} <= ?", radius)
 204                    .order(sql_for_distance)
 205                    .limit(num)
 206     else
 207       nearby = []
 208     end
 209     nearby
 210   end
 211
 212   def distance(nearby_user)
 213     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
 214   end
 215
 216   def is_friends_with?(new_friend)
 217     friends.where(:friend_user_id => new_friend.id).exists?
 218   end
 219
 220   ##
 221   # returns true if a user is visible
 222   def visible?
 223     %w[pending active confirmed].include? status
 224   end
 225
 226   ##
 227   # returns true if a user is active
 228   def active?
 229     %w[active confirmed].include? status
 230   end
 231
 232   ##
 233   # returns true if the user has the moderator role, false otherwise
 234   def moderator?
 235     has_role? "moderator"
 236   end
 237
 238   ##
 239   # returns true if the user has the administrator role, false otherwise
 240   def administrator?
 241     has_role? "administrator"
 242   end
 243
 244   ##
 245   # returns true if the user has the requested role
 246   def has_role?(role)
 247     roles.any? { |r| r.role == role }
 248   end
 249
 250   ##
 251   # returns the first active block which would require users to view
 252   # a message, or nil if there are none.
 253   def blocked_on_view
 254     blocks.active.detect(&:needs_view?)
 255   end
 256
 257   ##
 258   # delete a user - leave the account but purge most personal data
 259   def delete
 260     self.display_name = "user_#{id}"
 261     self.description = ""
 262     self.home_lat = nil
 263     self.home_lon = nil
 264     self.image = nil
 265     self.email_valid = false
 266     self.new_email = nil
 267     self.auth_provider = nil
 268     self.auth_uid = nil
 269     self.status = "deleted"
 270     save
 271   end
 272
 273   ##
 274   # return a spam score for a user
 275   def spam_score
 276     changeset_score = changesets.size * 50
 277     trace_score = traces.size * 50
 278     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 279     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 280
 281     score = description.spam_score / 4.0
 282     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
 283     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
 284     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
 285     score -= changeset_score
 286     score -= trace_score
 287
 288     score.to_i
 289   end
 290
 291   ##
 292   # perform a spam check on a user
 293   def spam_check
 294     update(:status => "suspended") if status == "active" && spam_score > SPAM_THRESHOLD
 295   end
 296
 297   ##
 298   # return an oauth access token for a specified application
 299   def access_token(application_key)
 300     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
 301   end
 302
 303   private
 304
 305   def set_defaults
 306     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
 307   end
 308
 309   def encrypt_password
 310     if pass_crypt_confirmation
 311       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
 312       self.pass_crypt_confirmation = nil
 313     end
 314   end
 315
 316   def update_tile
 317     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
 318   end
 319 end