add northern cyprus, RT#39335
[freeside.git] / FS / FS / geocode_Mixin.pm
index d784b57..0625b5a 100644 (file)
@@ -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
 
@@ -94,6 +96,26 @@ sub location_label {
       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->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";
 
-  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( {
@@ -147,9 +232,66 @@ 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
+
+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 { $_ => $tax_info->{$_} } 
+      qw( district city county state country );
+    $hash{'taxname'} = '';
+
+    my $old = qsearchs('cust_main_county', \%hash);
+    if ( $old ) {
+      my $new = new FS::cust_main_county { $old->hash, %$tax_info };
+      warn "updating tax rate for district ".$tax_info->{'district'} if $DEBUG;
+      $error = $new->replace($old);
+    }
+    else {
+      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