1 package FS::part_export::netsapiens;
2 use base qw( FS::part_export );
4 use vars qw( $me %info );
7 use Date::Format qw( time2str );
8 use Regexp::Common qw( URI );
11 $me = '[FS::part_export::netsapiens]';
13 #These export options set default values for the various commands
14 #to create/update objects. Add more options as needed.
16 my %tristate = ( type => 'select', options => [ '', 'yes', 'no' ]);
18 tie my %subscriber_fields, 'Tie::IxHash',
19 'admin_vmail' => { label=>'VMail Prov.', %tristate },
20 'dial_plan' => { label=>'Dial Translation' },
21 'dial_policy' => { label=>'Dial Permission' },
22 'call_limit' => { label=>'Call Limit' },
23 'domain_dir' => { label=>'Dir Lst', %tristate },
26 tie my %registrar_fields, 'Tie::IxHash',
27 'authenticate_register' => { label=>'Authenticate Registration', %tristate },
28 'authentication_realm' => { label=>'Authentication Realm' },
31 tie my %dialplan_fields, 'Tie::IxHash',
32 'responder' => { label=>'Application' }, #this could be nicer
33 'from_name' => { label=>'Source Name Translation' },
34 'from_user' => { label=>'Source User Translation' },
39 'fnr' => 'Forward Not Registered',
40 'fna' => 'Forward No Answer',
41 'fbu' => 'Forward Busy',
42 'dnd' => 'Do-Not-Disturb',
43 'sim' => 'Simultaneous Ring',
51 tie my %options, 'Tie::IxHash',
52 'login' => { label=>'NetSapiens tac2 User API username' },
53 'password' => { label=>'NetSapiens tac2 User API password' },
54 'url' => { label=>'NetSapiens tac2 User URL' },
55 'device_login' => { label=>'NetSapiens tac2 Device API username' },
56 'device_password' => { label=>'NetSapiens tac2 Device API password' },
57 'device_url' => { label=>'NetSapiens tac2 Device URL' },
58 'domain' => { label=>'NetSapiens Domain' },
59 'domain_no_tld' => { label=>'Omit TLD from domains', type=>'checkbox' },
60 'debug' => { label=>'Enable debugging', type=>'checkbox' },
62 'features' => { label => 'Default features',
65 options => [ keys %features ],
66 option_label => sub { $features{$_[0]}; },
70 'did_countrycode' => { label=>'Use country code in DID destination',
75 'svc' => [qw( svc_phone part_device )],
76 'desc' => 'Provision phone numbers to NetSapiens',
77 'options' => \%options,
83 # http://devguide.netsapiens.com/
85 sub rebless { shift; }
89 my ($self, $options) = @_;
91 my $rex = qr/$RE{URI}{HTTP}{-scheme => qr|https?|}/; # match any "http:" or "https:" URL
93 for my $key (qw/url device_url/) {
94 if ($$options{$key} && ($$options{$key} !~ $rex)) {
95 return "Invalid (URL): " . $$options{$key};
105 $self->_ns_command('', @_);
108 sub ns_device_command {
110 $self->_ns_command('device_', @_);
114 my( $self, $prefix, $method, $command ) = splice(@_,0,4);
116 # kludge to curb excessive paranoia in LWP 6.0+
117 local $ENV{'PERL_LWP_SSL_VERIFY_HOSTNAME'} = 0;
119 my $ns = new REST::Client 'host'=>$self->option($prefix.'url');
121 my @args = ( $command );
123 if ( $method eq 'PUT' ) {
124 my $content = $ns->buildQuery( { @_ } );
126 push @args, $content;
127 } elsif ( $method eq 'GET' ) {
128 $args[0] .= $ns->buildQuery( { @_ } );
131 warn "$me $method ". $self->option($prefix.'url'). join(', ', @args). "\n"
132 if $self->option('debug');
134 my $auth = encode_base64( $self->option($prefix.'login'). ':'.
135 $self->option($prefix.'password') );
136 push @args, { 'Authorization' => "Basic $auth" };
138 $ns->$method( @args );
143 my($self, $svc_phone) = (shift, shift);
144 my $domain = $svc_phone->domain || $self->option('domain');
146 $domain =~ s/\.\w{2,4}$//
147 if $self->option('domain_no_tld');
153 my($self, $svc_phone) = (shift, shift);
155 my $domain = $self->ns_domain($svc_phone);
156 my $phonenum = $svc_phone->phonenum;
158 "/domains_config/$domain/subscriber_config/$phonenum";
162 my($self, $svc_phone) = (shift, shift);
164 $self->ns_subscriber($svc_phone).
165 '/registrar_config/'. $self->ns_devicename($svc_phone);
169 my($self, $svc_phone, $feature) = (shift, shift, shift);
171 $self->ns_subscriber($svc_phone).
172 "/feature_config/$feature,*,*,*,*";
177 my( $self, $svc_phone ) = (shift, shift);
179 my $domain = $self->ns_domain($svc_phone);
180 #my $countrycode = $svc_phone->countrycode;
181 my $phonenum = $svc_phone->phonenum;
183 #"sip:$countrycode$phonenum\@$domain";
184 "sip:$phonenum\@$domain";
188 my($self, $svc_phone) = (shift, shift);
190 my $countrycode = $svc_phone->countrycode || '1';
191 my $phonenum = $svc_phone->phonenum;
192 # Only in the dialplan destination, nowhere else
193 if ( $self->option('did_countrycode') ) {
194 $phonenum = $countrycode . $phonenum;
197 #"/dialplans/DID+Table/dialplan_config/sip:$countrycode$phonenum\@*"
198 "/domains_config/admin-only/dialplans/DID+Table/dialplan_config/sip:$phonenum\@*,*,*,*,*,*,*";
202 my($self, $svc_phone, $phone_device ) = (shift, shift, shift);
204 #my $countrycode = $svc_phone->countrycode;
205 #my $phonenum = $svc_phone->phonenum;
207 "/phones_config/". lc($phone_device->mac_addr);
210 sub ns_create_or_update {
211 my($self, $svc_phone, $dial_policy) = (shift, shift, shift);
213 my $domain = $self->ns_domain($svc_phone);
214 #my $countrycode = $svc_phone->countrycode;
215 my $phonenum = $svc_phone->phonenum;
217 #deal w/unaudited netsapiens services?
218 my $cust_main = $svc_phone->cust_svc->cust_pkg->cust_main;
220 my( $firstname, $lastname );
221 if ( $svc_phone->phone_name =~ /^\s*(\S+)\s+(\S.*\S)\s*$/ ) {
225 $firstname = $cust_main->get('first');
226 $lastname = $cust_main->get('last');
229 my ($email) = ($cust_main->invoicing_list_emailonly, '');
230 my $custnum = $cust_main->custnum;
233 # Piece 1 (already done) - User creation
236 $phonenum =~ /^(\d{3})/;
239 my $ns = $self->ns_command( 'PUT', $self->ns_subscriber($svc_phone),
240 'subscriber_login' => $phonenum.'@'.$domain,
241 'firstname' => $firstname,
242 'lastname' => $lastname,
243 'subscriber_pin' => $svc_phone->pin,
244 'callid_name' => "$firstname $lastname",
245 'callid_nmbr' => $phonenum,
246 'callid_emgr' => $phonenum,
247 'email_address' => $email,
248 'area_code' => $area_code,
249 'srv_code' => $custnum,
250 'date_created' => time2str('%Y-%m-%d %H:%M:%S', time),
251 $self->options_named(keys %subscriber_fields),
252 # allow this to be overridden for suspend
253 ( $dial_policy ? ('dial_policy' => $dial_policy) : () ),
256 if ( $ns->responseCode !~ /^2/ ) {
257 return $ns->responseCode. ' '.
258 join(', ', $self->ns_parse_response( $ns->responseContent ) );
262 # Piece 1.5 - feature creation
264 foreach $feature (split /\s+/, $self->option('features') ) {
266 my $param= exists($feature_param{$feature}) ? $feature_param{$feature} : '';
267 $param = $phonenum if $param eq '$phonenum';
269 my $nsf = $self->ns_command( 'PUT', $self->ns_feature($svc_phone, $feature),
270 'control' => 'd', #User Control, disable
271 'expires' => 'never',
273 'parameters' => $param,
276 'activation' => 'now',
279 if ( $nsf->responseCode !~ /^2/ ) {
280 return $nsf->responseCode. ' '.
281 join(', ', $self->ns_parse_response( $ns->responseContent ) );
287 # Piece 2 - sip device creation
290 my $ns2 = $self->ns_command( 'PUT', $self->ns_registrar($svc_phone),
291 'termination_match' => $self->ns_devicename($svc_phone),
292 'authentication_key'=> $svc_phone->sip_password,
293 'srv_code' => $custnum,
294 $self->options_named(keys %registrar_fields),
297 if ( $ns2->responseCode !~ /^2/ ) {
298 return $ns2->responseCode. ' '.
299 join(', ', $self->ns_parse_response( $ns2->responseContent ) );
303 # Piece 3 - DID mapping to user
306 my $ns3 = $self->ns_command( 'PUT', $self->ns_dialplan($svc_phone),
307 'to_user' => $phonenum,
308 'to_host' => $domain,
309 'plan_description' => "$custnum: $lastname, $firstname", #config?
310 $self->options_named(keys %dialplan_fields),
313 if ( $ns3->responseCode !~ /^2/ ) {
314 return $ns3->responseCode. ' '.
315 join(', ', $self->ns_parse_response( $ns3->responseContent ) );
322 my($self, $svc_phone) = (shift, shift);
324 # do the create steps in reverse order, though I'm not sure it matters
326 my $ns3 = $self->ns_command( 'DELETE', $self->ns_dialplan($svc_phone) );
328 if ( $ns3->responseCode !~ /^2/ ) {
329 return $ns3->responseCode. ' '.
330 join(', ', $self->ns_parse_response( $ns3->responseContent ) );
333 my $ns2 = $self->ns_command( 'DELETE', $self->ns_registrar($svc_phone) );
335 if ( $ns2->responseCode !~ /^2/ ) {
336 return $ns2->responseCode. ' '.
337 join(', ', $self->ns_parse_response( $ns2->responseContent ) );
340 my $ns = $self->ns_command( 'DELETE', $self->ns_subscriber($svc_phone) );
342 if ( $ns->responseCode !~ /^2/ ) {
343 return $ns->responseCode. ' '.
344 join(', ', $self->ns_parse_response( $ns->responseContent ) );
351 sub ns_parse_response {
352 my( $self, $content ) = ( shift, shift );
354 #try to screen-scrape something useful
355 tie my %hash, Tie::IxHash;
356 while ( $content =~ s/^.*?<p>\s*<b>(.+?)<\/b>\s*(.+?)\s*<\/p>//is ) {
357 ( $hash{$1} = $2 ) =~ s/^\s*<(\w+)>(.+?)<\/\1>/$2/is;
364 my($self, $svc_phone) = (shift, shift);
365 $self->ns_create_or_update($svc_phone);
368 sub _export_replace {
369 my( $self, $new, $old ) = (shift, shift, shift);
370 return "can't change phonenum with NetSapiens (unprovision and reprovision?)"
371 if $old->phonenum ne $new->phonenum;
372 $self->_export_insert($new);
376 my( $self, $svc_phone ) = (shift, shift);
378 $self->ns_delete($svc_phone);
381 sub _export_suspend {
382 my( $self, $svc_phone ) = (shift, shift);
383 $self->ns_create_or_update($svc_phone, 'Deny');
386 sub _export_unsuspend {
387 my( $self, $svc_phone ) = (shift, shift);
388 #$self->ns_create_or_update($svc_phone, 'Permit All');
389 $self->_export_insert($svc_phone);
392 sub export_device_insert {
393 my( $self, $svc_phone, $phone_device ) = (shift, shift, shift);
395 my $domain = $self->ns_domain($svc_phone);
396 my $countrycode = $svc_phone->countrycode;
397 my $phonenum = $svc_phone->phonenum;
399 my $ns = $self->ns_device_command(
400 'PUT', $self->ns_device($svc_phone, $phone_device),
401 'line1_enable' => 'yes',
402 'device1' => $self->ns_devicename($svc_phone),
403 'line1_ext' => $phonenum,
405 #'line2_enable' => 'yes',
413 'brand' => $phone_device->part_device->devicename,
417 if ( $ns->responseCode !~ /^2/ ) {
418 return $ns->responseCode. ' '.
419 join(', ', $self->ns_parse_response( $ns->responseContent ) );
426 sub export_device_delete {
427 my( $self, $svc_phone, $phone_device ) = (shift, shift, shift);
429 my $ns = $self->ns_device_command(
430 'DELETE', $self->ns_device($svc_phone, $phone_device),
433 if ( $ns->responseCode !~ /^2/ ) {
434 return $ns->responseCode. ' '.
435 join(', ', $self->ns_parse_response( $ns->responseContent ) );
443 sub export_device_replace {
444 my( $self, $svc_phone, $new_phone_device, $old_phone_device ) =
445 (shift, shift, shift, shift);
448 $self->export_device_insert( $svc_phone, $new_phone_device );
453 my($self, $svc_phone, $arrayref) = (shift, shift, shift);
454 #push @$arrayref, qq!<A HREF="http://example.com/~!. $svc_phone->username.
455 # qq!">!. $svc_phone->username. qq!</A>!;
462 my $v = $self->option($_);
463 length($v) ? ($_ => $v) : ()