X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_export%2Fikano.pm;h=68b1a9fded937462db91960c23e182d2fce71be7;hb=38e34bbc53a4222c7507e95914e1364a5a74623f;hp=73f962c2c628aadedd7450a69932c0c539c59a07;hpb=83c6bcc0a22bf4d5c5571a4183b9971a81686a25;p=freeside.git diff --git a/FS/FS/part_export/ikano.pm b/FS/FS/part_export/ikano.pm index 73f962c2c..68b1a9fde 100644 --- a/FS/FS/part_export/ikano.pm +++ b/FS/FS/part_export/ikano.pm @@ -10,6 +10,7 @@ use FS::Record qw(qsearch qsearchs dbh); use FS::part_export; use FS::svc_dsl; use Data::Dumper; +use Carp qw(carp); @ISA = qw(FS::part_export); $me= '[' . __PACKAGE__ . ']'; @@ -24,12 +25,14 @@ tie my %options, 'Tie::IxHash', default => 'ATT,BELLCA', }, 'debug' => { label => 'Debug Mode', type => 'checkbox' }, + 'import' => { label => 'Import Mode', type => 'checkbox' }, ; %info = ( 'svc' => 'svc_dsl', 'desc' => 'Provision DSL to Ikano', 'options' => \%options, + 'no_machine' => 1, 'notes' => <<'END' Requires installation of Net::Ikano from CPAN. @@ -40,6 +43,40 @@ END sub rebless { shift; } +sub external_pkg_map { 1; } + +sub location_types { + ( + '' => '(None)', + 'APT' => 'Apartment', + 'BLDG' => 'Building', + 'FLR' => 'Floor', + 'LOT' => 'Lot', + 'RM' => 'Room', + 'SLIP' => 'Slip', + 'SUIT' => 'Suite', + 'TRLR' => 'Trailer', + 'UNIT' => 'Unit', + 'WING' => 'Wing', + ); +} + +sub location_types_parse { + my $class = shift; + my %t = $class->location_types; + delete $t{''}; + ( + (map { $_ => $_ } keys %t), + (reverse %t), + 'STE' => 'SUIT', #USPS + ); +} + +sub import_mode { + my $self = shift; + $self->option('import'); +} + sub dsl_pull { # we distinguish between invalid new data (return error) versus data that # has legitimately changed (may eventually execute hooks; now just update) @@ -49,13 +86,30 @@ sub dsl_pull { # current assumptions of what won't change (from their side): # vendor_order_id, vendor_qual_id, vendor_order_type, pushed, monitored, # last_pull, address (from qual), contact info, ProductCustomId - my($self, $svc_dsl) = (shift, shift); - $self->loadmod; - my $result = $self->valid_order($svc_dsl,'pull'); - return $result unless $result eq ''; + my($self, $svc_dsl, $threshold, $import) = (shift, shift, shift, shift); + + return 'Invalid operation - Import Mode is enabled' + if $self->import_mode && !$import; + + return 'invalid arguments' if $import && !$self->import_mode; + + warn "$me dsl_pull: import mode" if $self->option('debug'); + + unless ( $import ) { + my $result = $self->valid_order($svc_dsl,'pull'); + return $result unless $result eq ''; + } + + my $now = time; + if($now - $svc_dsl->last_pull < $threshold) { + warn "$me skipping pull since threshold not reached (svcnum=" + . $svc_dsl->svcnum . ",now=$now,threshold=$threshold,last_pull=" + . $svc_dsl->last_pull .")" if $self->option('debug'); + return ''; + } - $result = $self->ikano_command('ORDERSTATUS', - { OrderId => $svc_dsl->vendor_order_id } ); + my $result = $self->ikano_command('ORDERSTATUS', + { OrderId => $svc_dsl->vendor_order_id } ); return $result unless ref($result); # scalar (string) is an error # now we're getting an OrderResponse which should have one Order in it @@ -106,8 +160,20 @@ sub dsl_pull { return 'Invalid number of products on order' if scalar(@product) != 1; my $product = $result->{'Product'}[0]; + $svc_dsl->vendor_order_type('NEW') if $import; # lame + # 3. phonenum - if($svc_dsl->loop_type eq '') { # line-share + if ( $import ) { + if ( $product->{'PhoneNumber'} eq 'STANDALONE' ) { + $svc_dsl->phonenum($product->{'VirtualPhoneNumber'}); + $svc_dsl->loop_type('0'); + } + else { + $svc_dsl->phonenum($product->{'PhoneNumber'}); + $svc_dsl->loop_type(''); + } + } + elsif($svc_dsl->loop_type eq '') { # line-share # TN may change only if sub changes it and New or Change order in Completed status my $tn = $product->{'PhoneNumber'}; if($tn ne $svc_dsl->phonenum) { @@ -198,7 +264,6 @@ sub dsl_pull { my @onotes = $svc_dsl->notes; # assume notes we already have don't change & no notes added from our side # so using the horrible code below just find what we're missing and add it - my $error; foreach my $inote ( @inotes ) { my $found = 0; foreach my $onote ( @onotes ) { @@ -207,7 +272,7 @@ sub dsl_pull { last; } } - $error = $inote->insert unless ( $found ); + my $error = $inote->insert unless ( $found ); if ( $error ) { $dbh->rollback if $oldAutoCommit; return "Cannot add note: $error"; @@ -216,7 +281,7 @@ sub dsl_pull { $svc_dsl->last_pull((time)); local $FS::svc_Common::noexport_hack = 1; - $error = $svc_dsl->replace; + my $error = $svc_dsl->replace; if ( $error ) { $dbh->rollback if $oldAutoCommit; return "Cannot update DSL data: $error"; @@ -242,33 +307,140 @@ sub ikano2fsnote { new FS::dsl_note( { 'svcnum' => $svcnum, - 'by' => $by, + 'author' => $by, 'priority' => $n->{'HighPriority'} eq 'false' ? 'N' : 'H', - 'date' => int(str2time($n->{'Date'})), + '_date' => int(str2time($n->{'Date'})), 'note' => $n->{'Text'}, } ); } +# address always required for Ikano qual, TN optional (assume dry if not given) sub qual { - ''; + my($self,$qual) = (shift,shift); + + return 'Invalid operation - Import Mode is enabled' if $self->import_mode; + + my %location_hash = $qual->location_hash; + return 'No address provided' unless keys %location_hash; + + return 'Location kind is required' unless $location_hash{location_kind}; + + my $svctn = $qual->phonenum; + + my $zip = $location_hash{zip}; + $zip =~ s/(\d{5})-\d{4}/$1/; + + my $result = $self->ikano_command('PREQUAL', + { AddressLine1 => $location_hash{address1}, + AddressUnitType => $location_hash{location_type}, + AddressUnitValue => $location_hash{location_number}, + AddressCity => $location_hash{city}, + AddressState => $location_hash{state}, + ZipCode => $zip, + Country => $location_hash{country}, + LocationType => $location_hash{location_kind}, + PhoneNumber => length($svctn) > 1 ? $svctn : "STANDALONE", + RequestClientIP => '127.0.0.1', + CheckNetworks => $self->option('check_networks'), + } ); + return $result unless ref($result); # error case + return 'Invalid prequal response' unless defined $result->{'PrequalId'}; + + my $qoptions = {}; + # lame data structure traversal... + # don't spend much time here, just get TermsId and ProductCustomId + my $networks = $result->{'Network'}; + my @networks = defined $networks ? @$networks : (); + my $netcount = 0; + foreach my $network ( @networks ) { + my $productgroups = $network->{'ProductGroup'}; + my @productgroups = defined $productgroups ? @$productgroups : (); + my $pgcount = 0; + foreach my $productgroup ( @productgroups ) { + my $prefix = "ikano_Network_$netcount"."_ProductGroup_$pgcount"."_"; + $qoptions->{$prefix."TermsId"} = $productgroup->{'TermsId'}; + my $products = $productgroup->{'Product'}; + my @products = defined $products ? @$products : (); + my $prodcount = 0; + foreach my $product ( @products ) { + $qoptions->{$prefix."Product_$prodcount"."_ProductCustomId"} = $product->{'ProductCustomId'}; + $prodcount++; + } + $pgcount++; + } + $netcount++; + } + + { 'vendor_qual_id' => $result->{'PrequalId'}, + 'status' => scalar(@networks) ? 'Q' : 'D', + 'options' => $qoptions, + }; } -sub notes_html { - my($self,$svc_dsl) = (shift,shift); - my $conf = new FS::Conf; - my $date_format = $conf->config('date_format') || '%m/%d/%Y'; - my @notes = $svc_dsl->notes; - my $html = ' - '; - foreach my $note ( @notes ) { - $html .= " - - - - "; +sub qual_result { + my($self,$qual) = (shift,shift); + + my %qual_options = $qual->options; + my @externalids = (); + my( $optionname, $optionvalue ); + while (($optionname, $optionvalue) = each %qual_options) { + push @externalids, $optionvalue + if ( $optionname =~ /^ikano_Network_(\d+)_ProductGroup_(\d+)_Product_(\d+)_ProductCustomId$/ + && $optionvalue ne '' ); + } + + my %pkglist = (); + my %found = (); + my @part_pkgs = qsearch( 'part_pkg', { 'disabled' => '' } ); + foreach my $part_pkg ( @part_pkgs ) { + my %vendor_pkg_ids = $part_pkg->vendor_pkg_ids; + my $externalid = $vendor_pkg_ids{$self->exportnum} + if defined $vendor_pkg_ids{$self->exportnum}; + if ( $externalid && grep { $_ eq $externalid } @externalids ) { + $pkglist{$part_pkg->pkgpart} = $part_pkg->pkg_comment; + $found{$externalid}++; + } } - $html .= '
DateByPriorityNote
".time2str("$date_format %H:%M",$note->date)."".$note->by."". ($note->priority eq 'N' ? 'Normal' : 'High') ."".$note->note."
'; - $html; + + my %not_avail = (); + foreach my $externalid ( grep !$found{$_}, @externalids ) { + $not_avail{$externalid} = $externalid; #a better label? + } + + { + 'pkglist' => \%pkglist, + 'not_avail' => \%not_avail, + }; +} + +sub quals_by_cust_and_pkg { + my($self, $custnum, $pkgpart) = (shift,shift,shift); + + die "invalid custnum or pkgpart" + unless ($custnum =~ /^\d+$/ && $pkgpart =~ /^\d+$/); + + my $part_pkg = qsearchs('part_pkg', { 'pkgpart' => $pkgpart } ); + die "no part_pkg found" unless $part_pkg; + my %vendor_pkg_ids = $part_pkg->vendor_pkg_ids; + my $external_id = $vendor_pkg_ids{$self->exportnum}; + die "no vendor package id defined on this package" unless $external_id; + + my $extra_sql = "where custnum = $custnum or locationnum in (select " + . "locationnum from cust_location where custnum = $custnum)"; + my @quals = qsearch( { 'table' => 'qual', 'extra_sql' => $extra_sql, } ); + + my @filtered_quals; + foreach my $qual ( @quals ) { + my %qual_options = $qual->options; + my( $optionname, $optionvalue ); + while (($optionname, $optionvalue) = each %qual_options) { + push @filtered_quals, $qual + if ( $optionname =~ /^ikano_Network_(\d+)_ProductGroup_(\d+)_Product_(\d+)_ProductCustomId$/ + && $optionvalue eq $external_id ); + } + } + + @filtered_quals; } sub loop_type_long { # sub, not a method @@ -305,17 +477,17 @@ sub valid_order { if $self->option('debug'); # common to all order types/status/loop_type - my $error = !($svc_dsl->desired_due_date - && grep($_ eq $svc_dsl->vendor_order_type, Net::Ikano->orderTypes) - && $svc_dsl->first - && $svc_dsl->last - && defined $svc_dsl->loop_type - && $svc_dsl->vendor_qual_id - ); - return 'Missing or invalid order data' if $error; - + return 'No desired_due_date' unless $svc_dsl->desired_due_date; + return 'Unknown vendor_order_type' + unless grep $_ eq $svc_dsl->vendor_order_type, Net::Ikano->orderTypes; + return 'No first name' unless $svc_dsl->first; + return 'No last name' unless $svc_dsl->get('last'); + return 'No loop type' unless defined $svc_dsl->loop_type; + return 'No vendor_qual_id' unless $svc_dsl->vendor_qual_id; + + my %vendor_pkg_ids = $svc_dsl->cust_svc->cust_pkg->part_pkg->vendor_pkg_ids; return 'Package does not have an external id configured' - if $svc_dsl->cust_svc->cust_pkg->part_pkg->options('externalid',1) eq ''; + unless defined $vendor_pkg_ids{$self->exportnum}; return 'No valid qualification for this order' unless qsearch( 'qual', { 'vendor_qual_id' => $svc_dsl->vendor_qual_id }); @@ -324,8 +496,8 @@ sub valid_order { # weird ifs & long lines for readability and ease of understanding - don't change if($svc_dsl->vendor_order_type eq 'NEW') { if($svc_dsl->pushed) { - $error = !( ($action eq 'pull' || $action eq 'statuschg' - || $action eq 'delete') + my $error = !( ($action eq 'pull' || $action eq 'statuschg' + || $action eq 'delete' || $action eq 'expire') && length($svc_dsl->vendor_order_id) > 0 && length($svc_dsl->vendor_order_status) > 0 ); @@ -335,7 +507,7 @@ sub valid_order { if ($action eq 'statuschg' && length($svc_dsl->phonenum) < 1); } else { # unpushed New order - cannot do anything other than push it - $error = !($action eq 'insert' + my $error = !($action eq 'insert' && length($svc_dsl->vendor_order_id) < 1 && length($svc_dsl->vendor_order_status) < 1 && ( ($svc_dsl->phonenum eq '' && $svc_dsl->loop_type eq '0') # dry @@ -373,16 +545,23 @@ sub qual2termsid { sub _export_insert { my( $self, $svc_dsl ) = (shift, shift); - $self->loadmod; + if($self->import_mode) { + warn "$me _export_insert: import mode" if $self->option('debug'); + $svc_dsl->pushed((time)-2); + $svc_dsl->last_pull((time)-1); + return $self->dsl_pull($svc_dsl,0,1); + } my $result = $self->valid_order($svc_dsl,'insert'); return $result unless $result eq ''; my $isp_chg = $svc_dsl->isp_chg eq 'Y' ? 'YES' : 'NO'; - my $contactTN = $svc_dsl->cust_svc->cust_pkg->cust_main->daytime; + my $cust_main = $svc_dsl->cust_svc->cust_pkg->cust_main; + my $contactTN = $cust_main->daytime || $cust_main->night || '5555555555'; $contactTN =~ s/[^0-9]//g; - my $ProductCustomId = $svc_dsl->cust_svc->cust_pkg->part_pkg->option('externalid',1); + my %vendor_pkg_ids = $svc_dsl->cust_svc->cust_pkg->part_pkg->vendor_pkg_ids; + my $ProductCustomId = $vendor_pkg_ids{$self->exportnum}; my $args = { orderType => 'NEW', @@ -434,6 +613,9 @@ sub _export_insert { sub _export_replace { my( $self, $new, $old ) = (shift, shift, shift); + + return 'Invalid operation - Import Mode is enabled' if $self->import_mode; + # XXX only supports password changes now, but should return error if # another change is attempted? @@ -457,11 +639,13 @@ sub _export_replace { sub _export_delete { my( $self, $svc_dsl ) = (shift, shift); + return 'Invalid operation - Import Mode is enabled' if $self->import_mode; + my $result = $self->valid_order($svc_dsl,'delete'); return $result unless $result eq ''; # for now allow an immediate cancel only on New orders in New/Pending status - #XXX: add support for Chance and Cancel orders in New/Pending status later + #XXX: add support for Change and Cancel orders in New/Pending status later if($svc_dsl->vendor_order_type eq 'NEW') { if($svc_dsl->vendor_order_status eq 'NEW' @@ -469,13 +653,23 @@ sub _export_delete { my $result = $self->ikano_command('CANCEL', { OrderId => $svc_dsl->vendor_order_id, } ); return $result unless ref($result); # scalar (string) is an error - - return $self->dsl_pull($svc_dsl); + return 'Unable to cancel order' unless $result->{'Order'}; + $result = $result->{'Order'}; + return 'Invalid cancellation response' + unless $result->{'Status'} eq 'CANCELLED' + && $result->{'OrderId'} eq $svc_dsl->vendor_order_id; + + # we're supposed to do a pull, but it will break everything, so don't + # this is very wrong... } else { return "Cannot cancel a NEW order unless it's in NEW or PENDING status"; } } + elsif($svc_dsl->vendor_order_type eq 'CANCEL') { + return 'Cannot cancel a CANCEL order unless expire was set' + unless $svc_dsl->cust_svc->cust_pkg->expire > 0; + } else { return 'Canceling orders other than NEW orders is not currently implemented'; } @@ -483,8 +677,96 @@ sub _export_delete { ''; } +sub export_expire { + my($self, $svc_dsl, $date) = (shift, shift, shift); + + if ( $FS::svc_Common::noexport_hack ) { + carp 'export_expire() suppressed by noexport_hack' + if $self->option('debug'); + return; + } + + return 'Invalid operation - Import Mode is enabled' if $self->import_mode; + + my $result = $self->valid_order($svc_dsl,'expire'); + return $result unless $result eq ''; + + # for now allow a proper cancel only on New orders in Completed status + #XXX: add support for some other cases in future + + if($svc_dsl->vendor_order_type eq 'NEW' + && $svc_dsl->vendor_order_status eq 'COMPLETED') { + + my $contactTN = $svc_dsl->cust_svc->cust_pkg->cust_main->daytime; + $contactTN =~ s/[^0-9]//g; + + my %vendor_pkg_ids = $svc_dsl->cust_svc->cust_pkg->part_pkg->vendor_pkg_ids; + my $ProductCustomId = $vendor_pkg_ids{$self->exportnum}; + + # we are now a cancel order + $svc_dsl->desired_due_date($date); + $svc_dsl->vendor_order_type('CANCEL'); + + my $args = { + orderType => 'CANCEL', + ProductCustomId => $ProductCustomId, + TermsId => $self->qual2termsid($svc_dsl->vendor_qual_id,$ProductCustomId), + DSLPhoneNumber => $svc_dsl->loop_type eq '0' ? 'STANDALONE' + : $svc_dsl->phonenum, + Password => $svc_dsl->password, + PrequalId => $svc_dsl->vendor_qual_id, + CompanyName => $svc_dsl->company, + FirstName => $svc_dsl->first, + LastName => $svc_dsl->last, + MiddleName => '', + ContactMethod => 'PHONE', + ContactPhoneNumber => $contactTN, + ContactEmail => 'x@x.xx', + ContactFax => '', + DateToOrder => time2str("%Y-%m-%d",$date), + RequestClientIP => '127.0.0.1', + IspChange => 'NO', + IspPrevious => '', + CurrentProvider => '', + }; + + $args->{'VirtualPhoneNumber'} = $svc_dsl->phonenum + if $svc_dsl->loop_type eq '0'; + + $result = $self->ikano_command('ORDER',$args); + return $result unless ref($result); # scalar (string) is an error + + # now we're getting an OrderResponse which should have one Order in it + warn "$me _export_insert OrderResponse hash:\n".Dumper($result) + if $self->option('debug'); + + return 'Invalid order response' unless defined $result->{'Order'}; + $result = $result->{'Order'}; + + return 'No/invalid order id or status returned' + unless defined $result->{'Status'} && defined $result->{'OrderId'} + && grep($_ eq $result->{'Status'}, @Net::Ikano::orderStatus); + + $svc_dsl->pushed(time); + $svc_dsl->last_pull((time)+1); + $svc_dsl->vendor_order_id($result->{'OrderId'}); + $svc_dsl->vendor_order_status($result->{'Status'}); + $svc_dsl->monitored('Y'); + local $FS::svc_Common::noexport_hack = 1; + $result = $svc_dsl->replace; + return "Error setting DSL fields: $result" if $result; + } + else { + return "Cancelling anything other than NEW orders in COMPLETED status is " + . "not currently implemented"; + } + ''; +} + sub statuschg { my( $self, $svc_dsl, $type ) = (shift, shift, shift); + + return 'Invalid operation - Import Mode is enabled' if $self->import_mode; my $result = $self->valid_order($svc_dsl,'statuschg'); return $result unless $result eq '';