app/validators/system_hook_url_validator.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# frozen_string_literal: true

# SystemHookUrlValidator
#
# Custom validator specifically for SystemHook URLs. This validator works like AddressableUrlValidator but
# it blocks urls pointing to localhost or the local network depending on
# ApplicationSetting.allow_local_requests_from_system_hooks
#
# Example:
#
#   class SystemHook < WebHook
#     validates :url, system_hook_url: { allow_localhost: true, allow_local_network: true }
#   end
#
class SystemHookUrlValidator < AddressableUrlValidator
  DEFAULT_OPTIONS = {
    allow_localhost: true,
    allow_local_network: true
  }.freeze

  def initialize(options)
    options.reverse_merge!(DEFAULT_OPTIONS)

    super(options)
  end

  def self.allow_setting_local_requests?
    ApplicationSetting.current&.allow_local_requests_from_system_hooks?
  end
end