add e911 (and cnameenable) to vitelity integration, RT#73618
[freeside.git] / FS / FS / part_export / vitelity.pm
index d44335b..5173126 100644 (file)
@@ -1,27 +1,35 @@
 package FS::part_export::vitelity;
+use base qw( FS::part_export );
 
-use vars qw(@ISA %info);
+use vars qw( %info );
 use Tie::IxHash;
-use FS::Record qw(qsearch dbh);
-use FS::part_export;
+use FS::Record qw( qsearch dbh );
 use FS::phone_avail;
 
-@ISA = qw(FS::part_export);
-
 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' },
+  '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',
+                          },
 ;
 
 %info = (
-  'svc'     => 'svc_phone',
-  'desc'    => 'Provision phone numbers to Vitelity',
-  'options' => \%options,
-  'notes'   => <<'END'
+  '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.
@@ -33,60 +41,83 @@ END
 
 sub rebless { shift; }
 
+sub can_get_dids { 1; }
+sub get_dids_can_tollfree { 1; };
+
 sub get_dids {
   my $self = shift;
   my %opt = ref($_[0]) ? %{$_[0]} : @_;
 
   if ( $opt{'tollfree'} ) {
-      # XXX: no caching for now
-      # XXX: limit option
-
     my $command = 'listtollfree';
     $command = 'listdids' if $self->option('fax');
     my @tollfree = $self->vitelity_command($command);
     my @ret = ();
 
-    if (scalar(@tollfree)) {
-       local $SIG{HUP} = 'IGNORE';
-       local $SIG{INT} = 'IGNORE';
-       local $SIG{QUIT} = 'IGNORE';
-       local $SIG{TERM} = 'IGNORE';
-       local $SIG{TSTP} = 'IGNORE';
-       local $SIG{PIPE} = 'IGNORE';
-
-       my $oldAutoCommit = $FS::UID::AutoCommit;
-       local $FS::UID::AutoCommit = 0;
-       my $dbh = dbh;
-
-       my $errmsg = 'WARNING: error populating phone availability cache: ';
-       
-       foreach my $did ( @tollfree ) {
-           $did =~ /^(\d{3})(\d{3})(\d{4})/ or die "unparsable did $did\n";
-           my($npa, $nxx, $station) = ($1, $2, $3);
-           push @ret, $did;
-
-           my $phone_avail = new FS::phone_avail {
-             'exportnum'   => $self->exportnum,
-             'countrycode' => '1', # vitelity is US/CA only now
-             'npa'         => $npa,
-             'nxx'         => $nxx,
-             'station'     => $station,
-           };
-
-           $error = $phone_avail->insert();
-           if ( $error ) {
-             $dbh->rollback if $oldAutoCommit;
-             die $errmsg.$error;
-           }
-        }
-       $dbh->commit or warn $errmsg.$dbh->errstr if $oldAutoCommit;
+    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;
     }
 
     my @sorted_ret = sort @ret;
     return \@sorted_ret;
 
-  } elsif ( $opt{'areacode'} && $opt{'exchange'} ) { #return numbers in format NPA-NXX-XXXX
+  } elsif ( $opt{'ratecenter'} && $opt{'state'} ) { 
+
+    my %flushopts = ( 'state' => $opt{'state'}, 
+                    'ratecenter' => $opt{'ratecenter'},
+                    'exportnum' => $self->exportnum
+                  );
+    FS::phone_avail::flush( \%flushopts );
+      
+    local $SIG{HUP} = 'IGNORE';
+    local $SIG{INT} = 'IGNORE';
+    local $SIG{QUIT} = 'IGNORE';
+    local $SIG{TERM} = 'IGNORE';
+    local $SIG{TSTP} = 'IGNORE';
+    local $SIG{PIPE} = 'IGNORE';
+
+    my $oldAutoCommit = $FS::UID::AutoCommit;
+    local $FS::UID::AutoCommit = 0;
+    my $dbh = dbh;
+
+    my $errmsg = 'WARNING: error populating phone availability cache: ';
+
+    my $command = 'listlocal';
+    $command = 'listdids' if $self->option('fax');
+    my @dids = $self->vitelity_command( $command,
+                                        'state'      => $opt{'state'},
+                                        'ratecenter' => $opt{'ratecenter'},
+                                      );
+    # XXX: Options: type=unlimited OR type=pri
+
+    next if ( $dids[0] eq 'unavailable'  || $dids[0] eq 'noneavailable' );
+    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";
+      my($npa, $nxx, $station) = ($1, $2, $3);
+
+      my $phone_avail = new FS::phone_avail {
+          'exportnum'   => $self->exportnum,
+          'countrycode' => '1', # vitelity is US/CA only now
+          'state'       => $opt{'state'},
+          'npa'         => $npa,
+          'nxx'         => $nxx,
+          'station'     => $station,
+          'name'        => $opt{'ratecenter'},
+      };
+
+      my $error = $phone_avail->insert();
+      if ( $error ) {
+          $dbh->rollback if $oldAutoCommit;
+          die $errmsg.$error;
+      }
+
+    }
+    $dbh->commit or warn $errmsg.$dbh->errstr if $oldAutoCommit;
 
     return [
       map { join('-', $_->npa, $_->nxx, $_->station ) }
@@ -94,35 +125,30 @@ sub get_dids {
             'table'    => 'phone_avail',
             'hashref'  => { 'exportnum'   => $self->exportnum,
                             'countrycode' => '1', # vitelity is US/CA only now
-                            'npa'         => $opt{'areacode'},
-                            'nxx'         => $opt{'exchange'},
+                            'name'         => $opt{'ratecenter'},
+                            'state'          => $opt{'state'},
                           },
-            'order_by' => 'ORDER BY station',
+            'order_by' => 'ORDER BY npa, nxx, station',
           })
     ];
 
-  } elsif ( $opt{'areacode'} ) { #return exchanges in format NPA-NXX- literal 'XXXX'
+  } elsif ( $opt{'areacode'} ) { 
 
-    # you can't call $->name .... that returns "(unlinked)"
-    # and in any case this is still major abuse of encapsulation, it just happens to work for the other fields
-    @rc = map { $_->{'Hash'}->{name}.' ('. $_->npa. '-'. $_->nxx. '-XXXX)' } 
+    my @rc = map { $_->{'Hash'}->{name}.", ".$_->state } 
           qsearch({
-            'select'   => 'DISTINCT npa,nxx,name',
+            'select'   => 'DISTINCT name, state',
             'table'    => 'phone_avail',
             'hashref'  => { 'exportnum'   => $self->exportnum,
                             'countrycode' => '1', # vitelity is US/CA only now
                             'npa'         => $opt{'areacode'},
                           },
-            'order_by' => 'ORDER BY nxx',
           });
 
-    @sorted_rc = sort @rc;
+    my @sorted_rc = sort @rc;
     return [ @sorted_rc ];
 
   } elsif ( $opt{'state'} ) { #and not other things, then return areacode
 
-    #XXX need to flush the cache at some point :/
-
     my @avail = qsearch({
       'select'   => 'DISTINCT npa',
       'table'    => 'phone_avail',
@@ -181,7 +207,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 did $did\n";
         my($npa, $nxx, $station) = ($1, $2, $3);
         $npa{$npa}++;
 
@@ -195,7 +221,7 @@ sub get_dids {
           'name'        => $ratecenter,
         };
 
-        $error = $phone_avail->insert();
+        my $error = $phone_avail->insert();
         if ( $error ) {
           $dbh->rollback if $oldAutoCommit;
           die $errmsg.$error;
@@ -208,8 +234,6 @@ sub get_dids {
     $dbh->commit or warn $errmsg.$dbh->errstr if $oldAutoCommit;
 
     my @return = sort { $a <=> $b } keys %npa;
-    #@return = sort { (split(' ', $a))[0] <=> (split(' ', $b))[0] } @return;
-
     return \@return;
 
   } else {
@@ -241,23 +265,25 @@ sub _export_insert {
 
   #we want to provision and catch errors now, not queue
 
-  %vparams = ( 'did' => $svc_phone->phonenum );
+  ###
+  # 1. provision the DID
+  ###
+
+  my %vparams = ( 'did' => $svc_phone->phonenum );
   $vparams{'routesip'} = $self->option('routesip') 
     if defined $self->option('routesip');
   $vparams{'type'} = $self->option('type') 
     if defined $self->option('type');
 
-
-  $command = 'getlocaldid';
-  $success = 'success';
+  my $command = 'getlocaldid';
+  my $success = 'success';
 
   # this is OK as Vitelity for now is US/CA only; it's not a hack
-  $command = 'gettollfree' if $vparams{'did'} =~ /^800|^88[8765]/;
+  $command = 'gettollfree' if $vparams{'did'} =~ /^800|^888|^877|^866|^855/;
 
-  if($self->option('fax')) {
-       # supposedly should work for toll-free fax too
-       $command = 'getdid';
-       $success = 'ok';
+  if ($self->option('fax')) {
+    $command = 'getdid';
+    $success = 'ok';
   }
   
   my $result = $self->vitelity_command($command,%vparams);
@@ -266,35 +292,94 @@ sub _export_insert {
     return "Error running Vitelity $command: $result";
   }
 
+  ###
+  # 2. Provision CNAM
+  ###
+
+  my $cnam_result = $self->vitelity_command('cnamenable',
+                                              'did'=>$svc_phone->phonenum,
+                                           );
+  if ( $result ne 'ok' ) {
+    #we already provisioned the DID, so...
+    warn "Vitelity error enabling CNAM for ". $svc_phone->phonenum. ": $result";
+  }
+
+  ###
+  # 3. Provision E911
+  ###
+
+  my $e911_error = $self->e911_send($svc_phone);
+
+  if ( $e911_error =~ /^(missingdata|invalid)/i ) {
+    #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 e911send {
+  my($self, $svc_phone) = (shift, shift);
+
+  return '' if $self->option('disable_e911');
+
+  my %location = $svc_phone->location_hash;
+  my %e911send = (
+    'did'     => $svc_phone->phonenum,
+    'address' => $location{'address1'},
+    'city'    => $location{'city'},
+    'state'   => $location{'state'},
+    'zip'     => $location{'zip'},
+  );
+  if ( $svc_phone->phone_name ) {
+    $e911send{'name'} = $svc_phone->phone_name;
+  } else {
+    my $cust_main = $svc_phone->cust_svc->cust_pkg->cust_main;
+    $e911send{'name'} = $cust_main->company || $cust_main->first. ' '.
+                                               $cust_main->get('last');
+  }
+  if ( $location{address2} =~ /^\s*(\w+)\W*(\d+)\s*$/ ) {
+    $e911send{'unittype'} = $1;
+    $e911send{'unitnumber'} = $2;
+  }
+
+  my $e911_result = $self->vitelity_command('e911send', %e911send);
+
+  return '' unless $result =~ /^(missingdata|invalid)/i;
+
+  return "Vitelity error provisioning E911 for". $svc_phone->phonenum.
+           ": $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',
+        'did'           => $old->phonenum,
+        'forward'        => $new->forwarddst ? $new->forwarddst : 'none',
       );
       if ( $result ne 'ok' ) {
-       return "Error running Vitelity callfw: $result";
+        return "Error running Vitelity callfw: $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 : '',
+        'did'           => $old->phonenum,
+        'emails'        => $new->email ? $new->email : '',
       );
       if ( $result ne 'ok' ) {
-       return "Error running Vitelity changeemail: $result";
+        return "Error running Vitelity changeemail: $result";
       }
   }
 
-  '';
+  $self->e911_send($new);
 }
 
 sub _export_delete {
@@ -315,6 +400,8 @@ sub _export_delete {
     return "Error running Vitelity removedid: $result";
   }
 
+  return '' if $self->option('disable_e911');
+
   '';
 }