Add links to the ToU and include them in signup
[rails.git] / app / models / user_block.rb
1 # == Schema Information
2 #
3 # Table name: user_blocks
4 #
5 #  id            :integer          not null, primary key
6 #  user_id       :integer          not null
7 #  creator_id    :integer          not null
8 #  reason        :text             not null
9 #  ends_at       :datetime         not null
10 #  needs_view    :boolean          default(FALSE), not null
11 #  revoker_id    :integer
12 #  created_at    :datetime
13 #  updated_at    :datetime
14 #  reason_format :enum             default("markdown"), not null
15 #
16 # Indexes
17 #
18 #  index_user_blocks_on_user_id  (user_id)
19 #
20 # Foreign Keys
21 #
22 #  user_blocks_moderator_id_fkey  (creator_id => users.id)
23 #  user_blocks_revoker_id_fkey    (revoker_id => users.id)
24 #  user_blocks_user_id_fkey       (user_id => users.id)
25 #
26
27 class UserBlock < ActiveRecord::Base
28   validate :moderator_permissions
29   validates :reason, :characters => true
30
31   belongs_to :user, :class_name => "User", :foreign_key => :user_id
32   belongs_to :creator, :class_name => "User", :foreign_key => :creator_id
33   belongs_to :revoker, :class_name => "User", :foreign_key => :revoker_id
34
35   PERIODS = Settings.user_block_periods
36
37   ##
38   # scope to match active blocks
39   def self.active
40     where("needs_view or ends_at > ?", Time.now.getutc)
41   end
42
43   ##
44   # return a renderable version of the reason text.
45   def reason
46     RichText.new(self[:reason_format], self[:reason])
47   end
48
49   ##
50   # returns true if the block is currently active (i.e: the user can't
51   # use the API).
52   def active?
53     needs_view || ends_at > Time.now.getutc
54   end
55
56   ##
57   # returns true if the block is a "zero hour" block
58   def zero_hour?
59     # if the times differ more than 1 minute we probably have more important issues
60     needs_view && (ends_at.to_i - updated_at.to_i) < 60
61   end
62
63   ##
64   # revokes the block, allowing the user to use the API again. the argument
65   # is the user object who is revoking the ban.
66   def revoke!(revoker)
67     update(
68       :ends_at => Time.now.getutc,
69       :revoker_id => revoker.id,
70       :needs_view => false
71     )
72   end
73
74   private
75
76   ##
77   # validate that only moderators are allowed to change the
78   # block. this should be caught and dealt with in the controller,
79   # but i've also included it here just in case.
80   def moderator_permissions
81     errors.add(:base, I18n.t("user_block.model.non_moderator_update")) if creator_id_changed? && !creator.moderator?
82     errors.add(:base, I18n.t("user_block.model.non_moderator_revoke")) unless revoker_id.nil? || revoker.moderator?
83   end
84 end