don't send zip+4 to vitelity e911, RT#76262
[freeside.git] / FS / FS / part_export / vitelity.pm
index 350a5ad..574592f 100644 (file)
@@ -1,37 +1,44 @@
 package FS::part_export::vitelity;
+use base qw( FS::part_export );
 
-use vars qw(@ISA %info);
+use strict;
+use vars qw( %info );
 use Tie::IxHash;
-use FS::Record qw(qsearch dbh);
-use FS::part_export;
+use Data::Dumper;
+use Geo::StreetAddress::US;
+use Net::Vitelity 0.05;
+use FS::Record qw( qsearch dbh );
 use FS::phone_avail;
-
-@ISA = qw(FS::part_export);
+use FS::svc_phone;
 
 tie my %options, 'Tie::IxHash',
-  'login'         => { label=>'Vitelity API login' },
-  'pass'          => { label=>'Vitelity API password' },
-  'dry_run'       => { label=>"Test mode - don't actually provision" },
-  'routesip'      => { label=>'routesip (optional sub-account)' },
-  'type'         => { label=>'type (optional DID type to order)' },
-  'fax'      => { label=>'vfax service', type=>'checkbox' },
-  'restrict_selection' => { type=>'select',
-                           label=>'Restrict DID Selection', 
-                           options=>[ '', 'tollfree', 'non-tollfree' ],
-                        }
-                           
+  'login'              => { label=>'Vitelity API login' },
+  'pass'               => { label=>'Vitelity API password' },
+  'routesip'           => { label=>'routesip (optional sub-account)' },
+  'type'               => { label=>'type (optional DID type to order)' },
+  'fax'                => { label=>'vfax service', type=>'checkbox' },
+  'restrict_selection' => { type    => 'select',
+                            label   => 'Restrict DID Selection', 
+                            options => [ '', 'tollfree', 'non-tollfree' ],
+                          },
+  'dry_run'            => { label => "Test mode - don't actually provision",
+                            type  => 'checkbox',
+                          },
+  'disable_e911'       => { label => "Disable E911 provisioning",
+                            type  => 'checkbox',
+                          },
+  'debug'              => { label  => 'Enable debugging',
+                             type  => 'checkbox',
+                             value => 1,
+                          },
 ;
 
 %info = (
-  'svc'     => 'svc_phone',
-  'desc'    => 'Provision phone numbers to Vitelity',
-  'options' => \%options,
+  'svc'        => 'svc_phone',
+  'desc'       => 'Provision phone numbers to Vitelity',
+  'options'    => \%options,
   'no_machine' => 1,
-  'notes'   => <<'END'
-Requires installation of
-<a href="http://search.cpan.org/dist/Net-Vitelity">Net::Vitelity</a>
-from CPAN.
-<br><br>
+  'notes'      => <<'END'
 routesip - optional Vitelity sub-account to which newly ordered DIDs will be routed
 <br>type - optional DID type (perminute, unlimited, or your-pri)
 END
@@ -39,6 +46,10 @@ END
 
 sub rebless { shift; }
 
+sub can_get_dids { 1; }
+sub get_dids_can_tollfree { 1; };
+sub can_lnp { 1; }
+
 sub get_dids {
   my $self = shift;
   my %opt = ref($_[0]) ? %{$_[0]} : @_;
@@ -52,8 +63,8 @@ sub get_dids {
     return [] if ( $tollfree[0] eq 'noneavailable' || $tollfree[0] eq 'none');
 
     foreach my $did ( @tollfree ) {
-       $did =~ /^(\d{3})(\d{3})(\d{4})/ or die "unparsable did $did\n";
-       push @ret, $did;
+        $did =~ /^(\d{3})(\d{3})(\d{4})/ or die "unparsable toll-free did $did\n";
+        push @ret, $did;
     }
 
     my @sorted_ret = sort @ret;
@@ -62,9 +73,9 @@ sub get_dids {
   } elsif ( $opt{'ratecenter'} && $opt{'state'} ) { 
 
     my %flushopts = ( 'state' => $opt{'state'}, 
-                   'ratecenter' => $opt{'ratecenter'},
-                   'exportnum' => $self->exportnum
-                 );
+                    'ratecenter' => $opt{'ratecenter'},
+                    'exportnum' => $self->exportnum
+                  );
     FS::phone_avail::flush( \%flushopts );
       
     local $SIG{HUP} = 'IGNORE';
@@ -92,7 +103,7 @@ sub get_dids {
     die "missingdata error running Vitelity API" if $dids[0] eq 'missingdata';
 
     foreach my $did ( @dids ) {
-      $did =~ /^(\d{3})(\d{3})(\d{4})/ or die "unparsable did $did\n";
+      $did =~ /^(\d{3})(\d{3})(\d{4})/ or die "unparsable (state and ratecenter) did $did\n";
       my($npa, $nxx, $station) = ($1, $2, $3);
 
       my $phone_avail = new FS::phone_avail {
@@ -121,7 +132,7 @@ sub get_dids {
             'hashref'  => { 'exportnum'   => $self->exportnum,
                             'countrycode' => '1', # vitelity is US/CA only now
                             'name'         => $opt{'ratecenter'},
-                           'state'       => $opt{'state'},
+                            'state'          => $opt{'state'},
                           },
             'order_by' => 'ORDER BY npa, nxx, station',
           })
@@ -202,7 +213,7 @@ sub get_dids {
       }
 
       foreach my $did ( @dids ) {
-       $did =~ /^(\d{3})(\d{3})(\d{4})/ or die "unparsable did $did\n";
+        $did =~ /^(\d{3})(\d{3})(\d{4})/ or die "unparsable (state) did $did\n";
         my($npa, $nxx, $station) = ($1, $2, $3);
         $npa{$npa}++;
 
@@ -240,14 +251,24 @@ sub get_dids {
 sub vitelity_command {
   my( $self, $command, @args ) = @_;
 
-  eval "use Net::Vitelity;";
-  die $@ if $@;
+  my $vitelity = Net::Vitelity->new(
+    'login'    => $self->option('login'),
+    'pass'     => $self->option('pass'),
+    'apitype'  => $self->option('fax') ? 'fax' : 'api',
+    'debug'    => $self->option('debug'),
+  );
+
+  $vitelity->$command(@args);
+}
+
+sub vitelity_lnp_command {
+  my( $self, $command, @args ) = @_;
 
   my $vitelity = Net::Vitelity->new(
-    'login' => $self->option('login'),
-    'pass'  => $self->option('pass'),
-    'apitype' => $self->option('fax') ? 'fax' : 'api',
-    #'debug'    => $debug,
+    'login'    => $self->option('login'),
+    'pass'     => $self->option('pass'),
+    'apitype'  => 'lnp',
+    'debug'    => $self->option('debug'),
   );
 
   $vitelity->$command(@args);
@@ -260,6 +281,67 @@ sub _export_insert {
 
   #we want to provision and catch errors now, not queue
 
+  #porting a number in?  different code path
+  if ( $svc_phone->lnp_status eq 'portingin' ) {
+
+    my $cust_main = $svc_phone->cust_svc->cust_pkg->cust_main;
+
+    return 'Customer company is required'
+      unless $cust_main->company;
+
+    return 'Customer day phone (for contact, not porting) is required'
+      unless $cust_main->daytime;
+
+    return 'LNP Other Provider is required'
+      unless $svc_phone->lnp_other_provider;
+
+    return 'LNP Other Provider Account # is required'
+      unless $svc_phone->lnp_other_provider_account;
+
+    my %location = $svc_phone->location_hash;
+    my $sa = Geo::StreetAddress::US->parse_location( $location{'address1'} );
+
+    my $result = $self->vitelity_lnp_command('addport',
+      'portnumber'    => $svc_phone->phonenum,
+      'partial'       => 'no',
+      'wireless'      => 'no',
+      'carrier'       => $svc_phone->lnp_other_provider,
+      'company'       => $cust_main->company,
+      'accnumber'     => $svc_phone->lnp_other_provider_account,
+      'name'          => $svc_phone->phone_name_or_cust,
+      'streetnumber'  => $sa->{number},
+      'streetprefix'  => $sa->{prefix},
+      'streetname'    => $sa->{street}. ' '. $sa->{type},
+      'streetsuffix'  => $sa->{suffix},
+      'unit'          => ( $sa->{sec_unit_num}
+                             ? $sa->{sec_unit_type}. ' '. $sa->{sec_unit_num}
+                             : ''
+                         ),
+      'city'          => $location{'city'},
+      'state'         => $location{'state'},
+      'zip'           => $location{'zip'},
+      'billnumber'    => $svc_phone->phonenum, #?? do we need a new field for this?
+      'contactnumber' => $cust_main->daytime,
+    );
+    warn "Vitelity response: $result" if $self->option('debug');
+
+    if ( $result =~ /^ok:/i ) {
+      my($ok, $portid, $sig, $bill) = split(':', $result);
+      $svc_phone->lnp_portid($portid);
+      $svc_phone->lnp_signature('Y') if $sig  =~ /y/i;
+      $svc_phone->lnp_bill('Y')      if $bill =~ /y/i;
+      local($FS::svc_Common::noexport_hack) = 1;
+      return $svc_phone->replace;
+    } else {
+      return "Error initiating Vitelity port: $result";
+    }
+
+  }
+
+  ###
+  # 1. provision the DID
+  ###
+
   my %vparams = ( 'did' => $svc_phone->phonenum );
   $vparams{'routesip'} = $self->option('routesip') 
     if defined $self->option('routesip');
@@ -272,46 +354,117 @@ sub _export_insert {
   # this is OK as Vitelity for now is US/CA only; it's not a hack
   $command = 'gettollfree' if $vparams{'did'} =~ /^800|^888|^877|^866|^855/;
 
-  if($self->option('fax')) {
-       $command = 'getdid';
-       $success = 'ok';
+  if ($self->option('fax')) {
+    $command = 'getdid';
+    $success = 'ok';
   }
   
   my $result = $self->vitelity_command($command,%vparams);
 
   if ( $result ne $success ) {
     return "Error running Vitelity $command: $result";
+  } elsif ( $self->option('debug') ) {
+    warn "Vitelity response: $result";
+  }
+
+  ###
+  # 2. Provision CNAM
+  ###
+
+  my $cnam_result = $self->vitelity_command('cnamenable',
+                                              'did'=>$svc_phone->phonenum,
+                                           );
+  if ( $result !~ /^(ok|success)/i ) {
+    #we already provisioned the DID, so...
+    warn "Vitelity error enabling CNAM for ". $svc_phone->phonenum. ": $result";
+  } elsif ( $self->option('debug') ) {
+    warn "Vitelity response: $result";
+  }
+
+  ###
+  # 3. Provision E911
+  ###
+
+  my $e911_error = $self->e911_send($svc_phone);
+
+  if ( $e911_error =~ /status=(missingdata|invalid)/i ) {
+
+    my $status = $1;
+    if ( $e911_error =~ /error=(.*)/ ) {
+      $e911_error = "status=$status, error=$1";
+    }
+
+    #but we already provisioned the DID, so:
+    $self->vitelity_command('removedid', 'did'=> $svc_phone->phonenum,);
+    #and check the results?  if it failed, then what?
+
+    return $e911_error;
   }
 
   '';
 }
 
+sub e911_send {
+  my($self, $svc_phone) = (shift, shift);
+
+  return '' if $self->option('disable_e911');
+
+  my %location = $svc_phone->location_hash;
+  $location{'zip'} =~ s/\-\d{4}$//;
+  my %e911send = (
+    'did'     => $svc_phone->phonenum,
+    'name'    => $svc_phone->phone_name_or_cust,
+    'address' => $location{'address1'},
+    'city'    => $location{'city'},
+    'state'   => $location{'state'},
+    'zip'     => $location{'zip'},
+  );
+  if ( $location{address2} =~ /^\s*(\w+)\W*(\d+)\s*$/ ) {
+    $e911send{'unittype'} = $1;
+    $e911send{'unitnumber'} = $2;
+  }
+
+  my $e911_result = $self->vitelity_command('e911send', %e911send);
+
+  unless ( $e911_result =~ /status=(missingdata|invalid)/i ) {
+    warn "Vitelity response: $e911_result" if $self->option('debug');
+    return '';
+  }
+
+  return "Vitelity error provisioning E911 for". $svc_phone->phonenum.
+           ": $e911_result";
+}
+
 sub _export_replace {
   my( $self, $new, $old ) = (shift, shift, shift);
 
   # Call Forwarding
-  if( $old->forwarddst ne $new->forwarddst ) {
-      my $result = $self->vitelity_command('callfw',
-       'did'           => $old->phonenum,
-       'forward'       => $new->forwarddst ? $new->forwarddst : 'none',
-      );
-      if ( $result ne 'ok' ) {
-       return "Error running Vitelity callfw: $result";
-      }
+  if ( $old->forwarddst ne $new->forwarddst ) {
+    my $result = $self->vitelity_command('callfw',
+      'did'           => $old->phonenum,
+      'forward'        => $new->forwarddst ? $new->forwarddst : 'none',
+    );
+    if ( $result ne 'ok' ) {
+      return "Error running Vitelity callfw: $result";
+    } elsif ( $self->option('debug') ) {
+      warn "Vitelity response: $result";
+    }
   }
 
   # vfax forwarding emails
-  if( $old->email ne $new->email && $self->option('fax') ) {
-      my $result = $self->vitelity_command('changeemail',
-       'did'           => $old->phonenum,
-       'emails'        => $new->email ? $new->email : '',
-      );
-      if ( $result ne 'ok' ) {
-       return "Error running Vitelity changeemail: $result";
-      }
+  if ( $old->email ne $new->email && $self->option('fax') ) {
+    my $result = $self->vitelity_command('changeemail',
+      'did'           => $old->phonenum,
+      'emails'        => $new->email ? $new->email : '',
+    );
+    if ( $result ne 'ok' ) {
+      return "Error running Vitelity changeemail: $result";
+    } elsif ( $self->option('debug') ) {
+      warn "Vitelity response: $result";
+    }
   }
 
-  '';
+  $self->e911_send($new);
 }
 
 sub _export_delete {
@@ -330,6 +483,8 @@ sub _export_delete {
 
   if ( $result ne 'success' ) {
     return "Error running Vitelity removedid: $result";
+  } elsif ( $self->option('debug') ) {
+    warn "Vitelity response: $result";
   }
 
   '';
@@ -347,5 +502,53 @@ sub _export_unsuspend {
   '';
 }
 
+sub check_lnp {
+  my $self = shift;
+
+  my @export_svc = $self->export_svc;
+  return unless @export_svc;
+
+  my $in_svcpart = 'IN ('. join( ',', map $_->svcpart, @export_svc). ')';
+
+  foreach my $svc_phone (
+    qsearch({ 'table'     => 'svc_phone',
+              'addl_from' => 'LEFT JOIN cust_svc USING (svcnum)',
+              'hashref'   => {lnp_status=>'portingin'},
+              'extra_sql' => "AND svcpart $in_svcpart",
+           })
+  ) {
+
+    my $result = $self->vitelity_lnp_command('checkstatus',
+                                               'portid'=>$svc_phone->lnp_portid,
+                                            );
+
+    if ( $result =~ /^Complete/i ) {
+
+      $svc_phone->lnp_status('portedin');
+      my $error = $self->_export_insert($svc_phone);
+      if ( $error ) {
+        #XXX log this using our internal log instead, so we can alert on it
+        # properly
+        warn "ERROR provisioning ported-in DID ". $svc_phone->phonenum. ": $error";
+      } else {
+        local($FS::svc_Common::noexport_hack) = 1;
+        $error = $svc_phone->replace; #to set the lnp_status
+        #XXX log this using our internal log instead, so we can alert on it
+        warn "ERROR setting lnp_status for DID ". $svc_phone->phonenum. ": $error" if $error;
+      }
+
+    } elsif ( $result ne $svc_phone->lnp_reject_reason ) {
+      $svc_phone->lnp_reject_reason($result);
+      local($FS::svc_Common::noexport_hack) = 1;
+      my $error = $svc_phone->replace;
+      #XXX log this using our internal log instead, so we can alert on it
+      warn "ERROR setting lnp_reject_reason for DID ". $svc_phone->phonenum. ": $error" if $error;
+
+    }
+
+  }
+
+}
+
 1;