1 package FS::addr_block;
2 use base qw(FS::Record);
6 use List::Util qw( first );
9 use FS::Record qw( qsearch dbh ); #qsearchs
15 FS::addr_block - Object methods for addr_block records
21 $record = new FS::addr_block \%hash;
22 $record = new FS::addr_block { 'column' => 'value' };
24 $error = $record->insert;
26 $error = $new_record->replace($old_record);
28 $error = $record->delete;
30 $error = $record->check;
34 An FS::addr_block record describes an address block assigned for broadband
35 access. FS::addr_block inherits from FS::Record. The following fields are
40 =item blocknum - primary key, used in FS::svc_broadband to associate
41 services to the block.
43 =item routernum - the router (see FS::router) to which this
46 =item ip_gateway - the gateway address used by customers within this block.
48 =item ip_netmask - the netmask of the block, expressed as an integer.
50 =item manual_flag - prohibit automatic ip assignment from this block when true.
52 =item agentnum - optional agent number (see L<FS::agent>)
62 Create a new record. To add the record to the database, see "insert".
66 sub table { 'addr_block'; }
70 Adds this record to the database. If there is an error, returns the error,
71 otherwise returns false.
75 Deletes this record from the database. If there is an error, returns the
76 error, otherwise returns false.
82 return 'Block must be deallocated and have no services before deletion'
83 if $self->router || $self->svc_broadband;
85 local $SIG{HUP} = 'IGNORE';
86 local $SIG{INT} = 'IGNORE';
87 local $SIG{QUIT} = 'IGNORE';
88 local $SIG{TERM} = 'IGNORE';
89 local $SIG{TSTP} = 'IGNORE';
90 local $SIG{PIPE} = 'IGNORE';
92 my $oldAutoCommit = $FS::UID::AutoCommit;
93 local $FS::UID::AutoCommit = 0;
96 my $error = $self->SUPER::delete;
98 $dbh->rollback if $oldAutoCommit;
102 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
107 =item replace OLD_RECORD
109 Replaces OLD_RECORD with this one in the database. If there is an error,
110 returns the error, otherwise returns false.
112 At present it's not possible to reallocate a block to a different router
113 except by deallocating it first, which requires that none of its addresses
114 be assigned. This is probably as it should be.
117 my ( $new, $old ) = ( shift, shift );
119 unless($new->routernum == $old->routernum) {
120 my @svc = $self->svc_broadband;
122 return 'Block has assigned addresses: '.
123 join ', ', map {$_->ip_addr} @svc;
126 return 'Block is already allocated'
127 if($new->routernum && $old->routernum);
136 Checks all fields to make sure this is a valid record. If there is an error,
137 returns the error, otherwise returns false. Called by the insert and replace
146 $self->ut_number('routernum')
147 || $self->ut_ip('ip_gateway')
148 || $self->ut_number('ip_netmask')
149 || $self->ut_enum('manual_flag', [ '', 'Y' ])
150 || $self->ut_agentnum_acl('agentnum', 'Broadband global configuration')
152 return $error if $error;
155 # A routernum of 0 indicates an unassigned block and is allowed
156 return "Unknown routernum"
157 if ($self->routernum and not $self->router);
159 my $self_addr = $self->NetAddr;
160 return "Cannot parse address: ". $self->ip_gateway . '/' . $self->ip_netmask
163 if (not $self->blocknum) {
165 my $block_addr = $_->NetAddr;
166 if($block_addr->contains($self_addr)
167 or $self_addr->contains($block_addr)) { $_; };
168 } qsearch( 'addr_block', {});
170 return "Block intersects existing block ".$_->ip_gateway."/".$_->ip_netmask;
180 Returns the FS::router object corresponding to this object. If the
181 block is unassigned, returns undef.
185 Returns a list of FS::svc_broadband objects associated
190 Returns a NetAddr::IP object for this block's address and netmask.
196 new NetAddr::IP ($self->ip_gateway, $self->ip_netmask);
201 Returns a CIDR string for this block's address and netmask, i.e. 10.4.20.0/24
207 $self->NetAddr->cidr;
212 Returns an aref sorted list of free addresses in the block.
221 FS::IP_Mixin->used_addresses($self),
222 FS::Conf->new()->config('exclude_ip_addr');
225 grep { !exists $used_addr_map{$_} }
227 $self->NetAddr->hostenum
233 Returns a NetAddr::IP object corresponding to the first unassigned address
234 in the block (other than the network, broadcast, or gateway address). If
235 there are no free addresses, returns nothing. There are never free addresses
236 when manual_flag is true.
238 There is no longer a method to return all free addresses in a block.
244 my $selfaddr = $self->NetAddr;
246 return () if $self->manual_flag;
248 my $conf = new FS::Conf;
249 my @excludeaddr = $conf->config('exclude_ip_addr');
251 my %used = map { $_ => 1 }
255 $selfaddr->network->addr,
256 $selfaddr->broadcast->addr,
257 FS::IP_Mixin->used_addresses($self)
260 # just do a linear search of the block
261 my $freeaddr = $selfaddr->network + 1;
262 while ( $freeaddr < $selfaddr->broadcast ) {
263 # also make sure it's not blocked from assignment by an address range
264 if ( !$used{$freeaddr->addr } ) {
265 my ($range) = grep { !$_->allow_use }
266 FS::addr_range->any_contains($freeaddr->addr);
268 # then we've found a free address
271 # otherwise, skip to the end of the range
272 $freeaddr = NetAddr::IP->new($range->end, $self->ip_netmask);
280 =item allocate -- deprecated
282 Allocates this address block to a router. Takes an FS::router object
285 At present it's not possible to reallocate a block to a different router
286 except by deallocating it first, which requires that none of its addresses
287 be assigned. This is probably as it should be.
292 my ($self, $router) = @_;
293 carp "deallocate deprecated -- use replace";
295 return 'Block must be allocated to a router'
296 unless(ref $router eq 'FS::router');
298 my $new = new FS::addr_block {$self->hash};
299 $new->routernum($router->routernum);
300 return $new->replace($self);
304 =item deallocate -- deprecated
306 Deallocates the block (i.e. sets the routernum to 0). If any addresses in the
307 block are assigned to services, it fails.
312 carp "deallocate deprecated -- use replace";
315 my $new = new FS::addr_block {$self->hash};
317 return $new->replace($self);
322 Splits this address block into two equal blocks, occupying the same space as
323 the original block. The first of the two will also have the same blocknum.
324 The gateway address of each block will be set to the first usable address, i.e.
325 (network address)+1. Since this method is designed for use on unallocated
326 blocks, this is probably the correct behavior.
328 (At present, splitting allocated blocks is disallowed. Anyone who wants to
329 implement this is reminded that each split costs three addresses, and any
330 customers who were using these addresses will have to be moved; depending on
331 how full the block was before being split, they might have to be moved to a
332 different block. Anyone who I<still> wants to implement it is asked to tie it
333 to a configuration switch so that site admins can disallow it.)
339 # We should consider using Attribute::Handlers/Aspect/Hook::LexWrap/
340 # something to atomicize functions, so that we can say
342 # sub split_block : atomic {
344 # instead of repeating all this AutoCommit verbage in every
345 # sub that does more than one database operation.
347 my $oldAutoCommit = $FS::UID::AutoCommit;
348 local $FS::UID::AutoCommit = 0;
355 return 'Block is already allocated';
358 #TODO: Smallest allowed block should be a config option.
359 if ($self->NetAddr->masklen() ge 30) {
360 return 'Cannot split blocks with a mask length >= 30';
364 $ip[0] = $self->NetAddr;
365 @ip = map {$_->first()} $ip[0]->split($self->ip_netmask + 1);
368 $new[$_] = new FS::addr_block {$self->hash};
369 $new[$_]->ip_gateway($ip[$_]->addr);
370 $new[$_]->ip_netmask($ip[$_]->masklen);
373 $new[1]->blocknum('');
375 $error = $new[0]->replace($self);
381 $error = $new[1]->insert;
387 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
397 Returns the agent (see L<FS::agent>) for this address block, if one exists.
401 Returns text including the router name, gateway ip, and netmask for this
408 my $router = $self->router;
409 ($router ? $router->routername : '(unallocated)'). ':'. $self->NetAddr;
414 Returns the router assigned to this block.
418 # necessary, because this can't be foreign keyed
422 my $routernum = $self->routernum;
424 return FS::router->by_key($routernum);
434 Minimum block size should be a config option. It's hardcoded at /30 right
435 now because that's the smallest block that makes any sense at all.