source: trunk/cgi-bin/IPDB.pm@ 839

Last change on this file since 839 was 839, checked in by Kris Deugau, 8 years ago

/trunk

Convert a lingering custom patch to another configuration knob. See #26.

  • Property svn:keywords set to Date Rev Author
File size: 131.4 KB
Line 
1# ipdb/cgi-bin/IPDB.pm
2# Contains functions for IPDB - database access, subnet mangling, block allocation, etc
3###
4# SVN revision info
5# $Date: 2016-04-12 18:49:45 +0000 (Tue, 12 Apr 2016) $
6# SVN revision $Rev: 839 $
7# Last update by $Author: kdeugau $
8###
9# Copyright (C) 2004-2010 - Kris Deugau
10
11package IPDB;
12
13use strict;
14use warnings;
15use Exporter;
16use DBI;
17use Net::SMTP;
18use NetAddr::IP qw(:lower Compact );
19use Frontier::Client;
20use POSIX;
21use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
22
23$VERSION = 3; ##VERSION##
24@ISA = qw(Exporter);
25@EXPORT_OK = qw(
26 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist
27 %IPDBacl %merge_display %aclmsg %rpcacl $maxfcgi
28 $errstr
29 &initIPDBGlobals &connectDB &finish &checkDBSanity
30 &addVRF &getVRF &deleteVRF &addMaster &touchMaster
31 &listVRF &listSummary &listSubs &listContainers &listAllocations &listForMerge &listFree &listPool
32 &getMasterList &getTypeList &getPoolSelect &findAllocateFrom
33 &ipParent &subParent &blockParent &getBreadCrumbs &getRoutedCity
34 &allocateBlock &updateBlock &splitBlock &shrinkBlock &mergeBlocks &deleteBlock &getBlockData
35 &getBlockRDNS &getRDNSbyIP &getRevID
36 &getNodeList &getNodeName &getNodeInfo
37 &mailNotify
38 );
39
40@EXPORT = (); # Export nothing by default.
41%EXPORT_TAGS = ( ALL => [qw(
42 %disp_alloctypes %list_alloctypes %def_custids @citylist @poplist
43 %IPDBacl %merge_display %aclmsg %rpcacl $maxfcgi
44 $errstr
45 &initIPDBGlobals &connectDB &finish &checkDBSanity
46 &addVRF &getVRF &deleteVRF &addMaster &touchMaster
47 &listVRF &listSummary &listSubs &listContainers &listAllocations &listForMerge &listFree &listPool
48 &getMasterList &getTypeList &getPoolSelect &findAllocateFrom
49 &ipParent &subParent &blockParent &getBreadCrumbs &getRoutedCity
50 &allocateBlock &updateBlock &splitBlock &shrinkBlock &mergeBlocks &deleteBlock &getBlockData
51 &getBlockRDNS &getRDNSbyIP &getRevID
52 &getNodeList &getNodeName &getNodeInfo
53 &mailNotify
54 )]
55 );
56
57##
58## Global variables
59##
60our %disp_alloctypes;
61our %list_alloctypes;
62our %def_custids;
63our @citylist;
64our @poplist;
65our %IPDBacl;
66
67# Mapping hash for pooltype -> poolip-as-netblock conversions
68my %poolmap = (sd => 'en', cd => 'cn', dp => 'cn', mp => 'cn', wp => 'cn', ld => 'in', ad => 'in', bd => 'in');
69
70# Backup fields, since we iterate over the set regularly
71our @backupfields = qw(brand model type src user vpass epass port ip);
72
73# Friendly display strings for merge scopes
74our %merge_display = (
75 keepall => "Keep mergeable allocations as suballocations of new block",
76 mergepeer => "Keep suballocations of mergeable allocations",
77 clearpeer => "Keep only suballocations of the selected block",
78 clearall => "Clear all suballocations"
79 );
80
81# mapping table for functional-area => error message
82our %aclmsg = (
83 addmaster => 'add a master block',
84 addblock => 'add an allocation',
85 updateblock => 'update a block',
86 delblock => 'delete an allocation',
87 mergeblock => 'merge allocations',
88 );
89
90our %rpcacl;
91our $maxfcgi = 3;
92
93# error reporting
94our $errstr = '';
95
96our $org_name = 'Example Corp';
97our $smtphost = 'smtp.example.com';
98our $domain = 'example.com';
99our $defcustid = '5554242';
100our $smtpsender = 'ipdb@example.com';
101# mostly for rwhois
102##fixme: leave these blank by default?
103our $rwhoisDataPath = '/usr/local/rwhoisd/etc/rwhoisd'; # to match ./configure defaults from rwhoisd-1.5.9.6
104our $org_street = '123 4th Street';
105our $org_city = 'Anytown';
106our $org_prov_state = 'ON';
107our $org_pocode = 'H0H 0H0';
108our $org_country = 'CA';
109our $org_phone = '000-555-1234';
110our $org_techhandle = 'ISP-ARIN-HANDLE';
111our $org_email = 'noc@example.com';
112our $hostmaster = 'dns@example.com';
113
114our $syslog_facility = 'local2';
115
116our $rpc_url = '';
117our $dnsadmin_url; # needs to be modified later
118our $revgroup = 1; # should probably be configurable somewhere
119our $rpccount = 0;
120
121# Largest inverse CIDR mask length to show per-IP rDNS list
122# (eg, NetAddr::IP->bits - NetAddr::IP->masklen)
123our $maxrevlist = 5; # /27
124
125# Display the per-IP rDNS list on all block types even when it might not
126# make sense (typically for IP pools, where the per-IP entries are available
127# from each IP's edit page)
128our $revlistalltypes = 0;
129
130# UI layout for subblocks/containers
131our $sublistlayout = 1;
132
133# UI layout for VRF/master blocks
134our $masterswithvrfs = 2;
135
136# VLAN validation mode. Set to 0 to allow alphanumeric vlan names instead of using the vlan number.
137our $numeric_vlan = 1;
138
139# Billing system return link
140our $billinglink = 'https://billing.example.com/radius.pl';
141
142##
143## Internal utility functions
144##
145
146## IPDB::_rpc
147# Make an RPC call for DNS changes
148sub _rpc {
149 return if !$rpc_url; # Just In Case
150 my $rpcsub = shift;
151 my %args = @_;
152
153 # Make an object to represent the XML-RPC server.
154 my $server = Frontier::Client->new(url => $rpc_url, debug => 0);
155 my $result;
156
157 my %rpcargs = (
158 rpcsystem => 'ipdb',
159# must be provided by caller's caller
160# rpcuser => $args{user},
161 %args,
162 );
163
164 eval {
165 $result = $server->call("dnsdb.$rpcsub", %rpcargs);
166 };
167 if ($@) {
168 $errstr = $@;
169 $errstr =~ s/\s*$//;
170 $errstr =~ s/Fault returned from XML RPC Server, fault code 4: error executing RPC `dnsdb.$rpcsub'\.\s//;
171 }
172 $rpccount++;
173
174 return $result if $result;
175} # end _rpc()
176
177
178## IPDB::_compactFree()
179# Utility sub to compact a set of free block entries down to the minimum possible set of CIDR entries
180# Not to be called outside of an eval{}!
181sub _compactFree {
182 my $dbh = shift;
183 my $parent = shift;
184
185 # Rather than having the caller provide all the details
186 my $pinfo = getBlockData($dbh, $parent);
187 my $ftype = (split //, $pinfo->{type})[0];
188
189# NetAddr::IP->compact() attempts to produce the smallest inclusive block
190# from the caller and the passed terms.
191# EG: if you call $cidr->compact($ip1,$ip2,$ip3) when $cidr, $ip1, $ip2,
192# and $ip3 are consecutive /27's starting on .0 (.0-.31, .32-.63,
193# .64-.95, and .96-.128), you will get an array containing a single
194# /25 as element 0 (.0-.127). Order is not important; you could have
195# $cidr=.32/27, $ip1=.96/27, $ip2=.0/27, and $ip3=.64/27.
196
197##fixme: vrf
198##fixme: simplify since all containers now represent different "layers"/"levels"?
199
200 # set up the query to get the list of blocks to try to merge.
201 my $sth = $dbh->prepare(q{
202 SELECT cidr,id FROM freeblocks
203 WHERE parent_id = ?
204 ORDER BY masklen(cidr) DESC
205 });
206 $sth->execute($parent);
207
208 my (@rawfb, @combinelist, %rawid);
209 my $i=0;
210 # for each free block under $parent, push a NetAddr::IP object into one list, and
211 # continuously use NetAddr::IP->compact to automagically merge netblocks as possible.
212 while (my ($fcidr, $fid) = $sth->fetchrow_array) {
213 my $testIP = new NetAddr::IP $fcidr;
214 push @rawfb, $testIP;
215 $rawid{"$testIP"} = $fid; # $data[0] vs "$testIP" *does* make a difference for v6
216 @combinelist = $testIP->compact(@combinelist);
217 }
218
219 # now that we have the full list of "compacted" freeblocks, go back over
220 # the list of raw freeblocks, and delete the ones that got merged.
221 $sth = $dbh->prepare("DELETE FROM freeblocks WHERE id = ?");
222 foreach my $rawfree (@rawfb) {
223 next if grep { $rawfree == $_ } @combinelist; # skip if the raw block is in the compacted list
224 $sth->execute($rawid{$rawfree});
225 }
226
227 # now we walk the new list of compacted blocks, and see which ones we need to insert
228 $sth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,vrf,parent_id,master_id) VALUES (?,?,?,?,?,?)");
229 foreach my $cme (@combinelist) {
230 next if grep { $cme == $_ } @rawfb; # skip if the combined block was in the raw list
231 $sth->execute($cme, $pinfo->{city}, $ftype, $pinfo->{vrf}, $parent, $pinfo->{master_id});
232 }
233
234} # end _compactFree()
235
236
237## IPDB::_toPool()
238# Convert an allocation or allocation tree to entries in an IP pool
239# Assumes an incomplete/empty pool
240# Takes a parent ID for the pool, CIDR range descriptor for the allocation(s) to convert, and the pool type
241sub _toPool {
242 my $dbh = shift;
243 my $poolparent = shift;
244 my $convblock = shift; # May be smaller than the block referenced by $poolparent
245 my $pooltype = shift;
246 my $retall = shift || 0;
247
248 # there is probably a way to avoid the temporary $foo here
249 my $foo = $dbh->selectall_arrayref("SELECT master_id,parent_id FROM allocations WHERE id = ?", undef, $poolparent);
250 my ($master,$mainparent) = @{$foo->[0]};
251
252 my @retlist;
253
254 my $iptype = $pooltype;
255 $iptype =~ s/[pd]$/i/;
256 my $poolclass = (split //, $iptype)[0];
257
258 my $cidrpool = new NetAddr::IP $convblock;
259
260 my $asth = $dbh->prepare(q{
261 SELECT id, cidr, type, parent_id, city, description, notes, circuitid,
262 createstamp, modifystamp, privdata, custid, vrf, vlan, rdns
263 FROM allocations
264 WHERE cidr <<= ? AND master_id = ?
265 ORDER BY masklen(cidr) DESC
266 });
267 my $inssth = $dbh->prepare(q{
268 INSERT INTO poolips (
269 ip,type,parent_id,available,
270 city,description,notes,circuitid,createstamp,modifystamp,privdata,custid,vrf,vlan,rdns
271 )
272 VALUES (?,?,?,'n',?,?,?,?,?,?,?,?,?,?,?)
273 });
274 my $updsth = $dbh->prepare("UPDATE poolips SET parent_id = ?, type = ? WHERE parent_id = ?");
275 my $delsth = $dbh->prepare("DELETE FROM allocations WHERE id = ?");
276 my $fbdelsth = $dbh->prepare("DELETE FROM freeblocks WHERE parent_id = ?");
277
278 $asth->execute($convblock, $master);
279 my %poolcounter;
280 while (my ($oldid, $oldcidr, $oldtype, $oldparent, @oldalloc) = $asth->fetchrow_array) {
281 if ($oldtype =~ /.[enr]/) {
282 # Convert leaf allocations to block of pool IP assignments
283 my $tmpcidr = new NetAddr::IP $oldcidr;
284 my $newtype = $poolclass.'i';
285 # set up the gateway IP in case we need it
286 my $gw = $cidrpool+1;
287 foreach my $newip ($tmpcidr->split(32)) {
288 my $baseip = $newip->addr;
289 # skip .0 and .255, they are prefectly legitimate but some systems behave
290 # poorly talking to a client using them.
291 next if $baseip =~ /\.(?:0|255)$/;
292 # skip the network, broadcast, and gateway IPs if we're creating a "normal netblock" pool
293 if ($pooltype =~ /d$/) {
294 next if $newip->addr eq $cidrpool->network->addr;
295 next if $newip->addr eq $cidrpool->broadcast->addr;
296 next if $newip->addr eq $gw->addr;
297 }
298 $inssth->execute($newip, $newtype, $poolparent, @oldalloc) if !$poolcounter{"$newip"};
299 $poolcounter{"$newip"}++;
300 }
301 } elsif ($oldtype =~ /.[dp]/) {
302 # Reparent IPs in an existing pool, and rewrite their type
303 $updsth->execute($poolparent, $poolclass.'i', $oldid);
304 } else {
305 # Containers are mostly "not interesting" in this context since they're
306 # equivalent to the pool allocation on .[dp] types. Clean up the lingering free block(s).
307 $fbdelsth->execute($oldid);
308 }
309 # Clean up - remove the converted block unless it is the "primary"
310 $delsth->execute($oldid) unless $oldid == $poolparent;
311 # Return the converted blocks, but only the immediate peers, not the entire tree
312 push @retlist, { block => $oldcidr, mdisp => $disp_alloctypes{$oldtype}, mtype => $oldtype }
313 if (($oldparent == $mainparent) || $retall) && $oldid != $poolparent;
314 } # while $asth->fetch
315
316 return \@retlist;
317} # end _toPool()
318
319
320## IPDB::_poolToAllocations
321# Convert pool IPs into allocations, and free IPs into free blocks
322# Takes a pool ID, original pool CIDR (in case the allocation has been updated before the call here)
323# and hashref to data for the new parent container for the IPs,
324# and an optional hash with the new parent ID and allocation type
325sub _poolToAllocations {
326 my $dbh = shift;
327 my $oldpool = shift;
328 my $parentinfo = shift;
329 my %args = @_;
330
331 # Default to converting the pool to a container
332 $args{newparent} = $oldpool->{id} if !$args{newparent};
333
334 my ($containerclass) = ($parentinfo->{type} =~ /(.)./);
335
336 # Default type mapping
337 $args{newtype} = $poolmap{$oldpool->{type}} if !$args{newtype};
338
339 # Convert a bunch of pool IP allocations into "normal" netblock allocations
340 my $pool2alloc = $dbh->prepare(q{
341 INSERT INTO allocations (
342 cidr,type,city, description, notes, circuitid, createstamp, modifystamp,
343 privdata, custid, vrf, vlan, rdns, parent_id, master_id
344 )
345 SELECT
346 ip, ? AS type, city, description, notes, circuitid, createstamp, modifystamp,
347 privdata, custid, vrf, vlan, rdns, ? AS parent_id, master_id
348 FROM poolips
349 WHERE parent_id = ? AND available = 'n'
350 });
351 $pool2alloc->execute($args{newtype}, $args{newparent}, $oldpool->{id});
352
353 # Snag the whole list of pool IPs
354 my @freeips = @{$dbh->selectall_arrayref("SELECT ip,available FROM poolips WHERE parent_id = ?",
355 undef, $oldpool->{id})};
356 my @iplist;
357 my %usedips;
358 # Filter out the ones that were used...
359 foreach my $ip (@freeips) {
360 $$ip[0] =~ s{/32$}{};
361 push @iplist, NetAddr::IP->new($$ip[0]) if $$ip[1] eq 'y';
362 $usedips{$$ip[0]}++ if $$ip[1] eq 'n';
363 }
364 # ... so that we can properly decide whether the net, gw, and bcast IPs need to be added to the free list.
365 my $tmpblock = new NetAddr::IP $oldpool->{block};
366 push @iplist, NetAddr::IP->new($tmpblock->network->addr)
367 if !$usedips{$tmpblock->network->addr} || $tmpblock->network->addr =~ /\.0$/;
368 push @iplist, NetAddr::IP->new($tmpblock->broadcast->addr)
369 if !$usedips{$tmpblock->broadcast->addr} || $tmpblock->broadcast->addr =~ /\.255$/;
370 # only "DHCP"-ish pools have a gw ip removed from the pool
371 if ($oldpool->{type} =~ /.d/) {
372 $tmpblock++;
373 push @iplist, NetAddr::IP->new($tmpblock->addr);
374 }
375
376 # take the list of /32 IPs, and see what CIDR ranges we get back as free, then insert them.
377 @iplist = Compact(@iplist);
378 my $insfbsth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,vrf,parent_id,master_id) VALUES (?,?,?,?,?,?)");
379 foreach (@iplist) {
380 $insfbsth->execute($_, $parentinfo->{city}, $containerclass, $parentinfo->{vrf},
381 $args{newparent}, $parentinfo->{master_id});
382 }
383
384 # and finally delete the poolips entries
385 $dbh->do("DELETE FROM poolips WHERE parent_id = ?", undef, $oldpool->{id});
386
387} # end _poolToAllocations()
388
389
390## IPDB::_deleteCascade()
391# Internal sub. Deletes an allocation and all subcomponents
392sub _deleteCascade {
393 my $dbh = shift;
394 my $id = shift;
395 my $createfb = shift; # may be null at this point
396
397 my $binfo = getBlockData($dbh, $id);
398
399 # Decide if we're going to add a free block.
400
401 # Caller is normal block delete -> add freeblock under $binfo->{parent_id} -> pass nothing
402 # Caller is delete for merge to leaf -> do not add freeblock -> pass 0
403 # Caller is normal master delete -> do not add freeblock -> pass nothing
404 # Caller is merge master -> add freeblock under alternate parent -> pass parent ID
405 if ($binfo->{type} ne 'mm') {
406 # Deleting a non-master block
407 if (!defined($createfb)) {
408 # No createfb flag passed; assuming normal block delete. Add the freeblock
409 # under the parent of the block we're deleting.
410 $createfb = $binfo->{parent_id};
411 #} else {
412 # Don't need to actually do anything here. The caller has given us an ID,
413 # which is either 0 (causing no free block) or (theoretically) a valid block
414 # ID to add the free block under.
415 }
416 #} else {
417 # Deleting a master block
418 # Don't need to actually do anything here. If the caller passed a parent ID,
419 # that parent will get the new free block. if the caller didn't pass anything,
420 # no free block will be added.
421 }
422
423##fixme: special-case master blocks up here and quickly delete based on master_id,
424# instead of wasting time tracing parent relations
425
426 # grab all allocations in the master within the CIDR of the block to be deleted
427 my %parents;
428 my %cidrlist;
429##fixme: limit by VRF?
430 my $sth = $dbh->prepare("SELECT cidr,id,parent_id FROM allocations WHERE cidr <<= ? AND master_id = ?");
431 $sth->execute($binfo->{block}, $binfo->{master_id});
432 while (my ($cidr, $cid, $pid) = $sth->fetchrow_array) {
433 $parents{$cid} = $pid;
434 $cidrlist{$cid} = $cidr;
435 }
436
437 # Trace the parent relations up the tree until we either hit parent ID 0 (we've found a master block
438 # but not the parent we're looking for - arguably this is already an error) or the parent ID matches
439 # the passed ID. If the latter, push the whole set into a second flag hash, so we can terminate
440 # further tree-tracing early.
441 my %found;
442 foreach my $cid (keys %parents) {
443 my @tmp;
444 if ($cid == $id) {
445 # "child" is the ID we've been asked to cascade-delete.
446 $found{$cid}++;
447 } elsif ($found{$cid}) {
448 # ID already seen and the chain terminates in our parent.
449 } elsif ($parents{$cid} == $id) {
450 # Immediate parent is the target parent
451 $found{$cid}++;
452 } else {
453 # Immediate parent isn't the one we're looking for. Walk the chain up until we hit our parent,
454 # the nonexistent parent id 0, or undefined (ID is not a child of the target ID at all)
455 # There are probably better ways to structure this loop.
456 while (1) {
457 # cache the ID
458 push @tmp, $cid;
459 # some very particularly defined loop ending conditions
460 if (!defined($parents{$cid}) || $parents{$cid} == $id || $parents{$cid} == 0) {
461 last;
462 } else {
463 # if we haven't found either the desired parent or another limiting condition,
464 # reset the ID to the parent next up the tree
465 $cid = $parents{$cid};
466 }
467 }
468 # if the current chain of relations ended with our target parent, shuffle the cached IDs into a flag hash
469 if (defined($parents{$cid}) && $parents{$cid} == $id) {
470 foreach (@tmp) { $found{$_}++; }
471 }
472 } # else
473 } # foreach my $cid
474
475 # Use the keys in the flag hash to determine which allocations to actually delete.
476 # Delete matching freeblocks and pool IPs; their parents are going away so we want
477 # to make sure we don't leave orphaned records lying around loose.
478 my @dellist = keys %found;
479 push @dellist, $id; # Just In Case the target ID didn't make the list earlier.
480 my $b = '?'. (',?' x $#dellist);
481 $dbh->do("DELETE FROM allocations WHERE id IN ($b)", undef, (@dellist) );
482 $dbh->do("DELETE FROM freeblocks WHERE parent_id IN ($b)", undef, (@dellist) );
483 $dbh->do("DELETE FROM poolips WHERE parent_id IN ($b)", undef, (@dellist) );
484
485 # Insert a new free block if needed
486 if ($createfb) {
487 my $pinfo = getBlockData($dbh, $createfb);
488 my $pt = (split //, $pinfo->{type})[1];
489 $dbh->do("INSERT INTO freeblocks (cidr,city,routed,parent_id,vrf,master_id) VALUES (?,?,?,?,?,?)", undef,
490 $binfo->{block}, $pinfo->{city}, $pt, $createfb, $pinfo->{vrf}, $binfo->{master_id});
491 }
492
493##todo: and hey! bonus! we can return @dellist, or something (%cidrlist{@dellist})
494
495} # end _deleteCascade()
496
497
498## IPDB::_getChildren()
499# Recursive sub to retrieve a flat list of suballocations
500# Takes the root parent ID, master ID, reference to push results into, and the CIDR
501# range to restrict results to
502sub _getChildren {
503 my $dbh = shift;
504 my $id = shift;
505 my $master = shift;
506 my $retlist = shift; # better than trying to return complex structures recursively. Ow.
507 my $cidr = shift;
508
509 if (!$cidr) {
510 my $bd = getBlockData($dbh, $id);
511 $cidr = $bd->{cidr};
512 }
513
514 my $sth = $dbh->prepare(q(
515 SELECT id,cidr,type FROM allocations
516 WHERE parent_id = ? AND master_id = ? AND cidr <<= ?
517 ) );
518 $sth->execute($id, $master, $cidr);
519 while (my $row = $sth->fetchrow_hashref) {
520 push @$retlist, $row;
521 _getChildren($dbh, $row->{id}, $master, $retlist, $cidr);
522 }
523} # end _getChildren()
524
525
526##
527## Public subs
528##
529
530
531## IPDB::initIPDBGlobals()
532# Initialize all globals. Takes a database handle, returns a success or error code
533sub initIPDBGlobals {
534 my $dbh = $_[0];
535 my $sth;
536
537 # Initialize alloctypes hashes
538 $sth = $dbh->prepare("select type,listname,dispname,listorder,def_custid from alloctypes order by listorder");
539 $sth->execute;
540 while (my @data = $sth->fetchrow_array) {
541 $disp_alloctypes{$data[0]} = $data[2];
542 $def_custids{$data[0]} = $data[4];
543 if ($data[3] < 900) {
544 $list_alloctypes{$data[0]} = $data[1];
545 }
546 }
547
548 # City and POP listings
549 $sth = $dbh->prepare("select city,routing from cities order by city");
550 $sth->execute;
551 return (undef,$sth->errstr) if $sth->err;
552 while (my @data = $sth->fetchrow_array) {
553 push @citylist, $data[0];
554 if ($data[1] eq 'y') {
555 push @poplist, $data[0];
556 }
557 }
558
559 # Load ACL data. Specific username checks are done at a different level.
560 $sth = $dbh->prepare("select username,acl from users");
561 $sth->execute;
562 return (undef,$sth->errstr) if $sth->err;
563 while (my @data = $sth->fetchrow_array) {
564 $IPDBacl{$data[0]} = $data[1];
565 }
566
567##fixme: initialize HTML::Template env var for template path
568# something like $self->path().'/templates' ?
569# $ENV{HTML_TEMPLATE_ROOT} = 'foo/bar';
570
571 # fix up DNSAdmin remote link based on RPC URL
572 if ($rpc_url) {
573 ($dnsadmin_url = $rpc_url) =~ s{/dns-rpc\.f?cgi}{};
574 }
575
576 return (1,"OK");
577} # end initIPDBGlobals
578
579
580## IPDB::connectDB()
581# Creates connection to IPDB.
582# Requires the database name, username, and password.
583# Returns a handle to the db.
584# Set up for a PostgreSQL db; could be any transactional DBMS with the
585# right changes.
586sub connectDB {
587 my $dbname = shift;
588 my $user = shift;
589 my $pass = shift;
590 my $dbhost = shift;
591
592 my $dbh;
593 my $DSN = "DBI:Pg:".($dbhost ? "host=$dbhost;" : '')."dbname=$dbname";
594
595# Note that we want to autocommit by default, and we will turn it off locally as necessary.
596# We may not want to print gobbledygook errors; YMMV. Have to ponder that further.
597 $dbh = DBI->connect($DSN, $user, $pass, {
598 AutoCommit => 1,
599 PrintError => 0
600 })
601 or return (undef, $DBI::errstr) if(!$dbh);
602
603# Return here if we can't select. Note that this indicates a
604# problem executing the select.
605 my $sth = $dbh->prepare("select type from alloctypes");
606 $sth->execute();
607 return (undef,$DBI::errstr) if ($sth->err);
608
609# See if the select returned anything (or null data). This should
610# succeed if the select executed, but...
611 $sth->fetchrow();
612 return (undef,$DBI::errstr) if ($sth->err);
613
614# If we get here, we should be OK.
615 return ($dbh,"DB connection OK");
616} # end connectDB
617
618
619## IPDB::finish()
620# Cleans up after database handles and so on.
621# Requires a database handle
622sub finish {
623 my $dbh = $_[0];
624 $dbh->disconnect if $dbh;
625} # end finish
626
627
628## IPDB::checkDBSanity()
629# Quick check to see if the db is responding. A full integrity
630# check will have to be a separate tool to walk the IP allocation trees.
631sub checkDBSanity {
632 my ($dbh) = $_[0];
633
634 if (!$dbh) {
635 print "No database handle, or connection has been closed.";
636 return -1;
637 } else {
638 # it connects, try a stmt.
639 my $sth = $dbh->prepare("select type from alloctypes");
640 my $err = $sth->execute();
641
642 if ($sth->fetchrow()) {
643 # all is well.
644 return 1;
645 } else {
646 print "Connected to the database, but could not execute test statement. ".$sth->errstr();
647 return -1;
648 }
649 }
650 # Clean up after ourselves.
651# $dbh->disconnect;
652} # end checkDBSanity
653
654
655## IPDB::addVRF()
656#
657sub addVRF {
658 my $dbh = shift;
659 my $newvrf = shift;
660 my %args = @_;
661
662 $args{comment} = '' if !$args{comment};
663 $args{location} = '' if !$args{location};
664
665 # Allow transactions, and raise an exception on errors so we can catch it later.
666 # Use local to make sure these get "reset" properly on exiting this block
667 local $dbh->{AutoCommit} = 0;
668 local $dbh->{RaiseError} = 1;
669
670 eval {
671 # Check if the VRF exists. Arguably should check for "looks similar", but that gets ugly fast.
672 my $vrfex = $dbh->selectrow_array("SELECT vrf FROM vrfs WHERE vrf=?", undef, $newvrf);
673 die "VRF already exists!\n" if $vrfex;
674
675 # Nothing there yet, so we can insert the new VRF
676 $dbh->do("INSERT INTO vrfs (vrf,comment,location) VALUES (?,?,?)", undef,
677 $newvrf, $args{comment}, $args{location});
678
679 $dbh->commit;
680 };
681 if ($@) {
682 my $msg = $@;
683 eval { $dbh->rollback; };
684 return ('FAIL',$msg);
685 }
686 return ('OK',$newvrf);
687} # end addVRF()
688
689
690## IPDB::getVRF()
691# Retrieve additional fields from DB for a VRF
692sub getVRF {
693 my $dbh = shift;
694 my $vrf = shift;
695
696 return $dbh->selectrow_hashref("SELECT comment,location FROM vrfs WHERE vrf = ?", {Slice=>{}}, $vrf);
697} # end getVRF()
698
699
700## IPDB::deleteVRF()
701#
702sub deleteVRF {
703 my $dbh = shift;
704 my $vrf = shift;
705
706 # Allow transactions, and raise an exception on errors so we can catch it later.
707 # Use local to make sure these get "reset" properly on exiting this block
708 local $dbh->{AutoCommit} = 0;
709 local $dbh->{RaiseError} = 1;
710
711 eval {
712 $dbh->do("DELETE FROM vrfs WHERE vrf = ?", undef, $vrf);
713 $dbh->commit;
714 };
715 if ($@) {
716 my $msg = $@; # not much complexity here just yet.
717 return ('FAIL',$msg);
718 }
719
720 return ('OK','OK');
721} # end deleteVRF()
722
723
724## IPDB::addMaster()
725# Does all the magic necessary to sucessfully add a master block
726# Requires database handle, block to add
727# Returns failure code and error message or success code and "message"
728sub addMaster {
729 my $dbh = shift;
730 # warning! during testing, this somehow generated a "Bad file descriptor" error. O_o
731 my $cidr = new NetAddr::IP shift;
732 my %args = @_;
733
734 $args{vrf} = '' if !$args{vrf};
735 $args{rdns} = '' if !$args{rdns};
736 $args{defloc} = '' if !$args{defloc};
737 $args{rwhois} = 'n' if !$args{rwhois}; # fail "safe", sort of.
738 $args{rwhois} = 'n' if $args{rwhois} ne 'n' and $args{rwhois} ne 'y';
739
740 my $mid;
741
742 # Allow transactions, and raise an exception on errors so we can catch it later.
743 # Use local to make sure these get "reset" properly on exiting this block
744 local $dbh->{AutoCommit} = 0;
745 local $dbh->{RaiseError} = 1;
746
747 # Wrap all the SQL in a transaction
748 eval {
749 # First check - does the master exist? Ignore VRFs until we can see a sane UI
750 my ($mcontained) = $dbh->selectrow_array("SELECT cidr FROM allocations WHERE cidr >>= ? AND type = 'mm' AND vrf = ?",
751 undef, ($cidr, $args{vrf}) );
752 die "Master block $mcontained already exists and entirely contains $cidr\n"
753 if $mcontained;
754
755 # Second check - does the new master contain an existing one or ones?
756 my ($mexist) = $dbh->selectrow_array("SELECT cidr FROM allocations WHERE cidr <<= ? AND type = 'mm' AND vrf = ?",
757 undef, ($cidr, $args{vrf}) );
758
759 if (!$mexist) {
760 # First case - master is brand-spanking-new.
761##fixme: rwhois should be globally-flagable somewhere, much like a number of other things
762## maybe a db table called "config"?
763 $dbh->do("INSERT INTO allocations (cidr,type,swip,vrf,rdns) VALUES (?,?,?,?,?)", undef,
764 ($cidr, 'mm', 'y', $args{vrf}, $args{rdns}) );
765 ($mid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
766
767# Unrouted blocks aren't associated with a city (yet). We don't rely on this
768# elsewhere though; legacy data may have traps and pitfalls in it to break this.
769# Thus the "routed" flag.
770 $dbh->do("INSERT INTO freeblocks (cidr,city,routed,parent_id,vrf,master_id) VALUES (?,?,?,?,?,?)", undef,
771 ($cidr, '<NULL>', 'm', $mid, $args{vrf}, $mid) );
772
773 # master should be its own master, so deletes directly at the master level work
774 $dbh->do("UPDATE allocations SET master_id = ? WHERE id = ?", undef, ($mid, $mid) );
775
776 # If we get here, everything is happy. Commit changes.
777 $dbh->commit;
778
779 } # done new master does not contain existing master(s)
780 else {
781
782 # collect the master(s) we're going to absorb, and snag the longest netmask while we're at it.
783 my $smallmask = $cidr->masklen;
784 my $sth = $dbh->prepare("SELECT cidr,id FROM allocations WHERE cidr <<= ? AND type='mm' AND parent_id=0");
785 $sth->execute($cidr);
786 my @cmasters;
787 my @oldmids;
788 while (my @data = $sth->fetchrow_array) {
789 my $master = new NetAddr::IP $data[0];
790 push @cmasters, $master;
791 push @oldmids, $data[1];
792 $smallmask = $master->masklen if $master->masklen > $smallmask;
793 }
794
795 # split the new master, and keep only those blocks not part of an existing master
796 my @blocklist;
797 foreach my $seg ($cidr->split($smallmask)) {
798 my $contained = 0;
799 foreach my $master (@cmasters) {
800 $contained = 1 if $master->contains($seg);
801 }
802 push @blocklist, $seg if !$contained;
803 }
804
805##fixme: master_id
806 # collect the unrouted free blocks within the new master
807 $sth = $dbh->prepare("SELECT cidr FROM freeblocks WHERE masklen(cidr) <= ? AND cidr <<= ? AND routed = 'm'");
808 $sth->execute($smallmask, $cidr);
809 while (my @data = $sth->fetchrow_array) {
810 my $freeblock = new NetAddr::IP $data[0];
811 push @blocklist, $freeblock;
812 }
813
814 # combine the set of free blocks we should have now.
815 @blocklist = Compact(@blocklist);
816
817 # master
818 $dbh->do("INSERT INTO allocations (cidr,type,swip,vrf,rdns) VALUES (?,?,?,?,?)", undef,
819 ($cidr, 'mm', 'y', $args{vrf}, $args{rdns}) );
820 ($mid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
821
822 # master should be its own master, so deletes directly at the master level work
823 $dbh->do("UPDATE allocations SET master_id = ? WHERE id = ?", undef, ($mid, $mid) );
824
825 # and now insert the new data. Make sure to delete old masters too.
826
827 # freeblocks
828 $sth = $dbh->prepare("DELETE FROM freeblocks WHERE cidr <<= ? AND parent_id IN (".join(',', @oldmids).")");
829 my $sth2 = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,parent_id,vrf,master_id)".
830 " VALUES (?,'<NULL>','m',?,?,?)");
831 foreach my $newblock (@blocklist) {
832 $sth->execute($newblock);
833 $sth2->execute($newblock, $mid, $args{vrf}, $mid);
834 }
835
836 # Update immediate allocations, and remove the old parents
837 $sth = $dbh->prepare("UPDATE allocations SET parent_id = ? WHERE parent_id = ?");
838 $sth2 = $dbh->prepare("DELETE FROM allocations WHERE id = ?");
839 foreach my $old (@oldmids) {
840 $sth->execute($mid, $old);
841 $sth2->execute($old);
842 }
843
844 # *whew* If we got here, we likely suceeded.
845 $dbh->commit;
846
847 } # new master contained existing master(s)
848 }; # end eval
849
850 if ($@) {
851 my $msg = $@;
852 eval { $dbh->rollback; };
853 return ('FAIL',$msg);
854 } else {
855
856 # Only attempt rDNS if the IPDB side succeeded
857 if ($rpc_url) {
858
859# Note *not* splitting reverse zones negates any benefit from caching the exported data.
860# IPv6 address space is far too large to split usefully, and in any case (also due to
861# the large address space) doesn't support the iterated template records v4 zones do
862# that causes the bulk of the slowdown that needs the cache anyway.
863
864 my @zonelist;
865# allow splitting reverse zones to be disabled, maybe, someday
866#if ($splitrevzones && !$cidr->{isv6}) {
867 if (1 && !$cidr->{isv6}) {
868 my $splitpoint = ($cidr->masklen <= 16 ? 16 : 24); # hack pthui
869 @zonelist = $cidr->split($splitpoint);
870 } else {
871 @zonelist = ($cidr);
872 }
873 my @fails;
874 ##fixme: remove hardcoding where possible
875 my $dasth = $dbh->prepare("INSERT INTO dnsavail (zone,location,parent_alloc) VALUES (?,?,?)");
876 foreach my $subzone (@zonelist) {
877 my %rpcargs = (
878 rpcuser => $args{user},
879 revzone => "$subzone",
880 revpatt => $args{rdns},
881 defloc => $args{defloc},
882 group => $revgroup, # not sure how these two could sanely be exposed, tbh...
883 state => 1, # could make them globally configurable maybe
884 );
885 if ($rpc_url) {
886 if (!_rpc('addRDNS', %rpcargs)) {
887 push @fails, ("$subzone" => $errstr);
888 } else {
889 $dasth->execute($subzone, $args{defloc}, $mid)
890 or push @fails, ("$subzone" => "rDNS added but failed to track locally: ".$dasth->errstr."\n");
891 }
892 }
893 }
894 if (@fails) {
895 $errstr = "Warning(s) adding $cidr to reverse DNS:\n".join("\n", @fails);
896 return ('WARN',$mid);
897 }
898 }
899 return ('OK',$mid);
900 }
901} # end addMaster
902
903
904## IPDB::touchMaster()
905# Update last-changed timestamp on a master block.
906sub touchMaster {
907 my $dbh = shift;
908 my $master = shift;
909
910 local $dbh->{AutoCommit} = 0;
911 local $dbh->{RaiseError} = 1;
912
913 eval {
914 $dbh->do("UPDATE allocations SET modifystamp=now() WHERE id = ?", undef, ($master));
915 $dbh->commit;
916 };
917
918 if ($@) {
919 my $msg = $@;
920 eval { $dbh->rollback; };
921 return ('FAIL',$msg);
922 }
923 return ('OK','OK');
924} # end touchMaster()
925
926
927## IPDB::listVRF()
928# Get summary list of all VRFs
929# Returns an arrayref to a list of hashrefs with the VRF name, comment
930sub listVRF {
931 my $dbh = shift;
932 my $vrflist = $dbh->selectall_arrayref("SELECT vrf,comment FROM vrfs ORDER BY vrf", { Slice => {} });
933 return $vrflist;
934} # end listVRF()
935
936
937## IPDB::listSummary()
938# Get summary list of all master blocks
939# Returns an arrayref to a list of hashrefs containing the master block, routed count,
940# allocated count, free count, and largest free block masklength
941sub listSummary {
942 my $dbh = shift;
943 my $vrf = shift;
944
945 my $mlist = $dbh->selectall_arrayref("SELECT cidr AS master,id FROM allocations ".
946 "WHERE type='mm' AND vrf = ? ORDER BY cidr",
947 { Slice => {} }, $vrf);
948
949 foreach (@{$mlist}) {
950 my ($rcnt) = $dbh->selectrow_array("SELECT count(*) FROM allocations WHERE cidr <<= ? AND type='rm' AND master_id = ?",
951 undef, ($$_{master}, $$_{id}));
952 $$_{routed} = $rcnt;
953 my ($acnt) = $dbh->selectrow_array("SELECT count(*) FROM allocations WHERE cidr <<= ? ".
954 "AND NOT type='rm' AND NOT type='mm' AND master_id = ?",
955 undef, ($$_{master}, $$_{id}));
956 $$_{allocated} = $acnt;
957 my ($fcnt) = $dbh->selectrow_array("SELECT count(*) FROM freeblocks WHERE cidr <<= ? AND master_id = ?",
958 undef, ($$_{master}, $$_{id}));
959 $$_{free} = $fcnt;
960 my ($bigfree) = $dbh->selectrow_array("SELECT masklen(cidr) AS maskbits FROM freeblocks WHERE cidr <<= ?".
961 " AND master_id = ? ORDER BY masklen(cidr) LIMIT 1", undef, ($$_{master}, $$_{id}));
962##fixme: should find a way to do this without having to HTMLize the <>
963 $bigfree = "/$bigfree" if $bigfree;
964 $bigfree = '<NONE>' if !$bigfree;
965 $$_{bigfree} = $bigfree;
966 }
967 return $mlist;
968} # end listSummary()
969
970
971## IPDB::listSubs()
972# Get list of subnets within a specified CIDR block, on a specified VRF.
973# Returns an arrayref to a list of hashrefs containing the CIDR block, customer location or
974# city it's routed to, block type, SWIP status, and description
975sub listSubs {
976 my $dbh = shift;
977 my %args = @_;
978
979 # Just In Case
980 $args{vrf} = '' if !$args{vrf};
981
982 # Snag the allocations for this block
983 my $sth = $dbh->prepare("SELECT cidr,city,type,custid,swip,description,vrf,id,master_id".
984 " FROM allocations WHERE parent_id = ? ORDER BY cidr");
985 $sth->execute($args{parent});
986
987 # hack hack hack
988 # set up to flag swip=y records if they don't actually have supporting data in the customers table
989 my $custsth = $dbh->prepare("SELECT count(*) FROM customers WHERE custid = ?");
990
991 # snag some more details
992 my $substh = $dbh->prepare("SELECT count(*) FROM allocations WHERE cidr <<= ? ".
993 "AND type ~ '[mc]\$' AND master_id = ? AND NOT cidr = ? ");
994 my $alsth = $dbh->prepare("SELECT count(*) FROM allocations WHERE cidr <<= ? ".
995 "AND NOT type='rm' AND NOT type='mm' AND master_id = ? AND NOT id = ?");
996 my $freesth = $dbh->prepare("SELECT count(*) FROM freeblocks WHERE cidr <<= ? AND master_id = ?");
997 my $lfreesth = $dbh->prepare("SELECT masklen(cidr) AS maskbits FROM freeblocks WHERE cidr <<= ?".
998 " AND master_id = ? ORDER BY masklen(cidr) LIMIT 1");
999
1000 my @blocklist;
1001 while (my ($cidr,$city,$type,$custid,$swip,$desc,$vrf,$id,$mid) = $sth->fetchrow_array()) {
1002 $desc .= " - vrf:$vrf" if $desc && $vrf;
1003 $desc = "vrf:$vrf" if !$desc && $vrf;
1004 $custsth->execute($custid);
1005 my ($ncust) = $custsth->fetchrow_array();
1006 $substh->execute($cidr, $mid, $cidr);
1007 my ($cont) = $substh->fetchrow_array();
1008 $alsth->execute($cidr, $mid, $id);
1009 my ($alloc) = $alsth->fetchrow_array();
1010 $freesth->execute($cidr, $mid);
1011 my ($free) = $freesth->fetchrow_array();
1012 $lfreesth->execute($cidr, $mid);
1013 my ($lfree) = $lfreesth->fetchrow_array();
1014 $lfree = "/$lfree" if $lfree;
1015 $lfree = '<NONE>' if !$lfree;
1016 my %row = (
1017 block => $cidr,
1018 subfree => $free,
1019 lfree => $lfree,
1020 city => $city,
1021 type => $disp_alloctypes{$type},
1022 custid => $custid,
1023 desc => $desc,
1024 hassubs => ($type eq 'rm' || $type =~ /.c/ ? 1 : 0),
1025 id => $id,
1026 );
1027# $row{subblock} = ($type =~ /^.r$/); # hmf. wonder why these won't work in the hash declaration...
1028 $row{listpool} = ($type =~ /^.[pd]$/);
1029 push (@blocklist, \%row);
1030 }
1031 return \@blocklist;
1032} # end listSubs()
1033
1034
1035## IPDB::listContainers()
1036# List all container-type allocations in a given parent
1037# Takes a database handle and a hash:
1038# - parent is the ID of the parent block
1039# Returns an arrayref to a list of hashrefs with the CIDR block, location, type,
1040# description, block ID, and counts for the nmber uf suballocations (all types),
1041# free blocks, and the CIDR size of the largest free block
1042sub listContainers {
1043 my $dbh = shift;
1044 my %args = @_;
1045
1046 # Just In Case
1047 $args{vrf} = '' if !$args{vrf};
1048
1049 # Snag the allocations for this block
1050 my $sth = $dbh->prepare("SELECT cidr,city,type,custid,swip,description,vrf,id,master_id".
1051 " FROM allocations WHERE parent_id = ? AND type ~ '[mc]\$' ORDER BY cidr");
1052 $sth->execute($args{parent});
1053
1054 my $alsth = $dbh->prepare("SELECT count(*) FROM allocations WHERE cidr <<= ? ".
1055 "AND NOT type='rm' AND NOT type='mm' AND master_id = ? AND NOT id = ?");
1056 my $freesth = $dbh->prepare("SELECT count(*) FROM freeblocks WHERE cidr <<= ? AND master_id = ?");
1057 my $lfreesth = $dbh->prepare("SELECT masklen(cidr) AS maskbits FROM freeblocks WHERE cidr <<= ?".
1058 " AND master_id = ? ORDER BY masklen(cidr) LIMIT 1");
1059
1060 my @blocklist;
1061 while (my ($cidr,$city,$type,$custid,$swip,$desc,$vrf,$id,$mid) = $sth->fetchrow_array()) {
1062 $desc .= " - vrf:$vrf" if $desc && $vrf;
1063 $desc = "vrf:$vrf" if !$desc && $vrf;
1064 $alsth->execute($cidr, $mid, $id);
1065 my ($alloc) = $alsth->fetchrow_array();
1066 $freesth->execute($cidr, $mid);
1067 my ($free) = $freesth->fetchrow_array();
1068 $lfreesth->execute($cidr, $mid);
1069 my ($lfree) = $lfreesth->fetchrow_array();
1070 $lfree = "/$lfree" if $lfree;
1071 $lfree = '<NONE>' if !$lfree;
1072 my %row = (
1073 block => $cidr,
1074 suballocs => $alloc,
1075 subfree => $free,
1076 lfree => $lfree,
1077 city => $city,
1078 type => $disp_alloctypes{$type},
1079 desc => $desc,
1080 id => $id,
1081 );
1082 push (@blocklist, \%row);
1083 }
1084 return \@blocklist;
1085} # end listContainers()
1086
1087
1088## IPDB::listAllocations()
1089# List all end-use allocations in a given parent
1090# Takes a database handle and a hash:
1091# - parent is the ID of the parent block
1092# Returns an arrayref to a list of hashrefs with the CIDR block, location, type,
1093# custID, SWIP flag, description, block ID, and master ID
1094sub listAllocations {
1095 my $dbh = shift;
1096 my %args = @_;
1097
1098 # Snag the allocations for this block
1099 my $sth = $dbh->prepare("SELECT cidr,city,type,custid,swip,description,vrf,id,master_id".
1100 " FROM allocations WHERE parent_id = ? AND type !~ '[mc]\$' ORDER BY cidr");
1101 $sth->execute($args{parent});
1102
1103 # hack hack hack
1104 # set up to flag swip=y records if they don't actually have supporting data in the customers table
1105 my $custsth = $dbh->prepare("SELECT count(*) FROM customers WHERE custid = ?");
1106
1107 my @blocklist;
1108 while (my ($cidr,$city,$type,$custid,$swip,$desc,$vrf,$id,$mid) = $sth->fetchrow_array()) {
1109 $desc .= " - vrf:$vrf" if $desc && $vrf;
1110 $desc = "vrf:$vrf" if !$desc && $vrf;
1111 $custsth->execute($custid);
1112 my ($ncust) = $custsth->fetchrow_array();
1113 my %row = (
1114 block => $cidr,
1115 city => $city,
1116 type => $disp_alloctypes{$type},
1117 custid => $custid,
1118 swip => ($swip eq 'y' ? 'Yes' : 'No'),
1119 partswip => ($swip eq 'y' && $ncust == 0 ? 1 : 0),
1120 desc => $desc,
1121 id => $id,
1122 );
1123# $row{subblock} = ($type =~ /^.r$/); # hmf. wonder why these won't work in the hash declaration...
1124 $row{listpool} = ($type =~ /^.[pd]$/);
1125 push (@blocklist, \%row);
1126 }
1127 return \@blocklist;
1128} # end listAllocations()
1129
1130
1131## IPDB::listForMerge()
1132# Get a list of blocks targetted in a proposed merge
1133sub listForMerge {
1134 my $dbh = shift;
1135 my $parent = shift;
1136 my $newblock = shift;
1137 my $btype = shift || 'a';
1138 $btype = 'a' if $btype !~/^[af]$/;
1139 my $incsub = shift;
1140 $incsub = 1 if !defined($incsub);
1141
1142 my $sql;
1143 if ($btype eq 'a') {
1144 my $ret = $dbh->selectall_arrayref(q(
1145 SELECT a.cidr,a.id,t.dispname FROM allocations a
1146 JOIN alloctypes t ON a.type=t.type
1147 WHERE a.parent_id = ? AND a.cidr <<= ?
1148 ORDER BY a.cidr
1149 ),
1150 { Slice => {} }, $parent, $newblock);
1151 return $ret;
1152 } else {
1153##fixme: Not sure about the casting hackery in "SELECT ?::integer AS id", but it works as intended
1154 my @dbargs = ($parent, "$newblock");
1155 push @dbargs, $parent, $newblock if $incsub;
1156 my $ret = $dbh->selectall_arrayref(q{
1157 SELECT cidr,id FROM freeblocks
1158 WHERE parent_id IN (
1159 }.($incsub ? "SELECT id FROM allocations WHERE parent_id = ? AND cidr <<= ? UNION " : '').q{
1160 SELECT ?::integer AS id
1161 ) AND cidr <<= ?
1162 ORDER BY cidr
1163 },
1164 { Slice => {} }, @dbargs);
1165 return $ret;
1166 }
1167 return;
1168} # end listForMerge()
1169
1170
1171## IPDB::listFree()
1172# Gets a list of free blocks in the requested parent/master and VRF instance in both CIDR and range notation
1173# Takes a parent/master ID and an optional VRF specifier that defaults to empty.
1174# Returns an arrayref to a list of hashrefs containing the CIDR and range-notation blocks
1175# Returns some extra flags in the hashrefs for routed blocks, since those can have several subtypes
1176sub listFree {
1177 my $dbh = shift;
1178
1179 my %args = @_;
1180 # Just In Case
1181 $args{vrf} = '' if !$args{vrf};
1182
1183 my $sth = $dbh->prepare(q(
1184 SELECT f.cidr,f.id,allocations.cidr
1185 FROM freeblocks f
1186 LEFT JOIN allocations ON f.reserve_for = allocations.id
1187 WHERE f.parent_id = ?
1188 ORDER BY f.cidr
1189 ) );
1190# $sth->execute($args{parent}, $args{vrf});
1191 $sth->execute($args{parent});
1192 my @flist;
1193 while (my ($cidr,$id,$resv) = $sth->fetchrow_array()) {
1194 $cidr = new NetAddr::IP $cidr;
1195 my %row = (
1196 fblock => "$cidr",
1197 frange => $cidr->range,
1198 fbid => $id,
1199 fbparent => $args{parent},
1200 resv => $resv,
1201 );
1202 push @flist, \%row;
1203 }
1204 return \@flist;
1205} # end listFree()
1206
1207
1208## IPDB::listPool()
1209# List the IPs in an IP pool.
1210# Takes a pool/parent ID
1211# Returns an arrayref to a list of hashrefs containing the IP, customer ID, availability flag,
1212# description, backreference to the pool/parent, and the IP ID in the pool.
1213# Also includes a "may be deleted" metaflag mainly useful for allowing the return to be passed
1214# directly to HTML::Template for UI display.
1215sub listPool {
1216 my $dbh = shift;
1217 my $pool = shift;
1218
1219 my $sth = $dbh->prepare("SELECT ip,custid,available,description,type,id".
1220 " FROM poolips WHERE parent_id = ? ORDER BY ip");
1221 $sth->execute($pool);
1222 my @poolips;
1223 while (my ($ip,$custid,$available,$desc,$type,$id) = $sth->fetchrow_array) {
1224 my %row = (
1225 ip => $ip,
1226 custid => $custid,
1227 available => $available,
1228 desc => $desc,
1229 delme => $available eq 'n',
1230 parent => $pool,
1231 id => $id,
1232 );
1233 push @poolips, \%row;
1234 }
1235 return \@poolips;
1236} # end listPool()
1237
1238
1239## IPDB::getMasterList()
1240# Get a list of master blocks, optionally including last-modified timestamps
1241# Takes an optional flag to indicate whether to include timestamps;
1242# 'm' includes ctime, all others (suggest 'c') do not.
1243# Returns an arrayref to a list of hashrefs
1244sub getMasterList {
1245 my $dbh = shift;
1246 my $stampme = shift || 'm'; # optional but should be set by caller for clarity
1247
1248 my $mlist = $dbh->selectall_arrayref("SELECT id,vrf,cidr AS master".($stampme eq 'm' ? ',modifystamp AS mtime' : '').
1249 " FROM allocations WHERE type='mm' ORDER BY cidr", { Slice => {} });
1250 return $mlist;
1251} # end getMasterList()
1252
1253
1254## IPDB::getTypeList()
1255# Get an alloctype/description pair list suitable for dropdowns
1256# Takes a flag to determine which general groups of types are returned
1257# Returns an reference to an array of hashrefs
1258sub getTypeList {
1259 my $dbh = shift;
1260 my $tgroup = shift || 'a'; # technically optional, like this, but should
1261 # really be specified in the call for clarity
1262 my $seltype = shift || '';
1263
1264 my $sql = "SELECT type,listname,type=? AS sel FROM alloctypes WHERE listorder <= 500";
1265 if ($tgroup eq 'n') {
1266 # grouping 'n' - all netblock types. These include routed blocks, containers (_c)
1267 # and contained (_r) types, dynamic-allocation ranges (_e), static IP pools (_d and _p),
1268 # and the "miscellaneous" cn, in, and en types.
1269 # Or in other words, everything but master and static IP types.
1270 $sql .= " AND type NOT LIKE '_i'";
1271 } elsif ($tgroup eq 'p') {
1272 # grouping 'p' - primary allocation types. As with 'n' above but without the _r contained types.
1273 $sql .= " AND type NOT LIKE '_i' AND type NOT LIKE '_r'";
1274 } elsif ($tgroup eq 'c') {
1275 # grouping 'c' - contained types. These include all static IPs and all _r types.
1276 $sql .= " AND (type LIKE '_i' OR type LIKE '_r')";
1277 } elsif ($tgroup eq 'i') {
1278 # grouping 'i' - static IP types.
1279 $sql .= " AND type LIKE '_i'";
1280 } else {
1281 # grouping 'a' - all standard allocation types. This includes everything
1282 # but mm (present only as a formality). Make this the default.
1283 # ... whee! no extra WHERE clauses
1284 }
1285 $sql .= " ORDER BY listorder";
1286 my $tlist = $dbh->selectall_arrayref($sql, { Slice => {} }, $seltype);
1287 return $tlist;
1288}
1289
1290
1291## IPDB::getPoolSelect()
1292# Get a list of pools matching the passed city and type that have 1 or more free IPs
1293# Returns an arrayref to a list of hashrefs containing the number of available IPs, the CIDR pool,
1294# and the city it's nominally in.
1295sub getPoolSelect {
1296 my $dbh = shift;
1297 my $iptype = shift;
1298 my $pcity = shift;
1299
1300 my ($ptype) = ($iptype =~ /^(.)i$/);
1301 return if !$ptype;
1302 $ptype .= '_';
1303
1304 my $plist = $dbh->selectall_arrayref( q(
1305 SELECT a.id as poolid,count(*) AS poolfree,a.cidr AS poolblock, a.city AS poolcit
1306 FROM poolips p
1307 JOIN allocations a ON p.parent_id=a.id
1308 WHERE p.available='y' AND a.city = ? AND p.type LIKE ?
1309 GROUP BY a.id,a.cidr,a.city
1310 ORDER BY a.cidr
1311 ),
1312 { Slice => {} }, ($pcity, $ptype) );
1313 return $plist;
1314} # end getPoolSelect()
1315
1316
1317## IPDB::findAllocateFrom()
1318# Find free block to add a new allocation from. (CIDR block version of pool select above, more or less)
1319# Takes
1320# - mask length
1321# - allocation type
1322# - POP city "parent"
1323# - optional master-block restriction
1324# - optional flag to allow automatic pick-from-private-network-ranges
1325# Returns a 3-element list with the free block ID, CIDR, and parent ID matching the criteria, if any
1326sub findAllocateFrom {
1327 my $dbh = shift;
1328 my $maskbits = shift;
1329 my $type = shift;
1330 my $city = shift;
1331 my $pop = shift;
1332 my %optargs = @_;
1333
1334 my $failmsg = "No suitable free block found\n";
1335
1336 my @vallist;
1337 my $sql;
1338
1339 # Free pool IPs should be easy.
1340 if ($type =~ /^.i$/) {
1341 # User may get an IP from the wrong VRF. User should not be using admin tools to allocate static IPs.
1342 $sql = "SELECT id, ip, parent_id FROM poolips WHERE ip = ?";
1343 @vallist = ($optargs{gimme});
1344 } else {
1345
1346## Set up the SQL to find out what freeblock we can (probably) use for an allocation.
1347## Very large systems will require development of a reserve system (possibly an extension
1348## of the reserve-for-expansion concept in https://secure.deepnet.cx/trac/ipdb/ticket/24?)
1349## Also populate a value list for the DBI call.
1350
1351 @vallist = ($maskbits);
1352 $sql = "SELECT id,cidr,parent_id FROM freeblocks WHERE masklen(cidr) <= ?";
1353
1354# cases, strict rules
1355# .c -> container type
1356# requires a routing container, fbtype r
1357# .d -> DHCP/"normal-routing" static pool
1358# requires a routing container, fbtype r
1359# .e -> Dynamic-assignment connectivity
1360# requires a routing container, fbtype r
1361# .i -> error, can't allocate static IPs this way?
1362# mm -> error, master block
1363# rm -> routed block
1364# requires master block, fbtype m
1365# .n -> Miscellaneous usage
1366# requires a routing container, fbtype r
1367# .p -> PPP(oE) static pool
1368# requires a routing container, fbtype r
1369# .r -> contained type
1370# requires a matching container, fbtype $1
1371##fixme: strict-or-not flag
1372
1373##fixme: config or UI flag for "Strict" mode
1374# if ($strictmode) {
1375if (0) {
1376 if ($type =~ /^(.)r$/) {
1377 push @vallist, $1;
1378 $sql .= " AND routed = ?";
1379 } elsif ($type eq 'rm') {
1380 $sql .= " AND routed = 'm'";
1381 } else {
1382 $sql .= " AND routed = 'r'";
1383 }
1384}
1385
1386 # for PPP(oE) and container types, the POP city is the one attached to the pool.
1387 # individual allocations get listed with the customer city site.
1388 ##fixme: chain cities to align roughly with a full layer-2 node graph
1389 $city = $pop if $type !~ /^.[pc]$/;
1390 if ($type ne 'rm' && $city) {
1391 $sql .= " AND city = ?";
1392 push @vallist, $city;
1393 }
1394 # Allow specifying an arbitrary full block, instead of a master
1395 if ($optargs{gimme}) {
1396 $sql .= " AND cidr >>= ?";
1397 push @vallist, $optargs{gimme};
1398 }
1399 # if a specific master was requested, allow the requestor to self->shoot(foot)
1400 if ($optargs{master} && $optargs{master} ne '-') {
1401 $sql .= " AND master_id = ?";
1402# if $optargs{master} ne '-';
1403 push @vallist, $optargs{master};
1404 } else {
1405 # if a specific master was NOT requested, filter out the RFC 1918 private networks
1406 if (!$optargs{allowpriv}) {
1407 $sql .= " AND NOT (cidr <<= '192.168.0.0/16' OR cidr <<= '10.0.0.0/8' OR cidr <<= '172.16.0.0/12')";
1408 }
1409 }
1410 # Keep "reserved" blocks out of automatic assignment.
1411##fixme: needs a UI flag or a config knob
1412 $sql .= " AND reserve_for = 0";
1413 # Sorting and limiting, since we don't (currently) care to provide a selection of
1414 # blocks to carve up. This preserves something resembling optimal usage of the IP
1415 # space by forcing contiguous allocations and free blocks as much as possible.
1416 $sql .= " ORDER BY masklen(cidr) DESC,cidr LIMIT 1";
1417 } # done setting up SQL for free CIDR block
1418
1419 my ($fbid,$fbfound,$fbparent) = $dbh->selectrow_array($sql, undef, @vallist);
1420 return $fbid,$fbfound,$fbparent;
1421} # end findAllocateFrom()
1422
1423
1424## IPDB::ipParent()
1425# Get an IP's parent pool's details
1426# Takes a database handle and IP
1427# Returns a hashref to the parent pool block, if any
1428sub ipParent {
1429 my $dbh = shift;
1430 my $block = shift;
1431
1432 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,custid,type,city,description FROM allocations".
1433 " WHERE cidr >>= ? AND (type LIKE '_p' OR type LIKE '_d')", undef, ($block) );
1434 return $pinfo;
1435} # end ipParent()
1436
1437
1438## IPDB::subParent()
1439# Get a block's parent's details
1440# Takes a database handle and CIDR block
1441# Returns a hashref to the parent container block, if any
1442sub subParent {
1443 my $dbh = shift;
1444 my $block = shift;
1445
1446 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,custid,type,city,description FROM allocations".
1447 " WHERE cidr >>= ?", undef, ($block) );
1448 return $pinfo;
1449} # end subParent()
1450
1451
1452## IPDB::blockParent()
1453# Get a block's parent's details
1454# Takes a database handle and CIDR block
1455# Returns a hashref to the parent container block, if any
1456sub blockParent {
1457 my $dbh = shift;
1458 my $block = shift;
1459
1460 my $pinfo = $dbh->selectrow_hashref("SELECT cidr,city FROM routed".
1461 " WHERE cidr >>= ?", undef, ($block) );
1462 return $pinfo;
1463} # end blockParent()
1464
1465
1466## IPDB::getBreadCrumbs()
1467# Retrieve the ID and CIDR of a block's parent(s) up to the master block
1468# Returns an arrayref to a list of hashrefs with CIDR and block ID
1469sub getBreadCrumbs {
1470 my $dbh = shift;
1471 my $parent = shift || 0;
1472 my $vrf = shift; # if we're not browsing into netblocks yet, caller can pass the VRF for breadcrumbs
1473 my @result;
1474
1475 my $sth = $dbh-> prepare("SELECT cidr,type,id,parent_id,vrf FROM allocations WHERE id=?");
1476
1477 while ($parent != 0) {
1478 $sth->execute($parent);
1479 my ($cidr,$type,$id,$pid,$bvrf) = $sth->fetchrow_array;
1480 $vrf = $bvrf;
1481 push @result, { cidr => $cidr, link => $id, ispool => ($type =~ /^.[dp]$/ ? 1 : 0) };
1482 $parent = $pid;
1483 }
1484
1485 push @result, { cidr => "vrf:$vrf", link => $vrf, isvrf => 1 }
1486 if $vrf;
1487
1488 return \@result;
1489} # end getBreadCrumbs()
1490
1491
1492## IPDB::getRoutedCity()
1493# Get the city for a routed block.
1494sub getRoutedCity {
1495 my $dbh = shift;
1496 my $block = shift;
1497
1498 my ($rcity) = $dbh->selectrow_array("SELECT city FROM routed WHERE cidr = ?", undef, ($block) );
1499 return $rcity;
1500} # end getRoutedCity()
1501
1502
1503## IPDB::allocateBlock()
1504# Does all of the magic of actually allocating a netblock
1505# Requires a database handle, and a hash containing the block to allocate, routing depth, custid,
1506# type, city, block to allocate from, and optionally a description, notes, circuit ID,
1507# and private data
1508# Returns a success code and optional error message.
1509sub allocateBlock {
1510 my $dbh = shift;
1511
1512 my %args = @_;
1513
1514 if ($args{cidr} eq 'Single static IP') {
1515 $args{cidr} = '';
1516 } else {
1517 $args{cidr} = new NetAddr::IP $args{cidr};
1518 }
1519
1520 $args{desc} = $args{description} if $args{description};
1521 $args{desc} = '' if !$args{desc};
1522 $args{notes} = '' if !$args{notes};
1523 $args{circid} = '' if !$args{circid};
1524 $args{privdata} = '' if !$args{privdata};
1525##fixme: VRF should trickle down like master_id
1526 $args{vrf} = '' if !$args{vrf};
1527 $args{vlan} = '' if !$args{vlan};
1528 $args{rdns} = '' if !$args{rdns};
1529
1530 # Could arguably allow this for eg /120 allocations, but end users who get a single v4 IP are
1531 # usually given a v6 /64, and most v6 addressing schemes need at least half that address space
1532 if ($args{cidr} && $args{cidr}->{isv6} && $args{rdns} =~ /\%/) {
1533 return ('FAIL','Reverse DNS template patterns are not supported for IPv6 allocations');
1534 }
1535
1536 my $sth;
1537
1538 # Snag the "type" of the freeblock and its CIDR
1539 my ($alloc_from_type, $alloc_from, $fbparent, $fcity, $fbmaster) =
1540 $dbh->selectrow_array("SELECT routed,cidr,parent_id,city,master_id FROM freeblocks WHERE id = ?",
1541 undef, $args{fbid});
1542 $alloc_from = new NetAddr::IP $alloc_from;
1543 return ('FAIL',"Failed to allocate $args{cidr}; intended free block was used by another allocation.")
1544 if ($args{type} !~ /.i/ && !$fbparent);
1545##fixme: fail here if !$alloc_from
1546# also consider "lock for allocation" due to multistep allocation process
1547
1548 # To contain the error message, if any.
1549 my $msg = "Unknown error allocating $args{cidr} as '$disp_alloctypes{$args{type}}'";
1550
1551 # Enable transactions and error handling
1552 local $dbh->{AutoCommit} = 0; # These need to be local so we don't
1553 local $dbh->{RaiseError} = 1; # step on our toes by accident.
1554
1555 if ($args{type} =~ /^.i$/) {
1556 $msg = "Unable to assign static IP $args{cidr} to $args{custid}";
1557 eval {
1558##fixme: IP pools across VRFs, need to use the IP ID instead of the CIDR
1559# ... or the VRF itself?
1560 if ($args{cidr}) { # IP specified
1561 my ($isavail) = $dbh->selectrow_array(
1562 "SELECT available FROM poolips WHERE ip=?".($args{vrf} ? " AND vrf=?" : ''),
1563 undef, ($args{vrf} ? ($args{cidr},$args{vrf}) : $args{cidr}) );
1564 die "IP is not in an IP pool.\n"
1565 if !$isavail;
1566 die "IP already allocated. Deallocate and reallocate, or update the entry\n"
1567 if $isavail eq 'n';
1568 } else { # IP not specified, take first available
1569 ($args{cidr}) = $dbh->selectrow_array("SELECT ip FROM poolips WHERE parent_id=? AND available='y' ORDER BY ip",
1570 undef, ($args{parent}) );
1571 }
1572
1573 # backup
1574 my $backupid = 0;
1575 if ($args{backup}) {
1576 my $bksql = "INSERT INTO backuplist (";
1577 my @bkvals;
1578 my @bkfields;
1579 for my $bk (@backupfields) {
1580 if ($args{"bk$bk"}) {
1581 push @bkfields, "bk$bk";
1582 push @bkvals, $args{"bk$bk"};
1583 }
1584 }
1585 $bksql .= join(',',@bkfields).") VALUES (".join(',', map {'?'} @bkfields).")";
1586 $dbh->do($bksql, undef, @bkvals);
1587 ($backupid) = $dbh->selectrow_array("SELECT currval('backuplist_backup_id_seq')");
1588 }
1589
1590 # finally assign the IP
1591 $dbh->do("UPDATE poolips SET custid = ?, city = ?, available='n', description = ?, notes = ?, ".
1592 "circuitid = ?, privdata = ?, rdns = ?, backup_id = ? ".
1593 "WHERE ip = ? AND parent_id = ?", undef,
1594 ($args{custid}, $args{city}, $args{desc}, $args{notes},
1595 $args{circid}, $args{privdata}, $args{rdns}, $backupid,
1596 $args{cidr}, $args{parent}) );
1597
1598# node hack
1599 if ($args{nodeid} && $args{nodeid} ne '') {
1600 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
1601 }
1602# end node hack
1603
1604 $dbh->commit; # Allocate IP from pool
1605 };
1606 if ($@) {
1607 $msg .= ": $@";
1608 eval { $dbh->rollback; };
1609 return ('FAIL', $msg);
1610 } else {
1611 # Snag the pool info
1612 my $pinfo = getBlockData($dbh, $args{parent});
1613 # Only try to update rDNS when the pool is flagged as "rDNS available"
1614 if ($pinfo->{revavail} || $pinfo->{revpartial}) {
1615 _rpc('addOrUpdateRevRec', cidr => "$args{cidr}", name => $args{rdns}, rpcuser => $args{user});
1616 }
1617 return ('OK', $args{cidr});
1618 }
1619
1620 } else { # end IP-from-pool allocation
1621
1622 if ($args{cidr} == $alloc_from) {
1623 # Easiest case- insert in one table, delete in the other, and go home. More or less.
1624
1625 eval {
1626 $msg = "Unable to allocate $args{cidr} as '$disp_alloctypes{$args{type}}'";
1627
1628 # backup
1629 my $backupid = 0;
1630 if ($args{backup}) {
1631 if (!$args{bkip}) {
1632 # check for /32-ness. no point in skipping /32 "netblocks", because they already single IPs
1633 die "Backup data set on a netblock requires a backup IP\n" unless $args{cidr} =~ m{/32$};
1634 $args{bkip} = $args{cidr};
1635 }
1636 my $bksql = "INSERT INTO backuplist (";
1637 my @bkfields;
1638 my @bkvals;
1639 for my $bk (@backupfields) {
1640 if ($args{"bk$bk"}) {
1641 push @bkfields, "bk$bk";
1642 push @bkvals, $args{"bk$bk"};
1643 }
1644 }
1645 $bksql .= join(',',@bkfields).") VALUES (".join(',',map {'?'} @bkfields).")";
1646 $dbh->do($bksql, undef, @bkvals);
1647 ($backupid) = $dbh->selectrow_array("SELECT currval('backuplist_backup_id_seq')");
1648 } # $args{backup}
1649
1650 # Insert the allocations entry
1651 $dbh->do("INSERT INTO allocations ".
1652 "(cidr,parent_id,master_id,vrf,vlan,custid,type,city,description,notes,circuitid,privdata,rdns,backup_id)".
1653 " VALUES (?,?,?,(SELECT vrf FROM allocations WHERE id=?),?,?,?,?,?,?,?,?,?,?)", undef,
1654 ($args{cidr}, $fbparent, $fbmaster, $fbmaster, $args{vlan}, $args{custid}, $args{type}, $args{city},
1655 $args{desc}, $args{notes}, $args{circid}, $args{privdata}, $args{rdns}, $backupid) );
1656 my ($bid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
1657
1658 # Munge freeblocks
1659 if ($args{type} =~ /^(.)[mc]$/) {
1660 # special case - block is a routed or container/"reserve" block
1661 my $rtype = $1;
1662 $dbh->do("UPDATE freeblocks SET routed = ?,city = ?,parent_id = ? WHERE id = ?",
1663 undef, ($rtype, $args{city}, $bid, $args{fbid}) );
1664 } else {
1665 # "normal" case
1666 $dbh->do("DELETE FROM freeblocks WHERE id = ?", undef, ($args{fbid}) );
1667 }
1668
1669 # And initialize the pool, if necessary
1670 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
1671 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
1672 if ($args{type} =~ /^.p$/) {
1673 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1674 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "all", $bid);
1675 die $rmsg if $code eq 'FAIL';
1676 } elsif ($args{type} =~ /^.d$/) {
1677 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1678 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "normal", $bid);
1679 die $rmsg if $code eq 'FAIL';
1680 }
1681
1682# node hack
1683 if ($args{nodeid} && $args{nodeid} ne '') {
1684 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
1685 }
1686# end node hack
1687
1688 $dbh->commit; # Simple block allocation
1689 }; # end of eval
1690 if ($@) {
1691 $msg .= ": ".$@;
1692 eval { $dbh->rollback; };
1693 return ('FAIL',$msg);
1694 }
1695
1696 } else { # cidr != alloc_from
1697
1698 # Hard case. Allocation is smaller than free block.
1699
1700 # make sure new allocation is in fact within freeblock. *sigh*
1701 return ('FAIL',"Requested allocation $args{cidr} is not within $alloc_from")
1702 if !$alloc_from->contains($args{cidr});
1703 my $wantmaskbits = $args{cidr}->masklen;
1704 my $maskbits = $alloc_from->masklen;
1705
1706 my @newfreeblocks; # Holds free blocks generated from splitting the source freeblock.
1707
1708 # This determines which blocks will be left "free" after allocation. We take the
1709 # block we're allocating from, and split it in half. We see which half the wanted
1710 # block is in, and repeat until the wanted block is equal to one of the halves.
1711 my $i=0;
1712 my $tmp_from = $alloc_from; # So we don't munge $args{alloc_from}
1713 while ($maskbits++ < $wantmaskbits) {
1714 my @subblocks = $tmp_from->split($maskbits);
1715 $newfreeblocks[$i++] = (($args{cidr}->within($subblocks[0])) ? $subblocks[1] : $subblocks[0]);
1716 $tmp_from = ( ($args{cidr}->within($subblocks[0])) ? $subblocks[0] : $subblocks[1] );
1717 } # while
1718
1719 # Begin SQL transaction block
1720 eval {
1721 $msg = "Unable to allocate $args{cidr} as '$disp_alloctypes{$args{type}}'";
1722
1723 # Delete old freeblocks entry
1724 $dbh->do("DELETE FROM freeblocks WHERE id = ?", undef, ($args{fbid}) );
1725
1726 # Insert the allocations entry
1727 $dbh->do("INSERT INTO allocations ".
1728 "(cidr,parent_id,master_id,vrf,vlan,custid,type,city,description,notes,circuitid,privdata,rdns)".
1729 " VALUES (?,?,?,(SELECT vrf FROM allocations WHERE id=?),?,?,?,?,?,?,?,?,?)", undef,
1730 ($args{cidr}, $fbparent, $fbmaster, $fbmaster, $args{vlan}, $args{custid}, $args{type}, $args{city},
1731 $args{desc}, $args{notes}, $args{circid}, $args{privdata}, $args{rdns}) );
1732 my ($bid) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
1733
1734 # Insert new list of smaller free blocks left over. Flag the one that matches the
1735 # masklength of the new allocation, if a reserve block was requested.
1736 $sth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,vrf,parent_id,master_id,reserve_for) ".
1737 "VALUES (?,?,?,?,?,?,?)");
1738 foreach my $block (@newfreeblocks) {
1739 $sth->execute($block, $fcity, $alloc_from_type, $args{vrf}, $fbparent, $fbmaster,
1740 ($args{reserve} && $block->masklen == $wantmaskbits ? $bid : 0));
1741 }
1742
1743 # For routed/container types, add a freeblock within the allocated block so we can subdivide it further
1744 if ($args{type} =~ /(.)[mc]/) { # rm and .c types - containers
1745 my $rtype = $1;
1746 $sth->execute($args{cidr}, $args{city}, $rtype, $args{vrf}, $bid, $fbmaster, 0);
1747 }
1748
1749 # And initialize the pool, if necessary
1750 # PPPoE pools (currently dialup, DSL, and WiFi) get all IPs made available
1751 # "DHCP" or "real-subnet" pools have the net, gw, and bcast IPs removed.
1752 if ($args{type} =~ /^.p$/) {
1753 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1754 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "all", $bid);
1755 die $rmsg if $code eq 'FAIL';
1756 } elsif ($args{type} =~ /^.d$/) {
1757 $msg = "Could not initialize IPs in new $disp_alloctypes{$args{type}} $args{cidr}";
1758 my ($code,$rmsg) = initPool($dbh, $args{cidr}, $args{type}, $args{city}, "normal", $bid);
1759 die $rmsg if $code eq 'FAIL';
1760 }
1761
1762# node hack
1763 if ($args{nodeid} && $args{nodeid} ne '') {
1764 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($args{cidr}, $args{nodeid}) );
1765 }
1766# end node hack
1767
1768 $dbh->commit; # Complex block allocation
1769 }; # end eval
1770 if ($@) {
1771 $msg .= ": ".$@;
1772 eval { $dbh->rollback; };
1773 return ('FAIL',$msg);
1774 }
1775
1776 } # end fullcidr != alloc_from
1777
1778 # Snag the parent info
1779 my $pinfo = getBlockData($dbh, $fbparent);
1780 # Only try to update rDNS when the block is flagged as "rDNS available"
1781 if (($pinfo->{revavail} || $pinfo->{revpartial}) && $args{rdns}) {
1782 # the netblock/allocation...
1783 _rpc('addOrUpdateRevRec', cidr => "$args{cidr}", name => $args{rdns}, rpcuser => $args{user});
1784 # ...and the per-IP set, if there is one.
1785 _rpc('updateRevSet', %{$args{iprev}}, rpcuser => $args{user})
1786 if keys (%{$args{iprev}});
1787 }
1788
1789 return ('OK', 'OK');
1790
1791 } # end static-IP vs netblock allocation
1792
1793} # end allocateBlock()
1794
1795
1796## IPDB::initPool()
1797# Initializes a pool
1798# Requires a database handle, the pool CIDR, type, city, and a parameter
1799# indicating whether the pool should allow allocation of literally every
1800# IP, or if it should reserve network/gateway/broadcast IPs
1801# Note that this is NOT done in a transaction, that's why it's a private
1802# function and should ONLY EVER get called from allocateBlock()
1803sub initPool {
1804 my ($dbh,undef,$type,$city,$class,$parent) = @_;
1805 my $pool = new NetAddr::IP $_[1];
1806
1807 # IPv6 does not lend itself to IP pools as supported
1808 return ('FAIL',"Refusing to create IPv6 static IP pool") if $pool->{isv6};
1809 # IPv4 pools don't make much sense beyond even /24. Allow up to 4096-host footshooting anyway.
1810 # NetAddr::IP won't allow more than a /16 (65k hosts).
1811 return ('FAIL',"Refusing to create oversized static IP pool") if $pool->masklen <= 20;
1812
1813 # Retrieve some odds and ends for defaults on the IPs
1814 my ($pcustid) = $dbh->selectrow_array("SELECT def_custid FROM alloctypes WHERE type=?", undef, ($type) );
1815 my ($vrf,$vlan,$master) = $dbh->selectrow_array("SELECT vrf,vlan,master_id FROM allocations WHERE id = ?",
1816 undef, ($parent) );
1817
1818 $type =~ s/[pd]$/i/;
1819 my $sth;
1820 my $msg;
1821
1822 eval {
1823 # have to insert all pool IPs into poolips table as "unallocated".
1824 $sth = $dbh->prepare("INSERT INTO poolips (ip,custid,city,type,parent_id,master_id,vrf) VALUES (?,?,?,?,?,?,?)");
1825
1826 # in case of pool extension by some means, we need to see what IPs were already inserted
1827 my $tmp1 = $dbh->selectall_arrayref("SELECT ip FROM poolips WHERE parent_id = ?", undef, $parent);
1828 my %foundips;
1829 foreach (@{$tmp1}) {
1830 $foundips{$_->[0]} = 1;
1831 }
1832
1833# Dodge an edge case - pool where IPs have been "stolen" and turned into a netblock assignment.
1834# We can't just "get all the current IPs, and add the missing ones", because some IPs are
1835# legitimately missing (for stretchy values of "legitimately").
1836
1837 my $pdata = getBlockData($dbh, $parent);
1838 my $pcidr = new NetAddr::IP $pdata->{block};
1839
1840 if ($pcidr != $pool) {
1841 # enumerate the IPs from the *old* pool, flag them as "found", so we can iterate the entire
1842 # requested pool and still make sure we skip the IPs in the old pool - even if they've been
1843 # "stolen" by legacy netblocks.
1844 my @oldips = $pcidr->hostenum;
1845 # decide whether to start excluding existing IPs at the "gateway" or "gateway+1"
1846 my $ostart = ($pdata->{type} =~ /^.d$/ ? 1 : 0);
1847 for (my $i = $ostart; $i<= $#oldips; $i++) {
1848 $foundips{$oldips[$i]} = 1;
1849 }
1850 }
1851
1852 # enumerate the hosts in the IP range - everything except the first (net) and last (bcast) IP
1853 my @poolip_list = $pool->hostenum;
1854
1855 # always check/add IPs from gw+1 through bcast-1:
1856 # (but the set won't be in oooorderrrrr! <pout>)
1857 for (my $i=1; $i<=$#poolip_list; $i++) {
1858 my $baseip = $poolip_list[$i]->addr;
1859 if ($baseip !~ /\.(?:0|255)$/ && !$foundips{$poolip_list[$i]}) {
1860 $sth->execute($baseip, $pcustid, $city, $type, $parent, $master, $vrf);
1861 }
1862 }
1863
1864 # now do the special case - DSL/PPP blocks can use the "net", "gw", and "bcast" IPs.
1865 # we exclude .0 and .255 anyway, since while they'll mostly work, they *will* behave badly here and there.
1866 if ($class eq 'all') { # (DSL-ish block - *all* IPs available
1867 if ($pool->addr !~ /\.0$/) { # .0 causes weirdness.
1868 $sth->execute($pool->addr, $pcustid, $city, $type, $parent, $master, $vrf)
1869 unless $foundips{$pool->addr."/32"};
1870 }
1871 $sth->execute($poolip_list[0]->addr, $pcustid, $city, $type, $parent, $master, $vrf)
1872 unless $foundips{$poolip_list[0]};
1873 $pool--;
1874 if ($pool->addr !~ /\.255$/) { # .255 can cause weirdness.
1875 $sth->execute($pool->addr, $pcustid, $city, $type, $parent, $master, $vrf)
1876 unless $foundips{$pool->addr."/32"};
1877 }
1878 }
1879# don't commit here! the caller may not be done.
1880# $dbh->commit;
1881 };
1882 if ($@) {
1883 $msg = $@;
1884# Don't roll back! It's up to the caller to handle this.
1885# eval { $dbh->rollback; };
1886 return ('FAIL',$msg);
1887 } else {
1888 return ('OK',"OK");
1889 }
1890} # end initPool()
1891
1892
1893## IPDB::updateBlock()
1894# Update an allocation
1895# Takes all allocation fields in a hash
1896sub updateBlock {
1897 my $dbh = shift;
1898 my %args = @_;
1899
1900 return ('FAIL', 'Missing block to update') if !$args{block};
1901
1902 # Spaces don't show up well in lots of places. Make sure they don't get into the DB.
1903 $args{custid} =~ s/^\s+//;
1904 $args{custid} =~ s/\s+$//;
1905
1906 # do it all in a transaction
1907 local $dbh->{AutoCommit} = 0;
1908 local $dbh->{RaiseError} = 1;
1909
1910 my @fieldlist;
1911 my @vallist;
1912 foreach ('custid', 'city', 'description', 'notes', 'circuitid', 'privdata', 'rdns', 'vrf', 'vlan') {
1913 if ($args{$_}) {
1914 push @fieldlist, $_;
1915 push @vallist, $args{$_};
1916 }
1917 }
1918
1919 my $binfo;
1920 my $updtable = 'allocations';
1921 my $keyfield = 'id';
1922 if ($args{type} =~ /^(.)i$/) {
1923 $updtable = 'poolips';
1924 $binfo = getBlockData($dbh, $args{block}, 'i');
1925 # allow allocating an IP by update. mainly for RPC, may simplify matters for caller
1926 if ($args{assignIP_on_update}) {
1927 push @fieldlist, 'available';
1928 push @vallist, 'n';
1929 }
1930 } else {
1931## fixme: there's got to be a better way...
1932 $binfo = getBlockData($dbh, $args{block});
1933 if ($args{swip}) {
1934 if ($args{swip} eq 'on' || $args{swip} eq '1' || $args{swip} eq 'y') {
1935 $args{swip} = 'y';
1936 } else {
1937 $args{swip} = 'n';
1938 }
1939 }
1940 foreach ('type', 'swip') {
1941 if ($args{$_}) {
1942 push @fieldlist, $_;
1943 push @vallist, $args{$_};
1944 }
1945 }
1946 }
1947
1948 return ('FAIL', 'No fields to update') if !@fieldlist;
1949
1950 my $sql = "UPDATE $updtable SET ";
1951 $sql .= join " = ?, ", @fieldlist;
1952
1953 # create these here so we can use the expanded CIDR in the rDNS update after the eval,
1954 # if we're expanding the block into a "reserved" freeblock
1955 my $cidr = NetAddr::IP->new($binfo->{block});
1956 my $newblock = NetAddr::IP->new($cidr->addr, $cidr->masklen - 1)->network;
1957
1958 eval {
1959 # check for block merge first...
1960 if ($args{fbmerge}) {
1961 # safety net? make sure mergeable block passed in is really one or both of
1962 # a) reserved for expansion of the block and
1963 # b) confirmed CIDR-combinable
1964 # "safety? SELECT foo FROM freeblocks WHERE cidr << ? AND masklen(cidr) = ?, $newblock, ".$cidr->masklen."\n";
1965 $dbh->do("DELETE FROM freeblocks WHERE id=?", undef, $args{fbmerge});
1966 # ... so we can append the change in the stored CIDR field to extend the allocation.
1967 $sql .= " = ?, cidr";
1968 push @vallist, $newblock;
1969 # if we have an IP pool, call initPool to fill in any missing entries in the pool
1970 if ($binfo->{type} =~ /^.p$/) {
1971 my ($code,$rmsg) = initPool($dbh, "$newblock", $binfo->{type}, $binfo->{city}, 'all', $args{block});
1972 die $rmsg if $code eq 'FAIL';
1973 } elsif ($binfo->{type} =~ /^.d$/) {
1974 my ($code,$rmsg) = initPool($dbh, "$newblock", $binfo->{type}, $binfo->{city}, 'normal', $args{block});
1975 die $rmsg if $code eq 'FAIL';
1976 }
1977 }
1978
1979 # backup
1980 if (!defined($args{ignorebk})) {
1981 # backup data considered "restricted"; caller should set this flag if user does not have 's' permission
1982
1983 my $backupid = $binfo->{hasbk};
1984 if (!$binfo->{hasbk}) {
1985 if ($args{backup}) {
1986 # failure mode: backup data on netblock with no IP set
1987 if (!$args{bkip}) {
1988 # check for /32-ness. no point in skipping /32 "netblocks", because they already single IPs
1989 die "Backup data set on a netblock requires a backup IP\n" unless $binfo->{block} =~ m{/32$};
1990 $args{bkip} = $binfo->{block};
1991 }
1992 # insert new backup record since we don't have one
1993 my $bksql = "INSERT INTO backuplist (";
1994 my @bkfields;
1995 my @bkvals;
1996 for my $bk (@backupfields) {
1997 if ($args{"bk$bk"}) {
1998 push @bkfields, "bk$bk";
1999 push @bkvals, $args{"bk$bk"};
2000 }
2001 }
2002 $bksql .= join(',',@bkfields).") VALUES (".join(',', map {'?'} @bkfields).")";
2003 $dbh->do($bksql, undef, @bkvals);
2004 ($backupid) = $dbh->selectrow_array("SELECT currval('backuplist_backup_id_seq')");
2005 # add the backup ID to the update
2006 push @vallist, $backupid;
2007 $sql .= " = ?, backup_id";
2008 }
2009
2010 } else { # !$binfo->{hasbk}
2011
2012 # allocation already has backup data
2013 if ($args{backup}) {
2014 if (!$args{bkip}) {
2015 # check for /32-ness. no point in skipping /32 "netblocks", because they are already single IPs
2016 die "Backup data set on a netblock requires a backup IP\n" unless $binfo->{block} =~ m{/32$};
2017 $args{bkip} = $binfo->{block};
2018 }
2019 my @bkfields;
2020 my @bkvals;
2021 for my $bk (@backupfields) {
2022 no warnings qw( uninitialized );
2023 if ($binfo->{"bk$bk"} ne $args{"bk$bk"}) {
2024 push @bkfields, "bk$bk = ?";
2025 push @bkvals, $args{"bk$bk"};
2026 }
2027 }
2028
2029 $dbh->do("UPDATE backuplist SET ".join(',', @bkfields)." WHERE backup_id = ?",
2030 undef, @bkvals, $binfo->{hasbk})
2031 if @bkfields;
2032##todo: keep historic changes for $timeperiod, by adding a backref ID field, and on updates adding a new backup
2033# record instead of updating the existing one. should probably check if new==old so we don't do needless updates
2034# in that case...
2035 } else {
2036 if ($binfo->{hasbk}) {
2037 # had backup data, no longer checked - delete backup entry
2038 $dbh->do("DELETE FROM backuplist WHERE backup_id = ?", undef, $binfo->{hasbk});
2039 $sql .= " = ?, backup_id";
2040 push @vallist, 0;
2041 }
2042 }
2043 } # $binfo->{hasbk} defined
2044 } # if !args{ignorebk}
2045
2046 # append another SQL fragment
2047 push @vallist, $args{block};
2048 $sql .= " = ? WHERE $keyfield = ?";
2049
2050##fixme: don't do the update on pool IPs if the IP is available and assignIP_on_update is not set
2051 # do the update
2052 $dbh->do($sql, undef, @vallist);
2053
2054 if ($args{node}) {
2055 # done with delete/insert so we don't have to worry about funkyness updating a node ref that isn't there
2056 $dbh->do("DELETE FROM noderef WHERE block = ?", undef, ($binfo->{block}) );
2057 $dbh->do("INSERT INTO noderef (block,node_id) VALUES (?,?)", undef, ($binfo->{block}, $args{node}) )
2058 if $args{node} ne '--';
2059 }
2060
2061 $dbh->commit;
2062 };
2063 if ($@) {
2064 my $msg = $@;
2065 $dbh->rollback;
2066 return ('FAIL', $msg);
2067 }
2068
2069 # Do RPC rDNS call, if available.
2070 # Snag the parent info
2071 my $pinfo = getBlockData($dbh, $binfo->{parent_id});
2072 # Return early if rDNS flag(s) are not set
2073 return ('OK','OK') unless ($pinfo->{revavail} || $pinfo->{revpartial});
2074
2075 # In case of any container (mainly master block), only update freeblocks so we don't stomp subs
2076 # (which would be the wrong thing in pretty much any case except "DELETE ALL EVARYTHING!!1!oneone!")
2077 if ($binfo->{type} =~ '.[mc]') {
2078 # Not using listFree() as it doesn't return quite all of the blocks wanted.
2079 # Retrieve the immediate free blocks
2080 my $sth = $dbh->prepare(q(
2081 SELECT cidr FROM freeblocks WHERE parent_id = ?
2082 UNION
2083 SELECT cidr FROM freeblocks f WHERE
2084 cidr = (SELECT cidr FROM allocations a WHERE f.cidr = a.cidr)
2085 AND master_id = ?
2086 ) );
2087 $sth->execute($args{block}, $binfo->{master_id});
2088 my %fbset;
2089 while (my ($fb) = $sth->fetchrow_array) {
2090 $fbset{"host_$fb"} = $args{rdns};
2091 }
2092 # We use this RPC call instead of multiple addOrUpdateRevRec calls, since we don't
2093 # know how many records we'll be updating and more than 3-4 is far too slow. This
2094 # should be safe to call unconditionally.
2095 # Requires dnsadmin >= r678
2096 _rpc('updateRevSet', %fbset, rpcuser => $args{user});
2097
2098 } else {
2099 $binfo->{block} =~ s{/(?:32|128)$}{};
2100 # Only insert a record for IPv4, or actual single v6 IPs
2101 _rpc('addOrUpdateRevRec', cidr => $binfo->{block}, name => $args{rdns}, rpcuser => $args{user})
2102 if !$cidr->{isv6} || ($cidr->{isv6} && $cidr->masklen == 128);
2103
2104 # and the per-IP set, if there is one.
2105 _rpc('updateRevSet', cidr => $binfo->{block}, %{$args{iprev}}, rpcuser => $args{user}, location => $pinfo->{location})
2106 if keys (%{$args{iprev}});
2107
2108 # and fix up the template's CIDR if required
2109 _rpc('resizeTemplate', oldcidr => "$binfo->{block}", newcidr => $newblock->network.'', rpcuser => $args{user})
2110 if $args{fbmerge};
2111 }
2112
2113##fixme: RPC failures?
2114 return ('OK','OK');
2115} # end updateBlock()
2116
2117
2118## IPDB::splitBlock()
2119# Splits an existing allocation into two or more smaller allocations based on a passed netmask
2120# Duplicates all other data
2121# Returns an arrayref to a list of hashrefs with ID and CIDR keys for the list of new allocations.
2122# Should probably commit DNS magic to realign DNS data
2123# Mostly works but may return Strange Things(TM) if used on a master block
2124sub splitBlock {
2125 my $dbh = shift;
2126 my %args = @_;
2127
2128##fixme: set errstr on errors so caller can suitably clue-by-four the user
2129 return if $args{basetype} ne 'b'; # only netblocks allowed!
2130
2131 my $binfo = getBlockData($dbh, $args{id});
2132 return if !$binfo;
2133
2134 return if $args{newmask} !~ /^\d+$/;
2135
2136 my @ret;
2137 my $block = new NetAddr::IP $binfo->{block};
2138 my $oldmask = $block->masklen;
2139
2140 # Fail if the block to split is "too small" - eg, can't split a v4 /32 at all
2141 # failure modes:
2142 # difference between $oldmask and $newmask is negative or 0
2143 if ($args{newmask} - $oldmask <= 0) {
2144 $errstr = "Can't split a /$oldmask allocation into /$args{newmask} pieces";
2145 return;
2146 }
2147# # difference between $oldmask and $newmask is > n, for arbitrary n?
2148# if ($newmask - $oldmask > 42) { # because 42
2149# }
2150 # $oldmask > n, for arbitrary n? At least check limits of data type.
2151 if ($block->{isv6}) {
2152 if ($args{newmask} - $oldmask > 128) {
2153 $errstr = "Impossible IPv6 mask length /$args{newmask} requested";
2154 return;
2155 }
2156 } else {
2157 if ($args{newmask} - $oldmask > 32) {
2158 $errstr = "Impossible IPv4 mask length /$args{newmask} requested";
2159 return;
2160 }
2161 }
2162
2163 my @newblocks = $block->split($args{newmask});
2164
2165 local $dbh->{AutoCommit} = 0;
2166 local $dbh->{RaiseError} = 1;
2167
2168 eval {
2169 # line up a list of fields and values. Be nice if there was a handy way to do,
2170 # direct in SQL, something like
2171 # "INSERT INTO foo (f1,f2,f3) VALUES (newf1,(SELECT oldf2,oldf3 FROM foo WHERE baz))"
2172 my @fieldlist = qw(type city description notes circuitid privdata custid swip vrf vlan rdns parent_id master_id);
2173 my $fields_sql = join(',', @fieldlist);
2174 my @vals;
2175 foreach (@fieldlist) {
2176 push @vals, $binfo->{$_};
2177 }
2178 # note the first block in the split for return
2179 push @ret, {nid => $args{id}, nblock => "$newblocks[0]"};
2180
2181 # prepare
2182 my $idsth = $dbh->prepare("SELECT currval('allocations_id_seq')");
2183 my $allocsth = $dbh->prepare("INSERT INTO allocations (cidr, $fields_sql)".
2184 " VALUES (?".',?'x(scalar(@fieldlist)).")");
2185 my $allocsth2 = $dbh->prepare(qq(
2186 INSERT INTO allocations (cidr, $fields_sql)
2187 SELECT ? AS cidr, $fields_sql
2188 FROM allocations
2189 WHERE id = ?
2190 ) );
2191 my $nbsth = $dbh->prepare("DELETE FROM poolips WHERE parent_id = ? AND ip = ?");
2192 my $upd_psth = $dbh->prepare("UPDATE allocations SET parent_id = ? WHERE parent_id = ? AND cidr <<= ?");
2193 my $upd_msth = $dbh->prepare("UPDATE allocations SET master_id = ? WHERE master_id = ? AND cidr <<= ?");
2194 my $fb_psth = $dbh->prepare("UPDATE freeblocks SET parent_id = ? WHERE parent_id = ? AND cidr <<= ?");
2195 my $fb_msth = $dbh->prepare("UPDATE freeblocks SET master_id = ? WHERE master_id = ? AND cidr <<= ?");
2196 my $pool_psth = $dbh->prepare("UPDATE poolips SET parent_id = ? WHERE parent_id = ? AND ip << ?");
2197 my $pool_msth = $dbh->prepare("UPDATE poolips SET master_id = ? WHERE master_id = ? AND ip <<= ?");
2198
2199 my @clist;
2200 _getChildren($dbh, $args{id}, $binfo->{master_id}, \@clist, $block);
2201
2202 my @processlist;
2203 push @processlist, { id => $args{id}, cidr => $block, mask => $block->masklen, type => $binfo->{type} };
2204 foreach (@clist) {
2205 $_->{cidr} = new NetAddr::IP $_->{cidr};
2206 if ($_->{cidr}->masklen < $args{newmask}) {
2207 $_->{mask} = $_->{cidr}->masklen;
2208 push @processlist, $_;
2209 }
2210 }
2211
2212 # Sort on masklen, crudely break ties by pushing container blocks down the stack. Multiple-nested containers
2213 # of the same size are virtually guaranteed to produce strange results, but should be rare enough to not matter
2214 @processlist = sort { $b->{cidr}->masklen <=> $a->{cidr}->masklen || $a->{type} =~ /^.m$/ } @processlist;
2215
2216 foreach my $pr (@processlist) {
2217 my @nbset = $pr->{cidr}->split($args{newmask});
2218
2219 # set up update of existing block
2220 $dbh->do("UPDATE allocations SET cidr = ? WHERE id = ?", undef, ("$nbset[0]", $pr->{id}) );
2221
2222 # axe the new bcast IP from the smaller pool at the "base" block, if it's a "normal" pool
2223 if ($pr->{type} =~ /.d/) {
2224 $nbset[0]--;
2225 $nbsth->execute($pr->{id}, $nbset[0]->addr);
2226 }
2227
2228 # Holder for freeblocks-to-delete. Should be impossible to have more than one...
2229 my %fbdel;
2230
2231 # Loop over the new blocks that are not the base block
2232 for (my $i = 1; $i <= $#nbset; $i++) {
2233 # add the new allocation
2234 $allocsth2->execute($nbset[$i], $pr->{id});
2235
2236 # fetch the ID of the entry we just added...
2237 $idsth->execute();
2238 my ($nid) = $idsth->fetchrow_array();
2239 # ... so we can pass back the list of blocks and IDs...
2240 push @ret, {nid => $nid, nblock => "$nbset[$i]"};
2241 # axe the net, gw, and bcast IPs as necessary when splitting a "normal" pool
2242 if ($pr->{type} =~ /.d/) {
2243 # net
2244 $nbsth->execute($pr->{id}, $nbset[$i]->addr);
2245 $nbset[$i]++;
2246 # gw
2247 $nbsth->execute($pr->{id}, $nbset[$i]->addr);
2248 $nbset[$i]--;
2249 $nbset[$i]--;
2250 # bcast
2251 $nbsth->execute($pr->{id}, $nbset[$i]->addr);
2252 $nbset[$i]++;
2253 } # $binfo->{type} =~ /.d/
2254
2255 # Check for free blocks larger than the new mask length, and split those as needed.
2256 if ($pr->{type} =~ /.[cm]/) {
2257 # get a "list" of freeblocks bigger than the allocation in the parent. there's only one, right?
2258 my $fblist = $dbh->selectall_arrayref("SELECT id FROM freeblocks WHERE cidr >> ? AND parent_id = ? ",
2259 {Slice=>{}}, $nbset[$i], $pr->{id});
2260 if (@$fblist) {
2261 # create a new freeblock for the new block we created earlier
2262 $dbh->do(q{
2263 INSERT INTO freeblocks (cidr, parent_id, master_id, city, routed,vrf)
2264 SELECT ? AS cidr, ? AS parent_id, master_id, city, routed, vrf FROM freeblocks
2265 WHERE id = ?
2266 }, undef, ($nbset[$i], $nid, $fblist->[0]->{id}) );
2267 $fbdel{$fblist->[0]->{id}}++;
2268 }
2269 } # $binfo->{type} =~ /.[cm]/
2270
2271 # Reparent allocations, freeblocks, and pool IPs.
2272 $upd_psth->execute($nid, $pr->{id}, $nbset[$i]);
2273 $fb_psth->execute($nid, $pr->{id}, $nbset[$i]);
2274 $pool_psth->execute($nid, $pr->{id}, $nbset[$i]);
2275
2276 # Update master if we've split a master block
2277 if ($pr->{type} eq 'mm') {
2278 $upd_msth->execute($nid, $pr->{id}, $nbset[$i]);
2279 $fb_msth->execute($nid, $pr->{id}, $nbset[$i]);
2280 $pool_msth->execute($nid, $pr->{id}, $nbset[$i]);
2281 }
2282
2283##fixme:
2284# 2015/09/09 not sure if the latest rewrite has covered this case complete or not
2285# Still missing one edge case - megasplitting a large block such that "many" children also need to be split.
2286# I'm going to call this "unsupported" because I really can't imagine a sane reason for doing this.
2287# Should probably check and error out at least
2288
2289 } # for (... @nbset)
2290
2291 if (%fbdel) {
2292 my $delfblist = $dbh->selectall_arrayref(q{
2293 SELECT cidr,parent_id,id FROM freeblocks
2294 WHERE id in (
2295 }.join(',', keys %fbdel).")", {Slice=>{}} );
2296 $dbh->do("DELETE FROM freeblocks WHERE id IN (".join(',', keys %fbdel).")") if %fbdel;
2297 }
2298
2299 } # foreach @processlist
2300
2301 $dbh->commit;
2302 };
2303 if ($@) {
2304 $errstr = "Error splitting $binfo->{block}: $@";
2305 $dbh->rollback;
2306 return;
2307 }
2308
2309 # Only try to update rDNS when the original block is flagged as "rDNS available"
2310 _rpc('splitTemplate', cidr => $binfo->{block}, newmask => $args{newmask}, rpcuser => $args{user})
2311 if ($binfo->{revavail} || $binfo->{revpartial});
2312
2313 return \@ret;
2314} # end splitBlock()
2315
2316
2317## IPDB::shrinkBlock()
2318# Shrink an allocation to the passed CIDR block
2319# Takes an allocation ID and a new CIDR
2320# Returns an arrayref to a list of hashrefs with the ID and CIDR of the freed block(s)
2321# Refuses to shrink "real netblock" pool types below /30
2322sub shrinkBlock {
2323 my $dbh = shift;
2324 my $id = shift;
2325
2326 # just take the new CIDR spec; this way we can shrink eg .16/28 to .20/30 without extra contortions
2327 my $newblock = new NetAddr::IP shift;
2328
2329 my $user = shift;
2330
2331 if (!$newblock) {
2332 $errstr = "Can't shrink something that's not a netblock";
2333 return;
2334 }
2335
2336 my $binfo = getBlockData($dbh, $id);
2337 my $pinfo = getBlockData($dbh, $binfo->{parent_id});
2338
2339 if ($binfo->{type} =~ /.d/ && $newblock->masklen > ($newblock->bits+2) ) {
2340 $errstr = "Can't shrink a non-PPP pool smaller than ".($newblock->{isv6} ? '/124' : '/30');
2341 return;
2342 }
2343
2344 my $oldblock = new NetAddr::IP $binfo->{block};
2345
2346 # Don't try to shrink the block outside of itself, Bad Things (probably) Happen.
2347 if (!$oldblock->contains($newblock)) {
2348 $errstr = "Can't shrink an allocation outside of itself";
2349 return;
2350 }
2351
2352 local $dbh->{AutoCommit} = 0;
2353 local $dbh->{RaiseError} = 1;
2354
2355 my $addfbsth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,vrf,parent_id,master_id) VALUES (?,?,?,?,?,?)");
2356 my $idsth = $dbh->prepare("SELECT currval('freeblocks_id_seq')");
2357 my $poolsth = $dbh->prepare("DELETE FROM poolips WHERE parent_id = ? AND ip << ?");
2358 my $netsth = $dbh->prepare("DELETE FROM poolips WHERE parent_id = ? AND ip = ?");
2359 my $allocsth = $dbh->prepare("DELETE FROM allocations WHERE parent_id = ? AND cidr <<= ?");
2360 my $delfbsth = $dbh->prepare("DELETE FROM freeblocks WHERE parent_id = ? AND cidr <<= ?");
2361
2362 my @ret;
2363 my @newfreelist;
2364 eval {
2365 $dbh->do("UPDATE allocations SET cidr = ? WHERE id = ?", undef, $newblock, $id);
2366
2367 # find the netblock(s) that are now free
2368 my @workingblocks = $oldblock->split($newblock->masklen);
2369 foreach my $newsub (@workingblocks) {
2370 next if $newsub == $newblock;
2371 push @newfreelist, $newsub;
2372 }
2373 @newfreelist = Compact(@newfreelist);
2374
2375 # set new freeblocks, and clean up any IP pool entries if needed.
2376 foreach my $newfree (@newfreelist) {
2377 my @clist;
2378 # the block we're munging
2379 push @clist, { id => $id, type => $binfo->{type}, cidr => $binfo->{block} };
2380 _getChildren($dbh, $id, $binfo->{master_id}, \@clist, $newfree);
2381
2382 foreach my $goner (@clist) {
2383 $poolsth->execute($goner->{id}, $newfree) if $goner->{type} =~ /.[dp]/;
2384 $allocsth->execute($goner->{id}, $newfree);
2385 $delfbsth->execute($goner->{id}, $newfree);
2386 }
2387
2388 # No pinfo means we're shrinking a master block, which means the free space is returned outside of IPDB.
2389 if ($pinfo) {
2390 $addfbsth->execute($newfree, $pinfo->{city}, 'm', $pinfo->{vrf}, $binfo->{parent_id}, $pinfo->{master_id});
2391 $idsth->execute;
2392 my ($nid) = $idsth->fetchrow_array();
2393 # add to return list
2394 push @ret, {fbid => $nid, newfree => "$newfree", fbparent => $binfo->{parent_id} };
2395 }
2396
2397 } # $newfree (@newfreelist)
2398
2399 # additional cleanup on net/gw/bcast IPs in pool
2400 if ($binfo->{type} =~ /.d/) {
2401 $netsth->execute($id, $newblock->addr);
2402 $newblock++;
2403 $netsth->execute($id, $newblock->addr);
2404 $newblock--;
2405 $newblock--;
2406 $netsth->execute($id, $newblock->addr);
2407 }
2408
2409 $dbh->commit;
2410 };
2411 if ($@) {
2412 $errstr = "Error splitting $binfo->{block}: $@";
2413 $dbh->rollback;
2414 return;
2415 }
2416
2417 # Only try to update rDNS when the original block is flagged as "rDNS available"
2418 _rpc('resizeTemplate', oldcidr => $binfo->{block}, newcidr => $newblock->network, rpcuser => $user)
2419 if ($binfo->{revavail} || $binfo->{revpartial});
2420
2421 return \@ret;
2422} # end shrinkBlock()
2423
2424
2425## IPDB::mergeBlocks()
2426# Merges two or more adjacent allocations, optionally including relevant
2427# free space, into one allocation.
2428# Takes a "base" block ID and a hash with a mask length and a scope argument to decide
2429# how much existing allocation data to delete.
2430# Returns a list starting with the new merged block, then the merged allocations with comment
2431## Merge scope:
2432# Merge to container
2433# keepall
2434# Move all mergeable allocations into the new block
2435# Move all mergeable free blocks into the new block
2436# mergepeer
2437# Move subs of mergeable containers into the updated primary.
2438# Reparent free blocks in mergeable containers to the updated primary.
2439# Convert assigned IPs from pools into subs.
2440# Convert unused IPs from pools into free blocks.
2441# Convert leaf allocations into free blocks.
2442# clearpeer
2443# Keep subs of the original (if it was a container).
2444# Convert assigned IPs from the original pool into subs (if it was a pool).
2445# Convert unused IPs from the original pool into free blocks (if it was a pool).
2446# Delete all peers and their subs aside from the original.
2447# clearall
2448# Delete all peers, subs and IPs.
2449# Add single free block for new container.
2450# Merge to pool
2451# keepall
2452# Convert all leaf allocations in the merge range to groups of used IPs
2453# mergepeer
2454# Effectively equal to keepall
2455# clearpeer
2456# Only convert IPs from the original allocation to used IPs
2457# clearall
2458# Delete any existing IPs, and reinitialize the new pool entirely
2459# Merge to leaf type
2460# Remove all subs
2461sub mergeBlocks {
2462 my $dbh = shift;
2463 my $prime = shift; # "base" block ID to use as a starting point
2464 if (!$prime) {
2465 $errstr = "Missing block ID to base merge on";
2466 return;
2467 }
2468
2469 my %args = @_;
2470
2471 # check key arguments.
2472 if (!$args{scope} || $args{scope} !~ /^(keepall|mergepeer|clearpeer|clearall)$/) {
2473 $errstr = "Bad or missing merge scope";
2474 return;
2475 }
2476 if (!$args{newmask} || $args{newmask} !~ /^\d+$/) {
2477 $errstr = "Bad or missing new netmask";
2478 return;
2479 }
2480
2481 # Retrieve info about the base allocation we're munging
2482 my $binfo = getBlockData($dbh, $prime);
2483 my $block = new NetAddr::IP $binfo->{block};
2484 my ($basetype) = ($binfo->{type} =~ /^.(.)$/);
2485 $binfo->{id} = $prime; # preserve for later, just in case
2486
2487 # proposed block
2488 my $newblock = new NetAddr::IP $block->addr."/$args{newmask}";
2489 $newblock = $newblock->network;
2490 $args{newtype} = $binfo->{type} if !$args{newtype};
2491 # if the "primary" block being changed is a master, it must remain one.
2492 # Also force the scope, since otherwise things get ugly.
2493 if ($binfo->{type} eq 'mm') {
2494 $args{newtype} = 'mm';
2495 # don't want to make a peer master a sub of the existing one; too many special cases go explodey,
2496 # but want to retain all other allocations
2497 $args{scope} = 'mergepeer';
2498 }
2499 my ($newcontainerclass) = ($args{newtype} =~ /^(.).$/);
2500
2501 # build an info hash for the "new" allocation we're creating
2502 my $pinfo = {
2503 id => $prime,
2504 block => "$newblock",
2505 type => $args{newtype},
2506 parent_id =>
2507 $binfo->{parent_id},
2508 city => $binfo->{city},
2509 vrf => $binfo->{vrf},
2510 master_id => $binfo->{master_id}
2511 };
2512
2513 my @retlist;
2514
2515 local $dbh->{AutoCommit} = 0;
2516 local $dbh->{RaiseError} = 1;
2517
2518 # Want to do all of the DB stuff in a transaction, to minimize data changing underfoot
2519 eval {
2520
2521 # We always update the "prime" block passed in...
2522 my $updsth = $dbh->prepare("UPDATE allocations SET cidr = ?, type = ? WHERE id = ?");
2523
2524##fixme: There's still an edge case in the return list where some branches accidentally include
2525# the original block as "additional". Probably due to the ordering of when the prepared update
2526# above gets executed.
2527
2528 # For leaf blocks, we may need to create a new parent as the "primary" instead
2529 # of updating the existing block
2530 my $newparent = $dbh->prepare(q{
2531 INSERT INTO allocations (
2532 cidr, type, city, description, notes, circuitid, createstamp, modifystamp,
2533 privdata, custid, swip, vrf, vlan, rdns, parent_id, master_id
2534 )
2535 SELECT
2536 ? AS cidr, ? AS type, city, description, notes, circuitid, createstamp, modifystamp,
2537 privdata, custid, swip, vrf, vlan, rdns, parent_id, master_id
2538 FROM allocations
2539 WHERE id = ?
2540 });
2541
2542 # Common actions
2543 my $peersth = $dbh->prepare("SELECT cidr,id,type,master_id FROM allocations WHERE parent_id = ? AND cidr <<= ?");
2544 $peersth->execute($binfo->{parent_id}, "$newblock");
2545 my $reparentsth = $dbh->prepare("UPDATE allocations SET parent_id = ?, master_id = ? WHERE id = ?");
2546 my $insfbsth = $dbh->prepare("INSERT INTO freeblocks (cidr,city,routed,vrf,parent_id,master_id) VALUES (?,?,?,?,?,?)");
2547 my $delsth = $dbh->prepare("DELETE FROM allocations WHERE id = ?");
2548
2549 my $fbreparentsth = $dbh->prepare(q{
2550 UPDATE freeblocks
2551 SET parent_id = ?, master_id = ?, city = ?, routed = ?, vrf = ?
2552 WHERE parent_id = ? AND cidr <<= ?
2553 });
2554
2555 if ($args{newtype} =~ /.[cm]/) {
2556 ## Container
2557
2558 # In case of merging a master block. Somewhat redundant with calls to $fbreparentsth,
2559 # but not *quite* entirely.
2560 my $mfbsth = $dbh->prepare("UPDATE freeblocks SET master_id = ? WHERE master_id = ?");
2561
2562 if ($args{scope} eq 'keepall') {
2563 # Create a new parent with the same info as the passed "primary".
2564 $newparent->execute($newblock, $args{newtype}, $prime);
2565 # and now retrieve the new parent ID
2566 ($prime) = $dbh->selectrow_array("SELECT currval('allocations_id_seq')");
2567 # snag the new parent info for the return list
2568 push @retlist, { block => "$newblock", type => $disp_alloctypes{$args{newtype}}, id => $prime };
2569 # Reparent the free blocks in the new block
2570 $fbreparentsth->execute($prime, $binfo->{master_id}, $binfo->{city}, $newcontainerclass, $binfo->{vrf},
2571 $binfo->{parent_id}, $newblock);
2572 # keep existing allocations (including the original primary), just push them down a level
2573 while (my ($peercidr, $peer_id, $peertype, $m_id) = $peersth->fetchrow_array) {
2574 $reparentsth->execute($prime, $binfo->{master_id}, $peer_id);
2575 # Fix up master_id on free blocks if we're merging a master block
2576 $mfbsth->execute($binfo->{master_id}, $m_id) if $peertype eq 'mm';
2577 # capture block for return
2578 push @retlist, { block => $peercidr, mdisp => $disp_alloctypes{$peertype}, mtype => $peertype };
2579 }
2580
2581 } elsif ($args{scope} =~ /^clear/) {
2582 # clearpeer and clearall share a starting point
2583 # snag the new parent info for the return list
2584 push @retlist, { block => "$newblock", type => $disp_alloctypes{$args{newtype}}, id => $prime };
2585 # update the primary allocation info
2586 $updsth->execute($newblock, $args{newtype}, $prime);
2587 # Reparent the free blocks in the new block
2588 $fbreparentsth->execute($prime, $binfo->{master_id}, $binfo->{city}, $newcontainerclass, $binfo->{vrf},
2589 $binfo->{parent_id}, $newblock);
2590 # Insert a free block if $prime is a leaf
2591 if ($binfo->{type} =~ /.[enr]/) {
2592 $insfbsth->execute($binfo->{block}, $binfo->{city}, $newcontainerclass, $binfo->{vrf}, $prime,
2593 $binfo->{master_id});
2594 }
2595 # delete the peers.
2596 while (my ($peercidr, $peer_id, $peertype, $m_id) = $peersth->fetchrow_array) {
2597 next if $peer_id == $prime;
2598 # push existing allocations down a level before deleting,
2599 # so that when they're deleted the parent info is correct
2600 $reparentsth->execute($prime, $binfo->{master_id}, $peer_id);
2601 _deleteCascade($dbh, $peer_id);
2602 # insert the freeblock _deleteCascade() (deliberately) didn't when deleting a master block.
2603 # aren't special cases fun?
2604 $dbh->do("INSERT INTO freeblocks (cidr,routed,parent_id,master_id) values (?,?,?,?)",
2605 undef, ($peercidr, 'm', $prime, $prime) ) if $binfo->{type} eq 'mm';
2606 # capture block for return
2607 push @retlist, { block => $peercidr, mdisp => $disp_alloctypes{$peertype}, mtype => $peertype };
2608 }
2609 if ($args{scope} eq 'clearall') {
2610 # delete any subs of $prime as well
2611 my $substh = $dbh->prepare("SELECT cidr,id FROM allocations WHERE parent_id = ?");
2612 $substh->execute($prime);
2613 while (my ($scidr, $s_id) = $substh->fetchrow_array) {
2614 _deleteCascade($dbh, $s_id);
2615 }
2616 } else {
2617 # clearpeer
2618 if ($basetype =~ /[dp]/) {
2619 # Convert active IP pool entries to allocations if the original was an IP pool
2620 _poolToAllocations($dbh, $binfo, $pinfo, newtype => $poolmap{$binfo->{type}});
2621 }
2622 } # clearall or clearpeer
2623
2624 } elsif ($args{scope} eq 'mergepeer') { # should this just be an else?
2625 # Default case. Merge "peer" blocks, but keep all suballocations
2626 # snag the new parent info for the return list
2627 push @retlist, {block => "$newblock", type => $disp_alloctypes{$args{newtype}}, id => $prime};
2628 my $substh = $dbh->prepare("UPDATE allocations SET parent_id = ? WHERE parent_id = ?");
2629 my $delsth = $dbh->prepare("DELETE FROM allocations WHERE id = ?");
2630 # Reparent freeblocks in parent
2631 $fbreparentsth->execute($prime, $binfo->{master_id}, $binfo->{city}, $newcontainerclass, $binfo->{vrf},
2632 $binfo->{parent_id}, $newblock);
2633 # Loop over "peer" allocations to be merged
2634 while (my ($peercidr, $peer_id, $peertype, $m_id) = $peersth->fetchrow_array) {
2635 # Snag existing peer data since we may need it
2636 my $peerfull = getBlockData($dbh, $peer_id);
2637 # Reparent free blocks from existing containers
2638 $fbreparentsth->execute($prime, $binfo->{master_id}, $binfo->{city}, $newcontainerclass,
2639 $binfo->{vrf}, $peer_id, $newblock);
2640 # Reparent any subblocks from existing containers
2641 $substh->execute($prime, $peer_id);
2642 # Delete the old container
2643 $delsth->execute($peer_id) unless $peer_id == $prime;
2644 # Add new freeblocks for merged leaf blocks
2645 $insfbsth->execute($peercidr, $binfo->{city}, $newcontainerclass, $binfo->{vrf}, $binfo->{id},
2646 $binfo->{master_id}) if $peertype =~ /.[enr]/;
2647 # Convert pool IPs into allocations or aggregated free blocks
2648 _poolToAllocations($dbh, $peerfull, $pinfo, newparent => $prime) if $peertype =~ /.[dp]/;
2649 # Fix up master_id on free blocks if we're merging a master block
2650 $mfbsth->execute($binfo->{master_id}, $m_id) if $peertype eq 'mm';
2651 # capture block for return
2652 push @retlist, { block => $peercidr, mdisp => $disp_alloctypes{$peertype}, mtype => $peertype };
2653 } # merge peers
2654 # update the primary allocation info. Do this last so we don't stomp extra data-retrieval in the loop above
2655 $updsth->execute($newblock, $args{newtype}, $prime);
2656
2657 } # scope
2658
2659 # Clean up free blocks
2660 _compactFree($dbh, $prime);
2661
2662 } elsif ($args{newtype} =~ /.[dp]/) {
2663 ## Pool
2664 # Snag the new parent info for the return list
2665 push @retlist, { block => "$newblock", type => $disp_alloctypes{$args{newtype}}, id => $prime };
2666
2667 if ($args{scope} eq 'keepall') {
2668 # Convert all mergeable allocations and subs to chunks of pool IP assignments
2669 push @retlist, @{ _toPool($dbh, $prime, $newblock, $args{newtype}, 1) };
2670
2671 } elsif ($args{scope} =~ /^clear/) {
2672 # Clear it all out for a fresh (mostly?) empty IP pool
2673 while (my ($peercidr, $peer_id, $peertype, $m_id) = $peersth->fetchrow_array) {
2674 next if $peer_id == $prime;
2675 # Push existing allocations down a level before deleting,
2676 # so that when they're deleted the parent info is correct
2677 $reparentsth->execute($prime, $binfo->{master_id}, $peer_id);
2678 _deleteCascade($dbh, $peer_id, 0);
2679 # Capture block for return
2680 push @retlist, { block => $peercidr, mdisp => $disp_alloctypes{$peertype}, mtype => $peertype };
2681 }
2682 if ($args{scope} eq 'clearall') {
2683 # Delete any subs of $prime as well
2684 my $substh = $dbh->prepare("SELECT cidr,id FROM allocations WHERE parent_id = ?");
2685 $substh->execute($prime);
2686 while (my ($scidr, $s_id) = $substh->fetchrow_array) {
2687 _deleteCascade($dbh, $s_id);
2688 }
2689 } else {
2690 # Convert (subs of) self if not a leaf.
2691 push @retlist, @{ _toPool($dbh, $prime, $newblock, $args{newtype}, 1) }
2692 unless $binfo->{type} =~ /.[enr]/;
2693 } # scope ne 'clearall'
2694
2695 } elsif ($args{scope} eq 'mergepeer') {
2696 # Try to match behaviour from (target type == container) by deleting immediate peer leaf allocations
2697 while (my ($peercidr, $peer_id, $peertype, $m_id) = $peersth->fetchrow_array) {
2698 next if $peer_id == $prime; # don't delete the block we're turning into the pool allocation
2699 # Capture block for return
2700 push @retlist, { block => $peercidr, mdisp => $disp_alloctypes{$peertype}, mtype => $peertype };
2701 next unless $peertype =~ /.[enr]/;
2702 # Don't need _deleteCascade(), since we'll just be deleting the freshly
2703 # added free block a little later anyway
2704 $delsth->execute($peer_id);
2705 }
2706 # Convert self if not a leaf, to match behaviour with a container type as target
2707 _toPool($dbh, $prime, $newblock, $args{newtype}) unless $binfo->{type} =~ /.[enr]/;
2708 }
2709 # Update the primary allocation info.
2710 $updsth->execute($newblock, $args{newtype}, $prime);
2711 # Delete any lingering free blocks
2712 $dbh->do("DELETE FROM freeblocks WHERE parent_id = ? AND cidr <<= ?", undef, $binfo->{parent_id}, $newblock);
2713 # Fix up the rest of the pool IPs
2714 my ($code,$msg) = initPool($dbh, $newblock, $args{newtype}, $binfo->{city},
2715 ($args{newtype} =~ /.p/ ? 'all' : 'normal'), $prime);
2716
2717 } elsif ($args{newtype} =~ /.[enr]/) {
2718 ## Leaf
2719 # Merging to a leaf type of any kind is, pretty much be definition, scope == 'clearall'.
2720 # keepall, mergepeer, and clearpeer all imply keeping suballocations, where leaf allocations
2721 # by definition do not have suballocations.
2722 # Update the old allocation
2723 $updsth->execute($newblock, $args{newtype}, $prime);
2724 # Snag the new parent info for the return list
2725 push @retlist, {block => "$newblock", type => $disp_alloctypes{$args{newtype}}, id => $prime};
2726 while (my ($peercidr, $peer_id, $peertype, $m_id) = $peersth->fetchrow_array) {
2727 next if $peer_id == $prime;
2728 # Push existing allocations down a level before deleting,
2729 # so that when they're deleted the parent info is correct
2730 $reparentsth->execute($prime, $binfo->{master_id}, $peer_id);
2731 _deleteCascade($dbh, $peer_id, 0);
2732 # Capture block for return
2733 push @retlist, { block => $peercidr, mdisp => $disp_alloctypes{$peertype}, mtype => $peertype };
2734 }
2735 # Delete any subs of $prime as well
2736 my $substh = $dbh->prepare("SELECT cidr,id FROM allocations WHERE parent_id = ?");
2737 $substh->execute($prime);
2738 while (my ($scidr, $s_id) = $substh->fetchrow_array) {
2739 _deleteCascade($dbh, $s_id);
2740 }
2741 # Clean up lingering free blocks and pool IPs
2742 $dbh->do("DELETE FROM freeblocks WHERE cidr <<= ? AND (parent_id = ? OR parent_id = ?)", undef,
2743 $newblock, $binfo->{parent_id}, $prime);
2744 $dbh->do("DELETE FROM poolips WHERE parent_id = ? AND ip <<= ? ", undef,
2745 $prime, $newblock);
2746
2747 } # $args{newtype} if()
2748
2749 $dbh->commit;
2750 };
2751 if ($@) {
2752 my $msg = $@;
2753 $errstr = $msg;
2754 $dbh->rollback;
2755 return ('FAIL',$msg);
2756 }
2757
2758# Make the assumption that any change crossing /24 or /16 boundaries will not come out right. Reverse DNS
2759# updates for this operation are already complex enough without handling those edge cases.
2760# ... er, how do we detect this?
2761
2762 # Return early if the block wasn't flagged as rDNS-able
2763 return \@retlist unless $binfo->{revavail} || $binfo->{revpartial};
2764
2765 if ($args{newtype} =~ /.[cm]/) {
2766
2767 if ($args{scope} eq 'keepall') {
2768 # Add new rDNS for new container
2769 _rpc('addOrUpdateRevRec', cidr => $binfo->{block}, name => $binfo->{rdns}, rpcuser => $args{user});
2770
2771 } else {
2772 # Resize rDNS template for $prime
2773 _rpc('resizeTemplate', oldcidr => "$binfo->{block}", newcidr => $newblock->network.'', rpcuser => $args{user});
2774
2775 # Assemble a list of blocks to delete...
2776 my $cidrlist;
2777 foreach my $mblock (@retlist) {
2778 $cidrlist .= $mblock->{block}."," unless $mblock->{block} =~ $newblock;
2779 }
2780
2781 # ... then make slight variant batch delete calls depending on the merge scope
2782 if ($args{scope} eq 'mergepeer') {
2783 # Delete separate rDNS for other peers
2784 $cidrlist =~ s/,$//;
2785 _rpc('delRevSet', cidrlist => $cidrlist, rpcuser => $args{user}, delforward => 'y', delsubs => 'n',
2786 parpatt => $pinfo->{rdns});
2787
2788 } elsif ($args{scope} eq 'clearpeer') {
2789 # Delete all rDNS within other peers
2790 $cidrlist =~ s/,$//;
2791 _rpc('delRevSet', cidrlist => $cidrlist, rpcuser => $args{user}, delforward => 'y', delsubs => 'y',
2792 parpatt => $pinfo->{rdns})
2793
2794 } elsif ($args{scope} eq 'clearall') {
2795 # Delete all other records within the new block
2796 $cidrlist .= $binfo->{block};
2797 _rpc('delRevSet', cidrlist => $cidrlist, rpcuser => $args{user}, delforward => 'y', delsubs => 'y',
2798 parpatt => $pinfo->{rdns});
2799
2800 } # scope, second level
2801 } # scope, !keepall
2802
2803 } elsif ($args{newtype} =~ /.[dp]/) {
2804 # Merge to pool
2805
2806 # Resize rDNS template for $prime
2807 _rpc('resizeTemplate', oldcidr => "$binfo->{block}", newcidr => $newblock->network.'', rpcuser => $args{user});
2808
2809 if ($args{scope} eq 'keepall' || $args{scope} eq 'mergepeer') {
2810 # Assemble a list of blocks to convert from template to individual records...
2811 my @convlist;
2812 my @dellist;
2813 foreach my $mblock (@retlist) {
2814 next if $mblock->{block} =~ $newblock;
2815 if ($mblock->{mtype} =~ /.[cmdp]/) {
2816 # Container and pool templates get deleted
2817 push @dellist, $mblock->{block};
2818 } else {
2819 # Not-containers get converted to per-IP reverse records
2820 push @convlist, $mblock->{block};
2821 }
2822 }
2823 # And do the calls.
2824 _rpc('delRevSet', cidrlist => join(',', @dellist), rpcuser => $args{user}, delforward => 'y', delsubs => 'n',
2825 parpatt => $pinfo->{rdns});
2826 _rpc('templatesToRecords', templates => \@convlist, rpcuser => $args{user});
2827
2828 } # scope eq 'keepall' || 'mergepeer'
2829 else {
2830
2831 # Assemble a list of blocks to convert from template to individual records...
2832 my @convlist;
2833 my @dellist;
2834 my @fulldellist;
2835# There may be an impossible edge case that can be optimized away in here...
2836 foreach my $mblock (@retlist) {
2837 my $checkcidr = new NetAddr::IP $mblock->{block};
2838 next if $mblock->{block} =~ $newblock;
2839 if (!$block->contains($checkcidr)) {
2840 # Blocks not within the original get deleted
2841 push @fulldellist, $mblock->{block};
2842 }
2843 elsif ($mblock->{mtype} =~ /.[cmdp]/) {
2844 # Containers and pools get deleted
2845 push @dellist, $mblock->{block};
2846 } else {
2847 # Whatever's left over gets converted
2848 push @convlist, $mblock->{block};
2849 }
2850 } # foreach @retlist
2851 # And do the calls.
2852 if ($args{scope} eq 'clearpeer') {
2853 # Not happy doing this many, but there isn't really a better way.
2854 # We delete ALL EVARYTHING in peer blocks...
2855 _rpc('delRevSet', cidrlist => join(',', @fulldellist), rpcuser => $args{user}, delforward => 'y',
2856 delsubs => 'y', parpatt => $pinfo->{rdns}) if @fulldellist;
2857 # ... and just the template for container or pool templates in $prime...
2858 _rpc('delRevSet', cidrlist => join(',', @dellist), rpcuser => $args{user}, delforward => 'y',
2859 delsubs => 'n', parpatt => $pinfo->{rdns}) if @dellist;
2860 # ... and convert a few to record groups
2861 _rpc('templatesToRecords', templates => \@convlist, rpcuser => $args{user}) if @convlist;
2862 }
2863 if ($args{scope} eq 'clearall') {
2864# consider just doing join(',',$newblock->split($newblock->masklen+1))?
2865 _rpc('delRevSet', cidrlist => join(',', @fulldellist, @dellist, @convlist, $binfo->{block}),
2866 rpcuser => $args{user}, delforward => 'y', delsubs => 'y', parpatt => $pinfo->{rdns});
2867 }
2868
2869 } # scope eq 'clearpeer' || 'clearall'
2870
2871 } elsif ($args{newtype} =~ /.[enr]/) {
2872 # Merge to leaf type
2873
2874 # Resize rDNS template for $prime
2875 _rpc('resizeTemplate', oldcidr => "$binfo->{block}", newcidr => $newblock->network.'', rpcuser => $args{user});
2876
2877 # Assemble a list of blocks to delete...
2878 my $cidrlist;
2879 foreach my $mblock (@retlist) {
2880 $cidrlist .= $mblock->{block}."," unless $mblock->{block} =~ $newblock;
2881 }
2882 # Delete all other records within the new block
2883 $cidrlist .= $binfo->{block};
2884 _rpc('delRevSet', cidrlist => $cidrlist, rpcuser => $args{user}, delforward => 'y', delsubs => 'y',
2885 parpatt => $pinfo->{rdns});
2886
2887 } # type grouping for rDNS calls
2888
2889 return \@retlist;
2890
2891} # end mergeBlocks()
2892
2893
2894## IPDB::deleteBlock()
2895# Removes an allocation from the database, including deleting IPs
2896# from poolips and recombining entries in freeblocks if possible
2897# Also handles "deleting" a static IP allocation, and removal of a master
2898# Requires a database handle, the block to delete, the routing depth (if applicable),
2899# the VRF ID, and a flag to indicate whether to delete associated forward DNS entries
2900# as well as the reverse entry
2901sub deleteBlock {
2902 my ($dbh,$id,$basetype,$delfwd,$user) = @_;
2903
2904 # reset $basetype so caller can just pass the complete allocation type
2905 if ($basetype =~ /.i/) {
2906 $basetype = 'i';
2907 } else {
2908 $basetype = 'b';
2909 }
2910
2911 # Collect info about the block we're going to delete
2912 my $binfo = getBlockData($dbh, $id, $basetype);
2913 my $cidr = new NetAddr::IP $binfo->{block};
2914
2915# For possible auto-VRF-ignoring (since public IPs shouldn't usually be present in more than one VRF)
2916# is_rfc1918 requires NetAddr::IP >= 4.059
2917# rather than doing this over and over and over.....
2918 my $tmpnum = $cidr->numeric;
2919# 192.168.0.0/16 -> 192.168.255.255 => 3232235520 -> 3232301055
2920# 172.16.0.0/12 -> 172.31.255.255 => 2886729728 -> 2887778303
2921# 10.0.0.0/8 -> 10.255.255.255 => 167772160 -> 184549375
2922 my $isprivnet = (3232235520 <= $tmpnum && $tmpnum <= 3232301055) ||
2923 (2886729728 <= $tmpnum && $tmpnum <= 2887778303) ||
2924 (167772160 <= $tmpnum && $tmpnum <= 184549375);
2925
2926 my $sth;
2927
2928 # Magic variables used for odd allocation cases.
2929 my $container;
2930 my $con_type;
2931
2932
2933 # temporarily forced null, until a sane UI for VRF tracking can be found.
2934# $vrf = '';# if !$vrf; # as with SQL, the null value is not equal to ''. *sigh*
2935
2936 # To contain the error message, if any.
2937 my $msg = "Unknown error deallocating $binfo->{type} $cidr";
2938 my $goback; # to put the parent in so we can link back where the deallocate started
2939
2940 # Enable transactions and exception-on-errors... but only for this sub
2941 local $dbh->{AutoCommit} = 0;
2942 local $dbh->{RaiseError} = 1;
2943
2944 if ($binfo->{type} =~ /^.i$/) {
2945 # First case. The "block" is a static IP
2946 # Note that we still need some additional code in the odd case
2947 # of a netblock-aligned contiguous group of static IPs
2948 my $pinfo;
2949
2950 eval {
2951 $msg = "Unable to deallocate $disp_alloctypes{$binfo->{type}} $cidr";
2952 $pinfo = getBlockData($dbh, $binfo->{parent_id}, 'b');
2953 $dbh->do("UPDATE poolips SET custid = ?, available = 'y',".
2954 "city = (SELECT city FROM allocations WHERE id = ?),".
2955 "description = '', notes = '', circuitid = '', vrf = ?, backup_id = 0".
2956 " WHERE id = ?", undef,
2957 ($pinfo->{custid}, $binfo->{parent_id}, $pinfo->{vrf}, $id) );
2958 $dbh->do("DELETE FROM backuplist WHERE backup_id = ?", undef, $binfo->{hasbk})
2959 if $binfo->{hasbk};
2960 $dbh->commit;
2961 };
2962 if ($@) {
2963 $msg .= ": $@";
2964 eval { $dbh->rollback; };
2965 return ('FAIL',$msg);
2966 }
2967
2968##fixme: RPC return code?
2969 _rpc('delByCIDR', cidr => "$cidr", user => $user, delforward => $delfwd, rpcuser => $user)
2970 if ($pinfo->{revavail} || $pinfo->{revpartial});
2971
2972 return ('OK',"OK");
2973
2974 } elsif ($binfo->{type} eq 'mm') { # end alloctype =~ /.i/
2975 # Second case. The block is a full master block
2976
2977##fixme: VRF limit
2978 $msg = "Unable to delete master block $cidr";
2979 eval {
2980 $dbh->do("DELETE FROM allocations WHERE cidr <<= ? AND master_id = ?", undef, ($cidr, $binfo->{master_id}) );
2981 $dbh->do("DELETE FROM freeblocks WHERE cidr <<= ? AND master_id = ?", undef, ($cidr, $binfo->{master_id}) );
2982 $dbh->do("DELETE FROM backuplist WHERE backup_id = ?", undef, $binfo->{hasbk})
2983 if $binfo->{hasbk};
2984 $dbh->commit;
2985 };
2986 if ($@) {
2987 $msg .= ": $@";
2988 eval { $dbh->rollback; };
2989 return ('FAIL', $msg);
2990 }
2991
2992 # Have to handle potentially split reverse zones. Assume they *are* split,
2993 # since if we added them here, they would have been added split.
2994# allow splitting reverse zones to be disabled, maybe, someday
2995#if ($splitrevzones && !$cidr->{isv6}) {
2996 my @zonelist;
2997 if (1 && !$cidr->{isv6}) {
2998 my $splitpoint = ($cidr->masklen <= 16 ? 16 : 24); # hack pthui
2999 @zonelist = $cidr->split($splitpoint);
3000 } else {
3001 @zonelist = ($cidr);
3002 }
3003 my @fails;
3004 foreach my $subzone (@zonelist) {
3005 # We don't wrap this call tighter, since there isn't an inherent allocation to check for rDNS-ability.
3006 if ($rpc_url && !_rpc('delZone', zone => "$subzone", revrec => 'y', rpcuser => $user, delforward => $delfwd) ) {
3007 push @fails, ("$subzone" => $errstr);
3008 }
3009 }
3010 if (@fails) {
3011 return ('WARN',"Warning(s) deleting $cidr from reverse DNS:\n".join("\n", @fails));
3012 }
3013 return ('OK','OK');
3014
3015 } else { # end alloctype master block case
3016
3017 ## This is a big block; but it HAS to be done in a chunk. Any removal
3018 ## of a netblock allocation may result in a larger chunk of free
3019 ## contiguous IP space - which may in turn be combined into a single
3020 ## netblock rather than a number of smaller netblocks.
3021
3022 my $retcode = 'OK';
3023 my ($ptype,$pcity,$ppatt,$p_id);
3024
3025 eval {
3026
3027##fixme: add recursive flag to allow "YES DAMMIT DELETE ALL EVARYTHING!!1!!" without
3028# explicitly deleting any suballocations of the block to be deleted.
3029
3030 # get parent info of the block we're deleting
3031 my $pinfo = getBlockData($dbh, $binfo->{parent_id});
3032 $ptype = $pinfo->{type};
3033 $pcity = $pinfo->{city};
3034 $ppatt = $pinfo->{rdns};
3035 $p_id = $binfo->{parent_id};
3036
3037 # Delete the block
3038 $dbh->do("DELETE FROM allocations WHERE id = ?", undef, ($id) );
3039
3040 # munge the parent type a little
3041 $ptype = (split //, $ptype)[1];
3042
3043##fixme: you can't... CAN NOT.... assign the same public IP to multiple things.
3044# 'Net don't work like that, homey. Restrict VRF-uniqueness to private IPs?
3045# -> $isprivnet flag from start of sub
3046
3047 # check to see if any container allocations could be the "true" parent
3048 my ($tparent,$tpar_id,$trtype,$tcity);
3049 $tpar_id = 0;
3050
3051##fixme: this is far simpler in the strict VRF case; we "know" that any allocation
3052# contained by a container is a part of the same allocation tree when the VRF fields are equal.
3053
3054# logic:
3055# For each possible container of $cidr
3056# note the parent id
3057# walk the chain up the parents
3058# if we intersect $cidr's current parent, break
3059# if we've intersected $cidr's current parent
3060# set some variables to track that block
3061# break
3062
3063# Set up part of "is it in the middle of a pool?" check
3064 my $wuzpool = $dbh->selectrow_hashref("SELECT cidr,parent_id,type,city,custid,id FROM allocations ".
3065 "WHERE (type LIKE '_d' OR type LIKE '_p') AND cidr >> ? AND master_id = ?", { Slice => {} },
3066 ($cidr, $binfo->{master_id}) );
3067
3068##fixme?
3069# edge cases not handled, or handled badly:
3070# -> $cidr managed to get to be the entirety of an IP pool
3071
3072 if ($wuzpool && $wuzpool->{id} != $id) {
3073 # we have legacy goo to be purified
3074 # going to ignore nested pools; not possible to create them via API and no current legacy data includes any.
3075
3076 # for convenience
3077 my $poolid = $wuzpool->{id};
3078 my $pool = $wuzpool->{cidr};
3079 my $poolcity = $wuzpool->{city};
3080 my $pooltype = $wuzpool->{type};
3081 my $poolcustid = $wuzpool->{custid};
3082
3083 $retcode = 'WARNPOOL';
3084 $goback = "$poolid,$pool";
3085 # We've already deleted the block, now we have to stuff its IPs into the pool.
3086 $pooltype =~ s/[dp]$/i/; # change type to static IP
3087 my $sth2 = $dbh->prepare("INSERT INTO poolips (ip,city,type,custid,parent_id) VALUES ".
3088 "(?,'$poolcity','$pooltype','$poolcustid',$poolid)");
3089
3090##fixme: need to not insert net, gateway, and bcast on "real netblock" pools (DHCPish)
3091 # don't insert .0
3092 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.0$|;
3093 $cidr++;
3094 my $bcast = $cidr->broadcast;
3095 while ($cidr != $bcast) {
3096 $sth2->execute($cidr->addr);
3097 $cidr++;
3098 }
3099 # don't insert .255
3100 $sth2->execute($cidr->addr) unless $cidr->addr =~ m|\.255$|;
3101
3102# Weirdness Happens. $cidr goes read-only somewhere (this is a thing?!?),
3103# causing ->split, ->hostenum, and related methods to explode. O_o
3104# foreach my $ip ($cidr->hostenum) {
3105# $sth2->execute($ip);
3106# }
3107
3108 }
3109
3110## important!
3111# ... or IS IT?
3112# we may have undef'ed $wuzpool above, if the allocation tree $cidr is in doesn't intersect the pool we found
3113#if (!$wuzpool) {
3114
3115 else {
3116
3117# Edge case: Block is the same size as more than one parent level. Should be rare.
3118# - mainly master + first routing. Sorting on parent_id hides the problem pretty well,
3119# but it's likely still possible to fail in particularly well-mangled databases.
3120# The ultimate fix for this may be to resurrect the "routing depth" atrocity. :/
3121 # Get all possible (and probably a number of impossible) containers for $cidr
3122 $sth = $dbh->prepare("SELECT cidr,parent_id,type,city,id FROM allocations ".
3123 "WHERE (type LIKE '_m' OR type LIKE '_c') AND cidr >>= ? AND master_id = ? ".
3124 "ORDER BY masklen(cidr) DESC,parent_id DESC");
3125 $sth->execute($cidr, $binfo->{master_id});
3126
3127 # Quickly get certain fields (simpler than getBlockData()
3128 my $sth2 = $dbh->prepare("SELECT cidr,parent_id,type,city FROM allocations ".
3129 "WHERE (type LIKE '_m' OR type LIKE '_c') AND id = ? AND master_id = ?");
3130
3131 # For each possible container of $cidr...
3132 while (my @data = $sth->fetchrow_array) {
3133 my $i = 0;
3134 # Save some state and set a start point - parent ID of container we're checking
3135 $tparent = $data[0];
3136 my $ppid = $data[1];
3137 $trtype = $data[2];
3138 $tcity = $data[3];
3139 $tpar_id = $data[4];
3140 last if $data[4] == $binfo->{parent_id}; # Preemptively break if we're already in the right place
3141 last if $ppid == $binfo->{parent_id}; # ... or if the parent of the container is the block's parent
3142 while (1) {
3143 # Retrieve bits on that parent ID
3144 $sth2->execute($ppid, $binfo->{master_id});
3145 my @container = $sth2->fetchrow_array;
3146 $ppid = $container[1];
3147 last if $container[1] == 0; # Break if we've hit a master block
3148 last if $ppid == $binfo->{parent_id}; # Break if we've reached the block $cidr is currently in
3149 }
3150 last if $ppid == $binfo->{parent_id};
3151 }
3152
3153 # found an alternate parent; reset some parent-info bits
3154 if ($tpar_id != $binfo->{parent_id}) {
3155 $ptype = (split //, $trtype)[1];
3156 $pcity = $tcity;
3157 $retcode = 'WARNMERGE'; # may be redundant
3158 $p_id = $tpar_id;
3159 }
3160
3161 $goback = "$p_id,$tparent"; # breadcrumb, currently only used in case of live-parent-is-not-true-parent
3162
3163 # Special case - delete pool IPs
3164 if ($binfo->{type} =~ /^.[pd]$/) {
3165 # We have to delete the IPs from the pool listing.
3166##fixme: rdepth? vrf?
3167 $dbh->do("DELETE FROM poolips WHERE parent_id = ?", undef, ($id) );
3168 }
3169
3170 $pinfo = getBlockData($dbh, $p_id);
3171
3172 # If the block wasn't legacy goo embedded in a static pool, we check the
3173 # freeblocks in the identified parent to see if we can combine any of them.
3174
3175 # if the block to be deleted is a container, move its freeblock(s) up a level, and reset their parenting info
3176 if ($binfo->{type} =~ /^.[mc]/) {
3177 # move the freeblocks into the parent
3178 # we don't insert a new freeblock because there could be a live reparented sub.
3179 $dbh->do("UPDATE freeblocks SET parent_id = ?, routed = ?, city = ? WHERE parent_id = ?", undef,
3180 ($p_id, $ptype, $pcity, $id) );
3181 } else {
3182 # ... otherwise, add the freeblock
3183 $dbh->do("INSERT INTO freeblocks (cidr, city, routed, parent_id, master_id) VALUES (?,?,?,?,?)", undef,
3184 ($cidr, $pcity, $ptype, $p_id, $binfo->{master_id}) );
3185 }
3186
3187 # Walk the free blocks in the parent and reduce them to the minimal set of CIDR ranges necessary
3188 _compactFree($dbh, $p_id);
3189
3190 } # done returning IPs to the appropriate place
3191
3192 # If we got here, we've succeeded. Whew!
3193 $dbh->commit;
3194 }; # end eval
3195 if ($@) {
3196 $msg .= ": $@";
3197 eval { $dbh->rollback; };
3198 return ('FAIL', $msg);
3199 }
3200
3201##fixme: RPC return code?
3202 _rpc('delByCIDR', cidr => "$cidr", rpcuser => $user, delforward => $delfwd, delsubs => 'y', parpatt => $ppatt)
3203 if ($binfo->{revavail} || $binfo->{revpartial});
3204
3205 return ($retcode, $goback);
3206
3207 } # end alloctype != netblock
3208
3209} # end deleteBlock()
3210
3211
3212## IPDB::getBlockData()
3213# Get CIDR or IP, custid, type, city, circuit ID, description, notes, modification time,
3214# private/restricted data, and backup fields, for a CIDR block or pool IP
3215# Also returns SWIP status flag for CIDR blocks or pool netblock for IPs
3216# Takes the block ID or IP to look up and an optional flag to indicate a pool IP lookup
3217# instead of a netblock.
3218# Returns a hashref to the block data
3219sub getBlockData {
3220 my $dbh = shift;
3221 my $id = shift;
3222 my $type = shift || 'b'; # default to netblock for lazy callers
3223
3224# catch some errors, someday
3225# if (!$id || $id !~ /^\d+$/) {
3226# $errstr = "Allocation ID must be numeric
3227# }
3228
3229 # netblocks are in the allocations table; pool IPs are in the poolips table.
3230 # If we try to look up a CIDR in an integer field we should just get back nothing.
3231 my ($btype) = $dbh->selectrow_array("SELECT type FROM allocations WHERE id=?", undef, ($id) );
3232
3233 # Note city, vrf, parent_id and master_id removed due to JOIN uncertainty for block allocations
3234 my $commonfields = q(a.custid, a.type, a.circuitid, a.description, a.notes, a.modifystamp AS lastmod,
3235 a.privdata, a.vlan, a.rdns);
3236 my $bkfields = q(b.backup_id AS hasbk, b.bkbrand, b.bkmodel, b.bktype, b.bkport, b.bksrc,
3237 b.bkuser, b.bkvpass, b.bkepass, b.bkip);
3238
3239 if ($type eq 'i') {
3240 my $binfo = $dbh->selectrow_hashref(qq(
3241 SELECT a.id, a.ip AS block, a.city, a.vrf, a.parent_id, a.master_id, $commonfields,
3242 d.zone >> a.ip AS revavail, d.location,
3243 $bkfields,
3244 v.location AS vrfloc
3245 FROM poolips a
3246 LEFT JOIN dnsavail d ON a.master_id = d.parent_alloc AND a.ip << d.zone
3247 LEFT JOIN backuplist b ON a.backup_id = b.backup_id
3248 JOIN allocations m ON a.master_id = m.id JOIN vrfs v ON m.vrf = v.vrf
3249 WHERE a.id = ?
3250 ), undef, ($id) );
3251 return $binfo;
3252 } else {
3253 my $binfo = $dbh->selectrow_hashref(qq(
3254 SELECT a.id, a.cidr AS block, a.city, a.vrf, a.parent_id, a.master_id, a.swip, $commonfields,
3255 f.cidr AS reserve, f.id as reserve_id,
3256 d.zone >>= a.cidr AS revavail, d.zone << a.cidr AS revpartial, d.location,
3257 $bkfields,
3258 v.location AS vrfloc
3259 FROM allocations a
3260 LEFT JOIN freeblocks f ON a.id=f.reserve_for
3261 LEFT JOIN dnsavail d ON a.master_id = d.parent_alloc AND (a.cidr <<= d.zone OR a.cidr >> d.zone)
3262 LEFT JOIN backuplist b ON a.backup_id = b.backup_id
3263 JOIN allocations m ON a.master_id = m.id JOIN vrfs v ON m.vrf = v.vrf
3264 WHERE a.id = ?
3265 ), undef, ($id) );
3266
3267 return $binfo;
3268 }
3269} # end getBlockData()
3270
3271
3272## IPDB::getBlockRDNS()
3273# Gets reverse DNS pattern for a block or IP. Note that this will also
3274# retrieve any default pattern following the parent chain up, and check via
3275# RPC (if available) to see what the narrowest pattern for the requested block is
3276# Returns the current pattern for the block or IP.
3277sub getBlockRDNS {
3278 my $dbh = shift;
3279 my %args = @_;
3280
3281 $args{type} = 'b' if !$args{type};
3282 my $cached = 1;
3283
3284 # snag entry from database
3285 my ($rdns,$rfrom,$pid,$mid);
3286 if ($args{type} =~ /.i/) {
3287 ($rdns, $rfrom, $pid, $mid) = $dbh->selectrow_array("SELECT rdns,ip,parent_id,master_id FROM poolips WHERE id = ?",
3288 undef, ($args{id}) );
3289 } else {
3290 ($rdns, $rfrom, $pid, $mid) = $dbh->selectrow_array("SELECT rdns,cidr,parent_id,master_id FROM allocations WHERE id = ?",
3291 undef, ($args{id}) );
3292 }
3293
3294 # Can't see a way this could end up empty, for any case I care about. If the caller
3295 # doesn't know an allocation ID to request, then they don't know anything else anyway.
3296 my $selfblock = $rfrom;
3297
3298 my $type;
3299 while (!$rdns && $pid) {
3300 ($rdns, $rfrom, $pid, $type) = $dbh->selectrow_array(
3301 "SELECT rdns,cidr,parent_id,type FROM allocations WHERE id = ?",
3302 undef, ($pid) );
3303 last if $type eq 'mm'; # break loops in unfortunate legacy data
3304 }
3305
3306 # use the actual allocation to check against the DNS utility; we don't want
3307 # to always go chasing up the chain to the master... which may (usually won't)
3308 # be present directly in DNS anyway
3309 my $cidr = new NetAddr::IP $selfblock;
3310
3311 if ($rpc_url) {
3312 # Use the first /16 or /24, rather than dithering over which sub-/14 /16
3313 # or sub-/19 /24 to retrieve - it's the least-wrong way to do things.
3314
3315 my ($rpcblock) = ($cidr->masklen <= 24 ? $cidr->split( ($cidr->masklen <= 16 ? 16 : 24) ) : $cidr);
3316 my %rpcargs = (
3317 rpcuser => $args{user},
3318 group => $revgroup, # not sure how this could sanely be exposed, tbh...
3319 cidr => "$rpcblock",
3320 );
3321
3322# # Retrieve the VRF's location by way of the master block
3323# ($rpcargs{location}) = $dbh->selectrow_array("SELECT v.location FROM vrfs v".
3324# " JOIN allocations a ON a.vrf = v.vrf".
3325# " WHERE a.id = ?", undef, $mid);
3326
3327## ... is there something more needed here?
3328# order by so that we get the narrowest entry
3329 ($rpcargs{location}) = $dbh->selectrow_array("SELECT d.location FROM dnsavail d".
3330 " WHERE d.parent_alloc = ? ORDER BY zone DESC", undef, $mid);
3331
3332 $errstr = '';
3333 my $remote_rdns = _rpc('getRevPattern', %rpcargs);
3334 if ($remote_rdns) {
3335 $rdns = $remote_rdns;
3336 $cached = 0;
3337 } else {
3338 if (!$errstr) {
3339 # no error, but no data
3340 $cached = 0;
3341 }
3342 }
3343 }
3344
3345 # hmm. do we care about where it actually came from?
3346 return $rdns, $cached;
3347} # end getBlockRDNS()
3348
3349
3350## IPDB::getRDNSbyIP()
3351# Get individual reverse entries for the IP or CIDR IP range passed. Sort of looking the
3352# opposite direction down the netblock tree compared to getBlockRDNS() above.
3353sub getRDNSbyIP {
3354 my $dbh = shift;
3355 my %args = @_; # We want to accept a variety of call types
3356
3357 # key arguments: allocation ID, type
3358 unless ($args{id} || $args{type}) {
3359 $errstr = 'Missing allocation ID or type';
3360 return;
3361 }
3362
3363 my $binfo = getBlockData($dbh, $args{id}, $args{type});
3364
3365 my @ret = ();
3366 # special case: single IP. Check if it's an allocation or in a pool, then do the RPC call for fresh data.
3367 if ($args{type} =~ /^.i$/) {
3368 my ($ip, $localrev) = $dbh->selectrow_array("SELECT ip, rdns FROM poolips WHERE id = ?", undef, ($args{id}) );
3369 push @ret, { 'r_ip' => $ip, 'iphost' => $localrev };
3370##fixme: rpc call?
3371 } else {
3372 if ($rpc_url) {
3373 my %rpcargs = (
3374 rpcuser => $args{user},
3375 group => $revgroup, # not sure how this could sanely be exposed, tbh...
3376 cidr => $args{range},
3377 );
3378
3379# # Retrieve the VRF's DNS location by way of the master block
3380# ($rpcargs{location}) = $dbh->selectrow_array("SELECT v.location FROM vrfs v".
3381# " JOIN allocations a ON a.vrf = v.vrf JOIN allocations b ON a.id = b.master_id".
3382# " WHERE b.id = ?", undef, $args{id});
3383
3384## ... is there something more needed here?
3385# order by so that we get the narrowest entry
3386 ($rpcargs{location}) = $dbh->selectrow_array("SELECT d.location FROM dnsavail d".
3387 " WHERE d.parent_alloc = ? ORDER BY zone DESC", undef, $binfo->{master_id});
3388
3389 my $remote_rdns = _rpc('getRevSet', %rpcargs);
3390 return $remote_rdns;
3391# $rdns = $remote_rdns if $remote_rdns;
3392# $cached = 0;
3393 }
3394 }
3395 return \@ret;
3396} # end getRDNSbyIP()
3397
3398
3399## IPDB::getRevID()
3400# Get the reverse zone ID(s) for an allocation
3401# Takes a hash with cidr, location and user elements
3402# Returns a hashref to a list of zones and zone IDs (in case of large
3403# allocations effectively split across multiple DNS zones)
3404##fixme: arguably should be integrated in some other related sub that
3405# does RPC to minimize the number of RPC calls somehow
3406sub getRevID {
3407 my $dbh = shift;
3408 my %args = @_;
3409
3410##fixme: build a local cache for mapping allocations to DNS zone IDs
3411# my ($revlocal) = $dbh->selectrow_array("SELECT revzones[0] AS zone,revzones[1] AS revid FROM dnsavail WHERE
3412#zone >>= ? AND location = ?", undef, $args{cidr}, $args{location});
3413#use Data::Dumper;
3414#print "rezone array?<pre>".Dumper($revlocal)."</pre>\n";
3415
3416 my $revzones = _rpc('getZonesByCIDR', rpcuser => $args{user},
3417 cidr => $args{cidr},
3418 return_location => 0,
3419 location => $args{location},
3420 );
3421 return $revzones;
3422} # end getRevID()
3423
3424
3425## IPDB::getNodeList()
3426# Gets a list of node ID+name pairs as an arrayref to a list of hashrefs
3427sub getNodeList {
3428 my $dbh = shift;
3429
3430 my $ret = $dbh->selectall_arrayref("SELECT node_id, node_name FROM nodes ORDER BY node_type,node_id",
3431 { Slice => {} });
3432 return $ret;
3433} # end getNodeList()
3434
3435
3436## IPDB::getNodeName()
3437# Get node name from the ID
3438sub getNodeName {
3439 my $dbh = shift;
3440 my $nid = shift;
3441
3442 my ($nname) = $dbh->selectrow_array("SELECT node_name FROM nodes WHERE node_id = ?", undef, ($nid) );
3443 return $nname;
3444} # end getNodeName()
3445
3446
3447## IPDB::getNodeInfo()
3448# Get node name and ID associated with a block
3449sub getNodeInfo {
3450 my $dbh = shift;
3451 my $block = shift;
3452
3453 my ($nid, $nname) = $dbh->selectrow_array("SELECT nodes.node_id,node_name FROM nodes INNER JOIN noderef".
3454 " ON nodes.node_id=noderef.node_id WHERE noderef.block = ?", undef, ($block) );
3455 return ($nid, $nname);
3456} # end getNodeInfo()
3457
3458
3459## IPDB::mailNotify()
3460# Sends notification mail to recipients regarding an IPDB operation
3461sub mailNotify {
3462 my $dbh = shift;
3463 my ($action,$subj,$message) = @_;
3464
3465 return if $smtphost eq 'smtp.example.com'; # do nothing if still using default SMTP host.
3466
3467##fixme: need to redesign the breakdown/processing for $action for proper handling of all cases
3468
3469# split action into parts for fiddlement. nb: there are almost certainly better ways to do this.
3470 my @actionbits = split //, $action;
3471
3472 # want to notify anyone who has specifically requested notify on *this* type ($action as passed),
3473 # on "all static IP types" or "all pool types" (and other last-char-in-type groupings), on eg "all DSL types",
3474 # and "all events with this action"
3475 my @actionsets = ($action);
3476##fixme: ick, eww. really gotta find a better way to handle this...
3477 push @actionsets, ($actionbits[0].'.'.$actionbits[2],
3478 $actionbits[0].$actionbits[1].'.', $actionbits[0].'a') if $action =~ /^.{3}$/;
3479
3480 my $mailer = Net::SMTP->new($smtphost, Hello => "ipdb.$domain");
3481
3482 # get recip list from db
3483 my $sth = $dbh->prepare("SELECT reciplist FROM notify WHERE action=?");
3484
3485 my %reciplist;
3486 foreach (@actionsets) {
3487 $sth->execute($_);
3488##fixme - need to handle db errors
3489 my ($recipsub) = $sth->fetchrow_array;
3490 next if !$recipsub;
3491 foreach (split(/,/, $recipsub)) {
3492 $reciplist{$_}++;
3493 }
3494 }
3495
3496 return if !%reciplist;
3497
3498 foreach my $recip (keys %reciplist) {
3499 $mailer->mail($smtpsender);
3500 $mailer->to($recip);
3501 $mailer->data("From: \"$org_name IP Database\" <$smtpsender>\n",
3502 "To: $recip\n",
3503 "Date: ".strftime("%a, %d %b %Y %H:%M:%S %z",localtime)."\n",
3504 "Subject: {IPDB} $subj\n",
3505 "X-Mailer: IPDB Notify v".sprintf("%.1d",$IPDB::VERSION)."\n",
3506 "Organization: $org_name\n",
3507 "\n$message\n");
3508 }
3509 $mailer->quit;
3510}
3511
3512# Indicates module loaded OK. Required by Perl.
35131;
Note: See TracBrowser for help on using the repository browser.