Bump osm-community-index from 5.5.2 to 5.5.3

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

diff --git a/app/models/user.rb b/app/models/user.rb
index b5200760262c53280c7fabb76858fcdb73df8e6f..c809b619294732038c97558423b349fe2050212c 100644 (file)
--- a/app/models/user.rb
+++ b/app/models/user.rb
@@ -1,72 +1,140 @@
-class User < ActiveRecord::Base
-  require 'xml/libxml'
+# == 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)
+#
+
+class User < ApplicationRecord
+  require "digest"
+  include AASM

 
   has_many :traces, -> { where(:visible => true) }
 
   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_entries, -> { order(:created_at => :desc) }, :inverse_of => :user
+  has_many :diary_comments, -> { order(:created_at => :desc) }, :inverse_of => :user
+  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 :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 :friends, -> { joins(:befriendee).where(:users => { :status => ["active", "confirmed"] }) }
-  has_many :friend_users, :through => :friends, :source => :befriendee
-  has_many :tokens, :class_name => "UserToken"
+  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 :preferences, :class_name => "UserPreference"

-  has_many :changesets, -> { order(:created_at => :desc) }
-  has_many :note_comments, :foreign_key => :author_id
+  has_many :changesets, -> { order(:created_at => :desc) }, :inverse_of => :user
+  has_many :changeset_comments, :foreign_key => :author_id, :inverse_of => :author
+  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, :inverse_of => :author

   has_many :notes, :through => :note_comments
 
   has_many :client_applications
   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 :oauth_tokens, -> { order(:authorized_at => :desc).preload(:client_application) }, :class_name => "OauthToken", :inverse_of => :user
+
+  has_many :oauth2_applications, :class_name => Doorkeeper.config.application_model.name, :as => :owner
+  has_many :access_grants, :class_name => Doorkeeper.config.access_grant_model.name, :foreign_key => :resource_owner_id
+  has_many :access_tokens, :class_name => Doorkeeper.config.access_token_model.name, :foreign_key => :resource_owner_id

 
   has_many :blocks, :class_name => "UserBlock"
 
   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 :blocks_created, :class_name => "UserBlock", :foreign_key => :creator_id, :inverse_of => :creator
+  has_many :blocks_revoked, :class_name => "UserBlock", :foreign_key => :revoker_id, :inverse_of => :revoker

 
   has_many :roles, :class_name => "UserRole"
 
 
   has_many :roles, :class_name => "UserRole"
 

-  scope :visible, -> { where(:status => ["pending", "active", "confirmed"]) }
-  scope :active, -> { where(:status => ["active", "confirmed"]) }
-  scope :public, -> { where(:data_public => true) }
-
-  validates_presence_of :email, :display_name
-  validates_confirmation_of :email#, :message => ' addresses must match'
-  validates_confirmation_of :pass_crypt#, :message => ' must match the confirmation password'
-  validates_uniqueness_of :display_name, :allow_nil => true, :case_sensitive => false, :if => Proc.new { |u| u.display_name_changed? }
-  validates_uniqueness_of :email, :case_sensitive => false, :if => Proc.new { |u| u.email_changed? }
-  validates_uniqueness_of :openid_url, :allow_nil => true
-  validates_length_of :pass_crypt, :within => 8..255
-  validates_length_of :display_name, :within => 3..255, :allow_nil => true
-  validates_email_format_of :email, :if => Proc.new { |u| u.email_changed? }
-  validates_email_format_of :new_email, :allow_blank => true, :if => Proc.new { |u| u.new_email_changed? }
-  validates_format_of :display_name, :with => /\A[^\/;.,?%#]*\z/, :if => Proc.new { |u| u.display_name_changed? }
-  validates_format_of :display_name, :with => /\A\S/, :message => "has leading whitespace", :if => Proc.new { |u| u.display_name_changed? }
-  validates_format_of :display_name, :with => /\S\z/, :message => "has trailing whitespace", :if => Proc.new { |u| u.display_name_changed? }
-  validates_numericality_of :home_lat, :allow_nil => true
-  validates_numericality_of :home_lon, :allow_nil => true
-  validates_numericality_of :home_zoom, :only_integer => true, :allow_nil => true
-  validates_inclusion_of :preferred_editor, :in => Editors::ALL_EDITORS, :allow_nil => true
-
-  after_initialize :set_defaults
+  has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id, :inverse_of => :reported_user
+  has_many :issue_comments
+
+  has_many :reports
+
+  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, :service => Settings.avatar_storage
+
+  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 :avatar, :if => proc { |u| u.attachment_changes["avatar"] },
+                     :image => true
+
+  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? }
+
+  alias_attribute :created_at, :creation_time
+

   before_save :encrypt_password
   before_save :encrypt_password

+  before_save :update_tile

   after_save :spam_check
 
   after_save :spam_check
 

-  has_attached_file :image,
-    :default_url => "/assets/:class/:attachment/:style.png",
-    :styles => { :large => "100x100>", :small => "50x50>" }
+  def to_param
+    display_name
+  end

 
   def self.authenticate(options)
 
   def self.authenticate(options)

-    if options[:username] and options[:password]
-      user = where("email = ? OR display_name = ?", options[:username], options[:username]).first
+    if options[:username] && options[:password]
+      user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])

 
       if user.nil?
 
       if user.nil?

-        users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username], options[:username])
+        users = where("LOWER(email) = LOWER(?) OR LOWER(display_name) = LOWER(?)", options[:username].strip, options[:username])

 
 

-        if users.count == 1
-          user = users.first
-        end
+        user = users.first if users.count == 1

       end
 
       end
 

-      if user and PasswordHash.check(user.pass_crypt, user.pass_salt, options[:password])
+      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
         if PasswordHash.upgrade?(user.pass_crypt, user.pass_salt)
           user.pass_crypt, user.pass_salt = PasswordHash.create(options[:password])
           user.save


@@ -75,104 +143,148 @@ class User < ActiveRecord::Base
         user = nil
       end
     elsif options[:token]
         user = nil
       end
     elsif options[:token]

-      token = UserToken.find_by_token(options[:token])
+      token = UserToken.find_by(:token => options[:token])

       user = token.user if token
     end
 
       user = token.user if token
     end
 

-    if user and
-      ( user.status == "deleted" or
-        ( user.status == "pending" and not options[:pending] ) or
-        ( user.status == "suspended" and not options[:suspended] ) )
+    if user &&
+       (user.status == "deleted" ||
+         (user.status == "pending" && !options[:pending]) ||
+         (user.status == "suspended" && !options[:suspended]))

       user = nil
     end
 
       user = nil
     end
 

-    token.update_column(:expiry, 1.week.from_now) if token and user
+    token.update(:expiry => 1.week.from_now) if token && user

 
 

-    return user
+    user

   end
 
   end
 

-  def to_xml
-    doc = OSM::API.new.get_xml_doc
-    doc.root << to_xml_node()
-    return doc
-  end
+  aasm :column => :status, :no_direct_assignment => true do
+    state :pending, :initial => true
+    state :active
+    state :confirmed
+    state :suspended
+    state :deleted
+
+    # A normal account is active
+    event :activate do
+      transitions :from => :pending, :to => :active
+    end
+
+    # Used in test suite, not something that we would normally need to do.
+    if Rails.env.test?
+      event :deactivate do
+        transitions :from => :active, :to => :pending
+      end
+    end
+
+    # To confirm an account is used to override the spam scoring
+    event :confirm do
+      transitions :from => [:pending, :active, :suspended], :to => :confirmed
+    end
+
+    # To unconfirm an account is to make it subject to future spam scoring again
+    event :unconfirm do
+      transitions :from => :confirmed, :to => :active
+    end
+
+    # Accounts can be automatically suspended by spam_check
+    event :suspend do
+      transitions :from => [:pending, :active], :to => :suspended
+    end
+
+    # Unsuspending an account moves it back to active without overriding the spam scoring
+    event :unsuspend do
+      transitions :from => :suspended, :to => :active
+    end
+
+    # Mark the account as deleted but keep all data intact
+    event :hide do
+      transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted
+    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
-    if self.home_lat and self.home_lon
-      home = XML::Node.new 'home'
-      home['lat'] = self.home_lat.to_s
-      home['lon'] = self.home_lon.to_s
-      home['zoom'] = self.home_zoom.to_s
-      el1 << home
+    event :unhide do
+      transitions :from => [:deleted], :to => :active
+    end
+
+    # Mark the account as deleted and remove personal data
+    event :soft_destroy do
+      before do
+        revoke_authentication_tokens
+        remove_personal_data
+      end
+
+      transitions :from => [:pending, :active, :confirmed, :suspended], :to => :deleted

     end
     end

-    return el1

   end
 
   def description
   end
 
   def description

-    RichText.new(read_attribute(:description_format), read_attribute(:description))
+    RichText.new(self[:description_format], self[:description])

   end
 
   def languages
   end
 
   def languages

-    attribute_present?(:languages) ? read_attribute(:languages).split(/ *, */) : []
+    attribute_present?(:languages) ? self[:languages].split(/ *[, ] */) : []

   end
 
   def languages=(languages)
   end
 
   def languages=(languages)

-    write_attribute(:languages, languages.join(","))
+    self[:languages] = languages.join(",")

   end
 
   def preferred_language
     languages.find { |l| Language.exists?(:code => l) }
   end
 
   end
 
   def preferred_language
     languages.find { |l| Language.exists?(:code => l) }
   end
 

-  def preferred_language_from(array)
-    (languages & array.collect { |i| i.to_s }).first
+  def preferred_languages
+    @preferred_languages ||= Locale.list(languages)

   end
 
   end
 

-  def nearby(radius = NEARBY_RADIUS, num = NEARBY_USERS)
-    if self.home_lon and self.home_lat
-      gc = OSM::GreatCircle.new(self.home_lat, self.home_lon)
-      bounds = gc.bounds(radius)
+  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")
       sql_for_distance = gc.sql_for_distance("home_lat", "home_lon")

-      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)
+      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
       nearby = []
     end
     else
       nearby = []
     end

-    return nearby
+    nearby

   end
 
   def distance(nearby_user)
   end
 
   def distance(nearby_user)

-    return OSM::GreatCircle.new(self.home_lat, self.home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
+    OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)

   end
 
   end
 

-  def is_friends_with?(new_friend)
-    self.friends.where(:friend_user_id => new_friend.id).exists?
+  def friends_with?(new_friend)
+    friendships.exists?(:befriendee => new_friend)

   end
 
   ##
   # returns true if a user is visible
   def visible?
   end
 
   ##
   # returns true if a user is visible
   def visible?

-    ["pending","active","confirmed"].include? self.status
+    %w[pending active confirmed].include? status

   end
 
   ##
   # returns true if a user is active
   def active?
   end
 
   ##
   # returns true if a user is active
   def active?

-    ["active","confirmed"].include? self.status
+    %w[active confirmed].include? status

   end
 
   ##
   # returns true if the user has the moderator role, false otherwise
   def moderator?
   end
 
   ##
   # returns true if the user has the moderator role, false otherwise
   def moderator?

-    has_role? 'moderator'
+    has_role? "moderator"

   end
 
   ##
   # returns true if the user has the administrator role, false otherwise
   def administrator?
   end
 
   ##
   # returns true if the user has the administrator role, false otherwise
   def administrator?

-    has_role? 'administrator'
+    has_role? "administrator"

   end
 
   ##
   end
 
   ##


@@ -185,66 +297,110 @@ class User < ActiveRecord::Base
   # returns the first active block which would require users to view
   # a message, or nil if there are none.
   def blocked_on_view
   # 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 { |b| b.needs_view? }
+    blocks.active.detect(&:needs_view?)
+  end
+
+  ##
+  # revoke any authentication tokens
+  def revoke_authentication_tokens
+    oauth_tokens.authorized.each(&:invalidate!)
+    access_tokens.not_expired.each(&:revoke)

   end
 
   ##
   end
 
   ##

-  # delete a user - leave the account but purge most personal data
-  def delete
-    self.display_name = "user_#{self.id}"
+  # remove personal data - leave the account but purge most personal data
+  def remove_personal_data
+    avatar.purge_later
+
+    self.display_name = "user_#{id}"

     self.description = ""
     self.home_lat = nil
     self.home_lon = nil
     self.description = ""
     self.home_lat = nil
     self.home_lon = nil

-    self.image = nil

     self.email_valid = false
     self.new_email = nil
     self.email_valid = false
     self.new_email = nil

-    self.openid_url = nil
-    self.status = "deleted"
-    self.save
+    self.auth_provider = nil
+    self.auth_uid = nil
+
+    save

   end
 
   ##
   # return a spam score for a user
   def spam_score
   end
 
   ##
   # return a spam score for a user
   def spam_score

-    changeset_score = self.changesets.size * 50
-    trace_score = self.traces.size * 50
-    diary_entry_score = self.diary_entries.inject(0) { |s,e| s += e.body.spam_score }
-    diary_comment_score = self.diary_comments.inject(0) { |s,c| s += c.body.spam_score }
-
-    score = self.description.spam_score / 4.0
-    score += diary_entry_score / self.diary_entries.length if self.diary_entries.length > 0
-    score += diary_comment_score / self.diary_comments.length if self.diary_comments.length > 0
+    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 -= changeset_score
     score -= trace_score
 

-    return score.to_i
+    score.to_i

   end
 
   ##
   # perform a spam check on a user
   def spam_check
   end
 
   ##
   # perform a spam check on a user
   def spam_check

-    if status == "active" and spam_score > SPAM_THRESHOLD
-      update_column(:status, "suspended")
-    end
+    suspend! if may_suspend? && spam_score > Settings.spam_threshold

   end
 
   ##
   end
 
   ##

-  # return an oauth access token for a specified application
+  # return an oauth 1 access token for a specified application

   def access_token(application_key)
   def access_token(application_key)

-    return ClientApplication.find_by_key(application_key).access_token_for_user(self)
+    ClientApplication.find_by(:key => application_key).access_token_for_user(self)

   end
 
   end
 

-private
+  ##
+  # return an oauth 2 access token for a specified application
+  def oauth_token(application_id)
+    application = Doorkeeper.config.application_model.find_by(:uid => application_id)
+
+    Doorkeeper.config.access_token_model.find_or_create_for(
+      :application => application,
+      :resource_owner => self,
+      :scopes => application.scopes
+    )
+  end

 
 

-  def set_defaults
-    self.creation_time = Time.now.getutc unless self.attribute_present?(:creation_time)
-    self.description_format = "markdown" unless self.attribute_present?(:description_format)
+  def fingerprint
+    digest = Digest::SHA256.new
+    digest.update(email)
+    digest.update(pass_crypt)
+    digest.hexdigest

   end
 
   end
 

+  def max_messages_per_hour
+    account_age_in_seconds = Time.now.utc - created_at
+    account_age_in_hours = account_age_in_seconds / 3600
+    recent_messages = messages.where("sent_on >= ?", Time.now.utc - 3600).count
+    active_reports = issues.with_status(:open).sum(:reports_count)
+    max_messages = account_age_in_hours.ceil + recent_messages - (active_reports * 10)
+    max_messages.clamp(0, Settings.max_messages_per_hour)
+  end
+
+  def max_friends_per_hour
+    account_age_in_seconds = Time.now.utc - created_at
+    account_age_in_hours = account_age_in_seconds / 3600
+    recent_friends = Friendship.where(:befriendee => self).where("created_at >= ?", Time.now.utc - 3600).count
+    active_reports = issues.with_status(:open).sum(:reports_count)
+    max_friends = account_age_in_hours.ceil + recent_friends - (active_reports * 10)
+    max_friends.clamp(0, Settings.max_friends_per_hour)
+  end
+
+  private
+

   def encrypt_password
     if pass_crypt_confirmation
       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
       self.pass_crypt_confirmation = nil
     end
   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

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

 end
 end