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