1 package FS::part_export::saisei;
4 use vars qw( @ISA %info );
5 use base qw( FS::part_export );
6 use Date::Format 'time2str';
18 FS::part_export::saisei
22 Saisei integration for Freeside
26 This export offers basic svc_broadband provisioning for Saisei.
28 This is a customer integration with Saisei. This will set up a rate plan and tie
29 the rate plan to a host and the access point via the Saisei API when the broadband service is provisioned.
30 It will also untie the host from the rate plan, setting it to the default rate plan via the API upon unprovisioning of the broadband service.
32 This will create and modify the rate plans at Saisei as soon as the broadband service attached to this export is created or modified.
33 This will also create and modify an access point at Saisei as soon as the tower is created or modified.
35 To use this export, follow the below instructions:
37 Create a new service definition and set the table to svc_broadband. The service name will become the Saisei rate plan name.
38 Set the upload and download speed for the service. This is required to be able to export the service to Saisei.
39 Attach this Saisei export to this service.
41 Create a tower and add a sector to that tower. The sector name will be the name of the access point,
42 Make sure you have set the up and down rate limit for the tower and the sector. This is required to be able to export the access point.
43 The tower and sector will be set up as access points at Saisei upon the creation of the tower or sector. They will be modified at Saisei when modified in freeside.
44 Each sector will be attached to its tower access point using the Saisei uplink field.
46 Create a package for the above created service, and order this package for a customer.
48 Provision the service, making sure to enter the IP address associated with this service and select the tower and sector for it's access point.
49 This provisioned service will then be exported as a host to Saisei.
51 Unprovisioning this service will set the host entry at Saisei to the default rate plan with the user and access point set to <none>.
53 After this export is set up and attached to a service, you can export the already provisioned services by clicking the link Export provisioned services attached to this export.
54 Clicking on this link will export all services attached to this export not currently exported to Saisei.
56 This module also provides generic methods for working through the L</Saisei API>.
60 tie my %scripts, 'Tie::IxHash',
61 'export_provisioned_services' => { component => '/elements/popup_link.html',
62 label => 'Export provisioned services',
63 description => 'will export provisioned services of part service with Saisei export attached.',
64 html_label => '<b>Export provisioned services attached to this export.</b>',
68 tie my %options, 'Tie::IxHash',
69 'port' => { label => 'Port',
71 'username' => { label => 'Saisei API User Name',
73 'password' => { label => 'Saisei API Password',
75 'debug' => { type => 'checkbox',
76 label => 'Enable debug warnings' },
80 'svc' => 'svc_broadband',
81 'desc' => 'Export broadband service/account to Saisei',
82 'options' => \%options,
83 'scripts' => \%scripts,
85 This is a customer integration with Saisei. This will set up a rate plan and tie
86 the rate plan to a host and the access point via the Saisei API when the broadband service is provisioned.
87 It will also untie the host from the rate plan, setting it to the default rate plan via the API upon unprovisioning of the broadband service.
89 This will create and modify the rate plans at Saisei as soon as the broadband service attached to this export is created or modified.
90 This will also create and modify an access point at Saisei as soon as the tower is created or modified.
92 To use this export, follow the below instructions:
96 Create a new service definition and set the table to svc_broadband. The service name will become the Saisei rate plan name.
97 Set the upload speed, download speed, and tower to be required for the service. This is required to be able to export the service to Saisei.
98 Attach this Saisei export to this service.
102 Create a tower and add a sector to that tower. The sector name will be the name of the access point,
103 Make sure you have set the up and down rate limit for the tower and the sector. This is required to be able to export the access point.
104 The tower and sector will be set up as access points at Saisei upon the creation of the tower or sector. They will be modified at Saisei when modified in freeside.
105 Each sector will be attached to its tower access point using the Saisei uplink field.
109 Create a package for the above created service, and order this package for a customer.
113 Provision the service, making sure to enter the IP address associated with this service, the upload and download speed are correct, and select the tower and sector for it's access point.
114 This provisioned service will then be exported as a host to Saisei.
116 Unprovisioning this service will set the host entry at Saisei to the default rate plan with the user and access point set to <i>none</i>.
120 After this export is set up and attached to a service, you can export the already provisioned services by clicking the link <b>Export provisioned services attached to this export</b>.
121 Clicking on this link will export all services attached to this export not currently exported to Saisei.
125 <A HREF="http://www.freeside.biz/mediawiki/index.php/Saisei_provisioning_export" target="_new">Documentation</a>
130 my ($self, $svc_broadband) = @_;
132 my $rateplan_name = $self->get_rateplan_name($svc_broadband);
134 # check for existing rate plan
135 my $existing_rateplan;
136 $existing_rateplan = $self->api_get_rateplan($rateplan_name) unless $self->{'__saisei_error'};
138 # if no existing rate plan create one and modify it.
139 $self->api_create_rateplan($svc_broadband, $rateplan_name) unless $existing_rateplan;
140 $self->api_modify_rateplan($svc_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan);
141 return $self->api_error if $self->{'__saisei_error'};
143 # set rateplan to existing one or newly created one.
144 my $rateplan = $existing_rateplan ? $existing_rateplan : $self->api_get_rateplan($rateplan_name);
146 my $username = $svc_broadband->{Hash}->{svcnum};
147 my $description = $svc_broadband->{Hash}->{description};
150 $self->{'__saisei_error'} = 'no username - can not export';
151 return $self->api_error;
154 # check for existing user.
156 $existing_user = $self->api_get_user($username) unless $self->{'__saisei_error'};
158 # if no existing user create one.
159 $self->api_create_user($username, $description) unless $existing_user;
160 return $self->api_error if $self->{'__saisei_error'};
162 # set user to existing one or newly created one.
163 my $user = $existing_user ? $existing_user : $self->api_get_user($username);
166 my $tower_sector = FS::Record::qsearchs({
167 'table' => 'tower_sector',
168 'select' => 'tower.towername,
169 tower.up_rate_limit as tower_upratelimit,
170 tower.down_rate_limit as tower_downratelimit,
171 tower_sector.sectorname,
172 tower_sector.up_rate_limit as sector_upratelimit,
173 tower_sector.down_rate_limit as sector_downratelimit ',
174 'addl_from' => 'LEFT JOIN tower USING ( towernum )',
176 'sectornum' => $svc_broadband->{Hash}->{sectornum},
180 my $tower_name = $tower_sector->{Hash}->{towername};
181 $tower_name =~ s/\s/_/g;
184 'tower_name' => $tower_name,
185 'tower_uprate_limit' => $tower_sector->{Hash}->{tower_upratelimit},
186 'tower_downrate_limit' => $tower_sector->{Hash}->{tower_downratelimit},
189 my $tower_ap = process_tower($self, $tower_opt);
190 return $self->api_error if $self->{'__saisei_error'};
192 my $sector_name = $tower_sector->{Hash}->{sectorname};
193 $sector_name =~ s/\s/_/g;
196 'tower_name' => $tower_name,
197 'sector_name' => $sector_name,
198 'sector_uprate_limit' => $tower_sector->{Hash}->{sector_upratelimit},
199 'sector_downrate_limit' => $tower_sector->{Hash}->{sector_downratelimit},
201 my $accesspoint = process_sector($self, $sector_opt);
202 return $self->api_error if $self->{'__saisei_error'};
204 ## get custnum and pkgpart from cust_pkg for virtual access point
205 my $cust_pkg = FS::Record::qsearchs({
206 'table' => 'cust_pkg',
207 'hashref' => { 'pkgnum' => $svc_broadband->{Hash}->{pkgnum}, },
209 my $virtual_ap_name = $cust_pkg->{Hash}->{custnum}.'_'.$cust_pkg->{Hash}->{pkgpart}.'_'.$svc_broadband->{Hash}->{speed_down}.'_'.$svc_broadband->{Hash}->{speed_up};
211 my $virtual_ap_opt = {
212 'virtual_name' => $virtual_ap_name,
213 'sector_name' => $sector_name,
214 'virtual_uprate_limit' => $svc_broadband->{Hash}->{speed_up},
215 'virtual_downrate_limit' => $svc_broadband->{Hash}->{speed_down},
217 my $virtual_ap = process_virtual_ap($self, $virtual_ap_opt);
218 return $self->api_error if $self->{'__saisei_error'};
220 ## tie host to user add sector name as access point.
221 $self->api_add_host_to_user(
222 $user->{collection}->[0]->{name},
223 $rateplan->{collection}->[0]->{name},
224 $svc_broadband->{Hash}->{ip_addr},
225 $virtual_ap->{collection}->[0]->{name},
226 ) unless $self->{'__saisei_error'};
229 return $self->api_error;
233 sub _export_replace {
234 my ($self, $svc_broadband) = @_;
235 my $error = $self->_export_insert($svc_broadband);
240 my ($self, $svc_broadband) = @_;
242 my $rateplan_name = $self->get_rateplan_name($svc_broadband);
244 my $username = $svc_broadband->{Hash}->{svcnum};
246 ## untie host to user
247 $self->api_delete_host_to_user($username, $rateplan_name, $svc_broadband->{Hash}->{ip_addr}) unless $self->{'__saisei_error'};
252 sub _export_suspend {
253 my ($self, $svc_broadband) = @_;
257 sub _export_unsuspend {
258 my ($self, $svc_broadband) = @_;
263 my ($self, $svc_part) = @_;
266 if ($svc_part->{Hash}->{svc_broadband__speed_down} eq "down" || $svc_part->{Hash}->{svc_broadband__speed_up} eq "up") {
267 for my $type (qw( down up )) {
268 my $speed_type = "broadband_".$type."stream";
269 foreach my $pkg_svc (FS::Record::qsearch({
270 'table' => 'pkg_svc',
271 'select' => 'pkg_svc.*, part_pkg_fcc_option.fccoptionname, part_pkg_fcc_option.optionvalue',
272 'addl_from' => ' LEFT JOIN part_pkg_fcc_option USING (pkgpart) ',
273 'extra_sql' => " WHERE pkg_svc.svcpart = ".$svc_part->{Hash}->{svcpart}." AND pkg_svc.quantity > 0 AND part_pkg_fcc_option.fccoptionname = '".$speed_type."'",
274 })) { $fcc_477_speeds->{
275 $pkg_svc->{Hash}->{pkgpart}}->{$speed_type} = $pkg_svc->{Hash}->{optionvalue} * 1000 unless !$pkg_svc->{Hash}->{optionvalue}; }
279 $fcc_477_speeds->{1}->{broadband_downstream} = $svc_part->{Hash}->{"svc_broadband__speed_down"};
280 $fcc_477_speeds->{1}->{broadband_upstream} = $svc_part->{Hash}->{"svc_broadband__speed_up"};
283 foreach my $key (keys %$fcc_477_speeds) {
285 $svc_part->{Hash}->{speed_down} = $fcc_477_speeds->{$key}->{broadband_downstream};
286 $svc_part->{Hash}->{speed_up} = $fcc_477_speeds->{$key}->{broadband_upstream};
287 $svc_part->{Hash}->{svc_broadband__speed_down} = $fcc_477_speeds->{$key}->{broadband_downstream};
288 $svc_part->{Hash}->{svc_broadband__speed_up} = $fcc_477_speeds->{$key}->{broadband_upstream};
290 my $temp_svc = $svc_part->{Hash};
291 my $svc_broadband = {};
292 map { if ($_ =~ /^svc_broadband__(.*)$/) { $svc_broadband->{Hash}->{$1} = $temp_svc->{$_}; } } keys %$temp_svc;
294 my $rateplan_name = $self->get_rateplan_name($svc_broadband, $svc_part->{Hash}->{svc});
296 # check for existing rate plan
297 my $existing_rateplan;
298 $existing_rateplan = $self->api_get_rateplan($rateplan_name) unless $self->{'__saisei_error'};
300 # Modify the existing rate plan with new service data.
301 $self->api_modify_existing_rateplan($svc_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || !$existing_rateplan);
303 # if no existing rate plan create one and modify it.
304 $self->api_create_rateplan($svc_broadband, $rateplan_name) unless $existing_rateplan;
305 $self->api_modify_rateplan($svc_part, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan);
309 return $self->api_error;
313 sub export_tower_sector {
314 my ($self, $tower) = @_;
316 #modify tower or create it.
317 my $tower_name = $tower->{Hash}->{towername};
318 $tower_name =~ s/\s/_/g;
320 'tower_name' => $tower_name,
321 'tower_uprate_limit' => $tower->{Hash}->{up_rate_limit},
322 'tower_downrate_limit' => $tower->{Hash}->{down_rate_limit},
323 'modify_existing' => '1', # modify an existing access point with this info
326 my $tower_access_point = process_tower($self, $tower_opt);
327 return $tower_access_point if $tower_access_point->{error};
329 #get list of all access points
331 'table' => 'tower_sector',
333 'hashref' => { 'towernum' => $tower->{Hash}->{towernum}, },
336 #for each one modify or create it.
337 foreach my $tower_sector ( FS::Record::qsearch($hash_opt) ) {
338 my $sector_name = $tower_sector->{Hash}->{sectorname};
339 $sector_name =~ s/\s/_/g;
341 'tower_name' => $tower_name,
342 'sector_name' => $sector_name,
343 'sector_uprate_limit' => $tower_sector->{Hash}->{up_rate_limit},
344 'sector_downrate_limit' => $tower_sector->{Hash}->{down_rate_limit},
345 'modify_existing' => '1', # modify an existing access point with this info
347 my $sector_access_point = process_sector($self, $sector_opt) unless ($sector_name eq "_default");
348 return $sector_access_point if $sector_access_point->{error};
351 return { error => $self->api_error, };
354 ## creates the rateplan name
355 sub get_rateplan_name {
356 my ($self, $svc_broadband, $svc_name) = @_;
358 my $service_part = FS::Record::qsearchs( 'part_svc', { 'svcpart' => $svc_broadband->{Hash}->{svcpart} } ) unless $svc_name;
359 my $service_name = $svc_name ? $svc_name : $service_part->{Hash}->{svc};
361 my $rateplan_name = $service_name . " " . $svc_broadband->{Hash}->{speed_down} . "-" . $svc_broadband->{Hash}->{speed_up};
362 $rateplan_name =~ s/\s/_/g; $rateplan_name =~ s/[^A-Za-z0-9\-_]//g;
364 return $rateplan_name;
369 These methods allow access to the Saisei API using the credentials
370 set in the export options.
376 Accepts I<$method>, I<$path>, I<$params> hashref and optional.
377 Places an api call to the specified path and method with the specified params.
378 Returns the decoded json object returned by the api call.
379 Returns empty on failure; retrieve error messages using L</api_error>.
384 my ($self,$method,$path,$params) = @_;
386 $self->{'__saisei_error'} = '';
387 my $auth_info = $self->option('username') . ':' . $self->option('password');
390 warn "Calling $method on http://"
391 .$self->{Hash}->{machine}.':'.$self->option('port')
392 ."/rest/top/configurations/running/$path\n" if $self->option('debug');
394 my $data = encode_json($params) if keys %{ $params };
396 my $client = REST::Client->new();
397 $client->addHeader("Authorization", "Basic ".encode_base64($auth_info));
398 $client->setHost('http://'.$self->{Hash}->{machine}.':'.$self->option('port'));
399 $client->$method('/rest/top/configurations/running'.$path, $data, { "Content-type" => 'application/json'});
401 warn "Saisei Response Code is ".$client->responseCode()."\n" if $self->option('debug');
405 if ($client->responseCode() eq '200' || $client->responseCode() eq '201') {
406 eval { $result = decode_json($client->responseContent()) };
408 $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.";
409 warn "Saisei RC 201 Response Content is not json\n".$client->responseContent()."\n" if $self->option('debug');
413 elsif ($client->responseCode() eq '404') {
414 eval { $result = decode_json($client->responseContent()) };
416 $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.";
417 warn "Saisei RC 404 Response Content is not json\n".$client->responseContent()."\n" if $self->option('debug');
420 ## check if message is for empty hash.
421 my($does_not_exist) = $result->{message} =~ /'(.*)' does not exist$/;
422 $self->{'__saisei_error'} = "Saisei Error: ".$result->{message} unless $does_not_exist;
423 warn "Saisei Response Content is\n".$client->responseContent."\n" if ($self->option('debug') && !$does_not_exist);
426 elsif ($client->responseCode() eq '500') {
427 $self->{'__saisei_error'} = "Could not connect to the host (".$self->{Hash}->{machine}.':'.$self->option('port').") during $method , we received the responce code: " . $client->responseCode();
428 warn "Saisei Response Content is\n".$client->responseContent."\n" if $self->option('debug');
432 $self->{'__saisei_error'} = "Received Bad response from server during $method , we received responce code: " . $client->responseCode();
433 warn "Saisei Response Content is\n".$client->responseContent."\n" if $self->option('debug');
443 Returns the error string set by L</Saisei API> methods,
444 or a blank string if most recent call produced no errors.
450 return $self->{'__saisei_error'} || '';
453 =head2 api_get_policies
455 Gets a list of global policies.
459 sub api_get_policies {
462 my $get_policies = $self->api_call("GET", '/policies/?token=1&order=name&start=0&limit=20&select=name%2Cpercent_rate%2Cassured%2C');
463 return if $self->api_error;
464 $self->{'__saisei_error'} = "Did not receive any global policies from Saisei."
465 unless $get_policies;
467 return $get_policies->{collection};
470 =head2 api_get_rateplan
472 Gets rateplan info for specific rateplan.
476 sub api_get_rateplan {
478 my $rateplan = shift;
480 my $get_rateplan = $self->api_call("GET", "/rate_plans/$rateplan");
481 return if $self->api_error;
483 return $get_rateplan;
488 Gets user info for specific user.
496 my $get_user = $self->api_call("GET", "/users/$user");
497 return if $self->api_error;
502 =head2 api_get_accesspoint
504 Gets user info for specific access point.
508 sub api_get_accesspoint {
510 my $accesspoint = shift;
512 my $get_accesspoint = $self->api_call("GET", "/access_points/$accesspoint");
513 return if $self->api_error;
515 return $get_accesspoint;
520 Gets user info for specific host.
528 my $get_host = $self->api_call("GET", "/hosts/$ip");
530 return { message => $self->api_error, } if $self->api_error;
535 =head2 api_create_rateplan
541 sub api_create_rateplan {
542 my ($self, $svc, $rateplan) = @_;
544 $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};
545 $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};
547 my $new_rateplan = $self->api_call(
549 "/rate_plans/$rateplan",
551 'downstream_rate' => $svc->{Hash}->{speed_down},
552 'upstream_rate' => $svc->{Hash}->{speed_up},
554 ) unless $self->{'__saisei_error'};
556 $self->{'__saisei_error'} = "Saisei could not create the rate plan $rateplan."
557 unless ($new_rateplan || $self->{'__saisei_error'});
559 return $new_rateplan;
563 =head2 api_modify_rateplan
565 Modify a new rateplan.
569 sub api_modify_rateplan {
570 my ($self,$svc,$rateplan_name) = @_;
573 my $policies = $self->api_get_policies();
575 foreach my $policy (@$policies) {
576 my $policyname = $policy->{name};
577 my $rate_multiplier = '';
578 if ($policy->{background}) { $rate_multiplier = ".01"; }
579 my $modified_rateplan = $self->api_call(
581 "/rate_plans/$rateplan_name/partitions/$policyname",
583 'restricted' => $policy->{assured}, # policy_assured_flag
584 'rate_multiplier' => $rate_multiplier, # policy_background 0.1
585 'rate' => $policy->{percent_rate}, # policy_percent_rate
589 $self->{'__saisei_error'} = "Saisei could not modify the rate plan $rateplan_name after it was created."
590 unless ($modified_rateplan || $self->{'__saisei_error'}); # should never happen
598 =head2 api_modify_existing_rateplan
600 Modify a existing rateplan.
604 sub api_modify_existing_rateplan {
605 my ($self,$svc,$rateplan_name) = @_;
607 my $modified_rateplan = $self->api_call(
609 "/rate_plans/$rateplan_name",
611 'downstream_rate' => $svc->{Hash}->{speed_down},
612 'upstream_rate' => $svc->{Hash}->{speed_up},
616 $self->{'__saisei_error'} = "Saisei could not modify the rate plan $rateplan_name."
617 unless ($modified_rateplan || $self->{'__saisei_error'}); # should never happen
623 =head2 api_create_user
629 sub api_create_user {
630 my ($self,$user, $description) = @_;
632 my $new_user = $self->api_call(
636 'description' => $description,
640 $self->{'__saisei_error'} = "Saisei could not create the user $user"
641 unless ($new_user || $self->{'__saisei_error'}); # should never happen
647 =head2 api_create_accesspoint
649 Creates a access point.
653 sub api_create_accesspoint {
654 my ($self,$accesspoint, $upratelimit, $downratelimit) = @_;
656 my $new_accesspoint = $self->api_call(
658 "/access_points/$accesspoint",
660 'downstream_rate_limit' => $downratelimit,
661 'upstream_rate_limit' => $upratelimit,
665 $self->{'__saisei_error'} = "Saisei could not create the access point $accesspoint"
666 unless ($new_accesspoint || $self->{'__saisei_error'}); # should never happen
671 =head2 api_modify_accesspoint
673 Modify a new access point.
677 sub api_modify_accesspoint {
678 my ($self, $accesspoint, $uplink) = @_;
680 my $modified_accesspoint = $self->api_call(
682 "/access_points/$accesspoint",
684 'uplink' => $uplink, # name of attached access point
688 $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint after it was created."
689 unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
695 =head2 api_modify_existing_accesspoint
697 Modify a existing accesspoint.
701 sub api_modify_existing_accesspoint {
702 my ($self, $accesspoint, $uplink, $upratelimit, $downratelimit) = @_;
704 my $modified_accesspoint = $self->api_call(
706 "/access_points/$accesspoint",
708 'downstream_rate_limit' => $downratelimit,
709 'upstream_rate_limit' => $upratelimit,
710 # 'uplink' => $uplink, # name of attached access point
714 $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint."
715 unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
721 =head2 api_add_host_to_user
723 ties host to user, rateplan and default access point.
727 sub api_add_host_to_user {
728 my ($self,$user, $rateplan, $ip, $accesspoint) = @_;
730 my $new_host = $self->api_call(
735 'rate_plan' => $rateplan,
736 'access_point' => $accesspoint,
740 $self->{'__saisei_error'} = "Saisei could not create the host $ip"
741 unless ($new_host || $self->{'__saisei_error'}); # should never happen
747 =head2 api_delete_host_to_user
749 unties host from user and rateplan.
750 this will set the host entry at Saisei to the default rate plan with the user and access point set to <none>.
754 sub api_delete_host_to_user {
755 my ($self,$user, $rateplan, $ip) = @_;
757 my $default_rate_plan = $self->api_call("GET", '?token=1&select=default_rate_plan');
758 return if $self->api_error;
759 $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."
760 unless $default_rate_plan;
762 my $default_rateplan_name = $default_rate_plan->{collection}->[0]->{default_rate_plan}->{link}->{name};
764 my $delete_host = $self->api_call(
769 'access_point' => '<none>',
770 'rate_plan' => $default_rateplan_name,
774 $self->{'__saisei_error'} = "Saisei could not delete the host $ip"
775 unless ($delete_host || $self->{'__saisei_error'}); # should never happen
782 my ($self, $opt) = @_;
784 if (!$opt->{tower_uprate_limit} || !$opt->{tower_downrate_limit}) {
785 $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.";
786 return { error => $self->api_error, };
789 my $existing_tower_ap;
790 my $tower_name = $opt->{tower_name};
792 #check if tower has been set up as an access point.
793 $existing_tower_ap = $self->api_get_accesspoint($tower_name) unless $self->{'__saisei_error'};
795 # modify the existing accesspoint if changing tower .
796 $self->api_modify_existing_accesspoint (
798 '', # tower does not have a uplink on sectors.
799 $opt->{tower_uprate_limit},
800 $opt->{tower_downrate_limit},
801 ) if $existing_tower_ap->{collection} && $opt->{modify_existing};
803 #if tower does not exist as an access point create it.
804 $self->api_create_accesspoint(
806 $opt->{tower_uprate_limit},
807 $opt->{tower_downrate_limit},
808 ) unless $existing_tower_ap->{collection};
810 my $accesspoint = $self->api_get_accesspoint($tower_name);
812 return { error => $self->api_error, } if $self->api_error;
817 my ($self, $opt) = @_;
819 if (!$opt->{sector_uprate_limit} || !$opt->{sector_downrate_limit}) {
820 $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.";
821 return { error => $self->api_error, };
824 my $existing_sector_ap;
825 my $sector_name = $opt->{sector_name};
827 #check if sector has been set up as an access point.
828 $existing_sector_ap = $self->api_get_accesspoint($sector_name);
830 # modify the existing accesspoint if changing sector .
831 $self->api_modify_existing_accesspoint (
834 $opt->{sector_uprate_limit},
835 $opt->{sector_downrate_limit},
836 ) if $existing_sector_ap && $opt->{modify_existing};
838 #if sector does not exist as an access point create it.
839 $self->api_create_accesspoint(
841 $opt->{sector_uprate_limit},
842 $opt->{sector_downrate_limit},
843 ) unless $existing_sector_ap;
845 # Attach newly created sector to it's tower.
846 $self->api_modify_accesspoint($sector_name, $opt->{tower_name}) unless ($self->{'__saisei_error'} || $existing_sector_ap);
848 # set access point to existing one or newly created one.
849 my $accesspoint = $existing_sector_ap ? $existing_sector_ap : $self->api_get_accesspoint($sector_name);
851 return { error => $self->api_error, } if $self->api_error;
855 sub process_virtual_ap {
856 my ($self, $opt) = @_;
858 my $existing_virtual_ap;
859 my $virtual_name = $opt->{virtual_name};
861 #check if virtual_ap has been set up as an access point.
862 $existing_virtual_ap = $self->api_get_accesspoint($virtual_name);
864 # modify the existing virtual accesspoint if changing it. this should never happen
865 $self->api_modify_existing_accesspoint (
868 $opt->{virtual_uprate_limit},
869 $opt->{virtual_downrate_limit},
870 ) if $existing_virtual_ap && $opt->{modify_existing};
872 #if virtual ap does not exist as an access point create it.
873 $self->api_create_accesspoint(
875 $opt->{virtual_uprate_limit},
876 $opt->{virtual_downrate_limit},
877 ) unless $existing_virtual_ap;
880 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})) {
884 # Attach newly created virtual ap to tower sector ap or if sector has changed.
885 $self->api_modify_accesspoint($virtual_name, $opt->{sector_name}) unless ($self->{'__saisei_error'} || ($existing_virtual_ap && !$update_sector));
887 # set access point to existing one or newly created one.
888 my $accesspoint = $existing_virtual_ap ? $existing_virtual_ap : $self->api_get_accesspoint($virtual_name);
893 sub export_provisioned_services {
895 my $param = thaw(decode_base64(shift));
897 my $part_export = FS::Record::qsearchs('part_export', { 'exportnum' => $param->{export_provisioned_services_exportnum}, } )
898 or die "You are trying to use an unknown exportnum $param->{export_provisioned_services_exportnum}. This export does not exist.\n";
901 my @svcparts = FS::Record::qsearch({
902 'table' => 'export_svc',
903 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart ) ',
904 'hashref' => { 'exportnum' => $param->{export_provisioned_services_exportnum}, },
906 my $part_count = scalar @svcparts;
908 my $parts = join "', '", map { $_->{Hash}->{svcpart} } @svcparts;
910 my @svcs = FS::Record::qsearch({
911 'table' => 'cust_svc',
912 'addl_from' => 'LEFT JOIN svc_broadband USING ( svcnum ) ',
913 'extra_sql' => " WHERE svcpart in ('".$parts."')",
916 my $svc_count = scalar @svcs;
919 for (my $c=1; $c <=100; $c=$c+1) { $status{int($svc_count * ($c/100))} = $c; }
922 foreach my $svc (@svcs) {
923 if ($status{$process_count}) { my $s = $status{$process_count}; $job->update_statustext($s); }
924 ## check if service exists as host if not export it.
925 my $host = api_get_host($part_export, $svc->{Hash}->{ip_addr});
926 die ("Please double check your credentials as ".$host->{message}."\n") if $host->{message};
927 warn "Exporting service ".$svc->{Hash}->{ip_addr}."\n" if ($part_export->option('debug'));
928 my $export_error = _export_insert($part_export,$svc) unless $host->{collection};
930 warn "Error exporting service ".$svc->{Hash}->{ip_addr}."\n" if ($part_export->option('debug'));
931 die ("$export_error\n");