RT# 30783 Add network block enumerating utils

[freeside.git] / FS / FS / addr_block.pm

diff --git a/FS/FS/addr_block.pm b/FS/FS/addr_block.pm
index e00f587..a39e1f1 100755 (executable)
--- a/FS/FS/addr_block.pm
+++ b/FS/FS/addr_block.pm
@@ -4,8 +4,11 @@ use strict;
 use vars qw( @ISA );
 use FS::Record qw( qsearchs qsearch dbh );
 use FS::router;
+use FS::addr_range;
 use FS::svc_broadband;
+use FS::svc_acct;
 use FS::Conf;
+use FS::IP_Mixin;
 use NetAddr::IP;
 use Carp qw( carp );
 use List::Util qw( first );
@@ -201,6 +204,18 @@ sub svc_broadband {
   return qsearch('svc_broadband', { blocknum => $self->blocknum });
 }
 
+=item svc_acct
+
+Returns a list of FS::svc_broadband objects associated
+with this object.
+
+=cut
+
+sub svc_acct {
+  my $self = shift;
+  return qsearch('svc_acct', { blocknum => $self->blocknum });
+}
+
 =item NetAddr
 
 Returns a NetAddr::IP object for this block's address and netmask.
@@ -225,41 +240,68 @@ sub cidr {
 
 =item free_addrs
 
+Returns a sorted list of free addresses in the block.
+
+=cut
+
+sub free_addrs {
+  my $self = shift;
+
+  my %used_addr_map =
+    map {$_ => 1}
+    FS::IP_Mixin->used_addresses_in_block($self),
+    FS::Conf->new()->config('exclude_ip_addr');
+
+  grep { !exists $used_addr_map{$_} } map { $_->addr } $self->NetAddr->hostenum;
+}
+
+=item next_free_addr
+
 Returns a NetAddr::IP object corresponding to the first unassigned address 
 in the block (other than the network, broadcast, or gateway address).  If 
 there are no free addresses, returns nothing.  There are never free addresses
 when manual_flag is true.
 
-=item next_free_addr
-
-Returns a NetAddr::IP object for the first unassigned address in the block,
-or '' if there are none.
+There is no longer a method to return all free addresses in a block.
 
 =cut
 
-sub free_addrs {
+sub next_free_addr {
   my $self = shift;
+  my $selfaddr = $self->NetAddr;
 
-  return if $self->manual_flag;
+  return () if $self->manual_flag;
 
   my $conf = new FS::Conf;
   my @excludeaddr = $conf->config('exclude_ip_addr');
-  
+
   my %used = map { $_ => 1 }
   (
-    (map { $_->NetAddr->addr }
-      ($self,
-       qsearch('svc_broadband', { blocknum => $self->blocknum }))
-    ), @excludeaddr
+    @excludeaddr,
+    $selfaddr->addr,
+    $selfaddr->network->addr,
+    $selfaddr->broadcast->addr,
+    FS::IP_Mixin->used_addresses($self)
   );
 
-  grep { !$used{$_->addr} } $self->NetAddr->hostenum;
-
-}
+  # just do a linear search of the block
+  my $freeaddr = $selfaddr->network + 1;
+  while ( $freeaddr < $selfaddr->broadcast ) {
+    # also make sure it's not blocked from assignment by an address range
+    if ( !$used{$freeaddr->addr } ) {
+      my ($range) = grep { !$_->allow_use }
+                  FS::addr_range->any_contains($freeaddr->addr);
+      if ( !$range ) {
+        # then we've found a free address
+        return $freeaddr;
+      }
+      # otherwise, skip to the end of the range
+      $freeaddr = NetAddr::IP->new($range->end, $self->ip_netmask);
+    }
+    $freeaddr++;
+  }
+  return;
 
-sub next_free_addr {
-  my $self = shift;
-  ($self->free_addrs, '')[0]
 }
 
 =item allocate -- deprecated
@@ -400,8 +442,6 @@ sub label {
   ($router ? $router->routername : '(unallocated)'). ':'. $self->NetAddr;
 }
 
-=back
-
 =head1 BUGS
 
 Minimum block size should be a config option.  It's hardcoded at /30 right
@@ -410,4 +450,3 @@ now because that's the smallest block that makes any sense at all.
 =cut
 
 1;
-