summaryrefslogtreecommitdiff
path: root/code/environments/production/modules/stdlib/lib/puppet/parser/functions/is_ip_address.rb
blob: 6ce993a3c2f2a5c69df44d0ce7b64d6ab7ca11ae (plain)
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
#
# is_ip_address.rb
#
module Puppet::Parser::Functions
  newfunction(:is_ip_address, :type => :rvalue, :doc => <<-DOC
    Returns true if the string passed to this function is a valid IP address.
    DOC
             ) do |arguments|

    require 'ipaddr'

    function_deprecation([:is_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function,
                           with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.'])

    if arguments.size != 1
      raise(Puppet::ParseError, "is_ip_address(): Wrong number of arguments given #{arguments.size} for 1")
    end

    begin
      ip = IPAddr.new(arguments[0])
    rescue ArgumentError
      return false
    end

    return true if ip.ipv4? || ip.ipv6?
    return false
  end
end

# vim: set ts=2 sw=2 et :