X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fgeocode_Mixin.pm;h=2b4304571ddffc71d1d1874ad9f41d9203261073;hp=09b1131124b8755c3e446aea7fbe407f5d870a84;hb=5372897f367498972c96f5494e142e6e11b29eb8;hpb=6a4b5b3bf9b3e589cf8ff18453e9c6be6a50091a diff --git a/FS/FS/geocode_Mixin.pm b/FS/FS/geocode_Mixin.pm index 09b113112..2b4304571 100644 --- a/FS/FS/geocode_Mixin.pm +++ b/FS/FS/geocode_Mixin.pm @@ -3,14 +3,18 @@ package FS::geocode_Mixin; use strict; use vars qw( $DEBUG $me ); use Carp; +use Cpanel::JSON::XS; +use Data::Dumper; use Locale::Country (); -use Geo::Coder::Googlev3; #compile time for now, until others are supported +use LWP::UserAgent; +use URI::Escape; use FS::Record qw( qsearchs qsearch ); use FS::Conf; use FS::cust_pkg; use FS::cust_location; use FS::cust_tax_location; use FS::part_pkg; +use FS::part_pkg_taxclass; $DEBUG = 0; $me = '[FS::geocode_Mixin]'; @@ -162,31 +166,66 @@ API and set the 'latitude' and 'longitude' fields accordingly. sub set_coord { my $self = shift; - #my $module = FS::Conf->new->config('geocode_module') || 'Geo::Coder::Googlev3'; - - my $geocoder = Geo::Coder::Googlev3->new; - - my $location = eval { - $geocoder->geocode( location => - $self->get('address1'). ','. - ( $self->get('address2') ? $self->get('address2').',' : '' ). - $self->get('city'). ','. - $self->get('state'). ','. - $self->country_full - ); - }; - if ( $@ ) { - warn "geocoding error: $@\n"; + # Google documetnation: + # https://developers.google.com/maps/documentation/geocoding/start + + + my $api_key = FS::Conf->new->config('google_maps_api_key'); + + unless ( $api_key ) { + # Google API now requires a valid key with a payment method attached + warn 'Geocoding unavailable, install a google_maps_api_key'; return; } - my $geo_loc = $location->{'geometry'}{'location'} or return; - if ( $geo_loc->{'lat'} && $geo_loc->{'lng'} ) { - $self->set('latitude', $geo_loc->{'lat'} ); - $self->set('longitude', $geo_loc->{'lng'} ); - $self->set('coord_auto', 'Y'); + my $google_api_url = 'https://maps.googleapis.com/maps/api/geocode/json'; + + my $address = + join ',', + map { $self->get( $_ ) ? uri_escape( $self->get( $_ ) ) : () } + qw( address1 address2 city state zip country_full ); + + my $query_url = sprintf + '%s?address=%s&key=%s', + $google_api_url, $address, $api_key; + + my $ua = LWP::UserAgent->new; + $ua->timeout(10); + my $res = $ua->get( $query_url ); + my $json_res = decode_json( $res->decoded_content ); + my $json_error = $json_res->{error_message} + if ref $json_res && $json_res->{error_message}; + + if ( $DEBUG ) { + warn "\$query_url: $query_url\n"; + warn "\$json_error: $json_error\n"; + warn Dumper( $json_res || $res->decoded_content )."\n"; } + if ( !$res->is_success || $json_error ) { + warn "Error using google GeoCoding API"; + warn Dumper( $json_res || $res->decoded_content ); + return; + } + + if ( + ref $json_res + && ref $json_res->{results} + && ref $json_res->{results}->[0] + && ref $json_res->{results}->[0]->{geometry} + && ref $json_res->{results}->[0]->{geometry}->{location} + ) { + my $location = $json_res->{results}->[0]->{geometry}->{location}; + if ( $location->{lat} && $location->{lng} ) { + $self->set( latitude => $location->{lat} ); + $self->set( longitude => $location->{lng} ); + $self->set( coord_auto => 'Y' ); + } + } else { + # If google changes the API response structure, warnings abound + warn "No location match found using google GeoCoding API for $address"; + warn Dumper( $json_res || $res->decoded_content ); + } } =item geocode DATA_VENDOR @@ -253,82 +292,98 @@ Queueable function to update the tax district code using the selected method sub process_district_update { my $class = shift; my $id = shift; - - local $DEBUG = 1; + my $log = FS::Log->new('FS::cust_location::process_district_update'); eval "use FS::Misc::Geo qw(get_district); use FS::Conf; use $class;"; die $@ if $@; die "$class has no location data" if !$class->can('location_hash'); + my $error; my $conf = FS::Conf->new; my $method = $conf->config('tax_district_method') or return; #nothing to do if null my $self = $class->by_key($id) or die "object $id not found"; + return if $self->disabled; # dies on error, fine my $tax_info = get_district({ $self->location_hash }, $method); - - if ( $tax_info ) { + return unless $tax_info; + + if ($self->district ne $tax_info->{'district'}) { $self->set('district', $tax_info->{'district'} ); - my $error = $self->replace; + $error = $self->replace; die $error if $error; + } - my %hash = map { $_ => uc( $tax_info->{$_} ) } - qw( district city county state country ); - $hash{'source'} = $method; # apply the update only to taxes we maintain - - my @old = qsearch('cust_main_county', \%hash); - if ( @old ) { - # prune any duplicates rather than updating them - my %keep; # key => cust_main_county record - foreach my $cust_main_county (@old) { - my $key = join('.', $cust_main_county->city , - $cust_main_county->district , - $cust_main_county->taxclass - ); - if ( exists $keep{$key} ) { - my $disable_this = $cust_main_county; - # prefer records that have a tax name - if ( $cust_main_county->taxname and not $keep{$key}->taxname ) { - $disable_this = $keep{$key}; - $keep{$key} = $cust_main_county; - } - # disable by setting the rate to zero, and setting source to null - # so it doesn't get auto-updated in the future. don't actually - # delete it, that produces orphan records - warn "disabling tax rate #" . - $disable_this->taxnum . - " because it's a duplicate for $key\n" - if $DEBUG; - # by setting its rate to zero, and never updating - # it again - $disable_this->set('tax' => 0); - $disable_this->set('source' => ''); - $error = $disable_this->replace; - die $error if $error; - } + my %hash = map { $_ => uc( $tax_info->{$_} ) } + qw( district city county state country ); + $hash{'source'} = $method; # apply the update only to taxes we maintain + + my @classes = FS::part_pkg_taxclass->taxclass_names; + my $taxname = $conf->config('tax_district_taxname'); + # there must be exactly one cust_main_county for each district+taxclass. + # do NOT exclude taxes that are zero. + + # mutex here so that concurrent queue jobs can't make duplicates. + FS::cust_main_county->lock_table; + foreach my $taxclass (@classes) { + my @existing = qsearch('cust_main_county', { + %hash, + 'taxclass' => $taxclass + }); + + if ( scalar(@existing) == 0 ) { + + # then create one with the assigned tax name, and the tax rate from + # the lookup. + my $new = new FS::cust_main_county({ + %hash, + 'taxclass' => $taxclass, + 'taxname' => $taxname, + 'tax' => $tax_info->{tax}, + 'exempt_amount' => 0, + }); + $log->info("creating tax rate for district ".$tax_info->{'district'}); + $error = $new->insert; - $keep{$key} ||= $cust_main_county; + } else { + my $to_update = $existing[0]; + # if there's somehow more than one, find the best candidate to be + # updated: + # - prefer tax > 0 over tax = 0 (leave disabled records disabled) + # - then, prefer taxname = the designated taxname + if ( scalar(@existing) > 1 ) { + $log->warning("tax district ".$tax_info->{district}." has multiple $method taxes."); + foreach (@existing) { + if ( $to_update->tax == 0 ) { + if ( $_->tax > 0 and $to_update->tax == 0 ) { + $to_update = $_; + } elsif ( $_->tax == 0 and $to_update->tax > 0 ) { + next; + } elsif ( $_->taxname eq $taxname and $to_update->tax ne $taxname ) { + $to_update = $_; + } + } + } + # don't remove the excess records here; upgrade does that. } - foreach my $key (keys %keep) { - my $cust_main_county = $keep{$key}; - warn "updating tax rate #".$cust_main_county->taxnum. - " for $key" if $DEBUG; - # update the tax rate only - $cust_main_county->set('tax', $tax_info->{'tax'}); - $error ||= $cust_main_county->replace; + my $taxnum = $to_update->taxnum; + if ( $to_update->tax == 0 ) { + $log->debug("tax#$taxnum is set to zero; not updating."); + } elsif ( $to_update->tax == $tax_info->{tax} ) { + # do nothing, no need to update + } else { + $to_update->set('tax', $tax_info->{tax}); + $log->info("updating tax#$taxnum with new rate ($tax_info->{tax})."); + $error = $to_update->replace; } - } else { - # make a new tax record, and mark it so we can find it later - $tax_info->{'source'} = $method; - my $new = new FS::cust_main_county $tax_info; - warn "creating tax rate for district ".$tax_info->{'district'} if $DEBUG; - $error = $new->insert; } + die $error if $error; - } + } # foreach $taxclass + return; }