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