RT# 83450 - added fields interface and map_location to export
[freeside.git] / FS / FS / part_export / saisei.pm
index 8376c7e..0f18ca3 100644 (file)
@@ -42,6 +42,7 @@ Create a tower and add a sector to that tower.  The sector name will be the name
 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.
+Each access point will be attached to the interface set in the export config.  If left blank access point will be attached to the default interface.  Most setups can leave this blank.
 
 Create a package for the above created service, and order this package for a customer.
 
@@ -65,6 +66,13 @@ tie my %scripts, 'Tie::IxHash',
                                       error_url  => '/edit/part_export.cgi?',
                                       success_message => 'Saisei export of provisioned services successful',
                                     },
+  'export_all_towers_sectors'    => { component => '/elements/popup_link.html',
+                                      label     => 'Export of all towers and sectors',
+                                      description => 'Will force an export of all towers and sectors to Saisei as access points.',
+                                      html_label => '<b>Export all towers and sectors.</b>',
+                                      error_url  => '/edit/part_export.cgi?',
+                                      success_message => 'Saisei export of towers and sectors as access points successful',
+                                    },
 ;
 
 tie my %options, 'Tie::IxHash',
@@ -74,6 +82,8 @@ tie my %options, 'Tie::IxHash',
                           default => '' },
   'password'         => { label => 'Saisei API Password',
                           default => '' },
+  'interface'        => { label => 'Saisei Access Point Interface',
+                          default => '' },
   'debug'            => { type => 'checkbox',
                           label => 'Enable debug warnings' },
 ;
@@ -105,6 +115,7 @@ Create a tower and add a sector to that tower.  The sector name will be the name
 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.
+Each access point will be attached to the interface set in the export config.  If left blank access point will be attached to the default interface.  Most setups can leave this blank.
 </LI>
 <P>
 <LI>
@@ -147,6 +158,8 @@ sub _export_insert {
 
   my $username = $svc_broadband->{Hash}->{svcnum};
   my $description = $svc_broadband->{Hash}->{description};
+  my $svc_location;
+  $svc_location = $svc_broadband->{Hash}->{latitude}.','.$svc_broadband->{Hash}->{longitude} if ($svc_broadband->{Hash}->{latitude} && $svc_broadband->{Hash}->{longitude});
 
   if (!$username) {
     $self->{'__saisei_error'} = 'no username - can not export';
@@ -158,7 +171,7 @@ sub _export_insert {
     $existing_user = $self->api_get_user($username) unless $self->{'__saisei_error'};
  
     # if no existing user create one.
-    $self->api_create_user($username, $description) unless $existing_user;
+    $self->api_create_user($username, $description, $svc_location) unless $existing_user;
     return $self->api_error if $self->{'__saisei_error'};
 
     # set user to existing one or newly created one.
@@ -173,13 +186,18 @@ sub _export_insert {
                       tower_sector.sectorname,
                       tower_sector.towernum,
                       tower_sector.up_rate_limit as sector_upratelimit,
-                      tower_sector.down_rate_limit as sector_downratelimit ',
+                      tower_sector.down_rate_limit as sector_downratelimit,
+                      tower.latitude,
+                      tower.longitude',
       'addl_from' => 'LEFT JOIN tower USING ( towernum )',
       'hashref'   => {
                         'sectornum' => $svc_broadband->{Hash}->{sectornum},
                      },
     });
 
+    my $tower_location;
+    $tower_location = $tower_sector->{Hash}->{latitude}.','.$tower_sector->{Hash}->{longitude} if ($tower_sector->{Hash}->{latitude} && $tower_sector->{Hash}->{longitude});
+
     my $tower_name = $tower_sector->{Hash}->{towername};
     $tower_name =~ s/\s/_/g;
 
@@ -189,6 +207,7 @@ sub _export_insert {
       'tower_uprate_limit'   => $tower_sector->{Hash}->{tower_upratelimit},
       'tower_downrate_limit' => $tower_sector->{Hash}->{tower_downratelimit},
     };
+    $tower_opt->{'location'} = $tower_location if $tower_location;
 
     my $tower_ap = process_tower($self, $tower_opt);
     return $self->api_error if $self->{'__saisei_error'};
@@ -204,6 +223,8 @@ sub _export_insert {
       'sector_downrate_limit' => $tower_sector->{Hash}->{sector_downratelimit},
       'rateplan'              => $rateplan_name,
     };
+    $sector_opt->{'location'} = $tower_location if $tower_location;
+
     my $accesspoint = process_sector($self, $sector_opt);
     return $self->api_error if $self->{'__saisei_error'};
 
@@ -224,12 +245,15 @@ sub _export_insert {
     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'};
+    my $host_opt = {
+      'user'        => $user->{collection}->[0]->{name},
+      'rateplan'    => $rateplan->{collection}->[0]->{name},
+      'ip'          => $svc_broadband->{Hash}->{ip_addr},
+      'accesspoint' => $virtual_ap->{collection}->[0]->{name},
+      'location'    => $svc_location,
+    };
+    $self->api_add_host_to_user($host_opt)
+      unless $self->{'__saisei_error'};
   }
 
   return $self->api_error;
@@ -331,6 +355,9 @@ sub export_tower_sector {
     return;
   }
 
+  my $tower_location;
+  $tower_location = $tower->{Hash}->{latitude}.','.$tower->{Hash}->{longitude} if ($tower->{Hash}->{latitude} && $tower->{Hash}->{longitude});
+
   #modify tower or create it.
   my $tower_name = $tower->{Hash}->{towername};
   $tower_name =~ s/\s/_/g;
@@ -341,6 +368,7 @@ sub export_tower_sector {
     'tower_downrate_limit' => $tower->{Hash}->{down_rate_limit},
     'modify_existing'      => '1', # modify an existing access point with this info
   };
+  $tower_opt->{'location'} = $tower_location if $tower_location;
 
   my $tower_access_point = process_tower($self, $tower_opt);
     return $tower_access_point if $tower_access_point->{error};
@@ -354,6 +382,7 @@ sub export_tower_sector {
 
   #for each one modify or create it.
   foreach my $tower_sector ( FS::Record::qsearch($hash_opt) ) {
+    next if $tower_sector->{Hash}->{sectorname} eq "_default";
     my $sector_name = $tower_sector->{Hash}->{sectorname};
     $sector_name =~ s/\s/_/g;
     my $sector_opt = {
@@ -364,6 +393,8 @@ sub export_tower_sector {
       'sector_downrate_limit' => $tower_sector->{Hash}->{down_rate_limit},
       'modify_existing'       => '1', # modify an existing access point with this info
     };
+    $sector_opt->{'location'} = $tower_location if $tower_location;
+
     my $sector_access_point = process_sector($self, $sector_opt) unless ($sector_name eq "_default");
       return $sector_access_point if $sector_access_point->{error};
   }
@@ -449,7 +480,7 @@ sub api_call {
     return;
   }
   else {
-    $self->{'__saisei_error'} = "Received Bad response from server during $method , we received responce code: " . $client->responseCode();
+    $self->{'__saisei_error'} = "Received Bad response from server during $method $path $data, we received responce code: " . $client->responseCode() . " " . $client->responseContent;
     warn "Saisei Response Content is\n".$client->responseContent."\n" if $self->option('debug');
     return; 
   }
@@ -650,14 +681,17 @@ Creates a user.
 =cut
 
 sub api_create_user {
-  my ($self,$user, $description) = @_;
+  my ($self,$user, $description, $location) = @_;
+
+  my $user_hash = {
+    'description' => $description,
+  };
+  $user_hash->{'map_location'} = $location if $location;
 
   my $new_user = $self->api_call(
       "PUT", 
       "/users/$user",
-      {
-        'description' => $description,
-      },
+      $user_hash,
   );
 
   $self->{'__saisei_error'} = "Saisei could not create the user $user"
@@ -674,15 +708,19 @@ Creates a access point.
 =cut
 
 sub api_create_accesspoint {
-  my ($self,$accesspoint, $upratelimit, $downratelimit) = @_;
+  my ($self,$accesspoint, $upratelimit, $downratelimit, $location) = @_;
+
+  my $ap_hash = {
+    'downstream_rate_limit' => $downratelimit,
+    'upstream_rate_limit'   => $upratelimit,
+    'interface'             => $self->option('interface'),
+  };
+  $ap_hash->{'map_location'} = $location if $location;
 
   my $new_accesspoint = $self->api_call(
       "PUT",
       "/access_points/$accesspoint",
-      {
-         'downstream_rate_limit' => $downratelimit,
-         'upstream_rate_limit' => $upratelimit,
-      },
+      $ap_hash,
   );
 
   $self->{'__saisei_error'} = "Saisei could not create the access point $accesspoint"
@@ -698,14 +736,18 @@ Modify a new access point.
 =cut
 
 sub api_modify_accesspoint {
-  my ($self, $accesspoint, $uplink) = @_;
+  my ($self, $accesspoint, $uplink, $location) = @_;
+
+  my $ap_hash = {
+    'uplink'    => $uplink,
+    'interface' => $self->option('interface'),
+  };
+  $ap_hash->{'map_location'} = $location if $location;
 
   my $modified_accesspoint = $self->api_call(
     "PUT",
     "/access_points/$accesspoint",
-    {
-      'uplink' => $uplink, # name of attached access point
-    },
+    $ap_hash,
   );
 
   $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint after it was created."
@@ -722,20 +764,24 @@ Modify a existing accesspoint.
 =cut
 
 sub api_modify_existing_accesspoint {
-  my ($self, $accesspoint, $uplink, $upratelimit, $downratelimit) = @_;
+  my ($self, $accesspoint, $uplink, $upratelimit, $downratelimit, $location) = @_;
+
+  my $ap_hash = {
+    'downstream_rate_limit' => $downratelimit,
+    'upstream_rate_limit'   => $upratelimit,
+    'interface'             => $self->option('interface'),
+#   'uplink'                => $uplink, # name of attached access point
+  };
+  $ap_hash->{'map_location'} = $location if $location;
 
   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
-    },
+    $ap_hash,
   );
 
-    $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint."
-      unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
+  $self->{'__saisei_error'} = "Saisei could not modify the access point $accesspoint."
+    unless ($modified_accesspoint || $self->{'__saisei_error'}); # should never happen
 
   return;
 
@@ -748,16 +794,22 @@ ties host to user, rateplan and default access point.
 =cut
 
 sub api_add_host_to_user {
-  my ($self,$user, $rateplan, $ip, $accesspoint) = @_;
+#  my ($self,$user, $rateplan, $ip, $accesspoint, $location) = @_;
+  my ($self,$opt) = @_;
+  my $ip = $opt->{'ip'};
+  my $location = $opt->{'location'};
+
+  my $newhost_hash = {
+    'user'         => $opt->{'user'},
+    'rate_plan'    => $opt->{'rateplan'},
+    'access_point' => $opt->{'accesspoint'},
+  };
+  $newhost_hash->{'map_location'} = $location if $location;
 
   my $new_host = $self->api_call(
       "PUT", 
       "/hosts/$ip",
-      {
-        'user'      => $user,
-        'rate_plan' => $rateplan,
-        'access_point' => $accesspoint,
-      },
+      $newhost_hash,
   );
 
   $self->{'__saisei_error'} = "Saisei could not create the host $ip"
@@ -811,6 +863,7 @@ sub process_tower {
 
   my $existing_tower_ap;
   my $tower_name = $opt->{tower_name};
+  my $location = $opt->{location};
 
   #check if tower has been set up as an access point.
   $existing_tower_ap = $self->api_get_accesspoint($tower_name) unless $self->{'__saisei_error'};
@@ -821,6 +874,7 @@ sub process_tower {
     '', # tower does not have a uplink on sectors.
     $opt->{tower_uprate_limit},
     $opt->{tower_downrate_limit},
+    $location,
   ) if $existing_tower_ap->{collection} && $opt->{modify_existing};
 
   #if tower does not exist as an access point create it.
@@ -828,6 +882,7 @@ sub process_tower {
       $tower_name,
       $opt->{tower_uprate_limit},
       $opt->{tower_downrate_limit},
+      $location,
   ) unless $existing_tower_ap->{collection};
 
   my $accesspoint = $self->api_get_accesspoint($tower_name);
@@ -851,6 +906,7 @@ sub process_sector {
 
   my $existing_sector_ap;
   my $sector_name = $opt->{sector_name};
+  my $location = $opt->{location};
 
   #check if sector has been set up as an access point.
   $existing_sector_ap = $self->api_get_accesspoint($sector_name);
@@ -861,6 +917,7 @@ sub process_sector {
     $opt->{tower_name},
     $opt->{sector_uprate_limit},
     $opt->{sector_downrate_limit},
+    $location,
   ) if $existing_sector_ap && $opt->{modify_existing};
 
   #if sector does not exist as an access point create it.
@@ -868,10 +925,11 @@ sub process_sector {
     $sector_name,
     $opt->{sector_uprate_limit},
     $opt->{sector_downrate_limit},
+    $location,
   ) 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);
+  $self->api_modify_accesspoint($sector_name, $opt->{tower_name}, $location) 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);
@@ -1001,6 +1059,37 @@ sub export_provisioned_services {
 
 }
 
+sub export_all_towers_sectors {
+  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 @towers = FS::Record::qsearch({
+    'table' => 'tower',
+  });
+  my $tower_count = scalar @towers;
+
+  my %status = {};
+  for (my $c=1; $c <=100; $c=$c+1) { $status{int($tower_count * ($c/100))} = $c; }
+
+  my $process_count=0;
+  foreach my $tower (@towers) {
+    if ($status{$process_count}) { my $s = $status{$process_count}; $job->update_statustext($s); }
+    my $export_error = export_tower_sector($part_export,$tower);
+    if ($export_error->{'error'}) {
+      warn "Error exporting tower/sector (".$tower->{Hash}->{towername}.")\n" if ($part_export->option('debug'));
+      die ($export_error->{'error'}."\n");
+    }
+    $process_count++;
+  }
+
+  return;
+
+}
+
 sub test_export_report {
   my ($self, $opts) = @_;
   my @export_error;