Remove outdated comment

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

diff --git a/app/models/user_block.rb b/app/models/user_block.rb
index 66b2c81ff5d28eaa320ded5afe8da0ccea04b3d3..7af1f9bdc2d009a562bb910a6d560c6e7ae1846a 100644 (file)
--- a/app/models/user_block.rb
+++ b/app/models/user_block.rb
@@ -1,36 +1,84 @@
-class UserBlock < ActiveRecord::Base
+# == Schema Information
+#
+# Table name: user_blocks
+#
+#  id            :integer          not null, primary key
+#  user_id       :bigint(8)        not null
+#  creator_id    :bigint(8)        not null
+#  reason        :text             not null
+#  ends_at       :datetime         not null
+#  needs_view    :boolean          default(FALSE), not null
+#  revoker_id    :bigint(8)
+#  created_at    :datetime
+#  updated_at    :datetime
+#  reason_format :enum             default("markdown"), not null
+#
+# Indexes
+#
+#  index_user_blocks_on_user_id  (user_id)
+#
+# Foreign Keys
+#
+#  user_blocks_moderator_id_fkey  (creator_id => users.id)
+#  user_blocks_revoker_id_fkey    (revoker_id => users.id)
+#  user_blocks_user_id_fkey       (user_id => users.id)
+#
+
+class UserBlock < ApplicationRecord
   validate :moderator_permissions
+  validates :reason, :characters => true
+
+  belongs_to :user, :class_name => "User"
+  belongs_to :creator, :class_name => "User"
+  belongs_to :revoker, :class_name => "User", :optional => true
+
+  PERIODS = Settings.user_block_periods
+
+  ##
+  # scope to match active blocks
+  def self.active
+    where("needs_view or ends_at > ?", Time.now.utc)
+  end
 
-  belongs_to :user, :class_name => "User", :foreign_key => :user_id
-  belongs_to :moderator, :class_name => "User", :foreign_key => :moderator_id
-  belongs_to :revoker, :class_name => "User", :foreign_key => :revoker_id
-  
-  PERIODS = [0, 1, 3, 6, 12, 24, 48, 96]
+  ##
+  # return a renderable version of the reason text.
+  def reason
+    RichText.new(self[:reason_format], self[:reason])
+  end
 
   ##
   # returns true if the block is currently active (i.e: the user can't
   # use the API).
   def active?
-    needs_view or end_at > Time.now.getutc
+    needs_view || ends_at > Time.now.utc
+  end
+
+  ##
+  # returns true if the block is a "zero hour" block
+  def zero_hour?
+    # if the times differ more than 1 minute we probably have more important issues
+    needs_view && (ends_at.to_i - updated_at.to_i) < 60
   end
 
   ##
   # revokes the block, allowing the user to use the API again. the argument
   # is the user object who is revoking the ban.
   def revoke!(revoker)
-    attrs = { :end_at => Time.now.getutc(),
-              :revoker_id => @user.id,
-              :needs_view => false }
-    revoker.moderator? and update_attributes(attrs)
+    update(
+      :ends_at => Time.now.utc,
+      :revoker_id => revoker.id,
+      :needs_view => false
+    )
   end
 
   private
+
   ##
   # validate that only moderators are allowed to change the
   # block. this should be caught and dealt with in the controller,
   # but i've also included it here just in case.
   def moderator_permissions
-    errors.add_to_base("Must be a moderator to create or update a block.") if moderator_id_changed? and !moderator.moderator?
-    errors.add_to_base("Must be a moderator to revoke a block.") unless revoker_id.nil? or revoker.moderator?
+    errors.add(:base, I18n.t("user_blocks.model.non_moderator_update")) if creator_id_changed? && !creator.moderator?
+    errors.add(:base, I18n.t("user_blocks.model.non_moderator_revoke")) if revoker_id_changed? && !revoker_id.nil? && !revoker.moderator?
   end
 end