package FS::part_export::ikano;
-use vars qw(@ISA %info %orderType %orderStatus %loopType $DEBUG $me);
+use strict;
+use warnings;
+use vars qw(@ISA %info %loopType $me);
use Tie::IxHash;
use Date::Format qw( time2str );
-use FS::Record qw(qsearch qsearchs);
+use Date::Parse qw( str2time );
+use FS::Record qw(qsearch qsearchs dbh);
use FS::part_export;
use FS::svc_dsl;
use Data::Dumper;
@ISA = qw(FS::part_export);
-$DEBUG = 1;
$me= '[' . __PACKAGE__ . ']';
tie my %options, 'Tie::IxHash',
'check_networks' => { label => 'Check Networks',
default => 'ATT,BELLCA',
},
+ 'debug' => { label => 'Debug Mode', type => 'checkbox' },
;
%info = (
END
);
-%orderType = ( 'N' => 'NEW', 'X' => 'CANCEL', 'C' => 'CHANGE' );
-%orderStatus = ('N' => 'NEW',
- 'P' => 'PENDING',
- 'X' => 'CANCELLED',
- 'C' => 'COMPLETED',
- 'E' => 'ERROR' );
%loopType = ( '' => 'Line-share', '0' => 'Standalone' );
sub rebless { shift; }
sub dsl_pull {
+# we distinguish between invalid new data (return error) versus data that
+# has legitimately changed (may eventually execute hooks; now just update)
+# if we do add hooks later, we should work on a copy of svc_dsl and pass
+# the old and new svc_dsl to the hooks so they know what changed
+#
+# 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 '';
+
+ $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
+ warn "$me pull OrderResponse hash:\n".Dumper($result)
+ if $self->option('debug');
+
+ return 'Invalid order response' unless defined $result->{'Order'};
+ $result = $result->{'Order'};
+
+ return 'No order id or status returned'
+ unless defined $result->{'Status'} && defined $result->{'OrderId'};
+
+ local $SIG{HUP} = 'IGNORE';
+ local $SIG{INT} = 'IGNORE';
+ local $SIG{QUIT} = 'IGNORE';
+ local $SIG{TERM} = 'IGNORE';
+ local $SIG{TSTP} = 'IGNORE';
+ local $SIG{PIPE} = 'IGNORE';
+
+ my $oldAutoCommit = $FS::UID::AutoCommit;
+ local $FS::UID::AutoCommit = 0;
+ my $dbh = dbh;
+
+ # 1. status
+ my $order_status = grep($_ eq $result->{'Status'}, @Net::Ikano::orderStatus)
+ ? $result->{'Status'} : '';
+ return 'Invalid new status' if $order_status eq '';
+ $svc_dsl->vendor_order_status($order_status)
+ if($svc_dsl->vendor_order_status ne $order_status);
+ $svc_dsl->monitored('')
+ if ($order_status eq 'CANCELLED' || $order_status eq 'COMPLETED');
+
+ # 2. fields we don't care much about
+ my %justUpdate = ( 'first' => 'FirstName',
+ 'last' => 'LastName',
+ 'company' => 'CompanyName',
+ 'username' => 'Username',
+ 'password' => 'Password' );
+
+ my($fsf, $ikanof);
+ while (($fsf, $ikanof) = each %justUpdate) {
+ $svc_dsl->$fsf($result->{$ikanof})
+ if $result->{$ikanof} ne $svc_dsl->$fsf;
+ }
+
+ # let's look inside the <Product> response element
+ my @product = $result->{'Product'};
+ return 'Invalid number of products on order' if scalar(@product) != 1;
+ my $product = $result->{'Product'}[0];
+
+ # 3. phonenum
+ if($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) {
+ if( ($svc_dsl->vendor_order_type eq 'NEW'
+ || $svc_dsl->vendor_order_type eq 'CHANGE')
+ && $svc_dsl->vendor_order_status eq 'COMPLETED' ) {
+ $svc_dsl->phonenum($tn);
+ }
+ else { return 'TN has changed in an invalid state'; }
+ }
+ }
+ elsif($svc_dsl->loop_type eq '0') { # dry loop
+# TN may change only if it's assigned while a New or Change order is in progress
+ return 'Invalid PhoneNumber value for a dry loop'
+ if $product->{'PhoneNumber'} ne 'STANDALONE';
+ my $tn = $product->{'VirtualPhoneNumber'};
+ if($tn ne $svc_dsl->phonenum) {
+ if( ($svc_dsl->vendor_order_type eq 'NEW'
+ || $svc_dsl->vendor_order_type eq 'CHANGE')
+ && $svc_dsl->vendor_order_status ne 'COMPLETED'
+ && $svc_dsl->vendor_order_status ne 'CANCELLED') {
+ $svc_dsl->phonenum($tn);
+ }
+ else { return 'TN has changed in an invalid state'; }
+ }
+ }
+
+ # 4. desired_due_date - may change if manually changed
+ if($svc_dsl->vendor_order_type eq 'NEW'
+ || $svc_dsl->vendor_order_type eq 'CHANGE'){
+ my $f = str2time($product->{'DateToOrder'});
+ return 'Invalid DateToOrder' unless $f;
+ $svc_dsl->desired_due_date($f) if $svc_dsl->desired_due_date ne $f;
+ # XXX: optionally sync back to start_date or whatever...
+ }
+ elsif($svc_dsl->vendor_order_type eq 'CANCEL'){
+ my $f = str2time($product->{'DateToDisconnect'});
+ return 'Invalid DateToDisconnect' unless $f;
+ $svc_dsl->desired_due_date($f) if $svc_dsl->desired_due_date ne $f;
+ # XXX: optionally sync back to expire or whatever...
+ }
+
+ # 5. due_date
+ if($svc_dsl->vendor_order_type eq 'NEW'
+ || $svc_dsl->vendor_order_type eq 'CHANGE') {
+ my $f = str2time($product->{'ActivationDate'});
+ if($svc_dsl->vendor_order_status ne 'NEW'
+ && $svc_dsl->vendor_order_status ne 'CANCELLED') {
+ return 'Invalid ActivationDate' unless $f;
+ $svc_dsl->due_date($f) if $svc_dsl->due_date ne $f;
+ }
+ }
+ # Ikano API does not implement the proper disconnect date,
+ # so we can't do anything about it
+
+ # 6. staticips - for now just comma-separate them
+ my $tstatics = $result->{'StaticIps'};
+ my @istatics = defined $tstatics ? @$tstatics : ();
+ my $ostatics = $svc_dsl->staticips;
+ my @ostatics = split(',',$ostatics);
+ # more horrible search/sync code below...
+ my $staticsChanged = 0;
+ foreach my $istatic ( @istatics ) { # they have, we don't
+ unless ( grep($_ eq $istatic, @ostatics) ) {
+ push @ostatics, $istatic;
+ $staticsChanged = 1;
+ }
+ }
+ for(my $i=0; $i < scalar(@ostatics); $i++) {
+ unless ( grep($_ eq $ostatics[$i], @istatics) ) {
+ splice(@ostatics,$i,1);
+ $i--;
+ $staticsChanged = 1;
+ }
+ }
+ $svc_dsl->staticips(join(',',@ostatics)) if $staticsChanged;
+
+ # 7. notes - put them into the common format and compare
+ my $tnotes = $result->{'OrderNotes'};
+ my @tnotes = defined $tnotes ? @$tnotes : ();
+ my @inotes = (); # all Ikano OrderNotes as FS::dsl_note objects
+ my $notesChanged = 0;
+ foreach my $tnote ( @tnotes ) {
+ my $inote = $self->ikano2fsnote($tnote,$svc_dsl->svcnum);
+ return 'Cannot parse note' unless ref($inote);
+ push @inotes, $inote;
+ }
+ 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 ) {
+ if($onote->date == $inote->date && $onote->note eq $inote->note) {
+ $found = 1;
+ last;
+ }
+ }
+ $error = $inote->insert unless ( $found );
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "Cannot add note: $error";
+ }
+ }
+
+ $svc_dsl->last_pull((time));
+ local $FS::svc_Common::noexport_hack = 1;
+ $error = $svc_dsl->replace;
+ if ( $error ) {
+ $dbh->rollback if $oldAutoCommit;
+ return "Cannot update DSL data: $error";
+ }
+
+ $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+
'';
}
-sub dsl_qual {
- '';
+sub ikano2fsnote {
+ my($self,$n,$svcnum) = (shift,shift,shift);
+ my @ikanoRequired = qw( HighPriority StaffId Date Text CompanyStaffId );
+ return '' unless defined $n->{'HighPriority'}
+ && defined $n->{'StaffId'}
+ && defined $n->{'CompanyStaffId'}
+ && defined $n->{'Date'}
+ && defined $n->{'Text'}
+ ;
+ my $by = 'Unknown';
+ $by = "Ikano" if $n->{'CompanyStaffId'} == -1 && $n->{'StaffId'} != -1;
+ $by = "Us" if $n->{'StaffId'} == -1 && $n->{'CompanyStaffId'} != -1;
+
+ new FS::dsl_note( {
+ 'svcnum' => $svcnum,
+ 'by' => $by,
+ 'priority' => $n->{'HighPriority'} eq 'false' ? 'N' : 'H',
+ 'date' => int(str2time($n->{'Date'})),
+ 'note' => $n->{'Text'},
+ } );
}
-sub notes_html {
+sub qual {
'';
}
+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 = '<TABLE border="1" cellspacing="2" cellpadding="2" id="dsl_notes">
+ <TR><TH>Date</TH><TH>By</TH><TH>Priority</TH><TH>Note</TH></TR>';
+ foreach my $note ( @notes ) {
+ $html .= "<TR>
+ <TD>".time2str("$date_format %H:%M",$note->date)."</TD>
+ <TD>".$note->by."</TD>
+ <TD>". ($note->priority eq 'N' ? 'Normal' : 'High') ."</TD>
+ <TD>".$note->note."</TD></TR>";
+ }
+ $html .= '</TABLE>';
+ $html;
+}
+
sub loop_type_long { # sub, not a method
my($svc_dsl) = (shift);
return $loopType{$svc_dsl->loop_type};
}
-sub status_line {
- my($self,$svc_dsl) = (shift,shift);
- return "Ikano ".$orderType{$svc_dsl->vendor_order_type}." order #"
- . $svc_dsl->vendor_order_id . " (Status: "
- . $orderStatus{$svc_dsl->vendor_order_status} . ")";
-}
-
sub ikano_command {
my( $self, $command, $args ) = @_;
- eval "use Net::Ikano;";
- die $@ if $@;
+ $self->loadmod;
my $ikano = Net::Ikano->new(
'keyid' => $self->option('keyid'),
'username' => $self->option('username'),
'password' => $self->option('password'),
- 'debug' => 1,
- #'reqpreviewonly' => 1,
+ 'debug' => $self->option('debug'),
);
$ikano->$command($args);
}
+sub loadmod {
+ eval "use Net::Ikano;";
+ die $@ if $@;
+}
+
sub valid_order {
my( $self, $svc_dsl, $action ) = (shift, shift, shift);
+
+ $self->loadmod;
- warn "$me valid_order action=$action svc_dsl:\n". Dumper($svc_dsl) if $DEBUG;
+ warn "$me valid_order action=$action svc_dsl:\n". Dumper($svc_dsl)
+ if $self->option('debug');
# common to all order types/status/loop_type
my $error = !($svc_dsl->desired_due_date
- && defined $orderType{$svc_dsl->vendor_order_type}
+ && grep($_ eq $svc_dsl->vendor_order_type, Net::Ikano->orderTypes)
&& $svc_dsl->first
&& $svc_dsl->last
&& defined $svc_dsl->loop_type
# now go by order type
# weird ifs & long lines for readability and ease of understanding - don't change
- if($svc_dsl->vendor_order_type eq 'N') {
+ if($svc_dsl->vendor_order_type eq 'NEW') {
if($svc_dsl->pushed) {
+ $error = !( ($action eq 'pull' || $action eq 'statuschg'
+ || $action eq 'delete')
+ && length($svc_dsl->vendor_order_id) > 0
+ && length($svc_dsl->vendor_order_status) > 0
+ );
+ return 'Invalid order data' if $error;
+
+ return 'Phone number required for status change'
+ if ($action eq 'statuschg' && length($svc_dsl->phonenum) < 1);
}
else { # unpushed New order - cannot do anything other than push it
$error = !($action eq 'insert'
return 'Invalid order data' if $error;
}
}
- elsif($svc_dsl->vendor_order_type eq 'X') {
+ elsif($svc_dsl->vendor_order_type eq 'CANCEL') {
}
- elsif($svc_dsl->vendor_order_type eq 'C') {
+ elsif($svc_dsl->vendor_order_type eq 'CHANGE') {
}
'';
my $qual = qsearchs( 'qual', { 'vendor_qual_id' => $vendor_qual_id });
return '' unless $qual;
my %qual_options = $qual->options;
+ my( $optionname, $optionvalue );
while (($optionname, $optionvalue) = each %qual_options) {
if ( $optionname =~ /^ikano_Network_(\d+)_ProductGroup_(\d+)_Product_(\d+)_ProductCustomId$/
&& $optionvalue eq $ProductCustomId ) {
'';
}
-sub orderstatus_long2short {
- my ($self,$order_status) = (shift,shift);
- while (($k, $v) = each %orderStatus) {
- return $k if $v eq $order_status;
- }
- return '';
-}
-
sub _export_insert {
my( $self, $svc_dsl ) = (shift, shift);
+ $self->loadmod;
+
my $result = $self->valid_order($svc_dsl,'insert');
return $result unless $result eq '';
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 $DEBUG;
+ 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 order id or status returned'
- unless defined $result->{'Status'} && defined $result->{'OrderId'};
+ 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($self->orderstatus_long2short($result->{'Status'}));
+ $svc_dsl->vendor_order_status($result->{'Status'});
$svc_dsl->username($result->{'Username'});
local $FS::svc_Common::noexport_hack = 1;
- local $FS::UID::AutoCommit = 0;
$result = $svc_dsl->replace;
- return 'Error setting DSL fields' if $result;
+ return "Error setting DSL fields: $result" if $result;
'';
}
sub _export_replace {
my( $self, $new, $old ) = (shift, shift, shift);
+# XXX only supports password changes now, but should return error if
+# another change is attempted?
+
+ if($new->password ne $old->password) {
+ my $result = $self->valid_order($new,'statuschg');
+ return $result unless $result eq '';
+
+ $result = $self->ikano_command('PASSWORDCHANGE',
+ { DSLPhoneNumber => $new->phonenum,
+ NewPassword => $new->password,
+ } );
+ return $result unless ref($result); # scalar (string) is an error
+
+ return 'Error changing password' unless defined $result->{'Password'}
+ && $result->{'Password'} eq $new->password;
+ }
+
'';
}
sub _export_delete {
my( $self, $svc_dsl ) = (shift, shift);
+
+ 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
+
+ if($svc_dsl->vendor_order_type eq 'NEW') {
+ if($svc_dsl->vendor_order_status eq 'NEW'
+ || $svc_dsl->vendor_order_status eq 'PENDING') {
+ 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);
+ }
+ else {
+ return "Cannot cancel a NEW order unless it's in NEW or PENDING status";
+ }
+ }
+ else {
+ return 'Canceling orders other than NEW orders is not currently implemented';
+ }
+
'';
}
+sub statuschg {
+ my( $self, $svc_dsl, $type ) = (shift, shift, shift);
+
+ my $result = $self->valid_order($svc_dsl,'statuschg');
+ return $result unless $result eq '';
+
+ # get the DSLServiceId
+ $result = $self->ikano_command('CUSTOMERLOOKUP',
+ { PhoneNumber => $svc_dsl->phonenum } );
+ return $result unless ref($result); # scalar (string) is an error
+ return 'No DSLServiceId found' unless defined $result->{'DSLServiceId'};
+ my $DSLServiceId = $result->{'DSLServiceId'};
+
+ $result = $self->ikano_command('ACCOUNTSTATUSCHANGE',
+ { DSLPhoneNumber => $svc_dsl->phonenum,
+ DSLServiceId => $DSLServiceId,
+ type => $type,
+ } );
+ return $result unless ref($result); # scalar (string) is an error
+ '';
+}
+
sub _export_suspend {
my( $self, $svc_dsl ) = (shift, shift);
- '';
+ $self->statuschg($svc_dsl,"SUSPEND");
}
sub _export_unsuspend {
my( $self, $svc_dsl ) = (shift, shift);
- '';
+ $self->statuschg($svc_dsl,"UNSUSPEND");
}
1;