1 package FS::addr_block;
5 use FS::Record qw( qsearchs qsearch dbh );
11 @ISA = qw( FS::Record );
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.
58 Create a new record. To add the record to the database, see "insert".
62 sub table { 'addr_block'; }
66 Adds this record to the database. If there is an error, returns the error,
67 otherwise returns false.
71 Deletes this record from the database. If there is an error, returns the
72 error, otherwise returns false.
76 return 'Block must be deallocated before deletion'
82 =item replace OLD_RECORD
84 Replaces OLD_RECORD with this one in the database. If there is an error,
85 returns the error, otherwise returns false.
89 Checks all fields to make sure this is a valid record. If there is an error,
90 returns the error, otherwise returns false. Called by the insert and replace
99 $self->ut_number('routernum')
100 || $self->ut_ip('ip_gateway')
101 || $self->ut_number('ip_netmask')
103 return $error if $error;
106 # A routernum of 0 indicates an unassigned block and is allowed
107 return "Unknown routernum"
108 if ($self->routernum and not $self->router);
110 my $self_addr = $self->NetAddr;
111 return "Cannot parse address: ". $self->ip_gateway . '/' . $self->ip_netmask
114 if (not $self->blocknum) {
116 my $block_addr = $_->NetAddr;
117 if($block_addr->contains($self_addr)
118 or $self_addr->contains($block_addr)) { $_; };
119 } qsearch( 'addr_block', {});
121 return "Block intersects existing block ".$_->ip_gateway."/".$_->ip_netmask;
131 Returns the FS::router object corresponding to this object. If the
132 block is unassigned, returns undef.
138 return qsearchs('router', { routernum => $self->routernum });
143 Returns a list of FS::svc_broadband objects associated
150 return qsearch('svc_broadband', { blocknum => $self->blocknum });
155 Returns a NetAddr::IP object for this block's address and netmask.
161 new NetAddr::IP ($self->ip_gateway, $self->ip_netmask);
166 Returns a CIDR string for this block's address and netmask, i.e. 10.4.20.0/24
172 $self->NetAddr->cidr;
177 Returns a NetAddr::IP object corresponding to the first unassigned address
178 in the block (other than the network, broadcast, or gateway address). If
179 there are no free addresses, returns false.
186 my $conf = new FS::Conf;
187 my @excludeaddr = $conf->config('exclude_ip_addr');
190 ( (map { $_->NetAddr->addr }
192 qsearch('svc_broadband', { blocknum => $self->blocknum }))
196 my @free = $self->NetAddr->hostenum;
197 while (my $ip = shift @free) {
198 if (not grep {$_ eq $ip->addr;} @used) { return $ip; };
207 Allocates this address block to a router. Takes an FS::router object
210 At present it's not possible to reallocate a block to a different router
211 except by deallocating it first, which requires that none of its addresses
212 be assigned. This is probably as it should be.
217 my ($self, $router) = @_;
219 return 'Block is already allocated'
222 return 'Block must be allocated to a router'
223 unless(ref $router eq 'FS::router');
225 my @svc = $self->svc_broadband;
227 return 'Block has assigned addresses: '. join ', ', map {$_->ip_addr} @svc;
230 my $new = new FS::addr_block {$self->hash};
231 $new->routernum($router->routernum);
232 return $new->replace($self);
238 Deallocates the block (i.e. sets the routernum to 0). If any addresses in the
239 block are assigned to services, it fails.
246 my @svc = $self->svc_broadband;
248 return 'Block has assigned addresses: '. join ', ', map {$_->ip_addr} @svc;
251 my $new = new FS::addr_block {$self->hash};
253 return $new->replace($self);
258 Splits this address block into two equal blocks, occupying the same space as
259 the original block. The first of the two will also have the same blocknum.
260 The gateway address of each block will be set to the first usable address, i.e.
261 (network address)+1. Since this method is designed for use on unallocated
262 blocks, this is probably the correct behavior.
264 (At present, splitting allocated blocks is disallowed. Anyone who wants to
265 implement this is reminded that each split costs three addresses, and any
266 customers who were using these addresses will have to be moved; depending on
267 how full the block was before being split, they might have to be moved to a
268 different block. Anyone who I<still> wants to implement it is asked to tie it
269 to a configuration switch so that site admins can disallow it.)
275 # We should consider using Attribute::Handlers/Aspect/Hook::LexWrap/
276 # something to atomicize functions, so that we can say
278 # sub split_block : atomic {
280 # instead of repeating all this AutoCommit verbage in every
281 # sub that does more than one database operation.
283 my $oldAutoCommit = $FS::UID::AutoCommit;
284 local $FS::UID::AutoCommit = 0;
291 return 'Block is already allocated';
294 #TODO: Smallest allowed block should be a config option.
295 if ($self->NetAddr->masklen() ge 30) {
296 return 'Cannot split blocks with a mask length >= 30';
300 $ip[0] = $self->NetAddr;
301 @ip = map {$_->first()} $ip[0]->split($self->ip_netmask + 1);
304 $new[$_] = new FS::addr_block {$self->hash};
305 $new[$_]->ip_gateway($ip[$_]->addr);
306 $new[$_]->ip_netmask($ip[$_]->masklen);
309 $new[1]->blocknum('');
311 $error = $new[0]->replace($self);
317 $error = $new[1]->insert;
323 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
335 Minimum block size should be a config option. It's hardcoded at /30 right
336 now because that's the smallest block that makes any sense at all.