app/models/user.rb

   1 # == Schema Information
   2 #
   3 # Table name: users
   4 #
   5 #  email               :string           not null
   6 #  id                  :integer          not null, primary key
   7 #  pass_crypt          :string           not null
   8 #  creation_time       :datetime         not null
   9 #  display_name        :string           default(""), not null
  10 #  data_public         :boolean          default(FALSE), not null
  11 #  description         :text             default(""), not null
  12 #  home_lat            :float
  13 #  home_lon            :float
  14 #  home_zoom           :integer          default(3)
  15 #  nearby              :integer          default(50)
  16 #  pass_salt           :string
  17 #  image_file_name     :text
  18 #  email_valid         :boolean          default(FALSE), not null
  19 #  new_email           :string
  20 #  creation_ip         :string
  21 #  languages           :string
  22 #  status              :enum             default("pending"), not null
  23 #  terms_agreed        :datetime
  24 #  consider_pd         :boolean          default(FALSE), not null
  25 #  auth_uid            :string
  26 #  preferred_editor    :string
  27 #  terms_seen          :boolean          default(FALSE), not null
  28 #  description_format  :enum             default("markdown"), not null
  29 #  image_fingerprint   :string
  30 #  changesets_count    :integer          default(0), not null
  31 #  traces_count        :integer          default(0), not null
  32 #  diary_entries_count :integer          default(0), not null
  33 #  image_use_gravatar  :boolean          default(FALSE), not null
  34 #  image_content_type  :string
  35 #  auth_provider       :string
  36 #  home_tile           :integer
  37 #
  38 # Indexes
  39 #
  40 #  users_auth_idx                (auth_provider,auth_uid) UNIQUE
  41 #  users_display_name_idx        (display_name) UNIQUE
  42 #  users_display_name_lower_idx  (lower((display_name)::text))
  43 #  users_email_idx               (email) UNIQUE
  44 #  users_email_lower_idx         (lower((email)::text))
  45 #  users_home_idx                (home_tile)
  46 #
  47
  48 class User < ActiveRecord::Base
  49   require "xml/libxml"
  50
  51   has_many :traces, -> { where(:visible => true) }
  52   has_many :diary_entries, -> { order(:created_at => :desc) }
  53   has_many :diary_comments, -> { order(:created_at => :desc) }
  54   has_many :diary_entry_subscriptions, :class_name => "DiaryEntrySubscription"
  55   has_many :diary_subscriptions, :through => :diary_entry_subscriptions, :source => :diary_entry
  56   has_many :messages, -> { where(:to_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
  57   has_many :new_messages, -> { where(:to_user_visible => true, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
  58   has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
  59   has_many :friends, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
  60   has_many :friend_users, :through => :friends, :source => :befriendee
  61   has_many :tokens, :class_name => "UserToken"
  62   has_many :preferences, :class_name => "UserPreference"
  63   has_many :changesets, -> { order(:created_at => :desc) }
  64   has_many :changeset_comments, :foreign_key => :author_id
  65   has_and_belongs_to_many :changeset_subscriptions, :class_name => "Changeset", :join_table => "changesets_subscribers", :foreign_key => "subscriber_id"
  66   has_many :note_comments, :foreign_key => :author_id
  67   has_many :notes, :through => :note_comments
  68
  69   has_many :client_applications
  70   has_many :oauth_tokens, -> { order(:authorized_at => :desc).preload(:client_application) }, :class_name => "OauthToken"
  71
  72   has_many :blocks, :class_name => "UserBlock"
  73   has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
  74   has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
  75
  76   has_many :roles, :class_name => "UserRole"
  77
  78   has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id
  79   has_many :issue_comments
  80
  81   has_many :reports
  82
  83   scope :visible, -> { where(:status => %w[pending active confirmed]) }
  84   scope :active, -> { where(:status => %w[active confirmed]) }
  85   scope :identifiable, -> { where(:data_public => true) }
  86
  87   has_attached_file :image,
  88                     :default_url => "/assets/:class/:attachment/:style.png",
  89                     :styles => { :large => "100x100>", :small => "50x50>" }
  90
  91   INVALID_ASCII_CHARS = "/;.,?%#".freeze
  92   INVALID_NON_ASCII_CHARS = "\x00-\x08\x0b-\x0c\x0e-\x1f\x7f\ufffe\uffff".freeze
  93
  94   validates :display_name, :presence => true, :allow_nil => true, :length => 3..255,
  95                            :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
  96   validates :display_name, :if => proc { |u| u.display_name_changed? },
  97                            :uniqueness => { :case_sensitive => false }
  98   validates :display_name, :if => proc { |u| u.display_name_changed? },
  99                            :format => { :with => /\A[^#{INVALID_NON_ASCII_CHARS}]*\z/ }
 100   validates :display_name, :if => proc { |u| u.display_name_changed? },
 101                            :format => { :with => /\A[^#{INVALID_ASCII_CHARS}]*\z/,
 102                                         :message => I18n.t("users.account.invalid chars", :invalid_chars => INVALID_ASCII_CHARS) }
 103   validates :display_name, :if => proc { |u| u.display_name_changed? },
 104                            :format => { :with => /\A\S/, :message => I18n.t("users.account.leading whitespace") }
 105   validates :display_name, :if => proc { |u| u.display_name_changed? },
 106                            :format => { :with => /\S\z/, :message => I18n.t("users.account.trailing whitespace") }
 107   validates :email, :presence => true, :confirmation => true
 108   validates :email, :if => proc { |u| u.email_changed? },
 109                     :uniqueness => { :case_sensitive => false }
 110   validates :pass_crypt, :confirmation => true, :length => 8..255
 111   validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
 112   validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
 113   validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
 114   validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
 115   validates :image, :attachment_content_type => { :content_type => %r{\Aimage/.*\Z} }
 116   validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
 117                        :uniqueness => { :scope => :auth_provider }
 118
 119   validates_email_format_of :email, :if => proc { |u| u.email_changed? }
 120   validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
 121
 122   after_initialize :set_defaults
 123   before_save :encrypt_password
 124   before_save :update_tile
 125   after_save :spam_check
 126   after_save :reset_preferred_languages
 127
 128   def to_param
 129     display_name
 130   end
 131
 132   def self.authenticate(options)
 133     if options[:username] && options[:password]
 134       user = find_by("email = ? OR display_name = ?", options[:username], options[:username])
 135
 136       if user.nil?
 137         users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username], options[:username])
 138
 139         user = users.first if users.count == 1
 140       end
 141
 142       if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
 143         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
 144           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
 145           user.save
 146         end
 147       else
 148         user = nil
 149       end
 150     elsif options[:token]
 151       token = UserToken.find_by(:token => options[:token])
 152       user = token.user if token
 153     end
 154
 155     if user &&
 156        (user.status == "deleted" ||
 157          (user.status == "pending" && !options[:pending]) ||
 158          (user.status == "suspended" && !options[:suspended]))
 159       user = nil
 160     end
 161
 162     token.update(:expiry => 1.week.from_now) if token && user
 163
 164     user
 165   end
 166
 167   def to_xml
 168     doc = OSM::API.new.get_xml_doc
 169     doc.root << to_xml_node
 170     doc
 171   end
 172
 173   def to_xml_node
 174     el1 = XML::Node.new "user"
 175     el1["display_name"] = display_name.to_s
 176     el1["account_created"] = creation_time.xmlschema
 177     if home_lat && home_lon
 178       home = XML::Node.new "home"
 179       home["lat"] = home_lat.to_s
 180       home["lon"] = home_lon.to_s
 181       home["zoom"] = home_zoom.to_s
 182       el1 << home
 183     end
 184     el1
 185   end
 186
 187   def description
 188     RichText.new(self[:description_format], self[:description])
 189   end
 190
 191   def languages
 192     attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []
 193   end
 194
 195   def languages=(languages)
 196     self[:languages] = languages.join(",")
 197   end
 198
 199   def preferred_language
 200     languages.find { |l| Language.exists?(:code => l) }
 201   end
 202
 203   def preferred_languages
 204     @preferred_languages ||= Locale.list(languages)
 205   end
 206
 207   def reset_preferred_languages
 208     @preferred_languages = nil
 209   end
 210
 211   def nearby(radius = NEARBY_RADIUS, num = NEARBY_USERS)
 212     if home_lon && home_lat
 213       gc = OSM::GreatCircle.new(home_lat, home_lon)
 214       sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
 215       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
 216       nearby = User.active.identifiable
 217                    .where("id != ?", id)
 218                    .where(sql_for_area)
 219                    .where("#{sql_for_distance} <= ?", radius)
 220                    .order(Arel.sql(sql_for_distance))
 221                    .limit(num)
 222     else
 223       nearby = []
 224     end
 225     nearby
 226   end
 227
 228   def distance(nearby_user)
 229     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
 230   end
 231
 232   def is_friends_with?(new_friend)
 233     friends.where(:friend_user_id => new_friend.id).exists?
 234   end
 235
 236   ##
 237   # returns true if a user is visible
 238   def visible?
 239     %w[pending active confirmed].include? status
 240   end
 241
 242   ##
 243   # returns true if a user is active
 244   def active?
 245     %w[active confirmed].include? status
 246   end
 247
 248   ##
 249   # returns true if the user has the moderator role, false otherwise
 250   def moderator?
 251     has_role? "moderator"
 252   end
 253
 254   ##
 255   # returns true if the user has the administrator role, false otherwise
 256   def administrator?
 257     has_role? "administrator"
 258   end
 259
 260   ##
 261   # returns true if the user has the requested role
 262   def has_role?(role)
 263     roles.any? { |r| r.role == role }
 264   end
 265
 266   ##
 267   # returns the first active block which would require users to view
 268   # a message, or nil if there are none.
 269   def blocked_on_view
 270     blocks.active.detect(&:needs_view?)
 271   end
 272
 273   ##
 274   # delete a user - leave the account but purge most personal data
 275   def delete
 276     self.display_name = "user_#{id}"
 277     self.description = ""
 278     self.home_lat = nil
 279     self.home_lon = nil
 280     self.image = nil
 281     self.email_valid = false
 282     self.new_email = nil
 283     self.auth_provider = nil
 284     self.auth_uid = nil
 285     self.status = "deleted"
 286     save
 287   end
 288
 289   ##
 290   # return a spam score for a user
 291   def spam_score
 292     changeset_score = changesets.size * 50
 293     trace_score = traces.size * 50
 294     diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 295     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 296
 297     score = description.spam_score / 4.0
 298     score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
 299     score += diary_entry_score / diary_entries.length unless diary_entries.empty?
 300     score += diary_comment_score / diary_comments.length unless diary_comments.empty?
 301     score -= changeset_score
 302     score -= trace_score
 303
 304     score.to_i
 305   end
 306
 307   ##
 308   # perform a spam check on a user
 309   def spam_check
 310     update(:status => "suspended") if status == "active" && spam_score > SPAM_THRESHOLD
 311   end
 312
 313   ##
 314   # return an oauth access token for a specified application
 315   def access_token(application_key)
 316     ClientApplication.find_by(:key => application_key).access_token_for_user(self)
 317   end
 318
 319   private
 320
 321   def set_defaults
 322     self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
 323   end
 324
 325   def encrypt_password
 326     if pass_crypt_confirmation
 327       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
 328       self.pass_crypt_confirmation = nil
 329     end
 330   end
 331
 332   def update_tile
 333     self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
 334   end
 335 end