X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_export%2Fsaisei.pm;h=8661651df80a7bb4e5bfafe5005efb6e93b9012f;hp=f409046a5ec1871ef3c1ed40bcff42dd9f6ba244;hb=c15c4b8b1afa91049915f77503487e663554938b;hpb=a9056b16e215e7ac8da9144106e34918cced951f diff --git a/FS/FS/part_export/saisei.pm b/FS/FS/part_export/saisei.pm index f409046a5..8661651df 100644 --- a/FS/FS/part_export/saisei.pm +++ b/FS/FS/part_export/saisei.pm @@ -62,6 +62,8 @@ tie my %scripts, 'Tie::IxHash', label => 'Export provisioned services', description => 'will export provisioned services of part service with Saisei export attached.', html_label => 'Export provisioned services attached to this export.', + error_url => '/edit/part_export.cgi?', + success_message => 'Saisei export of provisioned services successful', }, ; @@ -94,7 +96,7 @@ To use this export, follow the below instructions:
@@ -110,7 +112,7 @@ Create a package for the above created service, and order this package for a cus
Unprovisioning this service will set the host entry at Saisei to the default rate plan with the user and access point set to none. @@ -122,7 +124,7 @@ Clicking on this link will export all services attached to this export not curre
- +Documentation END ); @@ -169,6 +171,7 @@ sub _export_insert { tower.up_rate_limit as tower_upratelimit, tower.down_rate_limit as tower_downratelimit, tower_sector.sectorname, + tower_sector.towernum, tower_sector.up_rate_limit as sector_upratelimit, tower_sector.down_rate_limit as sector_downratelimit ', 'addl_from' => 'LEFT JOIN tower USING ( towernum )', @@ -182,6 +185,7 @@ sub _export_insert { my $tower_opt = { 'tower_name' => $tower_name, + 'tower_num' => $tower_sector->{Hash}->{towernum}, 'tower_uprate_limit' => $tower_sector->{Hash}->{tower_upratelimit}, 'tower_downrate_limit' => $tower_sector->{Hash}->{tower_downratelimit}, }; @@ -194,9 +198,11 @@ sub _export_insert { my $sector_opt = { 'tower_name' => $tower_name, + 'tower_num' => $tower_sector->{Hash}->{towernum}, 'sector_name' => $sector_name, 'sector_uprate_limit' => $tower_sector->{Hash}->{sector_upratelimit}, 'sector_downrate_limit' => $tower_sector->{Hash}->{sector_downratelimit}, + 'rateplan' => $rateplan_name, }; my $accesspoint = process_sector($self, $sector_opt); return $self->api_error if $self->{'__saisei_error'}; @@ -330,6 +336,7 @@ sub export_tower_sector { $tower_name =~ s/\s/_/g; my $tower_opt = { 'tower_name' => $tower_name, + 'tower_num' => $tower->{Hash}->{towernum}, 'tower_uprate_limit' => $tower->{Hash}->{up_rate_limit}, 'tower_downrate_limit' => $tower->{Hash}->{down_rate_limit}, 'modify_existing' => '1', # modify an existing access point with this info @@ -351,16 +358,17 @@ sub export_tower_sector { $sector_name =~ s/\s/_/g; my $sector_opt = { 'tower_name' => $tower_name, + 'tower_num' => $tower_sector->{Hash}->{towernum}, 'sector_name' => $sector_name, 'sector_uprate_limit' => $tower_sector->{Hash}->{up_rate_limit}, 'sector_downrate_limit' => $tower_sector->{Hash}->{down_rate_limit}, 'modify_existing' => '1', # modify an existing access point with this info }; - my $sector_access_point = process_sector($self, $sector_opt); + my $sector_access_point = process_sector($self, $sector_opt) unless ($sector_name eq "_default"); return $sector_access_point if $sector_access_point->{error}; } - return $self->api_error; + return { error => $self->api_error, }; } ## creates the rateplan name @@ -371,7 +379,7 @@ sub get_rateplan_name { my $service_name = $svc_name ? $svc_name : $service_part->{Hash}->{svc}; my $rateplan_name = $service_name . " " . $svc_broadband->{Hash}->{speed_down} . "-" . $svc_broadband->{Hash}->{speed_up}; - $rateplan_name =~ s/\s/_/g; + $rateplan_name =~ s/\s/_/g; $rateplan_name =~ s/[^A-Za-z0-9\-_]//g; return $rateplan_name; } @@ -410,37 +418,39 @@ sub api_call { $client->setHost('http://'.$self->{Hash}->{machine}.':'.$self->option('port')); $client->$method('/rest/top/configurations/running'.$path, $data, { "Content-type" => 'application/json'}); - warn "Response Code is ".$client->responseCode()."\n" if $self->option('debug'); + warn "Saisei Response Code is ".$client->responseCode()."\n" if $self->option('debug'); my $result; if ($client->responseCode() eq '200' || $client->responseCode() eq '201') { eval { $result = decode_json($client->responseContent()) }; unless ($result) { - $self->{'__saisei_error'} = "Error decoding json: $@"; + $self->{'__saisei_error'} = "There was an error decoding the JSON data from Saisei. Bad JSON data logged in error log if debug option was set."; + warn "Saisei RC 201 Response Content is not json\n".$client->responseContent()."\n" if $self->option('debug'); return; } } elsif ($client->responseCode() eq '404') { eval { $result = decode_json($client->responseContent()) }; unless ($result) { - $self->{'__saisei_error'} = "Error decoding json: $@"; + $self->{'__saisei_error'} = "There was an error decoding the JSON data from Saisei. Bad JSON data logged in error log if debug option was set."; + warn "Saisei RC 404 Response Content is not json\n".$client->responseContent()."\n" if $self->option('debug'); return; } ## check if message is for empty hash. my($does_not_exist) = $result->{message} =~ /'(.*)' does not exist$/; - $self->{'__saisei_error'} = "Error ".$result->{message} unless $does_not_exist; - warn "Response Content is\n".$client->responseContent."\n" if ($self->option('debug') && !$does_not_exist); + $self->{'__saisei_error'} = "Saisei Error: ".$result->{message} unless $does_not_exist; + warn "Saisei Response Content is\n".$client->responseContent."\n" if ($self->option('debug') && !$does_not_exist); return; } elsif ($client->responseCode() eq '500') { - $self->{'__saisei_error'} = "Can't connect to host during $method , received responce code: " . $client->responseCode() . " and message: " . $client->responseContent(); - warn "Response Content is\n".$client->responseContent."\n" if $self->option('debug'); + $self->{'__saisei_error'} = "Could not connect to the Saisei export host machine (".$self->{Hash}->{machine}.':'.$self->option('port').") during $method , we received the responce code: " . $client->responseCode(); + warn "Saisei Response Content is\n".$client->responseContent."\n" if $self->option('debug'); return; } else { - $self->{'__saisei_error'} = "Bad response from server during $method , received responce code: " . $client->responseCode() . " and message: " . $client->responseContent(); - warn "Response Content is\n".$client->responseContent."\n" if $self->option('debug'); + $self->{'__saisei_error'} = "Received Bad response from server during $method , we received responce code: " . $client->responseCode(); + warn "Saisei Response Content is\n".$client->responseContent."\n" if $self->option('debug'); return; } @@ -471,7 +481,7 @@ sub api_get_policies { my $get_policies = $self->api_call("GET", '/policies/?token=1&order=name&start=0&limit=20&select=name%2Cpercent_rate%2Cassured%2C'); return if $self->api_error; - $self->{'__saisei_error'} = "Did not receive any global policies" + $self->{'__saisei_error'} = "Did not receive any global policies from Saisei." unless $get_policies; return $get_policies->{collection}; @@ -537,7 +547,7 @@ sub api_get_host { my $get_host = $self->api_call("GET", "/hosts/$ip"); - return $self->api_error if $self->api_error; + return { message => $self->api_error, } if $self->api_error; return $get_host; } @@ -551,8 +561,8 @@ Creates a rateplan. sub api_create_rateplan { my ($self, $svc, $rateplan) = @_; - $self->{'__saisei_error'} = "No downrate listed for service $rateplan" if !$svc->{Hash}->{speed_down}; - $self->{'__saisei_error'} = "No uprate listed for service $rateplan" if !$svc->{Hash}->{speed_up}; + $self->{'__saisei_error'} = "There is no download speed set for the service !--service,".$svc->svcnum.",".$rateplan."--! with host (".$svc->{Hash}->{ip_addr}."). All services that are to be exported to Saisei need to have a download speed set for them." if !$svc->{Hash}->{speed_down}; + $self->{'__saisei_error'} = "There is no upload speed set for the service !--service,".$svc->svcnum.",".$rateplan."--! with host (".$svc->{Hash}->{ip_addr}."). All services that are to be exported to Saisei need to have a upload speed set for them." if !$svc->{Hash}->{speed_up}; my $new_rateplan = $self->api_call( "PUT", @@ -563,7 +573,7 @@ sub api_create_rateplan { }, ) unless $self->{'__saisei_error'}; - $self->{'__saisei_error'} = "Rate Plan not created" + $self->{'__saisei_error'} = "Saisei could not create the rate plan $rateplan." unless ($new_rateplan || $self->{'__saisei_error'}); return $new_rateplan; @@ -596,7 +606,7 @@ sub api_modify_rateplan { }, ); - $self->{'__saisei_error'} = "Rate Plan not modified after create" + $self->{'__saisei_error'} = "Saisei could not modify the rate plan $rateplan_name after it was created." unless ($modified_rateplan || $self->{'__saisei_error'}); # should never happen } @@ -614,6 +624,9 @@ Modify a existing rateplan. sub api_modify_existing_rateplan { my ($self,$svc,$rateplan_name) = @_; + $self->{'__saisei_error'} = "There is no download speed set for the service !--service,".$svc->svcnum.",".$rateplan_name."--! with host (".$svc->{Hash}->{ip_addr}."). All services that are to be exported to Saisei need to have a download speed set for them." if !$svc->{Hash}->{speed_down}; + $self->{'__saisei_error'} = "There is no upload speed set for the service !--service,".$svc->svcnum.",".$rateplan_name."--! with host (".$svc->{Hash}->{ip_addr}."). All services that are to be exported to Saisei need to have a upload speed set for them." if !$svc->{Hash}->{speed_up}; + my $modified_rateplan = $self->api_call( "PUT", "/rate_plans/$rateplan_name", @@ -623,7 +636,7 @@ sub api_modify_existing_rateplan { }, ); - $self->{'__saisei_error'} = "Rate Plan not modified" + $self->{'__saisei_error'} = "Saisei could not modify the rate plan $rateplan_name." unless ($modified_rateplan || $self->{'__saisei_error'}); # should never happen return; @@ -647,7 +660,7 @@ sub api_create_user { }, ); - $self->{'__saisei_error'} = "User not created" + $self->{'__saisei_error'} = "Saisei could not create the user $user" unless ($new_user || $self->{'__saisei_error'}); # should never happen return $new_user; @@ -672,7 +685,7 @@ sub api_create_accesspoint { }, ); - $self->{'__saisei_error'} = "Access point not created" + $self->{'__saisei_error'} = "Saisei could not create the access point $accesspoint" unless ($new_accesspoint || $self->{'__saisei_error'}); # should never happen return; @@ -695,7 +708,7 @@ sub api_modify_accesspoint { }, ); - $self->{'__saisei_error'} = "Rate Plan not modified" + $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint after it was created." unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen return; @@ -721,7 +734,7 @@ sub api_modify_existing_accesspoint { }, ); - $self->{'__saisei_error'} = "Access point not modified" + $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint." unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen return; @@ -747,7 +760,7 @@ sub api_add_host_to_user { }, ); - $self->{'__saisei_error'} = "Host not created" + $self->{'__saisei_error'} = "Saisei could not create the host $ip" unless ($new_host || $self->{'__saisei_error'}); # should never happen return $new_host; @@ -766,7 +779,7 @@ sub api_delete_host_to_user { my $default_rate_plan = $self->api_call("GET", '?token=1&select=default_rate_plan'); return if $self->api_error; - $self->{'__saisei_error'} = "Did not receive a default rate plan" + $self->{'__saisei_error'} = "Can not delete the host as Saisei did not return a default rate plan. Please make sure Saisei has a default rateplan setup." unless $default_rate_plan; my $default_rateplan_name = $default_rate_plan->{collection}->[0]->{default_rate_plan}->{link}->{name}; @@ -781,7 +794,7 @@ sub api_delete_host_to_user { }, ); - $self->{'__saisei_error'} = "Host not created" + $self->{'__saisei_error'} = "Saisei could not delete the host $ip" unless ($delete_host || $self->{'__saisei_error'}); # should never happen return $delete_host; @@ -792,7 +805,7 @@ sub process_tower { my ($self, $opt) = @_; if (!$opt->{tower_uprate_limit} || !$opt->{tower_downrate_limit}) { - $self->{'__saisei_error'} = "Can not export tower, no up or down rates attached to tower"; + $self->{'__saisei_error'} = "Could not export tower !--tower,".$opt->{tower_num}.",".$opt->{tower_name}."--! because there was no up or down rates attached to the tower. Saisei requires a up and down rate be attached to each tower."; return { error => $self->api_error, }; } @@ -819,14 +832,20 @@ sub process_tower { my $accesspoint = $self->api_get_accesspoint($tower_name); + return { error => $self->api_error, } if $self->api_error; return $accesspoint; } sub process_sector { my ($self, $opt) = @_; + if (!$opt->{sector_name} || $opt->{sector_name} eq '_default') { + $self->{'__saisei_error'} = "No sector attached to Tower (".$opt->{tower_name}.") for service ".$opt->{'rateplan'}.". Saisei requires a tower sector to be attached to each service that is exported to Saisei."; + return { error => $self->api_error, }; + } + if (!$opt->{sector_uprate_limit} || !$opt->{sector_downrate_limit}) { - $self->{'__saisei_error'} = "Can not export sector, no up or down rates attached to sector"; + $self->{'__saisei_error'} = "Could not export sector !--tower,".$opt->{tower_num}.",".$opt->{sector_name}."--! because there was no up or down rates attached to the sector. Saisei requires a up and down rate be attached to each sector."; return { error => $self->api_error, }; } @@ -857,9 +876,25 @@ sub process_sector { # set access point to existing one or newly created one. my $accesspoint = $existing_sector_ap ? $existing_sector_ap : $self->api_get_accesspoint($sector_name); + return { error => $self->api_error, } if $self->api_error; return $accesspoint; } +=head2 require_tower_and_sector + +sets whether the service export requires a sector with it's tower. + +=cut + +sub require_tower_and_sector { + 1; +} + +sub required_fields { + my @fields = ('svc_broadband__ip_addr_required', 'svc_broadband__speed_up_required', 'svc_broadband__speed_down_required', 'svc_broadband__sectornum_required'); + return @fields; +} + sub process_virtual_ap { my ($self, $opt) = @_; @@ -903,7 +938,7 @@ sub export_provisioned_services { my $param = shift; my $part_export = FS::Record::qsearchs('part_export', { 'exportnum' => $param->{export_provisioned_services_exportnum}, } ) - or die "unknown exportnum $param->{export_provisioned_services_exportnum}"; + or die "You are trying to use an unknown exportnum $param->{export_provisioned_services_exportnum}. This export does not exist.\n"; bless $part_export; my @svcparts = FS::Record::qsearch({ @@ -931,10 +966,13 @@ sub export_provisioned_services { if ($status{$process_count}) { my $s = $status{$process_count}; $job->update_statustext($s); } ## check if service exists as host if not export it. my $host = api_get_host($part_export, $svc->{Hash}->{ip_addr}); - die $host->{message} if $host->{message}; + die ("Please double check your credentials as ".$host->{message}."\n") if $host->{message}; warn "Exporting service ".$svc->{Hash}->{ip_addr}."\n" if ($part_export->option('debug')); my $export_error = _export_insert($part_export,$svc) unless $host->{collection}; - die $export_error if $export_error; + if ($export_error) { + warn "Error exporting service ".$svc->{Hash}->{ip_addr}."\n" if ($part_export->option('debug')); + die ("$export_error\n"); + } $process_count++; }