app/models/user.rb

   1 class User < ActiveRecord::Base
   2   require 'xml/libxml'
   3
   4   has_many :traces, -> { where(:visible => true) }
   5   has_many :diary_entries, -> { order(:created_at => :desc) }
   6   has_many :diary_comments, -> { order(:created_at => :desc) }
   7   has_many :messages, -> { where(:to_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
   8   has_many :new_messages, -> { where(:to_user_visible => true, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
   9   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
  10   has_many :friends, -> { joins(:befriendee).where(:users => { :status => ["active", "confirmed"] }) }
  11   has_many :friend_users, :through => :friends, :source => :befriendee
  12   has_many :tokens, :class_name => "UserToken"
  13   has_many :preferences, :class_name => "UserPreference"
  14   has_many :changesets, -> { order(:created_at => :desc) }
  15   has_many :note_comments, :foreign_key => :author_id
  16   has_many :notes, :through => :note_comments
  17
  18   has_many :client_applications
  19   has_many :oauth_tokens, -> { order(:authorized_at => :desc).preload(:client_application) }, :class_name => "OauthToken"
  20
  21   has_many :blocks, :class_name => "UserBlock"
  22   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
  23   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
  24
  25   has_many :roles, :class_name => "UserRole"
  26
  27   scope :visible, -> { where(:status => ["pending", "active", "confirmed"]) }
  28   scope :active, -> { where(:status => ["active", "confirmed"]) }
  29   scope :identifiable, -> { where(:data_public => true) }
  30
  31   has_attached_file :image,
  32     :default_url => "/assets/:class/:attachment/:style.png",
  33     :styles => { :large => "100x100>", :small => "50x50>" }
  34
  35   validates_presence_of :email, :display_name
  36   validates_confirmation_of :email#, :message => ' addresses must match'
  37   validates_confirmation_of :pass_crypt#, :message => ' must match the confirmation password'
  38   validates_uniqueness_of :display_name, :allow_nil => true, :case_sensitive => false, :if => Proc.new { |u| u.display_name_changed? }
  39   validates_uniqueness_of :email, :case_sensitive => false, :if => Proc.new { |u| u.email_changed? }
  40   validates_uniqueness_of :openid_url, :allow_nil => true
  41   validates_length_of :pass_crypt, :within => 8..255
  42   validates_length_of :display_name, :within => 3..255, :allow_nil => true
  43   validates_email_format_of :email, :if => Proc.new { |u| u.email_changed? }
  44   validates_email_format_of :new_email, :allow_blank => true, :if => Proc.new { |u| u.new_email_changed? }
  45   validates_format_of :display_name, :with => /\A[^\x00-\x1f\x7f\ufffe\uffff\/;.,?%#]*\z/, :if => Proc.new { |u| u.display_name_changed? }
  46   validates_format_of :display_name, :with => /\A\S/, :message => "has leading whitespace", :if => Proc.new { |u| u.display_name_changed? }
  47   validates_format_of :display_name, :with => /\S\z/, :message => "has trailing whitespace", :if => Proc.new { |u| u.display_name_changed? }
  48   validates_exclusion_of :display_name, :in => %w(new terms save confirm confirm-email go_public reset-password forgot-password suspended)
  49   validates_numericality_of :home_lat, :allow_nil => true
  50   validates_numericality_of :home_lon, :allow_nil => true
  51   validates_numericality_of :home_zoom, :only_integer => true, :allow_nil => true
  52   validates_inclusion_of :preferred_editor, :in => Editors::ALL_EDITORS, :allow_nil => true
  53   validates_attachment_content_type :image, :content_type => /\Aimage\/.*\Z/
  54
  55   after_initialize :set_defaults
  56   before_save :encrypt_password
  57   after_save :spam_check
  58
  59   def self.authenticate(options)
  60     if options[:username] and options[:password]
  61       user = where("email = ? OR display_name = ?", options[:username], options[:username]).first
  62
  63       if user.nil?
  64         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username], options[:username])
  65
  66         if users.count == 1
  67           user = users.first
  68         end
  69       end
  70
  71       if user and PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
  72         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
  73           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
  74           user.save
  75         end
  76       else
  77         user = nil
  78       end
  79     elsif options[:token]
  80       token = UserToken.find_by_token(options[:token])
  81       user = token.user if token
  82     end
  83
  84     if user and
  85       ( user.status == "deleted" or
  86         ( user.status == "pending" and not options[:pending] ) or
  87         ( user.status == "suspended" and not options[:suspended] ) )
  88       user = nil
  89     end
  90
  91     token.update_column(:expiry, 1.week.from_now) if token and user
  92
  93     return user
  94   end
  95
  96   def to_xml
  97     doc = OSM::API.new.get_xml_doc
  98     doc.root << to_xml_node()
  99     return doc
 100   end
 101
 102   def to_xml_node
 103     el1 = XML::Node.new 'user'
 104     el1['display_name'] = self.display_name.to_s
 105     el1['account_created'] = self.creation_time.xmlschema
 106     if self.home_lat and self.home_lon
 107       home = XML::Node.new 'home'
 108       home['lat'] = self.home_lat.to_s
 109       home['lon'] = self.home_lon.to_s
 110       home['zoom'] = self.home_zoom.to_s
 111       el1 << home
 112     end
 113     return el1
 114   end
 115
 116   def description
 117     RichText.new(read_attribute(:description_format), read_attribute(:description))
 118   end
 119
 120   def languages
 121     attribute_present?(:languages) ? read_attribute(:languages).split(/ *, */) : []
 122   end
 123
 124   def languages=(languages)
 125     write_attribute(:languages, languages.join(","))
 126   end
 127
 128   def preferred_language
 129     languages.find { |l| Language.exists?(:code => l) }
 130   end
 131
 132   def preferred_language_from(array)
 133     (languages & array.collect { |i| i.to_s }).first
 134   end
 135
 136   def nearby(radius = NEARBY_RADIUS, num = NEARBY_USERS)
 137     if self.home_lon and self.home_lat
 138       gc = OSM::GreatCircle.new(self.home_lat, self.home_lon)
 139       bounds = gc.bounds(radius)
 140       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
 141       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)
 142     else
 143       nearby = []
 144     end
 145     return nearby
 146   end
 147
 148   def distance(nearby_user)
 149     return OSM::GreatCircle.new(self.home_lat, self.home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
 150   end
 151
 152   def is_friends_with?(new_friend)
 153     self.friends.where(:friend_user_id => new_friend.id).exists?
 154   end
 155
 156   ##
 157   # returns true if a user is visible
 158   def visible?
 159     ["pending","active","confirmed"].include? self.status
 160   end
 161
 162   ##
 163   # returns true if a user is active
 164   def active?
 165     ["active","confirmed"].include? self.status
 166   end
 167
 168   ##
 169   # returns true if the user has the moderator role, false otherwise
 170   def moderator?
 171     has_role? 'moderator'
 172   end
 173
 174   ##
 175   # returns true if the user has the administrator role, false otherwise
 176   def administrator?
 177     has_role? 'administrator'
 178   end
 179
 180   ##
 181   # returns true if the user has the requested role
 182   def has_role?(role)
 183     roles.any? { |r| r.role == role }
 184   end
 185
 186   ##
 187   # returns the first active block which would require users to view
 188   # a message, or nil if there are none.
 189   def blocked_on_view
 190     blocks.active.detect { |b| b.needs_view? }
 191   end
 192
 193   ##
 194   # delete a user - leave the account but purge most personal data
 195   def delete
 196     self.display_name = "user_#{self.id}"
 197     self.description = ""
 198     self.home_lat = nil
 199     self.home_lon = nil
 200     self.image = nil
 201     self.email_valid = false
 202     self.new_email = nil
 203     self.openid_url = nil
 204     self.status = "deleted"
 205     self.save
 206   end
 207
 208   ##
 209   # return a spam score for a user
 210   def spam_score
 211     changeset_score = self.changesets.size * 50
 212     trace_score = self.traces.size * 50
 213     diary_entry_score = self.diary_entries.inject(0) { |s,e| s += e.body.spam_score }
 214     diary_comment_score = self.diary_comments.inject(0) { |s,c| s += c.body.spam_score }
 215
 216     score = self.description.spam_score / 4.0
 217     score += diary_entry_score / self.diary_entries.length if self.diary_entries.length > 0
 218     score += diary_comment_score / self.diary_comments.length if self.diary_comments.length > 0
 219     score -= changeset_score
 220     score -= trace_score
 221
 222     return score.to_i
 223   end
 224
 225   ##
 226   # perform a spam check on a user
 227   def spam_check
 228     if status == "active" and spam_score > SPAM_THRESHOLD
 229       update_column(:status, "suspended")
 230     end
 231   end
 232
 233   ##
 234   # return an oauth access token for a specified application
 235   def access_token(application_key)
 236     return ClientApplication.find_by_key(application_key).access_token_for_user(self)
 237   end
 238
 239 private
 240
 241   def set_defaults
 242     self.creation_time = Time.now.getutc unless self.attribute_present?(:creation_time)
 243     self.description_format = "markdown" unless self.attribute_present?(:description_format)
 244   end
 245
 246   def encrypt_password
 247     if pass_crypt_confirmation
 248       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
 249       self.pass_crypt_confirmation = nil
 250     end
 251   end
 252 end