1 package FS::addr_block;
5 use FS::Record qw( qsearchs qsearch dbh );
12 @ISA = qw( FS::Record );
16 FS::addr_block - Object methods for addr_block records
22 $record = new FS::addr_block \%hash;
23 $record = new FS::addr_block { 'column' => 'value' };
25 $error = $record->insert;
27 $error = $new_record->replace($old_record);
29 $error = $record->delete;
31 $error = $record->check;
35 An FS::addr_block record describes an address block assigned for broadband
36 access. FS::addr_block inherits from FS::Record. The following fields are
41 =item blocknum - primary key, used in FS::svc_broadband to associate
42 services to the block.
44 =item routernum - the router (see FS::router) to which this
47 =item ip_gateway - the gateway address used by customers within this block.
49 =item ip_netmask - the netmask of the block, expressed as an integer.
51 =item agentnum - optional agent number (see L<FS::agent>)
61 Create a new record. To add the record to the database, see "insert".
65 sub table { 'addr_block'; }
69 Adds this record to the database. If there is an error, returns the error,
70 otherwise returns false.
74 Deletes this record from the database. If there is an error, returns the
75 error, otherwise returns false.
79 return 'Block must be deallocated before deletion'
85 =item replace OLD_RECORD
87 Replaces OLD_RECORD with this one in the database. If there is an error,
88 returns the error, otherwise returns false.
90 At present it's not possible to reallocate a block to a different router
91 except by deallocating it first, which requires that none of its addresses
92 be assigned. This is probably as it should be.
95 my ( $new, $old ) = ( shift, shift );
97 unless($new->routernum == $old->routernum) {
98 my @svc = $self->svc_broadband;
100 return 'Block has assigned addresses: '.
101 join ', ', map {$_->ip_addr} @svc;
104 return 'Block is already allocated'
105 if($new->routernum && $old->routernum);
114 Checks all fields to make sure this is a valid record. If there is an error,
115 returns the error, otherwise returns false. Called by the insert and replace
124 $self->ut_number('routernum')
125 || $self->ut_ip('ip_gateway')
126 || $self->ut_number('ip_netmask')
127 || $self->ut_agentnum_acl('agentnum', 'Broadband global configuration')
129 return $error if $error;
132 # A routernum of 0 indicates an unassigned block and is allowed
133 return "Unknown routernum"
134 if ($self->routernum and not $self->router);
136 my $self_addr = $self->NetAddr;
137 return "Cannot parse address: ". $self->ip_gateway . '/' . $self->ip_netmask
140 if (not $self->blocknum) {
142 my $block_addr = $_->NetAddr;
143 if($block_addr->contains($self_addr)
144 or $self_addr->contains($block_addr)) { $_; };
145 } qsearch( 'addr_block', {});
147 return "Block intersects existing block ".$_->ip_gateway."/".$_->ip_netmask;
157 Returns the FS::router object corresponding to this object. If the
158 block is unassigned, returns undef.
164 return qsearchs('router', { routernum => $self->routernum });
169 Returns a list of FS::svc_broadband objects associated
176 return qsearch('svc_broadband', { blocknum => $self->blocknum });
181 Returns a NetAddr::IP object for this block's address and netmask.
187 new NetAddr::IP ($self->ip_gateway, $self->ip_netmask);
192 Returns a CIDR string for this block's address and netmask, i.e. 10.4.20.0/24
198 $self->NetAddr->cidr;
203 Returns a NetAddr::IP object corresponding to the first unassigned address
204 in the block (other than the network, broadcast, or gateway address). If
205 there are no free addresses, returns false.
212 my $conf = new FS::Conf;
213 my @excludeaddr = $conf->config('exclude_ip_addr');
216 ( (map { $_->NetAddr->addr }
218 qsearch('svc_broadband', { blocknum => $self->blocknum }))
222 my @free = $self->NetAddr->hostenum;
223 while (my $ip = shift @free) {
224 if (not grep {$_ eq $ip->addr;} @used) { return $ip; };
231 =item allocate -- deprecated
233 Allocates this address block to a router. Takes an FS::router object
236 At present it's not possible to reallocate a block to a different router
237 except by deallocating it first, which requires that none of its addresses
238 be assigned. This is probably as it should be.
243 my ($self, $router) = @_;
244 carp "deallocate deprecated -- use replace";
246 return 'Block must be allocated to a router'
247 unless(ref $router eq 'FS::router');
249 my $new = new FS::addr_block {$self->hash};
250 $new->routernum($router->routernum);
251 return $new->replace($self);
255 =item deallocate -- deprecated
257 Deallocates the block (i.e. sets the routernum to 0). If any addresses in the
258 block are assigned to services, it fails.
263 carp "deallocate deprecated -- use replace";
266 my $new = new FS::addr_block {$self->hash};
268 return $new->replace($self);
273 Splits this address block into two equal blocks, occupying the same space as
274 the original block. The first of the two will also have the same blocknum.
275 The gateway address of each block will be set to the first usable address, i.e.
276 (network address)+1. Since this method is designed for use on unallocated
277 blocks, this is probably the correct behavior.
279 (At present, splitting allocated blocks is disallowed. Anyone who wants to
280 implement this is reminded that each split costs three addresses, and any
281 customers who were using these addresses will have to be moved; depending on
282 how full the block was before being split, they might have to be moved to a
283 different block. Anyone who I<still> wants to implement it is asked to tie it
284 to a configuration switch so that site admins can disallow it.)
290 # We should consider using Attribute::Handlers/Aspect/Hook::LexWrap/
291 # something to atomicize functions, so that we can say
293 # sub split_block : atomic {
295 # instead of repeating all this AutoCommit verbage in every
296 # sub that does more than one database operation.
298 my $oldAutoCommit = $FS::UID::AutoCommit;
299 local $FS::UID::AutoCommit = 0;
306 return 'Block is already allocated';
309 #TODO: Smallest allowed block should be a config option.
310 if ($self->NetAddr->masklen() ge 30) {
311 return 'Cannot split blocks with a mask length >= 30';
315 $ip[0] = $self->NetAddr;
316 @ip = map {$_->first()} $ip[0]->split($self->ip_netmask + 1);
319 $new[$_] = new FS::addr_block {$self->hash};
320 $new[$_]->ip_gateway($ip[$_]->addr);
321 $new[$_]->ip_netmask($ip[$_]->masklen);
324 $new[1]->blocknum('');
326 $error = $new[0]->replace($self);
332 $error = $new[1]->insert;
338 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
348 Returns the agent (see L<FS::agent>) for this address block, if one exists.
353 qsearchs('agent', { 'agentnum' => shift->agentnum } );
358 Returns text including the router name, gateway ip, and netmask for this
365 my $router = $self->router;
366 ($router ? $router->routername : '(unallocated)'). ':'. $self->NetAddr;
373 Minimum block size should be a config option. It's hardcoded at /30 right
374 now because that's the smallest block that makes any sense at all.