use REST::Client;
use Data::Dumper;
use FS::Conf;
+use Carp qw(carp);
=pod
This export offers basic svc_broadband provisioning for Saisei.
-This is a customer integration with Saisei. This will setup a rate plan and tie
-the rate plan to a host via the Saisei API when the broadband service is provisioned.
-It will also untie the rate plan via the API upon unprovisioning of the broadband service.
+This is a customer integration with Saisei. This will set up a rate plan and tie
+the rate plan to a host and the access point via the Saisei API when the broadband service is provisioned.
+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.
-This export will use the broadband service descriptive label for the Saisei rate plan name and
-will use the email from the first contact for the Saisei username that will be
-attached to this rate plan. It will use the Saisei default Access Point.
+This will create and modify the rate plans at Saisei as soon as the broadband service attached to this export is created or modified.
+This will also create and modify an access point at Saisei as soon as the tower is created or modified.
-Hostname or IP - Host name to Saisei API
-Port - <I>Port number to Saisei API
-User Name - <I>Saisei API user name
-Password - <I>Saisei API password
+To use this export, follow the below instructions:
+
+Create a new service definition and set the table to svc_broadband. The service name will become the Saisei rate plan name.
+Set the upload and download speed for the service. This is required to be able to export the service to Saisei.
+Attach this Saisei export to this service.
+
+Create a tower and add a sector to that tower. The sector name will be the name of the access point,
+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.
+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.
+Each sector will be attached to its tower access point using the Saisei uplink field.
+
+Create a package for the above created service, and order this package for a customer.
+
+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.
+This provisioned service will then be exported as a host to Saisei.
+
+Unprovisioning this service will set the host entry at Saisei to the default rate plan with the user and access point set to <none>.
+
+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.
+Clicking on this link will export all services attached to this export not currently exported to Saisei.
This module also provides generic methods for working through the L</Saisei API>.
=cut
+tie my %scripts, 'Tie::IxHash',
+ 'export_provisioned_services' => { component => '/elements/popup_link.html',
+ label => 'Export provisioned services',
+ description => 'will export provisioned services of part service with Saisei export attached.',
+ html_label => '<b>Export provisioned services attached to this export.</b>',
+ error_url => '/edit/part_export.cgi?',
+ success_message => 'Saisei export of provisioned services successful',
+ },
+;
+
tie my %options, 'Tie::IxHash',
'port' => { label => 'Port',
default => 5000 },
- 'username' => { label => 'User Name',
+ 'username' => { label => 'Saisei API User Name',
default => '' },
- 'password' => { label => 'Password',
+ 'password' => { label => 'Saisei API Password',
default => '' },
'debug' => { type => 'checkbox',
label => 'Enable debug warnings' },
'svc' => 'svc_broadband',
'desc' => 'Export broadband service/account to Saisei',
'options' => \%options,
+ 'scripts' => \%scripts,
'notes' => <<'END',
-This is a customer integration with Saisei. This will setup a rate plan and tie
-the rate plan to a host via the Saisei API when the broadband service is provisioned.
-It will also untie the rate plan via the API upon unprovisioning of the broadband service.
-<P>This export will use the broadband service descriptive label for the Saisei rate plan name and
-will use the email from the first contact for the Saisei username that will be
-attached to this rate plan. It will use the Saisei default Access Point.
+This is a customer integration with Saisei. This will set up a rate plan and tie
+the rate plan to a host and the access point via the Saisei API when the broadband service is provisioned.
+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.
+<P>
+This will create and modify the rate plans at Saisei as soon as the broadband service attached to this export is created or modified.
+This will also create and modify an access point at Saisei as soon as the tower is created or modified.
+<P>
+To use this export, follow the below instructions:
+<P>
+<OL>
+<LI>
+Create a new service definition and set the table to svc_broadband. The service name will become the Saisei rate plan name.
+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.
+Attach this Saisei export to this service.
+</LI>
+<P>
+<LI>
+Create a tower and add a sector to that tower. The sector name will be the name of the access point,
+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.
+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.
+Each sector will be attached to its tower access point using the Saisei uplink field.
+</LI>
<P>
-Required Fields:
-<UL>
-<LI>Hostname or IP - <I>Host name to Saisei API</I></LI>
-<LI>Port - <I>Port number to Saisei API</I></LI>
-<LI>User Name - <I>Saisei API user name</I></LI>
-<LI>Password - <I>Saisei API password</I></LI>
-</UL>
+<LI>
+Create a package for the above created service, and order this package for a customer.
+</LI>
+<P>
+<LI>
+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.
+This provisioned service will then be exported as a host to Saisei.
+<P>
+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>.
+</LI>
+<P>
+<LI>
+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>.
+Clicking on this link will export all services attached to this export not currently exported to Saisei.
+</LI>
+</OL>
+<P>
+<A HREF="http://www.freeside.biz/mediawiki/index.php/Saisei_provisioning_export" target="_new">Documentation</a>
END
);
sub _export_insert {
my ($self, $svc_broadband) = @_;
- my $rateplan_name = $svc_broadband->{Hash}->{description};
- $rateplan_name =~ s/\s/_/g;
-
- # load needed info from our end
- my $cust_main = $svc_broadband->cust_main;
- return "Could not load service customer" unless $cust_main;
- my $conf = new FS::Conf;
-
- # get policy list
- my $policies = $self->api_get_policies();
+ my $rateplan_name = $self->get_rateplan_name($svc_broadband);
# check for existing rate plan
my $existing_rateplan;
# if no existing rate plan create one and modify it.
$self->api_create_rateplan($svc_broadband, $rateplan_name) unless $existing_rateplan;
- $self->api_modify_rateplan($policies->{collection}, $svc_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan);
+ $self->api_modify_rateplan($svc_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan);
+ return $self->api_error if $self->{'__saisei_error'};
# set rateplan to existing one or newly created one.
my $rateplan = $existing_rateplan ? $existing_rateplan : $self->api_get_rateplan($rateplan_name);
- my @email = map { $_->emailaddress } FS::Record::qsearch({
- 'table' => 'cust_contact',
- 'select' => 'emailaddress',
- 'addl_from' => ' JOIN contact_email USING (contactnum)',
- 'hashref' => { 'custnum' => $cust_main->{Hash}->{custnum}, },
- });
- my $username = $email[0];
- my $description = $cust_main->{Hash}->{first}." ".$cust_main->{Hash}->{last};
+ my $username = $svc_broadband->{Hash}->{svcnum};
+ my $description = $svc_broadband->{Hash}->{description};
if (!$username) {
$self->{'__saisei_error'} = 'no username - can not export';
- warn "No email found $username\n" if $self->option('debug');
- return;
+ return $self->api_error;
}
else {
# check for existing user.
# if no existing user create one.
$self->api_create_user($username, $description) unless $existing_user;
+ return $self->api_error if $self->{'__saisei_error'};
# set user to existing one or newly created one.
my $user = $existing_user ? $existing_user : $self->api_get_user($username);
- ## add access point ?
-
- ## tie host to user
- $self->api_add_host_to_user($user->{collection}->[0]->{name}, $rateplan->{collection}->[0]->{name}, $svc_broadband->{Hash}->{ip_addr}) unless $self->{'__saisei_error'};
+ ## add access point
+ my $tower_sector = FS::Record::qsearchs({
+ 'table' => 'tower_sector',
+ 'select' => 'tower.towername,
+ 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 )',
+ 'hashref' => {
+ 'sectornum' => $svc_broadband->{Hash}->{sectornum},
+ },
+ });
+
+ my $tower_name = $tower_sector->{Hash}->{towername};
+ $tower_name =~ s/\s/_/g;
+
+ 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},
+ };
+
+ my $tower_ap = process_tower($self, $tower_opt);
+ return $self->api_error if $self->{'__saisei_error'};
+
+ my $sector_name = $tower_sector->{Hash}->{sectorname};
+ $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}->{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'};
+
+## get custnum and pkgpart from cust_pkg for virtual access point
+ my $cust_pkg = FS::Record::qsearchs({
+ 'table' => 'cust_pkg',
+ 'hashref' => { 'pkgnum' => $svc_broadband->{Hash}->{pkgnum}, },
+ });
+ my $virtual_ap_name = $cust_pkg->{Hash}->{custnum}.'_'.$cust_pkg->{Hash}->{pkgpart}.'_'.$svc_broadband->{Hash}->{speed_down}.'_'.$svc_broadband->{Hash}->{speed_up};
+
+ my $virtual_ap_opt = {
+ 'virtual_name' => $virtual_ap_name,
+ 'sector_name' => $sector_name,
+ 'virtual_uprate_limit' => $svc_broadband->{Hash}->{speed_up},
+ 'virtual_downrate_limit' => $svc_broadband->{Hash}->{speed_down},
+ };
+ my $virtual_ap = process_virtual_ap($self, $virtual_ap_opt);
+ return $self->api_error if $self->{'__saisei_error'};
+
+ ## tie host to user add sector name as access point.
+ $self->api_add_host_to_user(
+ $user->{collection}->[0]->{name},
+ $rateplan->{collection}->[0]->{name},
+ $svc_broadband->{Hash}->{ip_addr},
+ $virtual_ap->{collection}->[0]->{name},
+ ) unless $self->{'__saisei_error'};
}
- return '';
+ return $self->api_error;
}
sub _export_replace {
- my ($self, $svc_phone) = @_;
- return '';
+ my ($self, $svc_broadband) = @_;
+ my $error = $self->_export_insert($svc_broadband);
+ return $error;
}
sub _export_delete {
my ($self, $svc_broadband) = @_;
- my $cust_main = $svc_broadband->cust_main;
- return "Could not load service customer" unless $cust_main;
- my $conf = new FS::Conf;
+ my $rateplan_name = $self->get_rateplan_name($svc_broadband);
- my $rateplan_name = $svc_broadband->{Hash}->{description};
- $rateplan_name =~ s/\s/_/g;
+ my $username = $svc_broadband->{Hash}->{svcnum};
- my @email = map { $_->emailaddress } FS::Record::qsearch({
- 'table' => 'cust_contact',
- 'select' => 'emailaddress',
- 'addl_from' => ' JOIN contact_email USING (contactnum)',
- 'hashref' => { 'custnum' => $cust_main->{Hash}->{custnum}, },
- });
- my $username = $email[0];
-
- ## tie host to user
+ ## untie host to user
$self->api_delete_host_to_user($username, $rateplan_name, $svc_broadband->{Hash}->{ip_addr}) unless $self->{'__saisei_error'};
return '';
}
sub _export_suspend {
- my ($self, $svc_phone) = @_;
+ my ($self, $svc_broadband) = @_;
return '';
}
sub _export_unsuspend {
- my ($self, $svc_phone) = @_;
+ my ($self, $svc_broadband) = @_;
return '';
}
+sub export_partsvc {
+ my ($self, $svc_part) = @_;
+
+ if ( $FS::svc_Common::noexport_hack ) {
+ carp 'export_partsvc() suppressed by noexport_hack'
+ if $self->option('debug');
+ return;
+ }
+
+ my $fcc_477_speeds;
+ if ($svc_part->{Hash}->{svc_broadband__speed_down} eq "down" || $svc_part->{Hash}->{svc_broadband__speed_up} eq "up") {
+ for my $type (qw( down up )) {
+ my $speed_type = "broadband_".$type."stream";
+ foreach my $pkg_svc (FS::Record::qsearch({
+ 'table' => 'pkg_svc',
+ 'select' => 'pkg_svc.*, part_pkg_fcc_option.fccoptionname, part_pkg_fcc_option.optionvalue',
+ 'addl_from' => ' LEFT JOIN part_pkg_fcc_option USING (pkgpart) ',
+ 'extra_sql' => " WHERE pkg_svc.svcpart = ".$svc_part->{Hash}->{svcpart}." AND pkg_svc.quantity > 0 AND part_pkg_fcc_option.fccoptionname = '".$speed_type."'",
+ })) { $fcc_477_speeds->{
+ $pkg_svc->{Hash}->{pkgpart}}->{$speed_type} = $pkg_svc->{Hash}->{optionvalue} * 1000 unless !$pkg_svc->{Hash}->{optionvalue}; }
+ }
+ }
+ else {
+ $fcc_477_speeds->{1}->{broadband_downstream} = $svc_part->{Hash}->{"svc_broadband__speed_down"};
+ $fcc_477_speeds->{1}->{broadband_upstream} = $svc_part->{Hash}->{"svc_broadband__speed_up"};
+ }
+
+ foreach my $key (keys %$fcc_477_speeds) {
+
+ $svc_part->{Hash}->{speed_down} = $fcc_477_speeds->{$key}->{broadband_downstream};
+ $svc_part->{Hash}->{speed_up} = $fcc_477_speeds->{$key}->{broadband_upstream};
+ $svc_part->{Hash}->{svc_broadband__speed_down} = $fcc_477_speeds->{$key}->{broadband_downstream};
+ $svc_part->{Hash}->{svc_broadband__speed_up} = $fcc_477_speeds->{$key}->{broadband_upstream};
+
+ my $temp_svc = $svc_part->{Hash};
+ my $svc_broadband = {};
+ map { if ($_ =~ /^svc_broadband__(.*)$/) { $svc_broadband->{Hash}->{$1} = $temp_svc->{$_}; } } keys %$temp_svc;
+
+ my $rateplan_name = $self->get_rateplan_name($svc_broadband, $svc_part->{Hash}->{svc});
+
+ # check for existing rate plan
+ my $existing_rateplan;
+ $existing_rateplan = $self->api_get_rateplan($rateplan_name) unless $self->{'__saisei_error'};
+
+ # Modify the existing rate plan with new service data.
+ $self->api_modify_existing_rateplan($svc_broadband, $rateplan_name) unless ($self->{'__saisei_error'} || !$existing_rateplan);
+
+ # if no existing rate plan create one and modify it.
+ $self->api_create_rateplan($svc_broadband, $rateplan_name) unless $existing_rateplan;
+ $self->api_modify_rateplan($svc_part, $rateplan_name) unless ($self->{'__saisei_error'} || $existing_rateplan);
+
+ }
+
+ return $self->api_error;
+
+}
+
+sub export_tower_sector {
+ my ($self, $tower) = @_;
+
+ if ( $FS::svc_Common::noexport_hack ) {
+ carp 'export_tower_sector() suppressed by noexport_hack'
+ if $self->option('debug');
+ return;
+ }
+
+ #modify tower or create it.
+ my $tower_name = $tower->{Hash}->{towername};
+ $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
+ };
+
+ 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 = {
+ 'table' => 'tower_sector',
+ 'select' => '*',
+ 'hashref' => { 'towernum' => $tower->{Hash}->{towernum}, },
+ };
+
+ #for each one modify or create it.
+ foreach my $tower_sector ( FS::Record::qsearch($hash_opt) ) {
+ my $sector_name = $tower_sector->{Hash}->{sectorname};
+ $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) unless ($sector_name eq "_default");
+ return $sector_access_point if $sector_access_point->{error};
+ }
+
+ return { error => $self->api_error, };
+}
+
+## creates the rateplan name
+sub get_rateplan_name {
+ my ($self, $svc_broadband, $svc_name) = @_;
+
+ my $service_part = FS::Record::qsearchs( 'part_svc', { 'svcpart' => $svc_broadband->{Hash}->{svcpart} } ) unless $svc_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/[^A-Za-z0-9\-_]//g;
+
+ return $rateplan_name;
+}
+
=head1 Saisei API
These methods allow access to the Saisei API using the credentials
sub api_call {
my ($self,$method,$path,$params) = @_;
+
$self->{'__saisei_error'} = '';
my $auth_info = $self->option('username') . ':' . $self->option('password');
$params ||= {};
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 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: " . $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;
}
=head2 api_error
-Returns the error string set by L</PortaOne API> methods,
+Returns the error string set by L</Saisei API> methods,
or a blank string if most recent call produced no errors.
=cut
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;
+ return $get_policies->{collection};
}
=head2 api_get_rateplan
my $get_rateplan = $self->api_call("GET", "/rate_plans/$rateplan");
return if $self->api_error;
- $self->{'__saisei_error'} = "Did not receive any rateplan info"
- unless $get_rateplan;
return $get_rateplan;
}
my $get_user = $self->api_call("GET", "/users/$user");
return if $self->api_error;
- $self->{'__saisei_error'} = "Did not receive any user info"
- unless $get_user;
return $get_user;
}
sub api_get_accesspoint {
my $self = shift;
- my $accesspoint;
+ my $accesspoint = shift;
my $get_accesspoint = $self->api_call("GET", "/access_points/$accesspoint");
return if $self->api_error;
- $self->{'__saisei_error'} = "Did not receive any user info"
- unless $get_accesspoint;
- return;
+ return $get_accesspoint;
+}
+
+=head2 api_get_host
+
+Gets user info for specific host.
+
+=cut
+
+sub api_get_host {
+ my $self = shift;
+ my $ip = shift;
+
+ my $get_host = $self->api_call("GET", "/hosts/$ip");
+
+ return { message => $self->api_error, } if $self->api_error;
+
+ return $get_host;
}
=head2 api_create_rateplan
sub api_create_rateplan {
my ($self, $svc, $rateplan) = @_;
+ $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",
"/rate_plans/$rateplan",
'downstream_rate' => $svc->{Hash}->{speed_down},
'upstream_rate' => $svc->{Hash}->{speed_up},
},
- );
+ ) unless $self->{'__saisei_error'};
+
+ $self->{'__saisei_error'} = "Saisei could not create the rate plan $rateplan."
+ unless ($new_rateplan || $self->{'__saisei_error'});
- $self->{'__saisei_error'} = "Rate Plan not created"
- unless $new_rateplan; # should never happen
return $new_rateplan;
}
=head2 api_modify_rateplan
-Modify a rateplan.
+Modify a new rateplan.
=cut
sub api_modify_rateplan {
- my ($self,$policies,$svc,$rateplan_name) = @_;
+ my ($self,$svc,$rateplan_name) = @_;
+
+ # get policy list
+ my $policies = $self->api_get_policies();
foreach my $policy (@$policies) {
my $policyname = $policy->{name};
},
);
- $self->{'__saisei_error'} = "Rate Plan not modified"
- unless $modified_rateplan; # should never happen
+ $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
}
}
+=head2 api_modify_existing_rateplan
+
+Modify a existing rateplan.
+
+=cut
+
+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",
+ {
+ 'downstream_rate' => $svc->{Hash}->{speed_down},
+ 'upstream_rate' => $svc->{Hash}->{speed_up},
+ },
+ );
+
+ $self->{'__saisei_error'} = "Saisei could not modify the rate plan $rateplan_name."
+ unless ($modified_rateplan || $self->{'__saisei_error'}); # should never happen
+
+ return;
+
+}
+
=head2 api_create_user
Creates a user.
},
);
- $self->{'__saisei_error'} = "User not created"
- unless $new_user; # should never happen
+ $self->{'__saisei_error'} = "Saisei could not create the user $user"
+ unless ($new_user || $self->{'__saisei_error'}); # should never happen
return $new_user;
=cut
sub api_create_accesspoint {
- my ($self,$accesspoint) = @_;
-
- # this has not been tested, but should work, if needed.
- #my $new_accesspoint = $self->api_call(
- # "PUT",
- # "/access_points/$accesspoint",
- # {
- # 'description' => 'my description',
- # },
- #);
-
- #$self->{'__saisei_error'} = "Access point not created"
- # unless $new_accesspoint; # should never happen
+ my ($self,$accesspoint, $upratelimit, $downratelimit) = @_;
+
+ my $new_accesspoint = $self->api_call(
+ "PUT",
+ "/access_points/$accesspoint",
+ {
+ 'downstream_rate_limit' => $downratelimit,
+ 'upstream_rate_limit' => $upratelimit,
+ },
+ );
+
+ $self->{'__saisei_error'} = "Saisei could not create the access point $accesspoint"
+ unless ($new_accesspoint || $self->{'__saisei_error'}); # should never happen
+ return;
+
+}
+
+=head2 api_modify_accesspoint
+
+Modify a new access point.
+
+=cut
+
+sub api_modify_accesspoint {
+ my ($self, $accesspoint, $uplink) = @_;
+
+ my $modified_accesspoint = $self->api_call(
+ "PUT",
+ "/access_points/$accesspoint",
+ {
+ 'uplink' => $uplink, # name of attached access point
+ },
+ );
+
+ $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;
+
+}
+
+=head2 api_modify_existing_accesspoint
+
+Modify a existing accesspoint.
+
+=cut
+
+sub api_modify_existing_accesspoint {
+ my ($self, $accesspoint, $uplink, $upratelimit, $downratelimit) = @_;
+
+ my $modified_accesspoint = $self->api_call(
+ "PUT",
+ "/access_points/$accesspoint",
+ {
+ 'downstream_rate_limit' => $downratelimit,
+ 'upstream_rate_limit' => $upratelimit,
+# 'uplink' => $uplink, # name of attached access point
+ },
+ );
+
+ $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint."
+ unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
+
return;
}
=cut
sub api_add_host_to_user {
- my ($self,$user, $rateplan, $ip) = @_;
+ my ($self,$user, $rateplan, $ip, $accesspoint) = @_;
my $new_host = $self->api_call(
"PUT",
{
'user' => $user,
'rate_plan' => $rateplan,
+ 'access_point' => $accesspoint,
},
);
- $self->{'__saisei_error'} = "Host not created"
- unless $new_host; # should never happen
+ $self->{'__saisei_error'} = "Saisei could not create the host $ip"
+ unless ($new_host || $self->{'__saisei_error'}); # should never happen
return $new_host;
=head2 api_delete_host_to_user
-unties host to user and rateplan.
+unties host from user and rateplan.
+this will set the host entry at Saisei to the default rate plan with the user and access point set to <none>.
=cut
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};
},
);
- $self->{'__saisei_error'} = "Host not created"
- unless $delete_host; # should never happen
+ $self->{'__saisei_error'} = "Saisei could not delete the host $ip"
+ unless ($delete_host || $self->{'__saisei_error'}); # should never happen
return $delete_host;
}
+sub process_tower {
+ my ($self, $opt) = @_;
+
+ if (!$opt->{tower_uprate_limit} || !$opt->{tower_downrate_limit}) {
+ $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, };
+ }
+
+ my $existing_tower_ap;
+ my $tower_name = $opt->{tower_name};
+
+ #check if tower has been set up as an access point.
+ $existing_tower_ap = $self->api_get_accesspoint($tower_name) unless $self->{'__saisei_error'};
+
+ # modify the existing accesspoint if changing tower .
+ $self->api_modify_existing_accesspoint (
+ $tower_name,
+ '', # tower does not have a uplink on sectors.
+ $opt->{tower_uprate_limit},
+ $opt->{tower_downrate_limit},
+ ) 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->{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 !--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, };
+ }
+
+ my $existing_sector_ap;
+ my $sector_name = $opt->{sector_name};
+
+ #check if sector has been set up as an access point.
+ $existing_sector_ap = $self->api_get_accesspoint($sector_name);
+
+ # modify the existing accesspoint if changing sector .
+ $self->api_modify_existing_accesspoint (
+ $sector_name,
+ $opt->{tower_name},
+ $opt->{sector_uprate_limit},
+ $opt->{sector_downrate_limit},
+ ) if $existing_sector_ap && $opt->{modify_existing};
+
+ #if sector does not exist as an access point create it.
+ $self->api_create_accesspoint(
+ $sector_name,
+ $opt->{sector_uprate_limit},
+ $opt->{sector_downrate_limit},
+ ) unless $existing_sector_ap;
+
+ # Attach newly created sector to it's tower.
+ $self->api_modify_accesspoint($sector_name, $opt->{tower_name}) unless ($self->{'__saisei_error'} || $existing_sector_ap);
+
+ # 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 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
+ $self->api_modify_existing_accesspoint (
+ $virtual_name,
+ $opt->{sector_name},
+ $opt->{virtual_uprate_limit},
+ $opt->{virtual_downrate_limit},
+ ) if $existing_virtual_ap && $opt->{modify_existing};
+
+ #if virtual ap does not exist as an access point create it.
+ $self->api_create_accesspoint(
+ $virtual_name,
+ $opt->{virtual_uprate_limit},
+ $opt->{virtual_downrate_limit},
+ ) unless $existing_virtual_ap;
+
+ 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));
+
+ # set access point to existing one or newly created one.
+ my $accesspoint = $existing_virtual_ap ? $existing_virtual_ap : $self->api_get_accesspoint($virtual_name);
+
+ return $accesspoint;
+}
+
+sub export_provisioned_services {
+ my $job = shift;
+ my $param = shift;
+
+ my $part_export = FS::Record::qsearchs('part_export', { '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({
+ 'table' => 'export_svc',
+ 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart ) ',
+ 'hashref' => { 'exportnum' => $param->{export_provisioned_services_exportnum}, },
+ });
+ my $part_count = scalar @svcparts;
+
+ my $parts = join "', '", map { $_->{Hash}->{svcpart} } @svcparts;
+
+ my @svcs = FS::Record::qsearch({
+ 'table' => 'cust_svc',
+ 'addl_from' => 'LEFT JOIN svc_broadband USING ( svcnum ) ',
+ 'extra_sql' => " WHERE svcpart in ('".$parts."')",
+ }) unless !$parts;
+
+ my $svc_count = scalar @svcs;
+
+ my %status = {};
+ for (my $c=1; $c <=100; $c=$c+1) { $status{int($svc_count * ($c/100))} = $c; }
+
+ my $process_count=0;
+ 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.
+ 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++;
+ }
+
+ return;
+
+}
+
=head1 SEE ALSO
L<FS::part_export>
projects / freeside.git / blobdiff