6316b298d1c1d95d3ecdf87df2c8a6b94933b03b
[freeside.git] / FS / FS / part_export / ikano.pm
1 package FS::part_export::ikano;
2
3 use strict;
4 use warnings;
5 use vars qw(@ISA %info %loopType $me);
6 use Tie::IxHash;
7 use Date::Format qw( time2str );
8 use Date::Parse qw( str2time );
9 use FS::Record qw(qsearch qsearchs dbh);
10 use FS::part_export;
11 use FS::svc_dsl;
12 use Data::Dumper;
13
14 @ISA = qw(FS::part_export);
15 $me= '[' .  __PACKAGE__ . ']';
16
17 tie my %options, 'Tie::IxHash',
18   'keyid'         => { label=>'Ikano keyid' },
19   'username'      => { label=>'Ikano username',
20                         default => 'admin',
21                         },
22   'password'      => { label=>'Ikano password' },
23   'check_networks' => { label => 'Check Networks',
24                     default => 'ATT,BELLCA',
25                     },
26   'debug' => { label => 'Debug Mode',  type => 'checkbox' },
27 ;
28
29 %info = (
30   'svc'     => 'svc_dsl',
31   'desc'    => 'Provision DSL to Ikano',
32   'options' => \%options,
33   'notes'   => <<'END'
34 Requires installation of
35 <a href="http://search.cpan.org/dist/Net-Ikano">Net::Ikano</a> from CPAN.
36 END
37 );
38     
39 %loopType = ( '' => 'Line-share', '0' => 'Standalone' );
40
41 sub rebless { shift; }
42
43 sub dsl_pull {
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
48 #
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);
53     $self->loadmod;
54     my $result = $self->valid_order($svc_dsl,'pull');
55     return $result unless $result eq '';
56
57     my $now = time;
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');
62         return '';
63     }
64   
65     $result = $self->ikano_command('ORDERSTATUS', 
66         { OrderId => $svc_dsl->vendor_order_id } ); 
67     return $result unless ref($result); # scalar (string) is an error
68
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');
72   
73     return 'Invalid order response' unless defined $result->{'Order'};
74     $result = $result->{'Order'};
75
76     return 'No order id or status returned' 
77         unless defined $result->{'Status'} && defined $result->{'OrderId'};
78         
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';
85
86     my $oldAutoCommit = $FS::UID::AutoCommit;
87     local $FS::UID::AutoCommit = 0;
88     my $dbh = dbh;
89
90     # 1. status 
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');
98
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' );
105
106     my($fsf, $ikanof);
107     while (($fsf, $ikanof) = each %justUpdate) {
108        $svc_dsl->$fsf($result->{$ikanof}) 
109             if $result->{$ikanof} ne $svc_dsl->$fsf;
110     }
111
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];
116
117     # 3. phonenum 
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);
126             }
127             else { return 'TN has changed in an invalid state'; }
128         }
129     }
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);
141             }
142             else { return 'TN has changed in an invalid state'; }
143         }
144     }
145     
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... 
153     }
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... 
159     }
160
161     # 5. due_date
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;
169         }
170     }
171     # Ikano API does not implement the proper disconnect date,
172     # so we can't do anything about it
173
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;
184             $staticsChanged = 1;
185         }
186     }
187     for(my $i=0; $i < scalar(@ostatics); $i++) {
188         unless ( grep($_ eq $ostatics[$i], @istatics) ) {
189             splice(@ostatics,$i,1);
190             $i--;
191             $staticsChanged = 1;
192         }
193     }
194     $svc_dsl->staticips(join(',',@ostatics)) if $staticsChanged;
195
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;
205     }
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
209     my $error;
210     foreach my $inote ( @inotes ) {
211         my $found = 0;
212         foreach my $onote ( @onotes ) {
213             if($onote->date == $inote->date && $onote->note eq $inote->note) {
214                 $found = 1;
215                 last;
216             }
217         }
218         $error = $inote->insert unless ( $found );
219         if ( $error ) {
220           $dbh->rollback if $oldAutoCommit;
221           return "Cannot add note: $error";
222         }
223     }
224     
225     $svc_dsl->last_pull((time));
226     local $FS::svc_Common::noexport_hack = 1;
227     $error = $svc_dsl->replace; 
228     if ( $error ) {
229       $dbh->rollback if $oldAutoCommit;
230       return "Cannot update DSL data: $error";
231     }
232
233     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
234
235     '';
236 }
237
238 sub ikano2fsnote {
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'}
246                 ;
247     my $by = 'Unknown';
248     $by = "Ikano" if $n->{'CompanyStaffId'} == -1 && $n->{'StaffId'} != -1;
249     $by = "Us" if $n->{'StaffId'} == -1 && $n->{'CompanyStaffId'} != -1;
250
251     new FS::dsl_note( {
252         'svcnum' => $svcnum,
253         'user' => $by,
254         'priority' => $n->{'HighPriority'} eq 'false' ? 'N' : 'H',
255         '_date' => int(str2time($n->{'Date'})),
256         'note' => $n->{'Text'},
257      } );
258 }
259
260 sub qual {
261     my($self,$qual) = (shift,shift);
262 # address always required for Ikano qual, TN optional (assume dry if not given)
263
264     my %location_hash = $qual->location; 
265     return 'No address provided' unless %location_hash;
266     my $svctn = $qual->phonenum;
267
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'),
280       } ); 
281     return 'Invalid prequal response' unless defined $result->{'PrequalId'};
282
283     my $qoptions = {};
284     # lame data structure traversal...
285     # don't spend much time here, just get TermsId and ProductCustomId
286     my $networks = $result->{'Network'};
287     my @networks = defined $networks ? @$networks : ();
288     my $netcount = 0;
289     foreach my $network ( @networks ) { 
290         my $productgroups = $network->{'ProductGroup'};
291         my @productgroups = defined $productgroups ? @$productgroups : ();
292         my $pgcount = 0;
293         foreach my $productgroup ( @productgroups ) {
294             my $prefix = "ikano_Network_$netcount"."_ProductGroup_$pgcount"."_";
295             $qoptions->{$prefix."TermsId"} = $productgroup->{'TermsId'};
296             my $products = $network->{'Product'};
297             my @products = defined $products ? @$products : ();
298             my $prodcount = 0;
299             foreach my $product ( @products ) {
300                 $qoptions->{$prefix."Product_$prodcount"."_ProductCustomId"} = $product->{'ProductCustomId'};
301                 $prodcount++;
302             }
303             $pgcount++;
304         }
305         $netcount++;
306     }
307
308     {   'vendor_qual_id' => $result->{'PrequalId'},
309         'status' => scalar(@networks) ? 'Q' : 'D',
310         'options' => $qoptions,
311     };
312 }
313
314 sub qual_html {
315     '';
316 }
317
318 sub notes_html { 
319     my($self,$svc_dsl) = (shift,shift);
320     my $conf = new FS::Conf;
321     my $date_format = $conf->config('date_format') || '%m/%d/%Y';
322     my @notes = $svc_dsl->notes;
323     my $html = '<TABLE border="1" cellspacing="2" cellpadding="2" id="dsl_notes">
324         <TR><TH>Date</TH><TH>By</TH><TH>Priority</TH><TH>Note</TH></TR>';
325     foreach my $note ( @notes ) {
326         $html .= "<TR>
327             <TD>".time2str("$date_format %H:%M",$note->date)."</TD>
328             <TD>".$note->by."</TD>
329             <TD>". ($note->priority eq 'N' ? 'Normal' : 'High') ."</TD>
330             <TD>".$note->note."</TD></TR>";
331     }
332     $html .= '</TABLE>';
333     $html;
334 }
335
336 sub loop_type_long { # sub, not a method
337     my($svc_dsl) = (shift);
338     return $loopType{$svc_dsl->loop_type};
339 }
340
341 sub ikano_command {
342   my( $self, $command, $args ) = @_;
343
344   $self->loadmod;
345
346   my $ikano = Net::Ikano->new(
347     'keyid' => $self->option('keyid'),
348     'username'  => $self->option('username'),
349     'password'  => $self->option('password'),
350     'debug'    => $self->option('debug'),
351   );
352
353   $ikano->$command($args);
354 }
355
356 sub loadmod {
357   eval "use Net::Ikano;";
358   die $@ if $@;
359 }
360
361 sub valid_order {
362   my( $self, $svc_dsl, $action ) = (shift, shift, shift);
363  
364   $self->loadmod;
365   
366   warn "$me valid_order action=$action svc_dsl:\n". Dumper($svc_dsl)
367         if $self->option('debug');
368
369   # common to all order types/status/loop_type
370   my $error = !($svc_dsl->desired_due_date
371             &&  grep($_ eq $svc_dsl->vendor_order_type, Net::Ikano->orderTypes)
372             &&  $svc_dsl->first
373             &&  $svc_dsl->last
374             &&  defined $svc_dsl->loop_type
375             &&  $svc_dsl->vendor_qual_id
376             );
377   return 'Missing or invalid order data' if $error;
378   
379   return 'Package does not have an external id configured'
380     if $svc_dsl->cust_svc->cust_pkg->part_pkg->options('externalid',1) eq '';
381
382   return 'No valid qualification for this order' 
383     unless qsearch( 'qual', { 'vendor_qual_id' => $svc_dsl->vendor_qual_id });
384
385   # now go by order type
386   # weird ifs & long lines for readability and ease of understanding - don't change
387   if($svc_dsl->vendor_order_type eq 'NEW') {
388     if($svc_dsl->pushed) {
389         $error = !( ($action eq 'pull' || $action eq 'statuschg' 
390                         || $action eq 'delete')
391             &&  length($svc_dsl->vendor_order_id) > 0
392             &&  length($svc_dsl->vendor_order_status) > 0
393                 );
394         return 'Invalid order data' if $error;
395
396         return 'Phone number required for status change'
397             if ($action eq 'statuschg' && length($svc_dsl->phonenum) < 1);
398     }
399     else { # unpushed New order - cannot do anything other than push it
400         $error = !($action eq 'insert'
401             &&  length($svc_dsl->vendor_order_id) < 1
402             &&  length($svc_dsl->vendor_order_status) < 1
403             && ( ($svc_dsl->phonenum eq '' && $svc_dsl->loop_type eq '0') # dry
404               || ($svc_dsl->phonenum ne '' && $svc_dsl->loop_type eq '') # line-share
405                )
406             );  
407         return 'Invalid order data' if $error;
408     }
409   }
410   elsif($svc_dsl->vendor_order_type eq 'CANCEL') {
411   }
412   elsif($svc_dsl->vendor_order_type eq 'CHANGE') {
413   }
414
415  '';
416 }
417
418 sub qual2termsid {
419     my ($self,$vendor_qual_id,$ProductCustomId) = (shift,shift,shift);
420     my $qual = qsearchs( 'qual', { 'vendor_qual_id' => $vendor_qual_id });
421     return '' unless $qual;
422     my %qual_options = $qual->options;
423     my( $optionname, $optionvalue );
424     while (($optionname, $optionvalue) = each %qual_options) {
425         if ( $optionname =~ /^ikano_Network_(\d+)_ProductGroup_(\d+)_Product_(\d+)_ProductCustomId$/ 
426             && $optionvalue eq $ProductCustomId ) {
427             my $network = $1;
428             my $productgroup = $2;
429             return $qual->option("ikano_Network_".$network."_ProductGroup_".$productgroup."_TermsId");
430         }
431     }
432     '';
433 }
434
435 sub _export_insert {
436   my( $self, $svc_dsl ) = (shift, shift);
437
438   $self->loadmod;
439
440   my $result = $self->valid_order($svc_dsl,'insert');
441   return $result unless $result eq '';
442
443   my $isp_chg = $svc_dsl->isp_chg eq 'Y' ? 'YES' : 'NO';
444   my $contactTN = $svc_dsl->cust_svc->cust_pkg->cust_main->daytime;
445   $contactTN =~ s/[^0-9]//g;
446
447   my $ProductCustomId = $svc_dsl->cust_svc->cust_pkg->part_pkg->option('externalid',1);
448
449   my $args = {
450         orderType => 'NEW',
451         ProductCustomId => $ProductCustomId,
452         TermsId => $self->qual2termsid($svc_dsl->vendor_qual_id,$ProductCustomId),
453         DSLPhoneNumber => $svc_dsl->loop_type eq '0' ? 'STANDALONE'
454                                                     : $svc_dsl->phonenum,
455         Password => $svc_dsl->password,
456         PrequalId => $svc_dsl->vendor_qual_id,
457         CompanyName => $svc_dsl->company,
458         FirstName => $svc_dsl->first,
459         LastName => $svc_dsl->last,
460         MiddleName => '',
461         ContactMethod => 'PHONE',
462         ContactPhoneNumber => $contactTN,
463         ContactEmail => 'x@x.xx',
464         ContactFax => '',
465         DateToOrder => time2str("%Y-%m-%d",$svc_dsl->desired_due_date),
466         RequestClientIP => '127.0.0.1',
467         IspChange => $isp_chg,
468         IspPrevious => $isp_chg eq 'YES' ? $svc_dsl->isp_prev : '',
469         CurrentProvider => $isp_chg eq 'NO' ? $svc_dsl->isp_prev : '',
470   };
471
472   $result = $self->ikano_command('ORDER',$args); 
473   return $result unless ref($result); # scalar (string) is an error
474
475   # now we're getting an OrderResponse which should have one Order in it
476   warn "$me _export_insert OrderResponse hash:\n".Dumper($result)
477         if $self->option('debug');
478   
479   return 'Invalid order response' unless defined $result->{'Order'};
480   $result = $result->{'Order'};
481
482   return 'No/invalid order id or status returned' 
483     unless defined $result->{'Status'} && defined $result->{'OrderId'}
484         && grep($_ eq $result->{'Status'}, @Net::Ikano::orderStatus);
485
486   $svc_dsl->pushed(time);
487   $svc_dsl->last_pull((time)+1); 
488   $svc_dsl->vendor_order_id($result->{'OrderId'});
489   $svc_dsl->vendor_order_status($result->{'Status'});
490   $svc_dsl->username($result->{'Username'});
491   local $FS::svc_Common::noexport_hack = 1;
492   $result = $svc_dsl->replace; 
493   return "Error setting DSL fields: $result" if $result;
494   '';
495 }
496
497 sub _export_replace {
498   my( $self, $new, $old ) = (shift, shift, shift);
499 # XXX only supports password changes now, but should return error if 
500 # another change is attempted?
501
502   if($new->password ne $old->password) {
503       my $result = $self->valid_order($new,'statuschg');
504       return $result unless $result eq '';
505       
506       $result = $self->ikano_command('PASSWORDCHANGE',
507             { DSLPhoneNumber => $new->phonenum,
508               NewPassword => $new->password,
509             } ); 
510       return $result unless ref($result); # scalar (string) is an error
511
512       return 'Error changing password' unless defined $result->{'Password'}
513         && $result->{'Password'} eq $new->password;
514   }
515
516   '';
517 }
518
519 sub _export_delete {
520   my( $self, $svc_dsl ) = (shift, shift);
521   
522   my $result = $self->valid_order($svc_dsl,'delete');
523   return $result unless $result eq '';
524
525   # for now allow an immediate cancel only on New orders in New/Pending status
526   #XXX: add support for Chance and Cancel orders in New/Pending status later
527
528   if($svc_dsl->vendor_order_type eq 'NEW') {
529     if($svc_dsl->vendor_order_status eq 'NEW' 
530             || $svc_dsl->vendor_order_status eq 'PENDING') {
531         my $result = $self->ikano_command('CANCEL', 
532             { OrderId => $svc_dsl->vendor_order_id, } );
533         return $result unless ref($result); # scalar (string) is an error
534         return 'Unable to cancel order' unless $result->{'Order'};
535         $result = $result->{'Order'};
536         return 'Invalid cancellation response' 
537             unless $result->{'Status'} eq 'CANCELLED' 
538                 && $result->{'OrderId'} eq $svc_dsl->vendor_order_id;
539
540         # we're supposed to do a pull, but it will break everything, so don't
541         # this is very wrong...
542     }
543     else {
544         return "Cannot cancel a NEW order unless it's in NEW or PENDING status";
545     }
546   }
547   else {
548     return 'Canceling orders other than NEW orders is not currently implemented';
549   }
550
551   '';
552 }
553
554 sub statuschg {
555   my( $self, $svc_dsl, $type ) = (shift, shift, shift);
556
557   my $result = $self->valid_order($svc_dsl,'statuschg');
558   return $result unless $result eq '';
559
560   # get the DSLServiceId
561   $result = $self->ikano_command('CUSTOMERLOOKUP',
562         { PhoneNumber => $svc_dsl->phonenum } ); 
563   return $result unless ref($result); # scalar (string) is an error
564   return 'No DSLServiceId found' unless defined $result->{'DSLServiceId'};
565   my $DSLServiceId = $result->{'DSLServiceId'};
566
567   $result = $self->ikano_command('ACCOUNTSTATUSCHANGE',
568         { DSLPhoneNumber => $svc_dsl->phonenum,
569           DSLServiceId => $DSLServiceId,
570           type => $type,
571         } ); 
572   return $result unless ref($result); # scalar (string) is an error
573   ''; 
574 }
575
576 sub _export_suspend {
577   my( $self, $svc_dsl ) = (shift, shift);
578   $self->statuschg($svc_dsl,"SUSPEND");
579 }
580
581 sub _export_unsuspend {
582   my( $self, $svc_dsl ) = (shift, shift);
583   $self->statuschg($svc_dsl,"UNSUSPEND");
584 }
585
586 1;