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 external_pkg_map { 1; }
  44
  45 sub location_types {
  46   (
  47     ''     => '(None)',
  48     'APT'  => 'Apartment',
  49     'BLDG' => 'Building',
  50     'FLR'  => 'Floor',
  51     'LOT'  => 'Lot',
  52     'RM'   => 'Room',
  53     'SLIP' => 'Slip',
  54     'SUIT' => 'Suite',
  55     'TRLR' => 'Trailer',
  56     'UNIT' => 'Unit',
  57     'WING' => 'Wing',
  58   );
  59 }
  60
  61 sub location_types_parse {
  62   my $class = shift;
  63   my %t = $class->location_types;
  64   delete $t{''};
  65   (
  66     (map { $_ => $_ } keys %t),
  67     (reverse %t),
  68     'STE' => 'SUIT', #USPS
  69   );
  70 }
  71
  72 sub dsl_pull {
  73 # we distinguish between invalid new data (return error) versus data that
  74 # has legitimately changed (may eventually execute hooks; now just update)
  75 # if we do add hooks later, we should work on a copy of svc_dsl and pass
  76 # the old and new svc_dsl to the hooks so they know what changed
  77 #
  78 # current assumptions of what won't change (from their side):
  79 # vendor_order_id, vendor_qual_id, vendor_order_type, pushed, monitored,
  80 # last_pull, address (from qual), contact info, ProductCustomId
  81     my($self, $svc_dsl, $threshold) = (shift, shift, shift);
  82     my $result = $self->valid_order($svc_dsl,'pull');
  83     return $result unless $result eq '';
  84
  85     my $now = time;
  86     if($now - $svc_dsl->last_pull < $threshold) {
  87         warn "$me skipping pull since threshold not reached (svcnum="
  88             . $svc_dsl->svcnum . ",now=$now,threshold=$threshold,last_pull="
  89             . $svc_dsl->last_pull .")" if $self->option('debug');
  90         return '';
  91     }
  92
  93     $result = $self->ikano_command('ORDERSTATUS',
  94         { OrderId => $svc_dsl->vendor_order_id } );
  95     return $result unless ref($result); # scalar (string) is an error
  96
  97     # now we're getting an OrderResponse which should have one Order in it
  98     warn "$me pull OrderResponse hash:\n".Dumper($result)
  99         if $self->option('debug');
 100
 101     return 'Invalid order response' unless defined $result->{'Order'};
 102     $result = $result->{'Order'};
 103
 104     return 'No order id or status returned'
 105         unless defined $result->{'Status'} && defined $result->{'OrderId'};
 106
 107     local $SIG{HUP} = 'IGNORE';
 108     local $SIG{INT} = 'IGNORE';
 109     local $SIG{QUIT} = 'IGNORE';
 110     local $SIG{TERM} = 'IGNORE';
 111     local $SIG{TSTP} = 'IGNORE';
 112     local $SIG{PIPE} = 'IGNORE';
 113
 114     my $oldAutoCommit = $FS::UID::AutoCommit;
 115     local $FS::UID::AutoCommit = 0;
 116     my $dbh = dbh;
 117
 118     # 1. status
 119     my $order_status = grep($_ eq $result->{'Status'}, @Net::Ikano::orderStatus)
 120                             ? $result->{'Status'} : '';
 121     return 'Invalid new status' if $order_status eq '';
 122     $svc_dsl->vendor_order_status($order_status)
 123         if($svc_dsl->vendor_order_status ne $order_status);
 124     $svc_dsl->monitored('')
 125             if ($order_status eq 'CANCELLED' || $order_status eq 'COMPLETED');
 126
 127     # 2. fields we don't care much about
 128     my %justUpdate = ( 'first' => 'FirstName',
 129                     'last' => 'LastName',
 130                     'company' => 'CompanyName',
 131                     'username' => 'Username',
 132                     'password' => 'Password' );
 133
 134     my($fsf, $ikanof);
 135     while (($fsf, $ikanof) = each %justUpdate) {
 136        $svc_dsl->$fsf($result->{$ikanof})
 137             if $result->{$ikanof} ne $svc_dsl->$fsf;
 138     }
 139
 140     # let's look inside the <Product> response element
 141     my @product = $result->{'Product'};
 142     return 'Invalid number of products on order' if scalar(@product) != 1;
 143     my $product = $result->{'Product'}[0];
 144
 145     # 3. phonenum
 146     if($svc_dsl->loop_type eq '') { # line-share
 147 # TN may change only if sub changes it and New or Change order in Completed status
 148         my $tn = $product->{'PhoneNumber'};
 149         if($tn ne $svc_dsl->phonenum) {
 150             if( ($svc_dsl->vendor_order_type eq 'NEW'
 151                 || $svc_dsl->vendor_order_type eq 'CHANGE')
 152                && $svc_dsl->vendor_order_status eq 'COMPLETED' ) {
 153                 $svc_dsl->phonenum($tn);
 154             }
 155             else { return 'TN has changed in an invalid state'; }
 156         }
 157     }
 158     elsif($svc_dsl->loop_type eq '0') { # dry loop
 159 # TN may change only if it's assigned while a New or Change order is in progress
 160         return 'Invalid PhoneNumber value for a dry loop'
 161             if $product->{'PhoneNumber'} ne 'STANDALONE';
 162         my $tn = $product->{'VirtualPhoneNumber'};
 163         if($tn ne $svc_dsl->phonenum) {
 164             if( ($svc_dsl->vendor_order_type eq 'NEW'
 165                 || $svc_dsl->vendor_order_type eq 'CHANGE')
 166               && $svc_dsl->vendor_order_status ne 'COMPLETED'
 167               && $svc_dsl->vendor_order_status ne 'CANCELLED') {
 168                 $svc_dsl->phonenum($tn);
 169             }
 170             else { return 'TN has changed in an invalid state'; }
 171         }
 172     }
 173
 174     # 4. desired_due_date - may change if manually changed
 175     if($svc_dsl->vendor_order_type eq 'NEW'
 176             || $svc_dsl->vendor_order_type eq 'CHANGE'){
 177         my $f = str2time($product->{'DateToOrder'});
 178         return 'Invalid DateToOrder' unless $f;
 179         $svc_dsl->desired_due_date($f) if $svc_dsl->desired_due_date ne $f;
 180         # XXX: optionally sync back to start_date or whatever...
 181     }
 182     elsif($svc_dsl->vendor_order_type eq 'CANCEL'){
 183         my $f = str2time($product->{'DateToDisconnect'});
 184         return 'Invalid DateToDisconnect' unless $f;
 185         $svc_dsl->desired_due_date($f) if $svc_dsl->desired_due_date ne $f;
 186         # XXX: optionally sync back to expire or whatever...
 187     }
 188
 189     # 5. due_date
 190     if($svc_dsl->vendor_order_type eq 'NEW'
 191           || $svc_dsl->vendor_order_type eq 'CHANGE') {
 192         my $f = str2time($product->{'ActivationDate'});
 193         if($svc_dsl->vendor_order_status ne 'NEW'
 194             && $svc_dsl->vendor_order_status ne 'CANCELLED') {
 195             return 'Invalid ActivationDate' unless $f;
 196             $svc_dsl->due_date($f) if $svc_dsl->due_date ne $f;
 197         }
 198     }
 199     # Ikano API does not implement the proper disconnect date,
 200     # so we can't do anything about it
 201
 202     # 6. staticips - for now just comma-separate them
 203     my $tstatics = $result->{'StaticIps'};
 204     my @istatics = defined $tstatics ? @$tstatics : ();
 205     my $ostatics = $svc_dsl->staticips;
 206     my @ostatics = split(',',$ostatics);
 207     # more horrible search/sync code below...
 208     my $staticsChanged = 0;
 209     foreach my $istatic ( @istatics ) { # they have, we don't
 210         unless ( grep($_ eq $istatic, @ostatics) ) {
 211             push @ostatics, $istatic;
 212             $staticsChanged = 1;
 213         }
 214     }
 215     for(my $i=0; $i < scalar(@ostatics); $i++) {
 216         unless ( grep($_ eq $ostatics[$i], @istatics) ) {
 217             splice(@ostatics,$i,1);
 218             $i--;
 219             $staticsChanged = 1;
 220         }
 221     }
 222     $svc_dsl->staticips(join(',',@ostatics)) if $staticsChanged;
 223
 224     # 7. notes - put them into the common format and compare
 225     my $tnotes = $result->{'OrderNotes'};
 226     my @tnotes = defined $tnotes ? @$tnotes : ();
 227     my @inotes = (); # all Ikano OrderNotes as FS::dsl_note objects
 228     my $notesChanged = 0;
 229     foreach my $tnote ( @tnotes ) {
 230         my $inote = $self->ikano2fsnote($tnote,$svc_dsl->svcnum);
 231         return 'Cannot parse note' unless ref($inote);
 232         push @inotes, $inote;
 233     }
 234     my @onotes = $svc_dsl->notes;
 235     # assume notes we already have don't change & no notes added from our side
 236     # so using the horrible code below just find what we're missing and add it
 237     my $error;
 238     foreach my $inote ( @inotes ) {
 239         my $found = 0;
 240         foreach my $onote ( @onotes ) {
 241             if($onote->date == $inote->date && $onote->note eq $inote->note) {
 242                 $found = 1;
 243                 last;
 244             }
 245         }
 246         $error = $inote->insert unless ( $found );
 247         if ( $error ) {
 248           $dbh->rollback if $oldAutoCommit;
 249           return "Cannot add note: $error";
 250         }
 251     }
 252
 253     $svc_dsl->last_pull((time));
 254     local $FS::svc_Common::noexport_hack = 1;
 255     $error = $svc_dsl->replace;
 256     if ( $error ) {
 257       $dbh->rollback if $oldAutoCommit;
 258       return "Cannot update DSL data: $error";
 259     }
 260
 261     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 262
 263     '';
 264 }
 265
 266 sub ikano2fsnote {
 267     my($self,$n,$svcnum) = (shift,shift,shift);
 268     my @ikanoRequired = qw( HighPriority StaffId Date Text CompanyStaffId );
 269     return '' unless defined $n->{'HighPriority'}
 270                 && defined $n->{'StaffId'}
 271                 && defined $n->{'CompanyStaffId'}
 272                 && defined $n->{'Date'}
 273                 && defined $n->{'Text'}
 274                 ;
 275     my $by = 'Unknown';
 276     $by = "Ikano" if $n->{'CompanyStaffId'} == -1 && $n->{'StaffId'} != -1;
 277     $by = "Us" if $n->{'StaffId'} == -1 && $n->{'CompanyStaffId'} != -1;
 278
 279     new FS::dsl_note( {
 280         'svcnum' => $svcnum,
 281         'author' => $by,
 282         'priority' => $n->{'HighPriority'} eq 'false' ? 'N' : 'H',
 283         '_date' => int(str2time($n->{'Date'})),
 284         'note' => $n->{'Text'},
 285      } );
 286 }
 287
 288 # address always required for Ikano qual, TN optional (assume dry if not given)
 289 sub qual {
 290     my($self,$qual) = (shift,shift);
 291
 292     my %location_hash = $qual->location_hash;
 293     return 'No address provided' unless keys %location_hash;
 294
 295     return 'Location kind is required' unless $location_hash{location_kind};
 296
 297     my $svctn = $qual->phonenum;
 298
 299     my $result = $self->ikano_command('PREQUAL',
 300       { AddressLine1 => $location_hash{address1},
 301         AddressUnitType => $location_hash{location_type},
 302         AddressUnitValue => $location_hash{location_number},
 303         AddressCity => $location_hash{city},
 304         AddressState => $location_hash{state},
 305         ZipCode => $location_hash{zip},
 306         Country => $location_hash{country},
 307         LocationType => $location_hash{location_kind},
 308         PhoneNumber => length($svctn) > 1 ? $svctn : "STANDALONE",
 309         RequestClientIP => '127.0.0.1',
 310         CheckNetworks => $self->option('check_networks'),
 311       } );
 312     return $result unless ref($result); # error case
 313     return 'Invalid prequal response' unless defined $result->{'PrequalId'};
 314
 315     my $qoptions = {};
 316     # lame data structure traversal...
 317     # don't spend much time here, just get TermsId and ProductCustomId
 318     my $networks = $result->{'Network'};
 319     my @networks = defined $networks ? @$networks : ();
 320     my $netcount = 0;
 321     foreach my $network ( @networks ) {
 322         my $productgroups = $network->{'ProductGroup'};
 323         my @productgroups = defined $productgroups ? @$productgroups : ();
 324         my $pgcount = 0;
 325         foreach my $productgroup ( @productgroups ) {
 326             my $prefix = "ikano_Network_$netcount"."_ProductGroup_$pgcount"."_";
 327             $qoptions->{$prefix."TermsId"} = $productgroup->{'TermsId'};
 328             my $products = $productgroup->{'Product'};
 329             my @products = defined $products ? @$products : ();
 330             my $prodcount = 0;
 331             foreach my $product ( @products ) {
 332                 $qoptions->{$prefix."Product_$prodcount"."_ProductCustomId"} = $product->{'ProductCustomId'};
 333                 $prodcount++;
 334             }
 335             $pgcount++;
 336         }
 337         $netcount++;
 338     }
 339
 340     {   'vendor_qual_id' => $result->{'PrequalId'},
 341         'status' => scalar(@networks) ? 'Q' : 'D',
 342         'options' => $qoptions,
 343     };
 344 }
 345
 346 sub qual_result {
 347     my($self,$qual) = (shift,shift);
 348
 349     my %qual_options = $qual->options;
 350     my @externalids = ();
 351     my( $optionname, $optionvalue );
 352     while (($optionname, $optionvalue) = each %qual_options) {
 353         push @externalids, $optionvalue
 354             if ( $optionname =~ /^ikano_Network_(\d+)_ProductGroup_(\d+)_Product_(\d+)_ProductCustomId$/
 355                 && $optionvalue ne '' );
 356     }
 357
 358     my %pkglist = ();
 359     my $result = { 'header' => 'Qualifying Packages',
 360                    'pkglist' => \%pkglist,
 361                  };
 362
 363     my @part_pkgs = qsearch( 'part_pkg', { 'disabled' => '' } );
 364     foreach my $part_pkg ( @part_pkgs ) {
 365         my %vendor_pkg_ids = $part_pkg->vendor_pkg_ids;
 366         my $externalid = $vendor_pkg_ids{$self->exportnum}
 367             if defined $vendor_pkg_ids{$self->exportnum};
 368         if ( $externalid && grep( $_ eq $externalid, @externalids )) {
 369             $pkglist{$part_pkg->pkgpart} = $part_pkg->pkg." - ".$part_pkg->comment;
 370         }
 371     }
 372
 373     $result;
 374 }
 375
 376 sub quals_by_cust_and_pkg {
 377     my($self, $custnum, $pkgpart) = (shift,shift,shift);
 378
 379     die "invalid custnum or pkgpart"
 380         unless ($custnum =~ /^\d+$/ && $pkgpart =~ /^\d+$/);
 381
 382     my $part_pkg = qsearchs('part_pkg', { 'pkgpart' => $pkgpart } );
 383     die "no part_pkg found" unless $part_pkg;
 384     my %vendor_pkg_ids = $part_pkg->vendor_pkg_ids;
 385     my $external_id = $vendor_pkg_ids{$self->exportnum};
 386     die "no vendor package id defined on this package" unless $external_id;
 387
 388     my $extra_sql = "where custnum = $custnum or locationnum in (select "
 389         . "locationnum from cust_location where custnum = $custnum)";
 390     my @quals = qsearch( { 'table' => 'qual', 'extra_sql' => $extra_sql, } );
 391
 392     my @filtered_quals;
 393     foreach my $qual ( @quals ) {
 394         my %qual_options = $qual->options;
 395         my( $optionname, $optionvalue );
 396         while (($optionname, $optionvalue) = each %qual_options) {
 397            push @filtered_quals, $qual
 398               if ( $optionname =~ /^ikano_Network_(\d+)_ProductGroup_(\d+)_Product_(\d+)_ProductCustomId$/
 399                     && $optionvalue eq $external_id );
 400         }
 401     }
 402
 403     @filtered_quals;
 404 }
 405
 406 sub notes_html {
 407     my($self,$svc_dsl) = (shift,shift);
 408     my $conf = new FS::Conf;
 409     my $date_format = $conf->config('date_format') || '%m/%d/%Y';
 410     my @notes = $svc_dsl->notes;
 411     my $html = '<TABLE border="1" cellspacing="2" cellpadding="2" id="dsl_notes">
 412         <TR><TH>Date</TH><TH>By</TH><TH>Priority</TH><TH>Note</TH></TR>';
 413     foreach my $note ( @notes ) {
 414         $html .= "<TR>
 415             <TD>".time2str("$date_format %H:%M",$note->date)."</TD>
 416             <TD>".$note->by."</TD>
 417             <TD>". ($note->priority eq 'N' ? 'Normal' : 'High') ."</TD>
 418             <TD>".$note->note."</TD></TR>";
 419     }
 420     $html .= '</TABLE>';
 421     $html;
 422 }
 423
 424 sub loop_type_long { # sub, not a method
 425     my($svc_dsl) = (shift);
 426     return $loopType{$svc_dsl->loop_type};
 427 }
 428
 429 sub ikano_command {
 430   my( $self, $command, $args ) = @_;
 431
 432   $self->loadmod;
 433
 434   my $ikano = Net::Ikano->new(
 435     'keyid' => $self->option('keyid'),
 436     'username'  => $self->option('username'),
 437     'password'  => $self->option('password'),
 438     'debug'    => $self->option('debug'),
 439   );
 440
 441   $ikano->$command($args);
 442 }
 443
 444 sub loadmod {
 445   eval "use Net::Ikano;";
 446   die $@ if $@;
 447 }
 448
 449 sub valid_order {
 450   my( $self, $svc_dsl, $action ) = (shift, shift, shift);
 451
 452   $self->loadmod;
 453
 454   warn "$me valid_order action=$action svc_dsl:\n". Dumper($svc_dsl)
 455         if $self->option('debug');
 456
 457   # common to all order types/status/loop_type
 458   my $error = !($svc_dsl->desired_due_date
 459             &&  grep($_ eq $svc_dsl->vendor_order_type, Net::Ikano->orderTypes)
 460             &&  $svc_dsl->first
 461             &&  $svc_dsl->last
 462             &&  defined $svc_dsl->loop_type
 463             &&  $svc_dsl->vendor_qual_id
 464             );
 465   return 'Missing or invalid order data' if $error;
 466
 467   my %vendor_pkg_ids = $svc_dsl->cust_svc->cust_pkg->part_pkg->vendor_pkg_ids;
 468   return 'Package does not have an external id configured'
 469     unless defined $vendor_pkg_ids{$self->exportnum};
 470
 471   return 'No valid qualification for this order'
 472     unless qsearch( 'qual', { 'vendor_qual_id' => $svc_dsl->vendor_qual_id });
 473
 474   # now go by order type
 475   # weird ifs & long lines for readability and ease of understanding - don't change
 476   if($svc_dsl->vendor_order_type eq 'NEW') {
 477     if($svc_dsl->pushed) {
 478         $error = !( ($action eq 'pull' || $action eq 'statuschg'
 479                         || $action eq 'delete' || $action eq 'expire')
 480             &&  length($svc_dsl->vendor_order_id) > 0
 481             &&  length($svc_dsl->vendor_order_status) > 0
 482                 );
 483         return 'Invalid order data' if $error;
 484
 485         return 'Phone number required for status change'
 486             if ($action eq 'statuschg' && length($svc_dsl->phonenum) < 1);
 487     }
 488     else { # unpushed New order - cannot do anything other than push it
 489         $error = !($action eq 'insert'
 490             &&  length($svc_dsl->vendor_order_id) < 1
 491             &&  length($svc_dsl->vendor_order_status) < 1
 492             && ( ($svc_dsl->phonenum eq '' && $svc_dsl->loop_type eq '0') # dry
 493               || ($svc_dsl->phonenum ne '' && $svc_dsl->loop_type eq '') # line-share
 494                )
 495             );
 496         return 'Invalid order data' if $error;
 497     }
 498   }
 499   elsif($svc_dsl->vendor_order_type eq 'CANCEL') {
 500   }
 501   elsif($svc_dsl->vendor_order_type eq 'CHANGE') {
 502   }
 503
 504  '';
 505 }
 506
 507 sub qual2termsid {
 508     my ($self,$vendor_qual_id,$ProductCustomId) = (shift,shift,shift);
 509     my $qual = qsearchs( 'qual', { 'vendor_qual_id' => $vendor_qual_id });
 510     return '' unless $qual;
 511     my %qual_options = $qual->options;
 512     my( $optionname, $optionvalue );
 513     while (($optionname, $optionvalue) = each %qual_options) {
 514         if ( $optionname =~ /^ikano_Network_(\d+)_ProductGroup_(\d+)_Product_(\d+)_ProductCustomId$/
 515             && $optionvalue eq $ProductCustomId ) {
 516             my $network = $1;
 517             my $productgroup = $2;
 518             return $qual->option("ikano_Network_".$network."_ProductGroup_".$productgroup."_TermsId");
 519         }
 520     }
 521     '';
 522 }
 523
 524 sub _export_insert {
 525   my( $self, $svc_dsl ) = (shift, shift);
 526
 527   my $result = $self->valid_order($svc_dsl,'insert');
 528   return $result unless $result eq '';
 529
 530   my $isp_chg = $svc_dsl->isp_chg eq 'Y' ? 'YES' : 'NO';
 531   my $contactTN = $svc_dsl->cust_svc->cust_pkg->cust_main->daytime;
 532   $contactTN =~ s/[^0-9]//g;
 533
 534   my %vendor_pkg_ids = $svc_dsl->cust_svc->cust_pkg->part_pkg->vendor_pkg_ids;
 535   my $ProductCustomId = $vendor_pkg_ids{$self->exportnum};
 536
 537   my $args = {
 538         orderType => 'NEW',
 539         ProductCustomId => $ProductCustomId,
 540         TermsId => $self->qual2termsid($svc_dsl->vendor_qual_id,$ProductCustomId),
 541         DSLPhoneNumber => $svc_dsl->loop_type eq '0' ? 'STANDALONE'
 542                                                     : $svc_dsl->phonenum,
 543         Password => $svc_dsl->password,
 544         PrequalId => $svc_dsl->vendor_qual_id,
 545         CompanyName => $svc_dsl->company,
 546         FirstName => $svc_dsl->first,
 547         LastName => $svc_dsl->last,
 548         MiddleName => '',
 549         ContactMethod => 'PHONE',
 550         ContactPhoneNumber => $contactTN,
 551         ContactEmail => 'x@x.xx',
 552         ContactFax => '',
 553         DateToOrder => time2str("%Y-%m-%d",$svc_dsl->desired_due_date),
 554         RequestClientIP => '127.0.0.1',
 555         IspChange => $isp_chg,
 556         IspPrevious => $isp_chg eq 'YES' ? $svc_dsl->isp_prev : '',
 557         CurrentProvider => $isp_chg eq 'NO' ? $svc_dsl->isp_prev : '',
 558   };
 559
 560   $result = $self->ikano_command('ORDER',$args);
 561   return $result unless ref($result); # scalar (string) is an error
 562
 563   # now we're getting an OrderResponse which should have one Order in it
 564   warn "$me _export_insert OrderResponse hash:\n".Dumper($result)
 565         if $self->option('debug');
 566
 567   return 'Invalid order response' unless defined $result->{'Order'};
 568   $result = $result->{'Order'};
 569
 570   return 'No/invalid order id or status returned'
 571     unless defined $result->{'Status'} && defined $result->{'OrderId'}
 572         && grep($_ eq $result->{'Status'}, @Net::Ikano::orderStatus);
 573
 574   $svc_dsl->pushed(time);
 575   $svc_dsl->last_pull((time)+1);
 576   $svc_dsl->vendor_order_id($result->{'OrderId'});
 577   $svc_dsl->vendor_order_status($result->{'Status'});
 578   $svc_dsl->username($result->{'Username'});
 579   local $FS::svc_Common::noexport_hack = 1;
 580   $result = $svc_dsl->replace;
 581   return "Error setting DSL fields: $result" if $result;
 582   '';
 583 }
 584
 585 sub _export_replace {
 586   my( $self, $new, $old ) = (shift, shift, shift);
 587 # XXX only supports password changes now, but should return error if
 588 # another change is attempted?
 589
 590   if($new->password ne $old->password) {
 591       my $result = $self->valid_order($new,'statuschg');
 592       return $result unless $result eq '';
 593
 594       $result = $self->ikano_command('PASSWORDCHANGE',
 595             { DSLPhoneNumber => $new->phonenum,
 596               NewPassword => $new->password,
 597             } );
 598       return $result unless ref($result); # scalar (string) is an error
 599
 600       return 'Error changing password' unless defined $result->{'Password'}
 601         && $result->{'Password'} eq $new->password;
 602   }
 603
 604   '';
 605 }
 606
 607 sub _export_delete {
 608   my( $self, $svc_dsl ) = (shift, shift);
 609
 610   my $result = $self->valid_order($svc_dsl,'delete');
 611   return $result unless $result eq '';
 612
 613   # for now allow an immediate cancel only on New orders in New/Pending status
 614   #XXX: add support for Change and Cancel orders in New/Pending status later
 615
 616   if($svc_dsl->vendor_order_type eq 'NEW') {
 617     if($svc_dsl->vendor_order_status eq 'NEW'
 618             || $svc_dsl->vendor_order_status eq 'PENDING') {
 619         my $result = $self->ikano_command('CANCEL',
 620             { OrderId => $svc_dsl->vendor_order_id, } );
 621         return $result unless ref($result); # scalar (string) is an error
 622         return 'Unable to cancel order' unless $result->{'Order'};
 623         $result = $result->{'Order'};
 624         return 'Invalid cancellation response'
 625             unless $result->{'Status'} eq 'CANCELLED'
 626                 && $result->{'OrderId'} eq $svc_dsl->vendor_order_id;
 627
 628         # we're supposed to do a pull, but it will break everything, so don't
 629         # this is very wrong...
 630     }
 631     else {
 632         return "Cannot cancel a NEW order unless it's in NEW or PENDING status";
 633     }
 634   }
 635   elsif($svc_dsl->vendor_order_type eq 'CANCEL') {
 636      return 'Cannot cancel a CANCEL order unless expire was set'
 637         unless $svc_dsl->cust_svc->cust_pkg->expire > 0;
 638   }
 639   else {
 640     return 'Canceling orders other than NEW orders is not currently implemented';
 641   }
 642
 643   '';
 644 }
 645
 646 sub export_expire {
 647   my($self, $svc_dsl, $date) = (shift, shift, shift);
 648
 649   my $result = $self->valid_order($svc_dsl,'expire');
 650   return $result unless $result eq '';
 651
 652   # for now allow a proper cancel only on New orders in Completed status
 653   #XXX: add support for some other cases in future
 654
 655   if($svc_dsl->vendor_order_type eq 'NEW'
 656         && $svc_dsl->vendor_order_status eq 'COMPLETED') {
 657
 658           my $contactTN = $svc_dsl->cust_svc->cust_pkg->cust_main->daytime;
 659           $contactTN =~ s/[^0-9]//g;
 660
 661           my %vendor_pkg_ids = $svc_dsl->cust_svc->cust_pkg->part_pkg->vendor_pkg_ids;
 662           my $ProductCustomId = $vendor_pkg_ids{$self->exportnum};
 663
 664           # we are now a cancel order
 665           $svc_dsl->desired_due_date($date);
 666           $svc_dsl->vendor_order_type('CANCEL');
 667
 668           my $args = {
 669                 orderType => 'CANCEL',
 670                 ProductCustomId => $ProductCustomId,
 671                 TermsId => $self->qual2termsid($svc_dsl->vendor_qual_id,$ProductCustomId),
 672                 DSLPhoneNumber => $svc_dsl->loop_type eq '0' ? 'STANDALONE'
 673                                                             : $svc_dsl->phonenum,
 674                 Password => $svc_dsl->password,
 675                 PrequalId => $svc_dsl->vendor_qual_id,
 676                 CompanyName => $svc_dsl->company,
 677                 FirstName => $svc_dsl->first,
 678                 LastName => $svc_dsl->last,
 679                 MiddleName => '',
 680                 ContactMethod => 'PHONE',
 681                 ContactPhoneNumber => $contactTN,
 682                 ContactEmail => 'x@x.xx',
 683                 ContactFax => '',
 684                 DateToOrder => time2str("%Y-%m-%d",$date),
 685                 RequestClientIP => '127.0.0.1',
 686                 IspChange => 'NO',
 687                 IspPrevious => '',
 688                 CurrentProvider => '',
 689           };
 690
 691           $args->{'VirtualPhoneNumber'} = $svc_dsl->phonenum
 692             if $svc_dsl->loop_type eq '0';
 693
 694           $result = $self->ikano_command('ORDER',$args);
 695           return $result unless ref($result); # scalar (string) is an error
 696
 697           # now we're getting an OrderResponse which should have one Order in it
 698           warn "$me _export_insert OrderResponse hash:\n".Dumper($result)
 699                 if $self->option('debug');
 700
 701           return 'Invalid order response' unless defined $result->{'Order'};
 702           $result = $result->{'Order'};
 703
 704           return 'No/invalid order id or status returned'
 705             unless defined $result->{'Status'} && defined $result->{'OrderId'}
 706                 && grep($_ eq $result->{'Status'}, @Net::Ikano::orderStatus);
 707
 708           $svc_dsl->pushed(time);
 709           $svc_dsl->last_pull((time)+1);
 710           $svc_dsl->vendor_order_id($result->{'OrderId'});
 711           $svc_dsl->vendor_order_status($result->{'Status'});
 712           $svc_dsl->monitored('Y');
 713           local $FS::svc_Common::noexport_hack = 1;
 714           $result = $svc_dsl->replace;
 715           return "Error setting DSL fields: $result" if $result;
 716   }
 717   else {
 718     return "Cancelling anything other than NEW orders in COMPLETED status is "
 719         . "not currently implemented";
 720   }
 721  '';
 722 }
 723
 724 sub statuschg {
 725   my( $self, $svc_dsl, $type ) = (shift, shift, shift);
 726
 727   my $result = $self->valid_order($svc_dsl,'statuschg');
 728   return $result unless $result eq '';
 729
 730   # get the DSLServiceId
 731   $result = $self->ikano_command('CUSTOMERLOOKUP',
 732         { PhoneNumber => $svc_dsl->phonenum } );
 733   return $result unless ref($result); # scalar (string) is an error
 734   return 'No DSLServiceId found' unless defined $result->{'DSLServiceId'};
 735   my $DSLServiceId = $result->{'DSLServiceId'};
 736
 737   $result = $self->ikano_command('ACCOUNTSTATUSCHANGE',
 738         { DSLPhoneNumber => $svc_dsl->phonenum,
 739           DSLServiceId => $DSLServiceId,
 740           type => $type,
 741         } );
 742   return $result unless ref($result); # scalar (string) is an error
 743   '';
 744 }
 745
 746 sub _export_suspend {
 747   my( $self, $svc_dsl ) = (shift, shift);
 748   $self->statuschg($svc_dsl,"SUSPEND");
 749 }
 750
 751 sub _export_unsuspend {
 752   my( $self, $svc_dsl ) = (shift, shift);
 753   $self->statuschg($svc_dsl,"UNSUSPEND");
 754 }
 755
 756 1;