File Coverage

blib/lib/Mail/MtPolicyd/Plugin/GeoIPLookup.pm

Criterion	Covered	Total	%
statement	12	20	60.0
branch	0	2	0.0
condition			n/a
subroutine	4	6	66.6
pod	1	1	100.0
total	17	29	58.6

package Mail::MtPolicyd::Plugin::GeoIPLookup;

use Moose;
use namespace::autoclean;

our $VERSION = '1.23'; # VERSION
# ABSTRACT: mtpolicyd plugin for checking geo information of an client_address

extends 'Mail::MtPolicyd::Plugin';

use Mail::MtPolicyd::Plugin::Result;

use Geo::IP;


has '_geoip' => (
	is => 'ro', isa => 'Geo::IP', lazy => 1,
	default => sub {
		my $self = shift;
		Geo::IP->open( $self->database, GEOIP_STANDARD );
	},
);

has 'database' => ( is => 'rw', isa => 'Str', default => '/usr/share/GeoIP/GeoIP.dat');

sub run {
	my ( $self, $r ) = @_;
	my $ip = $r->attr('client_address');
	my $session = $r->session;

	my ( $result ) = $r->do_cached('geoip-'.$self->name.'-result',
		sub { $self->_geoip->country_code_by_addr( $ip ) } );

	if( ! defined $result ) {
		$self->log($r, 'no GeoIP record for '.$ip.' found');
	}

	return;
}

__PACKAGE__->meta->make_immutable;

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Mail::MtPolicyd::Plugin::GeoIPLookup - mtpolicyd plugin for checking geo information of an client_address

=head1 VERSION

version 1.23

=head1 DESCRIPTION

This plugin queries a GeoIP for the country code of the client_address.
The plugin is divided in this plugin which does the Lookup and the GeoIPAction
plugin which can be used to take actions based on country code.

=head1 PARAMETERS

=over

=item database (default: /usr/share/GeoIP/GeoIP.dat)

The path to the geoip country database.

=back

=head1 MAXMIND GEOIP COUNTRY DATABASE

On a debian system you can install the country database with the geoip-database package.

You also download it directly from Maxmind:

http://dev.maxmind.com/geoip/geoip2/geolite2/

(choose "GeoLite2 Country/DB")

=head1 AUTHOR

Markus Benning <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2014 by Markus Benning <[e-mail]>.

This is free software, licensed under:

  The GNU General Public License, Version 2, June 1991

=cut