1 package FS::part_export::ikano;
5 use vars qw(@ISA %info %loopType $me);
7 use Date::Format qw( time2str );
8 use Date::Parse qw( str2time );
9 use FS::Record qw(qsearch qsearchs dbh);
14 @ISA = qw(FS::part_export);
15 $me= '[' . __PACKAGE__ . ']';
17 tie my %options, 'Tie::IxHash',
18 'keyid' => { label=>'Ikano keyid' },
19 'username' => { label=>'Ikano username',
22 'password' => { label=>'Ikano password' },
23 'check_networks' => { label => 'Check Networks',
24 default => 'ATT,BELLCA',
26 'debug' => { label => 'Debug Mode', type => 'checkbox' },
31 'desc' => 'Provision DSL to Ikano',
32 'options' => \%options,
34 Requires installation of
35 <a href="http://search.cpan.org/dist/Net-Ikano">Net::Ikano</a> from CPAN.
39 %loopType = ( '' => 'Line-share', '0' => 'Standalone' );
41 sub rebless { shift; }
44 # we distinguish between invalid new data (return error) versus data that
45 # has legitimately changed (may eventually execute hooks; now just update)
46 # if we do add hooks later, we should work on a copy of svc_dsl and pass
47 # the old and new svc_dsl to the hooks so they know what changed
49 # current assumptions of what won't change (from their side):
50 # vendor_order_id, vendor_qual_id, vendor_order_type, pushed, monitored,
51 # last_pull, address (from qual), contact info, ProductCustomId
52 my($self, $svc_dsl, $threshold) = (shift, shift, shift);
54 my $result = $self->valid_order($svc_dsl,'pull');
55 return $result unless $result eq '';
58 if($now - $svc_dsl->last_pull < $threshold) {
59 warn "$me skipping pull since threshold not reached (svcnum="
60 . $svc_dsl->svcnum . ",now=$now,threshold=$threshold,last_pull="
61 . $svc_dsl->last_pull .")" if $self->option('debug');
65 $result = $self->ikano_command('ORDERSTATUS',
66 { OrderId => $svc_dsl->vendor_order_id } );
67 return $result unless ref($result); # scalar (string) is an error
69 # now we're getting an OrderResponse which should have one Order in it
70 warn "$me pull OrderResponse hash:\n".Dumper($result)
71 if $self->option('debug');
73 return 'Invalid order response' unless defined $result->{'Order'};
74 $result = $result->{'Order'};
76 return 'No order id or status returned'
77 unless defined $result->{'Status'} && defined $result->{'OrderId'};
79 local $SIG{HUP} = 'IGNORE';
80 local $SIG{INT} = 'IGNORE';
81 local $SIG{QUIT} = 'IGNORE';
82 local $SIG{TERM} = 'IGNORE';
83 local $SIG{TSTP} = 'IGNORE';
84 local $SIG{PIPE} = 'IGNORE';
86 my $oldAutoCommit = $FS::UID::AutoCommit;
87 local $FS::UID::AutoCommit = 0;
91 my $order_status = grep($_ eq $result->{'Status'}, @Net::Ikano::orderStatus)
92 ? $result->{'Status'} : '';
93 return 'Invalid new status' if $order_status eq '';
94 $svc_dsl->vendor_order_status($order_status)
95 if($svc_dsl->vendor_order_status ne $order_status);
96 $svc_dsl->monitored('')
97 if ($order_status eq 'CANCELLED' || $order_status eq 'COMPLETED');
99 # 2. fields we don't care much about
100 my %justUpdate = ( 'first' => 'FirstName',
101 'last' => 'LastName',
102 'company' => 'CompanyName',
103 'username' => 'Username',
104 'password' => 'Password' );
107 while (($fsf, $ikanof) = each %justUpdate) {
108 $svc_dsl->$fsf($result->{$ikanof})
109 if $result->{$ikanof} ne $svc_dsl->$fsf;
112 # let's look inside the <Product> response element
113 my @product = $result->{'Product'};
114 return 'Invalid number of products on order' if scalar(@product) != 1;
115 my $product = $result->{'Product'}[0];
118 if($svc_dsl->loop_type eq '') { # line-share
119 # TN may change only if sub changes it and New or Change order in Completed status
120 my $tn = $product->{'PhoneNumber'};
121 if($tn ne $svc_dsl->phonenum) {
122 if( ($svc_dsl->vendor_order_type eq 'NEW'
123 || $svc_dsl->vendor_order_type eq 'CHANGE')
124 && $svc_dsl->vendor_order_status eq 'COMPLETED' ) {
125 $svc_dsl->phonenum($tn);
127 else { return 'TN has changed in an invalid state'; }
130 elsif($svc_dsl->loop_type eq '0') { # dry loop
131 # TN may change only if it's assigned while a New or Change order is in progress
132 return 'Invalid PhoneNumber value for a dry loop'
133 if $product->{'PhoneNumber'} ne 'STANDALONE';
134 my $tn = $product->{'VirtualPhoneNumber'};
135 if($tn ne $svc_dsl->phonenum) {
136 if( ($svc_dsl->vendor_order_type eq 'NEW'
137 || $svc_dsl->vendor_order_type eq 'CHANGE')
138 && $svc_dsl->vendor_order_status ne 'COMPLETED'
139 && $svc_dsl->vendor_order_status ne 'CANCELLED') {
140 $svc_dsl->phonenum($tn);
142 else { return 'TN has changed in an invalid state'; }
146 # 4. desired_due_date - may change if manually changed
147 if($svc_dsl->vendor_order_type eq 'NEW'
148 || $svc_dsl->vendor_order_type eq 'CHANGE'){
149 my $f = str2time($product->{'DateToOrder'});
150 return 'Invalid DateToOrder' unless $f;
151 $svc_dsl->desired_due_date($f) if $svc_dsl->desired_due_date ne $f;
152 # XXX: optionally sync back to start_date or whatever...
154 elsif($svc_dsl->vendor_order_type eq 'CANCEL'){
155 my $f = str2time($product->{'DateToDisconnect'});
156 return 'Invalid DateToDisconnect' unless $f;
157 $svc_dsl->desired_due_date($f) if $svc_dsl->desired_due_date ne $f;
158 # XXX: optionally sync back to expire or whatever...
162 if($svc_dsl->vendor_order_type eq 'NEW'
163 || $svc_dsl->vendor_order_type eq 'CHANGE') {
164 my $f = str2time($product->{'ActivationDate'});
165 if($svc_dsl->vendor_order_status ne 'NEW'
166 && $svc_dsl->vendor_order_status ne 'CANCELLED') {
167 return 'Invalid ActivationDate' unless $f;
168 $svc_dsl->due_date($f) if $svc_dsl->due_date ne $f;
171 # Ikano API does not implement the proper disconnect date,
172 # so we can't do anything about it
174 # 6. staticips - for now just comma-separate them
175 my $tstatics = $result->{'StaticIps'};
176 my @istatics = defined $tstatics ? @$tstatics : ();
177 my $ostatics = $svc_dsl->staticips;
178 my @ostatics = split(',',$ostatics);
179 # more horrible search/sync code below...
180 my $staticsChanged = 0;
181 foreach my $istatic ( @istatics ) { # they have, we don't
182 unless ( grep($_ eq $istatic, @ostatics) ) {
183 push @ostatics, $istatic;
187 for(my $i=0; $i < scalar(@ostatics); $i++) {
188 unless ( grep($_ eq $ostatics[$i], @istatics) ) {
189 splice(@ostatics,$i,1);
194 $svc_dsl->staticips(join(',',@ostatics)) if $staticsChanged;
196 # 7. notes - put them into the common format and compare
197 my $tnotes = $result->{'OrderNotes'};
198 my @tnotes = defined $tnotes ? @$tnotes : ();
199 my @inotes = (); # all Ikano OrderNotes as FS::dsl_note objects
200 my $notesChanged = 0;
201 foreach my $tnote ( @tnotes ) {
202 my $inote = $self->ikano2fsnote($tnote,$svc_dsl->svcnum);
203 return 'Cannot parse note' unless ref($inote);
204 push @inotes, $inote;
206 my @onotes = $svc_dsl->notes;
207 # assume notes we already have don't change & no notes added from our side
208 # so using the horrible code below just find what we're missing and add it
210 foreach my $inote ( @inotes ) {
212 foreach my $onote ( @onotes ) {
213 if($onote->date == $inote->date && $onote->note eq $inote->note) {
218 $error = $inote->insert unless ( $found );
220 $dbh->rollback if $oldAutoCommit;
221 return "Cannot add note: $error";
225 $svc_dsl->last_pull((time));
226 local $FS::svc_Common::noexport_hack = 1;
227 $error = $svc_dsl->replace;
229 $dbh->rollback if $oldAutoCommit;
230 return "Cannot update DSL data: $error";
233 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
239 my($self,$n,$svcnum) = (shift,shift,shift);
240 my @ikanoRequired = qw( HighPriority StaffId Date Text CompanyStaffId );
241 return '' unless defined $n->{'HighPriority'}
242 && defined $n->{'StaffId'}
243 && defined $n->{'CompanyStaffId'}
244 && defined $n->{'Date'}
245 && defined $n->{'Text'}
248 $by = "Ikano" if $n->{'CompanyStaffId'} == -1 && $n->{'StaffId'} != -1;
249 $by = "Us" if $n->{'StaffId'} == -1 && $n->{'CompanyStaffId'} != -1;
254 'priority' => $n->{'HighPriority'} eq 'false' ? 'N' : 'H',
255 '_date' => int(str2time($n->{'Date'})),
256 'note' => $n->{'Text'},
261 my($self,$qual) = (shift,shift);
262 # address always required for Ikano qual, TN optional (assume dry if not given)
264 my %location_hash = $qual->location;
265 return 'No address provided' unless %location_hash;
266 my $svctn = $qual->phonenum;
268 my $result = $self->ikano_command('PREQUAL',
269 { AddressLine1 => $location_hash{address1},
270 AddressUnitType => $location_hash{location_type},
271 AddressUnitValue => $location_hash{location_number},
272 AddressCity => $location_hash{city},
273 AddressState => $location_hash{state},
274 ZipCode => $location_hash{zip},
275 Country => $location_hash{country},
276 LocationType => $location_hash{location_kind},
277 PhoneNumber => length($svctn) > 1 ? $svctn : "STANDALONE",
278 RequestClientIP => '127.0.0.1',
279 CheckNetworks => $self->option('check_networks'),
281 return $result unless ref($result); # error case
282 return 'Invalid prequal response' unless defined $result->{'PrequalId'};
285 # lame data structure traversal...
286 # don't spend much time here, just get TermsId and ProductCustomId
287 my $networks = $result->{'Network'};
288 my @networks = defined $networks ? @$networks : ();
290 foreach my $network ( @networks ) {
291 my $productgroups = $network->{'ProductGroup'};
292 my @productgroups = defined $productgroups ? @$productgroups : ();
294 foreach my $productgroup ( @productgroups ) {
295 my $prefix = "ikano_Network_$netcount"."_ProductGroup_$pgcount"."_";
296 $qoptions->{$prefix."TermsId"} = $productgroup->{'TermsId'};
297 my $products = $productgroup->{'Product'};
298 my @products = defined $products ? @$products : ();
300 foreach my $product ( @products ) {
301 $qoptions->{$prefix."Product_$prodcount"."_ProductCustomId"} = $product->{'ProductCustomId'};
309 { 'vendor_qual_id' => $result->{'PrequalId'},
310 'status' => scalar(@networks) ? 'Q' : 'D',
311 'options' => $qoptions,
316 my($self,$qual) = (shift,shift);
318 my %qual_options = $qual->options;
319 my @externalids = ();
320 my( $optionname, $optionvalue );
321 while (($optionname, $optionvalue) = each %qual_options) {
322 push @externalids, $optionvalue
323 if ( $optionname =~ /^ikano_Network_(\d+)_ProductGroup_(\d+)_Product_(\d+)_ProductCustomId$/
324 && $optionvalue ne '' );
327 # XXX: eventually perhaps this should return both the packages a link to
328 # order each package and go to the svc prov with the prequal id filled in
329 my $list = "<B>Qualifying Packages:</B><UL>";
330 my @part_pkgs = qsearch( 'part_pkg', { 'disabled' => '' } );
331 foreach my $part_pkg ( @part_pkgs ) {
332 my $externalid = $part_pkg->option('externalid',1);
334 $list .= "<LI>".$part_pkg->pkgpart.": ".$part_pkg->pkg." - "
335 .$part_pkg->comment."</LI>"
336 if grep( $_ eq $externalid, @externalids );
344 my($self,$svc_dsl) = (shift,shift);
345 my $conf = new FS::Conf;
346 my $date_format = $conf->config('date_format') || '%m/%d/%Y';
347 my @notes = $svc_dsl->notes;
348 my $html = '<TABLE border="1" cellspacing="2" cellpadding="2" id="dsl_notes">
349 <TR><TH>Date</TH><TH>By</TH><TH>Priority</TH><TH>Note</TH></TR>';
350 foreach my $note ( @notes ) {
352 <TD>".time2str("$date_format %H:%M",$note->date)."</TD>
353 <TD>".$note->by."</TD>
354 <TD>". ($note->priority eq 'N' ? 'Normal' : 'High') ."</TD>
355 <TD>".$note->note."</TD></TR>";
361 sub loop_type_long { # sub, not a method
362 my($svc_dsl) = (shift);
363 return $loopType{$svc_dsl->loop_type};
367 my( $self, $command, $args ) = @_;
371 my $ikano = Net::Ikano->new(
372 'keyid' => $self->option('keyid'),
373 'username' => $self->option('username'),
374 'password' => $self->option('password'),
375 'debug' => $self->option('debug'),
378 $ikano->$command($args);
382 eval "use Net::Ikano;";
387 my( $self, $svc_dsl, $action ) = (shift, shift, shift);
391 warn "$me valid_order action=$action svc_dsl:\n". Dumper($svc_dsl)
392 if $self->option('debug');
394 # common to all order types/status/loop_type
395 my $error = !($svc_dsl->desired_due_date
396 && grep($_ eq $svc_dsl->vendor_order_type, Net::Ikano->orderTypes)
399 && defined $svc_dsl->loop_type
400 && $svc_dsl->vendor_qual_id
402 return 'Missing or invalid order data' if $error;
404 return 'Package does not have an external id configured'
405 if $svc_dsl->cust_svc->cust_pkg->part_pkg->options('externalid',1) eq '';
407 return 'No valid qualification for this order'
408 unless qsearch( 'qual', { 'vendor_qual_id' => $svc_dsl->vendor_qual_id });
410 # now go by order type
411 # weird ifs & long lines for readability and ease of understanding - don't change
412 if($svc_dsl->vendor_order_type eq 'NEW') {
413 if($svc_dsl->pushed) {
414 $error = !( ($action eq 'pull' || $action eq 'statuschg'
415 || $action eq 'delete')
416 && length($svc_dsl->vendor_order_id) > 0
417 && length($svc_dsl->vendor_order_status) > 0
419 return 'Invalid order data' if $error;
421 return 'Phone number required for status change'
422 if ($action eq 'statuschg' && length($svc_dsl->phonenum) < 1);
424 else { # unpushed New order - cannot do anything other than push it
425 $error = !($action eq 'insert'
426 && length($svc_dsl->vendor_order_id) < 1
427 && length($svc_dsl->vendor_order_status) < 1
428 && ( ($svc_dsl->phonenum eq '' && $svc_dsl->loop_type eq '0') # dry
429 || ($svc_dsl->phonenum ne '' && $svc_dsl->loop_type eq '') # line-share
432 return 'Invalid order data' if $error;
435 elsif($svc_dsl->vendor_order_type eq 'CANCEL') {
437 elsif($svc_dsl->vendor_order_type eq 'CHANGE') {
444 my ($self,$vendor_qual_id,$ProductCustomId) = (shift,shift,shift);
445 my $qual = qsearchs( 'qual', { 'vendor_qual_id' => $vendor_qual_id });
446 return '' unless $qual;
447 my %qual_options = $qual->options;
448 my( $optionname, $optionvalue );
449 while (($optionname, $optionvalue) = each %qual_options) {
450 if ( $optionname =~ /^ikano_Network_(\d+)_ProductGroup_(\d+)_Product_(\d+)_ProductCustomId$/
451 && $optionvalue eq $ProductCustomId ) {
453 my $productgroup = $2;
454 return $qual->option("ikano_Network_".$network."_ProductGroup_".$productgroup."_TermsId");
461 my( $self, $svc_dsl ) = (shift, shift);
465 my $result = $self->valid_order($svc_dsl,'insert');
466 return $result unless $result eq '';
468 my $isp_chg = $svc_dsl->isp_chg eq 'Y' ? 'YES' : 'NO';
469 my $contactTN = $svc_dsl->cust_svc->cust_pkg->cust_main->daytime;
470 $contactTN =~ s/[^0-9]//g;
472 my $ProductCustomId = $svc_dsl->cust_svc->cust_pkg->part_pkg->option('externalid',1);
476 ProductCustomId => $ProductCustomId,
477 TermsId => $self->qual2termsid($svc_dsl->vendor_qual_id,$ProductCustomId),
478 DSLPhoneNumber => $svc_dsl->loop_type eq '0' ? 'STANDALONE'
479 : $svc_dsl->phonenum,
480 Password => $svc_dsl->password,
481 PrequalId => $svc_dsl->vendor_qual_id,
482 CompanyName => $svc_dsl->company,
483 FirstName => $svc_dsl->first,
484 LastName => $svc_dsl->last,
486 ContactMethod => 'PHONE',
487 ContactPhoneNumber => $contactTN,
488 ContactEmail => 'x@x.xx',
490 DateToOrder => time2str("%Y-%m-%d",$svc_dsl->desired_due_date),
491 RequestClientIP => '127.0.0.1',
492 IspChange => $isp_chg,
493 IspPrevious => $isp_chg eq 'YES' ? $svc_dsl->isp_prev : '',
494 CurrentProvider => $isp_chg eq 'NO' ? $svc_dsl->isp_prev : '',
497 $result = $self->ikano_command('ORDER',$args);
498 return $result unless ref($result); # scalar (string) is an error
500 # now we're getting an OrderResponse which should have one Order in it
501 warn "$me _export_insert OrderResponse hash:\n".Dumper($result)
502 if $self->option('debug');
504 return 'Invalid order response' unless defined $result->{'Order'};
505 $result = $result->{'Order'};
507 return 'No/invalid order id or status returned'
508 unless defined $result->{'Status'} && defined $result->{'OrderId'}
509 && grep($_ eq $result->{'Status'}, @Net::Ikano::orderStatus);
511 $svc_dsl->pushed(time);
512 $svc_dsl->last_pull((time)+1);
513 $svc_dsl->vendor_order_id($result->{'OrderId'});
514 $svc_dsl->vendor_order_status($result->{'Status'});
515 $svc_dsl->username($result->{'Username'});
516 local $FS::svc_Common::noexport_hack = 1;
517 $result = $svc_dsl->replace;
518 return "Error setting DSL fields: $result" if $result;
522 sub _export_replace {
523 my( $self, $new, $old ) = (shift, shift, shift);
524 # XXX only supports password changes now, but should return error if
525 # another change is attempted?
527 if($new->password ne $old->password) {
528 my $result = $self->valid_order($new,'statuschg');
529 return $result unless $result eq '';
531 $result = $self->ikano_command('PASSWORDCHANGE',
532 { DSLPhoneNumber => $new->phonenum,
533 NewPassword => $new->password,
535 return $result unless ref($result); # scalar (string) is an error
537 return 'Error changing password' unless defined $result->{'Password'}
538 && $result->{'Password'} eq $new->password;
545 my( $self, $svc_dsl ) = (shift, shift);
547 my $result = $self->valid_order($svc_dsl,'delete');
548 return $result unless $result eq '';
550 # for now allow an immediate cancel only on New orders in New/Pending status
551 #XXX: add support for Chance and Cancel orders in New/Pending status later
553 if($svc_dsl->vendor_order_type eq 'NEW') {
554 if($svc_dsl->vendor_order_status eq 'NEW'
555 || $svc_dsl->vendor_order_status eq 'PENDING') {
556 my $result = $self->ikano_command('CANCEL',
557 { OrderId => $svc_dsl->vendor_order_id, } );
558 return $result unless ref($result); # scalar (string) is an error
559 return 'Unable to cancel order' unless $result->{'Order'};
560 $result = $result->{'Order'};
561 return 'Invalid cancellation response'
562 unless $result->{'Status'} eq 'CANCELLED'
563 && $result->{'OrderId'} eq $svc_dsl->vendor_order_id;
565 # we're supposed to do a pull, but it will break everything, so don't
566 # this is very wrong...
569 return "Cannot cancel a NEW order unless it's in NEW or PENDING status";
573 return 'Canceling orders other than NEW orders is not currently implemented';
580 my( $self, $svc_dsl, $type ) = (shift, shift, shift);
582 my $result = $self->valid_order($svc_dsl,'statuschg');
583 return $result unless $result eq '';
585 # get the DSLServiceId
586 $result = $self->ikano_command('CUSTOMERLOOKUP',
587 { PhoneNumber => $svc_dsl->phonenum } );
588 return $result unless ref($result); # scalar (string) is an error
589 return 'No DSLServiceId found' unless defined $result->{'DSLServiceId'};
590 my $DSLServiceId = $result->{'DSLServiceId'};
592 $result = $self->ikano_command('ACCOUNTSTATUSCHANGE',
593 { DSLPhoneNumber => $svc_dsl->phonenum,
594 DSLServiceId => $DSLServiceId,
597 return $result unless ref($result); # scalar (string) is an error
601 sub _export_suspend {
602 my( $self, $svc_dsl ) = (shift, shift);
603 $self->statuschg($svc_dsl,"SUSPEND");
606 sub _export_unsuspend {
607 my( $self, $svc_dsl ) = (shift, shift);
608 $self->statuschg($svc_dsl,"UNSUSPEND");