Merge pull request #3009 from gravitystorm/svg_icons

[rails.git] / app / models / user.rb

diff --git a/app/models/user.rb b/app/models/user.rb
index c64fcf21b93b66a2b1f915c1f2c77bad607482a4..9cc8b7d8361cb62a64f7f089a8256d6d6a80ee03 100644 (file)
--- a/app/models/user.rb
+++ b/app/models/user.rb
@@ -1,101 +1,313 @@
-class User < ActiveRecord::Base
-  require 'xml/libxml'
-  require 'digest/md5'
-
-  has_many :traces
-  has_many :diary_entries
-  has_many :messages, :foreign_key => :to_user_id
-  has_many :friends
-
-  validates_confirmation_of :pass_crypt, :message => 'Password must match the confirmation password'
-  validates_uniqueness_of :display_name, :allow_nil => true
-  validates_uniqueness_of :email
-  validates_length_of :pass_crypt, :minimum => 8
-  validates_length_of :display_name, :minimum => 3, :allow_nil => true
-  validates_format_of :email, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+# == Schema Information
+#
+# Table name: users
+#
+#  email               :string           not null
+#  id                  :bigint(8)        not null, primary key
+#  pass_crypt          :string           not null
+#  creation_time       :datetime         not null
+#  display_name        :string           default(""), not null
+#  data_public         :boolean          default(FALSE), not null
+#  description         :text             default(""), not null
+#  home_lat            :float
+#  home_lon            :float
+#  home_zoom           :integer          default(3)
+#  nearby              :integer          default(50)
+#  pass_salt           :string
+#  email_valid         :boolean          default(FALSE), not null
+#  new_email           :string
+#  creation_ip         :string
+#  languages           :string
+#  status              :enum             default("pending"), not null
+#  terms_agreed        :datetime
+#  consider_pd         :boolean          default(FALSE), not null
+#  auth_uid            :string
+#  preferred_editor    :string
+#  terms_seen          :boolean          default(FALSE), not null
+#  description_format  :enum             default("markdown"), not null
+#  changesets_count    :integer          default(0), not null
+#  traces_count        :integer          default(0), not null
+#  diary_entries_count :integer          default(0), not null
+#  image_use_gravatar  :boolean          default(FALSE), not null
+#  auth_provider       :string
+#  home_tile           :bigint(8)
+#  tou_agreed          :datetime
+#
+# Indexes
+#
+#  users_auth_idx                (auth_provider,auth_uid) UNIQUE
+#  users_display_name_idx        (display_name) UNIQUE
+#  users_display_name_lower_idx  (lower((display_name)::text))
+#  users_email_idx               (email) UNIQUE
+#  users_email_lower_idx         (lower((email)::text))
+#  users_home_idx                (home_tile)
+#

 
 

-  def set_defaults
-    self.creation_time = Time.now
-    self.timeout = Time.now
-    self.token = User.make_token()
-  end
+class User < ApplicationRecord
+  require "digest"
+  require "xml/libxml"

 
 

-  def pass_crypt=(str) 
-    write_attribute("pass_crypt", Digest::MD5.hexdigest(str)) 
-  end
+  has_many :traces, -> { where(:visible => true) }
+  has_many :diary_entries, -> { order(:created_at => :desc) }
+  has_many :diary_comments, -> { order(:created_at => :desc) }
+  has_many :diary_entry_subscriptions, :class_name => "DiaryEntrySubscription"
+  has_many :diary_subscriptions, :through => :diary_entry_subscriptions, :source => :diary_entry
+  has_many :messages, -> { where(:to_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
+  has_many :new_messages, -> { where(:to_user_visible => true, :message_read => false).order(:sent_on => :desc) }, :class_name => "Message", :foreign_key => :to_user_id
+  has_many :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id
+  has_many :friendships, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
+  has_many :friends, :through => :friendships, :source => :befriendee
+  has_many :tokens, :class_name => "UserToken", :dependent => :destroy
+  has_many :preferences, :class_name => "UserPreference"
+  has_many :changesets, -> { order(:created_at => :desc) }
+  has_many :changeset_comments, :foreign_key => :author_id
+  has_and_belongs_to_many :changeset_subscriptions, :class_name => "Changeset", :join_table => "changesets_subscribers", :foreign_key => "subscriber_id"
+  has_many :note_comments, :foreign_key => :author_id
+  has_many :notes, :through => :note_comments
+
+  has_many :client_applications
+  has_many :oauth_tokens, -> { order(:authorized_at => :desc).preload(:client_application) }, :class_name => "OauthToken"
+
+  has_many :blocks, :class_name => "UserBlock"
+  has_many :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id
+  has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id
+
+  has_many :roles, :class_name => "UserRole"
+
+  has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id
+  has_many :issue_comments
+
+  has_many :reports

 
 

-  def pass_crypt_confirmation=(str) 
-    write_attribute("pass_crypt_confirm", Digest::MD5.hexdigest(str)) 
+  scope :visible, -> { where(:status => %w[pending active confirmed]) }
+  scope :active, -> { where(:status => %w[active confirmed]) }
+  scope :identifiable, -> { where(:data_public => true) }
+
+  has_one_attached :avatar
+
+  validates :display_name, :presence => true, :length => 3..255,
+                           :exclusion => %w[new terms save confirm confirm-email go_public reset-password forgot-password suspended]
+  validates :display_name, :if => proc { |u| u.display_name_changed? },
+                           :uniqueness => { :case_sensitive => false }
+  validates :display_name, :if => proc { |u| u.display_name_changed? },
+                           :characters => { :url_safe => true },
+                           :whitespace => { :leading => false, :trailing => false }
+  validates :email, :presence => true, :confirmation => true, :characters => true
+  validates :email, :if => proc { |u| u.email_changed? },
+                    :uniqueness => { :case_sensitive => false }
+  validates :email, :if => proc { |u| u.email_changed? },
+                    :whitespace => { :leading => false, :trailing => false }
+  validates :pass_crypt, :confirmation => true, :length => 8..255
+  validates :home_lat, :allow_nil => true, :numericality => true, :inclusion => { :in => -90..90 }
+  validates :home_lon, :allow_nil => true, :numericality => true, :inclusion => { :in => -180..180 }
+  validates :home_zoom, :allow_nil => true, :numericality => { :only_integer => true }
+  validates :preferred_editor, :inclusion => Editors::ALL_EDITORS, :allow_nil => true
+  validates :auth_uid, :unless => proc { |u| u.auth_provider.nil? },
+                       :uniqueness => { :scope => :auth_provider }
+
+  validates_email_format_of :email, :if => proc { |u| u.email_changed? }
+  validates_email_format_of :new_email, :allow_blank => true, :if => proc { |u| u.new_email_changed? }
+
+  after_initialize :set_defaults
+  before_save :encrypt_password
+  before_save :update_tile
+  after_save :spam_check
+  after_save :reset_preferred_languages
+
+  def to_param
+    display_name

   end
 
   end
 

-  def self.authenticate(email, passwd)
-    find(:first, :conditions => [ "email = ? AND pass_crypt = ? AND active = true", email, Digest::MD5.hexdigest(passwd)])
-  end 
+  def self.authenticate(options)
+    if options[:username] && options[:password]
+      user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])

 
 

-  def self.authenticate_token(token) 
-    find(:first, :conditions => [ "token = ? ", token])
-  end 
+      if user.nil?
+        users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username].strip, options[:username])

 
 

-  def self.make_token(length=30)
-    chars = 'abcdefghijklmnopqrtuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
-    confirmstring = ''
+        user = users.first if users.count == 1
+      end

 
 

-    length.times do
-      confirmstring += chars[(rand * chars.length).to_i].chr
+      if user && PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
+        if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
+          user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
+          user.save
+        end
+      else
+        user = nil
+      end
+    elsif options[:token]
+      token = UserToken.find_by(:token => options[:token])
+      user = token.user if token

     end
 
     end
 

-    return confirmstring
+    if user &&
+       (user.status == "deleted" ||
+         (user.status == "pending" && !options[:pending]) ||
+         (user.status == "suspended" && !options[:suspended]))
+      user = nil
+    end
+
+    token.update(:expiry => 1.week.from_now) if token && user
+
+    user

   end
 
   end
 

-  def to_xml
-    doc = OSM::API.new.get_xml_doc
-    doc.root << to_xml_node()
-    return doc
+  def description
+    RichText.new(self[:description_format], self[:description])

   end
 
   end
 

-  def to_xml_node
-    el1 = XML::Node.new 'user'
-    el1['display_name'] = self.display_name.to_s
-    el1['account_created'] = self.creation_time.xmlschema
-    return el1
+  def languages
+    attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []

   end
 
   end
 

-  def nearby(lat_range=1, lon_range=1)
-      if self.home_lon and self.home_lat 
-          nearby = User.find(:all,  :conditions => "#{self.home_lon} > home_lon - #{lon_range} and #{self.home_lon} < home_lon + #{lon_range} and  #{self.home_lon} > home_lon - #{lon_range} and #{self.home_lon} < home_lon + #{lon_range} and data_public = 1 and id != #{self.id}") 
-      else
-          nearby = []
-      end
-      return nearby
+  def languages=(languages)
+    self[:languages] = languages.join(",")
+  end
+
+  def preferred_language
+    languages.find { |l| Language.exists?(:code => l) }

   end
 
   end
 

-  def self.has_messages?
-    if Message.fdhjklsafind_by_to_user_id(self.id) 
-      return true
+  def preferred_languages
+    @preferred_languages ||= Locale.list(languages)
+  end
+
+  def reset_preferred_languages
+    @preferred_languages = nil
+  end
+
+  def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
+    if home_lon && home_lat
+      gc = OSM::GreatCircle.new(home_lat, home_lon)
+      sql_for_area = QuadTile.sql_for_area(gc.bounds(radius), "home_")
+      sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")
+      nearby = User.active.identifiable
+                   .where.not(:id => id)
+                   .where(sql_for_area)
+                   .where("#{sql_for_distance} <= ?", radius)
+                   .order(Arel.sql(sql_for_distance))
+                   .limit(num)

     else
     else

-      return false
+      nearby = []

     end
     end

+    nearby

   end
 
   end
 

-  def get_new_messages
-    messages = Message.find(:all, :conditions => "message_read = 0 and to_user_id = #{self.id}")
-    return messages
+  def distance(nearby_user)
+    OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)

   end
 
   end
 

-  def get_all_messages
-    messages = Message.find(:all, :conditions => "to_user_id = #{self.id}")
-    return messages
+  def is_friends_with?(new_friend)
+    friendships.exists?(:befriendee => new_friend)

   end
 
   end
 

-  def is_friends_with?(new_friend)
-    res = false
-    @new_friend = new_friend
-    self.friends.each do |friend|
-      if friend.user_id == @new_friend.user_id
-        return true
-      end
+  ##
+  # returns true if a user is visible
+  def visible?
+    %w[pending active confirmed].include? status
+  end
+
+  ##
+  # returns true if a user is active
+  def active?
+    %w[active confirmed].include? status
+  end
+
+  ##
+  # returns true if the user has the moderator role, false otherwise
+  def moderator?
+    has_role? "moderator"
+  end
+
+  ##
+  # returns true if the user has the administrator role, false otherwise
+  def administrator?
+    has_role? "administrator"
+  end
+
+  ##
+  # returns true if the user has the requested role
+  def has_role?(role)
+    roles.any? { |r| r.role == role }
+  end
+
+  ##
+  # returns the first active block which would require users to view
+  # a message, or nil if there are none.
+  def blocked_on_view
+    blocks.active.detect(&:needs_view?)
+  end
+
+  ##
+  # delete a user - leave the account but purge most personal data
+  def delete
+    avatar.purge_later
+
+    self.display_name = "user_#{id}"
+    self.description = ""
+    self.home_lat = nil
+    self.home_lon = nil
+    self.email_valid = false
+    self.new_email = nil
+    self.auth_provider = nil
+    self.auth_uid = nil
+    self.status = "deleted"
+
+    save
+  end
+
+  ##
+  # return a spam score for a user
+  def spam_score
+    changeset_score = changesets.size * 50
+    trace_score = traces.size * 50
+    diary_entry_score = diary_entries.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
+    diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
+
+    score = description.spam_score / 4.0
+    score += diary_entries.where("created_at > ?", 1.day.ago).count * 10
+    score += diary_entry_score / diary_entries.length unless diary_entries.empty?
+    score += diary_comment_score / diary_comments.length unless diary_comments.empty?
+    score -= changeset_score
+    score -= trace_score
+
+    score.to_i
+  end
+
+  ##
+  # perform a spam check on a user
+  def spam_check
+    update(:status => "suspended") if status == "active" && spam_score > Settings.spam_threshold
+  end
+
+  ##
+  # return an oauth access token for a specified application
+  def access_token(application_key)
+    ClientApplication.find_by(:key => application_key).access_token_for_user(self)
+  end
+
+  def fingerprint
+    digest = Digest::SHA256.new
+    digest.update(email)
+    digest.update(pass_crypt)
+    digest.hexdigest
+  end
+
+  private
+
+  def set_defaults
+    self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
+  end
+
+  def encrypt_password
+    if pass_crypt_confirmation
+      self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
+      self.pass_crypt_confirmation = nil

     end
     end

-    return false

   end
 
   end
 

+  def update_tile
+    self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
+  end

 end
 end