X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=FS%2FFS%2Fpart_export%2Fsaisei.pm;h=ba6bc622fbdc5ef9aeb33cb43dded134ef977d2c;hb=ac155162693c27f9f26382358c302f548f381d5e;hp=6a42b94bacacfe997339f192110e56415f74036c;hpb=4cf578816f5a491b1f66ddb5a9e832457ebe1332;p=freeside.git diff --git a/FS/FS/part_export/saisei.pm b/FS/FS/part_export/saisei.pm index 6a42b94ba..ba6bc622f 100644 --- a/FS/FS/part_export/saisei.pm +++ b/FS/FS/part_export/saisei.pm @@ -94,7 +94,7 @@ To use this export, follow the below instructions:
@@ -110,7 +110,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 +122,7 @@ Clicking on this link will export all services attached to this export not curre
- +Documentation END ); @@ -197,6 +197,7 @@ sub _export_insert { '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'}; @@ -324,6 +325,7 @@ sub export_tower_sector { }; my $tower_access_point = process_tower($self, $tower_opt); + return $tower_access_point if $tower_access_point->{error}; #get list of all access points my $hash_opt = { @@ -343,10 +345,11 @@ sub export_tower_sector { '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 @@ -357,7 +360,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; } @@ -387,30 +390,48 @@ sub api_call { warn "Calling $method on http://" .$self->{Hash}->{machine}.':'.$self->option('port') - ."/rest/stm/configurations/running/$path\n" if $self->option('debug'); + ."/rest/top/configurations/running/$path\n" if $self->option('debug'); my $data = encode_json($params) if keys %{ $params }; my $client = REST::Client->new(); $client->addHeader("Authorization", "Basic ".encode_base64($auth_info)); $client->setHost('http://'.$self->{Hash}->{machine}.':'.$self->option('port')); - $client->$method('/rest/stm/configurations/running'.$path, $data, { "Content-type" => 'application/json'}); + $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'} = "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'} = "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'} = "Could not connect to the host (".$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: " . $client->responseContent() - unless ($method eq "GET"); - 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; } @@ -441,7 +462,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}; @@ -507,7 +528,7 @@ sub api_get_host { my $get_host = $self->api_call("GET", "/hosts/$ip"); - return if $self->api_error; + return { message => $self->api_error, } if $self->api_error; return $get_host; } @@ -521,8 +542,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 $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 $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", @@ -533,7 +554,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; @@ -566,7 +587,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 } @@ -593,7 +614,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; @@ -617,7 +638,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; @@ -633,7 +654,6 @@ Creates a access point. sub api_create_accesspoint { my ($self,$accesspoint, $upratelimit, $downratelimit) = @_; - # this has not been tested, but should work, if needed. my $new_accesspoint = $self->api_call( "PUT", "/access_points/$accesspoint", @@ -643,7 +663,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; @@ -666,7 +686,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; @@ -692,7 +712,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; @@ -718,7 +738,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; @@ -737,7 +757,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}; @@ -752,7 +772,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; @@ -762,6 +782,11 @@ sub api_delete_host_to_user { sub process_tower { my ($self, $opt) = @_; + if (!$opt->{tower_uprate_limit} || !$opt->{tower_downrate_limit}) { + $self->{'__saisei_error'} = "Could not export tower ".$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, }; + } + my $existing_tower_ap; my $tower_name = $opt->{tower_name}; @@ -774,23 +799,34 @@ sub process_tower { '', # tower does not have a uplink on sectors. $opt->{tower_uprate_limit}, $opt->{tower_downrate_limit}, - ) if $existing_tower_ap && $opt->{modify_existing}; + ) if $existing_tower_ap->{collection} && $opt->{modify_existing}; #if tower does not exist as an access point create it. $self->api_create_accesspoint( $tower_name, $opt->{tower_uprate_limit}, - $opt->{tower_downrate_limit} - ) unless $existing_tower_ap; + $opt->{tower_downrate_limit}, + ) unless $existing_tower_ap->{collection}; 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'} = "Could not export sector ".$opt->{tower_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, }; + } + my $existing_sector_ap; my $sector_name = $opt->{sector_name}; @@ -818,16 +854,32 @@ 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) = @_; my $existing_virtual_ap; my $virtual_name = $opt->{virtual_name}; - #check if sector has been set up as an access point. + #check if virtual_ap has been set up as an access point. $existing_virtual_ap = $self->api_get_accesspoint($virtual_name); # modify the existing virtual accesspoint if changing it. this should never happen @@ -845,10 +897,10 @@ sub process_virtual_ap { $opt->{virtual_downrate_limit}, ) unless $existing_virtual_ap; -my $update_sector; -if ($existing_virtual_ap && ($existing_virtual_ap->{collection}->[0]->{uplink}->{link}->{name} ne $opt->{sector_name})) { - $update_sector = 1; -} + my $update_sector; + if ($existing_virtual_ap && (ref $existing_virtual_ap->{collection}->[0]->{uplink} eq "HASH") && ($existing_virtual_ap->{collection}->[0]->{uplink}->{link}->{name} ne $opt->{sector_name})) { + $update_sector = 1; + } # Attach newly created virtual ap to tower sector ap or if sector has changed. $self->api_modify_accesspoint($virtual_name, $opt->{sector_name}) unless ($self->{'__saisei_error'} || ($existing_virtual_ap && !$update_sector)); @@ -864,7 +916,7 @@ sub export_provisioned_services { my $param = thaw(decode_base64(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({ @@ -891,7 +943,14 @@ sub export_provisioned_services { foreach my $svc (@svcs) { if ($status{$process_count}) { my $s = $status{$process_count}; $job->update_statustext($s); } ## check if service exists as host if not export it. - _export_insert($part_export,$svc) unless api_get_host($part_export, $svc->{Hash}->{ip_addr}); + my $host = api_get_host($part_export, $svc->{Hash}->{ip_addr}); + 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}; + if ($export_error) { + warn "Error exporting service ".$svc->{Hash}->{ip_addr}."\n" if ($part_export->option('debug')); + die ("$export_error\n"); + } $process_count++; }