File Coverage

lib/Net/IPAddress/Filter.pm

Criterion	Covered	Total	%
statement	49	51	96.0
branch	12	18	66.6
condition	1	2	50.0
subroutine	11	11	100.0
pod	5	5	100.0
total	78	87	89.6

package Net::IPAddress::Filter;

use strict;
use warnings;

# ABSTRACT: A compact and fast IP Address range filter
our $VERSION = '20140113'; # VERSION


use Net::CIDR::Lite;
use Set::IntervalTree;    # XS module.

our $CIDR_REGEX = qr{/ \d+ \z}xms;


sub new {
    my $class = shift;

    my $self = { filter => Set::IntervalTree->new(), };

    return bless $self, $class;
}


sub add_range {
    my ( $self, $start_ip, $end_ip ) = @_;

    my ($start_num, $end_num) = _get_start_and_end_numbers($start_ip, $end_ip);

    # Different versions of Set::IntervalTree use different-closed intervals,
    # so need to allow for that.
    if ( $Set::IntervalTree::VERSION < 0.08 ) {
        $self->{filter}->insert($start_ip . ($end_ip ? ",$end_ip" : ''), $start_num - 1, $end_num + 1 );
    }
    else {
        $self->{filter}->insert($start_ip . ($end_ip ? ",$end_ip" : ''), $start_num, $end_num + 1 );
    }

    return 1;
}


sub add_range_with_value {
    my ( $self, $value, $start_ip, $end_ip ) = @_;

    my ($start_num, $end_num) = _get_start_and_end_numbers($start_ip, $end_ip);

    # Different versions of Set::IntervalTree use different-closed intervals,
    # so need to allow for that.
    if ( $Set::IntervalTree::VERSION < 0.08 ) {
        $self->{filter}->insert( $value, $start_num - 1, $end_num + 1 );
    }
    else {
        $self->{filter}->insert( $value, $start_num, $end_num + 1 );
    }

    return 1;
}


sub in_filter {
    my ( $self, $test_ip ) = @_;

    my $test_num = _ip_address_to_number($test_ip);
    my $end_num  = $Set::IntervalTree::VERSION < 0.08 ? $test_num : $test_num + 1;

    my $found = $self->{filter}->fetch( $test_num, $end_num ) || return 0;

    return scalar @$found;
}


sub get_matches {
    my ( $self, $test_ip ) = @_;

    my $test_num = _ip_address_to_number($test_ip);
    my $end_num  = $Set::IntervalTree::VERSION < 0.08 ? $test_num : $test_num + 1;

    return $self->{filter}->fetch( $test_num, $end_num );

}


sub _get_start_and_end_numbers {
    my ( $start_ip, $end_ip ) = @_;

    my ($start_num, $end_num);

    if ( $start_ip =~ $CIDR_REGEX ) {
        my $cidr = Net::CIDR::Lite->new;
        $cidr->add($start_ip);
        my ( $start_cidr, $end_cidr ) = split /-/, @{ $cidr->list_range() }[0];
        $start_num = _ip_address_to_number($start_cidr);
        $end_num = _ip_address_to_number($end_cidr);
    }
    else {
        $start_num = _ip_address_to_number($start_ip);
        $end_num = $end_ip ? _ip_address_to_number($end_ip) : $start_num;
    }

    # Guarantee that the start <= end
    if ( $end_num < $start_num ) {
        ( $start_num, $end_num ) = ( $end_num, $start_num );
    }

    return ( $start_num, $end_num );
}


sub _ip_address_to_number {

    return unpack 'N', pack 'C4', split '\.', shift;
}

1;

__END__