RT# 78547 noexport_hack part_svc::netsapiens

[freeside.git] / FS / FS / part_export / netsapiens.pm

diff --git a/FS/FS/part_export/netsapiens.pm b/FS/FS/part_export/netsapiens.pm
index 2869290..c6110f5 100644 (file)
--- a/FS/FS/part_export/netsapiens.pm
+++ b/FS/FS/part_export/netsapiens.pm
@@ -1,12 +1,14 @@
 package FS::part_export::netsapiens;
+use base qw( FS::part_export );
 
-use vars qw(@ISA $me %info);
+use vars qw( $me %info );
 use MIME::Base64;
 use Tie::IxHash;
-use FS::part_export;
 use Date::Format qw( time2str );
+use Regexp::Common qw( URI );
+use REST::Client;
+use Carp qw(carp);
 
-@ISA = qw(FS::part_export);
 $me = '[FS::part_export::netsapiens]';
 
 #These export options set default values for the various commands
@@ -33,6 +35,20 @@ tie my %dialplan_fields, 'Tie::IxHash',
   'from_user'       => { label=>'Source User Translation' },
 ;
 
+my %features = (
+  'for' => 'Forward',
+  'fnr' => 'Forward Not Registered',
+  'fna' => 'Forward No Answer',
+  'fbu' => 'Forward Busy',
+  'dnd' => 'Do-Not-Disturb',
+  'sim' => 'Simultaneous Ring',
+);
+
+my %feature_param = (
+  'dnd' => 'n/a',
+  'sim' => '$phonenum',
+);
+
 tie my %options, 'Tie::IxHash',
   'login'           => { label=>'NetSapiens tac2 User API username' },
   'password'        => { label=>'NetSapiens tac2 User API password' },
@@ -41,8 +57,15 @@ tie my %options, 'Tie::IxHash',
   'device_password' => { label=>'NetSapiens tac2 Device API password' },
   'device_url'      => { label=>'NetSapiens tac2 Device URL' },
   'domain'          => { label=>'NetSapiens Domain' },
+  'domain_no_tld'   => { label=>'Omit TLD from domains', type=>'checkbox' },
   'debug'           => { label=>'Enable debugging', type=>'checkbox' },
   %subscriber_fields,
+  'features'        => { label        => 'Default features',
+                         type         => 'select',
+                         multiple     => 1,
+                         options      => [ keys %features ],
+                         option_label => sub { $features{$_[0]}; },
+                       },
   %registrar_fields,
   %dialplan_fields,
   'did_countrycode' => { label=>'Use country code in DID destination',
@@ -50,18 +73,34 @@ tie my %options, 'Tie::IxHash',
 ;
 
 %info = (
-  'svc'      => [ 'svc_phone', ], # 'part_device',
-  'desc'     => 'Provision phone numbers to NetSapiens',
-  'options'  => \%options,
-  'notes'    => <<'END'
-Requires installation of
-<a href="http://search.cpan.org/dist/REST-Client">REST::Client</a>
-from CPAN.
+  'svc'        => [qw( svc_phone part_device )],
+  'desc'       => 'Provision phone numbers to NetSapiens',
+  'options'    => \%options,
+  'no_machine' => 1,
+  'notes'      => <<'END'
 END
 );
 
+# http://devguide.netsapiens.com/
+
 sub rebless { shift; }
 
+
+sub check_options {
+  my ($self, $options) = @_;
+       
+  my $rex = qr/$RE{URI}{HTTP}{-scheme => qr|https?|}/;                 # match any "http:" or "https:" URL
+       
+  for my $key (qw/url device_url/) {
+    if ($$options{$key} && ($$options{$key} !~ $rex)) {
+      return "Invalid (URL): " . $$options{$key};
+    }
+  }
+  return '';
+}
+
+
+
 sub ns_command {
   my $self = shift;
   $self->_ns_command('', @_);
@@ -77,8 +116,6 @@ sub _ns_command {
 
   # kludge to curb excessive paranoia in LWP 6.0+
   local $ENV{'PERL_LWP_SSL_VERIFY_HOSTNAME'} = 0;
-  eval 'use REST::Client';
-  die $@ if $@;
 
   my $ns = new REST::Client 'host'=>$self->option($prefix.'url');
 
@@ -105,7 +142,12 @@ sub _ns_command {
 
 sub ns_domain {
   my($self, $svc_phone) = (shift, shift);
-  $svc_phone->domain || $self->option('domain');
+  my $domain = $svc_phone->domain || $self->option('domain');
+
+  $domain =~ s/\.\w{2,4}$//
+    if $self->option('domain_no_tld');
+  
+  $domain;
 }
 
 sub ns_subscriber {
@@ -124,6 +166,14 @@ sub ns_registrar {
     '/registrar_config/'. $self->ns_devicename($svc_phone);
 }
 
+sub ns_feature {
+  my($self, $svc_phone, $feature) = (shift, shift, shift);
+
+  $self->ns_subscriber($svc_phone).
+    "/feature_config/$feature,*,*,*,*";
+
+}
+
 sub ns_devicename {
   my( $self, $svc_phone ) = (shift, shift);
 
@@ -180,7 +230,9 @@ sub ns_create_or_update {
   my ($email) = ($cust_main->invoicing_list_emailonly, '');
   my $custnum = $cust_main->custnum;
 
+  ###
   # Piece 1 (already done) - User creation
+  ###
   
   $phonenum =~ /^(\d{3})/;
   my $area_code = $1;
@@ -207,7 +259,34 @@ sub ns_create_or_update {
             join(', ', $self->ns_parse_response( $ns->responseContent ) );
   }
 
-  #Piece 2 - sip device creation 
+  ###
+  # Piece 1.5 - feature creation
+  ###
+  foreach $feature (split /\s+/, $self->option('features') ) {
+
+    my $param= exists($feature_param{$feature}) ? $feature_param{$feature} : '';
+    $param = $phonenum if $param eq '$phonenum';
+
+    my $nsf = $self->ns_command( 'PUT', $self->ns_feature($svc_phone, $feature),
+      'control'    => 'd', #User Control, disable
+      'expires'    => 'never',
+      #'ts'         => '', #?
+      'parameters' => $param,
+      'hour_match' => '*',
+      'time_frame' => '*',
+      'activation' => 'now',
+    );
+
+    if ( $nsf->responseCode !~ /^2/ ) {
+       return $nsf->responseCode. ' '.
+              join(', ', $self->ns_parse_response( $ns->responseContent ) );
+    }
+
+  }
+
+  ###
+  # Piece 2 - sip device creation 
+  ###
 
   my $ns2 = $self->ns_command( 'PUT', $self->ns_registrar($svc_phone),
     'termination_match' => $self->ns_devicename($svc_phone),
@@ -221,7 +300,9 @@ sub ns_create_or_update {
             join(', ', $self->ns_parse_response( $ns2->responseContent ) );
   }
 
-  #Piece 3 - DID mapping to user
+  ###
+  # Piece 3 - DID mapping to user
+  ###
 
   my $ns3 = $self->ns_command( 'PUT', $self->ns_dialplan($svc_phone),
     'to_user' => $phonenum,
@@ -312,6 +393,12 @@ sub _export_unsuspend {
 sub export_device_insert {
   my( $self, $svc_phone, $phone_device ) = (shift, shift, shift);
 
+  if ( $FS::svc_Common::noexport_hack ) {
+    carp 'export_device_insert() suppressed by noexport_hack'
+      if $self->option('debug');
+    return;
+  }
+
   my $domain = $self->ns_domain($svc_phone);
   my $countrycode = $svc_phone->countrycode;
   my $phonenum    = $svc_phone->phonenum;
@@ -346,6 +433,12 @@ sub export_device_insert {
 sub export_device_delete {
   my( $self, $svc_phone, $phone_device ) = (shift, shift, shift);
 
+  if ( $FS::svc_Common::noexport_hack ) {
+    carp 'export_device_delete() suppressed by noexport_hack'
+      if $self->option('debug');
+    return;
+  }
+
   my $ns = $self->ns_device_command(
     'DELETE', $self->ns_device($svc_phone, $phone_device),
   );