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