File Coverage

blib/lib/Net/IPAddress/Minimal.pm

Criterion	Covered	Total	%
statement	45	45	100.0
branch	8	8	100.0
condition	2	2	100.0
subroutine	14	14	100.0
pod	4	4	100.0
total	73	73	100.0

use strict;
use warnings;
package Net::IPAddress::Minimal;
BEGIN {
  $Net::IPAddress::Minimal::VERSION = '0.05';
}
# ABSTRACT: IP string to number and back

use Data::Validate     'is_integer';
use Data::Validate::IP 'is_ipv4';
use base 'Exporter';

our @EXPORT_OK = qw( ip_to_num num_to_ip invert_ip );

sub test_string_structure {
    my $string = shift || q{};

    is_ipv4($string)    && return 'ip';
    is_integer($string) && return 'num';
    $string             || return 'empty';

    return 'err';
}

sub ip_to_num {
    # Converting between IP to number is according to this formula:
    # IP = A.B.C.D
    # IP Number = A x (256**3) + B x (256**2) + C x 256 + D
    my $ip = shift;

    my ( $Aclass, $Bclass, $Cclass, $Dclass ) = split /\./, $ip;

    my $num = (
        $Aclass * 256**3 +
        $Bclass * 256**2 +
        $Cclass * 256    +
        $Dclass
    );

    return $num;
}

sub num_to_ip {
    my $ipnum = shift;

    my $z = $ipnum % 256;
    $ipnum >>= 8;
    my $y = $ipnum % 256;
    $ipnum >>= 8;
    my $x = $ipnum % 256;
    $ipnum >>= 8;
    my $w = $ipnum % 256;

    my $ipstr = "$w.$x.$y.$z";

    return $ipstr;
}

sub invert_ip {
    my $input_str = shift;
    my $result    = test_string_structure($input_str);
    my %responses = (
        ip    => sub { ip_to_num($input_str) },
        num   => sub { num_to_ip($input_str) },
        err   => sub { 'Illegal string. Please use IPv4 strings or numbers.' },
        empty => sub { 'Empty string. Please use IPv4 strings or numbers.'   },
    );
    # This is a dispatch table, instead of a big ugly if block / switch

    if ( exists $responses{$result} ) {
        return $responses{$result}->();
    }

    # If none of the above was executed
    die 'Could not convert IP string / number due to unknown error';
}

1;



=pod

=head1 NAME

Net::IPAddress::Minimal - IP string to number and back

=head1 VERSION

version 0.05

=head1 SYNOPSIS

This module converts IPv4 strings to integer IP numbers and vice versa.

It's built to be used as quickly and easily as possible, which is why you can
just simply use the C function.

It recognizes whether you have an IPv4 string or a number and converts it to the
other form.

Here's a sample script:

    use Net::IPAddress::Minimal ('invert_ip');

    my $input_string = shift @ARGV;
    my $output       = invert_ip( $input_string );

    print "$output\n";

=head1 EXPORT

Three functions can be exported:

=over 4

=item * invert_ip

=item * num_to_ip

=item * ip_to_num

=back

=head1 SUBROUTINES/METHODS

=head2 invert_ip

Gets an IPv4 string or an IP number and converts it to the other form.

    my $ip_num = invert_ip( '10.200.10.130' );
    #  $ip_str = 180882050

    my $ip_num = invert_ip( 180882050 );
    #  $ip_str = '10.200.10.130';

=head2 num_to_ip

Gets an IP number and returns an IPv4 string.

    my $ip_num = num_to_ip( 3232235778 );
    #  $ip_str = '192.168.1.2';

=head2 ip_to_num

Gets a IPv4 string and returns the matching IP number.

    my $ip_num = ip_to_num( '212.212.212.212' );
    #  $ip_num = 3570717908

=head2 test_string_structure

Checks the structure of the input string and returns flags indicating whether
it's an IPv4 string, and IP number or something else (which is an error).

=head1 BUGS

We encourage you to open bugs on the Github Issues page:

L.

=head1 AUTHORS

  Tamir Lousky
  Sawyer X

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Tamir Lousky.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut


__END__