7f2241b74e2dc50879f16e3748f8859f81cd7d04
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / is_ipv4_address.rb
1 #
2 # is_ipv4_address.rb
3 #
4 module Puppet::Parser::Functions
5   newfunction(:is_ipv4_address, :type => :rvalue, :doc => <<-DOC
6     Returns true if the string passed to this function is a valid IPv4 address.
7     DOC
8              ) do |arguments|
9
10     require 'ipaddr'
11
12     function_deprecation([:is_ipv4_address, 'This method is deprecated, please use the stdlib validate_legacy function,
13                             with Stdlib::Compat::Ipv4. There is further documentation for validate_legacy function in the README.'])
14
15     if arguments.size != 1
16       raise(Puppet::ParseError, "is_ipv4_address(): Wrong number of arguments given #{arguments.size} for 1")
17     end
18
19     begin
20       ip = IPAddr.new(arguments[0])
21     rescue ArgumentError
22       return false
23     end
24
25     return ip.ipv4?
26   end
27 end
28
29 # vim: set ts=2 sw=2 et :