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


line stmt bran cond sub pod time code
1             package Mail::MtPolicyd::Plugin::GeoIPLookup;
2              
3 1     1   1605 use Moose;
  1         3  
  1         28  
4 1     1   6663 use namespace::autoclean;
  1         3  
  1         12  
5              
6             our $VERSION = '1.23'; # VERSION
7             # ABSTRACT: mtpolicyd plugin for checking geo information of an client_address
8              
9             extends 'Mail::MtPolicyd::Plugin';
10              
11 1     1   101 use Mail::MtPolicyd::Plugin::Result;
  1         3  
  1         26  
12              
13 1     1   1734 use Geo::IP;
  1         33989  
  1         484  
14              
15              
16             has '_geoip' => (
17             is => 'ro', isa => 'Geo::IP', lazy => 1,
18             default => sub {
19             my $self = shift;
20             Geo::IP->open( $self->database, GEOIP_STANDARD );
21             },
22             );
23              
24             has 'database' => ( is => 'rw', isa => 'Str', default => '/usr/share/GeoIP/GeoIP.dat');
25              
26             sub run {
27 0     0 1   my ( $self, $r ) = @_;
28 0           my $ip = $r->attr('client_address');
29 0           my $session = $r->session;
30              
31             my ( $result ) = $r->do_cached('geoip-'.$self->name.'-result',
32 0     0     sub { $self->_geoip->country_code_by_addr( $ip ) } );
  0            
33              
34 0 0         if( ! defined $result ) {
35 0           $self->log($r, 'no GeoIP record for '.$ip.' found');
36             }
37              
38 0           return;
39             }
40              
41             __PACKAGE__->meta->make_immutable;
42              
43             1;
44              
45             __END__
46              
47             =pod
48              
49             =encoding UTF-8
50              
51             =head1 NAME
52              
53             Mail::MtPolicyd::Plugin::GeoIPLookup - mtpolicyd plugin for checking geo information of an client_address
54              
55             =head1 VERSION
56              
57             version 1.23
58              
59             =head1 DESCRIPTION
60              
61             This plugin queries a GeoIP for the country code of the client_address.
62             The plugin is divided in this plugin which does the Lookup and the GeoIPAction
63             plugin which can be used to take actions based on country code.
64              
65             =head1 PARAMETERS
66              
67             =over
68              
69             =item database (default: /usr/share/GeoIP/GeoIP.dat)
70              
71             The path to the geoip country database.
72              
73             =back
74              
75             =head1 MAXMIND GEOIP COUNTRY DATABASE
76              
77             On a debian system you can install the country database with the geoip-database package.
78              
79             You also download it directly from Maxmind:
80              
81             http://dev.maxmind.com/geoip/geoip2/geolite2/
82              
83             (choose "GeoLite2 Country/DB")
84              
85             =head1 AUTHOR
86              
87             Markus Benning <ich@markusbenning.de>
88              
89             =head1 COPYRIGHT AND LICENSE
90              
91             This software is Copyright (c) 2014 by Markus Benning <ich@markusbenning.de>.
92              
93             This is free software, licensed under:
94              
95             The GNU General Public License, Version 2, June 1991
96              
97             =cut