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