Merge remote-tracking branch 'upstream/pull/4559'

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

diff --git a/app/models/user.rb b/app/models/user.rb
index c02795a4af9656f4e8219d15dd942ab54e27a26c..45ecbcc1b1360476b549285d51171f286c57f148 100644 (file)
--- a/app/models/user.rb
+++ b/app/models/user.rb
@@ -12,7 +12,6 @@
 #  home_lat            :float
 #  home_lon            :float
 #  home_zoom           :integer          default(3)
 #  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
 #  pass_salt           :string
 #  email_valid         :boolean          default(FALSE), not null
 #  new_email           :string


@@ -35,50 +34,53 @@
 #
 # Indexes
 #
 #
 # 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)
+#  users_auth_idx                    (auth_provider,auth_uid) UNIQUE
+#  users_display_name_canonical_idx  (lower(NORMALIZE(display_name, NFKC)))
+#  users_display_name_idx            (display_name) UNIQUE
+#  users_email_idx                   (email) UNIQUE
+#  users_email_lower_idx             (lower((email)::text))
+#  users_home_idx                    (home_tile)

 #
 
 class User < ApplicationRecord
   require "digest"
 #
 
 class User < ApplicationRecord
   require "digest"

-  require "xml/libxml"
+  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 :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 :messages, -> { where(:to_user_visible => true, :muted => false).order(:sent_on => :desc).preload(:sender, :recipient) }, :foreign_key => :to_user_id
+  has_many :new_messages, -> { where(:to_user_visible => true, :muted => false, :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 :sent_messages, -> { where(:from_user_visible => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :from_user_id

+  has_many :muted_messages, -> { where(:to_user_visible => true, :muted => true).order(:sent_on => :desc).preload(:sender, :recipient) }, :class_name => "Message", :foreign_key => :to_user_id

   has_many :friendships, -> { joins(:befriendee).where(:users => { :status => %w[active confirmed] }) }
   has_many :friends, :through => :friendships, :source => :befriendee
   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 :changeset_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_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 :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, :foreign_key => :owner_id
+  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 :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_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 :mutes, -> { order(:created_at => :desc) }, :class_name => "UserMute", :foreign_key => :owner_id, :inverse_of => :owner
+  has_many :muted_users, :through => :mutes, :source => :subject

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

-  has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id
+  has_many :issues, :class_name => "Issue", :foreign_key => :reported_user_id, :inverse_of => :reported_user

   has_many :issue_comments
 
   has_many :reports
   has_many :issue_comments
 
   has_many :reports


@@ -87,15 +89,17 @@ class User < ApplicationRecord
   scope :active, -> { where(:status => %w[active confirmed]) }
   scope :identifiable, -> { where(:data_public => true) }
 
   scope :active, -> { where(:status => %w[active confirmed]) }
   scope :identifiable, -> { where(:data_public => true) }
 

-  has_one_attached :avatar
+  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? },
 
   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 }
+                           :normalized_uniqueness => { :case_sensitive => false }

   validates :display_name, :if => proc { |u| u.display_name_changed? },
                            :characters => { :url_safe => true },
   validates :display_name, :if => proc { |u| u.display_name_changed? },
                            :characters => { :url_safe => true },

-                           :whitespace => { :leading => false, :trailing => false }
+                           :whitespace => { :leading => false, :trailing => false },
+                           :width => { :minimum => 3 }
+  validate :display_name_cannot_be_user_id_with_other_id, :if => proc { |u| u.display_name_changed? }

   validates :email, :presence => true, :confirmation => true, :characters => true
   validates :email, :if => proc { |u| u.email_changed? },
                     :uniqueness => { :case_sensitive => false }
   validates :email, :presence => true, :confirmation => true, :characters => true
   validates :email, :if => proc { |u| u.email_changed? },
                     :uniqueness => { :case_sensitive => false }


@@ -114,11 +118,29 @@ class User < ApplicationRecord
   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? }
 
   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
+  alias_attribute :created_at, :creation_time
+

   before_save :encrypt_password
   before_save :update_tile
   after_save :spam_check
   before_save :encrypt_password
   before_save :update_tile
   after_save :spam_check

-  after_save :reset_preferred_languages
+
+  generates_token_for :new_user, :expires_in => 1.week do
+    fingerprint
+  end
+
+  generates_token_for :new_email, :expires_in => 1.week do
+    fingerprint
+  end
+
+  generates_token_for :password_reset, :expires_in => 1.week do
+    fingerprint
+  end
+
+  def display_name_cannot_be_user_id_with_other_id
+    display_name&.match(/^user_(\d+)$/i) do |m|
+      errors.add :display_name, I18n.t("activerecord.errors.messages.display_name_is_user_n") unless m[1].to_i == id
+    end
+  end

 
   def to_param
     display_name
 
   def to_param
     display_name


@@ -129,7 +151,7 @@ class User < ApplicationRecord
       user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])
 
       if user.nil?
       user = find_by("email = ? OR display_name = ?", options[:username].strip, options[:username])
 
       if user.nil?

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

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


@@ -142,9 +164,6 @@ class User < ApplicationRecord
       else
         user = nil
       end
       else
         user = nil
       end

-    elsif options[:token]
-      token = UserToken.find_by(:token => options[:token])
-      user = token.user if token

     end
 
     if user &&
     end
 
     if user &&


@@ -154,11 +173,68 @@ class User < ApplicationRecord
       user = nil
     end
 
       user = nil
     end
 

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

     user
   end
 
     user
   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
+
+    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
+

   def description
     RichText.new(self[:description_format], self[:description])
   end
   def description
     RichText.new(self[:description_format], self[:description])
   end


@@ -179,12 +255,12 @@ class User < ApplicationRecord
     @preferred_languages ||= Locale.list(languages)
   end
 
     @preferred_languages ||= Locale.list(languages)
   end
 

-  def reset_preferred_languages
-    @preferred_languages = nil
+  def home_location?
+    home_lat && home_lon

   end
 
   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)
   end
 
   def nearby(radius = Settings.nearby_radius, num = Settings.nearby_users)

-    if home_lon && home_lat
+    if home_location?

       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")
       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")


@@ -204,7 +280,7 @@ class User < ApplicationRecord
     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
   end
 
     OSM::GreatCircle.new(home_lat, home_lon).distance(nearby_user.home_lat, nearby_user.home_lon)
   end
 

-  def is_friends_with?(new_friend)
+  def friends_with?(new_friend)

     friendships.exists?(:befriendee => new_friend)
   end
 
     friendships.exists?(:befriendee => new_friend)
   end
 


@@ -223,18 +299,24 @@ class User < ApplicationRecord
   ##
   # returns true if the user has the moderator role, false otherwise
   def moderator?
   ##
   # returns true if the user has the moderator role, false otherwise
   def moderator?

-    has_role? "moderator"
+    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"
+    role? "administrator"
+  end
+
+  ##
+  # returns true if the user has the importer role, false otherwise
+  def importer?
+    role? "importer"

   end
 
   ##
   # returns true if the user has the requested role
   end
 
   ##
   # returns true if the user has the requested role

-  def has_role?(role)
+  def role?(role)

     roles.any? { |r| r.role == role }
   end
 
     roles.any? { |r| r.role == role }
   end
 


@@ -246,8 +328,15 @@ class User < ApplicationRecord
   end
 
   ##
   end
 
   ##

-  # delete a user - leave the account but purge most personal data
-  def delete
+  # revoke any authentication tokens
+  def revoke_authentication_tokens
+    oauth_tokens.authorized.each(&:invalidate!)
+    access_tokens.not_expired.each(&:revoke)
+  end
+
+  ##
+  # remove personal data - leave the account but purge most personal data
+  def remove_personal_data

     avatar.purge_later
 
     self.display_name = "user_#{id}"
     avatar.purge_later
 
     self.display_name = "user_#{id}"


@@ -258,7 +347,6 @@ class User < ApplicationRecord
     self.new_email = nil
     self.auth_provider = nil
     self.auth_uid = nil
     self.new_email = nil
     self.auth_provider = nil
     self.auth_uid = nil

-    self.status = "deleted"

 
     save
   end
 
     save
   end


@@ -272,9 +360,9 @@ class User < ApplicationRecord
     diary_comment_score = diary_comments.visible.inject(0) { |acc, elem| acc + elem.body.spam_score }
 
     score = description.spam_score / 4.0
     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 += diary_entries.visible.where("created_at > ?", 1.day.ago).count * 10
+    score += diary_entry_score / diary_entries.visible.length unless diary_entries.visible.empty?
+    score += diary_comment_score / diary_comments.visible.length unless diary_comments.visible.empty?

     score -= changeset_score
     score -= trace_score
 
     score -= changeset_score
     score -= trace_score
 


@@ -284,7 +372,7 @@ class User < ApplicationRecord
   ##
   # perform a spam check on a user
   def spam_check
   ##
   # perform a spam check on a user
   def spam_check

-    update(:status => "suspended") if status == "active" && spam_score > Settings.spam_threshold
+    suspend! if may_suspend? && spam_score > Settings.spam_threshold

   end
 
   ##
   end
 
   ##


@@ -312,30 +400,56 @@ class User < ApplicationRecord
     digest.hexdigest
   end
 
     digest.hexdigest
   end
 

+  def active_reports
+    issues
+      .with_status(:open)
+      .joins(:reports)
+      .where("reports.updated_at >= COALESCE(issues.resolved_at, '1970-01-01')")
+      .count
+  end
+

   def max_messages_per_hour
   def max_messages_per_hour

-    account_age_in_seconds = Time.now.utc - creation_time
+    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
     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 = 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
     max_messages.clamp(0, Settings.max_messages_per_hour)
   end
 
   def max_friends_per_hour

-    account_age_in_seconds = Time.now.utc - creation_time
+    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
     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 = account_age_in_hours.ceil + recent_friends - (active_reports * 10)

     max_friends.clamp(0, Settings.max_friends_per_hour)
   end
 
     max_friends.clamp(0, Settings.max_friends_per_hour)
   end
 

-  private
+  def max_changeset_comments_per_hour
+    if moderator?
+      Settings.moderator_changeset_comments_per_hour
+    else
+      previous_comments = changeset_comments.limit(200).count
+      max_comments = previous_comments / 200.0 * Settings.max_changeset_comments_per_hour
+      max_comments = max_comments.floor.clamp(Settings.initial_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
+      max_comments /= 2**active_reports
+      max_comments.floor.clamp(Settings.min_changeset_comments_per_hour, Settings.max_changeset_comments_per_hour)
+    end
+  end
+
+  def deletion_allowed_at
+    unless Settings.user_account_deletion_delay.nil?
+      last_changeset = changesets.reorder(:closed_at => :desc).first
+      return last_changeset.closed_at.utc + Settings.user_account_deletion_delay.hours if last_changeset
+    end
+    creation_time.utc
+  end

 
 

-  def set_defaults
-    self.creation_time = Time.now.getutc unless attribute_present?(:creation_time)
+  def deletion_allowed?
+    deletion_allowed_at <= Time.now.utc

   end
 
   end
 

+  private
+

   def encrypt_password
     if pass_crypt_confirmation
       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)
   def encrypt_password
     if pass_crypt_confirmation
       self.pass_crypt, self.pass_salt = PasswordHash.create(pass_crypt)


@@ -344,6 +458,6 @@ class User < ApplicationRecord
   end
 
   def update_tile
   end
 
   def update_tile

-    self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_lat && home_lon
+    self.home_tile = QuadTile.tile_for_point(home_lat, home_lon) if home_location?

   end
 end
   end
 end