X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fgeocode_Mixin.pm;h=09b1131124b8755c3e446aea7fbe407f5d870a84;hb=db5785cba180e2c210d3ab4d37064c7e61898614;hp=08e7b86197a9e6e923cd6c375b10a5dd23216a7d;hpb=c58774a70c3326ad2ba5a7a38b174dfbd76a9f78;p=freeside.git diff --git a/FS/FS/geocode_Mixin.pm b/FS/FS/geocode_Mixin.pm index 08e7b8619..09b113112 100644 --- a/FS/FS/geocode_Mixin.pm +++ b/FS/FS/geocode_Mixin.pm @@ -3,7 +3,8 @@ package FS::geocode_Mixin; use strict; use vars qw( $DEBUG $me ); use Carp; -use Locale::Country; +use Locale::Country (); +use Geo::Coder::Googlev3; #compile time for now, until others are supported use FS::Record qw( qsearchs qsearch ); use FS::Conf; use FS::cust_pkg; @@ -38,7 +39,8 @@ and other location fields. =item location_hash Returns a list of key/value pairs, with the following keys: address1, address2, -city, county, state, zip, country. The shipping address is used if present. +city, county, state, zip, country, geocode, location_type, location_number, +location_kind. The shipping address is used if present. =cut @@ -88,12 +90,32 @@ sub location_label { my $prefix = $self->has_ship_address ? 'ship_' : ''; my $notfirst = 0; - foreach (qw ( address1 address2 location_type location_number ) ) { + foreach (qw ( address1 address2 ) ) { my $method = "$prefix$_"; $line .= ($notfirst ? $separator : ''). &$escape($self->$method) if $self->$method; $notfirst++; } + + my $lt = $self->get($prefix.'location_type'); + if ( $lt ) { + my %location_type; + if ( 1 ) { #ikano, switch on via config + { no warnings 'void'; + eval { 'use FS::part_export::ikano;' }; + die $@ if $@; + } + %location_type = FS::part_export::ikano->location_types; + } else { + %location_type = (); #? + } + + $line .= ' '.&$escape( $location_type{$lt} || $lt ); + } + + $line .= ' '. &$escape($self->get($prefix.'location_number')) + if $self->get($prefix.'location_number'); + $notfirst = 0; foreach (qw ( city county state zip ) ) { my $method = "$prefix$_"; @@ -104,12 +126,69 @@ sub location_label { $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; + + #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"; + 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'); + } + +} + =item geocode DATA_VENDOR Returns a value for the customer location as encoded by DATA_VENDOR. @@ -123,18 +202,24 @@ sub geocode { 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"; + + # 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("${prefix}zip") + 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( { @@ -147,9 +232,106 @@ sub geocode { $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; + + local $DEBUG = 1; + + 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 $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"; + + # dies on error, fine + my $tax_info = get_district({ $self->location_hash }, $method); + + if ( $tax_info ) { + $self->set('district', $tax_info->{'district'} ); + my $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; + } + + $keep{$key} ||= $cust_main_county; + + } + 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; + } + } 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; + + } + return; +} + =back =head1 BUGS