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