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