13426423435

Committed 20 Feb 2025 02:18AM UTC coverage: 4.826%. Remained the same
Build # 13426423435
Build Type
push
github
Committed by
Commit Message
Coverage Stats
18 of 373 relevant lines covered (4.83%)
0.56 hits per line
Source File
Press 'n' to go to next uncovered line, 'b' for previous

4.83
/lib/Geo/Coder/List.pm
package Geo::Coder::List;

use 5.10.1;

use warnings;
use strict;
use Carp;
use HTML::Entities;
use Params::Get 0.04;
use Object::Configure 0.13;
use Time::HiRes;
use Scalar::Util;

use constant DEBUG => 0;        # Default debugging level

# TODO: investigate Geo, Coder::ArcGIS
# TODO: return a Geo::Location::Point object all the time

=head1 NAME

Geo::Coder::List - Call many Geo-Coders

=head1 VERSION

Version 0.36

=cut

our $VERSION = '0.36';

=head1 SYNOPSIS

L<Geo::Coder::All>
and
L<Geo::Coder::Many>
are great routines but neither quite does what I want.

C<Geo::Coder::List> is designed to simplify geocoding tasks by aggregating multiple geocoding services into a single, unified interface.
It allows developers to chain and prioritize various geocoding backends (such as Google Places, OpenStreetMap, and GeoNames)
based on specific conditions,
such as location or usage limits.
The module features built-in caching mechanisms to optimize performance and reduce redundant API calls,
while also normalizing responses from different providers into a consistent format for easier integration with mapping systems such as L<HTML::OSM> and <L<HTML::GoogleMaps::V3>.

=head1 SUBROUTINES/METHODS

=head2 new

Creates a C<Geo::Coder::List> object.

Takes an optional argument C<cache> which is a reference to a HASH or an object that supports C<get()> and C<set()> methods.
The licences of some geo coders,
such as Google,
specifically prohibit caching API calls,
so be careful to only use those services that allow it.

Takes an optional argument C<debug>,
the higher the number,
the more debugging.

    use Geo::Coder::List;
    use CHI;

    my $geocoder->new(cache => CHI->new(driver => 'Memory', global => 1));

The class can be configured at runtime using environments and configuration files,
for example,
setting C<$ENV{'GEO__CODER__LIST__carp_on_warn'}> causes warnings to use L<Carp>.
For more information about configuring object constructors at runtime,
see L<Object::Configure>.

=cut

sub new
{
        my $class = shift;
        my $params = Params::Get::get_params(undef, @_) || {};

        if(!defined($class)) {
                if((scalar keys %{$params}) > 0) {
                        # Using Geo::Coder::List::new(), not Geo::Coder::List->new()
                        carp(__PACKAGE__, ' use ->new() not ::new() to instantiate');
                        return;
                }

                # FIXME: this only works when no arguments are given
                $class = __PACKAGE__;
        } elsif(Scalar::Util::blessed($class)) {
                # If $class is an object, clone it with new arguments
                return bless { %{$class}, %{$params} }, ref($class);
        }

        $params = Object::Configure::configure($class, $params);

        # Return the blessed object
        # Locations is an L1 cache that is always used
        return bless { debug => DEBUG, locations => {}, geocoders => [], log => [], %{$params} }, $class;
}

=head2 push($self, $geocoder)

Add an encoder to the list of encoders.

    use Geo::Coder::List;
    use Geo::Coder::GooglePlaces;
    # ...
    my $list = Geo::Coder::List->new()->push(Geo::Coder::GooglePlaces->new());

Different encoders can be preferred for different locations.
For example, this code uses geocode.ca for Canada and US addresses,
and OpenStreetMap for other places:

    my $geo_coderlist = Geo::Coder::List->new()
        ->push({ regex => qr/(Canada|USA|United States)$/, geocoder => Geo::Coder::CA->new() })
        ->push(Geo::Coder::OSM->new());

    # Uses Geo::Coder::CA, and if that fails, uses Geo::Coder::OSM
    my $location = $geo_coderlist->geocode(location => '1600 Pennsylvania Ave NW, Washington DC, USA');
    # Only uses Geo::Coder::OSM
    if($location = $geo_coderlist->geocode('10 Downing St, London, UK')) {
        print 'The prime minister lives at co-ordinates ',
            $location->{geometry}{location}{lat}, ',',
            $location->{geometry}{location}{lng}, "\n";
    }

    # It is also possible to limit the number of enquires used by a particular encoder
    $geo_coderlist->push({ geocoder => Geo::Coder::GooglePlaces->new(key => '1234', limit => 100) });

=head3 Parameters

=over 4

=item * C<$geocoder> hashref (required)

Hashref containing a regex and a geocoding object.

=back

=cut

sub push
{
        my($self, $geocoder) = @_;        # Don't use Params::Get or else the regex will be lost

        croak(__PACKAGE__, '::push: Usage: ($geocoder)') unless(defined($geocoder));

        push @{$self->{geocoders}}, $geocoder;

        return $self;
}

=head2 geocode

Runs geocode on all of the loaded drivers.
See L<Geo::Coder::GooglePlaces::V3> for an explanation.

The name of the Geo-Coder that gave the result is put into the geocode element of the
return value,
if the value was retrieved from the cache the value will be undefined.

    if(defined($location->{'geocoder'})) {
        print 'Location information retrieved using ', $location->{'geocoder'}, "\n";
    }

=cut

sub geocode {
        my $self = shift;
        my $params = Params::Get::get_params('location', @_);

        my $location = $params->{'location'};

        if((!defined($location)) || (length($location) == 0)) {
                Carp::carp(__PACKAGE__, ' usage: geocode(location => $location)');
                return;
        }

        # Fail when the input is just a set of numbers
        if($params->{'location'} !~ /\D/) {
                Carp::croak('Usage: ', __PACKAGE__, ": invalid input to geocode(), ", $params->{location});
                return;
        }

        $location =~ s/\s\s+/ /g;
        $location = decode_entities($location);
        print "location: $location\n" if($self->{'debug'});

        my @call_details = caller(0);
        if((!wantarray) && (my $rc = $self->_cache($location))) {
                if(ref($rc) eq 'ARRAY') {
                        $rc = $rc->[0];
                }
                if(ref($rc) eq 'HASH') {
                        $rc->{'geocoder'} = 'cache';
                        my $log = {
                                line => $call_details[2],
                                location => $location,
                                timetaken => 0,
                                gecoder => 'cache',
                                wantarray => 0,
                                result => $rc
                        };
                        CORE::push @{$self->{'log'}}, $log;
                        print __PACKAGE__, ': ', __LINE__,  ": cached\n" if($self->{'debug'});
                        return $rc;
                }
        }
        if(defined($self->_cache($location)) && (ref($self->_cache($location)) eq 'ARRAY') && (my @rc = @{$self->_cache($location)})) {
                if(scalar(@rc)) {
                        my $allempty = 1;
                        foreach (@rc) {
                                if(ref($_) eq 'HASH') {
                                        if(defined($_->{geometry}{location}{lat})) {
                                                $allempty = 0;
                                                $_->{'geocoder'} = 'cache';
                                        } else {
                                                delete $_->{'geometry'};
                                        }
                                } elsif(ref($_) eq 'Geo::Location::Point') {
                                        $allempty = 0;
                                        $_->{'geocoder'} = 'cache';
                                } else {
                                        print STDERR Data::Dumper->new([\@rc])->Dump();
                                        Carp::croak(ref($self), " '$location': unexpected item in the cache");
                                }
                        }
                        my $log = {
                                line => $call_details[2],
                                location => $location,
                                timetaken => 0,
                                gecoder => 'cache',
                                wantarray => wantarray,
                                result => \@rc
                        };
                        CORE::push @{$self->{'log'}}, $log;
                        print __PACKAGE__, ': ', __LINE__,  ": cached\n" if($self->{'debug'});
                        if($allempty) {
                                return;
                        }
                        return (wantarray) ? @rc : $rc[0];
                }
        }

        # my $error;

        ENCODER: foreach my $g(@{$self->{geocoders}}) {
                my $geocoder = $g;
                if(ref($geocoder) eq 'HASH') {
                        if(exists($geocoder->{'limit'}) && defined(my $limit = $geocoder->{'limit'})) {
                                print "limit: $limit\n" if($self->{'debug'});
                                if($limit <= 0) {
                                        next;
                                }
                                $geocoder->{'limit'}--;
                        }
                        if(my $regex = $geocoder->{'regex'}) {
                                print 'consider ', ref($geocoder->{geocoder}), ": $regex\n" if($self->{'debug'});
                                if($location !~ $regex) {
                                        next;
                                }
                        }
                        $geocoder = $g->{'geocoder'};
                }
                my @rc;
                my $timetaken = Time::HiRes::time();
                eval {
                        # e.g. over QUERY LIMIT with this one
                        # TODO: remove from the list of geocoders
                        print 'trying ', ref($geocoder), "\n" if($self->{'debug'});
                        if(ref($geocoder) eq 'Geo::GeoNames') {
                                print 'username => ', $geocoder->username(), "\n" if($self->{'debug'});
                                die 'lost username' if(!defined($geocoder->username()));
                                @rc = $geocoder->geocode($location);
                        } else {
                                @rc = $geocoder->geocode(%{$params});
                        }
                };
                if($@) {
                        my $log = {
                                line => $call_details[2],
                                location => $location,
                                geocoder => ref($geocoder),
                                timetaken => Time::HiRes::time() - $timetaken,
                                wantarray => wantarray,
                                error => $@
                        };
                        CORE::push @{$self->{'log'}}, $log;
                        Carp::carp(ref($geocoder), " '$location': $@");
                        # $error = $@;
                        next ENCODER;
                }
                $timetaken = Time::HiRes::time() - $timetaken;
                if((ref($geocoder) eq 'Geo::Coder::US::Census') &&
                   !(defined($rc[0]->{result}{addressMatches}[0]->{coordinates}{y}))) {
                           # Looks like Geo::Coder::US::Census sometimes says it's worked when it hasn't
                        my $log = {
                                line => $call_details[2],
                                location => $location,
                                timetaken => $timetaken,
                                geocoder => 'Geo::Coder::US::Census',
                                wantarray => wantarray,
                                result => 'not found',
                        };
                        CORE::push @{$self->{'log'}}, $log;
                        next ENCODER;
                }
                if((scalar(@rc) == 0) ||
                   ((ref($rc[0]) eq 'HASH') && (scalar(keys %{$rc[0]}) == 0)) ||
                   ((ref($rc[0]) eq 'ARRAY') && (scalar(keys %{$rc[0][0]}) == 0))) {
                        my $log = {
                                line => $call_details[2],
                                location => $location,
                                timetaken => $timetaken,
                                geocoder => ref($geocoder),
                                wantarray => wantarray,
                                result => 'not found',
                        };
                        CORE::push @{$self->{'log'}}, $log;
                        next ENCODER;
                }
                POSSIBLE_LOCATION: foreach my $l(@rc) {
                        if(ref($l) eq 'ARRAY') {
                                # Geo::GeoNames
                                # FIXME: should consider all locations in the array
                                $l = $l->[0];
                        }
                        if((!defined($l)) || ($l eq '')) {
                                my $log = {
                                        line => $call_details[2],
                                        location => $location,
                                        timetaken => $timetaken,
                                        geocoder => ref($geocoder),
                                        wantarray => wantarray,
                                        result => 'not found',
                                };
                                CORE::push @{$self->{'log'}}, $log;
                                next ENCODER;
                        }
                        $l->{'geocoder'} = ref($geocoder);
                        print ref($geocoder), ': ',
                                Data::Dumper->new([\$l])->Dump() if($self->{'debug'} >= 2);
                        last if(ref($l) eq 'Geo::Location::Point');
                        next if(ref($l) ne 'HASH');
                        if($l->{'error'}) {
                                my $log = {
                                        line => $call_details[2],
                                        location => $location,
                                        timetaken => $timetaken,
                                        geocoder => ref($geocoder),
                                        wantarray => wantarray,
                                        error => $l->{'error'}
                                };
                                CORE::push @{$self->{'log'}}, $log;
                                next ENCODER;
                        } else {
                                # Try to create a common interface, helps with HTML::GoogleMaps::V3
                                if(!defined($l->{geometry}{location}{lat})) {
                                        my ($lat, $long);
                                        if($l->{lat} && defined($l->{lon})) {
                                                # OSM/RandMcNalley
                                                # This would have been nice, but it doesn't compile
                                                # ($lat, $long) = $l->{'lat', 'lon'};
                                                $lat = $l->{lat};
                                                $long = $l->{lon};
                                                $l->{'debug'} = __LINE__;
                                        } elsif($l->{BestLocation}) {
                                                # Bing
                                                $lat = $l->{BestLocation}->{Coordinates}->{Latitude};
                                                $long = $l->{BestLocation}->{Coordinates}->{Longitude};
                                                $l->{'debug'} = __LINE__;
                                        } elsif($l->{point}) {
                                                # Bing
                                                $lat = $l->{point}->{coordinates}[0];
                                                $long = $l->{point}->{coordinates}[1];
                                                $l->{'debug'} = __LINE__;
                                        } elsif($l->{latt}) {
                                                # geocoder.ca
                                                $lat = $l->{latt};
                                                $long = $l->{longt};
                                                $l->{'debug'} = __LINE__;
                                        } elsif($l->{latitude}) {
                                                # postcodes.io
                                                # Geo::Coder::Free
                                                $lat = $l->{latitude};
                                                $long = $l->{longitude};
                                                if(my $type = $l->{'local_type'}) {
                                                        $l->{'type'} = lcfirst($type);        # e.g. village
                                                }
                                                $l->{'debug'} = __LINE__;
                                        } elsif($l->{'properties'}{'geoLatitude'}) {
                                                # ovi
                                                $lat = $l->{properties}{geoLatitude};
                                                $long = $l->{properties}{geoLongitude};
                                                $l->{'debug'} = __LINE__;
                                        } elsif($l->{'results'}[0]->{'geometry'}) {
                                                if($l->{'results'}[0]->{'geometry'}->{'location'}) {
                                                        # DataScienceToolkit
                                                        $lat = $l->{'results'}[0]->{'geometry'}->{'location'}->{'lat'};
                                                        $long = $l->{'results'}[0]->{'geometry'}->{'location'}->{'lng'};
                                                        $l->{'debug'} = __LINE__;
                                                } else {
                                                        # OpenCage
                                                        $lat = $l->{'results'}[0]->{'geometry'}->{'lat'};
                                                        $long = $l->{'results'}[0]->{'geometry'}->{'lng'};
                                                        $l->{'debug'} = __LINE__;
                                                }
                                        } elsif($l->{'RESULTS'}) {
                                                # GeoCodeFarm
                                                $lat = $l->{'RESULTS'}[0]{'COORDINATES'}{'latitude'};
                                                $long = $l->{'RESULTS'}[0]{'COORDINATES'}{'longitude'};
                                                $l->{'debug'} = __LINE__;
                                        } elsif(defined($l->{result}{addressMatches}[0]->{coordinates}{y})) {
                                                # US Census
                                                # This would have been nice, but it doesn't compile
                                                # ($lat, $long) = $l->{result}{addressMatches}[0]->{coordinates}{y, x};
                                                $lat = $l->{result}{addressMatches}[0]->{coordinates}{y};
                                                $long = $l->{result}{addressMatches}[0]->{coordinates}{x};
                                                $l->{'debug'} = __LINE__;
                                        } elsif($l->{lat}) {
                                                # Geo::GeoNames
                                                $lat = $l->{lat};
                                                $long = $l->{lng};
                                                $l->{'debug'} = __LINE__;
                                        } elsif($l->{features}) {
                                                if($l->{features}[0]->{center}) {
                                                        # Geo::Coder::Mapbox
                                                        $lat = $l->{features}[0]->{center}[1];
                                                        $long = $l->{features}[0]->{center}[0];
                                                        $l->{'debug'} = __LINE__;
                                                } elsif($l->{'features'}[0]{'geometry'}{'coordinates'}) {
                                                        # Geo::Coder::GeoApify
                                                        $lat = $l->{'features'}[0]{'geometry'}{'coordinates'}[1];
                                                        $long = $l->{'features'}[0]{'geometry'}{'coordinates'}[0];
                                                        $l->{'debug'} = __LINE__;
                                                } else {
                                                        # GeoApify doesn't give an error if a location is not found
                                                        next ENCODER;
                                                }
                                        } else {
                                                $l->{'debug'} = __LINE__;
                                        }

                                        if(defined($lat) && defined($long)) {
                                                $l->{geometry}{location}{lat} = $lat;
                                                $l->{geometry}{location}{lng} = $long;
                                                # Compatibility
                                                $l->{'lat'} = $lat;
                                                $l->{'lon'} = $long;
                                        } else {
                                                delete $l->{'geometry'};
                                                delete $l->{'lat'};
                                                delete $l->{'lon'};
                                        }

                                        if($l->{'standard'}{'countryname'}) {
                                                # geocoder.xyz
                                                $l->{'address'}{'country'} = $l->{'standard'}{'countryname'};
                                        }
                                }
                                if(defined($l->{geometry}{location}{lat})) {
                                        print $l->{geometry}{location}{lat}, '/', $l->{geometry}{location}{lng}, "\n" if($self->{'debug'});
                                        $l->{geocoder} = $geocoder;
                                        $l->{'lat'} //= $l->{geometry}{location}{lat};
                                        $l->{'lng'} //= $l->{geometry}{location}{lng};
                                        $l->{'lon'} //= $l->{geometry}{location}{lng};
                                        my $log = {
                                                line => $call_details[2],
                                                location => $location,
                                                timetaken => $timetaken,
                                                geocoder => ref($geocoder),
                                                wantarray => wantarray,
                                                result => $l
                                        };
                                        CORE::push @{$self->{'log'}}, $log;
                                        last POSSIBLE_LOCATION;
                                }
                        }
                }

                if(scalar(@rc)) {
                        print 'Number of matches from ', ref($geocoder), ': ', scalar(@rc), "\n" if($self->{'debug'});
                        $Data::Dumper::Maxdepth = 10;
                        print Data::Dumper->new([\@rc])->Dump() if($self->{'debug'} >= 2);
                        if(defined($rc[0])) {        # check it's not an empty hash
                                if(defined($rc[0]->{'long'}) && !defined($rc[0]->{'lng'})) {
                                        $rc[0]->{'lng'} = $rc[0]->{'long'};
                                }
                                if(defined($rc[0]->{'long'}) && !defined($rc[0]->{'lon'})) {
                                        $rc[0]->{'lon'} = $rc[0]->{'long'};
                                }
                                if((!defined($rc[0]->{lat})) || (!defined($rc[0]->{lng}))) {
                                        # ::diag(Data::Dumper->new([\@rc])->Dump());
                                        warn Data::Dumper->new([\@rc])->Dump();
                                        Carp::croak("BUG: '$location': HASH exists but is not sensible");
                                }
                                if(wantarray) {
                                        $self->_cache($location, \@rc);
                                        return @rc;
                                }
                                $self->_cache($location, $rc[0]);
                                return $rc[0];
                        }
                }
        }
        # Can't do this because we need to return undef in this case
        # if($error) {
                # return { error => $error };
        # }
        print "No matches\n" if($self->{'debug'});
        if(wantarray) {
                $self->_cache($location, ());
                return ();
        }
        $self->_cache($location, undef);
}

=head2 ua($self, $ua)

Accessor method to set the UserAgent object used internally by each of the Geo-Coders.
You can call I<env_proxy>,
for example,
to set the proxy information from environment variables:

    my $geocoder_list = Geo::Coder::List->new();
    my $ua = LWP::UserAgent->new();
    $ua->env_proxy(1);
    $geocoder_list->ua($ua);

Note that unlike Geo::Coders,
there is no read method since that would be pointless.

=head3 Parameters

=over 4

=item * C<$ua> object (optional)

Useragent object.

=back

=cut

sub ua
{
        my($self, $ua) = @_;
        return unless $ua;

        foreach my $g(@{$self->{geocoders}}) {
                my $geocoder = (ref($g) eq 'HASH') ? $g->{geocoder} : $g;
                Carp::croak('No geocoder found') unless defined $geocoder;
                $geocoder->ua($ua);
        }

        return $ua;
}

=head2 reverse_geocode

Similar to geocode except it expects a latitude/longitude parameter.

    print $geocoder_list->reverse_geocode(latlng => '37.778907,-122.39732');

=head3 API SPECIFICATION

=head4 INPUT

  {
    latlng => {
      type => 'string',
      matches => qr/^\s*([-+]?(?:\d*\.?\d+|\d+\.?\d*))\s*,\s*([-+]?(?:\d*\.?\d+|\d+\.?\d*))\s*$/        # Two numbers separated by a comma
  }

=head4 OUTPUT

  {
    type => 'string'
  }

=cut

sub reverse_geocode {
        my $self = shift;
        my $params = Params::Get::get_params('latlng', @_);

        my $latlng = $params->{'latlng'}
                or Carp::croak('Usage: reverse_geocode(latlng => $location)');

        my ($latitude, $longitude);
        if($latlng) {
                ($latitude, $longitude) = split(/,/, $latlng);
                $params->{'lat'} //= $latitude;
                $params->{'lon'} //= $longitude;
        } else {
                $latitude //= $params->{'lat'};
                $longitude //= $params->{'lon'};
                $longitude //= $params->{'long'};
                $latlng = $params->{'latlng'} = "$latitude,$longitude";
        }

        if(my $rc = $self->_cache($latlng)) {
                return $rc;
        }

        foreach my $g(@{$self->{geocoders}}) {
                my $geocoder = $g;
                if(ref($geocoder) eq 'HASH') {
                        if(exists($geocoder->{'limit'}) && defined(my $limit = $geocoder->{'limit'})) {
                                print "limit: $limit\n" if($self->{'debug'});
                                if($limit <= 0) {
                                        next;
                                }
                                $geocoder->{'limit'}--;
                        }
                        $geocoder = $g->{'geocoder'};
                }
                print 'trying ', ref($geocoder), "\n" if($self->{'debug'});
                if(wantarray) {
                        my @rc;
                        if(my @locs = $geocoder->reverse_geocode(%{$params})) {
                                print Data::Dumper->new([\@locs])->Dump() if($self->{'debug'} >= 2);
                                foreach my $loc(@locs) {
                                        if(my $name = $loc->{'display_name'}) {
                                                # OSM
                                                CORE::push @rc, $name;
                                        } elsif($loc->{'city'}) {
                                                # Geo::Coder::CA
                                                my $name;
                                                if(my $usa = $loc->{'usa'}) {
                                                        $name = $usa->{'usstnumber'};
                                                        if(my $staddress = $usa->{'usstaddress'}) {
                                                                $name .= ' ' if($name);
                                                                $name .= $staddress;
                                                        }
                                                        if(my $city = $usa->{'uscity'}) {
                                                                $name .= ', ' if($name);
                                                                $name .= $city;
                                                        }
                                                        if(my $state = $usa->{'state'}) {
                                                                $name .= ', ' if($name);
                                                                $name .= $state;
                                                        }
                                                        $name .= ', ' if($name);
                                                        $name .= 'USA';
                                                } else {
                                                        $name = $loc->{'stnumber'};
                                                        if(my $staddress = $loc->{'staddress'}) {
                                                                $name .= ' ' if($name);
                                                                $name .= $staddress;
                                                        }
                                                        if(my $city = $loc->{'city'}) {
                                                                $name .= ', ' if($name);
                                                                $name .= $city;
                                                        }
                                                        if(my $state = $loc->{'prov'}) {
                                                                $state .= ', ' if($name);
                                                                $name .= $state;
                                                        }
                                                }
                                                CORE::push @rc, $name;
                                        } elsif($loc->{features}) {
                                                # Geo::Coder::Apify
                                                return CORE::push @rc, $loc->{features}[0]->{properties}{formatted};
                                        }
                                }
                        }
                        $self->_cache($latlng, \@rc);
                        return @rc;
                } elsif(my $rc = $self->_cache($latlng) // $geocoder->reverse_geocode(%{$params})) {
                        return $rc if(!ref($rc));
                        print Data::Dumper->new([$rc])->Dump() if($self->{'debug'} >= 2);
                        if(my $name = $rc->{'display_name'}) {
                                # OSM
                                return $self->_cache($latlng, $name);
                        }
                        if($rc->{'city'}) {
                                # Geo::Coder::CA
                                my $name;
                                if(my $usa = $rc->{'usa'}) {
                                        # TODO: Use Lingua::Conjunction
                                        $name = $usa->{'usstnumber'};
                                        if(my $staddress = $usa->{'usstaddress'}) {
                                                $name .= ' ' if($name);
                                                $name .= $staddress;
                                        }
                                        if(my $city = $usa->{'uscity'}) {
                                                $name .= ', ' if($name);
                                                $name .= $city;
                                        }
                                        if(my $state = $usa->{'state'}) {
                                                $name .= ', ' if($name);
                                                $name .= $state;
                                        }
                                        return $self->_cache($latlng, "$name, USA");
                                } else {
                                        # TODO: Use Lingua::Conjunction
                                        $name = $rc->{'stnumber'};
                                        if(my $staddress = $rc->{'staddress'}) {
                                                $name .= ' ' if($name);
                                                $name .= $staddress;
                                        }
                                        if(my $city = $rc->{'city'}) {
                                                $name .= ', ' if($name);
                                                $name .= $city;
                                        }
                                        if(my $state = $rc->{'prov'}) {
                                                $state = ", $state" if($name);
                                                return $self->_cache($latlng, "$name $state");
                                        }
                                }
                                return $self->_cache($latlng, $name);
                        }
                        if($rc->{features}) {
                                # Geo::Coder::Apify
                                return $self->_cache($latlng, $rc->{features}[0]->{properties}{formatted});
                        }
                }
        }
        return;
}

=head2 log

Returns an arrayref of the log of events.

    my @log = @{$geocoderlist->log()};

=head3 API SPECIFICATION

=head4 INPUT

None.

=head4 OUTPUT

  {
    type => 'arrayref'
  }

=cut

sub log {
        my $self = shift;

        return $self->{'log'};
}

=head2 flush

Clear the log.

=cut

sub flush {
        my $self = shift;

        delete $self->{'log'};
}

sub _cache {
        my $self = shift;
        my $key = shift;

        if(my $value = shift) {
                # Put something into the cache
                $self->{locations}->{$key} = $value;
                my $rc = $value;
                if($self->{'cache'}) {
                        my $duration;
                        if(ref($value) eq 'ARRAY') {
                                foreach my $item(@{$value}) {
                                        if(ref($item) eq 'HASH') {
                                                $item->{'geocoder'} = ref($item->{'geocoder'});        # It's an object, not the name
                                                if(!$self->{'debug'}) {
                                                        while(my($k, $v) = each %{$item}) {
                                                                delete $item->{$k} unless($k eq 'geometry');
                                                        }
                                                }
                                                if(!defined($item->{geometry}{location}{lat})) {
                                                        if(defined($item->{geometry})) {
                                                                # Maybe a temporary lookup failure,
                                                                # so do a research tomorrow
                                                                $duration = '1 day';
                                                        } else {
                                                                # Probably the place doesn't exist
                                                                $duration = '1 week';
                                                        }
                                                        $rc = undef;
                                                }
                                        }
                                }
                                if(!defined($duration)) {
                                        # Has matched - it won't move
                                        $duration = '1 month';
                                }
                        } elsif(ref($value) eq 'HASH') {
                                $value->{'geocoder'} = ref($value->{'geocoder'});        # It's an object, not the name
                                if(!$self->{'debug'}) {
                                        while(my($k, $v) = each %{$value}) {
                                                delete $value->{$k} unless ($k eq 'geometry');
                                        }
                                }
                                if(defined($value->{geometry}{location}{lat})) {
                                        $duration = '1 month';        # It won't move :-)
                                } elsif(defined($value->{geometry})) {
                                        # Maybe a temporary lookup failure, so do a research
                                        # tomorrow
                                        $duration = '1 day';
                                        $rc = undef;
                                } else {
                                        # Probably the place doesn't exist
                                        $duration = '1 week';
                                        $rc = undef;
                                }
                        } else {
                                $duration = '1 month';
                        }
                        print Data::Dumper->new([$value])->Dump() if($self->{'debug'});
                        if(ref($self->{'cache'}) eq 'HASH') {
                                $self->{'cache'}->{$key} = $value;
                        } elsif(!ref($value)) {
                                $self->{'cache'}->set($key, $value, $duration);
                        }
                }
                return $rc;
        }

        # Retrieve from the cache
        my $rc = $self->{'locations'}->{$key};        # In the L1 cache?
        if((!defined($rc)) && $self->{'cache'}) {        # In the L2 cache?
                if(ref($self->{'cache'}) eq 'HASH') {
                        $rc = $self->{'cache'}->{$key};
                } else {
                        $rc = $self->{'cache'}->get($key);
                }
        }
        if(defined($rc)) {
                if(ref($rc) eq 'HASH') {        # else - it will be an array of hashes
                        if(!defined($rc->{geometry}{location}{lat})) {
                                return;
                        }
                        $rc->{'lat'} //= $rc->{geometry}{location}{lat};
                        $rc->{'lng'} //= $rc->{geometry}{location}{lng};
                        $rc->{'lon'} //= $rc->{geometry}{location}{lng};
                }
        }
        return $rc;
}

=head1 AUTHOR

Nigel Horne, C<< <njh at nigelhorne.com> >>

=head1 BUGS

Please report any bugs or feature requests to C<bug-geo-coder-list at rt.cpan.org>,
or through the web interface at
L<https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Geo-Coder-List>.
I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

reverse_geocode() doesn't update the logger.
reverse_geocode() should support L<Geo::Location::Point> objects.

=head1 SEE ALSO

=over 4

=item * L<Test Dashboard|https://nigelhorne.github.io/Geo-Coder-List/coverage/>

=item * L<Geo::Coder::All>

=item * L<Geo::Coder::GooglePlaces>

=item * L<Geo::Coder::Many>

=item * L<Object::Configure>

=back

=cut

=head1 SUPPORT

This module is provided as-is without any warranty.

You can find documentation for this module with the perldoc command.

    perldoc Geo::Coder::List

You can also look for information at:

=over 4

=item * RT: CPAN's request tracker

L<https://rt.cpan.org/NoAuth/Bugs.html?Dist=Geo-Coder-List>

=item * MetaCPAN

L<https://metacpan.org/release/Geo-Coder-List>

=back

=head1 LICENSE AND COPYRIGHT

Copyright 2016-2026 Nigel Horne.

This program is released under the following licence: GPL2

=cut

1;
nigelhorne / Geo-Coder-List / 13426423435

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous
