app/models/user.rb

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