use strict;
use vars qw( $DEBUG $me );
use Carp;
-use Locale::Country;
+use Cpanel::JSON::XS;
+use Data::Dumper;
+use Locale::Country ();
+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]';
$notfirst++;
}
}
- $line .= $separator. &$escape(code2country($self->country))
+ $line .= $separator. &$escape($self->country_full)
if $self->country ne $cydefault;
$line;
}
+=item country_full
+
+Returns the full country name.
+
+=cut
+
+sub country_full {
+ my $self = shift;
+ $self->code2country($self->get('country'));
+}
+
+sub code2country {
+ my( $self, $country ) = @_;
+
+ #a hash? not expecting an explosion of business from unrecognized countries..
+ return 'KKTC' if $country eq 'XC';
+
+ Locale::Country::code2country($country);
+}
+
+=item set_coord
+
+Look up the coordinates of the location using (currently) the Google Maps
+API and set the 'latitude' and 'longitude' fields accordingly.
+
+=cut
+
+sub set_coord {
+ my $self = shift;
+
+ # 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 $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
Returns a value for the customer location as encoded by DATA_VENDOR.
my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
return $geocode if $geocode;
- my $prefix =
- ( FS::Conf->new->exists('tax-ship_address') && $self->has_ship_address )
- ? 'ship_'
- : '';
+ if ( $self->isa('FS::cust_main') ) {
+ warn "WARNING: FS::cust_main->geocode deprecated";
- my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
+ # do the best we can
+ my $m = FS::Conf->new->exists('tax-ship_address') ? 'ship_location'
+ : 'bill_location';
+ my $location = $self->$m or return '';
+ return $location->geocode($data_vendor);
+ }
+
+ my($zip,$plus4) = split /-/, $self->get('zip')
if $self->country eq 'US';
$zip ||= '';
$plus4 ||= '';
#CCH specific location stuff
- my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
+ my $extra_sql = $plus4 ? "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'"
+ : '';
my @cust_tax_location =
qsearch( {
$geocode = $cust_tax_location[0]->geocode
if scalar(@cust_tax_location);
+ warn "WARNING: customer ". $self->custnum.
+ ": multiple locations for zip ". $self->get("zip").
+ "; using arbitrary geocode $geocode\n"
+ if scalar(@cust_tax_location) > 1;
+
$geocode;
}
+=item process_district_update CLASS ID
+
+Queueable function to update the tax district code using the selected method
+(config 'tax_district_method'). CLASS is either 'FS::cust_main' or
+'FS::cust_location'; ID is the key in one of those tables.
+
+=cut
+
+# this is run from the job queue so I'm not transactionizing it.
+
+sub process_district_update {
+ my $class = shift;
+ my $id = shift;
+ 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);
+ return unless $tax_info;
+
+ if ($self->district ne $tax_info->{'district'}) {
+ $self->set('district', $tax_info->{'district'} );
+ $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 @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;
+
+ } 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.
+ }
+ 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;
+ }
+ }
+
+ die $error if $error;
+
+ } # foreach $taxclass
+
+ return;
+}
+
=back
=head1 BUGS
projects / freeside.git / blobdiff